Rust - Particulate Matter 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
26
27
28

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

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

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

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

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

    // Get current PM concentration.
    let pm_concentration = pm.get_pm_concentration().recv()?;

    println!("PM 1.0: {} µg/m³", pm_concentration.pm10);
    println!("PM 2.5: {} µg/m³", pm_concentration.pm25);
    println!("PM 10.0: {} µg/m³", pm_concentration.pm100);

    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
37

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

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

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

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

    let pm_concentration_receiver = pm.get_pm_concentration_callback_receiver();

    // Spawn thread to handle received callback messages.
    // This thread ends when the `pm` object
    // is dropped, so there is no need for manual cleanup.
    thread::spawn(move || {
        for pm_concentration in pm_concentration_receiver {
            println!("PM 1.0: {} µg/m³", pm_concentration.pm10);
            println!("PM 2.5: {} µg/m³", pm_concentration.pm25);
            println!("PM 10.0: {} µg/m³", pm_concentration.pm100);
            println!();
        }
    });

    // Set period for PM concentration callback to 1s (1000ms).
    pm.set_pm_concentration_callback_configuration(1000, false);

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

Basic Functions¶

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

Parameters:	uid – Type: &str ip_connection – Type: &IPConnection
Returns:	particulate_matter – Type: ParticulateMatterBricklet

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

let particulate_matter = ParticulateMatterBricklet::new("YOUR_DEVICE_UID", &ip_connection);

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

pub fn ParticulateMatterBricklet::get_pm_concentration(&self) → ConvertingReceiver<PmConcentration>¶

Return Object:	pm10 – Type: u16, Unit: 1 µg/m³, Range: [0 to 216 - 1] pm25 – Type: u16, Unit: 1 µg/m³, Range: [0 to 216 - 1] pm100 – Type: u16, Unit: 1 µg/m³, Range: [0 to 216 - 1]

Returns the particulate matter concentration, broken down as:

• PM_1.0,
• PM_2.5 and
• PM_10.0.

If the sensor is disabled (see ParticulateMatterBricklet::set_enable) then the last known good values from the sensor are returned.

If you want to get the values periodically, it is recommended to use the ParticulateMatterBricklet::get_pm_concentration_callback_receiver callback. You can set the callback configuration with ParticulateMatterBricklet::set_pm_concentration_callback_configuration.

pub fn ParticulateMatterBricklet::get_pm_count(&self) → ConvertingReceiver<PmCount>¶

Return Object:	greater03um – Type: u16, Unit: 10000 1/m³, Range: [0 to 216 - 1] greater05um – Type: u16, Unit: 10000 1/m³, Range: [0 to 216 - 1] greater10um – Type: u16, Unit: 10000 1/m³, Range: [0 to 216 - 1] greater25um – Type: u16, Unit: 10000 1/m³, Range: [0 to 216 - 1] greater50um – Type: u16, Unit: 10000 1/m³, Range: [0 to 216 - 1] greater100um – Type: u16, Unit: 10000 1/m³, Range: [0 to 216 - 1]

Returns the number of particulates in 100 ml of air, broken down by their diameter:

• greater 0.3µm,
• greater 0.5µm,
• greater 1.0µm,
• greater 2.5µm,
• greater 5.0µm and
• greater 10.0µm.

If the sensor is disabled (see ParticulateMatterBricklet::set_enable) then the last known good value from the sensor is returned.

If you want to get the values periodically, it is recommended to use the ParticulateMatterBricklet::get_pm_count_callback_receiver callback. You can set the callback configuration with ParticulateMatterBricklet::set_pm_count_callback_configuration.

Advanced Functions¶

pub fn ParticulateMatterBricklet::set_enable(&self, enable: bool) → ConvertingReceiver<()>¶

Parameters:	enable – Type: bool, Default: true

Enables/Disables the fan and the laser diode of the sensors.

The sensor takes about 30 seconds after it is enabled to settle and produce stable values.

The laser diode has a lifetime of about 8000 hours. If you want to measure in an interval with a long idle time (e.g. hourly) you should turn the laser diode off between the measurements.

pub fn ParticulateMatterBricklet::get_enable(&self) → ConvertingReceiver<bool>¶

Returns:	enable – Type: bool, Default: true

Returns the state of the sensor as set by ParticulateMatterBricklet::set_enable.

pub fn ParticulateMatterBricklet::get_sensor_info(&self) → ConvertingReceiver<SensorInfo>¶

Return Object:	sensor_version – Type: u8, Range: [0 to 255] last_error_code – Type: u8, Range: [0 to 255] framing_error_count – Type: u8, Range: [0 to 255] checksum_error_count – Type: u8, Range: [0 to 255]

Returns information about the sensor:

• the sensor version number,
• the last error code reported by the sensor (0 means no error) and
• the number of framing and checksum errors that occurred in the communication with the sensor.

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

• PARTICULATE_MATTER_BRICKLET_STATUS_LED_CONFIG_OFF = 0
• PARTICULATE_MATTER_BRICKLET_STATUS_LED_CONFIG_ON = 1
• PARTICULATE_MATTER_BRICKLET_STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
• PARTICULATE_MATTER_BRICKLET_STATUS_LED_CONFIG_SHOW_STATUS = 3

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

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

Returns the configuration as set by ParticulateMatterBricklet::set_status_led_config

The following constants are available for this function:

For config:

• PARTICULATE_MATTER_BRICKLET_STATUS_LED_CONFIG_OFF = 0
• PARTICULATE_MATTER_BRICKLET_STATUS_LED_CONFIG_ON = 1
• PARTICULATE_MATTER_BRICKLET_STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
• PARTICULATE_MATTER_BRICKLET_STATUS_LED_CONFIG_SHOW_STATUS = 3

pub fn ParticulateMatterBricklet::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 ParticulateMatterBricklet::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 ParticulateMatterBricklet::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 ParticulateMatterBricklet::set_pm_concentration_callback_configuration(&self, period: u32, value_has_to_change: bool) → ConvertingReceiver<()>¶

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

The period is the period with which the ParticulateMatterBricklet::get_pm_concentration_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.

pub fn ParticulateMatterBricklet::get_pm_concentration_callback_configuration(&self) → ConvertingReceiver<PmConcentrationCallbackConfiguration>¶

Return Object:	period – Type: u32, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0 value_has_to_change – Type: bool, Default: false

Returns the callback configuration as set by ParticulateMatterBricklet::set_pm_concentration_callback_configuration.

pub fn ParticulateMatterBricklet::set_pm_count_callback_configuration(&self, period: u32, value_has_to_change: bool) → ConvertingReceiver<()>¶

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

The period is the period with which the ParticulateMatterBricklet::get_pm_count_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.

pub fn ParticulateMatterBricklet::get_pm_count_callback_configuration(&self) → ConvertingReceiver<PmCountCallbackConfiguration>¶

Return Object:	period – Type: u32, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0 value_has_to_change – Type: bool, Default: false

Returns the callback configuration as set by ParticulateMatterBricklet::set_pm_count_callback_configuration.

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 ParticulateMatterBricklet::get_pm_concentration_callback_receiver(&self) → ConvertingCallbackReceiver<PmConcentrationEvent>¶

Event Object:	pm10 – Type: u16, Unit: 1 µg/m³, Range: [0 to 216 - 1] pm25 – Type: u16, Unit: 1 µg/m³, Range: [0 to 216 - 1] pm100 – Type: u16, Unit: 1 µg/m³, Range: [0 to 216 - 1]

Receivers created with this function receive PM Concentration events.

This callback is triggered periodically according to the configuration set by ParticulateMatterBricklet::set_pm_concentration_callback_configuration.

The members of the received struct are the same as ParticulateMatterBricklet::get_pm_concentration.

pub fn ParticulateMatterBricklet::get_pm_count_callback_receiver(&self) → ConvertingCallbackReceiver<PmCountEvent>¶

Event Object:	greater03um – Type: u16, Unit: 10000 1/m³, Range: [0 to 216 - 1] greater05um – Type: u16, Unit: 10000 1/m³, Range: [0 to 216 - 1] greater10um – Type: u16, Unit: 10000 1/m³, Range: [0 to 216 - 1] greater25um – Type: u16, Unit: 10000 1/m³, Range: [0 to 216 - 1] greater50um – Type: u16, Unit: 10000 1/m³, Range: [0 to 216 - 1] greater100um – Type: u16, Unit: 10000 1/m³, Range: [0 to 216 - 1]

Receivers created with this function receive PM Count events.

This callback is triggered periodically according to the configuration set by ParticulateMatterBricklet::set_pm_count_callback_configuration.

The members of the received struct are the same as ParticulateMatterBricklet::get_pm_count.

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

• PARTICULATE_MATTER_BRICKLET_FUNCTION_SET_ENABLE = 3
• PARTICULATE_MATTER_BRICKLET_FUNCTION_SET_PM_CONCENTRATION_CALLBACK_CONFIGURATION = 6
• PARTICULATE_MATTER_BRICKLET_FUNCTION_SET_PM_COUNT_CALLBACK_CONFIGURATION = 8
• PARTICULATE_MATTER_BRICKLET_FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
• PARTICULATE_MATTER_BRICKLET_FUNCTION_SET_STATUS_LED_CONFIG = 239
• PARTICULATE_MATTER_BRICKLET_FUNCTION_RESET = 243
• PARTICULATE_MATTER_BRICKLET_FUNCTION_WRITE_UID = 248

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

• PARTICULATE_MATTER_BRICKLET_FUNCTION_SET_ENABLE = 3
• PARTICULATE_MATTER_BRICKLET_FUNCTION_SET_PM_CONCENTRATION_CALLBACK_CONFIGURATION = 6
• PARTICULATE_MATTER_BRICKLET_FUNCTION_SET_PM_COUNT_CALLBACK_CONFIGURATION = 8
• PARTICULATE_MATTER_BRICKLET_FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
• PARTICULATE_MATTER_BRICKLET_FUNCTION_SET_STATUS_LED_CONFIG = 239
• PARTICULATE_MATTER_BRICKLET_FUNCTION_RESET = 243
• PARTICULATE_MATTER_BRICKLET_FUNCTION_WRITE_UID = 248

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

• PARTICULATE_MATTER_BRICKLET_BOOTLOADER_MODE_BOOTLOADER = 0
• PARTICULATE_MATTER_BRICKLET_BOOTLOADER_MODE_FIRMWARE = 1
• PARTICULATE_MATTER_BRICKLET_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
• PARTICULATE_MATTER_BRICKLET_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
• PARTICULATE_MATTER_BRICKLET_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4

For status:

• PARTICULATE_MATTER_BRICKLET_BOOTLOADER_STATUS_OK = 0
• PARTICULATE_MATTER_BRICKLET_BOOTLOADER_STATUS_INVALID_MODE = 1
• PARTICULATE_MATTER_BRICKLET_BOOTLOADER_STATUS_NO_CHANGE = 2
• PARTICULATE_MATTER_BRICKLET_BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT = 3
• PARTICULATE_MATTER_BRICKLET_BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT = 4
• PARTICULATE_MATTER_BRICKLET_BOOTLOADER_STATUS_CRC_MISMATCH = 5

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

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

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

The following constants are available for this function:

For mode:

• PARTICULATE_MATTER_BRICKLET_BOOTLOADER_MODE_BOOTLOADER = 0
• PARTICULATE_MATTER_BRICKLET_BOOTLOADER_MODE_FIRMWARE = 1
• PARTICULATE_MATTER_BRICKLET_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
• PARTICULATE_MATTER_BRICKLET_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
• PARTICULATE_MATTER_BRICKLET_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4

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

This constant is used to identify a Particulate Matter Bricklet.

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

This constant represents the human readable name of a Particulate Matter Bricklet.