Software / API Bindings / openHAB / API Reference and Examples / Bricklets / Tilt Bricklet

openHAB - Tilt Bricklet¶

Bemerkung

Die openHAB-Dokumentation ist nur auf Englisch verfügbar.

Warnung

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

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

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

Thing¶

UID:
tinkerforge:bricklettilt:[UID]

Required firmware version:
2.0.0

Firmware update supported:
yes

Channels:
Tilted

Vibrating

Actions:
GetTiltState

GetIdentity

UID:	tinkerforge:bricklettilt:[UID]
Required firmware version:	2.0.0
Firmware update supported:	yes
Channels:	Tilted Vibrating
Actions:	GetTiltState GetIdentity

Channels¶

Tilted¶

The current tilt state. Enabled if tilted, disabled if closed or vibrating.

Type:
Contact

UID:
tinkerforge:bricklettilt:[UID]:BrickletTiltTilted

Read only:
No

Type:	Contact
UID:	tinkerforge:bricklettilt:[UID]:BrickletTiltTilted
Read only:	No

Vibrating¶

The current vibration state. Enabled if vibration is detected, disabled if not. Vibration can only be detected if the bricklet is not tilted.

Type:
Contact

UID:
tinkerforge:bricklettilt:[UID]:BrickletTiltVibrating

Read only:
No

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

Basic Actions¶

brickletTiltGetTiltState()¶

Return Map:	state – Type: short, Range: See constants

Returns the current tilt state. The state can either be

0 = Closed: The ball in the tilt switch closes the circuit.
1 = Open: The ball in the tilt switch does not close the circuit.
2 = Closed Vibrating: The tilt switch is in motion (rapid change between open and close).

The following constants are available for this function:

For state:

val TILT_STATE_CLOSED = 0
val TILT_STATE_OPEN = 1
val TILT_STATE_CLOSED_VIBRATING = 2

Advanced Actions¶

brickletTiltGetIdentity()¶

Return Map:

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 2¹⁶ - 1]

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 2¹⁶ - 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.