Class: Tinkerforge::BrickletMultiTouchV2

Inherits:
Device
  • Object
show all
Defined in:
lib/tinkerforge/bricklet_multi_touch_v2.rb

Overview

Capacitive touch sensor for 12 electrodes

Constant Summary collapse

DEVICE_IDENTIFIER =

:nodoc:

2129
DEVICE_DISPLAY_NAME =

:nodoc:

'Multi Touch Bricklet 2.0'
CALLBACK_TOUCH_STATE =

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

This callback is triggered every time the touch state changes with a given period (see BrickletMultiTouchV2#set_touch_state_callback_configuration)

4
FUNCTION_GET_TOUCH_STATE =

:nodoc:

1
FUNCTION_SET_TOUCH_STATE_CALLBACK_CONFIGURATION =

:nodoc:

2
FUNCTION_GET_TOUCH_STATE_CALLBACK_CONFIGURATION =

:nodoc:

3
FUNCTION_RECALIBRATE =

:nodoc:

5
FUNCTION_SET_ELECTRODE_CONFIG =

:nodoc:

6
FUNCTION_GET_ELECTRODE_CONFIG =

:nodoc:

7
FUNCTION_SET_ELECTRODE_SENSITIVITY =

:nodoc:

8
FUNCTION_GET_ELECTRODE_SENSITIVITY =

:nodoc:

9
FUNCTION_SET_TOUCH_LED_CONFIG =

:nodoc:

10
FUNCTION_GET_TOUCH_LED_CONFIG =

:nodoc:

11
FUNCTION_GET_SPITFP_ERROR_COUNT =

:nodoc:

234
FUNCTION_SET_BOOTLOADER_MODE =

:nodoc:

235
FUNCTION_GET_BOOTLOADER_MODE =

:nodoc:

236
FUNCTION_SET_WRITE_FIRMWARE_POINTER =

:nodoc:

237
FUNCTION_WRITE_FIRMWARE =

:nodoc:

238
FUNCTION_SET_STATUS_LED_CONFIG =

:nodoc:

239
FUNCTION_GET_STATUS_LED_CONFIG =

:nodoc:

240
FUNCTION_GET_CHIP_TEMPERATURE =

:nodoc:

242
FUNCTION_RESET =

:nodoc:

243
FUNCTION_WRITE_UID =

:nodoc:

248
FUNCTION_READ_UID =

:nodoc:

249
FUNCTION_GET_IDENTITY =

:nodoc:

255
TOUCH_LED_CONFIG_OFF =

:nodoc:

0
TOUCH_LED_CONFIG_ON =

:nodoc:

1
TOUCH_LED_CONFIG_SHOW_HEARTBEAT =

:nodoc:

2
TOUCH_LED_CONFIG_SHOW_TOUCH =

:nodoc:

3
BOOTLOADER_MODE_BOOTLOADER =

:nodoc:

0
BOOTLOADER_MODE_FIRMWARE =

:nodoc:

1
BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT =

:nodoc:

2
BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT =

:nodoc:

3
BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT =

:nodoc:

4
BOOTLOADER_STATUS_OK =

:nodoc:

0
BOOTLOADER_STATUS_INVALID_MODE =

:nodoc:

1
BOOTLOADER_STATUS_NO_CHANGE =

:nodoc:

2
BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT =

:nodoc:

3
BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT =

:nodoc:

4
BOOTLOADER_STATUS_CRC_MISMATCH =

:nodoc:

5
STATUS_LED_CONFIG_OFF =

:nodoc:

0
STATUS_LED_CONFIG_ON =

:nodoc:

1
STATUS_LED_CONFIG_SHOW_HEARTBEAT =

:nodoc:

2
STATUS_LED_CONFIG_SHOW_STATUS =

:nodoc:

3

Constants inherited from Device

Device::DEVICE_IDENTIFIER_CHECK_MATCH, Device::DEVICE_IDENTIFIER_CHECK_MISMATCH, Device::DEVICE_IDENTIFIER_CHECK_PENDING, Device::RESPONSE_EXPECTED_ALWAYS_TRUE, Device::RESPONSE_EXPECTED_FALSE, Device::RESPONSE_EXPECTED_INVALID_FUNCTION_ID, Device::RESPONSE_EXPECTED_TRUE

Instance Attribute Summary

Attributes inherited from Device

#callback_formats, #expected_response_function_id, #expected_response_sequence_number, #high_level_callbacks, #registered_callbacks, #replaced, #uid

Instance Method Summary collapse

Methods inherited from Device

#check_validity, #dequeue_response, #enqueue_response, #get_api_version, #get_response_expected, #send_request, #set_response_expected, #set_response_expected_all

Constructor Details

#initialize(uid, ipcon) ⇒ BrickletMultiTouchV2

Creates an object with the unique device ID uid and adds it to the IP Connection ipcon.



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
 
# File 'lib/tinkerforge/bricklet_multi_touch_v2.rb', line 72

def initialize(uid, ipcon)
  super uid, ipcon, DEVICE_IDENTIFIER, DEVICE_DISPLAY_NAME

  @api_version = [2, 0, 0]

  @response_expected[FUNCTION_GET_TOUCH_STATE] = RESPONSE_EXPECTED_ALWAYS_TRUE
  @response_expected[FUNCTION_SET_TOUCH_STATE_CALLBACK_CONFIGURATION] = RESPONSE_EXPECTED_TRUE
  @response_expected[FUNCTION_GET_TOUCH_STATE_CALLBACK_CONFIGURATION] = RESPONSE_EXPECTED_ALWAYS_TRUE
  @response_expected[FUNCTION_RECALIBRATE] = RESPONSE_EXPECTED_FALSE
  @response_expected[FUNCTION_SET_ELECTRODE_CONFIG] = RESPONSE_EXPECTED_FALSE
  @response_expected[FUNCTION_GET_ELECTRODE_CONFIG] = RESPONSE_EXPECTED_ALWAYS_TRUE
  @response_expected[FUNCTION_SET_ELECTRODE_SENSITIVITY] = RESPONSE_EXPECTED_FALSE
  @response_expected[FUNCTION_GET_ELECTRODE_SENSITIVITY] = RESPONSE_EXPECTED_ALWAYS_TRUE
  @response_expected[FUNCTION_SET_TOUCH_LED_CONFIG] = RESPONSE_EXPECTED_FALSE
  @response_expected[FUNCTION_GET_TOUCH_LED_CONFIG] = RESPONSE_EXPECTED_ALWAYS_TRUE
  @response_expected[FUNCTION_GET_SPITFP_ERROR_COUNT] = RESPONSE_EXPECTED_ALWAYS_TRUE
  @response_expected[FUNCTION_SET_BOOTLOADER_MODE] = RESPONSE_EXPECTED_ALWAYS_TRUE
  @response_expected[FUNCTION_GET_BOOTLOADER_MODE] = RESPONSE_EXPECTED_ALWAYS_TRUE
  @response_expected[FUNCTION_SET_WRITE_FIRMWARE_POINTER] = RESPONSE_EXPECTED_FALSE
  @response_expected[FUNCTION_WRITE_FIRMWARE] = RESPONSE_EXPECTED_ALWAYS_TRUE
  @response_expected[FUNCTION_SET_STATUS_LED_CONFIG] = RESPONSE_EXPECTED_FALSE
  @response_expected[FUNCTION_GET_STATUS_LED_CONFIG] = RESPONSE_EXPECTED_ALWAYS_TRUE
  @response_expected[FUNCTION_GET_CHIP_TEMPERATURE] = RESPONSE_EXPECTED_ALWAYS_TRUE
  @response_expected[FUNCTION_RESET] = RESPONSE_EXPECTED_FALSE
  @response_expected[FUNCTION_WRITE_UID] = RESPONSE_EXPECTED_FALSE
  @response_expected[FUNCTION_READ_UID] = RESPONSE_EXPECTED_ALWAYS_TRUE
  @response_expected[FUNCTION_GET_IDENTITY] = RESPONSE_EXPECTED_ALWAYS_TRUE

  @callback_formats[CALLBACK_TOUCH_STATE] = [10, '?13']

  @ipcon.add_device self
end

Instance Method Details

#get_bootloader_mode ⇒ Object

Returns the current bootloader mode, see BrickletMultiTouchV2#set_bootloader_mode.



256
257
258
259
260
 
# File 'lib/tinkerforge/bricklet_multi_touch_v2.rb', line 256

def get_bootloader_mode
  check_validity

  send_request FUNCTION_GET_BOOTLOADER_MODE, [], '', 9, 'C'
end

#get_chip_temperature ⇒ Object

Returns the temperature as measured inside the microcontroller. The value returned is not the ambient temperature!

The temperature is only proportional to the real temperature and it has bad accuracy. Practically it is only useful as an indicator for temperature changes.



314
315
316
317
318
 
# File 'lib/tinkerforge/bricklet_multi_touch_v2.rb', line 314

def get_chip_temperature
  check_validity

  send_request FUNCTION_GET_CHIP_TEMPERATURE, [], '', 10, 's'
end

#get_electrode_config ⇒ Object

Returns the electrode configuration, as set by BrickletMultiTouchV2#set_electrode_config.



180
181
182
183
184
 
# File 'lib/tinkerforge/bricklet_multi_touch_v2.rb', line 180

def get_electrode_config
  check_validity

  send_request FUNCTION_GET_ELECTRODE_CONFIG, [], '', 10, '?13'
end

#get_electrode_sensitivity ⇒ Object

Returns the current sensitivity, as set by BrickletMultiTouchV2#set_electrode_sensitivity.



202
203
204
205
206
 
# File 'lib/tinkerforge/bricklet_multi_touch_v2.rb', line 202

def get_electrode_sensitivity
  check_validity

  send_request FUNCTION_GET_ELECTRODE_SENSITIVITY, [], '', 9, 'C'
end

#get_identity ⇒ Object

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 :ref:‘Isolator Bricklet <isolator_bricklet>` is always at position ’z’.

The device identifier numbers can be found :ref:‘here <device_identifier>`. |device_identifier_constant|



361
362
363
 
# File 'lib/tinkerforge/bricklet_multi_touch_v2.rb', line 361

def get_identity
  send_request FUNCTION_GET_IDENTITY, [], '', 33, 'Z8 Z8 k C3 C3 S'
end

#get_spitfp_error_count ⇒ Object

Returns the error count for the communication between Brick and Bricklet.

The errors are divided into

  • ACK checksum errors,

  • message checksum errors,

  • framing errors and

  • overflow errors.

The errors counts are for errors that occur on the Bricklet side. All Bricks have a similar function that returns the errors on the Brick side.



234
235
236
237
238
 
# File 'lib/tinkerforge/bricklet_multi_touch_v2.rb', line 234

def get_spitfp_error_count
  check_validity

  send_request FUNCTION_GET_SPITFP_ERROR_COUNT, [], '', 24, 'L L L L'
end

#get_status_led_config ⇒ Object

Returns the configuration as set by BrickletMultiTouchV2#set_status_led_config



302
303
304
305
306
 
# File 'lib/tinkerforge/bricklet_multi_touch_v2.rb', line 302

def get_status_led_config
  check_validity

  send_request FUNCTION_GET_STATUS_LED_CONFIG, [], '', 9, 'C'
end

#get_touch_led_config ⇒ Object

Returns the LED configuration as set by BrickletMultiTouchV2#set_touch_led_config



217
218
219
220
221
 
# File 'lib/tinkerforge/bricklet_multi_touch_v2.rb', line 217

def get_touch_led_config
  check_validity

  send_request FUNCTION_GET_TOUCH_LED_CONFIG, [], '', 9, 'C'
end

#get_touch_state ⇒ Object

Returns the current touch state. The state is given as a array of bools.

Element 0 to 11 represent the 12 electrodes and element 12 represents the proximity.

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

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.

If you want to get the value periodically, it is recommended to use the CALLBACK_TOUCH_STATE callback. You can set the callback configuration with BrickletMultiTouchV2#set_touch_state_callback_configuration.



124
125
126
127
128
 
# File 'lib/tinkerforge/bricklet_multi_touch_v2.rb', line 124

def get_touch_state
  check_validity

  send_request FUNCTION_GET_TOUCH_STATE, [], '', 10, '?13'
end

#get_touch_state_callback_configuration ⇒ Object

Returns the callback configuration as set by BrickletMultiTouchV2#set_touch_state_callback_configuration.



147
148
149
150
151
 
# File 'lib/tinkerforge/bricklet_multi_touch_v2.rb', line 147

def get_touch_state_callback_configuration
  check_validity

  send_request FUNCTION_GET_TOUCH_STATE_CALLBACK_CONFIGURATION, [], '', 13, 'L ?'
end

#read_uid ⇒ Object

Returns the current UID as an integer. Encode as Base58 to get the usual string version.



345
346
347
348
349
 
# File 'lib/tinkerforge/bricklet_multi_touch_v2.rb', line 345

def read_uid
  check_validity

  send_request FUNCTION_READ_UID, [], '', 12, 'L'
end

#recalibrate ⇒ Object

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



155
156
157
158
159
 
# File 'lib/tinkerforge/bricklet_multi_touch_v2.rb', line 155

def recalibrate
  check_validity

  send_request FUNCTION_RECALIBRATE, [], '', 8, ''
end

#register_callback(id, &block) ⇒ Object

Registers a callback with ID id to the block block.



366
367
368
369
 
# File 'lib/tinkerforge/bricklet_multi_touch_v2.rb', line 366

def register_callback(id, &block)
  callback = block
  @registered_callbacks[id] = callback
end

#reset ⇒ Object

Calling this function will reset the Bricklet. All configurations will be lost.

After a reset you have to create new device objects, calling functions on the existing ones will result in undefined behavior!



326
327
328
329
330
 
# File 'lib/tinkerforge/bricklet_multi_touch_v2.rb', line 326

def reset
  check_validity

  send_request FUNCTION_RESET, [], '', 8, ''
end

#set_bootloader_mode(mode) ⇒ Object

Sets the bootloader mode and returns the status after the requested mode change was instigated.

You can change from bootloader mode to firmware mode and vice versa. A change from bootloader mode to firmware mode will only take place if the entry function, device identifier and CRC are present and correct.

This function is used by Brick Viewer during flashing. It should not be necessary to call it in a normal user program.



249
250
251
252
253
 
# File 'lib/tinkerforge/bricklet_multi_touch_v2.rb', line 249

def set_bootloader_mode(mode)
  check_validity

  send_request FUNCTION_SET_BOOTLOADER_MODE, [mode], 'C', 9, 'C'
end

#set_electrode_config(enabled_electrodes) ⇒ Object

Enables/disables electrodes with a bool array (see BrickletMultiTouchV2#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 electrode (element 12) if the proximity feature is not needed. This will reduce the amount of traffic that is produced by the CALLBACK_TOUCH_STATE callback.

Disabling electrodes will also reduce power consumption.



173
174
175
176
177
 
# File 'lib/tinkerforge/bricklet_multi_touch_v2.rb', line 173

def set_electrode_config(enabled_electrodes)
  check_validity

  send_request FUNCTION_SET_ELECTRODE_CONFIG, [enabled_electrodes], '?13', 8, ''
end

#set_electrode_sensitivity(sensitivity) ⇒ Object

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 BrickletMultiTouchV2#recalibrate to calibrate the electrodes with the newly defined sensitivity.



195
196
197
198
199
 
# File 'lib/tinkerforge/bricklet_multi_touch_v2.rb', line 195

def set_electrode_sensitivity(sensitivity)
  check_validity

  send_request FUNCTION_SET_ELECTRODE_SENSITIVITY, [sensitivity], 'C', 8, ''
end

#set_status_led_config(config) ⇒ Object

Sets the status LED configuration. By default the LED shows communication traffic between Brick and Bricklet, it flickers once for every 10 received data packets.

You can also turn the LED permanently on/off or show a heartbeat.

If the Bricklet is in bootloader mode, the LED is will show heartbeat by default.



295
296
297
298
299
 
# File 'lib/tinkerforge/bricklet_multi_touch_v2.rb', line 295

def set_status_led_config(config)
  check_validity

  send_request FUNCTION_SET_STATUS_LED_CONFIG, [config], 'C', 8, ''
end

#set_touch_led_config(config) ⇒ Object

Configures the touch LED to be either turned off, turned on, blink in heartbeat mode or show the touch state (electrode touched = LED on).



210
211
212
213
214
 
# File 'lib/tinkerforge/bricklet_multi_touch_v2.rb', line 210

def set_touch_led_config(config)
  check_validity

  send_request FUNCTION_SET_TOUCH_LED_CONFIG, [config], 'C', 8, ''
end

#set_touch_state_callback_configuration(period, value_has_to_change) ⇒ Object

The period is the period with which the CALLBACK_TOUCH_STATE callback is triggered periodically. A value of 0 turns the callback off.

If the ‘value has to change`-parameter is set to true, the callback is only triggered after the value has changed. If the value didn’t change within the period, the callback is triggered immediately on change.

If it is set to false, the callback is continuously triggered with the period, independent of the value.



139
140
141
142
143
 
# File 'lib/tinkerforge/bricklet_multi_touch_v2.rb', line 139

def set_touch_state_callback_configuration(period, value_has_to_change)
  check_validity

  send_request FUNCTION_SET_TOUCH_STATE_CALLBACK_CONFIGURATION, [period, value_has_to_change], 'L ?', 8, ''
end

#set_write_firmware_pointer(pointer) ⇒ Object

Sets the firmware pointer for BrickletMultiTouchV2#write_firmware. The pointer has to be increased by chunks of size 64. The data is written to flash every 4 chunks (which equals to one page of size 256).

This function is used by Brick Viewer during flashing. It should not be necessary to call it in a normal user program.



268
269
270
271
272
 
# File 'lib/tinkerforge/bricklet_multi_touch_v2.rb', line 268

def set_write_firmware_pointer(pointer)
  check_validity

  send_request FUNCTION_SET_WRITE_FIRMWARE_POINTER, [pointer], 'L', 8, ''
end

#write_firmware(data) ⇒ Object

Writes 64 Bytes of firmware at the position as written by BrickletMultiTouchV2#set_write_firmware_pointer before. The firmware is written to flash every 4 chunks.

You can only write firmware in bootloader mode.

This function is used by Brick Viewer during flashing. It should not be necessary to call it in a normal user program.



282
283
284
285
286
 
# File 'lib/tinkerforge/bricklet_multi_touch_v2.rb', line 282

def write_firmware(data)
  check_validity

  send_request FUNCTION_WRITE_FIRMWARE, [data], 'C64', 9, 'C'
end

#write_uid(uid) ⇒ Object

Writes a new UID into flash. If you want to set a new UID you have to decode the Base58 encoded UID string into an integer first.

We recommend that you use Brick Viewer to change the UID.



337
338
339
340
341
 
# File 'lib/tinkerforge/bricklet_multi_touch_v2.rb', line 337

def write_uid(uid)
  check_validity

  send_request FUNCTION_WRITE_UID, [uid], 'L', 8, ''
end