class Tinkerforge::BrickletDualButtonV2
Two tactile buttons with built-in blue LEDs
Constants
- 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
.-
Public Class Methods
Creates an object with the unique device ID uid
and adds it to the IP Connection ipcon
.
# File lib/tinkerforge/bricklet_dual_button_v2.rb, line 81 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
Public Instance Methods
Returns the current bootloader mode, see BrickletDualButtonV2#set_bootloader_mode
.
# File lib/tinkerforge/bricklet_dual_button_v2.rb, line 202 def get_bootloader_mode check_validity send_request FUNCTION_GET_BOOTLOADER_MODE, [], '', 9, 'C' end
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.
# File lib/tinkerforge/bricklet_dual_button_v2.rb, line 260 def get_chip_temperature check_validity send_request FUNCTION_GET_CHIP_TEMPERATURE, [], '', 10, 's' end
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|
# File lib/tinkerforge/bricklet_dual_button_v2.rb, line 307 def get_identity send_request FUNCTION_GET_IDENTITY, [], '', 33, 'Z8 Z8 k C3 C3 S' end
Returns the current state of the LEDs, as set by BrickletDualButtonV2#set_led_state
.
# File lib/tinkerforge/bricklet_dual_button_v2.rb, line 129 def get_led_state check_validity send_request FUNCTION_GET_LED_STATE, [], '', 10, 'C C' end
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.
# File lib/tinkerforge/bricklet_dual_button_v2.rb, line 180 def get_spitfp_error_count check_validity send_request FUNCTION_GET_SPITFP_ERROR_COUNT, [], '', 24, 'L L L L' end
Returns the configuration as set by BrickletDualButtonV2#set_state_changed_callback_configuration
.
# File lib/tinkerforge/bricklet_dual_button_v2.rb, line 163 def get_state_changed_callback_configuration check_validity send_request FUNCTION_GET_STATE_CHANGED_CALLBACK_CONFIGURATION, [], '', 9, '?' end
Returns the configuration as set by BrickletDualButtonV2#set_status_led_config
# File lib/tinkerforge/bricklet_dual_button_v2.rb, line 248 def get_status_led_config check_validity send_request FUNCTION_GET_STATUS_LED_CONFIG, [], '', 9, 'C' end
Returns the current UID as an integer. Encode as Base58
to get the usual string version.
# File lib/tinkerforge/bricklet_dual_button_v2.rb, line 291 def read_uid check_validity send_request FUNCTION_READ_UID, [], '', 12, 'L' end
Registers a callback with ID id
to the block block
.
# File lib/tinkerforge/bricklet_dual_button_v2.rb, line 312 def register_callback(id, &block) callback = block @registered_callbacks[id] = callback end
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!
# File lib/tinkerforge/bricklet_dual_button_v2.rb, line 272 def reset check_validity send_request FUNCTION_RESET, [], '', 8, '' end
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.
# File lib/tinkerforge/bricklet_dual_button_v2.rb, line 195 def set_bootloader_mode(mode) check_validity send_request FUNCTION_SET_BOOTLOADER_MODE, [mode], 'C', 9, 'C' end
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
.
# File lib/tinkerforge/bricklet_dual_button_v2.rb, line 122 def set_led_state(led_l, led_r) check_validity send_request FUNCTION_SET_LED_STATE, [led_l, led_r], 'C C', 8, '' end
Sets the state of the selected LED.
The other LED remains untouched.
# File lib/tinkerforge/bricklet_dual_button_v2.rb, line 148 def set_selected_led_state(led, state) check_validity send_request FUNCTION_SET_SELECTED_LED_STATE, [led, state], 'C C', 8, '' end
If you enable this callback, the CALLBACK_STATE_CHANGED
callback is triggered every time a button is pressed/released
# File lib/tinkerforge/bricklet_dual_button_v2.rb, line 156 def set_state_changed_callback_configuration(enabled) check_validity send_request FUNCTION_SET_STATE_CHANGED_CALLBACK_CONFIGURATION, [enabled], '?', 8, '' end
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.
# File lib/tinkerforge/bricklet_dual_button_v2.rb, line 241 def set_status_led_config(config) check_validity send_request FUNCTION_SET_STATUS_LED_CONFIG, [config], 'C', 8, '' end
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.
# File lib/tinkerforge/bricklet_dual_button_v2.rb, line 214 def set_write_firmware_pointer(pointer) check_validity send_request FUNCTION_SET_WRITE_FIRMWARE_POINTER, [pointer], 'L', 8, '' end
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.
# File lib/tinkerforge/bricklet_dual_button_v2.rb, line 228 def write_firmware(data) check_validity send_request FUNCTION_WRITE_FIRMWARE, [data], 'C64', 9, 'C' end
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.
# File lib/tinkerforge/bricklet_dual_button_v2.rb, line 283 def write_uid(uid) check_validity send_request FUNCTION_WRITE_UID, [uid], 'L', 8, '' end