This is the description of the LabVIEW API bindings 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.
An installation guide for the LabVIEW API bindings is part of their general description.
The example code below is Public Domain (CC0 1.0).
Generally, every function of the LabVIEW bindings that outputs a value can
report a Tinkerforge.TimeoutException
. This error gets reported if the
device did not respond. If a cable based connection is used, it is
unlikely that this exception gets thrown (assuming nobody plugs the
device out). However, if a wireless connection is used, timeouts will occur
if the distance to the device gets too big.
The namespace for all Brick/Bricklet bindings and the IPConnection is
Tinkerforge.*
.
BrickletUVLightV2
(uid, ipcon) → uvLightV2¶Input: |
|
---|---|
Output: |
|
Creates an object with the unique device ID uid
.
This object can then be used after the IP Connection is connected.
BrickletUVLightV2.
GetUVA
() → uva¶Output: |
|
---|
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
GetUVI()
.
If the sensor is saturated, then -1 is returned, see SetConfiguration()
.
If you want to get the intensity periodically, it is recommended to use the
UVACallback
callback and set the period with
SetUVACallbackConfiguration()
.
If you want to get the value periodically, it is recommended to use the
UVACallback
callback. You can set the callback configuration
with SetUVACallbackConfiguration()
.
BrickletUVLightV2.
GetUVB
() → uvb¶Output: |
|
---|
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
GetUVI()
.
If the sensor is saturated, then -1 is returned, see SetConfiguration()
.
If you want to get the intensity periodically, it is recommended to use the
UVBCallback
callback and set the period with
SetUVBCallbackConfiguration()
.
If you want to get the value periodically, it is recommended to use the
UVBCallback
callback. You can set the callback configuration
with SetUVBCallbackConfiguration()
.
BrickletUVLightV2.
GetUVI
() → uvi¶Output: |
|
---|
Returns the UV index of the sensor, the index is given in 1/10.
If the sensor is saturated, then -1 is returned, see SetConfiguration()
.
If you want to get the intensity periodically, it is recommended to use the
UVICallback
callback and set the period with
SetUVICallbackConfiguration()
.
If you want to get the value periodically, it is recommended to use the
UVICallback
callback. You can set the callback configuration
with SetUVICallbackConfiguration()
.
BrickletUVLightV2.
SetConfiguration
(integrationTime)¶Input: |
|
---|
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 constants are available for this function:
For integrationTime:
BrickletUVLightV2.
GetConfiguration
() → integrationTime¶Output: |
|
---|
Returns the configuration as set by SetConfiguration()
.
The following constants are available for this function:
For integrationTime:
BrickletUVLightV2.
GetSPITFPErrorCount
() → errorCountAckChecksum, errorCountMessageChecksum, errorCountFrame, errorCountOverflow¶Output: |
|
---|
Returns the error count for the communication between Brick and Bricklet.
The errors are divided into
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.
SetStatusLEDConfig
(config)¶Input: |
|
---|
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 constants are available for this function:
For config:
BrickletUVLightV2.
GetStatusLEDConfig
() → config¶Output: |
|
---|
Returns the configuration as set by SetStatusLEDConfig()
The following constants are available for this function:
For config:
BrickletUVLightV2.
GetChipTemperature
() → temperature¶Output: |
|
---|
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
()¶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.
GetIdentity
() → uid, connectedUid, position, hardwareVersion, firmwareVersion, deviceIdentifier¶Output: |
|
---|
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. There is also a constant for the device identifier of this Bricklet.
BrickletUVLightV2.
SetUVACallbackConfiguration
(period, valueHasToChange, option, min, max)¶Input: |
|
---|
The period is the period with which the UVACallback
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 UVACallback
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 constants are available for this function:
For option:
BrickletUVLightV2.
GetUVACallbackConfiguration
() → period, valueHasToChange, option, min, max¶Output: |
|
---|
Returns the callback configuration as set by SetUVACallbackConfiguration()
.
The following constants are available for this function:
For option:
BrickletUVLightV2.
SetUVBCallbackConfiguration
(period, valueHasToChange, option, min, max)¶Input: |
|
---|
The period is the period with which the UVBCallback
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 UVBCallback
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 constants are available for this function:
For option:
BrickletUVLightV2.
GetUVBCallbackConfiguration
() → period, valueHasToChange, option, min, max¶Output: |
|
---|
Returns the callback configuration as set by SetUVBCallbackConfiguration()
.
The following constants are available for this function:
For option:
BrickletUVLightV2.
SetUVICallbackConfiguration
(period, valueHasToChange, option, min, max)¶Input: |
|
---|
The period is the period with which the UVICallback
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 UVICallback
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 constants are available for this function:
For option:
BrickletUVLightV2.
GetUVICallbackConfiguration
() → period, valueHasToChange, option, min, max¶Output: |
|
---|
Returns the callback configuration as set by SetUVICallbackConfiguration()
.
The following constants are available for this function:
For option:
Callbacks can be registered to receive time critical or recurring data from the device. The registration is done by assigning a function to a callback property of the device object. The available callback property and their type of parameters are described below.
Note
Using callbacks for recurring events is always preferred compared to using getters. It will use less USB bandwidth and the latency will be a lot better, since there is no round trip time.
BrickletUVLightV2.
UVACallback
→ sender, uva¶Callback Output: |
|
---|
This callback is triggered periodically according to the configuration set by
SetUVACallbackConfiguration()
.
The parameter is the same as GetUVA()
.
BrickletUVLightV2.
UVBCallback
→ sender, uvb¶Callback Output: |
|
---|
This callback is triggered periodically according to the configuration set by
SetUVBCallbackConfiguration()
.
The parameter is the same as GetUVB()
.
BrickletUVLightV2.
UVICallback
→ sender, uvi¶Callback Output: |
|
---|
This callback is triggered periodically according to the configuration set by
SetUVICallbackConfiguration()
.
The parameter is the same as GetUVI()
.
Virtual functions don't communicate with the device itself, but operate only on the API bindings device object. They can be called without the corresponding IP Connection object being connected.
BrickletUVLightV2.
GetAPIVersion
() → apiVersion¶Output: |
|
---|
Returns the version of the API definition implemented by this API bindings. This is neither the release version of this API bindings nor does it tell you anything about the represented Brick or Bricklet.
BrickletUVLightV2.
GetResponseExpected
(functionId) → responseExpected¶Input: |
|
---|---|
Output: |
|
Returns the response expected flag for the function specified by the function ID parameter. It is true if the function is expected to send a response, false otherwise.
For getter functions this is enabled by default and cannot be disabled,
because those functions will always send a response. For callback configuration
functions it is enabled by default too, but can be disabled by
SetResponseExpected()
. For setter functions it is disabled by default
and can be enabled.
Enabling the response expected flag for a setter function allows to detect timeouts and other error conditions calls of this setter as well. The device will then send a response for this purpose. If this flag is disabled for a setter function then no response is sent and errors are silently ignored, because they cannot be detected.
The following constants are available for this function:
For functionId:
BrickletUVLightV2.
SetResponseExpected
(functionId, responseExpected)¶Input: |
|
---|
Changes the response expected flag of the function specified by the function ID parameter. This flag can only be changed for setter (default value: false) and callback configuration functions (default value: true). For getter functions it is always enabled.
Enabling the response expected flag for a setter function allows to detect timeouts and other error conditions calls of this setter as well. The device will then send a response for this purpose. If this flag is disabled for a setter function then no response is sent and errors are silently ignored, because they cannot be detected.
The following constants are available for this function:
For functionId:
BrickletUVLightV2.
SetResponseExpectedAll
(responseExpected)¶Input: |
|
---|
Changes the response expected flag for all setter and callback configuration functions of this device at once.
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.
SetBootloaderMode
(mode) → status¶Input: |
|
---|---|
Output: |
|
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 constants are available for this function:
For mode:
For status:
BrickletUVLightV2.
GetBootloaderMode
() → mode¶Output: |
|
---|
Returns the current bootloader mode, see SetBootloaderMode()
.
The following constants are available for this function:
For mode:
BrickletUVLightV2.
SetWriteFirmwarePointer
(pointer)¶Input: |
|
---|
Sets the firmware pointer for WriteFirmware()
. 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.
WriteFirmware
(data) → status¶Input: |
|
---|---|
Output: |
|
Writes 64 Bytes of firmware at the position as written by
SetWriteFirmwarePointer()
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.
WriteUID
(uid)¶Input: |
|
---|
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.
ReadUID
() → uid¶Output: |
|
---|
Returns the current UID as an integer. Encode as Base58 to get the usual string version.
BrickletUVLightV2.
DEVICE_IDENTIFIER
¶This constant is used to identify a UV Light Bricklet 2.0.
The GetIdentity()
function and the
IPConnection.EnumerateCallback
callback of the IP Connection have a deviceIdentifier
parameter to specify
the Brick's or Bricklet's type.
BrickletUVLightV2.
DEVICE_DISPLAY_NAME
¶This constant represents the human readable name of a UV Light Bricklet 2.0.