Specifications / TCP/IP Protocol / API / Bricks and Bricklets / Bricklets / UV Light Bricklet 2.0

TCP/IP - UV Light Bricklet 2.0¶

This is the description of the TCP/IP protocol 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.

API¶

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

Basic Functions¶

BrickletUVLightV2.get_uva¶

Function ID:	1
Request:	empty payload
Response:	uva – Type: int32, Unit: 1/10 mW/m², Range: [-1 to 2³¹ - 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 get_uvi.

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

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

If you want to get the value periodically, it is recommended to use the CALLBACK_UVA callback. You can set the callback configuration with set_uva_callback_configuration.

BrickletUVLightV2.get_uvb¶

Function ID:	5
Request:	empty payload
Response:	uvb – Type: int32, Unit: 1/10 mW/m², Range: [-1 to 2³¹ - 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 get_uvi.

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

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

If you want to get the value periodically, it is recommended to use the CALLBACK_UVB callback. You can set the callback configuration with set_uvb_callback_configuration.

BrickletUVLightV2.get_uvi¶

Function ID:	9
Request:	empty payload
Response:	uvi – Type: int32, Unit: 1/10 , Range: [-1 to 2³¹ - 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 set_configuration.

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

If you want to get the value periodically, it is recommended to use the CALLBACK_UVI callback. You can set the callback configuration with set_uvi_callback_configuration.

Advanced Functions¶

BrickletUVLightV2.set_configuration¶

Function ID:	13
Request:	integration_time – Type: uint8, Range: See meanings, Default: 3
Response:	no response

Sets the configuration of the sensor. 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.

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

For integration_time:

0 = 50ms
1 = 100ms
2 = 200ms
3 = 400ms
4 = 800ms

BrickletUVLightV2.get_configuration¶

Function ID:	14
Request:	empty payload
Response:	integration_time – Type: uint8, Range: See meanings, Default: 3

Returns the configuration as set by set_configuration.

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

For integration_time:

0 = 50ms
1 = 100ms
2 = 200ms
3 = 400ms
4 = 800ms

BrickletUVLightV2.get_spitfp_error_count¶

Function ID:	234
Request:	empty payload
Response:	error_count_ack_checksum – Type: uint32, Range: [0 to 2³² - 1] error_count_message_checksum – Type: uint32, Range: [0 to 2³² - 1] error_count_frame – Type: uint32, Range: [0 to 2³² - 1] error_count_overflow – Type: uint32, Range: [0 to 2³² - 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.

BrickletUVLightV2.set_status_led_config¶

Function ID:	239
Request:	config – Type: uint8, Range: See meanings, Default: 3
Response:	no response

Sets 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.

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

For config:

0 = Off
1 = On
2 = Show Heartbeat
3 = Show Status

BrickletUVLightV2.get_status_led_config¶

Function ID:	240
Request:	empty payload
Response:	config – Type: uint8, Range: See meanings, Default: 3

Returns the configuration as set by set_status_led_config

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

For config:

0 = Off
1 = On
2 = Show Heartbeat
3 = Show Status

BrickletUVLightV2.get_chip_temperature¶

Function ID:	242
Request:	empty payload
Response:	temperature – Type: int16, Unit: 1 °C, Range: [-2¹⁵ to 2¹⁵ - 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.

BrickletUVLightV2.reset¶

Function ID:	243
Request:	empty payload
Response:	no response

Calling this function will reset the Bricklet. All configurations will be lost.

After a reset you have to create new device objects, calling functions on the existing ones will result in undefined behavior!

BrickletUVLightV2.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¶

BrickletUVLightV2.set_uva_callback_configuration¶

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

The period is the period with which the CALLBACK_UVA callback is triggered periodically. A value of 0 turns the callback off.

If the value has to change-parameter is set to true, the callback is only triggered after the value has changed. If the value didn't change within the period, the callback is triggered immediately on change.

If it is set to false, the callback is continuously triggered with the period, independent of the value.

It is furthermore possible to constrain the callback with thresholds.

The option-parameter together with min/max sets a threshold for the CALLBACK_UVA callback.

The following options are possible:

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

If the option is set to 'x' (threshold turned off) the callback is triggered with the fixed period.

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

For option:

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

BrickletUVLightV2.get_uva_callback_configuration¶

Function ID:	3
Request:	empty payload
Response:	period – Type: uint32, Unit: 1 ms, Range: [0 to 2³² - 1], Default: 0 value_has_to_change – Type: bool, Default: false option – Type: char, Range: See meanings, Default: 'x' min – Type: int32, Unit: 1/10 mW/m², Range: [-2³¹ to 2³¹ - 1], Default: 0 max – Type: int32, Unit: 1/10 mW/m², Range: [-2³¹ to 2³¹ - 1], Default: 0

Returns the callback configuration as set by set_uva_callback_configuration.

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

For option:

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

BrickletUVLightV2.set_uvb_callback_configuration¶

Function ID:	6
Request:	period – Type: uint32, Unit: 1 ms, Range: [0 to 2³² - 1], Default: 0 value_has_to_change – Type: bool, Default: false option – Type: char, Range: See meanings, Default: 'x' min – Type: int32, Unit: 1/10 mW/m², Range: [-2³¹ to 2³¹ - 1], Default: 0 max – Type: int32, Unit: 1/10 mW/m², Range: [-2³¹ to 2³¹ - 1], Default: 0
Response:	no response

The period is the period with which the CALLBACK_UVB callback is triggered periodically. A value of 0 turns the callback off.

If it is set to false, the callback is continuously triggered with the period, independent of the value.

It is furthermore possible to constrain the callback with thresholds.

The option-parameter together with min/max sets a threshold for the CALLBACK_UVB callback.

The following options are possible:

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

If the option is set to 'x' (threshold turned off) the callback is triggered with the fixed period.

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

For option:

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

BrickletUVLightV2.get_uvb_callback_configuration¶

Function ID:	7
Request:	empty payload
Response:	period – Type: uint32, Unit: 1 ms, Range: [0 to 2³² - 1], Default: 0 value_has_to_change – Type: bool, Default: false option – Type: char, Range: See meanings, Default: 'x' min – Type: int32, Unit: 1/10 mW/m², Range: [-2³¹ to 2³¹ - 1], Default: 0 max – Type: int32, Unit: 1/10 mW/m², Range: [-2³¹ to 2³¹ - 1], Default: 0

Returns the callback configuration as set by set_uvb_callback_configuration.

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

For option:

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

BrickletUVLightV2.set_uvi_callback_configuration¶

Function ID:	10
Request:	period – Type: uint32, Unit: 1 ms, Range: [0 to 2³² - 1], Default: 0 value_has_to_change – Type: bool, Default: false option – Type: char, Range: See meanings, Default: 'x' min – Type: int32, Unit: 1/10 , Range: [-2³¹ to 2³¹ - 1], Default: 0 max – Type: int32, Unit: 1/10 , Range: [-2³¹ to 2³¹ - 1], Default: 0
Response:	no response

The period is the period with which the CALLBACK_UVI callback is triggered periodically. A value of 0 turns the callback off.

If it is set to false, the callback is continuously triggered with the period, independent of the value.

It is furthermore possible to constrain the callback with thresholds.

The option-parameter together with min/max sets a threshold for the CALLBACK_UVI callback.

The following options are possible:

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

If the option is set to 'x' (threshold turned off) the callback is triggered with the fixed period.

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

For option:

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

BrickletUVLightV2.get_uvi_callback_configuration¶

Function ID:	11
Request:	empty payload
Response:	period – Type: uint32, Unit: 1 ms, Range: [0 to 2³² - 1], Default: 0 value_has_to_change – Type: bool, Default: false option – Type: char, Range: See meanings, Default: 'x' min – Type: int32, Unit: 1/10 , Range: [-2³¹ to 2³¹ - 1], Default: 0 max – Type: int32, Unit: 1/10 , Range: [-2³¹ to 2³¹ - 1], Default: 0

Returns the callback configuration as set by set_uvi_callback_configuration.

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

For option:

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

Callbacks¶

BrickletUVLightV2.CALLBACK_UVA¶

Function ID:	4
Response:	uva – Type: int32, Unit: 1/10 mW/m², Range: [-1 to 2³¹ - 1]

This callback is triggered periodically according to the configuration set by set_uva_callback_configuration.

The response value is the same as get_uva.

BrickletUVLightV2.CALLBACK_UVB¶

Function ID:	8
Response:	uvb – Type: int32, Unit: 1/10 mW/m², Range: [-1 to 2³¹ - 1]

This callback is triggered periodically according to the configuration set by set_uvb_callback_configuration.

The response value is the same as get_uvb.

BrickletUVLightV2.CALLBACK_UVI¶

Function ID:	12
Response:	uvi – Type: int32, Unit: 1/10 , Range: [-1 to 2³¹ - 1]

This callback is triggered periodically according to the configuration set by set_uvi_callback_configuration.

The response value is the same as get_uvi.

Internal Functions¶

Internal functions are used for maintenance tasks such as flashing a new firmware of changing the UID of a Bricklet. These task should be performed using Brick Viewer instead of using the internal functions directly.

BrickletUVLightV2.set_bootloader_mode¶

Function ID:	235
Request:	mode – Type: uint8, Range: See meanings
Response:	status – Type: uint8, Range: See meanings

Sets the bootloader mode and returns the status after the requested mode change was instigated.

You can change from bootloader mode to firmware mode and vice versa. A change from bootloader mode to firmware mode will only take place if the entry function, device identifier and CRC are present and correct.

This function is used by Brick Viewer during flashing. It should not be necessary to call it in a normal user program.

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

For mode:

0 = Bootloader
1 = Firmware
2 = Bootloader Wait For Reboot
3 = Firmware Wait For Reboot
4 = Firmware Wait For Erase And Reboot

For status:

0 = OK
1 = Invalid Mode
2 = No Change
3 = Entry Function Not Present
4 = Device Identifier Incorrect
5 = CRC Mismatch

BrickletUVLightV2.get_bootloader_mode¶

Function ID:	236
Request:	empty payload
Response:	mode – Type: uint8, Range: See meanings

Returns the current bootloader mode, see set_bootloader_mode.

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

For mode:

0 = Bootloader
1 = Firmware
2 = Bootloader Wait For Reboot
3 = Firmware Wait For Reboot
4 = Firmware Wait For Erase And Reboot

BrickletUVLightV2.set_write_firmware_pointer¶

Function ID:	237
Request:	pointer – Type: uint32, Unit: 1 B, Range: [0 to 2³² - 1]
Response:	no response

Sets the firmware pointer for write_firmware. The pointer has to be increased by chunks of size 64. The data is written to flash every 4 chunks (which equals to one page of size 256).

This function is used by Brick Viewer during flashing. It should not be necessary to call it in a normal user program.

BrickletUVLightV2.write_firmware¶

Function ID:	238
Request:	data – Type: uint8[64], Range: [0 to 255]
Response:	status – Type: uint8, Range: [0 to 255]

Writes 64 Bytes of firmware at the position as written by set_write_firmware_pointer before. The firmware is written to flash every 4 chunks.

You can only write firmware in bootloader mode.

This function is used by Brick Viewer during flashing. It should not be necessary to call it in a normal user program.

BrickletUVLightV2.write_uid¶

Function ID:	248
Request:	uid – Type: uint32, Range: [0 to 2³² - 1]
Response:	no response

Writes a new UID into flash. If you want to set a new UID you have to decode the Base58 encoded UID string into an integer first.

We recommend that you use Brick Viewer to change the UID.

BrickletUVLightV2.read_uid¶

Function ID:	249
Request:	empty payload
Response:	uid – Type: uint32, Range: [0 to 2³² - 1]

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