pub struct HallEffectBricklet { /* private fields */ }
Expand description
Detects presence of magnetic field
Implementations
sourceimpl HallEffectBricklet
impl HallEffectBricklet
pub const DEVICE_IDENTIFIER: u16 = 240u16
pub const DEVICE_DISPLAY_NAME: &'static str = "Hall Effect Bricklet"
sourcepub fn new(uid: &str, ip_connection: &IpConnection) -> HallEffectBricklet
pub fn new(uid: &str, ip_connection: &IpConnection) -> HallEffectBricklet
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: HallEffectBrickletFunction
) -> Result<bool, GetResponseExpectedError>
pub fn get_response_expected(
&mut self,
fun: HallEffectBrickletFunction
) -> 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: HallEffectBrickletFunction,
response_expected: bool
) -> Result<(), SetResponseExpectedError>
pub fn set_response_expected(
&mut self,
fun: HallEffectBrickletFunction,
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_edge_count_callback_receiver(
&self
) -> ConvertingCallbackReceiver<EdgeCountEvent>
pub fn get_edge_count_callback_receiver(
&self
) -> ConvertingCallbackReceiver<EdgeCountEvent>
This receiver is triggered periodically with the period that is set by
set_edge_count_callback_period
. The parameters are the
current count and the current value (see get_value
and
get_edge_count
).
The get_edge_count_callback_receiver
receiver is only triggered if the count or value changed
since the last triggering.
sourcepub fn get_value(&self) -> ConvertingReceiver<bool>
pub fn get_value(&self) -> ConvertingReceiver<bool>
Returns true if a magnetic field of 35 Gauss (3.5mT) or greater is detected.
sourcepub fn get_edge_count(&self, reset_counter: bool) -> ConvertingReceiver<u32>
pub fn get_edge_count(&self, reset_counter: bool) -> ConvertingReceiver<u32>
Returns the current value of the edge counter. You can configure
edge type (rising, falling, both) that is counted with
set_edge_count_config
.
If you set the reset counter to true, the count is set back to 0 directly after it is read.
sourcepub fn set_edge_count_config(
&self,
edge_type: u8,
debounce: u8
) -> ConvertingReceiver<()>
pub fn set_edge_count_config(
&self,
edge_type: u8,
debounce: u8
) -> ConvertingReceiver<()>
The edge type parameter configures if rising edges, falling edges or both are counted. Possible edge types are:
- 0 = rising (default)
- 1 = falling
- 2 = both
A magnetic field of 35 Gauss (3.5mT) or greater causes a falling edge and a magnetic field of 25 Gauss (2.5mT) or smaller causes a rising edge.
If a magnet comes near the Bricklet the signal goes low (falling edge), if a magnet is removed from the vicinity the signal goes high (rising edge).
The debounce time is given in ms.
Configuring an edge counter resets its value to 0.
If you don’t know what any of this means, just leave it at default. The default configuration is very likely OK for you.
Default values: 0 (edge type) and 100ms (debounce time)
Associated constants:
- HALL_EFFECT_BRICKLET_EDGE_TYPE_RISING
- HALL_EFFECT_BRICKLET_EDGE_TYPE_FALLING
- HALL_EFFECT_BRICKLET_EDGE_TYPE_BOTH
sourcepub fn get_edge_count_config(&self) -> ConvertingReceiver<EdgeCountConfig>
pub fn get_edge_count_config(&self) -> ConvertingReceiver<EdgeCountConfig>
Returns the edge type and debounce time as set by set_edge_count_config
.
Associated constants:
- HALL_EFFECT_BRICKLET_EDGE_TYPE_RISING
- HALL_EFFECT_BRICKLET_EDGE_TYPE_FALLING
- HALL_EFFECT_BRICKLET_EDGE_TYPE_BOTH
sourcepub fn set_edge_interrupt(&self, edges: u32) -> ConvertingReceiver<()>
pub fn set_edge_interrupt(&self, edges: u32) -> ConvertingReceiver<()>
Sets the number of edges until an interrupt is invoked.
If edges is set to n, an interrupt is invoked for every n-th detected edge.
If edges is set to 0, the interrupt is disabled.
Default value is 0.
sourcepub fn get_edge_interrupt(&self) -> ConvertingReceiver<u32>
pub fn get_edge_interrupt(&self) -> ConvertingReceiver<u32>
Returns the edges as set by set_edge_interrupt
.
sourcepub fn set_edge_count_callback_period(
&self,
period: u32
) -> ConvertingReceiver<()>
pub fn set_edge_count_callback_period(
&self,
period: u32
) -> ConvertingReceiver<()>
Sets the period in ms with which the get_edge_count_callback_receiver
receiver is triggered
periodically. A value of 0 turns the receiver off.
The get_edge_count_callback_receiver
receiver is only triggered if the edge count has changed
since the last triggering.
The default value is 0.
sourcepub fn get_edge_count_callback_period(&self) -> ConvertingReceiver<u32>
pub fn get_edge_count_callback_period(&self) -> ConvertingReceiver<u32>
Returns the period as set by set_edge_count_callback_period
.
sourcepub fn edge_interrupt(&self) -> ConvertingReceiver<EdgeInterrupt>
pub fn edge_interrupt(&self) -> ConvertingReceiver<EdgeInterrupt>
This receiver is triggered every n-th count, as configured with
set_edge_interrupt
. The parameters are the
current count and the current value (see get_value
and
get_edge_count
).
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 HallEffectBricklet
impl Clone for HallEffectBricklet
sourcefn clone(&self) -> HallEffectBricklet
fn clone(&self) -> HallEffectBricklet
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read more