Tinkerforge::BrickletUVLightV2 - Measures UV-A, UV-B and UV index
This constant is used to identify a UV Light Bricklet 2.0.
The get_identity() subroutine and the CALLBACK_ENUMERATE callback of the IP Connection have a device_identifier parameter to specify the Brick's or Bricklet's type.
This constant represents the display name of a UV Light Bricklet 2.0.
This constant is used with the register_callback() subroutine to specify the CALLBACK_UVA callback.
This constant is used with the register_callback() subroutine to specify the CALLBACK_UVB callback.
This constant is used with the register_callback() subroutine to specify the CALLBACK_UVI callback.
This constant is used with the get_response_expected(), set_response_expected() and set_response_expected_all() subroutines.
Creates an object with the unique device ID *uid* and adds it to the IP Connection *ipcon*.
Returns the UVA intensity of the sensor, the intensity is given in 1/10 mW/m². 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 :func:`Get UVI`.
If the sensor is saturated, then -1 is returned, see :func:`Set Configuration`.
If you want to get the intensity periodically, it is recommended to use the :cb:`UVA` callback and set the period with :func:`Set UVA Callback Configuration`.
If you want to get the value periodically, it is recommended to use the :cb:`UVA` callback. You can set the callback configuration with :func:`Set UVA Callback Configuration`.
The period in ms is the period with which the :cb:`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 :cb:`UVA` callback.
The following options are possible:
.. csv-table:: :header: "Option", "Description" :widths: 10, 100
"'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 default value is (0, false, 'x', 0, 0).
Returns the callback configuration as set by :func:`Set UVA Callback Configuration`.
Returns the UVB intensity of the sensor, the intensity is given in 1/10 mW/m². 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 :func:`Get UVI`.
If you want to get the intensity periodically, it is recommended to use the :cb:`UVB` callback and set the period with :func:`Set UVB Callback Configuration`.
If you want to get the value periodically, it is recommended to use the :cb:`UVB` callback. You can set the callback configuration with :func:`Set UVB Callback Configuration`.
The period in ms is the period with which the :cb:`UVB` callback is triggered periodically. A value of 0 turns the callback off.
The `option`-parameter together with min/max sets a threshold for the :cb:`UVB` callback.
Returns the callback configuration as set by :func:`Set UVB Callback Configuration`.
Returns the UV index of the sensor, the index is given in 1/10.
If you want to get the intensity periodically, it is recommended to use the :cb:`UVI` callback and set the period with :func:`Set UVI Callback Configuration`.
If you want to get the value periodically, it is recommended to use the :cb:`UVI` callback. You can set the callback configuration with :func:`Set UVI Callback Configuration`.
The period in ms is the period with which the :cb:`UVI` callback is triggered periodically. A value of 0 turns the callback off.
The `option`-parameter together with min/max sets a threshold for the :cb:`UVI` callback.
Returns the callback configuration as set by :func:`Set UVI Callback Configuration`.
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.
Default value: 400 ms.
Returns the configuration as set by :func:`Set Configuration`.
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.
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.
Returns the current bootloader mode, see :func:`Set Bootloader Mode`.
Sets the firmware pointer for :func:`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).
Writes 64 Bytes of firmware at the position as written by :func:`Set Write Firmware Pointer` before. The firmware is written to flash every 4 chunks.
You can only write firmware in bootloader mode.
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.
Returns the configuration as set by :func:`Set Status LED Config`
Returns the temperature in °C 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.
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!
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.
Returns the current UID as an integer. Encode as Base58 to get the usual string version.
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 :ref:`here <device_identifier>`. |device_identifier_constant|
To install Tinkerforge, copy and paste the appropriate command in to your terminal.
cpanm
cpanm Tinkerforge
CPAN shell
perl -MCPAN -e shell install Tinkerforge
For more information on module installation, please visit the detailed CPAN module installation guide.