openHAB - Sound Intensity 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 Sound Intensity Bricklet. General information and technical specifications for the Sound Intensity Bricklet are summarized in its hardware description.

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

Thing¶

UID:
tinkerforge:brickletsoundintensity:[UID]

Required firmware version:
2.0.0

Firmware update supported:
yes

Channels:
Sound Intensity

Actions:
GetIntensity

GetIdentity

UID:	tinkerforge:brickletsoundintensity:[UID]
Required firmware version:	2.0.0
Firmware update supported:	yes
Channels:	Sound Intensity
Actions:	GetIntensity GetIdentity

Channels¶

Sound Intensity¶

The current sound intensity. The value has a range of 0 to 4095.

The value corresponds to the upper envelop of the signal of the microphone capsule.

Type:
Number:Dimensionless

UID:
tinkerforge:brickletsoundintensity:[UID]:BrickletSoundIntensityIntensity

Read only:
Yes

Range:
0 to 4095 (Step 1)

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.

Type:	Number:Dimensionless
UID:	tinkerforge:brickletsoundintensity:[UID]:BrickletSoundIntensityIntensity
Read only:	Yes
Range:	0 to 4095 (Step 1)
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.

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

Basic Actions¶

brickletSoundIntensityGetIntensity()¶

Return Map:	intensity – Type: int, Range: [0 to 2¹² - 1]

Returns the current sound intensity.

The value corresponds to the upper envelop of the signal of the microphone capsule.

If you want to get the intensity periodically, it is recommended to use the Sound Intensity channel and set the period with the configuration of Sound Intensity.

Advanced Actions¶

brickletSoundIntensityGetIdentity()¶

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.