openHAB - UV Light Bricklet 2.0

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

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

Thing

UID:
  • tinkerforge:brickletuvlightv2:[UID]
Required firmware version:
  • 2.0.0
Firmware update supported:
  • yes
Channels:
Actions:
Parameters:
  • Integration Time – Type: Choice, Default: 400ms
  • The integration time can be configured between 50 and 800 ms. With a shorter integration time the sensor reading updates more often but contains more noise. With a longer integration the sensor reading contains less noise but updates less often. With a longer integration time (especially 800 ms) and a higher UV intensity the sensor can be saturated. If this happens the UVA/UVB/UVI readings are all -1. In this case you need to choose a shorter integration time.
  • Options: 50ms, 100ms, 200ms, 400ms, 800ms

  • Status LED Config – Type: Choice, Default: Show Status
  • The status LED configuration. By default the LED shows communication traffic between Brick and Bricklet, it flickers once for every 10 received data packets. You can also turn the LED permanently on/off or show a heartbeat. If the Bricklet is in bootloader mode, the LED is will show heartbeat by default.
  • Options: Off, On, Show Heartbeat, Show Status

Channels

UV-A Intensity

The sensor has not weighted the intensity with the erythemal action spectrum to get the skin-affecting irradiation. Therefore, you cannot just divide the value by 250 to get the UVA index.

Type:
  • Number:Intensity
UID:
  • tinkerforge:brickletuvlightv2:[UID]:BrickletUVLightV2UVA
Read only:
  • Yes
Unit:
  • Irradiance
Range:
  • 0 Irradiance to 214748.3647 Irradiance (Step 9.999999995343387e-05 Irradiance)
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.
UV-B Intensity

The sensor has not weighted the intensity with the erythemal action spectrum to get the skin-affecting irradiation. Therefore, you cannot just divide the value by 250 to get the UVB index.

Type:
  • Number:Intensity
UID:
  • tinkerforge:brickletuvlightv2:[UID]:BrickletUVLightV2UVB
Read only:
  • Yes
Unit:
  • Irradiance
Range:
  • 0 Irradiance to 214748.3647 Irradiance (Step 9.999999995343387e-05 Irradiance)
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.
UV Index

Calculated UV Index

Type:
  • Number:Dimensionless
UID:
  • tinkerforge:brickletuvlightv2:[UID]:BrickletUVLightV2UVI
Read only:
  • Yes
Range:
  • 0 to 50 (Step 2.3283064365386963e-08)
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:brickletuvlightv2:[UID]")
val hwVersion = actions.brickletUVLightV2GetIdentity().get("hardwareVersion") as short[]
logInfo("Example", "Hardware version: " + hwVersion.get(0) + "." + hwVersion.get(1) + "." + hwVersion.get(2))

Basic Actions

brickletUVLightV2GetUVA()
Return Map:
  • uva – Type: int, Unit: 1/10 mW/m², Range: [-1 to 231 - 1]

Returns the UVA intensity of the sensor. The sensor has not weighted the intensity with the erythemal action spectrum to get the skin-affecting irradiation. Therefore, you cannot just divide the value by 250 to get the UVA index. To get the UV index use UV Index.

If the sensor is saturated, then -1 is returned, see the thing configuration.

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

If you want to get the value periodically, it is recommended to use the UV-A Intensity channel. You can set the channel configuration with the configuration of UV-A Intensity.

brickletUVLightV2GetUVB()
Return Map:
  • uvb – Type: int, Unit: 1/10 mW/m², Range: [-1 to 231 - 1]

Returns the UVB intensity of the sensor. The sensor has not weighted the intensity with the erythemal action spectrum to get the skin-affecting irradiation. Therefore, you cannot just divide the value by 250 to get the UVB index. To get the UV index use UV Index.

If the sensor is saturated, then -1 is returned, see the thing configuration.

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

If you want to get the value periodically, it is recommended to use the UV-B Intensity channel. You can set the channel configuration with the configuration of UV-B Intensity.

brickletUVLightV2GetUVI()
Return Map:
  • uvi – Type: int, Unit: 1/10 , Range: [-1 to 231 - 1]

Returns the UV index of the sensor, the index is given in 1/10.

If the sensor is saturated, then -1 is returned, see the thing configuration.

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

If you want to get the value periodically, it is recommended to use the UV Index channel. You can set the channel configuration with the configuration of UV Index.

Advanced Actions

brickletUVLightV2GetConfiguration()
Return Map:
  • integrationTime – Type: int, Range: See constants, Default: 3

Returns the configuration as set by the thing configuration.

The following constants are available for this function:

For integrationTime:

  • val INTEGRATION_TIME_50MS = 0
  • val INTEGRATION_TIME_100MS = 1
  • val INTEGRATION_TIME_200MS = 2
  • val INTEGRATION_TIME_400MS = 3
  • val INTEGRATION_TIME_800MS = 4
brickletUVLightV2GetChipTemperature()
Return Map:
  • temperature – Type: int, Unit: 1 °C, Range: [-215 to 215 - 1]

Returns the temperature as measured inside the microcontroller. The value returned is not the ambient temperature!

The temperature is only proportional to the real temperature and it has bad accuracy. Practically it is only useful as an indicator for temperature changes.

brickletUVLightV2GetStatusLEDConfig()
Return Map:
  • config – Type: int, Range: See constants, Default: 3

Returns the configuration as set by the thing configuration

The following constants are available for this function:

For config:

  • val STATUS_LED_CONFIG_OFF = 0
  • val STATUS_LED_CONFIG_ON = 1
  • val STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • val STATUS_LED_CONFIG_SHOW_STATUS = 3
brickletUVLightV2GetSPITFPErrorCount()
Return Map:
  • errorCountAckChecksum – Type: long, Range: [0 to 232 - 1]
  • errorCountMessageChecksum – Type: long, Range: [0 to 232 - 1]
  • errorCountFrame – Type: long, Range: [0 to 232 - 1]
  • errorCountOverflow – Type: long, Range: [0 to 232 - 1]

Returns the error count for the communication between Brick and Bricklet.

The errors are divided into

  • ACK checksum errors,
  • message checksum errors,
  • framing errors and
  • overflow errors.

The errors counts are for errors that occur on the Bricklet side. All Bricks have a similar function that returns the errors on the Brick side.

brickletUVLightV2GetIdentity()
Return Map:
  • uid – Type: String, Length: up to 8
  • connectedUid – Type: String, Length: up to 8
  • position – Type: char, Range: ['a' to 'h', 'i', '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). 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

Internal Actions

brickletUVLightV2ReadUID()
Return Map:
  • uid – Type: long, Range: [0 to 232 - 1]

Returns the current UID as an integer. Encode as Base58 to get the usual string version.