/ 
Tinkerforge-2.1.25
River stage zero No dependents
/ Tinkerforge::BrickletRotaryPoti

NAME

Tinkerforge::BrickletRotaryPoti - 300° rotary potentiometer

CONSTANTS

DEVICE_IDENTIFIER

This constant is used to identify a Rotary Poti Bricklet.

The get_identity() subroutine and the CALLBACK_ENUMERATE callback of the IP Connection have a device_identifier parameter to specify the Brick's or Bricklet's type.

DEVICE_DISPLAY_NAME

This constant represents the display name of a Rotary Poti Bricklet.

CALLBACK_POSITION

This constant is used with the register_callback() subroutine to specify the CALLBACK_POSITION callback.

CALLBACK_ANALOG_VALUE

This constant is used with the register_callback() subroutine to specify the CALLBACK_ANALOG_VALUE callback.

CALLBACK_POSITION_REACHED

This constant is used with the register_callback() subroutine to specify the CALLBACK_POSITION_REACHED callback.

CALLBACK_ANALOG_VALUE_REACHED

This constant is used with the register_callback() subroutine to specify the CALLBACK_ANALOG_VALUE_REACHED callback.

FUNCTION_GET_POSITION

This constant is used with the get_response_expected(), set_response_expected() and set_response_expected_all() subroutines.

FUNCTION_GET_ANALOG_VALUE

This constant is used with the get_response_expected(), set_response_expected() and set_response_expected_all() subroutines.

FUNCTION_SET_POSITION_CALLBACK_PERIOD

This constant is used with the get_response_expected(), set_response_expected() and set_response_expected_all() subroutines.

FUNCTION_GET_POSITION_CALLBACK_PERIOD

This constant is used with the get_response_expected(), set_response_expected() and set_response_expected_all() subroutines.

FUNCTION_SET_ANALOG_VALUE_CALLBACK_PERIOD

This constant is used with the get_response_expected(), set_response_expected() and set_response_expected_all() subroutines.

FUNCTION_GET_ANALOG_VALUE_CALLBACK_PERIOD

This constant is used with the get_response_expected(), set_response_expected() and set_response_expected_all() subroutines.

FUNCTION_SET_POSITION_CALLBACK_THRESHOLD

This constant is used with the get_response_expected(), set_response_expected() and set_response_expected_all() subroutines.

FUNCTION_GET_POSITION_CALLBACK_THRESHOLD

This constant is used with the get_response_expected(), set_response_expected() and set_response_expected_all() subroutines.

FUNCTION_SET_ANALOG_VALUE_CALLBACK_THRESHOLD

This constant is used with the get_response_expected(), set_response_expected() and set_response_expected_all() subroutines.

FUNCTION_GET_ANALOG_VALUE_CALLBACK_THRESHOLD

This constant is used with the get_response_expected(), set_response_expected() and set_response_expected_all() subroutines.

FUNCTION_SET_DEBOUNCE_PERIOD

This constant is used with the get_response_expected(), set_response_expected() and set_response_expected_all() subroutines.

FUNCTION_GET_DEBOUNCE_PERIOD

This constant is used with the get_response_expected(), set_response_expected() and set_response_expected_all() subroutines.

FUNCTION_GET_IDENTITY

This constant is used with the get_response_expected(), set_response_expected() and set_response_expected_all() subroutines.

FUNCTIONS

new()

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

get_position()

Returns the position of the rotary potentiometer. The value is in degree and between -150° (turned left) and 150° (turned right).

If you want to get the position periodically, it is recommended to use the :cb:`Position` callback and set the period with :func:`Set Position Callback Period`.

get_analog_value()

Returns the value as read by a 12-bit analog-to-digital converter. The value is between 0 and 4095.

.. note:: The value returned by :func:`Get Position` is averaged over several samples to yield less noise, while :func:`Get Analog Value` gives back raw unfiltered analog values. The only reason to use :func:`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 :cb:`Analog Value` callback and set the period with :func:`Set Analog Value Callback Period`.

set_position_callback_period()

Sets the period with which the :cb:`Position` callback is triggered periodically. A value of 0 turns the callback off.

The :cb:`Position` callback is only triggered if the position has changed since the last triggering.

get_position_callback_period()

Returns the period as set by :func:`Set Position Callback Period`.

set_analog_value_callback_period()

Sets the period with which the :cb:`Analog Value` callback is triggered periodically. A value of 0 turns the callback off.

The :cb:`Analog Value` callback is only triggered if the analog value has changed since the last triggering.

get_analog_value_callback_period()

Returns the period as set by :func:`Set Analog Value Callback Period`.

set_position_callback_threshold()

Sets the thresholds for the :cb:`Position Reached` callback.

The following options are possible:

.. csv-table:: :header: "Option", "Description" :widths: 10, 100

"'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)"

The default value is ('x', 0, 0).

get_position_callback_threshold()

Returns the threshold as set by :func:`Set Position Callback Threshold`.

set_analog_value_callback_threshold()

Sets the thresholds for the :cb:`Analog Value Reached` callback.

The following options are possible:

.. csv-table:: :header: "Option", "Description" :widths: 10, 100

"'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)"

The default value is ('x', 0, 0).

get_analog_value_callback_threshold()

Returns the threshold as set by :func:`Set Analog Value Callback Threshold`.

set_debounce_period()

Sets the period with which the threshold callbacks

* :cb:`Position Reached`, * :cb:`Analog Value Reached`

are triggered, if the thresholds

* :func:`Set Position Callback Threshold`, * :func:`Set Analog Value Callback Threshold`

keep being reached.

get_debounce_period()

Returns the debounce period as set by :func:`Set Debounce Period`.

get_identity()

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' or 'd'.

The device identifier numbers can be found :ref:`here <device_identifier>`. |device_identifier_constant|