pub struct UvLightV2Bricklet { /* private fields */ }Expand description
Measures UV-A, UV-B and UV index
Implementations§
Source§impl UvLightV2Bricklet
impl UvLightV2Bricklet
pub const DEVICE_IDENTIFIER: u16 = 2_118u16
pub const DEVICE_DISPLAY_NAME: &'static str = "UV Light Bricklet 2.0"
Sourcepub fn new(uid: Uid, connection: AsyncIpConnection) -> UvLightV2Bricklet
pub fn new(uid: Uid, connection: AsyncIpConnection) -> UvLightV2Bricklet
Creates an object with the unique device ID uid. This object can then be used after the IP Connection ip_connection is connected.
Sourcepub fn get_response_expected(
&mut self,
fun: UvLightV2BrickletFunction,
) -> Result<bool, GetResponseExpectedError>
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 sent 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.
Sourcepub fn set_response_expected(
&mut self,
fun: UvLightV2BrickletFunction,
response_expected: bool,
) -> Result<(), SetResponseExpectedError>
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 sent and errors are silently ignored, because they cannot be detected.
Sourcepub fn set_response_expected_all(&mut self, response_expected: bool)
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.
Sourcepub fn get_api_version(&self) -> [u8; 3]
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.
Sourcepub async fn get_uva_callback_receiver(&mut self) -> impl Stream<Item = i32>
pub async fn get_uva_callback_receiver(&mut self) -> impl Stream<Item = i32>
This receiver is triggered periodically according to the configuration set by
set_uva_callback_configuration.
The parameter is the same as get_uva.
Sourcepub async fn get_uvb_callback_receiver(&mut self) -> impl Stream<Item = i32>
pub async fn get_uvb_callback_receiver(&mut self) -> impl Stream<Item = i32>
This receiver is triggered periodically according to the configuration set by
[set_uvb_callback_configuration].
The parameter is the same as [get_uvb].
Sourcepub async fn get_uvi_callback_receiver(&mut self) -> impl Stream<Item = i32>
pub async fn get_uvi_callback_receiver(&mut self) -> impl Stream<Item = i32>
This receiver is triggered periodically according to the configuration set by
[set_uvi_callback_configuration].
The parameter is the same as [get_uvi].
Sourcepub async fn get_uva(&mut self) -> Result<i32, TinkerforgeError>
pub async fn get_uva(&mut self) -> Result<i32, TinkerforgeError>
Returns the UVA intensity of the sensor.
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_callback_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_callback_configuration].
Sourcepub async fn set_uva_callback_configuration(
&mut self,
period: u32,
value_has_to_change: bool,
option: char,
min: i32,
max: i32,
) -> Result<(), TinkerforgeError>
pub async fn set_uva_callback_configuration( &mut self, period: u32, value_has_to_change: bool, option: char, min: i32, max: i32, ) -> Result<(), TinkerforgeError>
The period 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.
Associated constants:
- UV_LIGHT_V2_BRICKLET_THRESHOLD_OPTION_OFF
- UV_LIGHT_V2_BRICKLET_THRESHOLD_OPTION_OUTSIDE
- UV_LIGHT_V2_BRICKLET_THRESHOLD_OPTION_INSIDE
- UV_LIGHT_V2_BRICKLET_THRESHOLD_OPTION_SMALLER
- UV_LIGHT_V2_BRICKLET_THRESHOLD_OPTION_GREATER
Sourcepub async fn get_uva_callback_configuration(
&mut self,
) -> Result<UvaCallbackConfiguration, TinkerforgeError>
pub async fn get_uva_callback_configuration( &mut self, ) -> Result<UvaCallbackConfiguration, TinkerforgeError>
Returns the receiver configuration as set by [set_uva_callback_configuration].
Associated constants:
- UV_LIGHT_V2_BRICKLET_THRESHOLD_OPTION_OFF
- UV_LIGHT_V2_BRICKLET_THRESHOLD_OPTION_OUTSIDE
- UV_LIGHT_V2_BRICKLET_THRESHOLD_OPTION_INSIDE
- UV_LIGHT_V2_BRICKLET_THRESHOLD_OPTION_SMALLER
- UV_LIGHT_V2_BRICKLET_THRESHOLD_OPTION_GREATER
Sourcepub async fn get_uvb(&mut self) -> Result<i32, TinkerforgeError>
pub async fn get_uvb(&mut self) -> Result<i32, TinkerforgeError>
Returns the UVB intensity of the sensor.
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_callback_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_callback_configuration].
Sourcepub async fn set_uvb_callback_configuration(
&mut self,
period: u32,
value_has_to_change: bool,
option: char,
min: i32,
max: i32,
) -> Result<(), TinkerforgeError>
pub async fn set_uvb_callback_configuration( &mut self, period: u32, value_has_to_change: bool, option: char, min: i32, max: i32, ) -> Result<(), TinkerforgeError>
The period 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.
Associated constants:
- UV_LIGHT_V2_BRICKLET_THRESHOLD_OPTION_OFF
- UV_LIGHT_V2_BRICKLET_THRESHOLD_OPTION_OUTSIDE
- UV_LIGHT_V2_BRICKLET_THRESHOLD_OPTION_INSIDE
- UV_LIGHT_V2_BRICKLET_THRESHOLD_OPTION_SMALLER
- UV_LIGHT_V2_BRICKLET_THRESHOLD_OPTION_GREATER
Sourcepub async fn get_uvb_callback_configuration(
&mut self,
) -> Result<UvbCallbackConfiguration, TinkerforgeError>
pub async fn get_uvb_callback_configuration( &mut self, ) -> Result<UvbCallbackConfiguration, TinkerforgeError>
Returns the receiver configuration as set by [set_uvb_callback_configuration].
Associated constants:
- UV_LIGHT_V2_BRICKLET_THRESHOLD_OPTION_OFF
- UV_LIGHT_V2_BRICKLET_THRESHOLD_OPTION_OUTSIDE
- UV_LIGHT_V2_BRICKLET_THRESHOLD_OPTION_INSIDE
- UV_LIGHT_V2_BRICKLET_THRESHOLD_OPTION_SMALLER
- UV_LIGHT_V2_BRICKLET_THRESHOLD_OPTION_GREATER
Sourcepub async fn get_uvi(&mut self) -> Result<i32, TinkerforgeError>
pub async fn get_uvi(&mut self) -> Result<i32, TinkerforgeError>
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_callback_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_callback_configuration].
Sourcepub async fn set_uvi_callback_configuration(
&mut self,
period: u32,
value_has_to_change: bool,
option: char,
min: i32,
max: i32,
) -> Result<(), TinkerforgeError>
pub async fn set_uvi_callback_configuration( &mut self, period: u32, value_has_to_change: bool, option: char, min: i32, max: i32, ) -> Result<(), TinkerforgeError>
The period 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.
Associated constants:
- UV_LIGHT_V2_BRICKLET_THRESHOLD_OPTION_OFF
- UV_LIGHT_V2_BRICKLET_THRESHOLD_OPTION_OUTSIDE
- UV_LIGHT_V2_BRICKLET_THRESHOLD_OPTION_INSIDE
- UV_LIGHT_V2_BRICKLET_THRESHOLD_OPTION_SMALLER
- UV_LIGHT_V2_BRICKLET_THRESHOLD_OPTION_GREATER
Sourcepub async fn get_uvi_callback_configuration(
&mut self,
) -> Result<UviCallbackConfiguration, TinkerforgeError>
pub async fn get_uvi_callback_configuration( &mut self, ) -> Result<UviCallbackConfiguration, TinkerforgeError>
Returns the receiver configuration as set by [set_uvi_callback_configuration].
Associated constants:
- UV_LIGHT_V2_BRICKLET_THRESHOLD_OPTION_OFF
- UV_LIGHT_V2_BRICKLET_THRESHOLD_OPTION_OUTSIDE
- UV_LIGHT_V2_BRICKLET_THRESHOLD_OPTION_INSIDE
- UV_LIGHT_V2_BRICKLET_THRESHOLD_OPTION_SMALLER
- UV_LIGHT_V2_BRICKLET_THRESHOLD_OPTION_GREATER
Sourcepub async fn set_configuration(
&mut self,
integration_time: u8,
) -> Result<(), TinkerforgeError>
pub async fn set_configuration( &mut self, integration_time: u8, ) -> Result<(), TinkerforgeError>
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.
Associated constants:
- UV_LIGHT_V2_BRICKLET_INTEGRATION_TIME_50MS
- UV_LIGHT_V2_BRICKLET_INTEGRATION_TIME_100MS
- UV_LIGHT_V2_BRICKLET_INTEGRATION_TIME_200MS
- UV_LIGHT_V2_BRICKLET_INTEGRATION_TIME_400MS
- UV_LIGHT_V2_BRICKLET_INTEGRATION_TIME_800MS
Sourcepub async fn get_configuration(&mut self) -> Result<u8, TinkerforgeError>
pub async fn get_configuration(&mut self) -> Result<u8, TinkerforgeError>
Returns the configuration as set by [set_configuration].
Associated constants:
- UV_LIGHT_V2_BRICKLET_INTEGRATION_TIME_50MS
- UV_LIGHT_V2_BRICKLET_INTEGRATION_TIME_100MS
- UV_LIGHT_V2_BRICKLET_INTEGRATION_TIME_200MS
- UV_LIGHT_V2_BRICKLET_INTEGRATION_TIME_400MS
- UV_LIGHT_V2_BRICKLET_INTEGRATION_TIME_800MS
Sourcepub async fn get_spitfp_error_count(
&mut self,
) -> Result<SpitfpErrorCount, TinkerforgeError>
pub async fn get_spitfp_error_count( &mut self, ) -> Result<SpitfpErrorCount, TinkerforgeError>
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.
Sourcepub async fn set_bootloader_mode(
&mut self,
mode: u8,
) -> Result<u8, TinkerforgeError>
pub async fn set_bootloader_mode( &mut self, mode: u8, ) -> Result<u8, TinkerforgeError>
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_V2_BRICKLET_BOOTLOADER_MODE_BOOTLOADER
- UV_LIGHT_V2_BRICKLET_BOOTLOADER_MODE_FIRMWARE
- UV_LIGHT_V2_BRICKLET_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT
- UV_LIGHT_V2_BRICKLET_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT
- UV_LIGHT_V2_BRICKLET_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT
- UV_LIGHT_V2_BRICKLET_BOOTLOADER_STATUS_OK
- UV_LIGHT_V2_BRICKLET_BOOTLOADER_STATUS_INVALID_MODE
- UV_LIGHT_V2_BRICKLET_BOOTLOADER_STATUS_NO_CHANGE
- UV_LIGHT_V2_BRICKLET_BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT
- UV_LIGHT_V2_BRICKLET_BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT
- UV_LIGHT_V2_BRICKLET_BOOTLOADER_STATUS_CRC_MISMATCH
Sourcepub async fn get_bootloader_mode(&mut self) -> Result<u8, TinkerforgeError>
pub async fn get_bootloader_mode(&mut self) -> Result<u8, TinkerforgeError>
Returns the current bootloader mode, see [set_bootloader_mode].
Associated constants:
- UV_LIGHT_V2_BRICKLET_BOOTLOADER_MODE_BOOTLOADER
- UV_LIGHT_V2_BRICKLET_BOOTLOADER_MODE_FIRMWARE
- UV_LIGHT_V2_BRICKLET_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT
- UV_LIGHT_V2_BRICKLET_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT
- UV_LIGHT_V2_BRICKLET_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT
Sourcepub async fn set_write_firmware_pointer(
&mut self,
pointer: u32,
) -> Result<(), TinkerforgeError>
pub async fn set_write_firmware_pointer( &mut self, pointer: u32, ) -> Result<(), TinkerforgeError>
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.
Sourcepub async fn write_firmware(
&mut self,
data: &[u8; 64],
) -> Result<u8, TinkerforgeError>
pub async fn write_firmware( &mut self, data: &[u8; 64], ) -> Result<u8, TinkerforgeError>
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.
Sourcepub async fn set_status_led_config(
&mut self,
config: u8,
) -> Result<(), TinkerforgeError>
pub async fn set_status_led_config( &mut self, config: u8, ) -> Result<(), TinkerforgeError>
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_V2_BRICKLET_STATUS_LED_CONFIG_OFF
- UV_LIGHT_V2_BRICKLET_STATUS_LED_CONFIG_ON
- UV_LIGHT_V2_BRICKLET_STATUS_LED_CONFIG_SHOW_HEARTBEAT
- UV_LIGHT_V2_BRICKLET_STATUS_LED_CONFIG_SHOW_STATUS
Sourcepub async fn get_status_led_config(&mut self) -> Result<u8, TinkerforgeError>
pub async fn get_status_led_config(&mut self) -> Result<u8, TinkerforgeError>
Returns the configuration as set by [set_status_led_config]
Associated constants:
- UV_LIGHT_V2_BRICKLET_STATUS_LED_CONFIG_OFF
- UV_LIGHT_V2_BRICKLET_STATUS_LED_CONFIG_ON
- UV_LIGHT_V2_BRICKLET_STATUS_LED_CONFIG_SHOW_HEARTBEAT
- UV_LIGHT_V2_BRICKLET_STATUS_LED_CONFIG_SHOW_STATUS
Sourcepub async fn get_chip_temperature(&mut self) -> Result<i16, TinkerforgeError>
pub async fn get_chip_temperature(&mut self) -> Result<i16, TinkerforgeError>
Returns the temperature 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.
Sourcepub async fn reset(&mut self) -> Result<(), TinkerforgeError>
pub async fn reset(&mut self) -> Result<(), TinkerforgeError>
Calling this function will reset the Bricklet. All configurations will be lost.
After a reset you have to create new device objects, calling functions on the existing ones will result in undefined behavior!
Sourcepub async fn write_uid(&mut self, uid: u32) -> Result<(), TinkerforgeError>
pub async fn write_uid(&mut self, uid: u32) -> Result<(), TinkerforgeError>
Writes a new UID into flash. If you want to set a new UID you have to decode the Base58 encoded UID string into an integer first.
We recommend that you use Brick Viewer to change the UID.
Sourcepub async fn read_uid(&mut self) -> Result<u32, TinkerforgeError>
pub async fn read_uid(&mut self) -> Result<u32, TinkerforgeError>
Returns the current UID as an integer. Encode as Base58 to get the usual string version.
Sourcepub async fn get_identity(&mut self) -> Result<Identity, TinkerforgeError>
pub async fn get_identity(&mut self) -> Result<Identity, TinkerforgeError>
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’, ‘d’, ‘e’, ‘f’, ‘g’ or ‘h’ (Bricklet Port). A Bricklet connected to an Isolator Bricklet is always at position ‘z’.
The device identifier numbers can be found here. |device_identifier_constant|
Trait Implementations§
Source§impl Clone for UvLightV2Bricklet
impl Clone for UvLightV2Bricklet
Source§fn clone(&self) -> UvLightV2Bricklet
fn clone(&self) -> UvLightV2Bricklet
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read more