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

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

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

Thing

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

Channels

Illuminance

The illuminance of the ambient light sensor.

Type:
  • Number:Illuminance
UID:
  • tinkerforge:brickletambientlight:[UID]:BrickletAmbientLightIlluminance
Read only:
  • Yes
Unit:
  • Lux
Range:
  • 0 Lux to 900 Lux (Step 0.1 Lux)
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.
Analog Value

Returns the value as read by a 12-bit analog-to-digital converter.

Note

The value returned by Get Illuminance() is averaged over several samples to yield less noise, while Get Analog Value() gives back raw unfiltered analog values. The only reason to use Get Analog Value() is, if you need the full resolution of the analog-to-digital converter.

Also, the analog-to-digital converter covers three different ranges that are set dynamically depending on the light intensity. It is impossible to distinguish between these ranges with the analog value.

Type:
  • Number:Dimensionless
UID:
  • tinkerforge:brickletambientlight:[UID]:BrickletAmbientLightAnalogValue
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:brickletambientlight:[UID]")
val hwVersion = actions.brickletAmbientLightGetIdentity().get("hardwareVersion") as short[]
logInfo("Example", "Hardware version: " + hwVersion.get(0) + "." + hwVersion.get(1) + "." + hwVersion.get(2))

Basic Actions

brickletAmbientLightGetIlluminance()
Return Map:
  • illuminance – Type: int, Unit: 1/10 lx, Range: [0 to 9000]

Returns the illuminance of the ambient light sensor.

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

Advanced Actions

brickletAmbientLightGetAnalogValue()
Return Map:
  • value – Type: int, Range: [0 to 212 - 1]

Returns the value as read by a 12-bit analog-to-digital converter.

Note

The value returned by Illuminance is averaged over several samples to yield less noise, while Analog Value gives back raw unfiltered analog values. The only reason to use Analog Value is, if you need the full resolution of the analog-to-digital converter.

Also, the analog-to-digital converter covers three different ranges that are set dynamically depending on the light intensity. It is impossible to distinguish between these ranges with the analog value.

If you want the analog value periodically, it is recommended to use the Analog Value channel and set the period with the configuration of Analog Value.

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