openHAB - Load Cell Bricklet

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

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

Thing

UID:
  • tinkerforge:brickletloadcell:[UID]
Required firmware version:
  • 2.0.0
Firmware update supported:
  • yes
Channels:
Actions:
Parameters:
  • Moving Average – Type: integer, Default: 4, Min: 1, Max: 40
  • The length of a moving averaging for the weight value. Setting the length to 1 will turn the averaging off. With less averaging, there is more noise on the data.

Channels

Weight

The currently measured weight

Type:
  • Number:Mass
UID:
  • tinkerforge:brickletloadcell:[UID]:BrickletLoadCellWeight
Read only:
  • Yes
Unit:
  • Gram
Parameters:
  • Update Interval – Type: integer, Default: 1000, Unit: ms, Min: 0, Max: 4294967295
  • Specifies the update interval in milliseconds. A value of 0 disables automatic updates.
Tare

Sets the currently measured weight as tare weight.

Type:
  • Commands (String)
UID:
  • tinkerforge:brickletloadcell:[UID]:BrickletLoadCellTare
Read only:
  • No
Commands:
  • Accepts any string
LED

Activates/Deactivates the LED.

Type:
  • Switch
UID:
  • tinkerforge:brickletloadcell:[UID]:BrickletLoadCellLED
Read only:
  • No

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:brickletloadcell:[UID]")
val hwVersion = actions.brickletLoadCellGetIdentity().get("hardwareVersion") as short[]
logInfo("Example", "Hardware version: " + hwVersion.get(0) + "." + hwVersion.get(1) + "." + hwVersion.get(2))

Basic Actions

brickletLoadCellGetWeight()
Return Map:
  • weight – Type: int, Unit: 1 g, Range: [-231 to 231 - 1]

Returns the currently measured weight.

If you want to get the weight periodically, it is recommended to use the Weight channel and set the period with the configuration of Weight.

brickletLoadCellTare()

Sets the currently measured weight as tare weight.

brickletLoadCellLEDOn()

Turns the LED on.

brickletLoadCellLEDOff()

Turns the LED off.

brickletLoadCellIsLEDOn()
Return Map:
  • on – Type: boolean, Default: false

Returns true if the led is on, false otherwise.

Advanced Actions

brickletLoadCellGetMovingAverage()
Return Map:
  • average – Type: short, Range: [1 to 40], Default: 4

Returns the length moving average as set by the thing configuration.

brickletLoadCellGetConfiguration()
Return Map:
  • rate – Type: short, Range: See constants, Default: 0
  • gain – Type: short, Range: See constants, Default: 0

Returns the configuration as set by This function is not available in openHAB. Please use Brick Viewer to change persistant device settings.

The following constants are available for this function:

For rate:

  • val RATE_10HZ = 0
  • val RATE_80HZ = 1

For gain:

  • val GAIN_128X = 0
  • val GAIN_64X = 1
  • val GAIN_32X = 2
brickletLoadCellGetIdentity()
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 as position 'z'.

The device identifier numbers can be found here