public class BrickletColorV2 extends Device
Modifier and Type | Class and Description |
---|---|
class |
BrickletColorV2.Color |
class |
BrickletColorV2.ColorCallbackConfiguration |
static interface |
BrickletColorV2.ColorListener
This listener is triggered periodically with the period that is set by
setColorCallbackConfiguration(long, boolean) . |
class |
BrickletColorV2.ColorTemperatureCallbackConfiguration |
static interface |
BrickletColorV2.ColorTemperatureListener
This listener is triggered periodically according to the configuration set by
setColorTemperatureCallbackConfiguration(long, boolean, char, int, int) . |
class |
BrickletColorV2.Configuration |
class |
BrickletColorV2.IlluminanceCallbackConfiguration |
static interface |
BrickletColorV2.IlluminanceListener
This listener is triggered periodically according to the configuration set by
setIlluminanceCallbackConfiguration(long, boolean, char, long, long) . |
class |
BrickletColorV2.SPITFPErrorCount |
Device.Identity
Constructor and Description |
---|
BrickletColorV2(String uid,
IPConnection ipcon)
Creates an object with the unique device ID \c uid.
|
Modifier and Type | Method and Description |
---|---|
void |
addColorListener(BrickletColorV2.ColorListener listener)
Adds a Color listener.
|
void |
addColorTemperatureListener(BrickletColorV2.ColorTemperatureListener listener)
Adds a ColorTemperature listener.
|
void |
addIlluminanceListener(BrickletColorV2.IlluminanceListener listener)
Adds a Illuminance listener.
|
int |
getBootloaderMode()
Returns the current bootloader mode, see
setBootloaderMode(int) . |
int |
getChipTemperature()
Returns the temperature as measured inside the microcontroller.
|
BrickletColorV2.Color |
getColor()
Returns the measured color of the sensor.
|
BrickletColorV2.ColorCallbackConfiguration |
getColorCallbackConfiguration()
Returns the listener configuration as set by
setColorCallbackConfiguration(long, boolean) . |
int |
getColorTemperature()
Returns the color temperature.
|
BrickletColorV2.ColorTemperatureCallbackConfiguration |
getColorTemperatureCallbackConfiguration()
Returns the listener configuration as set by
setColorTemperatureCallbackConfiguration(long, boolean, char, int, int) . |
BrickletColorV2.Configuration |
getConfiguration()
Returns the configuration as set by
setConfiguration(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 affected by the gain and integration time as
set by
setConfiguration(int, int) . |
BrickletColorV2.IlluminanceCallbackConfiguration |
getIlluminanceCallbackConfiguration()
Returns the listener configuration as set by
setIlluminanceCallbackConfiguration(long, boolean, char, long, long) . |
boolean |
getLight()
Returns the value as set by
setLight(boolean) . |
BrickletColorV2.SPITFPErrorCount |
getSPITFPErrorCount()
Returns the error count for the communication between Brick and Bricklet.
|
int |
getStatusLEDConfig()
Returns the configuration as set by
setStatusLEDConfig(int) |
long |
readUID()
Returns the current UID as an integer.
|
void |
removeColorListener(BrickletColorV2.ColorListener listener)
Removes a Color listener.
|
void |
removeColorTemperatureListener(BrickletColorV2.ColorTemperatureListener listener)
Removes a ColorTemperature listener.
|
void |
removeIlluminanceListener(BrickletColorV2.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 |
setColorCallbackConfiguration(long period,
boolean valueHasToChange)
The period is the period with which the
BrickletColorV2.ColorListener
listener is triggered periodically. |
void |
setColorTemperatureCallbackConfiguration(long period,
boolean valueHasToChange,
char option,
int min,
int max)
The period is the period with which the
BrickletColorV2.ColorTemperatureListener listener is triggered
periodically. |
void |
setConfiguration(int gain,
int integrationTime)
Sets the configuration of the sensor.
|
void |
setIlluminanceCallbackConfiguration(long period,
boolean valueHasToChange,
char option,
long min,
long max)
The period is the period with which the
BrickletColorV2.IlluminanceListener listener is triggered
periodically. |
void |
setLight(boolean enable)
Turns the white LED on the Bricklet on/off.
|
void |
setStatusLEDConfig(int config)
Sets the status LED configuration.
|
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 String DEVICE_DISPLAY_NAME
public static final byte FUNCTION_GET_COLOR
public static final byte FUNCTION_SET_COLOR_CALLBACK_CONFIGURATION
public static final byte FUNCTION_GET_COLOR_CALLBACK_CONFIGURATION
public static final byte FUNCTION_GET_ILLUMINANCE
public static final byte FUNCTION_SET_ILLUMINANCE_CALLBACK_CONFIGURATION
public static final byte FUNCTION_GET_ILLUMINANCE_CALLBACK_CONFIGURATION
public static final byte FUNCTION_GET_COLOR_TEMPERATURE
public static final byte FUNCTION_SET_COLOR_TEMPERATURE_CALLBACK_CONFIGURATION
public static final byte FUNCTION_GET_COLOR_TEMPERATURE_CALLBACK_CONFIGURATION
public static final byte FUNCTION_SET_LIGHT
public static final byte FUNCTION_GET_LIGHT
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 GAIN_1X
public static final int GAIN_4X
public static final int GAIN_16X
public static final int GAIN_60X
public static final int INTEGRATION_TIME_2MS
public static final int INTEGRATION_TIME_24MS
public static final int INTEGRATION_TIME_101MS
public static final int INTEGRATION_TIME_154MS
public static final int INTEGRATION_TIME_700MS
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 BrickletColorV2(String uid, IPConnection ipcon)
public BrickletColorV2.Color getColor() throws TinkerforgeException
BrickletColorV2.ColorListener
listener and set the period with
setColorCallbackConfiguration(long, boolean)
.TinkerforgeException
public void setColorCallbackConfiguration(long period, boolean valueHasToChange) throws TinkerforgeException
BrickletColorV2.ColorListener
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.TinkerforgeException
public BrickletColorV2.ColorCallbackConfiguration getColorCallbackConfiguration() throws TinkerforgeException
setColorCallbackConfiguration(long, boolean)
.TinkerforgeException
public long getIlluminance() throws TinkerforgeException
setConfiguration(int, int)
. To get the illuminance in Lux apply this formula::
lux = illuminance * 700 / gain / integration_time
To get a correct illuminance measurement make sure that the color
values themselves are not saturated. The color value (R, G or B)
is saturated if it is equal to the maximum value of 65535.
In that case you have to reduce the gain, see setConfiguration(int, int)
.
If you want to get the value periodically, it is recommended to use the
BrickletColorV2.IlluminanceListener
listener. You can set the listener configuration
with setIlluminanceCallbackConfiguration(long, boolean, char, long, long)
.TinkerforgeException
public void setIlluminanceCallbackConfiguration(long period, boolean valueHasToChange, char option, long min, long max) throws TinkerforgeException
BrickletColorV2.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 the BrickletColorV2.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.TinkerforgeException
public BrickletColorV2.IlluminanceCallbackConfiguration getIlluminanceCallbackConfiguration() throws TinkerforgeException
setIlluminanceCallbackConfiguration(long, boolean, char, long, long)
.TinkerforgeException
public int getColorTemperature() throws TinkerforgeException
setConfiguration(int, int)
.
If you want to get the value periodically, it is recommended to use the
BrickletColorV2.ColorTemperatureListener
listener. You can set the listener configuration
with setColorTemperatureCallbackConfiguration(long, boolean, char, int, int)
.TinkerforgeException
public void setColorTemperatureCallbackConfiguration(long period, boolean valueHasToChange, char option, int min, int max) throws TinkerforgeException
BrickletColorV2.ColorTemperatureListener
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 BrickletColorV2.ColorTemperatureListener
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 BrickletColorV2.ColorTemperatureCallbackConfiguration getColorTemperatureCallbackConfiguration() throws TinkerforgeException
setColorTemperatureCallbackConfiguration(long, boolean, char, int, int)
.TinkerforgeException
public void setLight(boolean enable) throws TinkerforgeException
TinkerforgeException
public boolean getLight() throws TinkerforgeException
setLight(boolean)
.TinkerforgeException
public void setConfiguration(int gain, int integrationTime) throws TinkerforgeException
TinkerforgeException
public BrickletColorV2.Configuration getConfiguration() throws TinkerforgeException
setConfiguration(int, int)
.TinkerforgeException
public BrickletColorV2.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 addColorListener(BrickletColorV2.ColorListener listener)
public void removeColorListener(BrickletColorV2.ColorListener listener)
public void addIlluminanceListener(BrickletColorV2.IlluminanceListener listener)
public void removeIlluminanceListener(BrickletColorV2.IlluminanceListener listener)
public void addColorTemperatureListener(BrickletColorV2.ColorTemperatureListener listener)
public void removeColorTemperatureListener(BrickletColorV2.ColorTemperatureListener listener)
Copyright © 2022 Tinkerforge GmbH. All rights reserved.