openHAB - Hall Effect Bricklet 2.0

This is the description of the openHAB API bindings for the Hall Effect Bricklet 2.0. General information and technical specifications for the Hall Effect 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:bricklethalleffectv2:[UID]
Required firmware version:
  • 2.0.0
Firmware update supported:
  • yes
Channels:
Actions:
Parameters:
  • Low Threshold – Type: integer, Default: -2000, Min: -32768, Max: 32767
  • The low threshold in µT. If the measured magnetic flux density goes below the low threshold, the count of the counter is increased by 1.

  • High Threshold – Type: integer, Default: 2000, Min: -32768, Max: 32767
  • The high threshold in µT. If the measured magnetic flux density goes above the high threshold, the count of the counter is increased by 1.

  • Debounce Time – Type: integer, Default: 100000, Min: 0, Max: 1000000
  • The debounce time in µs is the minimum time between two count increments.

  • Status LED Config – 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

Counter

The current value of the counter.

Type:
  • Number:Dimensionless
UID:
  • tinkerforge:bricklethalleffectv2:[UID]:BrickletHallEffectV2Counter
Read only:
  • Yes
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.

  • Reset Counter On Update – Type: boolean, Default: false
  • Enabling this will reset the counter after OpenHAB reads its value. Use this if you want relative counts per update.
Magnetic Flux Density

The measured magnetic flux density.

Type:
  • Number:MagneticFluxDensity
UID:
  • tinkerforge:bricklethalleffectv2:[UID]:BrickletHallEffectV2MagneticFluxDensity
Read only:
  • Yes
Unit:
  • Tesla
Range:
  • -0.007 Tesla to 0.007 Tesla (Step 1e-06 Tesla)
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.

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

Basic Actions

brickletHallEffectV2GetMagneticFluxDensity()
Return Map:
  • magneticFluxDensity – Type: int, Unit: 1 µT, Range: [-7000 to 7000]

Returns the magnetic flux density (magnetic induction).

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

brickletHallEffectV2GetCounter(boolean resetCounter)
Parameters:
  • resetCounter – Type: boolean
Return Map:
  • count – Type: long, Range: [0 to 232 - 1]

Returns the current value of the counter.

You can configure the low/high thresholds and the debounce time with the thing configuration.

If you set reset counter to true, the count is set back to 0 directly after it is read.

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

brickletHallEffectV2GetCounterConfig()
Return Map:
  • highThreshold – Type: int, Unit: 1 µT, Range: [-215 to 215 - 1], Default: 2000
  • lowThreshold – Type: int, Unit: 1 µT, Range: [-215 to 215 - 1], Default: -2000
  • debounce – Type: long, Unit: 1 µs, Range: [0 to 1000000], Default: 100000

Returns the counter config as set by the thing configuration.

Advanced Actions

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

brickletHallEffectV2GetStatusLEDConfig()
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
brickletHallEffectV2GetSPITFPErrorCount()
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.

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

Internal Actions

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