Rust - UV Light Bricklet

This is the description of the Rust API bindings for the UV Light Bricklet. General information and technical specifications for the UV Light Bricklet are summarized in its hardware description.

An installation guide for the Rust API bindings is part of their general description. Additional documentation can be found on docs.rs.

Examples

The example code below is Public Domain (CC0 1.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
use std::{error::Error, io};

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

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

fn main() -> Result<(), Box<dyn Error>> {
    let ipcon = IpConnection::new(); // Create IP connection.
    let uvl = UvLightBricklet::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 light.
    let uv_light = uvl.get_uv_light().recv()?;
    println!("UV Light: {} mW/m²", uv_light 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
35
36
use std::{error::Error, io, thread};
use tinkerforge::{ip_connection::IpConnection, uv_light_bricklet::*};

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

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

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

    let uv_light_receiver = uvl.get_uv_light_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 uv_light in uv_light_receiver {
            println!("UV Light: {} mW/m²", uv_light as f32 / 10.0);
        }
    });

    // Set period for UV light receiver to 1s (1000ms).
    // Note: The UV light callback is only called every second
    //       if the UV light has changed since the last call!
    uvl.set_uv_light_callback_period(1000);

    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
37
38
use std::{error::Error, io, thread};
use tinkerforge::{ip_connection::IpConnection, uv_light_bricklet::*};

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

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

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

    // Get threshold receivers with a debounce time of 10 seconds (10000ms).
    uvl.set_debounce_period(10000);

    let uv_light_reached_receiver = uvl.get_uv_light_reached_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 uv_light_reached in uv_light_reached_receiver {
            println!("UV Light: {} mW/m²", uv_light_reached as f32 / 10.0);
            println!("UV Index > 3. Use sunscreen!");
        }
    });

    // Configure threshold for UV light "greater than 75 mW/m²".
    uvl.set_uv_light_callback_threshold('>', 75 * 10, 0);

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

API

To allow non-blocking usage, nearly every function of the Rust bindings returns a wrapper around a mpsc::Receiver. To block until the function has finished and get your result, call one of the receiver's recv variants. Those return either the result sent by the device, or any error occured.

Functions returning a result directly will block until the device has finished processing the request.

All functions listed below are thread-safe, those which return a receiver are lock-free.

Basic Functions

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

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

This device object can be used after the IP connection has been connected (see examples above).

pub fn UvLightBricklet::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 UvLightBricklet::get_uv_light_callback_receiver callback and set the period with UvLightBricklet::set_uv_light_callback_period.

Advanced Functions

pub fn UvLightBricklet::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 UvLightBricklet::get_response_expected(&mut self, function_id: u8) → 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 UvLightBricklet::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 UvLightBricklet::set_response_expected for the list of function ID constants available for this function.

pub fn UvLightBricklet::set_response_expected(&mut self, function_id: u8, response_expected: 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 send and errors are silently ignored, because they cannot be detected.

The following function ID constants are available for this function:

  • UV_LIGHT_BRICKLET_FUNCTION_SET_UV_LIGHT_CALLBACK_PERIOD = 2
  • UV_LIGHT_BRICKLET_FUNCTION_SET_UV_LIGHT_CALLBACK_THRESHOLD = 4
  • UV_LIGHT_BRICKLET_FUNCTION_SET_DEBOUNCE_PERIOD = 6
pub fn UvLightBricklet::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 UvLightBricklet::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. There is also a constant for the device identifier of this Bricklet.

Callback Configuration Functions

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

Sets the period in ms with which the UvLightBricklet::get_uv_light_callback_receiver callback is triggered periodically. A value of 0 turns the callback off.

The UvLightBricklet::get_uv_light_callback_receiver callback is only triggered if the intensity has changed since the last triggering.

The default value is 0.

pub fn UvLightBricklet::get_uv_light_callback_period(&self) → ConvertingReceiver<u32>

Returns the period as set by UvLightBricklet::set_uv_light_callback_period.

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

Sets the thresholds for the UvLightBricklet::get_uv_light_reached_callback_receiver callback.

The following options are possible:

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

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

The following constants are available for this function:

  • UV_LIGHT_BRICKLET_THRESHOLD_OPTION_OFF = 'x'
  • UV_LIGHT_BRICKLET_THRESHOLD_OPTION_OUTSIDE = 'o'
  • UV_LIGHT_BRICKLET_THRESHOLD_OPTION_INSIDE = 'i'
  • UV_LIGHT_BRICKLET_THRESHOLD_OPTION_SMALLER = '<'
  • UV_LIGHT_BRICKLET_THRESHOLD_OPTION_GREATER = '>'
pub fn UvLightBricklet::get_uv_light_callback_threshold(&self) → ConvertingReceiver<UvLightCallbackThreshold>

Returns the threshold as set by UvLightBricklet::set_uv_light_callback_threshold.

The following constants are available for this function:

  • UV_LIGHT_BRICKLET_THRESHOLD_OPTION_OFF = 'x'
  • UV_LIGHT_BRICKLET_THRESHOLD_OPTION_OUTSIDE = 'o'
  • UV_LIGHT_BRICKLET_THRESHOLD_OPTION_INSIDE = 'i'
  • UV_LIGHT_BRICKLET_THRESHOLD_OPTION_SMALLER = '<'
  • UV_LIGHT_BRICKLET_THRESHOLD_OPTION_GREATER = '>'
pub fn UvLightBricklet::set_debounce_period(&self, debounce: u32) → ConvertingReceiver<()>

Sets the period in ms with which the threshold callbacks

are triggered, if the thresholds

keep being reached.

The default value is 100.

pub fn UvLightBricklet::get_debounce_period(&self) → ConvertingReceiver<u32>

Returns the debounce period as set by UvLightBricklet::set_debounce_period.

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.

Note

Using callbacks for recurring events is always preferred compared to using getters. It will use less USB bandwidth and the latency will be a lot better, since there is no round trip time.

pub fn UvLightBricklet::get_uv_light_callback_receiver(&self) → ConvertingCallbackReceiver<u32>

Receivers created with this function receive UV Light events.

This callback is triggered periodically with the period that is set by UvLightBricklet::set_uv_light_callback_period. The received variable is the UV Light intensity of the sensor.

The UvLightBricklet::get_uv_light_callback_receiver callback is only triggered if the intensity has changed since the last triggering.

pub fn UvLightBricklet::get_uv_light_reached_callback_receiver(&self) → ConvertingCallbackReceiver<u32>

Receivers created with this function receive UV Light Reached events.

This callback is triggered when the threshold as set by UvLightBricklet::set_uv_light_callback_threshold is reached. The received variable is the UV Light intensity of the sensor.

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

Constants

UvLightBricklet::DEVICE_IDENTIFIER

This constant is used to identify a UV Light Bricklet.

The UvLightBricklet::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.

UvLightBricklet::DEVICE_DISPLAY_NAME

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