pub struct IndustrialDual020maBricklet { /* private fields */ }
Expand description
Measures two DC currents between 0mA and 20mA (IEC 60381-1)
Implementations
sourceimpl IndustrialDual020maBricklet
impl IndustrialDual020maBricklet
pub const DEVICE_IDENTIFIER: u16 = 228u16
pub const DEVICE_DISPLAY_NAME: &'static str = "Industrial Dual 0-20mA Bricklet"
sourcepub fn new(
uid: &str,
ip_connection: &IpConnection
) -> IndustrialDual020maBricklet
pub fn new(
uid: &str,
ip_connection: &IpConnection
) -> IndustrialDual020maBricklet
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: IndustrialDual020maBrickletFunction
) -> Result<bool, GetResponseExpectedError>
pub fn get_response_expected(
&mut self,
fun: IndustrialDual020maBrickletFunction
) -> 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: IndustrialDual020maBrickletFunction,
response_expected: bool
) -> Result<(), SetResponseExpectedError>
pub fn set_response_expected(
&mut self,
fun: IndustrialDual020maBrickletFunction,
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_current_callback_receiver(
&self
) -> ConvertingCallbackReceiver<CurrentEvent>
pub fn get_current_callback_receiver(
&self
) -> ConvertingCallbackReceiver<CurrentEvent>
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.
sourcepub fn get_current_reached_callback_receiver(
&self
) -> ConvertingCallbackReceiver<CurrentReachedEvent>
pub fn get_current_reached_callback_receiver(
&self
) -> ConvertingCallbackReceiver<CurrentReachedEvent>
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
.
sourcepub fn get_current(&self, sensor: u8) -> ConvertingReceiver<i32>
pub fn get_current(&self, sensor: u8) -> ConvertingReceiver<i32>
Returns the current of the specified sensor (0 or 1). The value is in nA and between 0nA and 22505322nA (22.5mA).
It is possible to detect if an IEC 60381-1 compatible sensor is connected and if it works probably.
If the returned current is below 4mA, there is likely no sensor connected or the sensor may be defect. If the returned current is over 20mA, there might be a short circuit or the sensor may be defect.
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
.
sourcepub fn set_current_callback_period(
&self,
sensor: u8,
period: u32
) -> ConvertingReceiver<()>
pub fn set_current_callback_period(
&self,
sensor: u8,
period: u32
) -> ConvertingReceiver<()>
Sets the period in ms with which the get_current_callback_receiver
receiver is triggered
periodically for the given sensor. 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.
sourcepub fn get_current_callback_period(&self, sensor: u8) -> ConvertingReceiver<u32>
pub fn get_current_callback_period(&self, sensor: u8) -> ConvertingReceiver<u32>
Returns the period as set by Set Current Receiver Period
.
sourcepub fn set_current_callback_threshold(
&self,
sensor: u8,
option: char,
min: i32,
max: i32
) -> ConvertingReceiver<()>
pub fn set_current_callback_threshold(
&self,
sensor: u8,
option: char,
min: i32,
max: i32
) -> ConvertingReceiver<()>
Sets the thresholds for the get_current_reached_callback_receiver
receiver for the given
sensor.
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:
- INDUSTRIAL_DUAL_0_20MABRICKLET_THRESHOLD_OPTION_OFF
- INDUSTRIAL_DUAL_0_20MABRICKLET_THRESHOLD_OPTION_OUTSIDE
- INDUSTRIAL_DUAL_0_20MABRICKLET_THRESHOLD_OPTION_INSIDE
- INDUSTRIAL_DUAL_0_20MABRICKLET_THRESHOLD_OPTION_SMALLER
- INDUSTRIAL_DUAL_0_20MABRICKLET_THRESHOLD_OPTION_GREATER
sourcepub fn get_current_callback_threshold(
&self,
sensor: u8
) -> ConvertingReceiver<CurrentCallbackThreshold>
pub fn get_current_callback_threshold(
&self,
sensor: u8
) -> ConvertingReceiver<CurrentCallbackThreshold>
Returns the threshold as set by Set Current Receiver Threshold
.
Associated constants:
- INDUSTRIAL_DUAL_0_20MABRICKLET_THRESHOLD_OPTION_OFF
- INDUSTRIAL_DUAL_0_20MABRICKLET_THRESHOLD_OPTION_OUTSIDE
- INDUSTRIAL_DUAL_0_20MABRICKLET_THRESHOLD_OPTION_INSIDE
- INDUSTRIAL_DUAL_0_20MABRICKLET_THRESHOLD_OPTION_SMALLER
- INDUSTRIAL_DUAL_0_20MABRICKLET_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 Current 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_sample_rate(&self, rate: u8) -> ConvertingReceiver<()>
pub fn set_sample_rate(&self, rate: u8) -> ConvertingReceiver<()>
Sets the sample rate to either 240, 60, 15 or 4 samples per second. The resolution for the rates is 12, 14, 16 and 18 bit respectively.
Value | Description |
---|---|
0 | 240 samples per second |
1 | 60 samples per second |
2 | 15 samples per second |
3 | 4 samples per second |
The default value is 3 (4 samples per second with 18 bit resolution).
Associated constants:
- INDUSTRIAL_DUAL_0_20MABRICKLET_SAMPLE_RATE_240_SPS
- INDUSTRIAL_DUAL_0_20MABRICKLET_SAMPLE_RATE_60_SPS
- INDUSTRIAL_DUAL_0_20MABRICKLET_SAMPLE_RATE_15_SPS
- INDUSTRIAL_DUAL_0_20MABRICKLET_SAMPLE_RATE_4_SPS
sourcepub fn get_sample_rate(&self) -> ConvertingReceiver<u8>
pub fn get_sample_rate(&self) -> ConvertingReceiver<u8>
Returns the sample rate as set by Set Sample Rate
.
Associated constants:
- INDUSTRIAL_DUAL_0_20MABRICKLET_SAMPLE_RATE_240_SPS
- INDUSTRIAL_DUAL_0_20MABRICKLET_SAMPLE_RATE_60_SPS
- INDUSTRIAL_DUAL_0_20MABRICKLET_SAMPLE_RATE_15_SPS
- INDUSTRIAL_DUAL_0_20MABRICKLET_SAMPLE_RATE_4_SPS
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 IndustrialDual020maBricklet
impl Clone for IndustrialDual020maBricklet
sourcefn clone(&self) -> IndustrialDual020maBricklet
fn clone(&self) -> IndustrialDual020maBricklet
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read more