Class: Tinkerforge::BrickletDualButtonV2

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

Overview

Two tactile buttons with built-in blue LEDs

Constant Summary collapse

DEVICE_IDENTIFIER =

:nodoc:

2119
DEVICE_DISPLAY_NAME =

:nodoc:

'Dual Button Bricklet 2.0'
CALLBACK_STATE_CHANGED =

This callback is called whenever a button is pressed.

Possible states for buttons are:

  • 0 = pressed

  • 1 = released

Possible states for LEDs are:

  • 0 = AutoToggleOn: Auto toggle enabled and LED on.

  • 1 = AutoToggleOff: Auto toggle enabled and LED off.

  • 2 = On: LED on (auto toggle is disabled).

  • 3 = Off: LED off (auto toggle is disabled).

This callback can be enabled with BrickletDualButtonV2#set_state_changed_callback_configuration.

4
FUNCTION_SET_LED_STATE =

:nodoc:

1
FUNCTION_GET_LED_STATE =

:nodoc:

2
FUNCTION_GET_BUTTON_STATE =

:nodoc:

3
FUNCTION_SET_SELECTED_LED_STATE =

:nodoc:

5
FUNCTION_SET_STATE_CHANGED_CALLBACK_CONFIGURATION =

:nodoc:

6
FUNCTION_GET_STATE_CHANGED_CALLBACK_CONFIGURATION =

:nodoc:

7
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
LED_STATE_AUTO_TOGGLE_ON =

:nodoc:

0
LED_STATE_AUTO_TOGGLE_OFF =

:nodoc:

1
LED_STATE_ON =

:nodoc:

2
LED_STATE_OFF =

:nodoc:

3
BUTTON_STATE_PRESSED =

:nodoc:

0
BUTTON_STATE_RELEASED =

:nodoc:

1
LED_LEFT =

:nodoc:

0
LED_RIGHT =

:nodoc:

1
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) ⇒ BrickletDualButtonV2

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



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

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

  @api_version = [2, 0, 0]

  @response_expected[FUNCTION_SET_LED_STATE] = RESPONSE_EXPECTED_FALSE
  @response_expected[FUNCTION_GET_LED_STATE] = RESPONSE_EXPECTED_ALWAYS_TRUE
  @response_expected[FUNCTION_GET_BUTTON_STATE] = RESPONSE_EXPECTED_ALWAYS_TRUE
  @response_expected[FUNCTION_SET_SELECTED_LED_STATE] = RESPONSE_EXPECTED_FALSE
  @response_expected[FUNCTION_SET_STATE_CHANGED_CALLBACK_CONFIGURATION] = RESPONSE_EXPECTED_TRUE
  @response_expected[FUNCTION_GET_STATE_CHANGED_CALLBACK_CONFIGURATION] = 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_STATE_CHANGED] = [12, 'C C C C']

  @ipcon.add_device self
end

Instance Method Details

#get_bootloader_mode ⇒ Object

Returns the current bootloader mode, see BrickletDualButtonV2#set_bootloader_mode.



203
204
205
206
207
 
# File 'lib/tinkerforge/bricklet_dual_button_v2.rb', line 203

def get_bootloader_mode
  check_validity

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

#get_button_state ⇒ Object

Returns the current state for both buttons. Possible states are:

  • 0 = pressed

  • 1 = released



140
141
142
143
144
 
# File 'lib/tinkerforge/bricklet_dual_button_v2.rb', line 140

def get_button_state
  check_validity

  send_request FUNCTION_GET_BUTTON_STATE, [], '', 10, 'C 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.



261
262
263
264
265
 
# File 'lib/tinkerforge/bricklet_dual_button_v2.rb', line 261

def get_chip_temperature
  check_validity

  send_request FUNCTION_GET_CHIP_TEMPERATURE, [], '', 10, 's'
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|



308
309
310
 
# File 'lib/tinkerforge/bricklet_dual_button_v2.rb', line 308

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

#get_led_state ⇒ Object

Returns the current state of the LEDs, as set by BrickletDualButtonV2#set_led_state.



130
131
132
133
134
 
# File 'lib/tinkerforge/bricklet_dual_button_v2.rb', line 130

def get_led_state
  check_validity

  send_request FUNCTION_GET_LED_STATE, [], '', 10, 'C C'
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.



181
182
183
184
185
 
# File 'lib/tinkerforge/bricklet_dual_button_v2.rb', line 181

def get_spitfp_error_count
  check_validity

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

#get_state_changed_callback_configuration ⇒ Object

Returns the configuration as set by BrickletDualButtonV2#set_state_changed_callback_configuration.



164
165
166
167
168
 
# File 'lib/tinkerforge/bricklet_dual_button_v2.rb', line 164

def get_state_changed_callback_configuration
  check_validity

  send_request FUNCTION_GET_STATE_CHANGED_CALLBACK_CONFIGURATION, [], '', 9, '?'
end

#get_status_led_config ⇒ Object

Returns the configuration as set by BrickletDualButtonV2#set_status_led_config



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

def get_status_led_config
  check_validity

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

#read_uid ⇒ Object

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



292
293
294
295
296
 
# File 'lib/tinkerforge/bricklet_dual_button_v2.rb', line 292

def read_uid
  check_validity

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

#register_callback(id, &block) ⇒ Object

Registers a callback with ID id to the block block.



313
314
315
316
 
# File 'lib/tinkerforge/bricklet_dual_button_v2.rb', line 313

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!



273
274
275
276
277
 
# File 'lib/tinkerforge/bricklet_dual_button_v2.rb', line 273

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.



196
197
198
199
200
 
# File 'lib/tinkerforge/bricklet_dual_button_v2.rb', line 196

def set_bootloader_mode(mode)
  check_validity

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

#set_led_state(led_l, led_r) ⇒ Object

Sets the state of the LEDs. Possible states are:

  • 0 = AutoToggleOn: Enables auto toggle with initially enabled LED.

  • 1 = AutoToggleOff: Activates auto toggle with initially disabled LED.

  • 2 = On: Enables LED (auto toggle is disabled).

  • 3 = Off: Disables LED (auto toggle is disabled).

In auto toggle mode the LED is toggled automatically at each press of a button.

If you just want to set one of the LEDs and don’t know the current state of the other LED, you can get the state with BrickletDualButtonV2#get_led_state or you can use BrickletDualButtonV2#set_selected_led_state.



123
124
125
126
127
 
# File 'lib/tinkerforge/bricklet_dual_button_v2.rb', line 123

def set_led_state(led_l, led_r)
  check_validity

  send_request FUNCTION_SET_LED_STATE, [led_l, led_r], 'C C', 8, ''
end

#set_selected_led_state(led, state) ⇒ Object

Sets the state of the selected LED.

The other LED remains untouched.



149
150
151
152
153
 
# File 'lib/tinkerforge/bricklet_dual_button_v2.rb', line 149

def set_selected_led_state(led, state)
  check_validity

  send_request FUNCTION_SET_SELECTED_LED_STATE, [led, state], 'C C', 8, ''
end

#set_state_changed_callback_configuration(enabled) ⇒ Object

If you enable this callback, the CALLBACK_STATE_CHANGED callback is triggered every time a button is pressed/released



157
158
159
160
161
 
# File 'lib/tinkerforge/bricklet_dual_button_v2.rb', line 157

def set_state_changed_callback_configuration(enabled)
  check_validity

  send_request FUNCTION_SET_STATE_CHANGED_CALLBACK_CONFIGURATION, [enabled], '?', 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.



242
243
244
245
246
 
# File 'lib/tinkerforge/bricklet_dual_button_v2.rb', line 242

def set_status_led_config(config)
  check_validity

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

#set_write_firmware_pointer(pointer) ⇒ Object

Sets the firmware pointer for BrickletDualButtonV2#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.



215
216
217
218
219
 
# File 'lib/tinkerforge/bricklet_dual_button_v2.rb', line 215

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



229
230
231
232
233
 
# File 'lib/tinkerforge/bricklet_dual_button_v2.rb', line 229

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.



284
285
286
287
288
 
# File 'lib/tinkerforge/bricklet_dual_button_v2.rb', line 284

def write_uid(uid)
  check_validity

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