Struct tinkerforge::dual_button_bricklet::DualButtonBricklet

pub struct DualButtonBricklet { /* fields omitted */ }

Two tactile buttons with built-in blue LEDs

Methods

impl DualButtonBricklet

pub const DEVICE_IDENTIFIER: u16

pub const DEVICE_DISPLAY_NAME: &'static str

pub fn new<T: GetRequestSender>(uid: &str, req_sender: T) -> DualButtonBricklet

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: 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 sent 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: 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 sent 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_api_version(&self) -> [u8; 3]

Returns the version of the API definition (major, minor, revision) implemented by this API bindings. This is neither the release version of this API bindings nor does it tell you anything about the represented Brick or Bricklet.

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).

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].

Associated constants:

• DUAL_BUTTON_BRICKLET_LED_STATE_AUTO_TOGGLE_ON
• DUAL_BUTTON_BRICKLET_LED_STATE_AUTO_TOGGLE_OFF
• DUAL_BUTTON_BRICKLET_LED_STATE_ON
• DUAL_BUTTON_BRICKLET_LED_STATE_OFF

pub fn get_led_state(&self) -> ConvertingReceiver<LedState>

Returns the current state of the LEDs, as set by [set_led_state].

Associated constants:

• DUAL_BUTTON_BRICKLET_LED_STATE_AUTO_TOGGLE_ON
• DUAL_BUTTON_BRICKLET_LED_STATE_AUTO_TOGGLE_OFF
• DUAL_BUTTON_BRICKLET_LED_STATE_ON
• DUAL_BUTTON_BRICKLET_LED_STATE_OFF

pub fn get_button_state(&self) -> ConvertingReceiver<ButtonState>

Returns the current state for both buttons. Possible states are:

• 0 = pressed
• 1 = released

Associated constants:

• DUAL_BUTTON_BRICKLET_BUTTON_STATE_PRESSED
• DUAL_BUTTON_BRICKLET_BUTTON_STATE_RELEASED

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_BUTTON_BRICKLET_LED_LEFT
• DUAL_BUTTON_BRICKLET_LED_RIGHT
• DUAL_BUTTON_BRICKLET_LED_STATE_AUTO_TOGGLE_ON
• DUAL_BUTTON_BRICKLET_LED_STATE_AUTO_TOGGLE_OFF
• DUAL_BUTTON_BRICKLET_LED_STATE_ON
• DUAL_BUTTON_BRICKLET_LED_STATE_OFF

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', 'd', 'e', 'f', 'g' or 'h' (Bricklet Port). The Raspberry Pi HAT (Zero) Brick is always at position 'i' and the Bricklet connected to an Isolator Bricklet is always as position 'z'.

The device identifier numbers can be found here. |device_identifier_constant|

Trait Implementations

impl Clone for DualButtonBricklet

fn clone(&self) -> DualButtonBricklet

Returns a copy of the value.

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

Performs copy-assignment from source.