class Tinkerforge::BrickletUVLightV2
Measures UV-A, UV-B and UV index
Constants
- CALLBACK_UVA
This callback is triggered periodically according to the configuration set by
BrickletUVLightV2#set_uva_callback_configuration
.The parameter is the same as
BrickletUVLightV2#get_uva
.- CALLBACK_UVB
This callback is triggered periodically according to the configuration set by
BrickletUVLightV2#set_uvb_callback_configuration
.The parameter is the same as
BrickletUVLightV2#get_uvb
.- CALLBACK_UVI
This callback is triggered periodically according to the configuration set by
BrickletUVLightV2#set_uvi_callback_configuration
.The parameter is the same as
BrickletUVLightV2#get_uvi
.
Public Class Methods
Creates an object with the unique device ID uid
and adds it to the IP Connection ipcon
.
# File lib/tinkerforge/bricklet_uv_light_v2.rb, line 89 def initialize(uid, ipcon) super uid, ipcon, DEVICE_IDENTIFIER, DEVICE_DISPLAY_NAME @api_version = [2, 0, 0] @response_expected[FUNCTION_GET_UVA] = RESPONSE_EXPECTED_ALWAYS_TRUE @response_expected[FUNCTION_SET_UVA_CALLBACK_CONFIGURATION] = RESPONSE_EXPECTED_TRUE @response_expected[FUNCTION_GET_UVA_CALLBACK_CONFIGURATION] = RESPONSE_EXPECTED_ALWAYS_TRUE @response_expected[FUNCTION_GET_UVB] = RESPONSE_EXPECTED_ALWAYS_TRUE @response_expected[FUNCTION_SET_UVB_CALLBACK_CONFIGURATION] = RESPONSE_EXPECTED_TRUE @response_expected[FUNCTION_GET_UVB_CALLBACK_CONFIGURATION] = RESPONSE_EXPECTED_ALWAYS_TRUE @response_expected[FUNCTION_GET_UVI] = RESPONSE_EXPECTED_ALWAYS_TRUE @response_expected[FUNCTION_SET_UVI_CALLBACK_CONFIGURATION] = RESPONSE_EXPECTED_TRUE @response_expected[FUNCTION_GET_UVI_CALLBACK_CONFIGURATION] = RESPONSE_EXPECTED_ALWAYS_TRUE @response_expected[FUNCTION_SET_CONFIGURATION] = RESPONSE_EXPECTED_FALSE @response_expected[FUNCTION_GET_CONFIGURATION] = RESPONSE_EXPECTED_ALWAYS_TRUE @response_expected[FUNCTION_GET_SPITFP_ERROR_COUNT] = RESPONSE_EXPECTED_ALWAYS_TRUE @response_expected[FUNCTION_SET_BOOTLOADER_MODE] = RESPONSE_EXPECTED_ALWAYS_TRUE @response_expected[FUNCTION_GET_BOOTLOADER_MODE] = RESPONSE_EXPECTED_ALWAYS_TRUE @response_expected[FUNCTION_SET_WRITE_FIRMWARE_POINTER] = RESPONSE_EXPECTED_FALSE @response_expected[FUNCTION_WRITE_FIRMWARE] = RESPONSE_EXPECTED_ALWAYS_TRUE @response_expected[FUNCTION_SET_STATUS_LED_CONFIG] = RESPONSE_EXPECTED_FALSE @response_expected[FUNCTION_GET_STATUS_LED_CONFIG] = RESPONSE_EXPECTED_ALWAYS_TRUE @response_expected[FUNCTION_GET_CHIP_TEMPERATURE] = RESPONSE_EXPECTED_ALWAYS_TRUE @response_expected[FUNCTION_RESET] = RESPONSE_EXPECTED_FALSE @response_expected[FUNCTION_WRITE_UID] = RESPONSE_EXPECTED_FALSE @response_expected[FUNCTION_READ_UID] = RESPONSE_EXPECTED_ALWAYS_TRUE @response_expected[FUNCTION_GET_IDENTITY] = RESPONSE_EXPECTED_ALWAYS_TRUE @callback_formats[CALLBACK_UVA] = [12, 'l'] @callback_formats[CALLBACK_UVB] = [12, 'l'] @callback_formats[CALLBACK_UVI] = [12, 'l'] @ipcon.add_device self end
Public Instance Methods
Returns the current bootloader mode, see BrickletUVLightV2#set_bootloader_mode
.
# File lib/tinkerforge/bricklet_uv_light_v2.rb, line 355 def get_bootloader_mode check_validity send_request FUNCTION_GET_BOOTLOADER_MODE, [], '', 9, 'C' end
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.
# File lib/tinkerforge/bricklet_uv_light_v2.rb, line 413 def get_chip_temperature check_validity send_request FUNCTION_GET_CHIP_TEMPERATURE, [], '', 10, 's' end
Returns the configuration as set by BrickletUVLightV2#set_configuration
.
# File lib/tinkerforge/bricklet_uv_light_v2.rb, line 316 def get_configuration check_validity send_request FUNCTION_GET_CONFIGURATION, [], '', 9, 'C' end
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 :ref:`Isolator Bricklet <isolator_bricklet>` is always at position 'z'.
The device identifier numbers can be found :ref:`here <device_identifier>`. |device_identifier_constant|
# File lib/tinkerforge/bricklet_uv_light_v2.rb, line 460 def get_identity send_request FUNCTION_GET_IDENTITY, [], '', 33, 'Z8 Z8 k C3 C3 S' end
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.
# File lib/tinkerforge/bricklet_uv_light_v2.rb, line 333 def get_spitfp_error_count check_validity send_request FUNCTION_GET_SPITFP_ERROR_COUNT, [], '', 24, 'L L L L' end
Returns the configuration as set by BrickletUVLightV2#set_status_led_config
# File lib/tinkerforge/bricklet_uv_light_v2.rb, line 401 def get_status_led_config check_validity send_request FUNCTION_GET_STATUS_LED_CONFIG, [], '', 9, 'C' end
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 BrickletUVLightV2#get_uvi
.
If the sensor is saturated, then -1 is returned, see BrickletUVLightV2#set_configuration
.
If you want to get the intensity periodically, it is recommended to use the CALLBACK_UVA
callback and set the period with BrickletUVLightV2#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 BrickletUVLightV2#set_uva_callback_configuration
.
# File lib/tinkerforge/bricklet_uv_light_v2.rb, line 141 def get_uva check_validity send_request FUNCTION_GET_UVA, [], '', 12, 'l' end
Returns the callback configuration as set by BrickletUVLightV2#set_uva_callback_configuration
.
# File lib/tinkerforge/bricklet_uv_light_v2.rb, line 179 def get_uva_callback_configuration check_validity send_request FUNCTION_GET_UVA_CALLBACK_CONFIGURATION, [], '', 22, 'L ? k l l' end
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 BrickletUVLightV2#get_uvi
.
If the sensor is saturated, then -1 is returned, see BrickletUVLightV2#set_configuration
.
If you want to get the intensity periodically, it is recommended to use the CALLBACK_UVB
callback and set the period with BrickletUVLightV2#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 BrickletUVLightV2#set_uvb_callback_configuration
.
# File lib/tinkerforge/bricklet_uv_light_v2.rb, line 201 def get_uvb check_validity send_request FUNCTION_GET_UVB, [], '', 12, 'l' end
Returns the callback configuration as set by BrickletUVLightV2#set_uvb_callback_configuration
.
# File lib/tinkerforge/bricklet_uv_light_v2.rb, line 239 def get_uvb_callback_configuration check_validity send_request FUNCTION_GET_UVB_CALLBACK_CONFIGURATION, [], '', 22, 'L ? k l l' end
Returns the UV index of the sensor, the index is given in 1/10.
If the sensor is saturated, then -1 is returned, see BrickletUVLightV2#set_configuration
.
If you want to get the intensity periodically, it is recommended to use the CALLBACK_UVI
callback and set the period with BrickletUVLightV2#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 BrickletUVLightV2#set_uvi_callback_configuration
.
# File lib/tinkerforge/bricklet_uv_light_v2.rb, line 257 def get_uvi check_validity send_request FUNCTION_GET_UVI, [], '', 12, 'l' end
Returns the callback configuration as set by BrickletUVLightV2#set_uvi_callback_configuration
.
# File lib/tinkerforge/bricklet_uv_light_v2.rb, line 295 def get_uvi_callback_configuration check_validity send_request FUNCTION_GET_UVI_CALLBACK_CONFIGURATION, [], '', 22, 'L ? k l l' end
Returns the current UID as an integer. Encode as Base58
to get the usual string version.
# File lib/tinkerforge/bricklet_uv_light_v2.rb, line 444 def read_uid check_validity send_request FUNCTION_READ_UID, [], '', 12, 'L' end
Registers a callback with ID id
to the block block
.
# File lib/tinkerforge/bricklet_uv_light_v2.rb, line 465 def register_callback(id, &block) callback = block @registered_callbacks[id] = callback end
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!
# File lib/tinkerforge/bricklet_uv_light_v2.rb, line 425 def reset check_validity send_request FUNCTION_RESET, [], '', 8, '' end
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.
# File lib/tinkerforge/bricklet_uv_light_v2.rb, line 348 def set_bootloader_mode(mode) check_validity send_request FUNCTION_SET_BOOTLOADER_MODE, [mode], 'C', 9, 'C' end
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.
# File lib/tinkerforge/bricklet_uv_light_v2.rb, line 309 def set_configuration(integration_time) check_validity send_request FUNCTION_SET_CONFIGURATION, [integration_time], 'C', 8, '' end
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.
# File lib/tinkerforge/bricklet_uv_light_v2.rb, line 394 def set_status_led_config(config) check_validity send_request FUNCTION_SET_STATUS_LED_CONFIG, [config], 'C', 8, '' end
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.
# File lib/tinkerforge/bricklet_uv_light_v2.rb, line 172 def set_uva_callback_configuration(period, value_has_to_change, option, min, max) check_validity send_request FUNCTION_SET_UVA_CALLBACK_CONFIGURATION, [period, value_has_to_change, option, min, max], 'L ? k l l', 8, '' end
The period is the period with which the CALLBACK_UVB
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_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.
# File lib/tinkerforge/bricklet_uv_light_v2.rb, line 232 def set_uvb_callback_configuration(period, value_has_to_change, option, min, max) check_validity send_request FUNCTION_SET_UVB_CALLBACK_CONFIGURATION, [period, value_has_to_change, option, min, max], 'L ? k l l', 8, '' end
The period is the period with which the CALLBACK_UVI
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_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.
# File lib/tinkerforge/bricklet_uv_light_v2.rb, line 288 def set_uvi_callback_configuration(period, value_has_to_change, option, min, max) check_validity send_request FUNCTION_SET_UVI_CALLBACK_CONFIGURATION, [period, value_has_to_change, option, min, max], 'L ? k l l', 8, '' end
Sets the firmware pointer for BrickletUVLightV2#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.
# File lib/tinkerforge/bricklet_uv_light_v2.rb, line 367 def set_write_firmware_pointer(pointer) check_validity send_request FUNCTION_SET_WRITE_FIRMWARE_POINTER, [pointer], 'L', 8, '' end
Writes 64 Bytes of firmware at the position as written by BrickletUVLightV2#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.
# File lib/tinkerforge/bricklet_uv_light_v2.rb, line 381 def write_firmware(data) check_validity send_request FUNCTION_WRITE_FIRMWARE, [data], 'C64', 9, 'C' end
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.
# File lib/tinkerforge/bricklet_uv_light_v2.rb, line 436 def write_uid(uid) check_validity send_request FUNCTION_WRITE_UID, [uid], 'L', 8, '' end