public class BrickletAirQuality extends Device
Device.Identity
Constructor and Description |
---|
BrickletAirQuality(java.lang.String uid,
IPConnection ipcon)
Creates an object with the unique device ID \c uid.
|
Modifier and Type | Method and Description |
---|---|
void |
addAirPressureListener(BrickletAirQuality.AirPressureListener listener)
Adds a AirPressure listener.
|
void |
addAllValuesListener(BrickletAirQuality.AllValuesListener listener)
Adds a AllValues listener.
|
void |
addHumidityListener(BrickletAirQuality.HumidityListener listener)
Adds a Humidity listener.
|
void |
addIAQIndexListener(BrickletAirQuality.IAQIndexListener listener)
Adds a IAQIndex listener.
|
void |
addTemperatureListener(BrickletAirQuality.TemperatureListener listener)
Adds a Temperature listener.
|
int |
getAirPressure()
Returns air pressure.
|
BrickletAirQuality.AirPressureCallbackConfiguration |
getAirPressureCallbackConfiguration()
Returns the listener configuration as set by
setAirPressureCallbackConfiguration(long, boolean, char, int, int) . |
BrickletAirQuality.AllValues |
getAllValues()
Returns all values measured by the Air Quality Bricklet.
|
BrickletAirQuality.AllValuesCallbackConfiguration |
getAllValuesCallbackConfiguration()
Returns the listener configuration as set by
setAllValuesCallbackConfiguration(long, boolean) . |
int |
getBackgroundCalibrationDuration()
Returns the background calibration duration as set by
setBackgroundCalibrationDuration(int) . |
int |
getBootloaderMode()
Returns the current bootloader mode, see
setBootloaderMode(int) . |
int |
getChipTemperature()
Returns the temperature as measured inside the microcontroller.
|
int |
getHumidity()
Returns relative humidity.
|
BrickletAirQuality.HumidityCallbackConfiguration |
getHumidityCallbackConfiguration()
Returns the listener configuration as set by
setHumidityCallbackConfiguration(long, boolean, char, int, int) . |
BrickletAirQuality.IAQIndex |
getIAQIndex()
Returns the IAQ index and accuracy.
|
BrickletAirQuality.IAQIndexCallbackConfiguration |
getIAQIndexCallbackConfiguration()
Returns the listener configuration as set by
setIAQIndexCallbackConfiguration(long, boolean) . |
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.
|
BrickletAirQuality.SPITFPErrorCount |
getSPITFPErrorCount()
Returns the error count for the communication between Brick and Bricklet.
|
int |
getStatusLEDConfig()
Returns the configuration as set by
setStatusLEDConfig(int) |
int |
getTemperature()
Returns temperature.
|
BrickletAirQuality.TemperatureCallbackConfiguration |
getTemperatureCallbackConfiguration()
Returns the listener configuration as set by
setTemperatureCallbackConfiguration(long, boolean, char, int, int) . |
int |
getTemperatureOffset()
Returns the temperature offset as set by
setTemperatureOffset(int) . |
long |
readUID()
Returns the current UID as an integer.
|
void |
removeAirPressureListener(BrickletAirQuality.AirPressureListener listener)
Removes a AirPressure listener.
|
void |
removeAllValuesListener(BrickletAirQuality.AllValuesListener listener)
Removes a AllValues listener.
|
void |
removeCalibration()
Deletes the calibration from flash.
|
void |
removeHumidityListener(BrickletAirQuality.HumidityListener listener)
Removes a Humidity listener.
|
void |
removeIAQIndexListener(BrickletAirQuality.IAQIndexListener listener)
Removes a IAQIndex listener.
|
void |
removeTemperatureListener(BrickletAirQuality.TemperatureListener listener)
Removes a Temperature listener.
|
void |
reset()
Calling this function will reset the Bricklet.
|
void |
setAirPressureCallbackConfiguration(long period,
boolean valueHasToChange,
char option,
int min,
int max)
The period is the period with which the
BrickletAirQuality.AirPressureListener listener is triggered
periodically. |
void |
setAllValuesCallbackConfiguration(long period,
boolean valueHasToChange)
The period is the period with which the
BrickletAirQuality.AllValuesListener
listener is triggered periodically. |
void |
setBackgroundCalibrationDuration(int duration)
The Air Quality Bricklet uses an automatic background calibration mechanism to
calculate the IAQ Index.
|
int |
setBootloaderMode(int mode)
Sets the bootloader mode and returns the status after the requested
mode change was instigated.
|
void |
setHumidityCallbackConfiguration(long period,
boolean valueHasToChange,
char option,
int min,
int max)
The period is the period with which the
BrickletAirQuality.HumidityListener listener is triggered
periodically. |
void |
setIAQIndexCallbackConfiguration(long period,
boolean valueHasToChange)
The period is the period with which the
BrickletAirQuality.IAQIndexListener
listener is triggered periodically. |
void |
setStatusLEDConfig(int config)
Sets the status LED configuration.
|
void |
setTemperatureCallbackConfiguration(long period,
boolean valueHasToChange,
char option,
int min,
int max)
The period is the period with which the
BrickletAirQuality.TemperatureListener listener is triggered
periodically. |
void |
setTemperatureOffset(int offset)
Sets a temperature offset.
|
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_ALL_VALUES
public static final byte FUNCTION_SET_TEMPERATURE_OFFSET
public static final byte FUNCTION_GET_TEMPERATURE_OFFSET
public static final byte FUNCTION_SET_ALL_VALUES_CALLBACK_CONFIGURATION
public static final byte FUNCTION_GET_ALL_VALUES_CALLBACK_CONFIGURATION
public static final byte FUNCTION_GET_IAQ_INDEX
public static final byte FUNCTION_SET_IAQ_INDEX_CALLBACK_CONFIGURATION
public static final byte FUNCTION_GET_IAQ_INDEX_CALLBACK_CONFIGURATION
public static final byte FUNCTION_GET_TEMPERATURE
public static final byte FUNCTION_SET_TEMPERATURE_CALLBACK_CONFIGURATION
public static final byte FUNCTION_GET_TEMPERATURE_CALLBACK_CONFIGURATION
public static final byte FUNCTION_GET_HUMIDITY
public static final byte FUNCTION_SET_HUMIDITY_CALLBACK_CONFIGURATION
public static final byte FUNCTION_GET_HUMIDITY_CALLBACK_CONFIGURATION
public static final byte FUNCTION_GET_AIR_PRESSURE
public static final byte FUNCTION_SET_AIR_PRESSURE_CALLBACK_CONFIGURATION
public static final byte FUNCTION_GET_AIR_PRESSURE_CALLBACK_CONFIGURATION
public static final byte FUNCTION_REMOVE_CALIBRATION
public static final byte FUNCTION_SET_BACKGROUND_CALIBRATION_DURATION
public static final byte FUNCTION_GET_BACKGROUND_CALIBRATION_DURATION
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 int ACCURACY_UNRELIABLE
public static final int ACCURACY_LOW
public static final int ACCURACY_MEDIUM
public static final int ACCURACY_HIGH
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 DURATION_4_DAYS
public static final int DURATION_28_DAYS
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 BrickletAirQuality(java.lang.String uid, IPConnection ipcon)
public BrickletAirQuality.AllValues getAllValues() throws TinkerforgeException
TinkerforgeException
public void setTemperatureOffset(int offset) throws TinkerforgeException
TinkerforgeException
public int getTemperatureOffset() throws TinkerforgeException
setTemperatureOffset(int)
.TinkerforgeException
public void setAllValuesCallbackConfiguration(long period, boolean valueHasToChange) throws TinkerforgeException
BrickletAirQuality.AllValuesListener
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 at least one of the values has changed. If the values 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 BrickletAirQuality.AllValuesCallbackConfiguration getAllValuesCallbackConfiguration() throws TinkerforgeException
setAllValuesCallbackConfiguration(long, boolean)
.TinkerforgeException
public BrickletAirQuality.IAQIndex getIAQIndex() throws TinkerforgeException
BrickletAirQuality.IAQIndexListener
listener. You can set the listener configuration
with setIAQIndexCallbackConfiguration(long, boolean)
.TinkerforgeException
public void setIAQIndexCallbackConfiguration(long period, boolean valueHasToChange) throws TinkerforgeException
BrickletAirQuality.IAQIndexListener
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 at least one of the values has changed. If the values 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 BrickletAirQuality.IAQIndexCallbackConfiguration getIAQIndexCallbackConfiguration() throws TinkerforgeException
setIAQIndexCallbackConfiguration(long, boolean)
.TinkerforgeException
public int getTemperature() throws TinkerforgeException
BrickletAirQuality.TemperatureListener
listener. You can set the listener configuration
with setTemperatureCallbackConfiguration(long, boolean, char, int, int)
.TinkerforgeException
public void setTemperatureCallbackConfiguration(long period, boolean valueHasToChange, char option, int min, int max) throws TinkerforgeException
BrickletAirQuality.TemperatureListener
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 BrickletAirQuality.TemperatureListener
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 BrickletAirQuality.TemperatureCallbackConfiguration getTemperatureCallbackConfiguration() throws TinkerforgeException
setTemperatureCallbackConfiguration(long, boolean, char, int, int)
.TinkerforgeException
public int getHumidity() throws TinkerforgeException
BrickletAirQuality.HumidityListener
listener. You can set the listener configuration
with setHumidityCallbackConfiguration(long, boolean, char, int, int)
.TinkerforgeException
public void setHumidityCallbackConfiguration(long period, boolean valueHasToChange, char option, int min, int max) throws TinkerforgeException
BrickletAirQuality.HumidityListener
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 BrickletAirQuality.HumidityListener
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 BrickletAirQuality.HumidityCallbackConfiguration getHumidityCallbackConfiguration() throws TinkerforgeException
setHumidityCallbackConfiguration(long, boolean, char, int, int)
.TinkerforgeException
public int getAirPressure() throws TinkerforgeException
BrickletAirQuality.AirPressureListener
listener. You can set the listener configuration
with setAirPressureCallbackConfiguration(long, boolean, char, int, int)
.TinkerforgeException
public void setAirPressureCallbackConfiguration(long period, boolean valueHasToChange, char option, int min, int max) throws TinkerforgeException
BrickletAirQuality.AirPressureListener
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 BrickletAirQuality.AirPressureListener
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 BrickletAirQuality.AirPressureCallbackConfiguration getAirPressureCallbackConfiguration() throws TinkerforgeException
setAirPressureCallbackConfiguration(long, boolean, char, int, int)
.TinkerforgeException
public void removeCalibration() throws TinkerforgeException
TinkerforgeException
public void setBackgroundCalibrationDuration(int duration) throws TinkerforgeException
TinkerforgeException
public int getBackgroundCalibrationDuration() throws TinkerforgeException
setBackgroundCalibrationDuration(int)
.
.. versionadded:: 2.0.3$nbsp;(Plugin)TinkerforgeException
public BrickletAirQuality.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 addAllValuesListener(BrickletAirQuality.AllValuesListener listener)
public void removeAllValuesListener(BrickletAirQuality.AllValuesListener listener)
public void addIAQIndexListener(BrickletAirQuality.IAQIndexListener listener)
public void removeIAQIndexListener(BrickletAirQuality.IAQIndexListener listener)
public void addTemperatureListener(BrickletAirQuality.TemperatureListener listener)
public void removeTemperatureListener(BrickletAirQuality.TemperatureListener listener)
public void addHumidityListener(BrickletAirQuality.HumidityListener listener)
public void removeHumidityListener(BrickletAirQuality.HumidityListener listener)
public void addAirPressureListener(BrickletAirQuality.AirPressureListener listener)
public void removeAirPressureListener(BrickletAirQuality.AirPressureListener listener)
Copyright © 2020 Tinkerforge GmbH. All rights reserved.