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 -- uint32

Returns the UV light intensity of the sensor, the intensity is given in 1/10 mW/m². 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 -- char[8]
  • connected_uid -- char[8]
  • position -- char
  • hardware_version -- uint8[3]
  • firmware_version -- uint8[3]
  • device_identifier -- uint16

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' or 'd'.

The device identifier numbers can be found here

Callback Configuration Functions

BrickletUVLight.set_uv_light_callback_period
Function ID:

2

Request:
  • period -- uint32
Response:

no response

Sets the period in ms 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.

The default value is 0.

BrickletUVLight.get_uv_light_callback_period
Function ID:

3

Request:

empty payload

Response:
  • period -- uint32

Returns the period as set by set_uv_light_callback_period.

BrickletUVLight.set_uv_light_callback_threshold
Function ID:

4

Request:
  • option -- char
  • min -- uint32
  • max -- uint32
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 default value is ('x', 0, 0).

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

  • x: off, for option
  • o: outside, for option
  • i: inside, for option
  • <: smaller, for option
  • >: greater, for option
BrickletUVLight.get_uv_light_callback_threshold
Function ID:

5

Request:

empty payload

Response:
  • option -- char
  • min -- uint32
  • max -- uint32

Returns the threshold as set by set_uv_light_callback_threshold.

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

  • x: off, for option
  • o: outside, for option
  • i: inside, for option
  • <: smaller, for option
  • >: greater, for option
BrickletUVLight.set_debounce_period
Function ID:

6

Request:
  • debounce -- uint32
Response:

no response

Sets the period in ms with which the threshold callbacks

are triggered, if the thresholds

keep being reached.

The default value is 100.

BrickletUVLight.get_debounce_period
Function ID:

7

Request:

empty payload

Response:
  • debounce -- uint32

Returns the debounce period as set by set_debounce_period.

Callbacks

BrickletUVLight.CALLBACK_UV_LIGHT
Function ID:

8

Response:
  • uv_light -- uint32

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 -- uint32

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.