/ 
Tinkerforge-2.1.6
River stage zero No dependents
/ Tinkerforge::BrickletJoystick

NAME

Tinkerforge::BrickletJoystick - 2-axis joystick with push-button

CONSTANTS

DEVICE_IDENTIFIER

This constant is used to identify a Joystick 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 Joystick 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.

CALLBACK_PRESSED

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

CALLBACK_RELEASED

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

FUNCTION_GET_POSITION

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

FUNCTION_IS_PRESSED

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_CALIBRATE

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 Joystick. The value ranges between -100 and 100 for both axis. The middle position of the joystick is x=0, y=0. The returned values are averaged and calibrated (see :func:`Calibrate`).

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

is_pressed()

Returns *true* if the button is pressed and *false* otherwise.

It is recommended to use the :func:`Pressed` and :func:`Released` callbacks to handle the button.

get_analog_value()

Returns the values as read by a 12-bit analog-to-digital converter. The values are between 0 and 4095 for both axis.

.. note:: The values returned by :func:`GetPosition` are averaged over several samples to yield less noise, while :func:`GetAnalogValue` gives back raw unfiltered analog values. The only reason to use :func:`GetAnalogValue` is, if you need the full resolution of the analog-to-digital converter.

If you want the analog values periodically, it is recommended to use the callback :func:`AnalogValue` and set the period with :func:`SetAnalogValueCallbackPeriod`.

calibrate()

Calibrates the middle position of the Joystick. If your Joystick Bricklet 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 on the EEPROM of the Joystick Bricklet, thus you only have to calibrate it once.

set_position_callback_period()

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

:func:`Position` is only triggered if the position has changed since the last triggering.

The default value is 0.

get_position_callback_period()

Returns the period as set by :func:`SetPositionCallbackPeriod`.

set_analog_value_callback_period()

Sets the period in ms with which the :func:`AnalogValue` callback is triggered periodically. A value of 0 turns the callback off.

:func:`AnalogValue` is only triggered if the analog values have changed since the last triggering.

The default value is 0.

get_analog_value_callback_period()

Returns the period as set by :func:`SetAnalogValueCallbackPeriod`.

set_position_callback_threshold()

Sets the thresholds for the :func:`PositionReached` 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 values (max is ignored)"
"'>'",    "Callback is triggered when the position is greater than the min values (max is ignored)"

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

get_position_callback_threshold()

Returns the threshold as set by :func:`SetPositionCallbackThreshold`.

set_analog_value_callback_threshold()

Sets the thresholds for the :func:`AnalogValueReached` 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 values are *outside* the min and max values"
"'i'",    "Callback is triggered when the analog values are *inside* the min and max values"
"'<'",    "Callback is triggered when the analog values are smaller than the min values (max is ignored)"
"'>'",    "Callback is triggered when the analog values are greater than the min values (max is ignored)"

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

get_analog_value_callback_threshold()

Returns the threshold as set by :func:`SetAnalogValueCallbackThreshold`.

set_debounce_period()

Sets the period in ms with which the threshold callbacks

* :func:`PositionReached`, * :func:`AnalogValueReached`

are triggered, if the thresholds

* :func:`SetPositionCallbackThreshold`, * :func:`SetAnalogValueCallbackThreshold`

keep being reached.

The default value is 100.

get_debounce_period()

Returns the debounce period as set by :func:`SetDebouncePeriod`.

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|