class Tinkerforge::BrickletRotaryPoti
300° rotary potentiometer
Constants
- CALLBACK_ANALOG_VALUE
This callback is triggered periodically with the period that is set by
BrickletRotaryPoti#set_analog_value_callback_period
. The parameter is the analog value of the rotary potentiometer.The
CALLBACK_ANALOG_VALUE
callback is only triggered if the position has changed since the last triggering.- CALLBACK_ANALOG_VALUE_REACHED
This callback is triggered when the threshold as set by
BrickletRotaryPoti#set_analog_value_callback_threshold
is reached. The parameter is the analog value of the rotary potentiometer.If the threshold keeps being reached, the callback is triggered periodically with the period as set by
BrickletRotaryPoti#set_debounce_period
.- CALLBACK_POSITION
This callback is triggered periodically with the period that is set by
BrickletRotaryPoti#set_position_callback_period
. The parameter is the position of the rotary potentiometer.The
CALLBACK_POSITION
callback is only triggered if the position has changed since the last triggering.- CALLBACK_POSITION_REACHED
This callback is triggered when the threshold as set by
BrickletRotaryPoti#set_position_callback_threshold
is reached. The parameter is the position of the rotary potentiometer.If the threshold keeps being reached, the callback is triggered periodically with the period as set by
BrickletRotaryPoti#set_debounce_period
.
Public Class Methods
Creates an object with the unique device ID uid
and adds it to the IP Connection ipcon
.
# File lib/tinkerforge/bricklet_rotary_poti.rb, line 73 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_GET_ANALOG_VALUE] = RESPONSE_EXPECTED_ALWAYS_TRUE @response_expected[FUNCTION_SET_POSITION_CALLBACK_PERIOD] = RESPONSE_EXPECTED_TRUE @response_expected[FUNCTION_GET_POSITION_CALLBACK_PERIOD] = RESPONSE_EXPECTED_ALWAYS_TRUE @response_expected[FUNCTION_SET_ANALOG_VALUE_CALLBACK_PERIOD] = RESPONSE_EXPECTED_TRUE @response_expected[FUNCTION_GET_ANALOG_VALUE_CALLBACK_PERIOD] = RESPONSE_EXPECTED_ALWAYS_TRUE @response_expected[FUNCTION_SET_POSITION_CALLBACK_THRESHOLD] = RESPONSE_EXPECTED_TRUE @response_expected[FUNCTION_GET_POSITION_CALLBACK_THRESHOLD] = RESPONSE_EXPECTED_ALWAYS_TRUE @response_expected[FUNCTION_SET_ANALOG_VALUE_CALLBACK_THRESHOLD] = RESPONSE_EXPECTED_TRUE @response_expected[FUNCTION_GET_ANALOG_VALUE_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_GET_IDENTITY] = RESPONSE_EXPECTED_ALWAYS_TRUE @callback_formats[CALLBACK_POSITION] = [10, 's'] @callback_formats[CALLBACK_ANALOG_VALUE] = [10, 'S'] @callback_formats[CALLBACK_POSITION_REACHED] = [10, 's'] @callback_formats[CALLBACK_ANALOG_VALUE_REACHED] = [10, 'S'] @ipcon.add_device self end
Public Instance Methods
Returns the value as read by a 12-bit analog-to-digital converter.
- .. note
-
The value returned by
BrickletRotaryPoti#get_position
is averaged over several samples to yield less noise, whileBrickletRotaryPoti#get_analog_value
gives back raw unfiltered analog values. The only reason to useBrickletRotaryPoti#get_analog_value
is, if you need the full resolution of the analog-to-digital converter.
If you want the analog value periodically, it is recommended to use the CALLBACK_ANALOG_VALUE
callback and set the period with BrickletRotaryPoti#set_analog_value_callback_period
.
# File lib/tinkerforge/bricklet_rotary_poti.rb, line 123 def get_analog_value check_validity send_request FUNCTION_GET_ANALOG_VALUE, [], '', 10, 'S' end
Returns the period as set by BrickletRotaryPoti#set_analog_value_callback_period
.
# File lib/tinkerforge/bricklet_rotary_poti.rb, line 159 def get_analog_value_callback_period check_validity send_request FUNCTION_GET_ANALOG_VALUE_CALLBACK_PERIOD, [], '', 12, 'L' end
Returns the threshold as set by BrickletRotaryPoti#set_analog_value_callback_threshold
.
# File lib/tinkerforge/bricklet_rotary_poti.rb, line 207 def get_analog_value_callback_threshold check_validity send_request FUNCTION_GET_ANALOG_VALUE_CALLBACK_THRESHOLD, [], '', 13, 'k S S' end
Returns the debounce period as set by BrickletRotaryPoti#set_debounce_period
.
# File lib/tinkerforge/bricklet_rotary_poti.rb, line 231 def get_debounce_period check_validity send_request FUNCTION_GET_DEBOUNCE_PERIOD, [], '', 12, 'L' 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_rotary_poti.rb, line 247 def get_identity send_request FUNCTION_GET_IDENTITY, [], '', 33, 'Z8 Z8 k C3 C3 S' end
Returns the position of the rotary potentiometer. The value is between -150° (turned left) and 150° (turned right).
If you want to get the position periodically, it is recommended to use the CALLBACK_POSITION
callback and set the period with BrickletRotaryPoti#set_position_callback_period
.
# File lib/tinkerforge/bricklet_rotary_poti.rb, line 106 def get_position check_validity send_request FUNCTION_GET_POSITION, [], '', 10, 's' end
Returns the period as set by BrickletRotaryPoti#set_position_callback_period
.
# File lib/tinkerforge/bricklet_rotary_poti.rb, line 141 def get_position_callback_period check_validity send_request FUNCTION_GET_POSITION_CALLBACK_PERIOD, [], '', 12, 'L' end
Returns the threshold as set by BrickletRotaryPoti#set_position_callback_threshold
.
# File lib/tinkerforge/bricklet_rotary_poti.rb, line 183 def get_position_callback_threshold check_validity send_request FUNCTION_GET_POSITION_CALLBACK_THRESHOLD, [], '', 13, 'k s s' end
Registers a callback with ID id
to the block block
.
# File lib/tinkerforge/bricklet_rotary_poti.rb, line 252 def register_callback(id, &block) callback = block @registered_callbacks[id] = callback end
Sets the period with which the CALLBACK_ANALOG_VALUE
callback is triggered periodically. A value of 0 turns the callback off.
The CALLBACK_ANALOG_VALUE
callback is only triggered if the analog value has changed since the last triggering.
# File lib/tinkerforge/bricklet_rotary_poti.rb, line 152 def set_analog_value_callback_period(period) check_validity send_request FUNCTION_SET_ANALOG_VALUE_CALLBACK_PERIOD, [period], 'L', 8, '' end
Sets the thresholds for the CALLBACK_ANALOG_VALUE_REACHED
callback.
The following options are possible:
"Option", "Description" "'x'", "Callback is turned off" "'o'", "Callback is triggered when the analog value is *outside* the min and max values" "'i'", "Callback is triggered when the analog value is *inside* the min and max values" "'<'", "Callback is triggered when the analog value is smaller than the min value (max is ignored)" "'>'", "Callback is triggered when the analog value is greater than the min value (max is ignored)"
# File lib/tinkerforge/bricklet_rotary_poti.rb, line 200 def set_analog_value_callback_threshold(option, min, max) check_validity send_request FUNCTION_SET_ANALOG_VALUE_CALLBACK_THRESHOLD, [option, min, max], 'k S S', 8, '' end
Sets the period with which the threshold callbacks
are triggered, if the thresholds
keep being reached.
# File lib/tinkerforge/bricklet_rotary_poti.rb, line 224 def set_debounce_period(debounce) check_validity send_request FUNCTION_SET_DEBOUNCE_PERIOD, [debounce], 'L', 8, '' end
Sets the period with which the CALLBACK_POSITION
callback is triggered periodically. A value of 0 turns the callback off.
The CALLBACK_POSITION
callback is only triggered if the position has changed since the last triggering.
# File lib/tinkerforge/bricklet_rotary_poti.rb, line 134 def set_position_callback_period(period) check_validity send_request FUNCTION_SET_POSITION_CALLBACK_PERIOD, [period], 'L', 8, '' end
Sets the thresholds for the CALLBACK_POSITION_REACHED
callback.
The following options are possible:
"Option", "Description" "'x'", "Callback is turned off" "'o'", "Callback is triggered when the position is *outside* the min and max values" "'i'", "Callback is triggered when the position is *inside* the min and max values" "'<'", "Callback is triggered when the position is smaller than the min value (max is ignored)" "'>'", "Callback is triggered when the position is greater than the min value (max is ignored)"
# File lib/tinkerforge/bricklet_rotary_poti.rb, line 176 def set_position_callback_threshold(option, min, max) check_validity send_request FUNCTION_SET_POSITION_CALLBACK_THRESHOLD, [option, min, max], 'k s s', 8, '' end