Struct tinkerforge::load_cell_bricklet::LoadCellBricklet
source · pub struct LoadCellBricklet { /* private fields */ }
Expand description
Measures weight with a load cell
Implementations
sourceimpl LoadCellBricklet
impl LoadCellBricklet
pub const DEVICE_IDENTIFIER: u16 = 253u16
pub const DEVICE_DISPLAY_NAME: &'static str = "Load Cell Bricklet"
sourcepub fn new(uid: &str, ip_connection: &IpConnection) -> LoadCellBricklet
pub fn new(uid: &str, ip_connection: &IpConnection) -> LoadCellBricklet
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: LoadCellBrickletFunction
) -> Result<bool, GetResponseExpectedError>
pub fn get_response_expected(
&mut self,
fun: LoadCellBrickletFunction
) -> 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: LoadCellBrickletFunction,
response_expected: bool
) -> Result<(), SetResponseExpectedError>
pub fn set_response_expected(
&mut self,
fun: LoadCellBrickletFunction,
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_weight_callback_receiver(&self) -> ConvertingCallbackReceiver<i32>
pub fn get_weight_callback_receiver(&self) -> ConvertingCallbackReceiver<i32>
This receiver is triggered periodically with the period that is set by
Set Weight Receiver Period
. The parameter is the weight
as measured by the load cell.
The get_weight_callback_receiver
receiver is only triggered if the weight has changed since the
last triggering.
sourcepub fn get_weight_reached_callback_receiver(
&self
) -> ConvertingCallbackReceiver<i32>
pub fn get_weight_reached_callback_receiver(
&self
) -> ConvertingCallbackReceiver<i32>
This receiver is triggered when the threshold as set by
Set Weight Receiver Threshold
is reached.
The parameter is the weight as measured by the load cell.
If the threshold keeps being reached, the receiver is triggered periodically
with the period as set by Set Debounce Period
.
sourcepub fn get_weight(&self) -> ConvertingReceiver<i32>
pub fn get_weight(&self) -> ConvertingReceiver<i32>
Returns the currently measured weight in grams.
If you want to get the weight periodically, it is recommended
to use the get_weight_callback_receiver
receiver and set the period with
Set Weight Receiver Period
.
sourcepub fn set_weight_callback_period(&self, period: u32) -> ConvertingReceiver<()>
pub fn set_weight_callback_period(&self, period: u32) -> ConvertingReceiver<()>
Sets the period in ms with which the get_weight_callback_receiver
receiver is triggered
periodically. A value of 0 turns the receiver off.
The get_weight_callback_receiver
receiver is only triggered if the weight has changed since the
last triggering.
The default value is 0.
sourcepub fn get_weight_callback_period(&self) -> ConvertingReceiver<u32>
pub fn get_weight_callback_period(&self) -> ConvertingReceiver<u32>
Returns the period as set by Set Weight Receiver Period
.
sourcepub fn set_weight_callback_threshold(
&self,
option: char,
min: i32,
max: i32
) -> ConvertingReceiver<()>
pub fn set_weight_callback_threshold(
&self,
option: char,
min: i32,
max: i32
) -> ConvertingReceiver<()>
Sets the thresholds for the get_weight_reached_callback_receiver
receiver.
The following options are possible:
Option | Description |
---|---|
‘x’ | Receiver is turned off |
‘o’ | Receiver is triggered when the weight is outside the min and max values |
‘i’ | Receiver is triggered when the weight is inside the min and max values |
‘<’ | Receiver is triggered when the weight is smaller than the min value (max is ignored) |
‘>’ | Receiver is triggered when the weight is greater than the min value (max is ignored) |
The default value is (‘x’, 0, 0).
Associated constants:
- LOAD_CELLBRICKLET_THRESHOLD_OPTION_OFF
- LOAD_CELLBRICKLET_THRESHOLD_OPTION_OUTSIDE
- LOAD_CELLBRICKLET_THRESHOLD_OPTION_INSIDE
- LOAD_CELLBRICKLET_THRESHOLD_OPTION_SMALLER
- LOAD_CELLBRICKLET_THRESHOLD_OPTION_GREATER
sourcepub fn get_weight_callback_threshold(
&self
) -> ConvertingReceiver<WeightCallbackThreshold>
pub fn get_weight_callback_threshold(
&self
) -> ConvertingReceiver<WeightCallbackThreshold>
Returns the threshold as set by Set Weight Receiver Threshold
.
Associated constants:
- LOAD_CELLBRICKLET_THRESHOLD_OPTION_OFF
- LOAD_CELLBRICKLET_THRESHOLD_OPTION_OUTSIDE
- LOAD_CELLBRICKLET_THRESHOLD_OPTION_INSIDE
- LOAD_CELLBRICKLET_THRESHOLD_OPTION_SMALLER
- LOAD_CELLBRICKLET_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 Weight 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 set_moving_average(&self, average: u8) -> ConvertingReceiver<()>
pub fn set_moving_average(&self, average: u8) -> ConvertingReceiver<()>
Sets the length of a moving averaging__ for the weight value.
Setting the length to 1 will turn the averaging off. With less averaging, there is more noise on the data.
The range for the averaging is 1-40.
The default value is 4.
sourcepub fn get_moving_average(&self) -> ConvertingReceiver<u8>
pub fn get_moving_average(&self) -> ConvertingReceiver<u8>
Returns the length moving average as set by Set Moving Average
.
sourcepub fn led_on(&self) -> ConvertingReceiver<()>
pub fn led_on(&self) -> ConvertingReceiver<()>
Turns the LED on.
sourcepub fn led_off(&self) -> ConvertingReceiver<()>
pub fn led_off(&self) -> ConvertingReceiver<()>
Turns the LED off.
sourcepub fn is_led_on(&self) -> ConvertingReceiver<bool>
pub fn is_led_on(&self) -> ConvertingReceiver<bool>
Returns true if the led is on, false otherwise.
sourcepub fn calibrate(&self, weight: u32) -> ConvertingReceiver<()>
pub fn calibrate(&self, weight: u32) -> ConvertingReceiver<()>
To calibrate your Load Cell Bricklet you have to
- empty the scale and call this function with 0 and
- add a known weight to the scale and call this function with the weight in grams.
The calibration is saved in the EEPROM of the Bricklet and only needs to be done once.
We recommend to use the Brick Viewer for calibration, you don’t need to call this function in your source code.
sourcepub fn tare(&self) -> ConvertingReceiver<()>
pub fn tare(&self) -> ConvertingReceiver<()>
Sets the currently measured weight as tare weight.
sourcepub fn set_configuration(&self, rate: u8, gain: u8) -> ConvertingReceiver<()>
pub fn set_configuration(&self, rate: u8, gain: u8) -> ConvertingReceiver<()>
The measurement rate and gain are configurable.
The rate can be either 10Hz or 80Hz. A faster rate will produce more noise.
It is additionally possible to add a moving average
(see Set Moving Average
) to the measurements.
The gain can be 128x, 64x or 32x. It represents a measurement range of ±20mV, ±40mV and ±80mV respectively. The Load Cell Bricklet uses an excitation voltage of 5V and most load cells use an output of 2mV/V. That means the voltage range is ±15mV for most load cells (i.e. gain of 128x is best). If you don’t know what all of this means you should keep it at 128x, it will most likely be correct.
The configuration is saved in the EEPROM of the Bricklet and only needs to be done once.
We recommend to use the Brick Viewer for configuration, you don’t need to call this function in your source code.
The default rate is 10Hz and the default gain is 128x.
Associated constants:
- LOAD_CELLBRICKLET_RATE_10HZ
- LOAD_CELLBRICKLET_RATE_80HZ
- LOAD_CELLBRICKLET_GAIN_128X
- LOAD_CELLBRICKLET_GAIN_64X
- LOAD_CELLBRICKLET_GAIN_32X
sourcepub fn get_configuration(&self) -> ConvertingReceiver<Configuration>
pub fn get_configuration(&self) -> ConvertingReceiver<Configuration>
Returns the configuration as set by Set Configuration
.
Associated constants:
- LOAD_CELLBRICKLET_RATE_10HZ
- LOAD_CELLBRICKLET_RATE_80HZ
- LOAD_CELLBRICKLET_GAIN_128X
- LOAD_CELLBRICKLET_GAIN_64X
- LOAD_CELLBRICKLET_GAIN_32X
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 LoadCellBricklet
impl Clone for LoadCellBricklet
sourcefn clone(&self) -> LoadCellBricklet
fn clone(&self) -> LoadCellBricklet
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read more