Rust - Dust Detector Bricklet¶

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::{dust_detector_bricklet::*, ip_connection::IpConnection};

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

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

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

    // Get current dust density.
    let dust_density = dd.get_dust_density().recv()?;
    println!("Dust Density: {} µg/m³", dust_density);

    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::{dust_detector_bricklet::*, ip_connection::IpConnection};

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

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

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

    let dust_density_receiver = dd.get_dust_density_callback_receiver();

    // Spawn thread to handle received callback messages.
    // This thread ends when the `dd` object
    // is dropped, so there is no need for manual cleanup.
    thread::spawn(move || {
        for dust_density in dust_density_receiver {
            println!("Dust Density: {} µg/m³", dust_density);
        }
    });

    // Set period for dust density receiver to 1s (1000ms).
    // Note: The dust density callback is only called every second
    //       if the dust density has changed since the last call!
    dd.set_dust_density_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

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

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

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

    let dust_density_reached_receiver = dd.get_dust_density_reached_callback_receiver();

    // Spawn thread to handle received callback messages.
    // This thread ends when the `dd` object
    // is dropped, so there is no need for manual cleanup.
    thread::spawn(move || {
        for dust_density_reached in dust_density_reached_receiver {
            println!("Dust Density: {} µg/m³", dust_density_reached);
        }
    });

    // Configure threshold for dust density "greater than 10 µg/m³".
    dd.set_dust_density_callback_threshold('>', 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 DustDetectorBricklet::new(uid: &str, ip_connection: &IpConnection) → DustDetectorBricklet¶

Parameters:	uid – Type: &str ip_connection – Type: &IPConnection
Returns:	dust_detector – Type: DustDetectorBricklet

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

let dust_detector = DustDetectorBricklet::new("YOUR_DEVICE_UID", &ip_connection);

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

pub fn DustDetectorBricklet::get_dust_density(&self) → ConvertingReceiver<u16>¶

Returns:	dust_density – Type: u16, Unit: 1 µg/m³, Range: [0 to 500]

Returns the dust density.

If you want to get the dust density periodically, it is recommended to use the DustDetectorBricklet::get_dust_density_callback_receiver callback and set the period with DustDetectorBricklet::set_dust_density_callback_period.

Advanced Functions¶

pub fn DustDetectorBricklet::set_moving_average(&self, average: u8) → ConvertingReceiver<()>¶

Parameters:	average – Type: u8, Range: [0 to 100], Default: 100

Sets the length of a moving averaging for the dust density.

Setting the length to 0 will turn the averaging completely off. With less averaging, there is more noise on the data.

pub fn DustDetectorBricklet::get_moving_average(&self) → ConvertingReceiver<u8>¶

Returns:	average – Type: u8, Range: [0 to 100], Default: 100

Returns the length moving average as set by DustDetectorBricklet::set_moving_average.

pub fn DustDetectorBricklet::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 DustDetectorBricklet::set_dust_density_callback_period(&self, period: u32) → ConvertingReceiver<()>¶

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

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

The DustDetectorBricklet::get_dust_density_callback_receiver callback is only triggered if the dust density has changed since the last triggering.

pub fn DustDetectorBricklet::get_dust_density_callback_period(&self) → ConvertingReceiver<u32>¶

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

Returns the period as set by DustDetectorBricklet::set_dust_density_callback_period.

pub fn DustDetectorBricklet::set_dust_density_callback_threshold(&self, option: char, min: u16, max: u16) → ConvertingReceiver<()>¶

Parameters:	option – Type: char, Range: See constants, Default: 'x' min – Type: u16, Unit: 1 µg/m³, Range: [0 to 216 - 1], Default: 0 max – Type: u16, Unit: 1 µg/m³, Range: [0 to 216 - 1], Default: 0

Sets the thresholds for the DustDetectorBricklet::get_dust_density_reached_callback_receiver callback.

The following options are possible:

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

The following constants are available for this function:

For option:

• DUST_DETECTOR_BRICKLET_THRESHOLD_OPTION_OFF = 'x'
• DUST_DETECTOR_BRICKLET_THRESHOLD_OPTION_OUTSIDE = 'o'
• DUST_DETECTOR_BRICKLET_THRESHOLD_OPTION_INSIDE = 'i'
• DUST_DETECTOR_BRICKLET_THRESHOLD_OPTION_SMALLER = '<'
• DUST_DETECTOR_BRICKLET_THRESHOLD_OPTION_GREATER = '>'

pub fn DustDetectorBricklet::get_dust_density_callback_threshold(&self) → ConvertingReceiver<DustDensityCallbackThreshold>¶

Return Object:	option – Type: char, Range: See constants, Default: 'x' min – Type: u16, Unit: 1 µg/m³, Range: [0 to 216 - 1], Default: 0 max – Type: u16, Unit: 1 µg/m³, Range: [0 to 216 - 1], Default: 0

Returns the threshold as set by DustDetectorBricklet::set_dust_density_callback_threshold.

The following constants are available for this function:

For option:

• DUST_DETECTOR_BRICKLET_THRESHOLD_OPTION_OFF = 'x'
• DUST_DETECTOR_BRICKLET_THRESHOLD_OPTION_OUTSIDE = 'o'
• DUST_DETECTOR_BRICKLET_THRESHOLD_OPTION_INSIDE = 'i'
• DUST_DETECTOR_BRICKLET_THRESHOLD_OPTION_SMALLER = '<'
• DUST_DETECTOR_BRICKLET_THRESHOLD_OPTION_GREATER = '>'

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

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

Sets the period with which the threshold callback

• DustDetectorBricklet::get_dust_density_reached_callback_receiver

is triggered, if the threshold

• DustDetectorBricklet::set_dust_density_callback_threshold

keeps being reached.

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

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

Returns the debounce period as set by DustDetectorBricklet::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.

pub fn DustDetectorBricklet::get_dust_density_callback_receiver(&self) → ConvertingCallbackReceiver<u16>¶

Event:	dust_density – Type: u16, Unit: 1 µg/m³, Range: [0 to 500]

Receivers created with this function receive Dust Density events.

This callback is triggered periodically with the period that is set by DustDetectorBricklet::set_dust_density_callback_period. The received variable is the dust density of the sensor.

Der DustDetectorBricklet::get_dust_density_callback_receiver callback is only triggered if the dust density value has changed since the last triggering.

pub fn DustDetectorBricklet::get_dust_density_reached_callback_receiver(&self) → ConvertingCallbackReceiver<u16>¶

Event:	dust_density – Type: u16, Unit: 1 µg/m³, Range: [0 to 500]

Receivers created with this function receive Dust Density Reached events.

This callback is triggered when the threshold as set by DustDetectorBricklet::set_dust_density_callback_threshold is reached. The received variable is the dust density of the sensor.

If the threshold keeps being reached, the callback is triggered periodically with the period as set by DustDetectorBricklet::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 DustDetectorBricklet::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 DustDetectorBricklet::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 DustDetectorBricklet::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:

• DUST_DETECTOR_BRICKLET_FUNCTION_SET_DUST_DENSITY_CALLBACK_PERIOD = 2
• DUST_DETECTOR_BRICKLET_FUNCTION_SET_DUST_DENSITY_CALLBACK_THRESHOLD = 4
• DUST_DETECTOR_BRICKLET_FUNCTION_SET_DEBOUNCE_PERIOD = 6
• DUST_DETECTOR_BRICKLET_FUNCTION_SET_MOVING_AVERAGE = 10

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

• DUST_DETECTOR_BRICKLET_FUNCTION_SET_DUST_DENSITY_CALLBACK_PERIOD = 2
• DUST_DETECTOR_BRICKLET_FUNCTION_SET_DUST_DENSITY_CALLBACK_THRESHOLD = 4
• DUST_DETECTOR_BRICKLET_FUNCTION_SET_DEBOUNCE_PERIOD = 6
• DUST_DETECTOR_BRICKLET_FUNCTION_SET_MOVING_AVERAGE = 10

pub fn DustDetectorBricklet::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 DustDetectorBricklet::DEVICE_IDENTIFIER¶

This constant is used to identify a Dust Detector Bricklet.

The DustDetectorBricklet::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 DustDetectorBricklet::DEVICE_DISPLAY_NAME¶

This constant represents the human readable name of a Dust Detector Bricklet.