Struct tinkerforge::tilt_bricklet::TiltBricklet

pub struct TiltBricklet { /* private fields */ }

Detects inclination of Bricklet (tilt switch open/closed)

Implementations

impl TiltBricklet

pub const DEVICE_IDENTIFIER: u16 = 239u16

pub const DEVICE_DISPLAY_NAME: &'static str = "Tilt Bricklet"

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

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: TiltBrickletFunction ) -> 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: TiltBrickletFunction, 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_tilt_state_callback_receiver(&self) -> ConvertingCallbackReceiver<u8>

This receiver provides the current tilt state. It is called every time the state changes.

See get_tilt_state for a description of the states.

pub fn get_tilt_state(&self) -> ConvertingReceiver<u8>

Returns the current tilt state. The state can either be

• 0 = Closed: The ball in the tilt switch closes the circuit.
• 1 = Open: The ball in the tilt switch does not close the circuit.
• 2 = Closed Vibrating: The tilt switch is in motion (rapid change between open and close).

.. image:: /Images/Bricklets/bricklet_tilt_mechanics.jpg :scale: 100 % :alt: Tilt states :align: center :target: ../../_images/Bricklets/bricklet_tilt_mechanics.jpg

Associated constants:

• TILT_BRICKLET_TILT_STATE_CLOSED
• TILT_BRICKLET_TILT_STATE_OPEN
• TILT_BRICKLET_TILT_STATE_CLOSED_VIBRATING

pub fn enable_tilt_state_callback(&self) -> ConvertingReceiver<()>

Enables the [get_tilt_state_callback_receiver] receiver.

pub fn disable_tilt_state_callback(&self) -> ConvertingReceiver<()>

Disables the [get_tilt_state_callback_receiver] receiver.

pub fn is_tilt_state_callback_enabled(&self) -> ConvertingReceiver<bool>

Returns true if the [get_tilt_state_callback_receiver] receiver is enabled.

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). A Bricklet connected to an Isolator Bricklet is always at position ‘z’.

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

Trait Implementations

impl Clone for TiltBricklet

fn clone(&self) -> TiltBricklet

Returns a copy of the value.

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

Performs copy-assignment from source.