pub struct DualButtonBricklet { /* private fields */ }
Expand description
Two tactile buttons with built-in blue LEDs
Implementations
sourceimpl DualButtonBricklet
impl DualButtonBricklet
pub const DEVICE_IDENTIFIER: u16 = 230u16
pub const DEVICE_DISPLAY_NAME: &'static str = "Dual Button Bricklet"
sourcepub fn new(uid: &str, ip_connection: &IpConnection) -> DualButtonBricklet
pub fn new(uid: &str, ip_connection: &IpConnection) -> DualButtonBricklet
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: DualButtonBrickletFunction
) -> Result<bool, GetResponseExpectedError>
pub fn get_response_expected(
&mut self,
fun: DualButtonBrickletFunction
) -> 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: DualButtonBrickletFunction,
response_expected: bool
) -> Result<(), SetResponseExpectedError>
pub fn set_response_expected(
&mut self,
fun: DualButtonBrickletFunction,
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_state_changed_callback_receiver(
&self
) -> ConvertingCallbackReceiver<StateChangedEvent>
pub fn get_state_changed_callback_receiver(
&self
) -> ConvertingCallbackReceiver<StateChangedEvent>
This receiver is called whenever a button is pressed.
Possible states for buttons are:
- 0 = pressed
- 1 = released
Possible states for LEDs are:
- 0 = AutoToggleOn: Auto toggle enabled and LED on.
- 1 = AutoToggleOff: Auto toggle enabled and LED off.
- 2 = On: LED on (auto toggle is disabled).
- 3 = Off: LED off (auto toggle is disabled).
sourcepub fn set_led_state(&self, led_l: u8, led_r: u8) -> ConvertingReceiver<()>
pub fn set_led_state(&self, led_l: u8, led_r: u8) -> ConvertingReceiver<()>
Sets the state of the LEDs. Possible states are:
- 0 = AutoToggleOn: Enables auto toggle with initially enabled LED.
- 1 = AutoToggleOff: Activates auto toggle with initially disabled LED.
- 2 = On: Enables LED (auto toggle is disabled).
- 3 = Off: Disables LED (auto toggle is disabled).
In auto toggle mode the LED is toggled automatically at each press of a button.
If you just want to set one of the LEDs and don’t know the current state
of the other LED, you can get the state with Get LED State
or you
can use Set Selected LED State
.
The default value is (1, 1).
Associated constants:
- DUAL_BUTTONBRICKLET_LED_STATE_AUTO_TOGGLE_ON
- DUAL_BUTTONBRICKLET_LED_STATE_AUTO_TOGGLE_OFF
- DUAL_BUTTONBRICKLET_LED_STATE_ON
- DUAL_BUTTONBRICKLET_LED_STATE_OFF
sourcepub fn get_led_state(&self) -> ConvertingReceiver<LedState>
pub fn get_led_state(&self) -> ConvertingReceiver<LedState>
Returns the current state of the LEDs, as set by Set LED State
.
Associated constants:
- DUAL_BUTTONBRICKLET_LED_STATE_AUTO_TOGGLE_ON
- DUAL_BUTTONBRICKLET_LED_STATE_AUTO_TOGGLE_OFF
- DUAL_BUTTONBRICKLET_LED_STATE_ON
- DUAL_BUTTONBRICKLET_LED_STATE_OFF
Returns the current state for both buttons. Possible states are:
- 0 = pressed
- 1 = released
Associated constants:
- DUAL_BUTTONBRICKLET_BUTTON_STATE_PRESSED
- DUAL_BUTTONBRICKLET_BUTTON_STATE_RELEASED
sourcepub fn set_selected_led_state(&self, led: u8, state: u8) -> ConvertingReceiver<()>
pub fn set_selected_led_state(&self, led: u8, state: u8) -> ConvertingReceiver<()>
Sets the state of the selected LED (0 or 1).
The other LED remains untouched.
Associated constants:
- DUAL_BUTTONBRICKLET_LED_LEFT
- DUAL_BUTTONBRICKLET_LED_RIGHT
- DUAL_BUTTONBRICKLET_LED_STATE_AUTO_TOGGLE_ON
- DUAL_BUTTONBRICKLET_LED_STATE_AUTO_TOGGLE_OFF
- DUAL_BUTTONBRICKLET_LED_STATE_ON
- DUAL_BUTTONBRICKLET_LED_STATE_OFF
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 DualButtonBricklet
impl Clone for DualButtonBricklet
sourcefn clone(&self) -> DualButtonBricklet
fn clone(&self) -> DualButtonBricklet
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read more