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.
Required firmware version:
Firmware update supported:
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.
The current value of the edge counter.
- 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.
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.
- Update Interval – Type: integer, Default: 1000, Unit: ms
- Specifies the update interval in milliseconds. A value of 0 disables automatic updates.
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))
Returns true if a magnetic field of 3.5 millitesla or greater is detected.
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.
Returns the edge type and debounce time as set by the thing configuration.
The following constants are available for this function:
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). The Raspberry Pi HAT (Zero) Brick is always at position 'i' and the Bricklet connected to an Isolator Bricklet is always as position 'z'.
The device identifier numbers can be found here.