Struct tinkerforge::uv_light_bricklet::UvLightBricklet

pub struct UvLightBricklet { /* fields omitted */ }

Measures UV light

Methods

impl UvLightBricklet

pub const DEVICE_IDENTIFIER: u16

pub const DEVICE_DISPLAY_NAME: &'static str

pub fn new<T: GetRequestSender>(uid: &str, req_sender: T) -> UvLightBricklet

Creates an object with the unique device ID uid. This object can then be used after the IP Connection ip_connection is connected.

pub fn get_response_expected(
    &mut self,
    fun: UvLightBrickletFunction
) -> Result<bool, GetResponseExpectedError>

Returns the response expected flag for the function specified by the function ID parameter. It is true if the function is expected to send a response, false otherwise.

For getter functions this is enabled by default and cannot be disabled, because those functions will always send a response. For callback configuration functions it is enabled by default too, but can be disabled by set_response_expected. For setter functions it is disabled by default and can be enabled.

Enabling the response expected flag for a setter function allows to detect timeouts and other error conditions calls of this setter as well. The device will then send a response for this purpose. If this flag is disabled for a setter function then no response is send and errors are silently ignored, because they cannot be detected.

See set_response_expected for the list of function ID constants available for this function.

pub fn set_response_expected(
    &mut self,
    fun: UvLightBrickletFunction,
    response_expected: bool
) -> Result<(), SetResponseExpectedError>

Changes the response expected flag of the function specified by the function ID parameter. This flag can only be changed for setter (default value: false) and callback configuration functions (default value: true). For getter functions it is always enabled.

Enabling the response expected flag for a setter function allows to detect timeouts and other error conditions calls of this setter as well. The device will then send a response for this purpose. If this flag is disabled for a setter function then no response is send and errors are silently ignored, because they cannot be detected.

pub fn set_response_expected_all(&mut self, response_expected: bool)

Changes the response expected flag for all setter and callback configuration functions of this device at once.

pub fn get_api_version(&self) -> [u8; 3]

Returns the version of the API definition (major, minor, revision) implemented by this API bindings. This is neither the release version of this API bindings nor does it tell you anything about the represented Brick or Bricklet.

pub fn get_uv_light_callback_receiver(&self) -> ConvertingCallbackReceiver<u32>

This receiver is triggered periodically with the period that is set by set_uv_light_callback_period. The parameter is the UV Light intensity of the sensor.

The get_uv_light_callback_receiver receiver is only triggered if the intensity has changed since the last triggering.

pub fn get_uv_light_reached_callback_receiver(
    &self
) -> ConvertingCallbackReceiver<u32>

This receiver is triggered when the threshold as set by set_uv_light_callback_threshold is reached. The parameter is the UV Light intensity of the sensor.

If the threshold keeps being reached, the receiver is triggered periodically with the period as set by set_debounce_period.

pub fn get_uv_light(&self) -> ConvertingReceiver<u32>

Returns the UV light intensity of the sensor, the intensity is given in 1/10 mW/m². The sensor has already weighted the intensity with the erythemal action spectrum to get the skin-affecting irradiation.

To get UV index you just have to divide the value by 250. For example, a UV light intensity of 500 is equivalent to an UV index of 2.

If you want to get the intensity periodically, it is recommended to use the get_uv_light_callback_receiver receiver and set the period with set_uv_light_callback_period.

pub fn set_uv_light_callback_period(
    &self,
    period: u32
) -> ConvertingReceiver<()>

Sets the period with which the get_uv_light_callback_receiver receiver is triggered periodically. A value of 0 turns the receiver off.

The get_uv_light_callback_receiver receiver is only triggered if the intensity has changed since the last triggering.

pub fn get_uv_light_callback_period(&self) -> ConvertingReceiver<u32>

Returns the period as set by set_uv_light_callback_period.

pub fn set_uv_light_callback_threshold(
    &self,
    option: char,
    min: u32,
    max: u32
) -> ConvertingReceiver<()>

Sets the thresholds for the get_uv_light_reached_callback_receiver receiver.

The following options are possible:

Option	Description
'x'	Receiver is turned off
'o'	Receiver is triggered when the intensity is outside the min and max values
'i'	Receiver is triggered when the intensity is inside the min and max values
'<'	Receiver is triggered when the intensity is smaller than the min value (max is ignored)
'>'	Receiver is triggered when the intensity is greater than the min value (max is ignored)

The default value is ('x', 0, 0).

Associated constants:

• UV_LIGHT_BRICKLET_THRESHOLD_OPTION_OFF
• UV_LIGHT_BRICKLET_THRESHOLD_OPTION_OUTSIDE
• UV_LIGHT_BRICKLET_THRESHOLD_OPTION_INSIDE
• UV_LIGHT_BRICKLET_THRESHOLD_OPTION_SMALLER
• UV_LIGHT_BRICKLET_THRESHOLD_OPTION_GREATER

pub fn get_uv_light_callback_threshold(
    &self
) -> ConvertingReceiver<UvLightCallbackThreshold>

Returns the threshold as set by set_uv_light_callback_threshold.

Associated constants:

• UV_LIGHT_BRICKLET_THRESHOLD_OPTION_OFF
• UV_LIGHT_BRICKLET_THRESHOLD_OPTION_OUTSIDE
• UV_LIGHT_BRICKLET_THRESHOLD_OPTION_INSIDE
• UV_LIGHT_BRICKLET_THRESHOLD_OPTION_SMALLER
• UV_LIGHT_BRICKLET_THRESHOLD_OPTION_GREATER

pub fn set_debounce_period(&self, debounce: u32) -> ConvertingReceiver<()>

Sets the period with which the threshold receivers

• get_uv_light_reached_callback_receiver,

are triggered, if the thresholds

• set_uv_light_callback_threshold,

keep being reached.

pub fn get_debounce_period(&self) -> ConvertingReceiver<u32>

Returns the debounce period as set by set_debounce_period.

pub fn get_identity(&self) -> ConvertingReceiver<Identity>

Returns the UID, the UID where the Bricklet is connected to, the position, the hardware and firmware version as well as the device identifier.

The position can be 'a', 'b', 'c' or 'd'.

The device identifier numbers can be found here. |device_identifier_constant|

Trait Implementations

impl Clone for UvLightBricklet

fn clone(&self) -> UvLightBricklet

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.