Struct tinkerforge::tilt_bricklet::TiltBricklet

source ·

pub struct TiltBricklet { /* private fields */ }

Expand description

Detects inclination of Bricklet (tilt switch open/closed)

Implementations

source

pub fn new(uid: &str, ip_connection: &IpConnection) -> TiltBricklet

Creates an object with the unique device ID uid. This object can then be used after the IP Connection ip_connection is connected.

source

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

source

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 send and errors are silently ignored, because they cannot be detected.

source

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.

source

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.

source

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: