Struct tinkerforge::load_cell_v2_bricklet::LoadCellV2Bricklet

source ·

pub struct LoadCellV2Bricklet { /* private fields */ }

Expand description

Measures weight with a load cell

Implementations

source

pub fn new(uid: &str, ip_connection: &IpConnection) -> LoadCellV2Bricklet

Creates an object with the unique device ID uid. This object can then be used after the IP Connection ip_connection is connected.

source

pub fn get_response_expected(
&mut self,
fun: LoadCellV2BrickletFunction
) -> 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.

source

pub fn set_response_expected(
 &mut self,
 fun: LoadCellV2BrickletFunction,
 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.

source

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.

source

pub fn get_weight_callback_receiver(&self) -> ConvertingCallbackReceiver<i32>

This receiver is triggered periodically according to the configuration set by Set Weight Receiver Configuration.

The parameter is the same as Get Weight.

source

pub fn get_weight(&self) -> ConvertingReceiver<i32>

Returns the currently measured weight in grams.

If you want to get the value periodically, it is recommended to use the get_weight_callback_receiver receiver. You can set the receiver configuration with Set Weight Receiver Configuration.

source

pub fn set_weight_callback_configuration(
 &self,
 period: u32,
 value_has_to_change: bool,
 option: char,
 min: i32,
 max: i32
) -> ConvertingReceiver<()>

The period in ms is the period with which the get_weight_callback_receiver receiver is triggered periodically. A value of 0 turns the receiver off.

If the value has to change-parameter is set to true, the receiver is only triggered after the value has changed. If the value didn’t change within the period, the receiver is triggered immediately on change.

If it is set to false, the receiver is continuously triggered with the period, independent of the value.

It is furthermore possible to constrain the receiver with thresholds.

The option-parameter together with min/max sets a threshold for the get_weight_callback_receiver receiver.

The following options are possible:

Option	Description
‘x’	Threshold is turned off
‘o’	Threshold is triggered when the value is outside the min and max values
‘i’	Threshold is triggered when the value is inside or equal to the min and max values
‘<’	Threshold is triggered when the value is smaller than the min value (max is ignored)
‘>’	Threshold is triggered when the value is greater than the min value (max is ignored)

If the option is set to ‘x’ (threshold turned off) the receiver is triggered with the fixed period.

The default value is (0, false, ‘x’, 0, 0).

Associated constants:

LOAD_CELL_V2BRICKLET_THRESHOLD_OPTION_OFF
LOAD_CELL_V2BRICKLET_THRESHOLD_OPTION_OUTSIDE
LOAD_CELL_V2BRICKLET_THRESHOLD_OPTION_INSIDE
LOAD_CELL_V2BRICKLET_THRESHOLD_OPTION_SMALLER
LOAD_CELL_V2BRICKLET_THRESHOLD_OPTION_GREATER

source

pub fn get_weight_callback_configuration(
&self
) -> ConvertingReceiver<WeightCallbackConfiguration>

Returns the receiver configuration as set by Set Weight Receiver Configuration.

Associated constants:

LOAD_CELL_V2BRICKLET_THRESHOLD_OPTION_OFF
LOAD_CELL_V2BRICKLET_THRESHOLD_OPTION_OUTSIDE
LOAD_CELL_V2BRICKLET_THRESHOLD_OPTION_INSIDE
LOAD_CELL_V2BRICKLET_THRESHOLD_OPTION_SMALLER
LOAD_CELL_V2BRICKLET_THRESHOLD_OPTION_GREATER

source

pub fn set_moving_average(&self, average: u16) -> 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-100.

The default value is 4.

source

pub fn get_moving_average(&self) -> ConvertingReceiver<u16>

Returns the length moving average as set by Set Moving Average.

source

pub fn set_info_led_config(&self, config: u8) -> ConvertingReceiver<()>

Configures the info LED to be either turned off, turned on, or blink in heartbeat mode.

Associated constants:

LOAD_CELL_V2BRICKLET_INFO_LED_CONFIG_OFF
LOAD_CELL_V2BRICKLET_INFO_LED_CONFIG_ON
LOAD_CELL_V2BRICKLET_INFO_LED_CONFIG_SHOW_HEARTBEAT

source

pub fn get_info_led_config(&self) -> ConvertingReceiver<u8>

Returns the LED configuration as set by Set Info LED Config

Associated constants:

LOAD_CELL_V2BRICKLET_INFO_LED_CONFIG_OFF
LOAD_CELL_V2BRICKLET_INFO_LED_CONFIG_ON
LOAD_CELL_V2BRICKLET_INFO_LED_CONFIG_SHOW_HEARTBEAT

source

pub fn calibrate(&self, weight: u32) -> ConvertingReceiver<()>

To calibrate your Load Cell Bricklet 2.0 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 flash 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.

source

pub fn tare(&self) -> ConvertingReceiver<()>

Sets the currently measured weight as tare weight.

source

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 default rate is 10Hz and the default gain is 128x.

Associated constants:

LOAD_CELL_V2BRICKLET_RATE_10HZ
LOAD_CELL_V2BRICKLET_RATE_80HZ
LOAD_CELL_V2BRICKLET_GAIN_128X
LOAD_CELL_V2BRICKLET_GAIN_64X
LOAD_CELL_V2BRICKLET_GAIN_32X

source

pub fn get_configuration(&self) -> ConvertingReceiver<Configuration>

Returns the configuration as set by Set Configuration.

Associated constants:

LOAD_CELL_V2BRICKLET_RATE_10HZ
LOAD_CELL_V2BRICKLET_RATE_80HZ
LOAD_CELL_V2BRICKLET_GAIN_128X
LOAD_CELL_V2BRICKLET_GAIN_64X
LOAD_CELL_V2BRICKLET_GAIN_32X

source

pub fn get_spitfp_error_count(&self) -> ConvertingReceiver<SpitfpErrorCount>

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.

source

pub fn set_bootloader_mode(&self, mode: u8) -> ConvertingReceiver<u8>

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.

Associated constants:

LOAD_CELL_V2BRICKLET_BOOTLOADER_MODE_BOOTLOADER
LOAD_CELL_V2BRICKLET_BOOTLOADER_MODE_FIRMWARE
LOAD_CELL_V2BRICKLET_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT
LOAD_CELL_V2BRICKLET_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT
LOAD_CELL_V2BRICKLET_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT
LOAD_CELL_V2BRICKLET_BOOTLOADER_STATUS_OK
LOAD_CELL_V2BRICKLET_BOOTLOADER_STATUS_INVALID_MODE
LOAD_CELL_V2BRICKLET_BOOTLOADER_STATUS_NO_CHANGE
LOAD_CELL_V2BRICKLET_BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT
LOAD_CELL_V2BRICKLET_BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT
LOAD_CELL_V2BRICKLET_BOOTLOADER_STATUS_CRC_MISMATCH

source

pub fn get_bootloader_mode(&self) -> ConvertingReceiver<u8>

Returns the current bootloader mode, see Set Bootloader Mode.

Associated constants:

LOAD_CELL_V2BRICKLET_BOOTLOADER_MODE_BOOTLOADER
LOAD_CELL_V2BRICKLET_BOOTLOADER_MODE_FIRMWARE
LOAD_CELL_V2BRICKLET_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT
LOAD_CELL_V2BRICKLET_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT
LOAD_CELL_V2BRICKLET_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT

source

pub fn set_write_firmware_pointer(&self, pointer: u32) -> ConvertingReceiver<()>

Sets the firmware pointer for 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.

source

pub fn write_firmware(&self, data: [u8; 64]) -> ConvertingReceiver<u8>

Writes 64 Bytes of firmware at the position as written by 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.

source

pub fn set_status_led_config(&self, config: u8) -> ConvertingReceiver<()>

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.

Associated constants:

LOAD_CELL_V2BRICKLET_STATUS_LED_CONFIG_OFF
LOAD_CELL_V2BRICKLET_STATUS_LED_CONFIG_ON
LOAD_CELL_V2BRICKLET_STATUS_LED_CONFIG_SHOW_HEARTBEAT
LOAD_CELL_V2BRICKLET_STATUS_LED_CONFIG_SHOW_STATUS

source

pub fn get_status_led_config(&self) -> ConvertingReceiver<u8>

Returns the configuration as set by Set Status LED Config

Associated constants:

LOAD_CELL_V2BRICKLET_STATUS_LED_CONFIG_OFF
LOAD_CELL_V2BRICKLET_STATUS_LED_CONFIG_ON
LOAD_CELL_V2BRICKLET_STATUS_LED_CONFIG_SHOW_HEARTBEAT
LOAD_CELL_V2BRICKLET_STATUS_LED_CONFIG_SHOW_STATUS

source

pub fn get_chip_temperature(&self) -> ConvertingReceiver<i16>

Returns the temperature in °C 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.

source