Struct tinkerforge::multi_touch_bricklet::MultiTouchBricklet

pub struct MultiTouchBricklet { /* fields omitted */ }

Capacitive touch sensor for 12 electrodes

Methods

impl MultiTouchBricklet

pub const DEVICE_IDENTIFIER: u16

pub const DEVICE_DISPLAY_NAME: &'static str

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

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

pub fn set_response_expected(
    &mut self,
    fun: MultiTouchBrickletFunction,
    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.

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_touch_state_callback_receiver(
    &self
) -> ConvertingCallbackReceiver<u16>

Returns the current touch state, see get_touch_state for information about the state.

This receiver is triggered every time the touch state changes.

pub fn get_touch_state(&self) -> ConvertingReceiver<u16>

Returns the current touch state. The state is given as a bitfield.

Bits 0 to 11 represent the 12 electrodes and bit 12 represents the proximity.

If an electrode is touched, the corresponding bit is true. If a hand or similar is in proximity to the electrodes, bit 12 is true.

Example: The state 4103 = 0x1007 = 0b1000000000111 means that electrodes 0, 1 and 2 are touched and that something is in the proximity of the electrodes.

The proximity is activated with a distance of 1-2cm. An electrode is already counted as touched if a finger is nearly touching the electrode. This means that you can put a piece of paper or foil or similar on top of a electrode to build a touch panel with a professional look.

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

Recalibrates the electrodes. Call this function whenever you changed or moved you electrodes.

pub fn set_electrode_config(
    &self,
    enabled_electrodes: u16
) -> ConvertingReceiver<()>

Enables/disables electrodes with a bitfield (see get_touch_state).

True enables the electrode, false disables the electrode. A disabled electrode will always return false as its state. If you don't need all electrodes you can disable the electrodes that are not needed.

It is recommended that you disable the proximity bit (bit 12) if the proximity feature is not needed. This will reduce the amount of traffic that is produced by the get_touch_state_callback_receiver receiver.

Disabling electrodes will also reduce power consumption.

Default: 8191 = 0x1FFF = 0b1111111111111 (all electrodes enabled)

pub fn get_electrode_config(&self) -> ConvertingReceiver<u16>

Returns the electrode configuration, as set by set_electrode_config.

pub fn set_electrode_sensitivity(
    &self,
    sensitivity: u8
) -> ConvertingReceiver<()>

Sets the sensitivity of the electrodes. An electrode with a high sensitivity will register a touch earlier then an electrode with a low sensitivity.

If you build a big electrode you might need to decrease the sensitivity, since the area that can be charged will get bigger. If you want to be able to activate an electrode from further away you need to increase the sensitivity.

After a new sensitivity is set, you likely want to call recalibrate to calibrate the electrodes with the newly defined sensitivity.

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

Returns the current sensitivity, as set by set_electrode_sensitivity.

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

impl Clone for MultiTouchBricklet

fn clone(&self) -> MultiTouchBricklet

Returns a copy of the value.

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

Performs copy-assignment from source.