Deutsch
English
Menu
Software / API Bindings / openHAB / API Reference and Examples / Bricklets / Accelerometer Bricklet 2.0

openHAB - Accelerometer Bricklet 2.0

Bemerkung

Die openHAB-Dokumentation ist nur auf Englisch verfügbar.

Warnung

The openHAB bindings are still in beta, but the development was stopped.

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

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

Thing

UID:
  • tinkerforge:brickletaccelerometerv2:[UID]
Required firmware version:
  • 2.0.2
Firmware update supported:
  • yes
Channels:
Actions:
Parameters:
  • Data Rate – Type: Choice, Default: 100Hz
  • The data rate of 0.781Hz to 25600Hz. Decreasing data rate or full scale range will also decrease the noise on the data.
  • Options: 0.781Hz, 1.563Hz, 3.125Hz, 6.2512Hz, 12.5Hz, 25Hz, 50Hz, 100Hz, 200Hz, 400Hz, 800Hz, 1600Hz, 3200Hz, 6400Hz, 12800Hz, 25600Hz

  • Full Scale Range – Type: Choice, Default: 2g
  • Full scale range of ±2g up to ±8g. Decreasing data rate or full scale range will also decrease the noise on the data.
  • Options: 2g, 4g, 8g

  • Info LED Mode – Type: Choice, Default: Off
  • Configures the info LED (marked as \"Force\" on the Bricklet) to be either turned off, turned on, or blink in heartbeat mode.
  • Options: Off, On, Show Heartbeat

  • IIR Filter – Type: boolean, Default: true
  • Enables/Disables the IIR filter.

  • Low Pass Filter Corner Frequency – Type: Choice, Default: Ninth
  • The low pass filter roll off corner frequency can be half or a ninth of the output data rate.
  • Options: Ninth, Half

  • Acceleration Update Interval – Type: integer, Default: 1000, Unit: ms, Min: 0, Max: 4294967295
  • Specifies the update interval for the acceleration in milliseconds. A value of 0 disables automatic updates.

  • Status LED Configuration – Type: Choice, Default: Show Status
  • The status LED configuration. By default the LED shows communication traffic between Brick and Bricklet, it flickers once for every 10 received data packets. You can also turn the LED permanently on/off or show a heartbeat. If the Bricklet is in bootloader mode, the LED is will show heartbeat by default.
  • Options: Off, On, Show Heartbeat, Show Status

Channels

Acceleration X

The acceleration in g (1g = 9.80665m/s²), not to be confused with grams.

Type:
  • Number:Acceleration
UID:
  • tinkerforge:brickletaccelerometerv2:[UID]:BrickletAccelerometerV2AccelerationX
Read only:
  • Yes
Unit:
  • Standard Gravity
Acceleration Y

The acceleration in g (1g = 9.80665m/s²), not to be confused with grams.

Type:
  • Number:Acceleration
UID:
  • tinkerforge:brickletaccelerometerv2:[UID]:BrickletAccelerometerV2AccelerationY
Read only:
  • Yes
Unit:
  • Standard Gravity
Acceleration Z

The acceleration in g (1g = 9.80665m/s²), not to be confused with grams.

Type:
  • Number:Acceleration
UID:
  • tinkerforge:brickletaccelerometerv2:[UID]:BrickletAccelerometerV2AccelerationZ
Read only:
  • Yes
Unit:
  • Standard Gravity

Actions

Actions can be used in rules by creating an action object. All actions return a Map<String, Object>. Returned values can be accessed by name, sometimes the type deduction needs some hints, as shown below:

val actions = getActions("tinkerforge", "tinkerforge:brickletaccelerometerv2:[UID]")
val hwVersion = actions.brickletAccelerometerV2GetIdentity().get("hardwareVersion") as short[]
logInfo("Example", "Hardware version: " + hwVersion.get(0) + "." + hwVersion.get(1) + "." + hwVersion.get(2))

Basic Actions

brickletAccelerometerV2GetAcceleration()
Return Map:
  • x – Type: int, Unit: 1/10000 gₙ, Range: ?
  • y – Type: int, Unit: 1/10000 gₙ, Range: ?
  • z – Type: int, Unit: 1/10000 gₙ, Range: ?

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

If you want to get the acceleration periodically, it is recommended to use the Acceleration X channel and set the period with the thing configuration.

brickletAccelerometerV2GetConfiguration()
Return Map:
  • dataRate – Type: int, Range: See constants, Default: 7
  • fullScale – Type: int, Range: See constants, Default: 0

Returns the configuration as set by the thing configuration.

The following constants are available for this function:

For dataRate:

  • val DATA_RATE_0_781HZ = 0
  • val DATA_RATE_1_563HZ = 1
  • val DATA_RATE_3_125HZ = 2
  • val DATA_RATE_6_2512HZ = 3
  • val DATA_RATE_12_5HZ = 4
  • val DATA_RATE_25HZ = 5
  • val DATA_RATE_50HZ = 6
  • val DATA_RATE_100HZ = 7
  • val DATA_RATE_200HZ = 8
  • val DATA_RATE_400HZ = 9
  • val DATA_RATE_800HZ = 10
  • val DATA_RATE_1600HZ = 11
  • val DATA_RATE_3200HZ = 12
  • val DATA_RATE_6400HZ = 13
  • val DATA_RATE_12800HZ = 14
  • val DATA_RATE_25600HZ = 15

For fullScale:

  • val FULL_SCALE_2G = 0
  • val FULL_SCALE_4G = 1
  • val FULL_SCALE_8G = 2
brickletAccelerometerV2GetInfoLEDConfig()
Return Map:
  • config – Type: int, Range: See constants, Default: 0

Returns the LED configuration as set by the thing configuration

The following constants are available for this function:

For config:

  • val INFO_LED_CONFIG_OFF = 0
  • val INFO_LED_CONFIG_ON = 1
  • val INFO_LED_CONFIG_SHOW_HEARTBEAT = 2

Advanced Actions

brickletAccelerometerV2GetFilterConfiguration()
Return Map:
  • iirBypass – Type: int, Range: See constants, Default: 0
  • lowPassFilter – Type: int, Range: See constants, Default: 0

Returns the configuration as set by the thing configuration.

The following constants are available for this function:

For iirBypass:

  • val IIR_BYPASS_APPLIED = 0
  • val IIR_BYPASS_BYPASSED = 1

For lowPassFilter:

  • val LOW_PASS_FILTER_NINTH = 0
  • val LOW_PASS_FILTER_HALF = 1

Neu in Version 2.0.2 (Plugin).

brickletAccelerometerV2GetChipTemperature()
Return Map:
  • temperature – Type: int, Unit: 1 °C, Range: [-215 to 215 - 1]

Returns the temperature as measured inside the microcontroller. The value returned is not the ambient temperature!

The temperature is only proportional to the real temperature and it has bad accuracy. Practically it is only useful as an indicator for temperature changes.

brickletAccelerometerV2GetStatusLEDConfig()
Return Map:
  • config – Type: int, Range: See constants, Default: 3

Returns the configuration as set by the thing configuration

The following constants are available for this function:

For config:

  • val STATUS_LED_CONFIG_OFF = 0
  • val STATUS_LED_CONFIG_ON = 1
  • val STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • val STATUS_LED_CONFIG_SHOW_STATUS = 3
brickletAccelerometerV2GetSPITFPErrorCount()
Return Map:
  • errorCountAckChecksum – Type: long, Range: [0 to 232 - 1]
  • errorCountMessageChecksum – Type: long, Range: [0 to 232 - 1]
  • errorCountFrame – Type: long, Range: [0 to 232 - 1]
  • errorCountOverflow – Type: long, Range: [0 to 232 - 1]

Returns the error count for the communication between Brick and Bricklet.

The errors are divided into

  • ACK checksum errors,
  • message checksum errors,
  • framing errors and
  • overflow errors.

The errors counts are for errors that occur on the Bricklet side. All Bricks have a similar function that returns the errors on the Brick side.

brickletAccelerometerV2Reset()

Calling this function will reset the Bricklet. All configurations will be lost.

After a reset you have to create new device objects, calling functions on the existing ones will result in undefined behavior!

brickletAccelerometerV2GetIdentity()
Return Map:
  • uid – Type: String, Length: up to 8
  • connectedUid – Type: String, Length: up to 8
  • position – Type: char, Range: ['a' to 'h', 'z']
  • hardwareVersion – Type: short[], Length: 3
    • 0: major – Type: short, Range: [0 to 255]
    • 1: minor – Type: short, Range: [0 to 255]
    • 2: revision – Type: short, Range: [0 to 255]
  • firmwareVersion – Type: short[], Length: 3
    • 0: major – Type: short, Range: [0 to 255]
    • 1: minor – Type: short, Range: [0 to 255]
    • 2: revision – Type: short, Range: [0 to 255]
  • deviceIdentifier – Type: int, 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). A Bricklet connected to an Isolator Bricklet is always at position 'z'.

The device identifier numbers can be found here. 

Internal Actions

brickletAccelerometerV2ReadUID()
Return Map:
  • uid – Type: long, Range: [0 to 232 - 1]

Returns the current UID as an integer. Encode as Base58 to get the usual string version.