Package com.tinkerforge
Class BrickletAmbientLightV3
- java.lang.Object
-
- com.tinkerforge.DeviceBase
-
- com.tinkerforge.Device
-
- com.tinkerforge.BrickletAmbientLightV3
-
public class BrickletAmbientLightV3 extends Device
Measures ambient light up to 64000lux
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description class
BrickletAmbientLightV3.Configuration
class
BrickletAmbientLightV3.IlluminanceCallbackConfiguration
static interface
BrickletAmbientLightV3.IlluminanceListener
This listener is triggered periodically according to the configuration set bysetIlluminanceCallbackConfiguration(long, boolean, char, long, long)
.class
BrickletAmbientLightV3.SPITFPErrorCount
-
Nested classes/interfaces inherited from class com.tinkerforge.Device
Device.Identity
-
-
Field Summary
-
Constructor Summary
Constructors Constructor Description BrickletAmbientLightV3(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
addIlluminanceListener(BrickletAmbientLightV3.IlluminanceListener listener)
Adds a Illuminance listener.int
getBootloaderMode()
Returns the current bootloader mode, seesetBootloaderMode(int)
.int
getChipTemperature()
Returns the temperature as measured inside the microcontroller.BrickletAmbientLightV3.Configuration
getConfiguration()
Returns the configuration as set bysetConfiguration(int, 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.long
getIlluminance()
Returns the illuminance of the ambient light sensor.BrickletAmbientLightV3.IlluminanceCallbackConfiguration
getIlluminanceCallbackConfiguration()
Returns the listener configuration as set bysetIlluminanceCallbackConfiguration(long, boolean, char, long, long)
.BrickletAmbientLightV3.SPITFPErrorCount
getSPITFPErrorCount()
Returns the error count for the communication between Brick and Bricklet.int
getStatusLEDConfig()
Returns the configuration as set bysetStatusLEDConfig(int)
long
readUID()
Returns the current UID as an integer.void
removeIlluminanceListener(BrickletAmbientLightV3.IlluminanceListener listener)
Removes a Illuminance 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 illuminanceRange, int integrationTime)
Sets the configuration.void
setIlluminanceCallbackConfiguration(long period, boolean valueHasToChange, char option, long min, long max)
The period is the period with which theBrickletAmbientLightV3.IlluminanceListener
listener is triggered periodically.void
setStatusLEDConfig(int config)
Sets the status LED configuration.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_ILLUMINANCE
public static final byte FUNCTION_GET_ILLUMINANCE
- See Also:
- Constant Field Values
-
FUNCTION_SET_ILLUMINANCE_CALLBACK_CONFIGURATION
public static final byte FUNCTION_SET_ILLUMINANCE_CALLBACK_CONFIGURATION
- See Also:
- Constant Field Values
-
FUNCTION_GET_ILLUMINANCE_CALLBACK_CONFIGURATION
public static final byte FUNCTION_GET_ILLUMINANCE_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
-
ILLUMINANCE_RANGE_UNLIMITED
public static final int ILLUMINANCE_RANGE_UNLIMITED
- See Also:
- Constant Field Values
-
ILLUMINANCE_RANGE_64000LUX
public static final int ILLUMINANCE_RANGE_64000LUX
- See Also:
- Constant Field Values
-
ILLUMINANCE_RANGE_32000LUX
public static final int ILLUMINANCE_RANGE_32000LUX
- See Also:
- Constant Field Values
-
ILLUMINANCE_RANGE_16000LUX
public static final int ILLUMINANCE_RANGE_16000LUX
- See Also:
- Constant Field Values
-
ILLUMINANCE_RANGE_8000LUX
public static final int ILLUMINANCE_RANGE_8000LUX
- See Also:
- Constant Field Values
-
ILLUMINANCE_RANGE_1300LUX
public static final int ILLUMINANCE_RANGE_1300LUX
- See Also:
- Constant Field Values
-
ILLUMINANCE_RANGE_600LUX
public static final int ILLUMINANCE_RANGE_600LUX
- 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_150MS
public static final int INTEGRATION_TIME_150MS
- See Also:
- Constant Field Values
-
INTEGRATION_TIME_200MS
public static final int INTEGRATION_TIME_200MS
- See Also:
- Constant Field Values
-
INTEGRATION_TIME_250MS
public static final int INTEGRATION_TIME_250MS
- See Also:
- Constant Field Values
-
INTEGRATION_TIME_300MS
public static final int INTEGRATION_TIME_300MS
- See Also:
- Constant Field Values
-
INTEGRATION_TIME_350MS
public static final int INTEGRATION_TIME_350MS
- See Also:
- Constant Field Values
-
INTEGRATION_TIME_400MS
public static final int INTEGRATION_TIME_400MS
- 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
-
BrickletAmbientLightV3
public BrickletAmbientLightV3(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
-
getIlluminance
public long getIlluminance() throws TinkerforgeException
Returns the illuminance of the ambient light sensor. The measurement range goes up to about 100000lux, but above 64000lux the precision starts to drop. The illuminance is given in lux/100, i.e. a value of 450000 means that an illuminance of 4500lux is measured. An illuminance of 0lux indicates an error condition where the sensor cannot perform a reasonable measurement. This can happen with very dim or very bright light conditions. In bright light conditions this might indicate that the sensor is saturated and the configuration should be modified (setConfiguration(int, int)
) to better match the conditions. If you want to get the value periodically, it is recommended to use theBrickletAmbientLightV3.IlluminanceListener
listener. You can set the listener configuration withsetIlluminanceCallbackConfiguration(long, boolean, char, long, long)
.- Throws:
TinkerforgeException
-
setIlluminanceCallbackConfiguration
public void setIlluminanceCallbackConfiguration(long period, boolean valueHasToChange, char option, long min, long max) throws TinkerforgeException
The period is the period with which theBrickletAmbientLightV3.IlluminanceListener
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 theBrickletAmbientLightV3.IlluminanceListener
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
-
getIlluminanceCallbackConfiguration
public BrickletAmbientLightV3.IlluminanceCallbackConfiguration getIlluminanceCallbackConfiguration() throws TinkerforgeException
Returns the listener configuration as set bysetIlluminanceCallbackConfiguration(long, boolean, char, long, long)
.- Throws:
TinkerforgeException
-
setConfiguration
public void setConfiguration(int illuminanceRange, int integrationTime) throws TinkerforgeException
Sets the configuration. It is possible to configure an illuminance range between 0-600lux and 0-64000lux and an integration time between 50ms and 400ms. The unlimited illuminance range allows to measure up to about 100000lux, but above 64000lux the precision starts to drop. A smaller illuminance range increases the resolution of the data. A longer integration time will result in less noise on the data. If the actual measure illuminance is out-of-range then the current illuminance range maximum +0.01lux is reported bygetIlluminance()
and theBrickletAmbientLightV3.IlluminanceListener
listener. For example, 800001 for the 0-8000lux range. With a long integration time the sensor might be saturated before the measured value reaches the maximum of the selected illuminance range. In this case 0lux is reported bygetIlluminance()
and theBrickletAmbientLightV3.IlluminanceListener
listener. If the measurement is out-of-range or the sensor is saturated then you should configure the next higher illuminance range. If the highest range is already in use, then start to reduce the integration time.- Throws:
TinkerforgeException
-
getConfiguration
public BrickletAmbientLightV3.Configuration getConfiguration() throws TinkerforgeException
Returns the configuration as set bysetConfiguration(int, int)
.- Throws:
TinkerforgeException
-
getSPITFPErrorCount
public BrickletAmbientLightV3.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
-
addIlluminanceListener
public void addIlluminanceListener(BrickletAmbientLightV3.IlluminanceListener listener)
Adds a Illuminance listener.
-
removeIlluminanceListener
public void removeIlluminanceListener(BrickletAmbientLightV3.IlluminanceListener listener)
Removes a Illuminance listener.
-
-