Class: Tinkerforge::BrickletJoystickV2

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

Overview

2-axis joystick with push-button

Constant Summary collapse

DEVICE_IDENTIFIER =

:nodoc:

2138
DEVICE_DISPLAY_NAME =

:nodoc:

'Joystick Bricklet 2.0'
CALLBACK_POSITION =

This callback is triggered periodically according to the configuration set by BrickletJoystickV2#set_position_callback_configuration.

The parameters are the same as with BrickletJoystickV2#get_position.

6
CALLBACK_PRESSED =

This callback is triggered periodically according to the configuration set by BrickletJoystickV2#set_pressed_callback_configuration.

The parameters are the same as with BrickletJoystickV2#is_pressed.

9
FUNCTION_GET_POSITION =

:nodoc:

1
FUNCTION_IS_PRESSED =

:nodoc:

2
FUNCTION_CALIBRATE =

:nodoc:

3
FUNCTION_SET_POSITION_CALLBACK_CONFIGURATION =

:nodoc:

4
FUNCTION_GET_POSITION_CALLBACK_CONFIGURATION =

:nodoc:

5
FUNCTION_SET_PRESSED_CALLBACK_CONFIGURATION =

:nodoc:

7
FUNCTION_GET_PRESSED_CALLBACK_CONFIGURATION =

:nodoc:

8
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
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) ⇒ BrickletJoystickV2

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



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

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

  @api_version = [2, 0, 0]

  @response_expected[FUNCTION_GET_POSITION] = RESPONSE_EXPECTED_ALWAYS_TRUE
  @response_expected[FUNCTION_IS_PRESSED] = RESPONSE_EXPECTED_ALWAYS_TRUE
  @response_expected[FUNCTION_CALIBRATE] = RESPONSE_EXPECTED_FALSE
  @response_expected[FUNCTION_SET_POSITION_CALLBACK_CONFIGURATION] = RESPONSE_EXPECTED_TRUE
  @response_expected[FUNCTION_GET_POSITION_CALLBACK_CONFIGURATION] = RESPONSE_EXPECTED_ALWAYS_TRUE
  @response_expected[FUNCTION_SET_PRESSED_CALLBACK_CONFIGURATION] = RESPONSE_EXPECTED_TRUE
  @response_expected[FUNCTION_GET_PRESSED_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_POSITION] = [12, 's s']
  @callback_formats[CALLBACK_PRESSED] = [9, '?']

  @ipcon.add_device self
end

Instance Method Details

#calibrate ⇒ Object

Calibrates the middle position of the joystick. If your Joystick Bricklet 2.0 does not return x=0 and y=0 in the middle position, call this function while the joystick is standing still in the middle position.

The resulting calibration will be saved in non-volatile memory, thus you only have to calibrate it once.



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

def calibrate
  check_validity

  send_request FUNCTION_CALIBRATE, [], '', 8, ''
end

#get_bootloader_mode ⇒ Object

Returns the current bootloader mode, see BrickletJoystickV2#set_bootloader_mode.



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

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.



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

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|



320
321
322
 
# File 'lib/tinkerforge/bricklet_joystick_v2.rb', line 320

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

#get_position ⇒ Object

Returns the position of the joystick. The middle position of the joystick is x=0, y=0. The returned values are averaged and calibrated (see BrickletJoystickV2#calibrate).

If you want to get the position periodically, it is recommended to use the CALLBACK_POSITION callback and set the period with BrickletJoystickV2#set_position_callback_configuration.



107
108
109
110
111
 
# File 'lib/tinkerforge/bricklet_joystick_v2.rb', line 107

def get_position
  check_validity

  send_request FUNCTION_GET_POSITION, [], '', 12, 's s'
end

#get_position_callback_configuration ⇒ Object

Returns the callback configuration as set by BrickletJoystickV2#set_position_callback_configuration.



153
154
155
156
157
 
# File 'lib/tinkerforge/bricklet_joystick_v2.rb', line 153

def get_position_callback_configuration
  check_validity

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

#get_pressed_callback_configuration ⇒ Object

Returns the callback configuration as set by BrickletJoystickV2#set_pressed_callback_configuration.



176
177
178
179
180
 
# File 'lib/tinkerforge/bricklet_joystick_v2.rb', line 176

def get_pressed_callback_configuration
  check_validity

  send_request FUNCTION_GET_PRESSED_CALLBACK_CONFIGURATION, [], '', 13, 'L ?'
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.



193
194
195
196
197
 
# File 'lib/tinkerforge/bricklet_joystick_v2.rb', line 193

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 BrickletJoystickV2#set_status_led_config



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

def get_status_led_config
  check_validity

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

#is_pressed ⇒ Object

Returns true if the button is pressed and false otherwise.

If you want to get the press-state periodically, it is recommended to use the CALLBACK_PRESSED callback and set the period with BrickletJoystickV2#set_pressed_callback_configuration.



118
119
120
121
122
 
# File 'lib/tinkerforge/bricklet_joystick_v2.rb', line 118

def is_pressed
  check_validity

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

#read_uid ⇒ Object

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



304
305
306
307
308
 
# File 'lib/tinkerforge/bricklet_joystick_v2.rb', line 304

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.



325
326
327
328
 
# File 'lib/tinkerforge/bricklet_joystick_v2.rb', line 325

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!



285
286
287
288
289
 
# File 'lib/tinkerforge/bricklet_joystick_v2.rb', line 285

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.



208
209
210
211
212
 
# File 'lib/tinkerforge/bricklet_joystick_v2.rb', line 208

def set_bootloader_mode(mode)
  check_validity

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

#set_position_callback_configuration(period, value_has_to_change) ⇒ Object

The period is the period with which the CALLBACK_POSITION 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 at least one of the values has changed. If the values 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.



145
146
147
148
149
 
# File 'lib/tinkerforge/bricklet_joystick_v2.rb', line 145

def set_position_callback_configuration(period, value_has_to_change)
  check_validity

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

#set_pressed_callback_configuration(period, value_has_to_change) ⇒ Object

The period is the period with which the CALLBACK_PRESSED 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 at least one of the values has changed. If the values 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.



168
169
170
171
172
 
# File 'lib/tinkerforge/bricklet_joystick_v2.rb', line 168

def set_pressed_callback_configuration(period, value_has_to_change)
  check_validity

  send_request FUNCTION_SET_PRESSED_CALLBACK_CONFIGURATION, [period, value_has_to_change], 'L ?', 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.



254
255
256
257
258
 
# File 'lib/tinkerforge/bricklet_joystick_v2.rb', line 254

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



227
228
229
230
231
 
# File 'lib/tinkerforge/bricklet_joystick_v2.rb', line 227

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



241
242
243
244
245
 
# File 'lib/tinkerforge/bricklet_joystick_v2.rb', line 241

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.



296
297
298
299
300
 
# File 'lib/tinkerforge/bricklet_joystick_v2.rb', line 296

def write_uid(uid)
  check_validity

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