Rust - Ambient Light Bricklet

This is the description of the Rust API bindings for the Ambient Light Bricklet. General information and technical specifications for the Ambient 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::{ambient_light_bricklet::*, ip_connection::IpConnection};

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

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

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

    // Get current illuminance.
    let illuminance = al.get_illuminance().recv()?;
    println!("Illuminance: {} lx", illuminance 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::{ambient_light_bricklet::*, ip_connection::IpConnection};

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

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

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

    let illuminance_receiver = al.get_illuminance_callback_receiver();

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

    // Set period for illuminance receiver to 1s (1000ms).
    // Note: The illuminance callback is only called every second
    //       if the illuminance has changed since the last call!
    al.set_illuminance_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::{ambient_light_bricklet::*, ip_connection::IpConnection};

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

fn main() -> Result<(), Box<dyn Error>> {
    let ipcon = IpConnection::new(); // Create IP connection.
    let al = AmbientLightBricklet::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).
    al.set_debounce_period(10000);

    let illuminance_reached_receiver = al.get_illuminance_reached_callback_receiver();

    // Spawn thread to handle received callback messages.
    // This thread ends when the `al` object
    // is dropped, so there is no need for manual cleanup.
    thread::spawn(move || {
        for illuminance_reached in illuminance_reached_receiver {
            println!("Illuminance: {} lx", illuminance_reached as f32 / 10.0);
            println!("Too bright, close the curtains!");
        }
    });

    // Configure threshold for illuminance "greater than 200 lx".
    al.set_illuminance_callback_threshold('>', 200 * 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 AmbientLightBricklet::new(uid: &str, ip_connection: &IpConnection) → AmbientLightBricklet

Creates a new AmbientLightBricklet 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 AmbientLightBricklet::get_illuminance(&self) → ConvertingReceiver<u16>

Returns the illuminance of the ambient light sensor. The value has a range of 0 to 9000 and is given in lux/10, i.e. a value of 4500 means that an illuminance of 450lux is measured.

If you want to get the illuminance periodically, it is recommended to use the AmbientLightBricklet::get_illuminance_callback_receiver callback and set the period with AmbientLightBricklet::set_illuminance_callback_period.

Advanced Functions

pub fn AmbientLightBricklet::get_analog_value(&self) → ConvertingReceiver<u16>

Returns the value as read by a 12-bit analog-to-digital converter. The value is between 0 and 4095.

Note

The value returned by AmbientLightBricklet::get_illuminance is averaged over several samples to yield less noise, while AmbientLightBricklet::get_analog_value gives back raw unfiltered analog values. The only reason to use AmbientLightBricklet::get_analog_value is, if you need the full resolution of the analog-to-digital converter.

Also, the analog-to-digital converter covers three different ranges that are set dynamically depending on the light intensity. It is impossible to distinguish between these ranges with the analog value.

If you want the analog value periodically, it is recommended to use the AmbientLightBricklet::get_analog_value_callback_receiver callback and set the period with AmbientLightBricklet::set_analog_value_callback_period.

pub fn AmbientLightBricklet::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 AmbientLightBricklet::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 AmbientLightBricklet::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 AmbientLightBricklet::set_response_expected for the list of function ID constants available for this function.

pub fn AmbientLightBricklet::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:

  • AMBIENT_LIGHT_BRICKLET_FUNCTION_SET_ILLUMINANCE_CALLBACK_PERIOD = 3
  • AMBIENT_LIGHT_BRICKLET_FUNCTION_SET_ANALOG_VALUE_CALLBACK_PERIOD = 5
  • AMBIENT_LIGHT_BRICKLET_FUNCTION_SET_ILLUMINANCE_CALLBACK_THRESHOLD = 7
  • AMBIENT_LIGHT_BRICKLET_FUNCTION_SET_ANALOG_VALUE_CALLBACK_THRESHOLD = 9
  • AMBIENT_LIGHT_BRICKLET_FUNCTION_SET_DEBOUNCE_PERIOD = 11
pub fn AmbientLightBricklet::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 AmbientLightBricklet::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 AmbientLightBricklet::set_illuminance_callback_period(&self, period: u32) → ConvertingReceiver<()>

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

The AmbientLightBricklet::get_illuminance_callback_receiver callback is only triggered if the illuminance has changed since the last triggering.

The default value is 0.

pub fn AmbientLightBricklet::get_illuminance_callback_period(&self) → ConvertingReceiver<u32>

Returns the period as set by AmbientLightBricklet::set_illuminance_callback_period.

pub fn AmbientLightBricklet::set_analog_value_callback_period(&self, period: u32) → ConvertingReceiver<()>

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

The AmbientLightBricklet::get_analog_value_callback_receiver callback is only triggered if the analog value has changed since the last triggering.

The default value is 0.

pub fn AmbientLightBricklet::get_analog_value_callback_period(&self) → ConvertingReceiver<u32>

Returns the period as set by AmbientLightBricklet::set_analog_value_callback_period.

pub fn AmbientLightBricklet::set_illuminance_callback_threshold(&self, option: char, min: u16, max: u16) → ConvertingReceiver<()>

Sets the thresholds for the AmbientLightBricklet::get_illuminance_reached_callback_receiver callback.

The following options are possible:

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

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

The following constants are available for this function:

  • AMBIENT_LIGHT_BRICKLET_THRESHOLD_OPTION_OFF = 'x'
  • AMBIENT_LIGHT_BRICKLET_THRESHOLD_OPTION_OUTSIDE = 'o'
  • AMBIENT_LIGHT_BRICKLET_THRESHOLD_OPTION_INSIDE = 'i'
  • AMBIENT_LIGHT_BRICKLET_THRESHOLD_OPTION_SMALLER = '<'
  • AMBIENT_LIGHT_BRICKLET_THRESHOLD_OPTION_GREATER = '>'
pub fn AmbientLightBricklet::get_illuminance_callback_threshold(&self) → ConvertingReceiver<IlluminanceCallbackThreshold>

Returns the threshold as set by AmbientLightBricklet::set_illuminance_callback_threshold.

The following constants are available for this function:

  • AMBIENT_LIGHT_BRICKLET_THRESHOLD_OPTION_OFF = 'x'
  • AMBIENT_LIGHT_BRICKLET_THRESHOLD_OPTION_OUTSIDE = 'o'
  • AMBIENT_LIGHT_BRICKLET_THRESHOLD_OPTION_INSIDE = 'i'
  • AMBIENT_LIGHT_BRICKLET_THRESHOLD_OPTION_SMALLER = '<'
  • AMBIENT_LIGHT_BRICKLET_THRESHOLD_OPTION_GREATER = '>'
pub fn AmbientLightBricklet::set_analog_value_callback_threshold(&self, option: char, min: u16, max: u16) → ConvertingReceiver<()>

Sets the thresholds for the AmbientLightBricklet::get_analog_value_reached_callback_receiver callback.

The following options are possible:

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

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

The following constants are available for this function:

  • AMBIENT_LIGHT_BRICKLET_THRESHOLD_OPTION_OFF = 'x'
  • AMBIENT_LIGHT_BRICKLET_THRESHOLD_OPTION_OUTSIDE = 'o'
  • AMBIENT_LIGHT_BRICKLET_THRESHOLD_OPTION_INSIDE = 'i'
  • AMBIENT_LIGHT_BRICKLET_THRESHOLD_OPTION_SMALLER = '<'
  • AMBIENT_LIGHT_BRICKLET_THRESHOLD_OPTION_GREATER = '>'
pub fn AmbientLightBricklet::get_analog_value_callback_threshold(&self) → ConvertingReceiver<AnalogValueCallbackThreshold>

Returns the threshold as set by AmbientLightBricklet::set_analog_value_callback_threshold.

The following constants are available for this function:

  • AMBIENT_LIGHT_BRICKLET_THRESHOLD_OPTION_OFF = 'x'
  • AMBIENT_LIGHT_BRICKLET_THRESHOLD_OPTION_OUTSIDE = 'o'
  • AMBIENT_LIGHT_BRICKLET_THRESHOLD_OPTION_INSIDE = 'i'
  • AMBIENT_LIGHT_BRICKLET_THRESHOLD_OPTION_SMALLER = '<'
  • AMBIENT_LIGHT_BRICKLET_THRESHOLD_OPTION_GREATER = '>'
pub fn AmbientLightBricklet::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 AmbientLightBricklet::get_debounce_period(&self) → ConvertingReceiver<u32>

Returns the debounce period as set by AmbientLightBricklet::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 AmbientLightBricklet::get_illuminance_callback_receiver(&self) → ConvertingCallbackReceiver<u16>

Receivers created with this function receive Illuminance events.

This callback is triggered periodically with the period that is set by AmbientLightBricklet::set_illuminance_callback_period. The received variable is the illuminance of the ambient light sensor.

The AmbientLightBricklet::get_illuminance_callback_receiver callback is only triggered if the illuminance has changed since the last triggering.

pub fn AmbientLightBricklet::get_analog_value_callback_receiver(&self) → ConvertingCallbackReceiver<u16>

Receivers created with this function receive Analog Value events.

This callback is triggered periodically with the period that is set by AmbientLightBricklet::set_analog_value_callback_period. The received variable is the analog value of the ambient light sensor.

The AmbientLightBricklet::get_analog_value_callback_receiver callback is only triggered if the analog value has changed since the last triggering.

pub fn AmbientLightBricklet::get_illuminance_reached_callback_receiver(&self) → ConvertingCallbackReceiver<u16>

Receivers created with this function receive Illuminance Reached events.

This callback is triggered when the threshold as set by AmbientLightBricklet::set_illuminance_callback_threshold is reached. The received variable is the illuminance of the ambient light sensor.

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

pub fn AmbientLightBricklet::get_analog_value_reached_callback_receiver(&self) → ConvertingCallbackReceiver<u16>

Receivers created with this function receive Analog Value Reached events.

This callback is triggered when the threshold as set by AmbientLightBricklet::set_analog_value_callback_threshold is reached. The received variable is the analog value of the ambient light sensor.

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

Constants

AmbientLightBricklet::DEVICE_IDENTIFIER

This constant is used to identify a Ambient Light Bricklet.

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

AmbientLightBricklet::DEVICE_DISPLAY_NAME

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