Rust - Accelerometer Bricklet¶

Simple¶

Download (example_simple.rs)

 1use std::{error::Error, io};
 2
 3use tinkerforge::{accelerometer_bricklet::*, ip_connection::IpConnection};
 4
 5const HOST: &str = "localhost";
 6const PORT: u16 = 4223;
 7const UID: &str = "XYZ"; // Change XYZ to the UID of your Accelerometer Bricklet.
 8
 9fn main() -> Result<(), Box<dyn Error>> {
10    let ipcon = IpConnection::new(); // Create IP connection.
11    let a = AccelerometerBricklet::new(UID, &ipcon); // Create device object.
12
13    ipcon.connect((HOST, PORT)).recv()??; // Connect to brickd.
14                                          // Don't use device before ipcon is connected.
15
16    // Get current acceleration.
17    let acceleration = a.get_acceleration().recv()?;
18
19    println!("Acceleration [X]: {} g", acceleration.x as f32 / 1000.0);
20    println!("Acceleration [Y]: {} g", acceleration.y as f32 / 1000.0);
21    println!("Acceleration [Z]: {} g", acceleration.z as f32 / 1000.0);
22
23    println!("Press enter to exit.");
24    let mut _input = String::new();
25    io::stdin().read_line(&mut _input)?;
26    ipcon.disconnect();
27    Ok(())
28}

Callback¶

Download (example_callback.rs)

 1use std::{error::Error, io, thread};
 2use tinkerforge::{accelerometer_bricklet::*, ip_connection::IpConnection};
 3
 4const HOST: &str = "localhost";
 5const PORT: u16 = 4223;
 6const UID: &str = "XYZ"; // Change XYZ to the UID of your Accelerometer Bricklet.
 7
 8fn main() -> Result<(), Box<dyn Error>> {
 9    let ipcon = IpConnection::new(); // Create IP connection.
10    let a = AccelerometerBricklet::new(UID, &ipcon); // Create device object.
11
12    ipcon.connect((HOST, PORT)).recv()??; // Connect to brickd.
13                                          // Don't use device before ipcon is connected.
14
15    let acceleration_receiver = a.get_acceleration_callback_receiver();
16
17    // Spawn thread to handle received callback messages.
18    // This thread ends when the `a` object
19    // is dropped, so there is no need for manual cleanup.
20    thread::spawn(move || {
21        for acceleration in acceleration_receiver {
22            println!("Acceleration [X]: {} g", acceleration.x as f32 / 1000.0);
23            println!("Acceleration [Y]: {} g", acceleration.y as f32 / 1000.0);
24            println!("Acceleration [Z]: {} g", acceleration.z as f32 / 1000.0);
25            println!();
26        }
27    });
28
29    // Set period for acceleration receiver to 1s (1000ms).
30    // Note: The acceleration callback is only called every second
31    //       if the acceleration has changed since the last call!
32    a.set_acceleration_callback_period(1000);
33
34    println!("Press enter to exit.");
35    let mut _input = String::new();
36    io::stdin().read_line(&mut _input)?;
37    ipcon.disconnect();
38    Ok(())
39}

Threshold¶

Download (example_threshold.rs)

 1use std::{error::Error, io, thread};
 2use tinkerforge::{accelerometer_bricklet::*, ip_connection::IpConnection};
 3
 4const HOST: &str = "localhost";
 5const PORT: u16 = 4223;
 6const UID: &str = "XYZ"; // Change XYZ to the UID of your Accelerometer Bricklet.
 7
 8fn main() -> Result<(), Box<dyn Error>> {
 9    let ipcon = IpConnection::new(); // Create IP connection.
10    let a = AccelerometerBricklet::new(UID, &ipcon); // Create device object.
11
12    ipcon.connect((HOST, PORT)).recv()??; // Connect to brickd.
13                                          // Don't use device before ipcon is connected.
14
15    // Get threshold receivers with a debounce time of 10 seconds (10000ms).
16    a.set_debounce_period(10000);
17
18    let acceleration_reached_receiver = a.get_acceleration_reached_callback_receiver();
19
20    // Spawn thread to handle received callback messages.
21    // This thread ends when the `a` object
22    // is dropped, so there is no need for manual cleanup.
23    thread::spawn(move || {
24        for acceleration_reached in acceleration_reached_receiver {
25            println!("Acceleration [X]: {} g", acceleration_reached.x as f32 / 1000.0);
26            println!("Acceleration [Y]: {} g", acceleration_reached.y as f32 / 1000.0);
27            println!("Acceleration [Z]: {} g", acceleration_reached.z as f32 / 1000.0);
28            println!();
29        }
30    });
31
32    // Configure threshold for acceleration "greater than 2 g, 2 g, 2 g".
33    a.set_acceleration_callback_threshold('>', 2 * 1000, 0, 2 * 1000, 0, 2 * 1000, 0);
34
35    println!("Press enter to exit.");
36    let mut _input = String::new();
37    io::stdin().read_line(&mut _input)?;
38    ipcon.disconnect();
39    Ok(())
40}

Basic Functions¶

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

Parameters:	uid – Type: &str ip_connection – Type: &IPConnection
Returns:	accelerometer – Type: AccelerometerBricklet

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

let accelerometer = AccelerometerBricklet::new("YOUR_DEVICE_UID", &ip_connection);

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

pub fn AccelerometerBricklet::get_acceleration(&self) → ConvertingReceiver<Acceleration>¶

Return Object:	x – Type: i16, Unit: 1/1000 gₙ, Range: ? y – Type: i16, Unit: 1/1000 gₙ, Range: ? z – Type: i16, Unit: 1/1000 gₙ, Range: ?

Returns the acceleration in x, y and z direction. The values are given in gₙ/1000 (1gₙ = 9.80665m/s²). The range is configured with AccelerometerBricklet::set_configuration().

If you want to get the acceleration periodically, it is recommended to use the AccelerometerBricklet::get_acceleration_callback_receiver() callback and set the period with AccelerometerBricklet::set_acceleration_callback_period().

pub fn AccelerometerBricklet::get_temperature(&self) → ConvertingReceiver<i16>¶

Returns:	temperature – Type: i16, Unit: 1 °C, Range: [-103 to 152]

Returns the temperature of the accelerometer.

pub fn AccelerometerBricklet::led_on(&self) → ConvertingReceiver<()>¶

Enables the LED on the Bricklet.

pub fn AccelerometerBricklet::led_off(&self) → ConvertingReceiver<()>¶

Disables the LED on the Bricklet.

pub fn AccelerometerBricklet::is_led_on(&self) → ConvertingReceiver<bool>¶

Returns:	on – Type: bool, Default: false

Returns true if the LED is enabled, false otherwise.

Advanced Functions¶

pub fn AccelerometerBricklet::set_configuration(&self, data_rate: u8, full_scale: u8, filter_bandwidth: u8) → ConvertingReceiver<()>¶

Parameters:	data_rate – Type: u8, Range: See constants, Default: 6 full_scale – Type: u8, Range: See constants, Default: 1 filter_bandwidth – Type: u8, Range: See constants, Default: 2

Configures the data rate, full scale range and filter bandwidth. Possible values are:

• Data rate of 0Hz to 1600Hz.

• Full scale range of ±2gₙ up to ±16gₙ.

• Filter bandwidth between 50Hz and 800Hz.

Decreasing data rate or full scale range will also decrease the noise on the data.

The following constants are available for this function:

For data_rate:

• ACCELEROMETER_BRICKLET_DATA_RATE_OFF = 0

• ACCELEROMETER_BRICKLET_DATA_RATE_3HZ = 1

• ACCELEROMETER_BRICKLET_DATA_RATE_6HZ = 2

• ACCELEROMETER_BRICKLET_DATA_RATE_12HZ = 3

• ACCELEROMETER_BRICKLET_DATA_RATE_25HZ = 4

• ACCELEROMETER_BRICKLET_DATA_RATE_50HZ = 5

• ACCELEROMETER_BRICKLET_DATA_RATE_100HZ = 6

• ACCELEROMETER_BRICKLET_DATA_RATE_400HZ = 7

• ACCELEROMETER_BRICKLET_DATA_RATE_800HZ = 8

• ACCELEROMETER_BRICKLET_DATA_RATE_1600HZ = 9

For full_scale:

• ACCELEROMETER_BRICKLET_FULL_SCALE_2G = 0

• ACCELEROMETER_BRICKLET_FULL_SCALE_4G = 1

• ACCELEROMETER_BRICKLET_FULL_SCALE_6G = 2

• ACCELEROMETER_BRICKLET_FULL_SCALE_8G = 3

• ACCELEROMETER_BRICKLET_FULL_SCALE_16G = 4

For filter_bandwidth:

• ACCELEROMETER_BRICKLET_FILTER_BANDWIDTH_800HZ = 0

• ACCELEROMETER_BRICKLET_FILTER_BANDWIDTH_400HZ = 1

• ACCELEROMETER_BRICKLET_FILTER_BANDWIDTH_200HZ = 2

• ACCELEROMETER_BRICKLET_FILTER_BANDWIDTH_50HZ = 3

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

Return Object:	data_rate – Type: u8, Range: See constants, Default: 6 full_scale – Type: u8, Range: See constants, Default: 1 filter_bandwidth – Type: u8, Range: See constants, Default: 2

Returns the configuration as set by AccelerometerBricklet::set_configuration().

The following constants are available for this function:

For data_rate:

• ACCELEROMETER_BRICKLET_DATA_RATE_OFF = 0

• ACCELEROMETER_BRICKLET_DATA_RATE_3HZ = 1

• ACCELEROMETER_BRICKLET_DATA_RATE_6HZ = 2

• ACCELEROMETER_BRICKLET_DATA_RATE_12HZ = 3

• ACCELEROMETER_BRICKLET_DATA_RATE_25HZ = 4

• ACCELEROMETER_BRICKLET_DATA_RATE_50HZ = 5

• ACCELEROMETER_BRICKLET_DATA_RATE_100HZ = 6

• ACCELEROMETER_BRICKLET_DATA_RATE_400HZ = 7

• ACCELEROMETER_BRICKLET_DATA_RATE_800HZ = 8

• ACCELEROMETER_BRICKLET_DATA_RATE_1600HZ = 9

For full_scale:

• ACCELEROMETER_BRICKLET_FULL_SCALE_2G = 0

• ACCELEROMETER_BRICKLET_FULL_SCALE_4G = 1

• ACCELEROMETER_BRICKLET_FULL_SCALE_6G = 2

• ACCELEROMETER_BRICKLET_FULL_SCALE_8G = 3

• ACCELEROMETER_BRICKLET_FULL_SCALE_16G = 4

For filter_bandwidth:

• ACCELEROMETER_BRICKLET_FILTER_BANDWIDTH_800HZ = 0

• ACCELEROMETER_BRICKLET_FILTER_BANDWIDTH_400HZ = 1

• ACCELEROMETER_BRICKLET_FILTER_BANDWIDTH_200HZ = 2

• ACCELEROMETER_BRICKLET_FILTER_BANDWIDTH_50HZ = 3

pub fn AccelerometerBricklet::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 AccelerometerBricklet::set_acceleration_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 AccelerometerBricklet::get_acceleration_callback_receiver() callback is triggered periodically. A value of 0 turns the callback off.

The AccelerometerBricklet::get_acceleration_callback_receiver() callback is only triggered if the acceleration has changed since the last triggering.

pub fn AccelerometerBricklet::get_acceleration_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 AccelerometerBricklet::set_acceleration_callback_period().

pub fn AccelerometerBricklet::set_acceleration_callback_threshold(&self, option: char, min_x: i16, max_x: i16, min_y: i16, max_y: i16, min_z: i16, max_z: i16) → ConvertingReceiver<()>¶

Parameters:

option – Type: char, Range: See constants, Default: 'x' min_x – Type: i16, Unit: 1/1000 gₙ, Range: [-215 to 215 - 1], Default: 0 max_x – Type: i16, Unit: 1/1000 gₙ, Range: [-215 to 215 - 1], Default: 0 min_y – Type: i16, Unit: 1/1000 gₙ, Range: [-215 to 215 - 1], Default: 0 max_y – Type: i16, Unit: 1/1000 gₙ, Range: [-215 to 215 - 1], Default: 0 min_z – Type: i16, Unit: 1/1000 gₙ, Range: [-215 to 215 - 1], Default: 0 max_z – Type: i16, Unit: 1/1000 gₙ, Range: [-215 to 215 - 1], Default: 0

Sets the thresholds for the AccelerometerBricklet::get_acceleration_reached_callback_receiver() callback.

The following options are possible:

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

The following constants are available for this function:

For option:

• ACCELEROMETER_BRICKLET_THRESHOLD_OPTION_OFF = 'x'

• ACCELEROMETER_BRICKLET_THRESHOLD_OPTION_OUTSIDE = 'o'

• ACCELEROMETER_BRICKLET_THRESHOLD_OPTION_INSIDE = 'i'

• ACCELEROMETER_BRICKLET_THRESHOLD_OPTION_SMALLER = '<'

• ACCELEROMETER_BRICKLET_THRESHOLD_OPTION_GREATER = '>'

pub fn AccelerometerBricklet::get_acceleration_callback_threshold(&self) → ConvertingReceiver<AccelerationCallbackThreshold>¶

Return Object:

option – Type: char, Range: See constants, Default: 'x' min_x – Type: i16, Unit: 1/1000 gₙ, Range: [-215 to 215 - 1], Default: 0 max_x – Type: i16, Unit: 1/1000 gₙ, Range: [-215 to 215 - 1], Default: 0 min_y – Type: i16, Unit: 1/1000 gₙ, Range: [-215 to 215 - 1], Default: 0 max_y – Type: i16, Unit: 1/1000 gₙ, Range: [-215 to 215 - 1], Default: 0 min_z – Type: i16, Unit: 1/1000 gₙ, Range: [-215 to 215 - 1], Default: 0 max_z – Type: i16, Unit: 1/1000 gₙ, Range: [-215 to 215 - 1], Default: 0

Returns the threshold as set by AccelerometerBricklet::set_acceleration_callback_threshold().

The following constants are available for this function:

For option:

• ACCELEROMETER_BRICKLET_THRESHOLD_OPTION_OFF = 'x'

• ACCELEROMETER_BRICKLET_THRESHOLD_OPTION_OUTSIDE = 'o'

• ACCELEROMETER_BRICKLET_THRESHOLD_OPTION_INSIDE = 'i'

• ACCELEROMETER_BRICKLET_THRESHOLD_OPTION_SMALLER = '<'

• ACCELEROMETER_BRICKLET_THRESHOLD_OPTION_GREATER = '>'

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

• AccelerometerBricklet::get_acceleration_reached_callback_receiver()

is triggered, if the threshold

• AccelerometerBricklet::set_acceleration_callback_threshold()

keeps being reached.

pub fn AccelerometerBricklet::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 AccelerometerBricklet::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 AccelerometerBricklet::get_acceleration_callback_receiver(&self) → ConvertingCallbackReceiver<AccelerationEvent>¶

Event Object:	x – Type: i16, Unit: 1/1000 gₙ, Range: ? y – Type: i16, Unit: 1/1000 gₙ, Range: ? z – Type: i16, Unit: 1/1000 gₙ, Range: ?

Receivers created with this function receive Acceleration events.

This callback is triggered periodically with the period that is set by AccelerometerBricklet::set_acceleration_callback_period(). The members of the received struct are the X, Y and Z acceleration. The range is configured with AccelerometerBricklet::set_configuration().

The AccelerometerBricklet::get_acceleration_callback_receiver() callback is only triggered if the acceleration has changed since the last triggering.

pub fn AccelerometerBricklet::get_acceleration_reached_callback_receiver(&self) → ConvertingCallbackReceiver<AccelerationReachedEvent>¶

Event Object:	x – Type: i16, Unit: 1/1000 gₙ, Range: ? y – Type: i16, Unit: 1/1000 gₙ, Range: ? z – Type: i16, Unit: 1/1000 gₙ, Range: ?

Receivers created with this function receive Acceleration Reached events.

This callback is triggered when the threshold as set by AccelerometerBricklet::set_acceleration_callback_threshold() is reached. The members of the received struct are the X, Y and Z acceleration. The range is configured with AccelerometerBricklet::set_configuration().

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

• ACCELEROMETER_BRICKLET_FUNCTION_SET_ACCELERATION_CALLBACK_PERIOD = 2

• ACCELEROMETER_BRICKLET_FUNCTION_SET_ACCELERATION_CALLBACK_THRESHOLD = 4

• ACCELEROMETER_BRICKLET_FUNCTION_SET_DEBOUNCE_PERIOD = 6

• ACCELEROMETER_BRICKLET_FUNCTION_SET_CONFIGURATION = 9

• ACCELEROMETER_BRICKLET_FUNCTION_LED_ON = 11

• ACCELEROMETER_BRICKLET_FUNCTION_LED_OFF = 12

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

• ACCELEROMETER_BRICKLET_FUNCTION_SET_ACCELERATION_CALLBACK_PERIOD = 2

• ACCELEROMETER_BRICKLET_FUNCTION_SET_ACCELERATION_CALLBACK_THRESHOLD = 4

• ACCELEROMETER_BRICKLET_FUNCTION_SET_DEBOUNCE_PERIOD = 6

• ACCELEROMETER_BRICKLET_FUNCTION_SET_CONFIGURATION = 9

• ACCELEROMETER_BRICKLET_FUNCTION_LED_ON = 11

• ACCELEROMETER_BRICKLET_FUNCTION_LED_OFF = 12

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

This constant is used to identify a Accelerometer Bricklet.

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

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