Class: Tinkerforge::BrickletRotaryEncoderV2

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

Overview

360° rotary encoder with push-button

Constant Summary collapse

DEVICE_IDENTIFIER =

:nodoc:

294
DEVICE_DISPLAY_NAME =

:nodoc:

'Rotary Encoder Bricklet 2.0'
CALLBACK_COUNT =

This callback is triggered periodically according to the configuration set by BrickletRotaryEncoderV2#set_count_callback_configuration.

The parameter is the same as BrickletRotaryEncoderV2#get_count.

4
CALLBACK_PRESSED =

This callback is triggered when the button is pressed.

6
CALLBACK_RELEASED =

This callback is triggered when the button is released.

7
FUNCTION_GET_COUNT =

:nodoc:

1
FUNCTION_SET_COUNT_CALLBACK_CONFIGURATION =

:nodoc:

2
FUNCTION_GET_COUNT_CALLBACK_CONFIGURATION =

:nodoc:

3
FUNCTION_IS_PRESSED =

:nodoc:

5
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
THRESHOLD_OPTION_OFF =

:nodoc:

'x'
THRESHOLD_OPTION_OUTSIDE =

:nodoc:

'o'
THRESHOLD_OPTION_INSIDE =

:nodoc:

'i'
THRESHOLD_OPTION_SMALLER =

:nodoc:

'<'
THRESHOLD_OPTION_GREATER =

:nodoc:

'>'
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) ⇒ BrickletRotaryEncoderV2

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

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

  @api_version = [2, 0, 1]

  @response_expected[FUNCTION_GET_COUNT] = RESPONSE_EXPECTED_ALWAYS_TRUE
  @response_expected[FUNCTION_SET_COUNT_CALLBACK_CONFIGURATION] = RESPONSE_EXPECTED_TRUE
  @response_expected[FUNCTION_GET_COUNT_CALLBACK_CONFIGURATION] = RESPONSE_EXPECTED_ALWAYS_TRUE
  @response_expected[FUNCTION_IS_PRESSED] = 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_COUNT] = [12, 'l']
  @callback_formats[CALLBACK_PRESSED] = [8, '']
  @callback_formats[CALLBACK_RELEASED] = [8, '']

  @ipcon.add_device self
end

Instance Method Details

#get_bootloader_mode ⇒ Object

Returns the current bootloader mode, see BrickletRotaryEncoderV2#set_bootloader_mode.



201
202
203
204
205
 
# File 'lib/tinkerforge/bricklet_rotary_encoder_v2.rb', line 201

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.



259
260
261
262
263
 
# File 'lib/tinkerforge/bricklet_rotary_encoder_v2.rb', line 259

def get_chip_temperature
  check_validity

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

#get_count(reset) ⇒ Object

Returns the current count of the encoder. If you set reset to true, the count is set back to 0 directly after the current count is read.

The encoder has 24 steps per rotation.

Turning the encoder to the left decrements the counter, so a negative count is possible.

If you want to get the value periodically, it is recommended to use the CALLBACK_COUNT callback. You can set the callback configuration with BrickletRotaryEncoderV2#set_count_callback_configuration.



114
115
116
117
118
 
# File 'lib/tinkerforge/bricklet_rotary_encoder_v2.rb', line 114

def get_count(reset)
  check_validity

  send_request FUNCTION_GET_COUNT, [reset], '?', 12, 'l'
end

#get_count_callback_configuration ⇒ Object

Returns the callback configuration as set by BrickletRotaryEncoderV2#set_count_callback_configuration.



152
153
154
155
156
 
# File 'lib/tinkerforge/bricklet_rotary_encoder_v2.rb', line 152

def get_count_callback_configuration
  check_validity

  send_request FUNCTION_GET_COUNT_CALLBACK_CONFIGURATION, [], '', 22, 'L ? k l l'
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|



306
307
308
 
# File 'lib/tinkerforge/bricklet_rotary_encoder_v2.rb', line 306

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.



179
180
181
182
183
 
# File 'lib/tinkerforge/bricklet_rotary_encoder_v2.rb', line 179

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



247
248
249
250
251
 
# File 'lib/tinkerforge/bricklet_rotary_encoder_v2.rb', line 247

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.

It is recommended to use the CALLBACK_PRESSED and CALLBACK_RELEASED callbacks to handle the button.



162
163
164
165
166
 
# File 'lib/tinkerforge/bricklet_rotary_encoder_v2.rb', line 162

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.



290
291
292
293
294
 
# File 'lib/tinkerforge/bricklet_rotary_encoder_v2.rb', line 290

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.



311
312
313
314
 
# File 'lib/tinkerforge/bricklet_rotary_encoder_v2.rb', line 311

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!



271
272
273
274
275
 
# File 'lib/tinkerforge/bricklet_rotary_encoder_v2.rb', line 271

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.



194
195
196
197
198
 
# File 'lib/tinkerforge/bricklet_rotary_encoder_v2.rb', line 194

def set_bootloader_mode(mode)
  check_validity

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

#set_count_callback_configuration(period, value_has_to_change, option, min, max) ⇒ Object

The period is the period with which the CALLBACK_COUNT 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.

It is furthermore possible to constrain the callback with thresholds.

The ‘option`-parameter together with min/max sets a threshold for the CALLBACK_COUNT callback.

The following options are possible:

"Option", "Description"

"'x'",    "Threshold is turned off"
"'o'",    "Threshold is triggered when the value is *outside* the min and max values"
"'i'",    "Threshold is triggered when the value is *inside* or equal to the min and max values"
"'<'",    "Threshold is triggered when the value is smaller than the min value (max is ignored)"
"'>'",    "Threshold is triggered when the value is greater than the min value (max is ignored)"

If the option is set to ‘x’ (threshold turned off) the callback is triggered with the fixed period.



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

def set_count_callback_configuration(period, value_has_to_change, option, min, max)
  check_validity

  send_request FUNCTION_SET_COUNT_CALLBACK_CONFIGURATION, [period, value_has_to_change, option, min, max], 'L ? k l 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.



240
241
242
243
244
 
# File 'lib/tinkerforge/bricklet_rotary_encoder_v2.rb', line 240

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



213
214
215
216
217
 
# File 'lib/tinkerforge/bricklet_rotary_encoder_v2.rb', line 213

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



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

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.



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

def write_uid(uid)
  check_validity

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