Struct tinkerforge::current25_bricklet::Current25Bricklet

pub struct Current25Bricklet { /* private fields */ }

Measures AC/DC current between -25A and +25A

Implementations

impl Current25Bricklet

pub const DEVICE_IDENTIFIER: u16 = 24u16

pub const DEVICE_DISPLAY_NAME: &'static str = "Current25 Bricklet"

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

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

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

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

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.

pub fn get_current_callback_receiver(&self) -> ConvertingCallbackReceiver<i16>

This receiver is triggered periodically with the period that is set by Set Current Receiver Period. The parameter is the current of the sensor.

The get_current_callback_receiver receiver is only triggered if the current has changed since the last triggering.

pub fn get_analog_value_callback_receiver(
    &self
) -> ConvertingCallbackReceiver<u16>

This receiver is triggered periodically with the period that is set by Set Analog Value Receiver Period. The parameter is the analog value of the sensor.

The get_analog_value_callback_receiver receiver is only triggered if the current has changed since the last triggering.

pub fn get_current_reached_callback_receiver(
    &self
) -> ConvertingCallbackReceiver<i16>

This receiver is triggered when the threshold as set by Set Current Receiver Threshold is reached. The parameter is the current of the sensor.

If the threshold keeps being reached, the receiver is triggered periodically with the period as set by Set Debounce Period.

pub fn get_analog_value_reached_callback_receiver(
    &self
) -> ConvertingCallbackReceiver<u16>

This receiver is triggered when the threshold as set by Set Analog Value Receiver Threshold is reached. The parameter is the analog value of the sensor.

If the threshold keeps being reached, the receiver is triggered periodically with the period as set by Set Debounce Period.

pub fn get_over_current_callback_receiver(
    &self
) -> ConvertingCallbackReceiver<()>

This receiver is triggered when an over current is measured (see Is Over Current).

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

Returns the current of the sensor. The value is in mA and between -25000mA and 25000mA.

If you want to get the current periodically, it is recommended to use the get_current_callback_receiver receiver and set the period with Set Current Receiver Period.

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

Calibrates the 0 value of the sensor. You have to call this function when there is no current present.

The zero point of the current sensor is depending on the exact properties of the analog-to-digital converter, the length of the Bricklet cable and the temperature. Thus, if you change the Brick or the environment in which the Bricklet is used, you might have to recalibrate.

The resulting calibration will be saved on the EEPROM of the Current Bricklet.

pub fn is_over_current(&self) -> ConvertingReceiver<bool>

Returns true if more than 25A were measured.

Note

To reset this value you have to power cycle the Bricklet.

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

Returns the value as read by a 12-bit analog-to-digital converter. The value is between 0 and 4095.

Note

The value returned by Get Current is averaged over several samples to yield less noise, while Get Analog Value gives back raw unfiltered analog values. The only reason to use Get Analog Value is, if you need the full resolution of the analog-to-digital converter.

If you want the analog value periodically, it is recommended to use the get_analog_value_callback_receiver receiver and set the period with Set Analog Value Receiver Period.

pub fn set_current_callback_period(&self, period: u32) -> ConvertingReceiver<()>

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

The get_current_callback_receiver receiver is only triggered if the current has changed since the last triggering.

The default value is 0.

pub fn get_current_callback_period(&self) -> ConvertingReceiver<u32>

Returns the period as set by Set Current Receiver Period.

pub fn set_analog_value_callback_period(
    &self,
    period: u32
) -> ConvertingReceiver<()>

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

The get_analog_value_callback_receiver receiver is only triggered if the analog value has changed since the last triggering.

The default value is 0.

pub fn get_analog_value_callback_period(&self) -> ConvertingReceiver<u32>

Returns the period as set by Set Analog Value Receiver Period.

pub fn set_current_callback_threshold(
    &self,
    option: char,
    min: i16,
    max: i16
) -> ConvertingReceiver<()>

Sets the thresholds for the get_current_reached_callback_receiver receiver.

The following options are possible:

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

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

Associated constants:

• CURRENT25BRICKLET_THRESHOLD_OPTION_OFF
• CURRENT25BRICKLET_THRESHOLD_OPTION_OUTSIDE
• CURRENT25BRICKLET_THRESHOLD_OPTION_INSIDE
• CURRENT25BRICKLET_THRESHOLD_OPTION_SMALLER
• CURRENT25BRICKLET_THRESHOLD_OPTION_GREATER

pub fn get_current_callback_threshold(
    &self
) -> ConvertingReceiver<CurrentCallbackThreshold>

Returns the threshold as set by Set Current Receiver Threshold.

Associated constants:

• CURRENT25BRICKLET_THRESHOLD_OPTION_OFF
• CURRENT25BRICKLET_THRESHOLD_OPTION_OUTSIDE
• CURRENT25BRICKLET_THRESHOLD_OPTION_INSIDE
• CURRENT25BRICKLET_THRESHOLD_OPTION_SMALLER
• CURRENT25BRICKLET_THRESHOLD_OPTION_GREATER

pub fn set_analog_value_callback_threshold(
    &self,
    option: char,
    min: u16,
    max: u16
) -> ConvertingReceiver<()>

Sets the thresholds for the get_analog_value_reached_callback_receiver receiver.

The following options are possible:

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

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

Associated constants:

• CURRENT25BRICKLET_THRESHOLD_OPTION_OFF
• CURRENT25BRICKLET_THRESHOLD_OPTION_OUTSIDE
• CURRENT25BRICKLET_THRESHOLD_OPTION_INSIDE
• CURRENT25BRICKLET_THRESHOLD_OPTION_SMALLER
• CURRENT25BRICKLET_THRESHOLD_OPTION_GREATER

pub fn get_analog_value_callback_threshold(
    &self
) -> ConvertingReceiver<AnalogValueCallbackThreshold>

Returns the threshold as set by Set Analog Value Receiver Threshold.

Associated constants:

• CURRENT25BRICKLET_THRESHOLD_OPTION_OFF
• CURRENT25BRICKLET_THRESHOLD_OPTION_OUTSIDE
• CURRENT25BRICKLET_THRESHOLD_OPTION_INSIDE
• CURRENT25BRICKLET_THRESHOLD_OPTION_SMALLER
• CURRENT25BRICKLET_THRESHOLD_OPTION_GREATER

pub fn set_debounce_period(&self, debounce: u32) -> ConvertingReceiver<()>

Sets the period in ms with which the threshold receivers

• get_current_reached_callback_receiver,
• get_analog_value_reached_callback_receiver

are triggered, if the thresholds

• Set Current Receiver Threshold,
• Set Analog Value Receiver Threshold

keep being reached.

The default value is 100.

pub fn get_debounce_period(&self) -> ConvertingReceiver<u32>

Returns the debounce period as set by Set Debounce Period.

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

impl Clone for Current25Bricklet

fn clone(&self) -> Current25Bricklet

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.