Specifications / TCP/IP Protocol / API / Bricks and Bricklets / Bricklets (Discontinued) / UV Light Bricklet

TCP/IP - UV Light Bricklet¶

This is the description of the TCP/IP protocol for the UV Light Bricklet. General information and technical specifications for the UV Light Bricklet are summarized in its hardware description.

API¶

A general description of the TCP/IP protocol structure can be found here.

Basic Functions¶

BrickletUVLight.get_uv_light¶

Function ID:	1
Request:	empty payload
Response:	uv_light – Type: uint32, Unit: 1/10 mW/m², Range: [0 to 3280]

Returns the UV light intensity of the sensor. The sensor has already weighted the intensity with the erythemal action spectrum to get the skin-affecting irradiation.

To get UV index you just have to divide the value by 250. For example, a UV light intensity of 500 is equivalent to an UV index of 2.

If you want to get the intensity periodically, it is recommended to use the CALLBACK_UV_LIGHT callback and set the period with set_uv_light_callback_period.

Advanced Functions¶

BrickletUVLight.get_identity¶

Function ID:	255
Request:	empty payload
Response:	uid – Type: char[8] connected_uid – Type: char[8] position – Type: char, Range: ['a' to 'h', 'z'] hardware_version – Type: uint8[3] 0: major – Type: uint8, Range: [0 to 255] 1: minor – Type: uint8, Range: [0 to 255] 2: revision – Type: uint8, Range: [0 to 255] firmware_version – Type: uint8[3] 0: major – Type: uint8, Range: [0 to 255] 1: minor – Type: uint8, Range: [0 to 255] 2: revision – Type: uint8, Range: [0 to 255] device_identifier – Type: uint16, 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.

Callback Configuration Functions¶

BrickletUVLight.set_uv_light_callback_period¶

Function ID:	2
Request:	period – Type: uint32, Unit: 1 ms, Range: [0 to 2³² - 1], Default: 0
Response:	no response

Sets the period with which the CALLBACK_UV_LIGHT callback is triggered periodically. A value of 0 turns the callback off.

The CALLBACK_UV_LIGHT callback is only triggered if the intensity has changed since the last triggering.

BrickletUVLight.get_uv_light_callback_period¶

Function ID:	3
Request:	empty payload
Response:	period – Type: uint32, Unit: 1 ms, Range: [0 to 2³² - 1], Default: 0

Returns the period as set by set_uv_light_callback_period.

BrickletUVLight.set_uv_light_callback_threshold¶

Function ID:	4
Request:	option – Type: char, Range: See meanings, Default: 'x' min – Type: uint32, Unit: 1/10 mW/m², Range: [0 to 2³² - 1], Default: 0 max – Type: uint32, Unit: 1/10 mW/m², Range: [0 to 2³² - 1], Default: 0
Response:	no response

Sets the thresholds for the CALLBACK_UV_LIGHT_REACHED callback.

The following options are possible:

Option	Description
'x'	Callback is turned off
'o'	Callback is triggered when the intensity is outside the min and max values
'i'	Callback is triggered when the intensity is inside the min and max values
'<'	Callback is triggered when the intensity is smaller than the min value (max is ignored)
'>'	Callback is triggered when the intensity is greater than the min value (max is ignored)

The following meanings are defined for the elements of this function:

For option:

'x' = Off
'o' = Outside
'i' = Inside
'<' = Smaller
'>' = Greater

BrickletUVLight.get_uv_light_callback_threshold¶

Function ID:	5
Request:	empty payload
Response:	option – Type: char, Range: See meanings, Default: 'x' min – Type: uint32, Unit: 1/10 mW/m², Range: [0 to 2³² - 1], Default: 0 max – Type: uint32, Unit: 1/10 mW/m², Range: [0 to 2³² - 1], Default: 0

Returns the threshold as set by set_uv_light_callback_threshold.

The following meanings are defined for the elements of this function:

For option:

'x' = Off
'o' = Outside
'i' = Inside
'<' = Smaller
'>' = Greater

BrickletUVLight.set_debounce_period¶

Function ID:	6
Request:	debounce – Type: uint32, Unit: 1 ms, Range: [0 to 2³² - 1], Default: 100
Response:	no response

Sets the period with which the threshold callbacks

CALLBACK_UV_LIGHT_REACHED,

are triggered, if the thresholds

set_uv_light_callback_threshold,

keep being reached.

BrickletUVLight.get_debounce_period¶

Function ID:	7
Request:	empty payload
Response:	debounce – Type: uint32, Unit: 1 ms, Range: [0 to 2³² - 1], Default: 100

Returns the debounce period as set by set_debounce_period.

Callbacks¶

BrickletUVLight.CALLBACK_UV_LIGHT¶

Function ID:	8
Response:	uv_light – Type: uint32, Unit: 1/10 mW/m², Range: [0 to 32800000]

This callback is triggered periodically with the period that is set by set_uv_light_callback_period. The response value is the UV Light intensity of the sensor.

The CALLBACK_UV_LIGHT callback is only triggered if the intensity has changed since the last triggering.

BrickletUVLight.CALLBACK_UV_LIGHT_REACHED¶

Function ID:	9
Response:	uv_light – Type: uint32, Unit: 1/10 mW/m², Range: [0 to 32800000]

This callback is triggered when the threshold as set by set_uv_light_callback_threshold is reached. The response value is the UV Light intensity of the sensor.

If the threshold keeps being reached, the callback is triggered periodically with the period as set by set_debounce_period.