pub struct RotaryEncoderBricklet { /* private fields */ }
Expand description
360° rotary encoder with push-button
Implementations
sourceimpl RotaryEncoderBricklet
impl RotaryEncoderBricklet
pub const DEVICE_IDENTIFIER: u16 = 236u16
pub const DEVICE_DISPLAY_NAME: &'static str = "Rotary Encoder Bricklet"
sourcepub fn new(uid: &str, ip_connection: &IpConnection) -> RotaryEncoderBricklet
pub fn new(uid: &str, ip_connection: &IpConnection) -> RotaryEncoderBricklet
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: RotaryEncoderBrickletFunction
) -> Result<bool, GetResponseExpectedError>
pub fn get_response_expected(
&mut self,
fun: RotaryEncoderBrickletFunction
) -> 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: RotaryEncoderBrickletFunction,
response_expected: bool
) -> Result<(), SetResponseExpectedError>
pub fn set_response_expected(
&mut self,
fun: RotaryEncoderBrickletFunction,
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_count_callback_receiver(&self) -> ConvertingCallbackReceiver<i32>
pub fn get_count_callback_receiver(&self) -> ConvertingCallbackReceiver<i32>
This receiver is triggered periodically with the period that is set by
Set Count Receiver Period
. The parameter is the count of
the encoder.
The get_count_callback_receiver
receiver is only triggered if the count has changed since the
last triggering.
sourcepub fn get_count_reached_callback_receiver(
&self
) -> ConvertingCallbackReceiver<i32>
pub fn get_count_reached_callback_receiver(
&self
) -> ConvertingCallbackReceiver<i32>
This receiver is triggered when the threshold as set by
Set Count Receiver Threshold
is reached.
The parameter is the count of the encoder.
If the threshold keeps being reached, the receiver is triggered periodically
with the period as set by Set Debounce Period
.
sourcepub fn get_pressed_callback_receiver(&self) -> ConvertingCallbackReceiver<()>
pub fn get_pressed_callback_receiver(&self) -> ConvertingCallbackReceiver<()>
This receiver is triggered when the button is pressed.
sourcepub fn get_released_callback_receiver(&self) -> ConvertingCallbackReceiver<()>
pub fn get_released_callback_receiver(&self) -> ConvertingCallbackReceiver<()>
This receiver is triggered when the button is released.
sourcepub fn get_count(&self, reset: bool) -> ConvertingReceiver<i32>
pub fn get_count(&self, reset: bool) -> ConvertingReceiver<i32>
Returns the current count of the encoder. If you set reset to true, the count is set back to 0 directly after the current count is read.
The encoder has 24 steps per rotation
Turning the encoder to the left decrements the counter, so a negative count is possible.
sourcepub fn set_count_callback_period(&self, period: u32) -> ConvertingReceiver<()>
pub fn set_count_callback_period(&self, period: u32) -> ConvertingReceiver<()>
Sets the period in ms with which the get_count_callback_receiver
receiver is triggered
periodically. A value of 0 turns the receiver off.
The get_count_callback_receiver
receiver is only triggered if the count has changed since the
last triggering.
The default value is 0.
sourcepub fn get_count_callback_period(&self) -> ConvertingReceiver<u32>
pub fn get_count_callback_period(&self) -> ConvertingReceiver<u32>
Returns the period as set by Set Count Receiver Period
.
sourcepub fn set_count_callback_threshold(
&self,
option: char,
min: i32,
max: i32
) -> ConvertingReceiver<()>
pub fn set_count_callback_threshold(
&self,
option: char,
min: i32,
max: i32
) -> ConvertingReceiver<()>
Sets the thresholds for the get_count_reached_callback_receiver
receiver.
The following options are possible:
Option | Description |
---|---|
‘x’ | Receiver is turned off |
‘o’ | Receiver is triggered when the count is outside the min and max values |
‘i’ | Receiver is triggered when the count is inside the min and max values |
‘<’ | Receiver is triggered when the count is smaller than the min value (max is ignored) |
‘>’ | Receiver is triggered when the count is greater than the min value (max is ignored) |
The default value is (‘x’, 0, 0).
Associated constants:
- ROTARY_ENCODERBRICKLET_THRESHOLD_OPTION_OFF
- ROTARY_ENCODERBRICKLET_THRESHOLD_OPTION_OUTSIDE
- ROTARY_ENCODERBRICKLET_THRESHOLD_OPTION_INSIDE
- ROTARY_ENCODERBRICKLET_THRESHOLD_OPTION_SMALLER
- ROTARY_ENCODERBRICKLET_THRESHOLD_OPTION_GREATER
sourcepub fn get_count_callback_threshold(
&self
) -> ConvertingReceiver<CountCallbackThreshold>
pub fn get_count_callback_threshold(
&self
) -> ConvertingReceiver<CountCallbackThreshold>
Returns the threshold as set by Set Count Receiver Threshold
.
Associated constants:
- ROTARY_ENCODERBRICKLET_THRESHOLD_OPTION_OFF
- ROTARY_ENCODERBRICKLET_THRESHOLD_OPTION_OUTSIDE
- ROTARY_ENCODERBRICKLET_THRESHOLD_OPTION_INSIDE
- ROTARY_ENCODERBRICKLET_THRESHOLD_OPTION_SMALLER
- ROTARY_ENCODERBRICKLET_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 thresholds
Set Count 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 is_pressed(&self) -> ConvertingReceiver<bool>
pub fn is_pressed(&self) -> ConvertingReceiver<bool>
Returns true if the button is pressed and false otherwise.
It is recommended to use the get_pressed_callback_receiver
and get_released_callback_receiver
receivers
to handle the button.
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 RotaryEncoderBricklet
impl Clone for RotaryEncoderBricklet
sourcefn clone(&self) -> RotaryEncoderBricklet
fn clone(&self) -> RotaryEncoderBricklet
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read more