Class: Tinkerforge::BrickletRotaryEncoder

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

Overview

360° rotary encoder with push-button

Constant Summary collapse

DEVICE_IDENTIFIER =

:nodoc:

236
DEVICE_DISPLAY_NAME =

:nodoc:

'Rotary Encoder Bricklet'
CALLBACK_COUNT =

This callback is triggered periodically with the period that is set by BrickletRotaryEncoder#set_count_callback_period. The parameter is the count of the encoder.

The CALLBACK_COUNT callback is only triggered if the count has changed since the last triggering.

8
CALLBACK_COUNT_REACHED =

This callback is triggered when the threshold as set by BrickletRotaryEncoder#set_count_callback_threshold is reached. The parameter is the count of the encoder.

If the threshold keeps being reached, the callback is triggered periodically with the period as set by BrickletRotaryEncoder#set_debounce_period.

9
CALLBACK_PRESSED =

This callback is triggered when the button is pressed.

11
CALLBACK_RELEASED =

This callback is triggered when the button is released.

12
FUNCTION_GET_COUNT =

:nodoc:

1
FUNCTION_SET_COUNT_CALLBACK_PERIOD =

:nodoc:

2
FUNCTION_GET_COUNT_CALLBACK_PERIOD =

:nodoc:

3
FUNCTION_SET_COUNT_CALLBACK_THRESHOLD =

:nodoc:

4
FUNCTION_GET_COUNT_CALLBACK_THRESHOLD =

:nodoc:

5
FUNCTION_SET_DEBOUNCE_PERIOD =

:nodoc:

6
FUNCTION_GET_DEBOUNCE_PERIOD =

:nodoc:

7
FUNCTION_IS_PRESSED =

:nodoc:

10
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:

'>'

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) ⇒ BrickletRotaryEncoder

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



60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
 
# File 'lib/tinkerforge/bricklet_rotary_encoder.rb', line 60

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

  @api_version = [2, 0, 0]

  @response_expected[FUNCTION_GET_COUNT] = RESPONSE_EXPECTED_ALWAYS_TRUE
  @response_expected[FUNCTION_SET_COUNT_CALLBACK_PERIOD] = RESPONSE_EXPECTED_TRUE
  @response_expected[FUNCTION_GET_COUNT_CALLBACK_PERIOD] = RESPONSE_EXPECTED_ALWAYS_TRUE
  @response_expected[FUNCTION_SET_COUNT_CALLBACK_THRESHOLD] = RESPONSE_EXPECTED_TRUE
  @response_expected[FUNCTION_GET_COUNT_CALLBACK_THRESHOLD] = RESPONSE_EXPECTED_ALWAYS_TRUE
  @response_expected[FUNCTION_SET_DEBOUNCE_PERIOD] = RESPONSE_EXPECTED_TRUE
  @response_expected[FUNCTION_GET_DEBOUNCE_PERIOD] = RESPONSE_EXPECTED_ALWAYS_TRUE
  @response_expected[FUNCTION_IS_PRESSED] = RESPONSE_EXPECTED_ALWAYS_TRUE
  @response_expected[FUNCTION_GET_IDENTITY] = RESPONSE_EXPECTED_ALWAYS_TRUE

  @callback_formats[CALLBACK_COUNT] = [12, 'l']
  @callback_formats[CALLBACK_COUNT_REACHED] = [12, 'l']
  @callback_formats[CALLBACK_PRESSED] = [8, '']
  @callback_formats[CALLBACK_RELEASED] = [8, '']

  @ipcon.add_device self
end

Instance Method Details

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



91
92
93
94
95
 
# File 'lib/tinkerforge/bricklet_rotary_encoder.rb', line 91

def get_count(reset)
  check_validity

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

#get_count_callback_period ⇒ Object

Returns the period as set by BrickletRotaryEncoder#set_count_callback_period.



109
110
111
112
113
 
# File 'lib/tinkerforge/bricklet_rotary_encoder.rb', line 109

def get_count_callback_period
  check_validity

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

#get_count_callback_threshold ⇒ Object

Returns the threshold as set by BrickletRotaryEncoder#set_count_callback_threshold.



133
134
135
136
137
 
# File 'lib/tinkerforge/bricklet_rotary_encoder.rb', line 133

def get_count_callback_threshold
  check_validity

  send_request FUNCTION_GET_COUNT_CALLBACK_THRESHOLD, [], '', 17, 'k l l'
end

#get_debounce_period ⇒ Object

Returns the debounce period as set by BrickletRotaryEncoder#set_debounce_period.



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

def get_debounce_period
  check_validity

  send_request FUNCTION_GET_DEBOUNCE_PERIOD, [], '', 12, '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|



181
182
183
 
# File 'lib/tinkerforge/bricklet_rotary_encoder.rb', line 181

def get_identity
  send_request FUNCTION_GET_IDENTITY, [], '', 33, 'Z8 Z8 k C3 C3 S'
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.



165
166
167
168
169
 
# File 'lib/tinkerforge/bricklet_rotary_encoder.rb', line 165

def is_pressed
  check_validity

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

#register_callback(id, &block) ⇒ Object

Registers a callback with ID id to the block block.



186
187
188
189
 
# File 'lib/tinkerforge/bricklet_rotary_encoder.rb', line 186

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

#set_count_callback_period(period) ⇒ Object

Sets the period with which the CALLBACK_COUNT callback is triggered periodically. A value of 0 turns the callback off.

The CALLBACK_COUNT callback is only triggered if the count has changed since the last triggering.



102
103
104
105
106
 
# File 'lib/tinkerforge/bricklet_rotary_encoder.rb', line 102

def set_count_callback_period(period)
  check_validity

  send_request FUNCTION_SET_COUNT_CALLBACK_PERIOD, [period], 'L', 8, ''
end

#set_count_callback_threshold(option, min, max) ⇒ Object

Sets the thresholds for the CALLBACK_COUNT_REACHED callback.

The following options are possible:

"Option", "Description"

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



126
127
128
129
130
 
# File 'lib/tinkerforge/bricklet_rotary_encoder.rb', line 126

def set_count_callback_threshold(option, min, max)
  check_validity

  send_request FUNCTION_SET_COUNT_CALLBACK_THRESHOLD, [option, min, max], 'k l l', 8, ''
end

#set_debounce_period(debounce) ⇒ Object

Sets the period with which the threshold callback

  • CALLBACK_COUNT_REACHED

is triggered, if the thresholds

  • BrickletRotaryEncoder#set_count_callback_threshold

keeps being reached.



148
149
150
151
152
 
# File 'lib/tinkerforge/bricklet_rotary_encoder.rb', line 148

def set_debounce_period(debounce)
  check_validity

  send_request FUNCTION_SET_DEBOUNCE_PERIOD, [debounce], 'L', 8, ''
end