openHAB - Hall Effect Bricklet

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

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

Thing

UID:
  • tinkerforge:bricklethalleffect:[UID]
Required firmware version:
  • 2.0.0
Firmware update supported:
  • yes
Channels:
Actions:
Parameters:
  • Edge Type – Type: Choice, Default: Rising
  • The edge type parameter configures if rising edges, falling edges or both are counted.
  • Options: Rising, Falling, Both

  • Debounce Time – Type: integer, Default: 100, Min: 0, Max: 255
  • The debounce time in ms.

Channels

Edge Count

The current value of the edge counter.

Type:
  • Number:Dimensionless
UID:
  • tinkerforge:bricklethalleffect:[UID]:BrickletHallEffectEdgeCount
Read only:
  • Yes
Parameters:
  • Refresh Count – Type: integer, Default: 1, Min: 0, Max: 4294967295
  • The edge count value will be refreshed every n-th edge.

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

Enabled if a magnetic field of 3.5 millitesla or greater is detected.

This channel will only update after the configured update interval, not on changed values.

Type:
  • Switch
UID:
  • tinkerforge:bricklethalleffect:[UID]:BrickletHallEffectMagneticFieldDetected
Read only:
  • No
Parameters:
  • Update Interval – Type: integer, Default: 1000, Unit: ms
  • 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:bricklethalleffect:[UID]")
val hwVersion = actions.brickletHallEffectGetIdentity().get("hardwareVersion") as short[]
logInfo("Example", "Hardware version: " + hwVersion.get(0) + "." + hwVersion.get(1) + "." + hwVersion.get(2))

Basic Actions

brickletHallEffectGetValue()
Return Map:
  • value – Type: boolean

Returns true if a magnetic field of 3.5 millitesla or greater is detected.

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

Returns the current value of the edge counter. You can configure edge type (rising, falling, both) that is counted with the thing configuration.

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

Advanced Actions

brickletHallEffectGetEdgeCountConfig()
Return Map:
  • edgeType – Type: short, Range: See constants, Default: 0
  • debounce – Type: short, Unit: 1 ms, Range: [0 to 255], Default: 100

Returns the edge type and debounce time as set by the thing configuration.

The following constants are available for this function:

For edgeType:

  • val EDGE_TYPE_RISING = 0
  • val EDGE_TYPE_FALLING = 1
  • val EDGE_TYPE_BOTH = 2
brickletHallEffectGetIdentity()
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