This is the description of the openHAB API bindings for the Rotary Encoder Bricklet. General information and technical specifications for the Rotary Encoder Bricklet are summarized in its hardware description.
An installation guide for the openHAB API bindings is part of their general description.
The current count of the encoder. The encoder has 24 steps per rotation. Turning the encoder to the left decrements the counter, so a negative count is possible.
- 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.
Resets the counter to 0.
- Commands (String)
- Accepts any string
Triggers if the button is pressed or released
- Trigger (system.rawbutton)
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:brickletrotaryencoder:[UID]") val hwVersion = actions.brickletRotaryEncoderGetIdentity().get("hardwareVersion") as short logInfo("Example", "Hardware version: " + hwVersion.get(0) + "." + hwVersion.get(1) + "." + hwVersion.get(2))
Returns the current count of the encoder. If you set reset to true, the count is set back to 0 directly after the current count is read.
The encoder has 24 steps per rotation
Turning the encoder to the left decrements the counter, so a negative count is possible.
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.