Deutsch
English
Menu
Software / API Bindings / openHAB / API Reference and Examples / Bricklets (Discontinued) / Rotary Encoder Bricklet

openHAB - Rotary Encoder Bricklet

Warning

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

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.

Thing

UID:
  • tinkerforge:brickletrotaryencoder:[UID]
Required firmware version:
  • 2.0.0
Firmware update supported:
  • yes
Channels:
Actions:

Channels

Count

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.

Type:
  • Number:Dimensionless
UID:
  • tinkerforge:brickletrotaryencoder:[UID]:BrickletRotaryEncoderCount
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

Resets the counter to 0.

Type:
  • Commands (String)
UID:
  • tinkerforge:brickletrotaryencoder:[UID]:BrickletRotaryEncoderResetCounter
Read only:
  • No
Commands:
  • Accepts any string
Pressed

Triggers if the button is pressed or released

Type:
  • Trigger (system.rawbutton)
UID:
  • tinkerforge:brickletrotaryencoder:[UID]:BrickletRotaryEncoderPressed
Read only:
  • No

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

Basic Actions

brickletRotaryEncoderGetCount(boolean reset)
Parameters:
  • reset – Type: boolean
Return Map:
  • count – Type: int, Range: [-231 to 231 - 1]

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.

brickletRotaryEncoderIsPressed()
Return Map:
  • pressed – Type: boolean

Returns true if the button is pressed and false otherwise.

It is recommended to use the Pressed and Pressed channels to handle the button.

Advanced Actions

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