Rust - UV Light Bricklet 2.0¶

Simple¶

Download (example_simple.rs)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33

use std::{error::Error, io};

use tinkerforge::{ip_connection::IpConnection, uv_light_v2_bricklet::*};

const HOST: &str = "localhost";
const PORT: u16 = 4223;
const UID: &str = "XYZ"; // Change XYZ to the UID of your UV Light Bricklet 2.0.

fn main() -> Result<(), Box<dyn Error>> {
    let ipcon = IpConnection::new(); // Create IP connection.
    let uvl = UvLightV2Bricklet::new(UID, &ipcon); // Create device object.

    ipcon.connect((HOST, PORT)).recv()??; // Connect to brickd.
                                          // Don't use device before ipcon is connected.

    // Get current UV-A.
    let uva = uvl.get_uva().recv()?;
    println!("UV-A: {} mW/m²", uva as f32 / 10.0);

    // Get current UV-B.
    let uvb = uvl.get_uvb().recv()?;
    println!("UV-B: {} mW/m²", uvb as f32 / 10.0);

    // Get current UV index.
    let uvi = uvl.get_uvi().recv()?;
    println!("UV Index: {}", uvi as f32 / 10.0);

    println!("Press enter to exit.");
    let mut _input = String::new();
    io::stdin().read_line(&mut _input)?;
    ipcon.disconnect();
    Ok(())
}

Callback¶

Download (example_callback.rs)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34

use std::{error::Error, io, thread};
use tinkerforge::{ip_connection::IpConnection, uv_light_v2_bricklet::*};

const HOST: &str = "localhost";
const PORT: u16 = 4223;
const UID: &str = "XYZ"; // Change XYZ to the UID of your UV Light Bricklet 2.0.

fn main() -> Result<(), Box<dyn Error>> {
    let ipcon = IpConnection::new(); // Create IP connection.
    let uvl = UvLightV2Bricklet::new(UID, &ipcon); // Create device object.

    ipcon.connect((HOST, PORT)).recv()??; // Connect to brickd.
                                          // Don't use device before ipcon is connected.

    let uvi_receiver = uvl.get_uvi_callback_receiver();

    // Spawn thread to handle received callback messages.
    // This thread ends when the `uvl` object
    // is dropped, so there is no need for manual cleanup.
    thread::spawn(move || {
        for uvi in uvi_receiver {
            println!("UV Index: {}", uvi as f32 / 10.0);
        }
    });

    // Set period for UVI callback to 1s (1000ms) without a threshold.
    uvl.set_uvi_callback_configuration(1000, false, 'x', 0, 0);

    println!("Press enter to exit.");
    let mut _input = String::new();
    io::stdin().read_line(&mut _input)?;
    ipcon.disconnect();
    Ok(())
}

Threshold¶

Download (example_threshold.rs)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36

use std::{error::Error, io, thread};
use tinkerforge::{ip_connection::IpConnection, uv_light_v2_bricklet::*};

const HOST: &str = "localhost";
const PORT: u16 = 4223;
const UID: &str = "XYZ"; // Change XYZ to the UID of your UV Light Bricklet 2.0.

fn main() -> Result<(), Box<dyn Error>> {
    let ipcon = IpConnection::new(); // Create IP connection.
    let uvl = UvLightV2Bricklet::new(UID, &ipcon); // Create device object.

    ipcon.connect((HOST, PORT)).recv()??; // Connect to brickd.
                                          // Don't use device before ipcon is connected.

    let uvi_receiver = uvl.get_uvi_callback_receiver();

    // Spawn thread to handle received callback messages.
    // This thread ends when the `uvl` object
    // is dropped, so there is no need for manual cleanup.
    thread::spawn(move || {
        for uvi in uvi_receiver {
            println!("UV Index: {}", uvi as f32 / 10.0);
            println!("UV index > 3. Use sunscreen!");
        }
    });

    // Configure threshold for UV index "greater than 3"
    // with a debounce period of 1s (1000ms).
    uvl.set_uvi_callback_configuration(1000, false, '>', 3 * 10, 0);

    println!("Press enter to exit.");
    let mut _input = String::new();
    io::stdin().read_line(&mut _input)?;
    ipcon.disconnect();
    Ok(())
}

Basic Functions¶

pub fn UvLightV2Bricklet::new(uid: &str, ip_connection: &IpConnection) → UvLightV2Bricklet¶

Parameters:	uid – Type: &str ip_connection – Type: &IPConnection
Returns:	uv_light_v2 – Type: UvLightV2Bricklet

Creates a new UvLightV2Bricklet object with the unique device ID uid and adds it to the IPConnection ip_connection:

let uv_light_v2 = UvLightV2Bricklet::new("YOUR_DEVICE_UID", &ip_connection);

This device object can be used after the IP connection has been connected.

pub fn UvLightV2Bricklet::get_uva(&self) → ConvertingReceiver<i32>¶

Returns:	uva – Type: i32, Unit: 1/10 mW/m², Range: [-1 to 231 - 1]

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 UvLightV2Bricklet::get_uvi.

If the sensor is saturated, then -1 is returned, see UvLightV2Bricklet::set_configuration.

If you want to get the intensity periodically, it is recommended to use the UvLightV2Bricklet::get_uva_callback_receiver callback and set the period with UvLightV2Bricklet::set_uva_callback_configuration.

If you want to get the value periodically, it is recommended to use the UvLightV2Bricklet::get_uva_callback_receiver callback. You can set the callback configuration with UvLightV2Bricklet::set_uva_callback_configuration.

pub fn UvLightV2Bricklet::get_uvb(&self) → ConvertingReceiver<i32>¶

Returns:	uvb – Type: i32, Unit: 1/10 mW/m², Range: [-1 to 231 - 1]

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 UvLightV2Bricklet::get_uvi.

If the sensor is saturated, then -1 is returned, see UvLightV2Bricklet::set_configuration.

If you want to get the intensity periodically, it is recommended to use the UvLightV2Bricklet::get_uvb_callback_receiver callback and set the period with UvLightV2Bricklet::set_uvb_callback_configuration.

If you want to get the value periodically, it is recommended to use the UvLightV2Bricklet::get_uvb_callback_receiver callback. You can set the callback configuration with UvLightV2Bricklet::set_uvb_callback_configuration.

pub fn UvLightV2Bricklet::get_uvi(&self) → ConvertingReceiver<i32>¶

Returns:	uvi – Type: i32, Unit: 1/10 , Range: [-1 to 231 - 1]

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

If the sensor is saturated, then -1 is returned, see UvLightV2Bricklet::set_configuration.

If you want to get the intensity periodically, it is recommended to use the UvLightV2Bricklet::get_uvi_callback_receiver callback and set the period with UvLightV2Bricklet::set_uvi_callback_configuration.

If you want to get the value periodically, it is recommended to use the UvLightV2Bricklet::get_uvi_callback_receiver callback. You can set the callback configuration with UvLightV2Bricklet::set_uvi_callback_configuration.

Advanced Functions¶

pub fn UvLightV2Bricklet::set_configuration(&self, integration_time: u8) → ConvertingReceiver<()>¶

Parameters:	integration_time – Type: u8, Range: See constants, Default: 3

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.

The following constants are available for this function:

For integration_time:

• UV_LIGHT_V2_BRICKLET_INTEGRATION_TIME_50MS = 0
• UV_LIGHT_V2_BRICKLET_INTEGRATION_TIME_100MS = 1
• UV_LIGHT_V2_BRICKLET_INTEGRATION_TIME_200MS = 2
• UV_LIGHT_V2_BRICKLET_INTEGRATION_TIME_400MS = 3
• UV_LIGHT_V2_BRICKLET_INTEGRATION_TIME_800MS = 4

pub fn UvLightV2Bricklet::get_configuration(&self) → ConvertingReceiver<u8>¶

Returns:	integration_time – Type: u8, Range: See constants, Default: 3

Returns the configuration as set by UvLightV2Bricklet::set_configuration.

The following constants are available for this function:

For integration_time:

• UV_LIGHT_V2_BRICKLET_INTEGRATION_TIME_50MS = 0
• UV_LIGHT_V2_BRICKLET_INTEGRATION_TIME_100MS = 1
• UV_LIGHT_V2_BRICKLET_INTEGRATION_TIME_200MS = 2
• UV_LIGHT_V2_BRICKLET_INTEGRATION_TIME_400MS = 3
• UV_LIGHT_V2_BRICKLET_INTEGRATION_TIME_800MS = 4

pub fn UvLightV2Bricklet::get_spitfp_error_count(&self) → ConvertingReceiver<SpitfpErrorCount>¶

Return Object:	error_count_ack_checksum – Type: u32, Range: [0 to 232 - 1] error_count_message_checksum – Type: u32, Range: [0 to 232 - 1] error_count_frame – Type: u32, Range: [0 to 232 - 1] error_count_overflow – Type: u32, Range: [0 to 232 - 1]

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.

pub fn UvLightV2Bricklet::set_status_led_config(&self, config: u8) → ConvertingReceiver<()>¶

Parameters:	config – Type: u8, Range: See constants, Default: 3

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.

The following constants are available for this function:

For config:

• UV_LIGHT_V2_BRICKLET_STATUS_LED_CONFIG_OFF = 0
• UV_LIGHT_V2_BRICKLET_STATUS_LED_CONFIG_ON = 1
• UV_LIGHT_V2_BRICKLET_STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
• UV_LIGHT_V2_BRICKLET_STATUS_LED_CONFIG_SHOW_STATUS = 3

pub fn UvLightV2Bricklet::get_status_led_config(&self) → ConvertingReceiver<u8>¶

Returns:	config – Type: u8, Range: See constants, Default: 3

Returns the configuration as set by UvLightV2Bricklet::set_status_led_config

The following constants are available for this function:

For config:

• UV_LIGHT_V2_BRICKLET_STATUS_LED_CONFIG_OFF = 0
• UV_LIGHT_V2_BRICKLET_STATUS_LED_CONFIG_ON = 1
• UV_LIGHT_V2_BRICKLET_STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
• UV_LIGHT_V2_BRICKLET_STATUS_LED_CONFIG_SHOW_STATUS = 3

pub fn UvLightV2Bricklet::get_chip_temperature(&self) → ConvertingReceiver<i16>¶

Returns:	temperature – Type: i16, Unit: 1 °C, Range: [-215 to 215 - 1]

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.

pub fn UvLightV2Bricklet::reset(&self) → ConvertingReceiver<()>¶

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!

pub fn UvLightV2Bricklet::get_identity(&self) → ConvertingReceiver<Identity>¶

Return Object:

uid – Type: String, Length: up to 8 connected_uid – Type: String, Length: up to 8 position – Type: char, Range: ['a' to 'h', 'z'] hardware_version – Type: [u8; 3] 0: major – Type: u8, Range: [0 to 255] 1: minor – Type: u8, Range: [0 to 255] 2: revision – Type: u8, Range: [0 to 255] firmware_version – Type: [u8; 3] 0: major – Type: u8, Range: [0 to 255] 1: minor – Type: u8, Range: [0 to 255] 2: revision – Type: u8, Range: [0 to 255] device_identifier – Type: u16, Range: [0 to 216 - 1]

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. There is also a constant for the device identifier of this Bricklet.

Callback Configuration Functions¶

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

Parameters:	period – Type: u32, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0 value_has_to_change – Type: bool, Default: false option – Type: char, Range: See constants, Default: 'x' min – Type: i32, Unit: 1/10 mW/m², Range: [-231 to 231 - 1], Default: 0 max – Type: i32, Unit: 1/10 mW/m², Range: [-231 to 231 - 1], Default: 0

The period is the period with which the UvLightV2Bricklet::get_uva_callback_receiver callback is triggered periodically. A value of 0 turns the callback off.

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

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

It is furthermore possible to constrain the callback with thresholds.

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

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 callback is triggered with the fixed period.

The following constants are available for this function:

For option:

• UV_LIGHT_V2_BRICKLET_THRESHOLD_OPTION_OFF = 'x'
• UV_LIGHT_V2_BRICKLET_THRESHOLD_OPTION_OUTSIDE = 'o'
• UV_LIGHT_V2_BRICKLET_THRESHOLD_OPTION_INSIDE = 'i'
• UV_LIGHT_V2_BRICKLET_THRESHOLD_OPTION_SMALLER = '<'
• UV_LIGHT_V2_BRICKLET_THRESHOLD_OPTION_GREATER = '>'

pub fn UvLightV2Bricklet::get_uva_callback_configuration(&self) → ConvertingReceiver<UvaCallbackConfiguration>¶

Return Object:	period – Type: u32, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0 value_has_to_change – Type: bool, Default: false option – Type: char, Range: See constants, Default: 'x' min – Type: i32, Unit: 1/10 mW/m², Range: [-231 to 231 - 1], Default: 0 max – Type: i32, Unit: 1/10 mW/m², Range: [-231 to 231 - 1], Default: 0

Returns the callback configuration as set by UvLightV2Bricklet::set_uva_callback_configuration.

The following constants are available for this function:

For option:

• UV_LIGHT_V2_BRICKLET_THRESHOLD_OPTION_OFF = 'x'
• UV_LIGHT_V2_BRICKLET_THRESHOLD_OPTION_OUTSIDE = 'o'
• UV_LIGHT_V2_BRICKLET_THRESHOLD_OPTION_INSIDE = 'i'
• UV_LIGHT_V2_BRICKLET_THRESHOLD_OPTION_SMALLER = '<'
• UV_LIGHT_V2_BRICKLET_THRESHOLD_OPTION_GREATER = '>'

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

Parameters:	period – Type: u32, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0 value_has_to_change – Type: bool, Default: false option – Type: char, Range: See constants, Default: 'x' min – Type: i32, Unit: 1/10 mW/m², Range: [-231 to 231 - 1], Default: 0 max – Type: i32, Unit: 1/10 mW/m², Range: [-231 to 231 - 1], Default: 0

The period is the period with which the UvLightV2Bricklet::get_uvb_callback_receiver callback is triggered periodically. A value of 0 turns the callback off.

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

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

It is furthermore possible to constrain the callback with thresholds.

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

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 callback is triggered with the fixed period.

The following constants are available for this function:

For option:

• UV_LIGHT_V2_BRICKLET_THRESHOLD_OPTION_OFF = 'x'
• UV_LIGHT_V2_BRICKLET_THRESHOLD_OPTION_OUTSIDE = 'o'
• UV_LIGHT_V2_BRICKLET_THRESHOLD_OPTION_INSIDE = 'i'
• UV_LIGHT_V2_BRICKLET_THRESHOLD_OPTION_SMALLER = '<'
• UV_LIGHT_V2_BRICKLET_THRESHOLD_OPTION_GREATER = '>'

pub fn UvLightV2Bricklet::get_uvb_callback_configuration(&self) → ConvertingReceiver<UvbCallbackConfiguration>¶

Return Object:	period – Type: u32, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0 value_has_to_change – Type: bool, Default: false option – Type: char, Range: See constants, Default: 'x' min – Type: i32, Unit: 1/10 mW/m², Range: [-231 to 231 - 1], Default: 0 max – Type: i32, Unit: 1/10 mW/m², Range: [-231 to 231 - 1], Default: 0

Returns the callback configuration as set by UvLightV2Bricklet::set_uvb_callback_configuration.

The following constants are available for this function:

For option:

• UV_LIGHT_V2_BRICKLET_THRESHOLD_OPTION_OFF = 'x'
• UV_LIGHT_V2_BRICKLET_THRESHOLD_OPTION_OUTSIDE = 'o'
• UV_LIGHT_V2_BRICKLET_THRESHOLD_OPTION_INSIDE = 'i'
• UV_LIGHT_V2_BRICKLET_THRESHOLD_OPTION_SMALLER = '<'
• UV_LIGHT_V2_BRICKLET_THRESHOLD_OPTION_GREATER = '>'

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

Parameters:	period – Type: u32, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0 value_has_to_change – Type: bool, Default: false option – Type: char, Range: See constants, Default: 'x' min – Type: i32, Unit: 1/10 , Range: [-231 to 231 - 1], Default: 0 max – Type: i32, Unit: 1/10 , Range: [-231 to 231 - 1], Default: 0

The period is the period with which the UvLightV2Bricklet::get_uvi_callback_receiver callback is triggered periodically. A value of 0 turns the callback off.

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

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

It is furthermore possible to constrain the callback with thresholds.

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

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 callback is triggered with the fixed period.

The following constants are available for this function:

For option:

• UV_LIGHT_V2_BRICKLET_THRESHOLD_OPTION_OFF = 'x'
• UV_LIGHT_V2_BRICKLET_THRESHOLD_OPTION_OUTSIDE = 'o'
• UV_LIGHT_V2_BRICKLET_THRESHOLD_OPTION_INSIDE = 'i'
• UV_LIGHT_V2_BRICKLET_THRESHOLD_OPTION_SMALLER = '<'
• UV_LIGHT_V2_BRICKLET_THRESHOLD_OPTION_GREATER = '>'

pub fn UvLightV2Bricklet::get_uvi_callback_configuration(&self) → ConvertingReceiver<UviCallbackConfiguration>¶

Return Object:	period – Type: u32, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0 value_has_to_change – Type: bool, Default: false option – Type: char, Range: See constants, Default: 'x' min – Type: i32, Unit: 1/10 , Range: [-231 to 231 - 1], Default: 0 max – Type: i32, Unit: 1/10 , Range: [-231 to 231 - 1], Default: 0

Returns the callback configuration as set by UvLightV2Bricklet::set_uvi_callback_configuration.

The following constants are available for this function:

For option:

• UV_LIGHT_V2_BRICKLET_THRESHOLD_OPTION_OFF = 'x'
• UV_LIGHT_V2_BRICKLET_THRESHOLD_OPTION_OUTSIDE = 'o'
• UV_LIGHT_V2_BRICKLET_THRESHOLD_OPTION_INSIDE = 'i'
• UV_LIGHT_V2_BRICKLET_THRESHOLD_OPTION_SMALLER = '<'
• UV_LIGHT_V2_BRICKLET_THRESHOLD_OPTION_GREATER = '>'

Callbacks¶

Callbacks can be registered to receive time critical or recurring data from the device. The registration is done with the corresponding get_*_callback_receiver function, which returns a receiver for callback events.

pub fn UvLightV2Bricklet::get_uva_callback_receiver(&self) → ConvertingCallbackReceiver<i32>¶

Event:	uva – Type: i32, Unit: 1/10 mW/m², Range: [-1 to 231 - 1]

Receivers created with this function receive UVA events.

This callback is triggered periodically according to the configuration set by UvLightV2Bricklet::set_uva_callback_configuration.

The received variable is the same as UvLightV2Bricklet::get_uva.

pub fn UvLightV2Bricklet::get_uvb_callback_receiver(&self) → ConvertingCallbackReceiver<i32>¶

Event:	uvb – Type: i32, Unit: 1/10 mW/m², Range: [-1 to 231 - 1]

Receivers created with this function receive UVB events.

This callback is triggered periodically according to the configuration set by UvLightV2Bricklet::set_uvb_callback_configuration.

The received variable is the same as UvLightV2Bricklet::get_uvb.

pub fn UvLightV2Bricklet::get_uvi_callback_receiver(&self) → ConvertingCallbackReceiver<i32>¶

Event:	uvi – Type: i32, Unit: 1/10 , Range: [-1 to 231 - 1]

Receivers created with this function receive UVI events.

This callback is triggered periodically according to the configuration set by UvLightV2Bricklet::set_uvi_callback_configuration.

The received variable is the same as UvLightV2Bricklet::get_uvi.

Virtual Functions¶

Virtual functions don't communicate with the device itself, but operate only on the API bindings device object. They can be called without the corresponding IP Connection object being connected.

pub fn UvLightV2Bricklet::get_api_version(&self) → [u8; 3]¶

Return Object:	api_version – Type: [u8; 3] 0: major – Type: u8, Range: [0 to 255] 1: minor – Type: u8, Range: [0 to 255] 2: revision – Type: u8, Range: [0 to 255]

Returns the version of the API definition 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 UvLightV2Bricklet::get_response_expected(&mut self, function_id: u8) → bool¶

Parameters:	function_id – Type: u8, Range: See constants
Returns:	response_expected – Type: bool

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 UvLightV2Bricklet::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.

The following constants are available for this function:

For function_id:

• UV_LIGHT_V2_BRICKLET_FUNCTION_SET_UVA_CALLBACK_CONFIGURATION = 2
• UV_LIGHT_V2_BRICKLET_FUNCTION_SET_UVB_CALLBACK_CONFIGURATION = 6
• UV_LIGHT_V2_BRICKLET_FUNCTION_SET_UVI_CALLBACK_CONFIGURATION = 10
• UV_LIGHT_V2_BRICKLET_FUNCTION_SET_CONFIGURATION = 13
• UV_LIGHT_V2_BRICKLET_FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
• UV_LIGHT_V2_BRICKLET_FUNCTION_SET_STATUS_LED_CONFIG = 239
• UV_LIGHT_V2_BRICKLET_FUNCTION_RESET = 243
• UV_LIGHT_V2_BRICKLET_FUNCTION_WRITE_UID = 248

pub fn UvLightV2Bricklet::set_response_expected(&mut self, function_id: u8, response_expected: bool) → ()¶

Parameters:	function_id – Type: u8, Range: See constants response_expected – Type: bool

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.

The following constants are available for this function:

For function_id:

• UV_LIGHT_V2_BRICKLET_FUNCTION_SET_UVA_CALLBACK_CONFIGURATION = 2
• UV_LIGHT_V2_BRICKLET_FUNCTION_SET_UVB_CALLBACK_CONFIGURATION = 6
• UV_LIGHT_V2_BRICKLET_FUNCTION_SET_UVI_CALLBACK_CONFIGURATION = 10
• UV_LIGHT_V2_BRICKLET_FUNCTION_SET_CONFIGURATION = 13
• UV_LIGHT_V2_BRICKLET_FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
• UV_LIGHT_V2_BRICKLET_FUNCTION_SET_STATUS_LED_CONFIG = 239
• UV_LIGHT_V2_BRICKLET_FUNCTION_RESET = 243
• UV_LIGHT_V2_BRICKLET_FUNCTION_WRITE_UID = 248

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

Parameters:	response_expected – Type: bool

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

Internal Functions¶

Internal functions are used for maintenance tasks such as flashing a new firmware of changing the UID of a Bricklet. These task should be performed using Brick Viewer instead of using the internal functions directly.

pub fn UvLightV2Bricklet::set_bootloader_mode(&self, mode: u8) → ConvertingReceiver<u8>¶

Parameters:	mode – Type: u8, Range: See constants
Returns:	status – Type: u8, Range: See constants

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.

The following constants are available for this function:

For mode:

• UV_LIGHT_V2_BRICKLET_BOOTLOADER_MODE_BOOTLOADER = 0
• UV_LIGHT_V2_BRICKLET_BOOTLOADER_MODE_FIRMWARE = 1
• UV_LIGHT_V2_BRICKLET_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
• UV_LIGHT_V2_BRICKLET_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
• UV_LIGHT_V2_BRICKLET_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4

For status:

• UV_LIGHT_V2_BRICKLET_BOOTLOADER_STATUS_OK = 0
• UV_LIGHT_V2_BRICKLET_BOOTLOADER_STATUS_INVALID_MODE = 1
• UV_LIGHT_V2_BRICKLET_BOOTLOADER_STATUS_NO_CHANGE = 2
• UV_LIGHT_V2_BRICKLET_BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT = 3
• UV_LIGHT_V2_BRICKLET_BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT = 4
• UV_LIGHT_V2_BRICKLET_BOOTLOADER_STATUS_CRC_MISMATCH = 5

pub fn UvLightV2Bricklet::get_bootloader_mode(&self) → ConvertingReceiver<u8>¶

Returns:	mode – Type: u8, Range: See constants

Returns the current bootloader mode, see UvLightV2Bricklet::set_bootloader_mode.

The following constants are available for this function:

For mode:

• UV_LIGHT_V2_BRICKLET_BOOTLOADER_MODE_BOOTLOADER = 0
• UV_LIGHT_V2_BRICKLET_BOOTLOADER_MODE_FIRMWARE = 1
• UV_LIGHT_V2_BRICKLET_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
• UV_LIGHT_V2_BRICKLET_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
• UV_LIGHT_V2_BRICKLET_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4

pub fn UvLightV2Bricklet::set_write_firmware_pointer(&self, pointer: u32) → ConvertingReceiver<()>¶

Parameters:	pointer – Type: u32, Unit: 1 B, Range: [0 to 232 - 1]

Sets the firmware pointer for UvLightV2Bricklet::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.

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

Parameters:	data – Type: [u8; 64], Range: [0 to 255]
Returns:	status – Type: u8, Range: [0 to 255]

Writes 64 Bytes of firmware at the position as written by UvLightV2Bricklet::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.

pub fn UvLightV2Bricklet::write_uid(&self, uid: u32) → ConvertingReceiver<()>¶

Parameters:	uid – Type: u32, Range: [0 to 232 - 1]

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.

pub fn UvLightV2Bricklet::read_uid(&self) → ConvertingReceiver<u32>¶

Returns:	uid – Type: u32, Range: [0 to 232 - 1]

Returns the current UID as an integer. Encode as Base58 to get the usual string version.

Constants¶

pub const UvLightV2Bricklet::DEVICE_IDENTIFIER¶

This constant is used to identify a UV Light Bricklet 2.0.

The UvLightV2Bricklet::get_identity function and the IpConnection::get_enumerate_callback_receiver callback of the IP Connection have a device_identifier parameter to specify the Brick's or Bricklet's type.

pub const UvLightV2Bricklet::DEVICE_DISPLAY_NAME¶

This constant represents the human readable name of a UV Light Bricklet 2.0.