pub struct AccelerometerBricklet { /* private fields */ }
Expand description
Measures acceleration in three axis
Implementations
sourceimpl AccelerometerBricklet
impl AccelerometerBricklet
pub const DEVICE_IDENTIFIER: u16 = 250u16
pub const DEVICE_DISPLAY_NAME: &'static str = "Accelerometer Bricklet"
sourcepub fn new(uid: &str, ip_connection: &IpConnection) -> AccelerometerBricklet
pub fn new(uid: &str, ip_connection: &IpConnection) -> AccelerometerBricklet
Creates an object with the unique device ID uid
. This object can then be used after the IP Connection ip_connection
is connected.
sourcepub fn get_response_expected(
&mut self,
fun: AccelerometerBrickletFunction
) -> Result<bool, GetResponseExpectedError>
pub fn get_response_expected(
&mut self,
fun: AccelerometerBrickletFunction
) -> Result<bool, GetResponseExpectedError>
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 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 send and errors are silently ignored, because they cannot be detected.
See set_response_expected
for the list of function ID constants available for this function.
sourcepub fn set_response_expected(
&mut self,
fun: AccelerometerBrickletFunction,
response_expected: bool
) -> Result<(), SetResponseExpectedError>
pub fn set_response_expected(
&mut self,
fun: AccelerometerBrickletFunction,
response_expected: bool
) -> Result<(), SetResponseExpectedError>
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 send and errors are silently ignored, because they cannot be detected.
sourcepub fn set_response_expected_all(&mut self, response_expected: bool)
pub fn set_response_expected_all(&mut self, response_expected: bool)
Changes the response expected flag for all setter and callback configuration functions of this device at once.
sourcepub fn get_acceleration_callback_receiver(
&self
) -> ConvertingCallbackReceiver<AccelerationEvent>
pub fn get_acceleration_callback_receiver(
&self
) -> ConvertingCallbackReceiver<AccelerationEvent>
This receiver is triggered periodically with the period that is set by
Set Acceleration Receiver Period
. The parameters are the
X, Y and Z acceleration.
The get_acceleration_callback_receiver
receiver is only triggered if the acceleration has
changed since the last triggering.
sourcepub fn get_acceleration_reached_callback_receiver(
&self
) -> ConvertingCallbackReceiver<AccelerationReachedEvent>
pub fn get_acceleration_reached_callback_receiver(
&self
) -> ConvertingCallbackReceiver<AccelerationReachedEvent>
This receiver is triggered when the threshold as set by
Set Acceleration Receiver Threshold
is reached.
The parameters are the X, Y and Z acceleration.
If the threshold keeps being reached, the receiver is triggered periodically
with the period as set by Set Debounce Period
.
sourcepub fn get_acceleration(&self) -> ConvertingReceiver<Acceleration>
pub fn get_acceleration(&self) -> ConvertingReceiver<Acceleration>
Returns the acceleration in x, y and z direction. The values are given in g/1000 (1g = 9.80665m/s²), not to be confused with grams.
If you want to get the acceleration periodically, it is recommended
to use the get_acceleration_callback_receiver
receiver and set the period with
Set Acceleration Receiver Period
.
sourcepub fn set_acceleration_callback_period(
&self,
period: u32
) -> ConvertingReceiver<()>
pub fn set_acceleration_callback_period(
&self,
period: u32
) -> ConvertingReceiver<()>
Sets the period in ms with which the get_acceleration_callback_receiver
receiver is triggered
periodically. A value of 0 turns the receiver off.
The get_acceleration_callback_receiver
receiver is only triggered if the acceleration has
changed since the last triggering.
The default value is 0.
sourcepub fn get_acceleration_callback_period(&self) -> ConvertingReceiver<u32>
pub fn get_acceleration_callback_period(&self) -> ConvertingReceiver<u32>
Returns the period as set by Set Acceleration Receiver Period
.
sourcepub fn 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<()>
pub fn 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<()>
Sets the thresholds for the get_acceleration_reached_callback_receiver
receiver.
The following options are possible:
Option | Description |
---|---|
‘x’ | Receiver is turned off |
‘o’ | Receiver is triggered when the acceleration is outside the min and max values |
‘i’ | Receiver is triggered when the acceleration is inside the min and max values |
‘<’ | Receiver is triggered when the acceleration is smaller than the min value (max is ignored) |
‘>’ | Receiver is triggered when the acceleration is greater than the min value (max is ignored) |
The default value is (‘x’, 0, 0, 0, 0, 0, 0).
Associated constants:
- ACCELEROMETERBRICKLET_THRESHOLD_OPTION_OFF
- ACCELEROMETERBRICKLET_THRESHOLD_OPTION_OUTSIDE
- ACCELEROMETERBRICKLET_THRESHOLD_OPTION_INSIDE
- ACCELEROMETERBRICKLET_THRESHOLD_OPTION_SMALLER
- ACCELEROMETERBRICKLET_THRESHOLD_OPTION_GREATER
sourcepub fn get_acceleration_callback_threshold(
&self
) -> ConvertingReceiver<AccelerationCallbackThreshold>
pub fn get_acceleration_callback_threshold(
&self
) -> ConvertingReceiver<AccelerationCallbackThreshold>
Returns the threshold as set by Set Acceleration Receiver Threshold
.
Associated constants:
- ACCELEROMETERBRICKLET_THRESHOLD_OPTION_OFF
- ACCELEROMETERBRICKLET_THRESHOLD_OPTION_OUTSIDE
- ACCELEROMETERBRICKLET_THRESHOLD_OPTION_INSIDE
- ACCELEROMETERBRICKLET_THRESHOLD_OPTION_SMALLER
- ACCELEROMETERBRICKLET_THRESHOLD_OPTION_GREATER
sourcepub fn set_debounce_period(&self, debounce: u32) -> ConvertingReceiver<()>
pub fn set_debounce_period(&self, debounce: u32) -> ConvertingReceiver<()>
Sets the period in ms with which the threshold receiver
is triggered, if the threshold
Set Acceleration Receiver Threshold
keeps being reached.
The default value is 100.
sourcepub fn get_debounce_period(&self) -> ConvertingReceiver<u32>
pub fn get_debounce_period(&self) -> ConvertingReceiver<u32>
Returns the debounce period as set by Set Debounce Period
.
sourcepub fn get_temperature(&self) -> ConvertingReceiver<i16>
pub fn get_temperature(&self) -> ConvertingReceiver<i16>
Returns the temperature of the accelerometer in °C.
sourcepub fn set_configuration(
&self,
data_rate: u8,
full_scale: u8,
filter_bandwidth: u8
) -> ConvertingReceiver<()>
pub fn set_configuration(
&self,
data_rate: u8,
full_scale: u8,
filter_bandwidth: u8
) -> ConvertingReceiver<()>
Configures the data rate, full scale range and filter bandwidth. Possible values are:
- Data rate of 0Hz to 1600Hz.
- Full scale range of -2G to +2G up to -16G to +16G.
- Filter bandwidth between 50Hz and 800Hz.
Decreasing data rate or full scale range will also decrease the noise on the data.
The default values are 100Hz data rate, -4G to +4G range and 200Hz filter bandwidth.
Associated constants:
- ACCELEROMETERBRICKLET_DATA_RATE_OFF
- ACCELEROMETERBRICKLET_DATA_RATE_3HZ
- ACCELEROMETERBRICKLET_DATA_RATE_6HZ
- ACCELEROMETERBRICKLET_DATA_RATE_12HZ
- ACCELEROMETERBRICKLET_DATA_RATE_25HZ
- ACCELEROMETERBRICKLET_DATA_RATE_50HZ
- ACCELEROMETERBRICKLET_DATA_RATE_100HZ
- ACCELEROMETERBRICKLET_DATA_RATE_400HZ
- ACCELEROMETERBRICKLET_DATA_RATE_800HZ
- ACCELEROMETERBRICKLET_DATA_RATE_1600HZ
- ACCELEROMETERBRICKLET_FULL_SCALE_2G
- ACCELEROMETERBRICKLET_FULL_SCALE_4G
- ACCELEROMETERBRICKLET_FULL_SCALE_6G
- ACCELEROMETERBRICKLET_FULL_SCALE_8G
- ACCELEROMETERBRICKLET_FULL_SCALE_16G
- ACCELEROMETERBRICKLET_FILTER_BANDWIDTH_800HZ
- ACCELEROMETERBRICKLET_FILTER_BANDWIDTH_400HZ
- ACCELEROMETERBRICKLET_FILTER_BANDWIDTH_200HZ
- ACCELEROMETERBRICKLET_FILTER_BANDWIDTH_50HZ
sourcepub fn get_configuration(&self) -> ConvertingReceiver<Configuration>
pub fn get_configuration(&self) -> ConvertingReceiver<Configuration>
Returns the configuration as set by Set Configuration
.
Associated constants:
- ACCELEROMETERBRICKLET_DATA_RATE_OFF
- ACCELEROMETERBRICKLET_DATA_RATE_3HZ
- ACCELEROMETERBRICKLET_DATA_RATE_6HZ
- ACCELEROMETERBRICKLET_DATA_RATE_12HZ
- ACCELEROMETERBRICKLET_DATA_RATE_25HZ
- ACCELEROMETERBRICKLET_DATA_RATE_50HZ
- ACCELEROMETERBRICKLET_DATA_RATE_100HZ
- ACCELEROMETERBRICKLET_DATA_RATE_400HZ
- ACCELEROMETERBRICKLET_DATA_RATE_800HZ
- ACCELEROMETERBRICKLET_DATA_RATE_1600HZ
- ACCELEROMETERBRICKLET_FULL_SCALE_2G
- ACCELEROMETERBRICKLET_FULL_SCALE_4G
- ACCELEROMETERBRICKLET_FULL_SCALE_6G
- ACCELEROMETERBRICKLET_FULL_SCALE_8G
- ACCELEROMETERBRICKLET_FULL_SCALE_16G
- ACCELEROMETERBRICKLET_FILTER_BANDWIDTH_800HZ
- ACCELEROMETERBRICKLET_FILTER_BANDWIDTH_400HZ
- ACCELEROMETERBRICKLET_FILTER_BANDWIDTH_200HZ
- ACCELEROMETERBRICKLET_FILTER_BANDWIDTH_50HZ
sourcepub fn led_on(&self) -> ConvertingReceiver<()>
pub fn led_on(&self) -> ConvertingReceiver<()>
Enables the LED on the Bricklet.
sourcepub fn led_off(&self) -> ConvertingReceiver<()>
pub fn led_off(&self) -> ConvertingReceiver<()>
Disables the LED on the Bricklet.
sourcepub fn is_led_on(&self) -> ConvertingReceiver<bool>
pub fn is_led_on(&self) -> ConvertingReceiver<bool>
Returns true if the LED is enabled, false otherwise.
sourcepub fn get_identity(&self) -> ConvertingReceiver<Identity>
pub fn get_identity(&self) -> ConvertingReceiver<Identity>
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’ or ‘d’.
The device identifier numbers can be found here. |device_identifier_constant|
Trait Implementations
sourceimpl Clone for AccelerometerBricklet
impl Clone for AccelerometerBricklet
sourcefn clone(&self) -> AccelerometerBricklet
fn clone(&self) -> AccelerometerBricklet
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read more