Software / API Bindings / Rust / API Reference and Examples / Bricklets (Discontinued) / Ambient Light Bricklet 2.0

Rust - Ambient Light Bricklet 2.0¶

This is the description of the Rust API bindings for the Ambient Light Bricklet 2.0. General information and technical specifications for the Ambient Light Bricklet 2.0 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)

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

use tinkerforge::{ambient_light_v2_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 2.0.

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

use std::{error::Error, io, thread};
use tinkerforge::{ambient_light_v2_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 2.0.

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

use std::{error::Error, io, thread};
use tinkerforge::{ambient_light_v2_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 2.0.

fn main() -> Result<(), Box<dyn Error>> {
    let ipcon = IpConnection::new(); // Create IP connection.
    let al = AmbientLightV2Bricklet::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 / 100.0);
            println!("Too bright, close the curtains!");
        }
    });

    // Configure threshold for illuminance "greater than 500 lx".
    al.set_illuminance_callback_threshold('>', 500 * 100, 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 occurred.

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 AmbientLightV2Bricklet::new(uid: &str, ip_connection: &IpConnection) → AmbientLightV2Bricklet¶

Parameters:	uid – Type: &str ip_connection – Type: &IPConnection
Returns:	ambient_light_v2 – Type: AmbientLightV2Bricklet

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

let ambient_light_v2 = AmbientLightV2Bricklet::new("YOUR_DEVICE_UID", &ip_connection);

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

pub fn AmbientLightV2Bricklet::get_illuminance(&self) → ConvertingReceiver<u32>¶

Returns:	illuminance – Type: u32, Unit: 1/100 lx, Range: [0 to 2³² - 1]

Returns the illuminance of the ambient light sensor. The measurement range goes up to about 100000lux, but above 64000lux the precision starts to drop.

Changed in version 2.0.2 (Plugin): An illuminance of 0lux indicates an error condition where the sensor cannot perform a reasonable measurement. This can happen with very dim or very bright light conditions. In bright light conditions this might indicate that the sensor is saturated and the configuration should be modified (AmbientLightV2Bricklet::set_configuration) to better match the light conditions.

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

Advanced Functions¶

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

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

Sets the configuration. It is possible to configure an illuminance range between 0-600lux and 0-64000lux and an integration time between 50ms and 400ms.

New in version 2.0.2 (Plugin): The unlimited illuminance range allows to measure up to about 100000lux, but above 64000lux the precision starts to drop.

A smaller illuminance range increases the resolution of the data. A longer integration time will result in less noise on the data.

Changed in version 2.0.2 (Plugin): If the actual measure illuminance is out-of-range then the current illuminance range maximum +0.01lux is reported by AmbientLightV2Bricklet::get_illuminance and the AmbientLightV2Bricklet::get_illuminance_callback_receiver callback. For example, 800001 for the 0-8000lux range.

Changed in version 2.0.2 (Plugin): With a long integration time the sensor might be saturated before the measured value reaches the maximum of the selected illuminance range. In this case 0lux is reported by AmbientLightV2Bricklet::get_illuminance and the AmbientLightV2Bricklet::get_illuminance_callback_receiver callback.

If the measurement is out-of-range or the sensor is saturated then you should configure the next higher illuminance range. If the highest range is already in use, then start to reduce the integration time.

The following constants are available for this function:

For illuminance_range:

AMBIENT_LIGHT_V2_BRICKLET_ILLUMINANCE_RANGE_UNLIMITED = 6
AMBIENT_LIGHT_V2_BRICKLET_ILLUMINANCE_RANGE_64000LUX = 0
AMBIENT_LIGHT_V2_BRICKLET_ILLUMINANCE_RANGE_32000LUX = 1
AMBIENT_LIGHT_V2_BRICKLET_ILLUMINANCE_RANGE_16000LUX = 2
AMBIENT_LIGHT_V2_BRICKLET_ILLUMINANCE_RANGE_8000LUX = 3
AMBIENT_LIGHT_V2_BRICKLET_ILLUMINANCE_RANGE_1300LUX = 4
AMBIENT_LIGHT_V2_BRICKLET_ILLUMINANCE_RANGE_600LUX = 5

For integration_time:

AMBIENT_LIGHT_V2_BRICKLET_INTEGRATION_TIME_50MS = 0
AMBIENT_LIGHT_V2_BRICKLET_INTEGRATION_TIME_100MS = 1
AMBIENT_LIGHT_V2_BRICKLET_INTEGRATION_TIME_150MS = 2
AMBIENT_LIGHT_V2_BRICKLET_INTEGRATION_TIME_200MS = 3
AMBIENT_LIGHT_V2_BRICKLET_INTEGRATION_TIME_250MS = 4
AMBIENT_LIGHT_V2_BRICKLET_INTEGRATION_TIME_300MS = 5
AMBIENT_LIGHT_V2_BRICKLET_INTEGRATION_TIME_350MS = 6
AMBIENT_LIGHT_V2_BRICKLET_INTEGRATION_TIME_400MS = 7

pub fn AmbientLightV2Bricklet::get_configuration(&self) → ConvertingReceiver<Configuration>¶

Return Object:	illuminance_range – Type: u8, Range: See constants, Default: 3 integration_time – Type: u8, Range: See constants, Default: 3

Returns the configuration as set by AmbientLightV2Bricklet::set_configuration.

The following constants are available for this function:

For illuminance_range:

AMBIENT_LIGHT_V2_BRICKLET_ILLUMINANCE_RANGE_UNLIMITED = 6
AMBIENT_LIGHT_V2_BRICKLET_ILLUMINANCE_RANGE_64000LUX = 0
AMBIENT_LIGHT_V2_BRICKLET_ILLUMINANCE_RANGE_32000LUX = 1
AMBIENT_LIGHT_V2_BRICKLET_ILLUMINANCE_RANGE_16000LUX = 2
AMBIENT_LIGHT_V2_BRICKLET_ILLUMINANCE_RANGE_8000LUX = 3
AMBIENT_LIGHT_V2_BRICKLET_ILLUMINANCE_RANGE_1300LUX = 4
AMBIENT_LIGHT_V2_BRICKLET_ILLUMINANCE_RANGE_600LUX = 5

For integration_time:

AMBIENT_LIGHT_V2_BRICKLET_INTEGRATION_TIME_50MS = 0
AMBIENT_LIGHT_V2_BRICKLET_INTEGRATION_TIME_100MS = 1
AMBIENT_LIGHT_V2_BRICKLET_INTEGRATION_TIME_150MS = 2
AMBIENT_LIGHT_V2_BRICKLET_INTEGRATION_TIME_200MS = 3
AMBIENT_LIGHT_V2_BRICKLET_INTEGRATION_TIME_250MS = 4
AMBIENT_LIGHT_V2_BRICKLET_INTEGRATION_TIME_300MS = 5
AMBIENT_LIGHT_V2_BRICKLET_INTEGRATION_TIME_350MS = 6
AMBIENT_LIGHT_V2_BRICKLET_INTEGRATION_TIME_400MS = 7

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

Return Object:

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 2¹⁶ - 1]

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 2¹⁶ - 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 AmbientLightV2Bricklet::set_illuminance_callback_period(&self, period: u32) → ConvertingReceiver<()>¶

Parameters:	period – Type: u32, Unit: 1 ms, Range: [0 to 2³² - 1], Default: 0

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

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

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

Returns:	period – Type: u32, Unit: 1 ms, Range: [0 to 2³² - 1], Default: 0

Returns the period as set by AmbientLightV2Bricklet::set_illuminance_callback_period.

pub fn AmbientLightV2Bricklet::set_illuminance_callback_threshold(&self, option: char, min: u32, max: u32) → ConvertingReceiver<()>¶

Parameters:	option – Type: char, Range: See constants, Default: 'x' min – Type: u32, Unit: 1/100 lx, Range: [0 to 2³² - 1], Default: 0 max – Type: u32, Unit: 1/100 lx, Range: [0 to 2³² - 1], Default: 0

Sets the thresholds for the AmbientLightV2Bricklet::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 following constants are available for this function:

For option:

AMBIENT_LIGHT_V2_BRICKLET_THRESHOLD_OPTION_OFF = 'x'
AMBIENT_LIGHT_V2_BRICKLET_THRESHOLD_OPTION_OUTSIDE = 'o'
AMBIENT_LIGHT_V2_BRICKLET_THRESHOLD_OPTION_INSIDE = 'i'
AMBIENT_LIGHT_V2_BRICKLET_THRESHOLD_OPTION_SMALLER = '<'
AMBIENT_LIGHT_V2_BRICKLET_THRESHOLD_OPTION_GREATER = '>'

pub fn AmbientLightV2Bricklet::get_illuminance_callback_threshold(&self) → ConvertingReceiver<IlluminanceCallbackThreshold>¶

Return Object:	option – Type: char, Range: See constants, Default: 'x' min – Type: u32, Unit: 1/100 lx, Range: [0 to 2³² - 1], Default: 0 max – Type: u32, Unit: 1/100 lx, Range: [0 to 2³² - 1], Default: 0

Returns the threshold as set by AmbientLightV2Bricklet::set_illuminance_callback_threshold.

The following constants are available for this function:

For option:

AMBIENT_LIGHT_V2_BRICKLET_THRESHOLD_OPTION_OFF = 'x'
AMBIENT_LIGHT_V2_BRICKLET_THRESHOLD_OPTION_OUTSIDE = 'o'
AMBIENT_LIGHT_V2_BRICKLET_THRESHOLD_OPTION_INSIDE = 'i'
AMBIENT_LIGHT_V2_BRICKLET_THRESHOLD_OPTION_SMALLER = '<'
AMBIENT_LIGHT_V2_BRICKLET_THRESHOLD_OPTION_GREATER = '>'

pub fn AmbientLightV2Bricklet::set_debounce_period(&self, debounce: u32) → ConvertingReceiver<()>¶

Parameters:	debounce – Type: u32, Unit: 1 ms, Range: [0 to 2³² - 1], Default: 100

Sets the period with which the threshold callbacks

AmbientLightV2Bricklet::get_illuminance_reached_callback_receiver,

are triggered, if the thresholds

AmbientLightV2Bricklet::set_illuminance_callback_threshold,

keep being reached.

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

Returns:	debounce – Type: u32, Unit: 1 ms, Range: [0 to 2³² - 1], Default: 100

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

Event:	illuminance – Type: u32, Unit: 1/100 lx, Range: [0 to 2³² - 1]

Receivers created with this function receive Illuminance events.

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

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

pub fn AmbientLightV2Bricklet::get_illuminance_reached_callback_receiver(&self) → ConvertingCallbackReceiver<u32>¶

Event:	illuminance – Type: u32, Unit: 1/100 lx, Range: [0 to 2³² - 1]

Receivers created with this function receive Illuminance Reached events.

This callback is triggered when the threshold as set by AmbientLightV2Bricklet::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 AmbientLightV2Bricklet::set_debounce_period.

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 AmbientLightV2Bricklet::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 AmbientLightV2Bricklet::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 AmbientLightV2Bricklet::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:

AMBIENT_LIGHT_V2_BRICKLET_FUNCTION_SET_ILLUMINANCE_CALLBACK_PERIOD = 2
AMBIENT_LIGHT_V2_BRICKLET_FUNCTION_SET_ILLUMINANCE_CALLBACK_THRESHOLD = 4
AMBIENT_LIGHT_V2_BRICKLET_FUNCTION_SET_DEBOUNCE_PERIOD = 6
AMBIENT_LIGHT_V2_BRICKLET_FUNCTION_SET_CONFIGURATION = 8

pub fn AmbientLightV2Bricklet::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.

The following constants are available for this function:

For function_id:

AMBIENT_LIGHT_V2_BRICKLET_FUNCTION_SET_ILLUMINANCE_CALLBACK_PERIOD = 2
AMBIENT_LIGHT_V2_BRICKLET_FUNCTION_SET_ILLUMINANCE_CALLBACK_THRESHOLD = 4
AMBIENT_LIGHT_V2_BRICKLET_FUNCTION_SET_DEBOUNCE_PERIOD = 6
AMBIENT_LIGHT_V2_BRICKLET_FUNCTION_SET_CONFIGURATION = 8

pub fn AmbientLightV2Bricklet::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.

Constants¶

pub const AmbientLightV2Bricklet::DEVICE_IDENTIFIER¶

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

The AmbientLightV2Bricklet::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 AmbientLightV2Bricklet::DEVICE_DISPLAY_NAME¶: This constant represents the human readable name of a Ambient Light Bricklet 2.0.