Package com.tinkerforge
Class BrickletUVLightV2
- java.lang.Object
-
- com.tinkerforge.DeviceBase
-
- com.tinkerforge.Device
-
- com.tinkerforge.BrickletUVLightV2
-
public class BrickletUVLightV2 extends Device
Measures UV-A, UV-B and UV index
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description class
BrickletUVLightV2.SPITFPErrorCount
class
BrickletUVLightV2.UVACallbackConfiguration
static interface
BrickletUVLightV2.UVAListener
This listener is triggered periodically according to the configuration set bysetUVACallbackConfiguration(long, boolean, char, int, int)
.class
BrickletUVLightV2.UVBCallbackConfiguration
static interface
BrickletUVLightV2.UVBListener
This listener is triggered periodically according to the configuration set bysetUVBCallbackConfiguration(long, boolean, char, int, int)
.class
BrickletUVLightV2.UVICallbackConfiguration
static interface
BrickletUVLightV2.UVIListener
This listener is triggered periodically according to the configuration set bysetUVICallbackConfiguration(long, boolean, char, int, int)
.-
Nested classes/interfaces inherited from class com.tinkerforge.Device
Device.Identity
-
-
Field Summary
-
Constructor Summary
Constructors Constructor Description BrickletUVLightV2(java.lang.String uid, IPConnection ipcon)
Creates an object with the unique device ID \c uid.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
addUVAListener(BrickletUVLightV2.UVAListener listener)
Adds a UVA listener.void
addUVBListener(BrickletUVLightV2.UVBListener listener)
Adds a UVB listener.void
addUVIListener(BrickletUVLightV2.UVIListener listener)
Adds a UVI listener.int
getBootloaderMode()
Returns the current bootloader mode, seesetBootloaderMode(int)
.int
getChipTemperature()
Returns the temperature as measured inside the microcontroller.int
getConfiguration()
Returns the configuration as set bysetConfiguration(int)
.Device.Identity
getIdentity()
Returns the UID, the UID where the Bricklet is connected to, the position, the hardware and firmware version as well as the device identifier.BrickletUVLightV2.SPITFPErrorCount
getSPITFPErrorCount()
Returns the error count for the communication between Brick and Bricklet.int
getStatusLEDConfig()
Returns the configuration as set bysetStatusLEDConfig(int)
int
getUVA()
Returns the UVA intensity of the sensor.BrickletUVLightV2.UVACallbackConfiguration
getUVACallbackConfiguration()
Returns the listener configuration as set bysetUVACallbackConfiguration(long, boolean, char, int, int)
.int
getUVB()
Returns the UVB intensity of the sensor.BrickletUVLightV2.UVBCallbackConfiguration
getUVBCallbackConfiguration()
Returns the listener configuration as set bysetUVBCallbackConfiguration(long, boolean, char, int, int)
.int
getUVI()
Returns the UV index of the sensor, the index is given in 1/10.BrickletUVLightV2.UVICallbackConfiguration
getUVICallbackConfiguration()
Returns the listener configuration as set bysetUVICallbackConfiguration(long, boolean, char, int, int)
.long
readUID()
Returns the current UID as an integer.void
removeUVAListener(BrickletUVLightV2.UVAListener listener)
Removes a UVA listener.void
removeUVBListener(BrickletUVLightV2.UVBListener listener)
Removes a UVB listener.void
removeUVIListener(BrickletUVLightV2.UVIListener listener)
Removes a UVI listener.void
reset()
Calling this function will reset the Bricklet.int
setBootloaderMode(int mode)
Sets the bootloader mode and returns the status after the requested mode change was instigated.void
setConfiguration(int integrationTime)
Sets the configuration of the sensor.void
setStatusLEDConfig(int config)
Sets the status LED configuration.void
setUVACallbackConfiguration(long period, boolean valueHasToChange, char option, int min, int max)
The period is the period with which theBrickletUVLightV2.UVAListener
listener is triggered periodically.void
setUVBCallbackConfiguration(long period, boolean valueHasToChange, char option, int min, int max)
The period is the period with which theBrickletUVLightV2.UVBListener
listener is triggered periodically.void
setUVICallbackConfiguration(long period, boolean valueHasToChange, char option, int min, int max)
The period is the period with which theBrickletUVLightV2.UVIListener
listener is triggered periodically.void
setWriteFirmwarePointer(long pointer)
Sets the firmware pointer forwriteFirmware(int[])
.int
writeFirmware(int[] data)
Writes 64 Bytes of firmware at the position as written bysetWriteFirmwarePointer(long)
before.void
writeUID(long uid)
Writes a new UID into flash.-
Methods inherited from class com.tinkerforge.DeviceBase
getAPIVersion, getResponseExpected, setResponseExpected, setResponseExpectedAll
-
-
-
-
Field Detail
-
DEVICE_IDENTIFIER
public static final int DEVICE_IDENTIFIER
- See Also:
- Constant Field Values
-
DEVICE_DISPLAY_NAME
public static final java.lang.String DEVICE_DISPLAY_NAME
- See Also:
- Constant Field Values
-
FUNCTION_GET_UVA
public static final byte FUNCTION_GET_UVA
- See Also:
- Constant Field Values
-
FUNCTION_SET_UVA_CALLBACK_CONFIGURATION
public static final byte FUNCTION_SET_UVA_CALLBACK_CONFIGURATION
- See Also:
- Constant Field Values
-
FUNCTION_GET_UVA_CALLBACK_CONFIGURATION
public static final byte FUNCTION_GET_UVA_CALLBACK_CONFIGURATION
- See Also:
- Constant Field Values
-
FUNCTION_GET_UVB
public static final byte FUNCTION_GET_UVB
- See Also:
- Constant Field Values
-
FUNCTION_SET_UVB_CALLBACK_CONFIGURATION
public static final byte FUNCTION_SET_UVB_CALLBACK_CONFIGURATION
- See Also:
- Constant Field Values
-
FUNCTION_GET_UVB_CALLBACK_CONFIGURATION
public static final byte FUNCTION_GET_UVB_CALLBACK_CONFIGURATION
- See Also:
- Constant Field Values
-
FUNCTION_GET_UVI
public static final byte FUNCTION_GET_UVI
- See Also:
- Constant Field Values
-
FUNCTION_SET_UVI_CALLBACK_CONFIGURATION
public static final byte FUNCTION_SET_UVI_CALLBACK_CONFIGURATION
- See Also:
- Constant Field Values
-
FUNCTION_GET_UVI_CALLBACK_CONFIGURATION
public static final byte FUNCTION_GET_UVI_CALLBACK_CONFIGURATION
- See Also:
- Constant Field Values
-
FUNCTION_SET_CONFIGURATION
public static final byte FUNCTION_SET_CONFIGURATION
- See Also:
- Constant Field Values
-
FUNCTION_GET_CONFIGURATION
public static final byte FUNCTION_GET_CONFIGURATION
- See Also:
- Constant Field Values
-
FUNCTION_GET_SPITFP_ERROR_COUNT
public static final byte FUNCTION_GET_SPITFP_ERROR_COUNT
- See Also:
- Constant Field Values
-
FUNCTION_SET_BOOTLOADER_MODE
public static final byte FUNCTION_SET_BOOTLOADER_MODE
- See Also:
- Constant Field Values
-
FUNCTION_GET_BOOTLOADER_MODE
public static final byte FUNCTION_GET_BOOTLOADER_MODE
- See Also:
- Constant Field Values
-
FUNCTION_SET_WRITE_FIRMWARE_POINTER
public static final byte FUNCTION_SET_WRITE_FIRMWARE_POINTER
- See Also:
- Constant Field Values
-
FUNCTION_WRITE_FIRMWARE
public static final byte FUNCTION_WRITE_FIRMWARE
- See Also:
- Constant Field Values
-
FUNCTION_SET_STATUS_LED_CONFIG
public static final byte FUNCTION_SET_STATUS_LED_CONFIG
- See Also:
- Constant Field Values
-
FUNCTION_GET_STATUS_LED_CONFIG
public static final byte FUNCTION_GET_STATUS_LED_CONFIG
- See Also:
- Constant Field Values
-
FUNCTION_GET_CHIP_TEMPERATURE
public static final byte FUNCTION_GET_CHIP_TEMPERATURE
- See Also:
- Constant Field Values
-
FUNCTION_RESET
public static final byte FUNCTION_RESET
- See Also:
- Constant Field Values
-
FUNCTION_WRITE_UID
public static final byte FUNCTION_WRITE_UID
- See Also:
- Constant Field Values
-
FUNCTION_READ_UID
public static final byte FUNCTION_READ_UID
- See Also:
- Constant Field Values
-
FUNCTION_GET_IDENTITY
public static final byte FUNCTION_GET_IDENTITY
- See Also:
- Constant Field Values
-
THRESHOLD_OPTION_OFF
public static final char THRESHOLD_OPTION_OFF
- See Also:
- Constant Field Values
-
THRESHOLD_OPTION_OUTSIDE
public static final char THRESHOLD_OPTION_OUTSIDE
- See Also:
- Constant Field Values
-
THRESHOLD_OPTION_INSIDE
public static final char THRESHOLD_OPTION_INSIDE
- See Also:
- Constant Field Values
-
THRESHOLD_OPTION_SMALLER
public static final char THRESHOLD_OPTION_SMALLER
- See Also:
- Constant Field Values
-
THRESHOLD_OPTION_GREATER
public static final char THRESHOLD_OPTION_GREATER
- See Also:
- Constant Field Values
-
INTEGRATION_TIME_50MS
public static final int INTEGRATION_TIME_50MS
- See Also:
- Constant Field Values
-
INTEGRATION_TIME_100MS
public static final int INTEGRATION_TIME_100MS
- See Also:
- Constant Field Values
-
INTEGRATION_TIME_200MS
public static final int INTEGRATION_TIME_200MS
- See Also:
- Constant Field Values
-
INTEGRATION_TIME_400MS
public static final int INTEGRATION_TIME_400MS
- See Also:
- Constant Field Values
-
INTEGRATION_TIME_800MS
public static final int INTEGRATION_TIME_800MS
- See Also:
- Constant Field Values
-
BOOTLOADER_MODE_BOOTLOADER
public static final int BOOTLOADER_MODE_BOOTLOADER
- See Also:
- Constant Field Values
-
BOOTLOADER_MODE_FIRMWARE
public static final int BOOTLOADER_MODE_FIRMWARE
- See Also:
- Constant Field Values
-
BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT
public static final int BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT
- See Also:
- Constant Field Values
-
BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT
public static final int BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT
- See Also:
- Constant Field Values
-
BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT
public static final int BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT
- See Also:
- Constant Field Values
-
BOOTLOADER_STATUS_OK
public static final int BOOTLOADER_STATUS_OK
- See Also:
- Constant Field Values
-
BOOTLOADER_STATUS_INVALID_MODE
public static final int BOOTLOADER_STATUS_INVALID_MODE
- See Also:
- Constant Field Values
-
BOOTLOADER_STATUS_NO_CHANGE
public static final int BOOTLOADER_STATUS_NO_CHANGE
- See Also:
- Constant Field Values
-
BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT
public static final int BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT
- See Also:
- Constant Field Values
-
BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT
public static final int BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT
- See Also:
- Constant Field Values
-
BOOTLOADER_STATUS_CRC_MISMATCH
public static final int BOOTLOADER_STATUS_CRC_MISMATCH
- See Also:
- Constant Field Values
-
STATUS_LED_CONFIG_OFF
public static final int STATUS_LED_CONFIG_OFF
- See Also:
- Constant Field Values
-
STATUS_LED_CONFIG_ON
public static final int STATUS_LED_CONFIG_ON
- See Also:
- Constant Field Values
-
STATUS_LED_CONFIG_SHOW_HEARTBEAT
public static final int STATUS_LED_CONFIG_SHOW_HEARTBEAT
- See Also:
- Constant Field Values
-
STATUS_LED_CONFIG_SHOW_STATUS
public static final int STATUS_LED_CONFIG_SHOW_STATUS
- See Also:
- Constant Field Values
-
-
Constructor Detail
-
BrickletUVLightV2
public BrickletUVLightV2(java.lang.String uid, IPConnection ipcon)
Creates an object with the unique device ID \c uid. and adds it to the IP Connection \c ipcon.
-
-
Method Detail
-
getUVA
public int getUVA() throws TinkerforgeException
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 usegetUVI()
. If the sensor is saturated, then -1 is returned, seesetConfiguration(int)
. If you want to get the intensity periodically, it is recommended to use theBrickletUVLightV2.UVAListener
listener and set the period withsetUVACallbackConfiguration(long, boolean, char, int, int)
. If you want to get the value periodically, it is recommended to use theBrickletUVLightV2.UVAListener
listener. You can set the listener configuration withsetUVACallbackConfiguration(long, boolean, char, int, int)
.- Throws:
TinkerforgeException
-
setUVACallbackConfiguration
public void setUVACallbackConfiguration(long period, boolean valueHasToChange, char option, int min, int max) throws TinkerforgeException
The period is the period with which theBrickletUVLightV2.UVAListener
listener is triggered periodically. A value of 0 turns the listener off. If the `value has to change`-parameter is set to true, the listener is only triggered after the value has changed. If the value didn't change within the period, the listener is triggered immediately on change. If it is set to false, the listener is continuously triggered with the period, independent of the value. It is furthermore possible to constrain the listener with thresholds. The `option`-parameter together with min/max sets a threshold for theBrickletUVLightV2.UVAListener
listener. The following options are possible: \verbatim "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)" \endverbatim If the option is set to 'x' (threshold turned off) the listener is triggered with the fixed period.- Throws:
TinkerforgeException
-
getUVACallbackConfiguration
public BrickletUVLightV2.UVACallbackConfiguration getUVACallbackConfiguration() throws TinkerforgeException
Returns the listener configuration as set bysetUVACallbackConfiguration(long, boolean, char, int, int)
.- Throws:
TinkerforgeException
-
getUVB
public int getUVB() throws TinkerforgeException
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 usegetUVI()
. If the sensor is saturated, then -1 is returned, seesetConfiguration(int)
. If you want to get the intensity periodically, it is recommended to use theBrickletUVLightV2.UVBListener
listener and set the period withsetUVBCallbackConfiguration(long, boolean, char, int, int)
. If you want to get the value periodically, it is recommended to use theBrickletUVLightV2.UVBListener
listener. You can set the listener configuration withsetUVBCallbackConfiguration(long, boolean, char, int, int)
.- Throws:
TinkerforgeException
-
setUVBCallbackConfiguration
public void setUVBCallbackConfiguration(long period, boolean valueHasToChange, char option, int min, int max) throws TinkerforgeException
The period is the period with which theBrickletUVLightV2.UVBListener
listener is triggered periodically. A value of 0 turns the listener off. If the `value has to change`-parameter is set to true, the listener is only triggered after the value has changed. If the value didn't change within the period, the listener is triggered immediately on change. If it is set to false, the listener is continuously triggered with the period, independent of the value. It is furthermore possible to constrain the listener with thresholds. The `option`-parameter together with min/max sets a threshold for theBrickletUVLightV2.UVBListener
listener. The following options are possible: \verbatim "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)" \endverbatim If the option is set to 'x' (threshold turned off) the listener is triggered with the fixed period.- Throws:
TinkerforgeException
-
getUVBCallbackConfiguration
public BrickletUVLightV2.UVBCallbackConfiguration getUVBCallbackConfiguration() throws TinkerforgeException
Returns the listener configuration as set bysetUVBCallbackConfiguration(long, boolean, char, int, int)
.- Throws:
TinkerforgeException
-
getUVI
public int getUVI() throws TinkerforgeException
Returns the UV index of the sensor, the index is given in 1/10. If the sensor is saturated, then -1 is returned, seesetConfiguration(int)
. If you want to get the intensity periodically, it is recommended to use theBrickletUVLightV2.UVIListener
listener and set the period withsetUVICallbackConfiguration(long, boolean, char, int, int)
. If you want to get the value periodically, it is recommended to use theBrickletUVLightV2.UVIListener
listener. You can set the listener configuration withsetUVICallbackConfiguration(long, boolean, char, int, int)
.- Throws:
TinkerforgeException
-
setUVICallbackConfiguration
public void setUVICallbackConfiguration(long period, boolean valueHasToChange, char option, int min, int max) throws TinkerforgeException
The period is the period with which theBrickletUVLightV2.UVIListener
listener is triggered periodically. A value of 0 turns the listener off. If the `value has to change`-parameter is set to true, the listener is only triggered after the value has changed. If the value didn't change within the period, the listener is triggered immediately on change. If it is set to false, the listener is continuously triggered with the period, independent of the value. It is furthermore possible to constrain the listener with thresholds. The `option`-parameter together with min/max sets a threshold for theBrickletUVLightV2.UVIListener
listener. The following options are possible: \verbatim "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)" \endverbatim If the option is set to 'x' (threshold turned off) the listener is triggered with the fixed period.- Throws:
TinkerforgeException
-
getUVICallbackConfiguration
public BrickletUVLightV2.UVICallbackConfiguration getUVICallbackConfiguration() throws TinkerforgeException
Returns the listener configuration as set bysetUVICallbackConfiguration(long, boolean, char, int, int)
.- Throws:
TinkerforgeException
-
setConfiguration
public void setConfiguration(int integrationTime) throws TinkerforgeException
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.- Throws:
TinkerforgeException
-
getConfiguration
public int getConfiguration() throws TinkerforgeException
Returns the configuration as set bysetConfiguration(int)
.- Throws:
TinkerforgeException
-
getSPITFPErrorCount
public BrickletUVLightV2.SPITFPErrorCount getSPITFPErrorCount() throws TinkerforgeException
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.- Throws:
TinkerforgeException
-
setBootloaderMode
public int setBootloaderMode(int mode) throws TinkerforgeException
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.- Throws:
TinkerforgeException
-
getBootloaderMode
public int getBootloaderMode() throws TinkerforgeException
Returns the current bootloader mode, seesetBootloaderMode(int)
.- Throws:
TinkerforgeException
-
setWriteFirmwarePointer
public void setWriteFirmwarePointer(long pointer) throws TinkerforgeException
Sets the firmware pointer forwriteFirmware(int[])
. 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.- Throws:
TinkerforgeException
-
writeFirmware
public int writeFirmware(int[] data) throws TinkerforgeException
Writes 64 Bytes of firmware at the position as written bysetWriteFirmwarePointer(long)
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.- Throws:
TinkerforgeException
-
setStatusLEDConfig
public void setStatusLEDConfig(int config) throws TinkerforgeException
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.- Throws:
TinkerforgeException
-
getStatusLEDConfig
public int getStatusLEDConfig() throws TinkerforgeException
Returns the configuration as set bysetStatusLEDConfig(int)
- Throws:
TinkerforgeException
-
getChipTemperature
public int getChipTemperature() throws TinkerforgeException
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.- Throws:
TinkerforgeException
-
reset
public void reset() throws TinkerforgeException
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!- Throws:
TinkerforgeException
-
writeUID
public void writeUID(long uid) throws TinkerforgeException
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.- Throws:
TinkerforgeException
-
readUID
public long readUID() throws TinkerforgeException
Returns the current UID as an integer. Encode as Base58 to get the usual string version.- Throws:
TinkerforgeException
-
getIdentity
public Device.Identity getIdentity() throws TinkerforgeException
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|- Specified by:
getIdentity
in classDevice
- Throws:
TinkerforgeException
-
addUVAListener
public void addUVAListener(BrickletUVLightV2.UVAListener listener)
Adds a UVA listener.
-
removeUVAListener
public void removeUVAListener(BrickletUVLightV2.UVAListener listener)
Removes a UVA listener.
-
addUVBListener
public void addUVBListener(BrickletUVLightV2.UVBListener listener)
Adds a UVB listener.
-
removeUVBListener
public void removeUVBListener(BrickletUVLightV2.UVBListener listener)
Removes a UVB listener.
-
addUVIListener
public void addUVIListener(BrickletUVLightV2.UVIListener listener)
Adds a UVI listener.
-
removeUVIListener
public void removeUVIListener(BrickletUVLightV2.UVIListener listener)
Removes a UVI listener.
-
-