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

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

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

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

    // Get current moisture value.
    let moisture = m.get_moisture_value().recv()?;
    println!("Moisture Value: {}", moisture);

    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, moisture_bricklet::*};

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

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

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

    let moisture_receiver = m.get_moisture_callback_receiver();

    // Spawn thread to handle received callback messages.
    // This thread ends when the `m` object
    // is dropped, so there is no need for manual cleanup.
    thread::spawn(move || {
        for moisture in moisture_receiver {
            println!("Moisture Value: {}", moisture);
        }
    });

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

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

fn main() -> Result<(), Box<dyn Error>> {
    let ipcon = IpConnection::new(); // Create IP connection.
    let m = MoistureBricklet::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 1 second (1000ms).
    m.set_debounce_period(1000);

    let moisture_reached_receiver = m.get_moisture_reached_callback_receiver();

    // Spawn thread to handle received callback messages.
    // This thread ends when the `m` object
    // is dropped, so there is no need for manual cleanup.
    thread::spawn(move || {
        for moisture_reached in moisture_reached_receiver {
            println!("Moisture Value: {}", moisture_reached);
        }
    });

    // Configure threshold for moisture value "greater than 200".
    m.set_moisture_callback_threshold('>', 200, 0);

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

Basic Functions¶

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

Parameters:	uid – Type: &str ip_connection – Type: &IPConnection
Returns:	moisture – Type: MoistureBricklet

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

let moisture = MoistureBricklet::new("YOUR_DEVICE_UID", &ip_connection);

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

pub fn MoistureBricklet::get_moisture_value(&self) → ConvertingReceiver<u16>¶

Returns:	moisture – Type: u16, Range: [0 to 212 - 1]

Returns the current moisture value. A small value corresponds to little moisture, a big value corresponds to much moisture.

If you want to get the moisture value periodically, it is recommended to use the MoistureBricklet::get_moisture_callback_receiver callback and set the period with MoistureBricklet::set_moisture_callback_period.

Advanced Functions¶

pub fn MoistureBricklet::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 moisture value.

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

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

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

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

pub fn MoistureBricklet::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 MoistureBricklet::set_moisture_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 MoistureBricklet::get_moisture_callback_receiver callback is triggered periodically. A value of 0 turns the callback off.

The MoistureBricklet::get_moisture_callback_receiver callback is only triggered if the moisture value has changed since the last triggering.

pub fn MoistureBricklet::get_moisture_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 MoistureBricklet::set_moisture_callback_period.

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

Parameters:	option – Type: char, Range: See constants, Default: 'x' min – Type: u16, Range: [0 to 216 - 1], Default: 0 max – Type: u16, Range: [0 to 216 - 1], Default: 0

Sets the thresholds for the MoistureBricklet::get_moisture_reached_callback_receiver callback.

The following options are possible:

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

The following constants are available for this function:

For option:

• MOISTURE_BRICKLET_THRESHOLD_OPTION_OFF = 'x'
• MOISTURE_BRICKLET_THRESHOLD_OPTION_OUTSIDE = 'o'
• MOISTURE_BRICKLET_THRESHOLD_OPTION_INSIDE = 'i'
• MOISTURE_BRICKLET_THRESHOLD_OPTION_SMALLER = '<'
• MOISTURE_BRICKLET_THRESHOLD_OPTION_GREATER = '>'

pub fn MoistureBricklet::get_moisture_callback_threshold(&self) → ConvertingReceiver<MoistureCallbackThreshold>¶

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

Returns the threshold as set by MoistureBricklet::set_moisture_callback_threshold.

The following constants are available for this function:

For option:

• MOISTURE_BRICKLET_THRESHOLD_OPTION_OFF = 'x'
• MOISTURE_BRICKLET_THRESHOLD_OPTION_OUTSIDE = 'o'
• MOISTURE_BRICKLET_THRESHOLD_OPTION_INSIDE = 'i'
• MOISTURE_BRICKLET_THRESHOLD_OPTION_SMALLER = '<'
• MOISTURE_BRICKLET_THRESHOLD_OPTION_GREATER = '>'

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

• MoistureBricklet::get_moisture_reached_callback_receiver

is triggered, if the threshold

• MoistureBricklet::set_moisture_callback_threshold

keeps being reached.

pub fn MoistureBricklet::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 MoistureBricklet::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 MoistureBricklet::get_moisture_callback_receiver(&self) → ConvertingCallbackReceiver<u16>¶

Event:	moisture – Type: u16, Range: [0 to 212 - 1]

Receivers created with this function receive Moisture events.

This callback is triggered periodically with the period that is set by MoistureBricklet::set_moisture_callback_period. The received variable is the moisture value of the sensor.

The MoistureBricklet::get_moisture_callback_receiver callback is only triggered if the moisture value has changed since the last triggering.

pub fn MoistureBricklet::get_moisture_reached_callback_receiver(&self) → ConvertingCallbackReceiver<u16>¶

Event:	moisture – Type: u16, Range: [0 to 212 - 1]

Receivers created with this function receive Moisture Reached events.

This callback is triggered when the threshold as set by MoistureBricklet::set_moisture_callback_threshold is reached. The received variable is the moisture value of the sensor.

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

• MOISTURE_BRICKLET_FUNCTION_SET_MOISTURE_CALLBACK_PERIOD = 2
• MOISTURE_BRICKLET_FUNCTION_SET_MOISTURE_CALLBACK_THRESHOLD = 4
• MOISTURE_BRICKLET_FUNCTION_SET_DEBOUNCE_PERIOD = 6
• MOISTURE_BRICKLET_FUNCTION_SET_MOVING_AVERAGE = 10

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

• MOISTURE_BRICKLET_FUNCTION_SET_MOISTURE_CALLBACK_PERIOD = 2
• MOISTURE_BRICKLET_FUNCTION_SET_MOISTURE_CALLBACK_THRESHOLD = 4
• MOISTURE_BRICKLET_FUNCTION_SET_DEBOUNCE_PERIOD = 6
• MOISTURE_BRICKLET_FUNCTION_SET_MOVING_AVERAGE = 10

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

This constant is used to identify a Moisture Bricklet.

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

This constant represents the human readable name of a Moisture Bricklet.