public class BrickletUVLightV2 extends Device
Modifier and Type | Class and Description |
---|---|
class |
BrickletUVLightV2.SPITFPErrorCount |
class |
BrickletUVLightV2.UVACallbackConfiguration |
static interface |
BrickletUVLightV2.UVAListener
This listener is triggered periodically according to the configuration set by
setUVACallbackConfiguration(long, boolean, char, int, int) . |
class |
BrickletUVLightV2.UVBCallbackConfiguration |
static interface |
BrickletUVLightV2.UVBListener
This listener is triggered periodically according to the configuration set by
setUVBCallbackConfiguration(long, boolean, char, int, int) . |
class |
BrickletUVLightV2.UVICallbackConfiguration |
static interface |
BrickletUVLightV2.UVIListener
This listener is triggered periodically according to the configuration set by
setUVICallbackConfiguration(long, boolean, char, int, int) . |
Device.Identity
Constructor and Description |
---|
BrickletUVLightV2(java.lang.String uid,
IPConnection ipcon)
Creates an object with the unique device ID \c uid.
|
Modifier and Type | Method and 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, see
setBootloaderMode(int) . |
int |
getChipTemperature()
Returns the temperature as measured inside the microcontroller.
|
int |
getConfiguration()
Returns the configuration as set by
setConfiguration(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 by
setStatusLEDConfig(int) |
int |
getUVA()
Returns the UVA intensity of the sensor.
|
BrickletUVLightV2.UVACallbackConfiguration |
getUVACallbackConfiguration()
Returns the listener configuration as set by
setUVACallbackConfiguration(long, boolean, char, int, int) . |
int |
getUVB()
Returns the UVB intensity of the sensor.
|
BrickletUVLightV2.UVBCallbackConfiguration |
getUVBCallbackConfiguration()
Returns the listener configuration as set by
setUVBCallbackConfiguration(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 by
setUVICallbackConfiguration(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 the
BrickletUVLightV2.UVAListener listener is triggered
periodically. |
void |
setUVBCallbackConfiguration(long period,
boolean valueHasToChange,
char option,
int min,
int max)
The period is the period with which the
BrickletUVLightV2.UVBListener listener is triggered
periodically. |
void |
setUVICallbackConfiguration(long period,
boolean valueHasToChange,
char option,
int min,
int max)
The period is the period with which the
BrickletUVLightV2.UVIListener listener is triggered
periodically. |
void |
setWriteFirmwarePointer(long pointer)
Sets the firmware pointer for
writeFirmware(int[]) . |
int |
writeFirmware(int[] data)
Writes 64 Bytes of firmware at the position as written by
setWriteFirmwarePointer(long) before. |
void |
writeUID(long uid)
Writes a new UID into flash.
|
getAPIVersion, getResponseExpected, setResponseExpected, setResponseExpectedAll
public static final int DEVICE_IDENTIFIER
public static final java.lang.String DEVICE_DISPLAY_NAME
public static final byte FUNCTION_GET_UVA
public static final byte FUNCTION_SET_UVA_CALLBACK_CONFIGURATION
public static final byte FUNCTION_GET_UVA_CALLBACK_CONFIGURATION
public static final byte FUNCTION_GET_UVB
public static final byte FUNCTION_SET_UVB_CALLBACK_CONFIGURATION
public static final byte FUNCTION_GET_UVB_CALLBACK_CONFIGURATION
public static final byte FUNCTION_GET_UVI
public static final byte FUNCTION_SET_UVI_CALLBACK_CONFIGURATION
public static final byte FUNCTION_GET_UVI_CALLBACK_CONFIGURATION
public static final byte FUNCTION_SET_CONFIGURATION
public static final byte FUNCTION_GET_CONFIGURATION
public static final byte FUNCTION_GET_SPITFP_ERROR_COUNT
public static final byte FUNCTION_SET_BOOTLOADER_MODE
public static final byte FUNCTION_GET_BOOTLOADER_MODE
public static final byte FUNCTION_SET_WRITE_FIRMWARE_POINTER
public static final byte FUNCTION_WRITE_FIRMWARE
public static final byte FUNCTION_SET_STATUS_LED_CONFIG
public static final byte FUNCTION_GET_STATUS_LED_CONFIG
public static final byte FUNCTION_GET_CHIP_TEMPERATURE
public static final byte FUNCTION_RESET
public static final byte FUNCTION_WRITE_UID
public static final byte FUNCTION_READ_UID
public static final byte FUNCTION_GET_IDENTITY
public static final char THRESHOLD_OPTION_OFF
public static final char THRESHOLD_OPTION_OUTSIDE
public static final char THRESHOLD_OPTION_INSIDE
public static final char THRESHOLD_OPTION_SMALLER
public static final char THRESHOLD_OPTION_GREATER
public static final int INTEGRATION_TIME_50MS
public static final int INTEGRATION_TIME_100MS
public static final int INTEGRATION_TIME_200MS
public static final int INTEGRATION_TIME_400MS
public static final int INTEGRATION_TIME_800MS
public static final int BOOTLOADER_MODE_BOOTLOADER
public static final int BOOTLOADER_MODE_FIRMWARE
public static final int BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT
public static final int BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT
public static final int BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT
public static final int BOOTLOADER_STATUS_OK
public static final int BOOTLOADER_STATUS_INVALID_MODE
public static final int BOOTLOADER_STATUS_NO_CHANGE
public static final int BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT
public static final int BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT
public static final int BOOTLOADER_STATUS_CRC_MISMATCH
public static final int STATUS_LED_CONFIG_OFF
public static final int STATUS_LED_CONFIG_ON
public static final int STATUS_LED_CONFIG_SHOW_HEARTBEAT
public static final int STATUS_LED_CONFIG_SHOW_STATUS
public BrickletUVLightV2(java.lang.String uid, IPConnection ipcon)
public int getUVA() throws TinkerforgeException
getUVI()
.
If the sensor is saturated, then -1 is returned, see setConfiguration(int)
.
If you want to get the intensity periodically, it is recommended to use the
BrickletUVLightV2.UVAListener
listener and set the period with
setUVACallbackConfiguration(long, boolean, char, int, int)
.
If you want to get the value periodically, it is recommended to use the
BrickletUVLightV2.UVAListener
listener. You can set the listener configuration
with setUVACallbackConfiguration(long, boolean, char, int, int)
.TinkerforgeException
public void setUVACallbackConfiguration(long period, boolean valueHasToChange, char option, int min, int max) throws TinkerforgeException
BrickletUVLightV2.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 the BrickletUVLightV2.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.TinkerforgeException
public BrickletUVLightV2.UVACallbackConfiguration getUVACallbackConfiguration() throws TinkerforgeException
setUVACallbackConfiguration(long, boolean, char, int, int)
.TinkerforgeException
public int getUVB() throws TinkerforgeException
getUVI()
.
If the sensor is saturated, then -1 is returned, see setConfiguration(int)
.
If you want to get the intensity periodically, it is recommended to use the
BrickletUVLightV2.UVBListener
listener and set the period with
setUVBCallbackConfiguration(long, boolean, char, int, int)
.
If you want to get the value periodically, it is recommended to use the
BrickletUVLightV2.UVBListener
listener. You can set the listener configuration
with setUVBCallbackConfiguration(long, boolean, char, int, int)
.TinkerforgeException
public void setUVBCallbackConfiguration(long period, boolean valueHasToChange, char option, int min, int max) throws TinkerforgeException
BrickletUVLightV2.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 the BrickletUVLightV2.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.TinkerforgeException
public BrickletUVLightV2.UVBCallbackConfiguration getUVBCallbackConfiguration() throws TinkerforgeException
setUVBCallbackConfiguration(long, boolean, char, int, int)
.TinkerforgeException
public int getUVI() throws TinkerforgeException
setConfiguration(int)
.
If you want to get the intensity periodically, it is recommended to use the
BrickletUVLightV2.UVIListener
listener and set the period with
setUVICallbackConfiguration(long, boolean, char, int, int)
.
If you want to get the value periodically, it is recommended to use the
BrickletUVLightV2.UVIListener
listener. You can set the listener configuration
with setUVICallbackConfiguration(long, boolean, char, int, int)
.TinkerforgeException
public void setUVICallbackConfiguration(long period, boolean valueHasToChange, char option, int min, int max) throws TinkerforgeException
BrickletUVLightV2.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 the BrickletUVLightV2.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.TinkerforgeException
public BrickletUVLightV2.UVICallbackConfiguration getUVICallbackConfiguration() throws TinkerforgeException
setUVICallbackConfiguration(long, boolean, char, int, int)
.TinkerforgeException
public void setConfiguration(int integrationTime) throws TinkerforgeException
TinkerforgeException
public int getConfiguration() throws TinkerforgeException
setConfiguration(int)
.TinkerforgeException
public BrickletUVLightV2.SPITFPErrorCount getSPITFPErrorCount() throws TinkerforgeException
TinkerforgeException
public int setBootloaderMode(int mode) throws TinkerforgeException
TinkerforgeException
public int getBootloaderMode() throws TinkerforgeException
setBootloaderMode(int)
.TinkerforgeException
public void setWriteFirmwarePointer(long pointer) throws TinkerforgeException
writeFirmware(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.TinkerforgeException
public int writeFirmware(int[] data) throws TinkerforgeException
setWriteFirmwarePointer(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.TinkerforgeException
public void setStatusLEDConfig(int config) throws TinkerforgeException
TinkerforgeException
public int getStatusLEDConfig() throws TinkerforgeException
setStatusLEDConfig(int)
TinkerforgeException
public int getChipTemperature() throws TinkerforgeException
TinkerforgeException
public void reset() throws TinkerforgeException
TinkerforgeException
public void writeUID(long uid) throws TinkerforgeException
TinkerforgeException
public long readUID() throws TinkerforgeException
TinkerforgeException
public Device.Identity getIdentity() throws TinkerforgeException
getIdentity
in class Device
TinkerforgeException
public void addUVAListener(BrickletUVLightV2.UVAListener listener)
public void removeUVAListener(BrickletUVLightV2.UVAListener listener)
public void addUVBListener(BrickletUVLightV2.UVBListener listener)
public void removeUVBListener(BrickletUVLightV2.UVBListener listener)
public void addUVIListener(BrickletUVLightV2.UVIListener listener)
public void removeUVIListener(BrickletUVLightV2.UVIListener listener)
Copyright © 2021 Tinkerforge GmbH. All rights reserved.