1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
/* ***********************************************************
* This file was automatically generated on 2019-11-25. *
* *
* Rust Bindings Version 2.0.13 *
* *
* If you have a bugfix for this file and want to commit it, *
* please fix the bug in the generator. You can find a link *
* to the generators git repository on tinkerforge.com *
*************************************************************/
//! Capacitive touch sensor for 12 electrodes.
//!
//! See also the documentation [here](https://www.tinkerforge.com/en/doc/Software/Bricklets/MultiTouch_Bricklet_Rust.html).
use crate::{
byte_converter::*, converting_callback_receiver::ConvertingCallbackReceiver, converting_receiver::ConvertingReceiver, device::*,
ip_connection::GetRequestSender,
};
pub enum MultiTouchBrickletFunction {
GetTouchState,
Recalibrate,
SetElectrodeConfig,
GetElectrodeConfig,
SetElectrodeSensitivity,
GetElectrodeSensitivity,
GetIdentity,
CallbackTouchState,
}
impl From<MultiTouchBrickletFunction> for u8 {
fn from(fun: MultiTouchBrickletFunction) -> Self {
match fun {
MultiTouchBrickletFunction::GetTouchState => 1,
MultiTouchBrickletFunction::Recalibrate => 2,
MultiTouchBrickletFunction::SetElectrodeConfig => 3,
MultiTouchBrickletFunction::GetElectrodeConfig => 4,
MultiTouchBrickletFunction::SetElectrodeSensitivity => 6,
MultiTouchBrickletFunction::GetElectrodeSensitivity => 7,
MultiTouchBrickletFunction::GetIdentity => 255,
MultiTouchBrickletFunction::CallbackTouchState => 5,
}
}
}
#[derive(Clone, Debug, Default, PartialEq, Eq, Hash)]
pub struct Identity {
pub uid: String,
pub connected_uid: String,
pub position: char,
pub hardware_version: [u8; 3],
pub firmware_version: [u8; 3],
pub device_identifier: u16,
}
impl FromByteSlice for Identity {
fn bytes_expected() -> usize { 25 }
fn from_le_byte_slice(bytes: &[u8]) -> Identity {
Identity {
uid: <String>::from_le_byte_slice(&bytes[0..8]),
connected_uid: <String>::from_le_byte_slice(&bytes[8..16]),
position: <char>::from_le_byte_slice(&bytes[16..17]),
hardware_version: <[u8; 3]>::from_le_byte_slice(&bytes[17..20]),
firmware_version: <[u8; 3]>::from_le_byte_slice(&bytes[20..23]),
device_identifier: <u16>::from_le_byte_slice(&bytes[23..25]),
}
}
}
/// Capacitive touch sensor for 12 electrodes
#[derive(Clone)]
pub struct MultiTouchBricklet {
device: Device,
}
impl MultiTouchBricklet {
pub const DEVICE_IDENTIFIER: u16 = 234;
pub const DEVICE_DISPLAY_NAME: &'static str = "Multi Touch Bricklet";
/// 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 new<T: GetRequestSender>(uid: &str, req_sender: T) -> MultiTouchBricklet {
let mut result = MultiTouchBricklet { device: Device::new([2, 0, 0], uid, req_sender, 0) };
result.device.response_expected[u8::from(MultiTouchBrickletFunction::GetTouchState) as usize] = ResponseExpectedFlag::AlwaysTrue;
result.device.response_expected[u8::from(MultiTouchBrickletFunction::Recalibrate) as usize] = ResponseExpectedFlag::False;
result.device.response_expected[u8::from(MultiTouchBrickletFunction::SetElectrodeConfig) as usize] = ResponseExpectedFlag::False;
result.device.response_expected[u8::from(MultiTouchBrickletFunction::GetElectrodeConfig) as usize] =
ResponseExpectedFlag::AlwaysTrue;
result.device.response_expected[u8::from(MultiTouchBrickletFunction::SetElectrodeSensitivity) as usize] =
ResponseExpectedFlag::False;
result.device.response_expected[u8::from(MultiTouchBrickletFunction::GetElectrodeSensitivity) as usize] =
ResponseExpectedFlag::AlwaysTrue;
result.device.response_expected[u8::from(MultiTouchBrickletFunction::GetIdentity) as usize] = ResponseExpectedFlag::AlwaysTrue;
result
}
/// 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`](crate::multi_touch_bricklet::MultiTouchBricklet::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`](crate::multi_touch_bricklet::MultiTouchBricklet::set_response_expected) for the list of function ID constants available for this function.
pub fn get_response_expected(&mut self, fun: MultiTouchBrickletFunction) -> Result<bool, GetResponseExpectedError> {
self.device.get_response_expected(u8::from(fun))
}
/// 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(
&mut self,
fun: MultiTouchBrickletFunction,
response_expected: bool,
) -> Result<(), SetResponseExpectedError> {
self.device.set_response_expected(u8::from(fun), response_expected)
}
/// Changes the response expected flag for all setter and callback configuration functions of this device at once.
pub fn set_response_expected_all(&mut self, response_expected: bool) { self.device.set_response_expected_all(response_expected) }
/// 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_api_version(&self) -> [u8; 3] { self.device.api_version }
/// Returns the current touch state, see [`get_touch_state`] for
/// information about the state.
///
/// This receiver is triggered every time the touch state changes.
///
/// [`get_touch_state`]: #method.get_touch_state
pub fn get_touch_state_callback_receiver(&self) -> ConvertingCallbackReceiver<u16> {
self.device.get_callback_receiver(u8::from(MultiTouchBrickletFunction::CallbackTouchState))
}
/// 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 get_touch_state(&self) -> ConvertingReceiver<u16> {
let payload = vec![0; 0];
self.device.get(u8::from(MultiTouchBrickletFunction::GetTouchState), payload)
}
/// Recalibrates the electrodes. Call this function whenever you changed
/// or moved you electrodes.
pub fn recalibrate(&self) -> ConvertingReceiver<()> {
let payload = vec![0; 0];
self.device.set(u8::from(MultiTouchBrickletFunction::Recalibrate), payload)
}
/// 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)
///
/// [`get_touch_state`]: #method.get_touch_state
/// [`get_touch_state_callback_receiver`]: #method.get_touch_state_callback_receiver
pub fn set_electrode_config(&self, enabled_electrodes: u16) -> ConvertingReceiver<()> {
let mut payload = vec![0; 2];
payload[0..2].copy_from_slice(&<u16>::to_le_byte_vec(enabled_electrodes));
self.device.set(u8::from(MultiTouchBrickletFunction::SetElectrodeConfig), payload)
}
/// Returns the electrode configuration, as set by [`set_electrode_config`].
///
/// [`set_electrode_config`]: #method.set_electrode_config
pub fn get_electrode_config(&self) -> ConvertingReceiver<u16> {
let payload = vec![0; 0];
self.device.get(u8::from(MultiTouchBrickletFunction::GetElectrodeConfig), payload)
}
/// 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.
///
/// [`recalibrate`]: #method.recalibrate
pub fn set_electrode_sensitivity(&self, sensitivity: u8) -> ConvertingReceiver<()> {
let mut payload = vec![0; 1];
payload[0..1].copy_from_slice(&<u8>::to_le_byte_vec(sensitivity));
self.device.set(u8::from(MultiTouchBrickletFunction::SetElectrodeSensitivity), payload)
}
/// Returns the current sensitivity, as set by [`set_electrode_sensitivity`].
///
/// [`set_electrode_sensitivity`]: #method.set_electrode_sensitivity
pub fn get_electrode_sensitivity(&self) -> ConvertingReceiver<u8> {
let payload = vec![0; 0];
self.device.get(u8::from(MultiTouchBrickletFunction::GetElectrodeSensitivity), payload)
}
/// 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).
/// |device_identifier_constant|
pub fn get_identity(&self) -> ConvertingReceiver<Identity> {
let payload = vec![0; 0];
self.device.get(u8::from(MultiTouchBrickletFunction::GetIdentity), payload)
}
}