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

openHAB - Load Cell Bricklet 2.0

Warning

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

This is the description of the openHAB API bindings for the Load Cell Bricklet 2.0. General information and technical specifications for the Load Cell 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:brickletloadcellv2:[UID]
Required firmware version:
  • 2.0.0
Firmware update supported:
  • yes
Channels:
Actions:
Parameters:
  • Moving Average Length – Type: integer, Default: 4, Min: 1, Max: 100
  • 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.

  • Measurement Rate – Type: Choice, Default: 10Hz
  • The rate can be either 10Hz or 80Hz. A faster rate will produce more noise.
  • Options: 10Hz, 80Hz

  • Gain – Type: Choice, Default: 128x
  • The gain can be 128x, 64x or 32x. It represents a measurement range of ±20mV, ±40mV and ±80mV respectively. The Load Cell Bricklet uses an excitation voltage of 5V and most load cells use an output of 2mV/V. That means the voltage range is ±15mV for most load cells (i.e. gain of 128x is best). If you don't know what all of this means you should keep it at 128x, it will most likely be correct.
  • Options: 128x, 64x, 32x

  • Info LED – Type: Choice, Default: Off
  • Configures the info LED to be either turned off, turned on, or blink in heartbeat mode.
  • Options: Off, On, Show Heartbeat

  • 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

Weight

The measured weight

Type:
  • Number:Mass
UID:
  • tinkerforge:brickletloadcellv2:[UID]:BrickletLoadCellV2Weight
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:brickletloadcellv2:[UID]:BrickletLoadCellV2Tare
Read only:
  • No
Commands:
  • Accepts any string

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

Basic Actions

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

Returns the currently measured weight.

If you want to get the value periodically, it is recommended to use the Weight channel. You can set the channel configuration with the configuration of Weight.

brickletLoadCellV2GetInfoLEDConfig()
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
brickletLoadCellV2Tare()

Sets the currently measured weight as tare weight.

Advanced Actions

brickletLoadCellV2GetMovingAverage()
Return Map:
  • average – Type: int, Range: [1 to 100], Default: 4

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

brickletLoadCellV2GetConfiguration()
Return Map:
  • rate – Type: int, Range: See constants, Default: 0
  • gain – 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 rate:

  • val RATE_10HZ = 0
  • val RATE_80HZ = 1

For gain:

  • val GAIN_128X = 0
  • val GAIN_64X = 1
  • val GAIN_32X = 2
brickletLoadCellV2GetChipTemperature()
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.

brickletLoadCellV2GetStatusLEDConfig()
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
brickletLoadCellV2GetSPITFPErrorCount()
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.

brickletLoadCellV2Reset()

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!

brickletLoadCellV2GetIdentity()
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

brickletLoadCellV2ReadUID()
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.