Struct tinkerforge::uv_light_v2_bricklet::UvLightV2Bricklet

source ·

pub struct UvLightV2Bricklet { /* private fields */ }

Expand description

Measures UV-A, UV-B and UV index

Implementations

source

pub fn new(uid: &str, ip_connection: &IpConnection) -> UvLightV2Bricklet

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

source

pub fn get_response_expected(
&mut self,
fun: UvLightV2BrickletFunction
) -> 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.

source

pub fn set_response_expected(
 &mut self,
 fun: UvLightV2BrickletFunction,
 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.

source

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.

source

pub fn get_uva_callback_receiver(&self) -> ConvertingCallbackReceiver<i32>

This receiver is triggered periodically according to the configuration set by Set UVA Receiver Configuration.

The parameter is the same as Get UVA.

source

pub fn get_uvb_callback_receiver(&self) -> ConvertingCallbackReceiver<i32>

This receiver is triggered periodically according to the configuration set by Set UVB Receiver Configuration.

The parameter is the same as Get UVB.

source

pub fn get_uvi_callback_receiver(&self) -> ConvertingCallbackReceiver<i32>

This receiver is triggered periodically according to the configuration set by Set UVI Receiver Configuration.

The parameter is the same as Get UVI.

source

pub fn get_uva(&self) -> ConvertingReceiver<i32>

Returns the UVA intensity of the sensor, the intensity is given in 1/10 mW/m². The sensor has not weighted the intensity with the erythemal action spectrum to get the skin-affecting irradiation. Therefore, you cannot just divide the value by 250 to get the UVA index. To get the UV index use Get UVI.

If the sensor is saturated, then -1 is returned, see Set Configuration.

If you want to get the intensity periodically, it is recommended to use the get_uva_callback_receiver receiver and set the period with Set UVA Receiver Configuration.

If you want to get the value periodically, it is recommended to use the get_uva_callback_receiver receiver. You can set the receiver configuration with Set UVA Receiver Configuration.

source

pub fn set_uva_callback_configuration(
 &self,
 period: u32,
 value_has_to_change: bool,
 option: char,
 min: i32,
 max: i32
) -> ConvertingReceiver<()>

The period in ms is the period with which the get_uva_callback_receiver receiver is triggered periodically. A value of 0 turns the receiver off.

If the value has to change-parameter is set to true, the receiver is only triggered after the value has changed. If the value didn’t change within the period, the receiver is triggered immediately on change.

If it is set to false, the receiver is continuously triggered with the period, independent of the value.

It is furthermore possible to constrain the receiver with thresholds.

The option-parameter together with min/max sets a threshold for the get_uva_callback_receiver receiver.

The following options are possible:

Option	Description
‘x’	Threshold is turned off
‘o’	Threshold is triggered when the value is outside the min and max values
‘i’	Threshold is triggered when the value is inside or equal to the min and max values
‘<’	Threshold is triggered when the value is smaller than the min value (max is ignored)
‘>’	Threshold is triggered when the value is greater than the min value (max is ignored)

If the option is set to ‘x’ (threshold turned off) the receiver is triggered with the fixed period.

The default value is (0, false, ‘x’, 0, 0).

Associated constants:

UV_LIGHT_V2BRICKLET_THRESHOLD_OPTION_OFF
UV_LIGHT_V2BRICKLET_THRESHOLD_OPTION_OUTSIDE
UV_LIGHT_V2BRICKLET_THRESHOLD_OPTION_INSIDE
UV_LIGHT_V2BRICKLET_THRESHOLD_OPTION_SMALLER
UV_LIGHT_V2BRICKLET_THRESHOLD_OPTION_GREATER

source

pub fn get_uva_callback_configuration(
&self
) -> ConvertingReceiver<UvaCallbackConfiguration>

Returns the receiver configuration as set by Set UVA Receiver Configuration.

Associated constants:

UV_LIGHT_V2BRICKLET_THRESHOLD_OPTION_OFF
UV_LIGHT_V2BRICKLET_THRESHOLD_OPTION_OUTSIDE
UV_LIGHT_V2BRICKLET_THRESHOLD_OPTION_INSIDE
UV_LIGHT_V2BRICKLET_THRESHOLD_OPTION_SMALLER
UV_LIGHT_V2BRICKLET_THRESHOLD_OPTION_GREATER

source

pub fn get_uvb(&self) -> ConvertingReceiver<i32>

Returns the UVB intensity of the sensor, the intensity is given in 1/10 mW/m². The sensor has not weighted the intensity with the erythemal action spectrum to get the skin-affecting irradiation. Therefore, you cannot just divide the value by 250 to get the UVB index. To get the UV index use Get UVI.

If the sensor is saturated, then -1 is returned, see Set Configuration.

If you want to get the intensity periodically, it is recommended to use the get_uvb_callback_receiver receiver and set the period with Set UVB Receiver Configuration.

If you want to get the value periodically, it is recommended to use the get_uvb_callback_receiver receiver. You can set the receiver configuration with Set UVB Receiver Configuration.

source

pub fn set_uvb_callback_configuration(
 &self,
 period: u32,
 value_has_to_change: bool,
 option: char,
 min: i32,
 max: i32
) -> ConvertingReceiver<()>

The period in ms is the period with which the get_uvb_callback_receiver receiver is triggered periodically. A value of 0 turns the receiver off.

If the value has to change-parameter is set to true, the receiver is only triggered after the value has changed. If the value didn’t change within the period, the receiver is triggered immediately on change.

If it is set to false, the receiver is continuously triggered with the period, independent of the value.

It is furthermore possible to constrain the receiver with thresholds.

The option-parameter together with min/max sets a threshold for the get_uvb_callback_receiver receiver.

The following options are possible:

Option	Description
‘x’	Threshold is turned off
‘o’	Threshold is triggered when the value is outside the min and max values
‘i’	Threshold is triggered when the value is inside or equal to the min and max values
‘<’	Threshold is triggered when the value is smaller than the min value (max is ignored)
‘>’	Threshold is triggered when the value is greater than the min value (max is ignored)

If the option is set to ‘x’ (threshold turned off) the receiver is triggered with the fixed period.

The default value is (0, false, ‘x’, 0, 0).

Associated constants:

UV_LIGHT_V2BRICKLET_THRESHOLD_OPTION_OFF
UV_LIGHT_V2BRICKLET_THRESHOLD_OPTION_OUTSIDE
UV_LIGHT_V2BRICKLET_THRESHOLD_OPTION_INSIDE
UV_LIGHT_V2BRICKLET_THRESHOLD_OPTION_SMALLER
UV_LIGHT_V2BRICKLET_THRESHOLD_OPTION_GREATER

source

pub fn get_uvb_callback_configuration(
&self
) -> ConvertingReceiver<UvbCallbackConfiguration>

Returns the receiver configuration as set by Set UVB Receiver Configuration.

Associated constants:

UV_LIGHT_V2BRICKLET_THRESHOLD_OPTION_OFF
UV_LIGHT_V2BRICKLET_THRESHOLD_OPTION_OUTSIDE
UV_LIGHT_V2BRICKLET_THRESHOLD_OPTION_INSIDE
UV_LIGHT_V2BRICKLET_THRESHOLD_OPTION_SMALLER
UV_LIGHT_V2BRICKLET_THRESHOLD_OPTION_GREATER

source

pub fn get_uvi(&self) -> ConvertingReceiver<i32>

Returns the UV index of the sensor, the index is given in 1/10.

If the sensor is saturated, then -1 is returned, see Set Configuration.

If you want to get the intensity periodically, it is recommended to use the get_uvi_callback_receiver receiver and set the period with Set UVI Receiver Configuration.

If you want to get the value periodically, it is recommended to use the get_uvi_callback_receiver receiver. You can set the receiver configuration with Set UVI Receiver Configuration.

source

pub fn set_uvi_callback_configuration(
 &self,
 period: u32,
 value_has_to_change: bool,
 option: char,
 min: i32,
 max: i32
) -> ConvertingReceiver<()>

The period in ms is the period with which the get_uvi_callback_receiver receiver is triggered periodically. A value of 0 turns the receiver off.

If the value has to change-parameter is set to true, the receiver is only triggered after the value has changed. If the value didn’t change within the period, the receiver is triggered immediately on change.

If it is set to false, the receiver is continuously triggered with the period, independent of the value.

It is furthermore possible to constrain the receiver with thresholds.

The option-parameter together with min/max sets a threshold for the get_uvi_callback_receiver receiver.

The following options are possible:

Option	Description
‘x’	Threshold is turned off
‘o’	Threshold is triggered when the value is outside the min and max values
‘i’	Threshold is triggered when the value is inside or equal to the min and max values
‘<’	Threshold is triggered when the value is smaller than the min value (max is ignored)
‘>’	Threshold is triggered when the value is greater than the min value (max is ignored)

If the option is set to ‘x’ (threshold turned off) the receiver is triggered with the fixed period.

The default value is (0, false, ‘x’, 0, 0).

Associated constants:

UV_LIGHT_V2BRICKLET_THRESHOLD_OPTION_OFF
UV_LIGHT_V2BRICKLET_THRESHOLD_OPTION_OUTSIDE
UV_LIGHT_V2BRICKLET_THRESHOLD_OPTION_INSIDE
UV_LIGHT_V2BRICKLET_THRESHOLD_OPTION_SMALLER
UV_LIGHT_V2BRICKLET_THRESHOLD_OPTION_GREATER

source

pub fn get_uvi_callback_configuration(
&self
) -> ConvertingReceiver<UviCallbackConfiguration>

Returns the receiver configuration as set by Set UVI Receiver Configuration.

Associated constants:

UV_LIGHT_V2BRICKLET_THRESHOLD_OPTION_OFF
UV_LIGHT_V2BRICKLET_THRESHOLD_OPTION_OUTSIDE
UV_LIGHT_V2BRICKLET_THRESHOLD_OPTION_INSIDE
UV_LIGHT_V2BRICKLET_THRESHOLD_OPTION_SMALLER
UV_LIGHT_V2BRICKLET_THRESHOLD_OPTION_GREATER

source

pub fn set_configuration(&self, integration_time: u8) -> ConvertingReceiver<()>

Sets the configuration of the sensor. The integration time can be configured between 50 and 800 ms. With a shorter integration time the sensor reading updates more often but contains more noise. With a longer integration the sensor reading contains less noise but updates less often.

With a longer integration time (especially 800 ms) and a higher UV intensity the sensor can be saturated. If this happens the UVA/UVB/UVI readings are all -1. In this case you need to choose a shorter integration time.

Default value: 400 ms.

Associated constants:

UV_LIGHT_V2BRICKLET_INTEGRATION_TIME_50MS
UV_LIGHT_V2BRICKLET_INTEGRATION_TIME_100MS
UV_LIGHT_V2BRICKLET_INTEGRATION_TIME_200MS
UV_LIGHT_V2BRICKLET_INTEGRATION_TIME_400MS
UV_LIGHT_V2BRICKLET_INTEGRATION_TIME_800MS

source

pub fn get_configuration(&self) -> ConvertingReceiver<u8>

Returns the configuration as set by Set Configuration.

Associated constants:

UV_LIGHT_V2BRICKLET_INTEGRATION_TIME_50MS
UV_LIGHT_V2BRICKLET_INTEGRATION_TIME_100MS
UV_LIGHT_V2BRICKLET_INTEGRATION_TIME_200MS
UV_LIGHT_V2BRICKLET_INTEGRATION_TIME_400MS
UV_LIGHT_V2BRICKLET_INTEGRATION_TIME_800MS

source

pub fn get_spitfp_error_count(&self) -> ConvertingReceiver<SpitfpErrorCount>

Returns the error count for the communication between Brick and Bricklet.

The errors are divided into

ACK checksum errors,
message checksum errors,
framing errors and
overflow errors.

The errors counts are for errors that occur on the Bricklet side. All Bricks have a similar function that returns the errors on the Brick side.

source

pub fn set_bootloader_mode(&self, mode: u8) -> ConvertingReceiver<u8>

Sets the bootloader mode and returns the status after the requested mode change was instigated.

You can change from bootloader mode to firmware mode and vice versa. A change from bootloader mode to firmware mode will only take place if the entry function, device identifier and CRC are present and correct.

This function is used by Brick Viewer during flashing. It should not be necessary to call it in a normal user program.

Associated constants:

UV_LIGHT_V2BRICKLET_BOOTLOADER_MODE_BOOTLOADER
UV_LIGHT_V2BRICKLET_BOOTLOADER_MODE_FIRMWARE
UV_LIGHT_V2BRICKLET_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT
UV_LIGHT_V2BRICKLET_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT
UV_LIGHT_V2BRICKLET_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT
UV_LIGHT_V2BRICKLET_BOOTLOADER_STATUS_OK
UV_LIGHT_V2BRICKLET_BOOTLOADER_STATUS_INVALID_MODE
UV_LIGHT_V2BRICKLET_BOOTLOADER_STATUS_NO_CHANGE
UV_LIGHT_V2BRICKLET_BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT
UV_LIGHT_V2BRICKLET_BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT
UV_LIGHT_V2BRICKLET_BOOTLOADER_STATUS_CRC_MISMATCH

source

pub fn get_bootloader_mode(&self) -> ConvertingReceiver<u8>

Returns the current bootloader mode, see Set Bootloader Mode.

Associated constants:

UV_LIGHT_V2BRICKLET_BOOTLOADER_MODE_BOOTLOADER
UV_LIGHT_V2BRICKLET_BOOTLOADER_MODE_FIRMWARE
UV_LIGHT_V2BRICKLET_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT
UV_LIGHT_V2BRICKLET_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT
UV_LIGHT_V2BRICKLET_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT

source

pub fn set_write_firmware_pointer(&self, pointer: u32) -> ConvertingReceiver<()>

Sets the firmware pointer for Write Firmware. The pointer has to be increased by chunks of size 64. The data is written to flash every 4 chunks (which equals to one page of size 256).

This function is used by Brick Viewer during flashing. It should not be necessary to call it in a normal user program.

source

pub fn write_firmware(&self, data: [u8; 64]) -> ConvertingReceiver<u8>

Writes 64 Bytes of firmware at the position as written by Set Write Firmware Pointer before. The firmware is written to flash every 4 chunks.

You can only write firmware in bootloader mode.

This function is used by Brick Viewer during flashing. It should not be necessary to call it in a normal user program.

source

pub fn set_status_led_config(&self, config: u8) -> ConvertingReceiver<()>

Sets the status LED configuration. By default the LED shows communication traffic between Brick and Bricklet, it flickers once for every 10 received data packets.

You can also turn the LED permanently on/off or show a heartbeat.

If the Bricklet is in bootloader mode, the LED is will show heartbeat by default.

Associated constants:

UV_LIGHT_V2BRICKLET_STATUS_LED_CONFIG_OFF
UV_LIGHT_V2BRICKLET_STATUS_LED_CONFIG_ON
UV_LIGHT_V2BRICKLET_STATUS_LED_CONFIG_SHOW_HEARTBEAT
UV_LIGHT_V2BRICKLET_STATUS_LED_CONFIG_SHOW_STATUS

source

pub fn get_status_led_config(&self) -> ConvertingReceiver<u8>

Returns the configuration as set by Set Status LED Config

Associated constants:

UV_LIGHT_V2BRICKLET_STATUS_LED_CONFIG_OFF
UV_LIGHT_V2BRICKLET_STATUS_LED_CONFIG_ON
UV_LIGHT_V2BRICKLET_STATUS_LED_CONFIG_SHOW_HEARTBEAT
UV_LIGHT_V2BRICKLET_STATUS_LED_CONFIG_SHOW_STATUS

source

pub fn get_chip_temperature(&self) -> ConvertingReceiver<i16>

Returns the temperature in °C as measured inside the microcontroller. The value returned is not the ambient temperature!

The temperature is only proportional to the real temperature and it has bad accuracy. Practically it is only useful as an indicator for temperature changes.

source