LabVIEW - Accelerometer Bricklet

This is the description of the LabVIEW API bindings for the Accelerometer Bricklet. General information and technical specifications for the Accelerometer 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

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

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

BrickletAccelerometer.GetAcceleration() → x, y, z
Output:
  • x – Type: Int16, Unit: 1/1000 gₙ, Range: ?
  • y – Type: Int16, Unit: 1/1000 gₙ, Range: ?
  • z – Type: Int16, Unit: 1/1000 gₙ, Range: ?

Returns the acceleration in x, y and z direction. The values are given in gₙ/1000 (1gₙ = 9.80665m/s²). The range is configured with SetConfiguration().

If you want to get the acceleration periodically, it is recommended to use the AccelerationCallback callback and set the period with SetAccelerationCallbackPeriod().

BrickletAccelerometer.GetTemperature() → temperature
Output:
  • temperature – Type: Int16, Unit: 1 °C, Range: [-103 to 152]

Returns the temperature of the accelerometer.

BrickletAccelerometer.LEDOn()

Enables the LED on the Bricklet.

BrickletAccelerometer.LEDOff()

Disables the LED on the Bricklet.

BrickletAccelerometer.IsLEDOn() → on
Output:
  • on – Type: Boolean, Default: F

Returns true if the LED is enabled, false otherwise.

Advanced Functions

BrickletAccelerometer.SetConfiguration(dataRate, fullScale, filterBandwidth)
Input:
  • dataRate – Type: Byte, Range: See constants, Default: 6
  • fullScale – Type: Byte, Range: See constants, Default: 1
  • filterBandwidth – Type: Byte, Range: See constants, Default: 2

Configures the data rate, full scale range and filter bandwidth. Possible values are:

  • Data rate of 0Hz to 1600Hz.
  • Full scale range of ±2gₙ up to ±16gₙ.
  • Filter bandwidth between 50Hz and 800Hz.

Decreasing data rate or full scale range will also decrease the noise on the data.

The following constants are available for this function:

For dataRate:

  • BrickletAccelerometer.DATA_RATE_OFF = 0
  • BrickletAccelerometer.DATA_RATE_3HZ = 1
  • BrickletAccelerometer.DATA_RATE_6HZ = 2
  • BrickletAccelerometer.DATA_RATE_12HZ = 3
  • BrickletAccelerometer.DATA_RATE_25HZ = 4
  • BrickletAccelerometer.DATA_RATE_50HZ = 5
  • BrickletAccelerometer.DATA_RATE_100HZ = 6
  • BrickletAccelerometer.DATA_RATE_400HZ = 7
  • BrickletAccelerometer.DATA_RATE_800HZ = 8
  • BrickletAccelerometer.DATA_RATE_1600HZ = 9

For fullScale:

  • BrickletAccelerometer.FULL_SCALE_2G = 0
  • BrickletAccelerometer.FULL_SCALE_4G = 1
  • BrickletAccelerometer.FULL_SCALE_6G = 2
  • BrickletAccelerometer.FULL_SCALE_8G = 3
  • BrickletAccelerometer.FULL_SCALE_16G = 4

For filterBandwidth:

  • BrickletAccelerometer.FILTER_BANDWIDTH_800HZ = 0
  • BrickletAccelerometer.FILTER_BANDWIDTH_400HZ = 1
  • BrickletAccelerometer.FILTER_BANDWIDTH_200HZ = 2
  • BrickletAccelerometer.FILTER_BANDWIDTH_50HZ = 3
BrickletAccelerometer.GetConfiguration() → dataRate, fullScale, filterBandwidth
Output:
  • dataRate – Type: Byte, Range: See constants, Default: 6
  • fullScale – Type: Byte, Range: See constants, Default: 1
  • filterBandwidth – Type: Byte, Range: See constants, Default: 2

Returns the configuration as set by SetConfiguration().

The following constants are available for this function:

For dataRate:

  • BrickletAccelerometer.DATA_RATE_OFF = 0
  • BrickletAccelerometer.DATA_RATE_3HZ = 1
  • BrickletAccelerometer.DATA_RATE_6HZ = 2
  • BrickletAccelerometer.DATA_RATE_12HZ = 3
  • BrickletAccelerometer.DATA_RATE_25HZ = 4
  • BrickletAccelerometer.DATA_RATE_50HZ = 5
  • BrickletAccelerometer.DATA_RATE_100HZ = 6
  • BrickletAccelerometer.DATA_RATE_400HZ = 7
  • BrickletAccelerometer.DATA_RATE_800HZ = 8
  • BrickletAccelerometer.DATA_RATE_1600HZ = 9

For fullScale:

  • BrickletAccelerometer.FULL_SCALE_2G = 0
  • BrickletAccelerometer.FULL_SCALE_4G = 1
  • BrickletAccelerometer.FULL_SCALE_6G = 2
  • BrickletAccelerometer.FULL_SCALE_8G = 3
  • BrickletAccelerometer.FULL_SCALE_16G = 4

For filterBandwidth:

  • BrickletAccelerometer.FILTER_BANDWIDTH_800HZ = 0
  • BrickletAccelerometer.FILTER_BANDWIDTH_400HZ = 1
  • BrickletAccelerometer.FILTER_BANDWIDTH_200HZ = 2
  • BrickletAccelerometer.FILTER_BANDWIDTH_50HZ = 3
BrickletAccelerometer.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 "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

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

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

The AccelerationCallback callback is only triggered if the acceleration has changed since the last triggering.

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

Returns the period as set by SetAccelerationCallbackPeriod().

BrickletAccelerometer.SetAccelerationCallbackThreshold(option, minX, maxX, minY, maxY, minZ, maxZ)
Input:
  • option – Type: Char, Range: See constants, Default: "x"
  • minX – Type: Int16, Unit: 1/1000 gₙ, Range: [-215 to 215 - 1], Default: 0
  • maxX – Type: Int16, Unit: 1/1000 gₙ, Range: [-215 to 215 - 1], Default: 0
  • minY – Type: Int16, Unit: 1/1000 gₙ, Range: [-215 to 215 - 1], Default: 0
  • maxY – Type: Int16, Unit: 1/1000 gₙ, Range: [-215 to 215 - 1], Default: 0
  • minZ – Type: Int16, Unit: 1/1000 gₙ, Range: [-215 to 215 - 1], Default: 0
  • maxZ – Type: Int16, Unit: 1/1000 gₙ, Range: [-215 to 215 - 1], Default: 0

Sets the thresholds for the AccelerationReachedCallback callback.

The following options are possible:

Option Description
'x' Callback is turned off
'o' Callback is triggered when the acceleration is outside the min and max values
'i' Callback is triggered when the acceleration is inside the min and max values
'<' Callback is triggered when the acceleration is smaller than the min value (max is ignored)
'>' Callback is triggered when the acceleration is greater than the min value (max is ignored)

The following constants are available for this function:

For option:

  • BrickletAccelerometer.THRESHOLD_OPTION_OFF = "x"
  • BrickletAccelerometer.THRESHOLD_OPTION_OUTSIDE = "o"
  • BrickletAccelerometer.THRESHOLD_OPTION_INSIDE = "i"
  • BrickletAccelerometer.THRESHOLD_OPTION_SMALLER = "<"
  • BrickletAccelerometer.THRESHOLD_OPTION_GREATER = ">"
BrickletAccelerometer.GetAccelerationCallbackThreshold() → option, minX, maxX, minY, maxY, minZ, maxZ
Output:
  • option – Type: Char, Range: See constants, Default: "x"
  • minX – Type: Int16, Unit: 1/1000 gₙ, Range: [-215 to 215 - 1], Default: 0
  • maxX – Type: Int16, Unit: 1/1000 gₙ, Range: [-215 to 215 - 1], Default: 0
  • minY – Type: Int16, Unit: 1/1000 gₙ, Range: [-215 to 215 - 1], Default: 0
  • maxY – Type: Int16, Unit: 1/1000 gₙ, Range: [-215 to 215 - 1], Default: 0
  • minZ – Type: Int16, Unit: 1/1000 gₙ, Range: [-215 to 215 - 1], Default: 0
  • maxZ – Type: Int16, Unit: 1/1000 gₙ, Range: [-215 to 215 - 1], Default: 0

Returns the threshold as set by SetAccelerationCallbackThreshold().

The following constants are available for this function:

For option:

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

Sets the period with which the threshold callback

is triggered, if the threshold

keeps being reached.

BrickletAccelerometer.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 BrickletAccelerometer.AccelerationCallback → sender, x, y, z
Callback Output:
  • sender – Type: .NET Refnum (BrickletAccelerometer)
  • x – Type: Int16, Unit: 1/1000 gₙ, Range: ?
  • y – Type: Int16, Unit: 1/1000 gₙ, Range: ?
  • z – Type: Int16, Unit: 1/1000 gₙ, Range: ?

This callback is triggered periodically with the period that is set by SetAccelerationCallbackPeriod(). The parameters are the X, Y and Z acceleration. The range is configured with SetConfiguration().

The AccelerationCallback callback is only triggered if the acceleration has changed since the last triggering.

event BrickletAccelerometer.AccelerationReachedCallback → sender, x, y, z
Callback Output:
  • sender – Type: .NET Refnum (BrickletAccelerometer)
  • x – Type: Int16, Unit: 1/1000 gₙ, Range: ?
  • y – Type: Int16, Unit: 1/1000 gₙ, Range: ?
  • z – Type: Int16, Unit: 1/1000 gₙ, Range: ?

This callback is triggered when the threshold as set by SetAccelerationCallbackThreshold() is reached. The parameters are the X, Y and Z acceleration. The range is configured with SetConfiguration().

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

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.

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

BrickletAccelerometer.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:

  • BrickletAccelerometer.FUNCTION_SET_ACCELERATION_CALLBACK_PERIOD = 2
  • BrickletAccelerometer.FUNCTION_SET_ACCELERATION_CALLBACK_THRESHOLD = 4
  • BrickletAccelerometer.FUNCTION_SET_DEBOUNCE_PERIOD = 6
  • BrickletAccelerometer.FUNCTION_SET_CONFIGURATION = 9
  • BrickletAccelerometer.FUNCTION_LED_ON = 11
  • BrickletAccelerometer.FUNCTION_LED_OFF = 12
BrickletAccelerometer.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:

  • BrickletAccelerometer.FUNCTION_SET_ACCELERATION_CALLBACK_PERIOD = 2
  • BrickletAccelerometer.FUNCTION_SET_ACCELERATION_CALLBACK_THRESHOLD = 4
  • BrickletAccelerometer.FUNCTION_SET_DEBOUNCE_PERIOD = 6
  • BrickletAccelerometer.FUNCTION_SET_CONFIGURATION = 9
  • BrickletAccelerometer.FUNCTION_LED_ON = 11
  • BrickletAccelerometer.FUNCTION_LED_OFF = 12
BrickletAccelerometer.SetResponseExpectedAll(responseExpected)
Input:
  • responseExpected – Type: Boolean

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

Constants

BrickletAccelerometer.DEVICE_IDENTIFIER

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

BrickletAccelerometer.DEVICE_DISPLAY_NAME

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