LabVIEW - Joystick Bricklet

This is the description of the LabVIEW API bindings for the Joystick Bricklet. General information and technical specifications for the Joystick Bricklet are summarized in its hardware description.

An installation guide for the LabVIEW API bindings is part of their general description.

API

Generally, every function of the LabVIEW bindings that outputs a value can report a Tinkerforge.TimeoutException. This error gets reported if the device did not respond. If a cable based connection is used, it is unlikely that this exception gets thrown (assuming nobody plugs the device out). However, if a wireless connection is used, timeouts will occur if the distance to the device gets too big.

The namespace for all Brick/Bricklet bindings and the IPConnection is Tinkerforge.*.

Basic Functions

BrickletJoystick(uid, ipcon) → joystick
Input:
  • uid – Type: String
  • ipcon – Type: .NET Refnum (IPConnection)
Output:
  • joystick – Type: .NET Refnum (BrickletJoystick)

Creates an object with the unique device ID uid. This object can then be used after the IP Connection is connected (see examples above).

BrickletJoystick.GetPosition() → x, y
Output:
  • x – Type: Int16, Range: [-100 to 100]
  • y – Type: Int16, Range: [-100 to 100]

Returns the position of the joystick. The middle position of the joystick is x=0, y=0. The returned values are averaged and calibrated (see Calibrate()).

If you want to get the position periodically, it is recommended to use the PositionCallback callback and set the period with SetPositionCallbackPeriod().

BrickletJoystick.IsPressed() → pressed
Output:
  • pressed – Type: Boolean

Returns true if the button is pressed and false otherwise.

It is recommended to use the PressedCallback and ReleasedCallback callbacks to handle the button.

Advanced Functions

BrickletJoystick.GetAnalogValue() → x, y
Output:
  • x – Type: Int32, Range: [0 to 4095]
  • y – Type: Int32, Range: [0 to 4095]

Returns the values as read by a 12-bit analog-to-digital converter.

Note

The values returned by GetPosition() are averaged over several samples to yield less noise, while GetAnalogValue() gives back raw unfiltered analog values. The only reason to use 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 AnalogValueCallback callback and set the period with SetAnalogValueCallbackPeriod().

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

BrickletJoystick.GetIdentity() → uid, connectedUid, position, hardwareVersion, firmwareVersion, deviceIdentifier
Output:
  • uid – Type: String, Length: up to 8
  • connectedUid – Type: String, Length: up to 8
  • position – Type: Char, Range: ["a" to "h", "i", "z"]
  • hardwareVersion – Type: Byte[3]
    • 0: major – Type: Byte, Range: [0 to 255]
    • 1: minor – Type: Byte, Range: [0 to 255]
    • 2: revision – Type: Byte, Range: [0 to 255]
  • firmwareVersion – Type: Byte[3]
    • 0: major – Type: Byte, Range: [0 to 255]
    • 1: minor – Type: Byte, Range: [0 to 255]
    • 2: revision – Type: Byte, Range: [0 to 255]
  • deviceIdentifier – Type: Int32, Range: [0 to 216 - 1]

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). The Raspberry Pi HAT (Zero) Brick is always at position 'i' and the Bricklet connected to an Isolator Bricklet is always as position 'z'.

The device identifier numbers can be found here. There is also a constant for the device identifier of this Bricklet.

Callback Configuration Functions

BrickletJoystick.SetPositionCallbackPeriod(period)
Input:
  • period – Type: Int64, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0

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

The PositionCallback callback is only triggered if the position has changed since the last triggering.

BrickletJoystick.GetPositionCallbackPeriod() → period
Output:
  • period – Type: Int64, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0

Returns the period as set by SetPositionCallbackPeriod().

BrickletJoystick.SetAnalogValueCallbackPeriod(period)
Input:
  • period – Type: Int64, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0

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

The AnalogValueCallback callback is only triggered if the analog values have changed since the last triggering.

BrickletJoystick.GetAnalogValueCallbackPeriod() → period
Output:
  • period – Type: Int64, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0

Returns the period as set by SetAnalogValueCallbackPeriod().

BrickletJoystick.SetPositionCallbackThreshold(option, minX, maxX, minY, maxY)
Input:
  • option – Type: Char, Range: See constants, Default: "x"
  • minX – Type: Int16, Range: [-215 to 215 - 1], Default: 0
  • maxX – Type: Int16, Range: [-215 to 215 - 1], Default: 0
  • minY – Type: Int16, Range: [-215 to 215 - 1], Default: 0
  • maxY – Type: Int16, Range: [-215 to 215 - 1], Default: 0

Sets the thresholds for the PositionReachedCallback 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 values (max is ignored)
'>' Callback is triggered when the position is greater than the min values (max is ignored)

The following constants are available for this function:

For option:

  • BrickletJoystick.THRESHOLD_OPTION_OFF = "x"
  • BrickletJoystick.THRESHOLD_OPTION_OUTSIDE = "o"
  • BrickletJoystick.THRESHOLD_OPTION_INSIDE = "i"
  • BrickletJoystick.THRESHOLD_OPTION_SMALLER = "<"
  • BrickletJoystick.THRESHOLD_OPTION_GREATER = ">"
BrickletJoystick.GetPositionCallbackThreshold() → option, minX, maxX, minY, maxY
Output:
  • option – Type: Char, Range: See constants, Default: "x"
  • minX – Type: Int16, Range: [-215 to 215 - 1], Default: 0
  • maxX – Type: Int16, Range: [-215 to 215 - 1], Default: 0
  • minY – Type: Int16, Range: [-215 to 215 - 1], Default: 0
  • maxY – Type: Int16, Range: [-215 to 215 - 1], Default: 0

Returns the threshold as set by SetPositionCallbackThreshold().

The following constants are available for this function:

For option:

  • BrickletJoystick.THRESHOLD_OPTION_OFF = "x"
  • BrickletJoystick.THRESHOLD_OPTION_OUTSIDE = "o"
  • BrickletJoystick.THRESHOLD_OPTION_INSIDE = "i"
  • BrickletJoystick.THRESHOLD_OPTION_SMALLER = "<"
  • BrickletJoystick.THRESHOLD_OPTION_GREATER = ">"
BrickletJoystick.SetAnalogValueCallbackThreshold(option, minX, maxX, minY, maxY)
Input:
  • option – Type: Char, Range: See constants, Default: "x"
  • minX – Type: Int32, Range: [0 to 216 - 1], Default: 0
  • maxX – Type: Int32, Range: [0 to 216 - 1], Default: 0
  • minY – Type: Int32, Range: [0 to 216 - 1], Default: 0
  • maxY – Type: Int32, Range: [0 to 216 - 1], Default: 0

Sets the thresholds for the AnalogValueReachedCallback callback.

The following options are possible:

Option Description
'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 following constants are available for this function:

For option:

  • BrickletJoystick.THRESHOLD_OPTION_OFF = "x"
  • BrickletJoystick.THRESHOLD_OPTION_OUTSIDE = "o"
  • BrickletJoystick.THRESHOLD_OPTION_INSIDE = "i"
  • BrickletJoystick.THRESHOLD_OPTION_SMALLER = "<"
  • BrickletJoystick.THRESHOLD_OPTION_GREATER = ">"
BrickletJoystick.GetAnalogValueCallbackThreshold() → option, minX, maxX, minY, maxY
Output:
  • option – Type: Char, Range: See constants, Default: "x"
  • minX – Type: Int32, Range: [0 to 216 - 1], Default: 0
  • maxX – Type: Int32, Range: [0 to 216 - 1], Default: 0
  • minY – Type: Int32, Range: [0 to 216 - 1], Default: 0
  • maxY – Type: Int32, Range: [0 to 216 - 1], Default: 0

Returns the threshold as set by SetAnalogValueCallbackThreshold().

The following constants are available for this function:

For option:

  • BrickletJoystick.THRESHOLD_OPTION_OFF = "x"
  • BrickletJoystick.THRESHOLD_OPTION_OUTSIDE = "o"
  • BrickletJoystick.THRESHOLD_OPTION_INSIDE = "i"
  • BrickletJoystick.THRESHOLD_OPTION_SMALLER = "<"
  • BrickletJoystick.THRESHOLD_OPTION_GREATER = ">"
BrickletJoystick.SetDebouncePeriod(debounce)
Input:
  • debounce – Type: Int64, Unit: 1 ms, Range: [0 to 232 - 1], Default: 100

Sets the period with which the threshold callbacks

are triggered, if the thresholds

keep being reached.

BrickletJoystick.GetDebouncePeriod() → debounce
Output:
  • debounce – Type: Int64, Unit: 1 ms, Range: [0 to 232 - 1], Default: 100

Returns the debounce period as set by SetDebouncePeriod().

Callbacks

Callbacks can be registered to receive time critical or recurring data from the device. The registration is done by assigning a function to a callback property of the device object. The available callback property and their type of parameters are described below.

Note

Using callbacks for recurring events is always preferred compared to using getters. It will use less USB bandwidth and the latency will be a lot better, since there is no round trip time.

event BrickletJoystick.PositionCallback → sender, x, y
Callback Output:
  • sender – Type: .NET Refnum (BrickletJoystick)
  • x – Type: Int16, Range: [-100 to 100]
  • y – Type: Int16, Range: [-100 to 100]

This callback is triggered periodically with the period that is set by SetPositionCallbackPeriod(). The parameter is the position of the joystick.

The PositionCallback callback is only triggered if the position has changed since the last triggering.

event BrickletJoystick.AnalogValueCallback → sender, x, y
Callback Output:
  • sender – Type: .NET Refnum (BrickletJoystick)
  • x – Type: Int32, Range: [0 to 4095]
  • y – Type: Int32, Range: [0 to 4095]

This callback is triggered periodically with the period that is set by SetAnalogValueCallbackPeriod(). The parameters are the analog values of the joystick.

The AnalogValueCallback callback is only triggered if the values have changed since the last triggering.

event BrickletJoystick.PositionReachedCallback → sender, x, y
Callback Output:
  • sender – Type: .NET Refnum (BrickletJoystick)
  • x – Type: Int16, Range: [-100 to 100]
  • y – Type: Int16, Range: [-100 to 100]

This callback is triggered when the threshold as set by SetPositionCallbackThreshold() is reached. The parameters are the position of the joystick.

If the threshold keeps being reached, the callback is triggered periodically with the period as set by SetDebouncePeriod().

event BrickletJoystick.AnalogValueReachedCallback → sender, x, y
Callback Output:
  • sender – Type: .NET Refnum (BrickletJoystick)
  • x – Type: Int32, Range: [0 to 4095]
  • y – Type: Int32, Range: [0 to 4095]

This callback is triggered when the threshold as set by SetAnalogValueCallbackThreshold() is reached. The parameters are the analog values of the joystick.

If the threshold keeps being reached, the callback is triggered periodically with the period as set by SetDebouncePeriod().

event BrickletJoystick.PressedCallback → sender
Callback Output:
  • sender – Type: .NET Refnum (BrickletJoystick)

This callback is triggered when the button is pressed.

event BrickletJoystick.ReleasedCallback → sender
Callback Output:
  • sender – Type: .NET Refnum (BrickletJoystick)

This callback is triggered when the button is released.

Virtual Functions

Virtual functions don't communicate with the device itself, but operate only on the API bindings device object. They can be called without the corresponding IP Connection object being connected.

BrickletJoystick.GetAPIVersion() → apiVersion
Output:
  • apiVersion – Type: Byte[3]
    • 0: major – Type: Byte, Range: [0 to 255]
    • 1: minor – Type: Byte, Range: [0 to 255]
    • 2: revision – Type: Byte, Range: [0 to 255]

Returns the version of the API definition implemented by this API bindings. This is neither the release version of this API bindings nor does it tell you anything about the represented Brick or Bricklet.

BrickletJoystick.GetResponseExpected(functionId) → responseExpected
Input:
  • functionId – Type: Byte, Range: See constants
Output:
  • responseExpected – Type: Boolean

Returns the response expected flag for the function specified by the function ID parameter. It is true if the function is expected to send a response, false otherwise.

For getter functions this is enabled by default and cannot be disabled, because those functions will always send a response. For callback configuration functions it is enabled by default too, but can be disabled by SetResponseExpected(). For setter functions it is disabled by default and can be enabled.

Enabling the response expected flag for a setter function allows to detect timeouts and other error conditions calls of this setter as well. The device will then send a response for this purpose. If this flag is disabled for a setter function then no response is send and errors are silently ignored, because they cannot be detected.

The following constants are available for this function:

For functionId:

  • BrickletJoystick.FUNCTION_CALIBRATE = 4
  • BrickletJoystick.FUNCTION_SET_POSITION_CALLBACK_PERIOD = 5
  • BrickletJoystick.FUNCTION_SET_ANALOG_VALUE_CALLBACK_PERIOD = 7
  • BrickletJoystick.FUNCTION_SET_POSITION_CALLBACK_THRESHOLD = 9
  • BrickletJoystick.FUNCTION_SET_ANALOG_VALUE_CALLBACK_THRESHOLD = 11
  • BrickletJoystick.FUNCTION_SET_DEBOUNCE_PERIOD = 13
BrickletJoystick.SetResponseExpected(functionId, responseExpected)
Input:
  • functionId – Type: Byte, Range: See constants
  • responseExpected – Type: Boolean

Changes the response expected flag of the function specified by the function ID parameter. This flag can only be changed for setter (default value: false) and callback configuration functions (default value: true). For getter functions it is always enabled.

Enabling the response expected flag for a setter function allows to detect timeouts and other error conditions calls of this setter as well. The device will then send a response for this purpose. If this flag is disabled for a setter function then no response is send and errors are silently ignored, because they cannot be detected.

The following constants are available for this function:

For functionId:

  • BrickletJoystick.FUNCTION_CALIBRATE = 4
  • BrickletJoystick.FUNCTION_SET_POSITION_CALLBACK_PERIOD = 5
  • BrickletJoystick.FUNCTION_SET_ANALOG_VALUE_CALLBACK_PERIOD = 7
  • BrickletJoystick.FUNCTION_SET_POSITION_CALLBACK_THRESHOLD = 9
  • BrickletJoystick.FUNCTION_SET_ANALOG_VALUE_CALLBACK_THRESHOLD = 11
  • BrickletJoystick.FUNCTION_SET_DEBOUNCE_PERIOD = 13
BrickletJoystick.SetResponseExpectedAll(responseExpected)
Input:
  • responseExpected – Type: Boolean

Changes the response expected flag for all setter and callback configuration functions of this device at once.

Constants

BrickletJoystick.DEVICE_IDENTIFIER

This constant is used to identify a Joystick Bricklet.

The GetIdentity() function and the IPConnection.EnumerateCallback callback of the IP Connection have a deviceIdentifier parameter to specify the Brick's or Bricklet's type.

BrickletJoystick.DEVICE_DISPLAY_NAME

This constant represents the human readable name of a Joystick Bricklet.