Package com.tinkerforge
Class BrickletAirQuality
- java.lang.Object
-
- com.tinkerforge.DeviceBase
-
- com.tinkerforge.Device
-
- com.tinkerforge.BrickletAirQuality
-
public class BrickletAirQuality extends Device
Measures IAQ index, temperature, humidity and air pressure
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class com.tinkerforge.Device
Device.Identity
-
-
Field Summary
-
Constructor Summary
Constructors Constructor Description BrickletAirQuality(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
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 bysetAirPressureCallbackConfiguration(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 bysetAllValuesCallbackConfiguration(long, boolean)
.int
getBackgroundCalibrationDuration()
Returns the background calibration duration as set bysetBackgroundCalibrationDuration(int)
.int
getBootloaderMode()
Returns the current bootloader mode, seesetBootloaderMode(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 bysetHumidityCallbackConfiguration(long, boolean, char, int, int)
.BrickletAirQuality.IAQIndex
getIAQIndex()
Returns the IAQ index and accuracy.BrickletAirQuality.IAQIndexCallbackConfiguration
getIAQIndexCallbackConfiguration()
Returns the listener configuration as set bysetIAQIndexCallbackConfiguration(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 bysetStatusLEDConfig(int)
int
getTemperature()
Returns temperature.BrickletAirQuality.TemperatureCallbackConfiguration
getTemperatureCallbackConfiguration()
Returns the listener configuration as set bysetTemperatureCallbackConfiguration(long, boolean, char, int, int)
.int
getTemperatureOffset()
Returns the temperature offset as set bysetTemperatureOffset(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 theBrickletAirQuality.AirPressureListener
listener is triggered periodically.void
setAllValuesCallbackConfiguration(long period, boolean valueHasToChange)
The period is the period with which theBrickletAirQuality.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 theBrickletAirQuality.HumidityListener
listener is triggered periodically.void
setIAQIndexCallbackConfiguration(long period, boolean valueHasToChange)
The period is the period with which theBrickletAirQuality.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 theBrickletAirQuality.TemperatureListener
listener is triggered periodically.void
setTemperatureOffset(int offset)
Sets a temperature offset.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_ALL_VALUES
public static final byte FUNCTION_GET_ALL_VALUES
- See Also:
- Constant Field Values
-
FUNCTION_SET_TEMPERATURE_OFFSET
public static final byte FUNCTION_SET_TEMPERATURE_OFFSET
- See Also:
- Constant Field Values
-
FUNCTION_GET_TEMPERATURE_OFFSET
public static final byte FUNCTION_GET_TEMPERATURE_OFFSET
- See Also:
- Constant Field Values
-
FUNCTION_SET_ALL_VALUES_CALLBACK_CONFIGURATION
public static final byte FUNCTION_SET_ALL_VALUES_CALLBACK_CONFIGURATION
- See Also:
- Constant Field Values
-
FUNCTION_GET_ALL_VALUES_CALLBACK_CONFIGURATION
public static final byte FUNCTION_GET_ALL_VALUES_CALLBACK_CONFIGURATION
- See Also:
- Constant Field Values
-
FUNCTION_GET_IAQ_INDEX
public static final byte FUNCTION_GET_IAQ_INDEX
- See Also:
- Constant Field Values
-
FUNCTION_SET_IAQ_INDEX_CALLBACK_CONFIGURATION
public static final byte FUNCTION_SET_IAQ_INDEX_CALLBACK_CONFIGURATION
- See Also:
- Constant Field Values
-
FUNCTION_GET_IAQ_INDEX_CALLBACK_CONFIGURATION
public static final byte FUNCTION_GET_IAQ_INDEX_CALLBACK_CONFIGURATION
- See Also:
- Constant Field Values
-
FUNCTION_GET_TEMPERATURE
public static final byte FUNCTION_GET_TEMPERATURE
- See Also:
- Constant Field Values
-
FUNCTION_SET_TEMPERATURE_CALLBACK_CONFIGURATION
public static final byte FUNCTION_SET_TEMPERATURE_CALLBACK_CONFIGURATION
- See Also:
- Constant Field Values
-
FUNCTION_GET_TEMPERATURE_CALLBACK_CONFIGURATION
public static final byte FUNCTION_GET_TEMPERATURE_CALLBACK_CONFIGURATION
- See Also:
- Constant Field Values
-
FUNCTION_GET_HUMIDITY
public static final byte FUNCTION_GET_HUMIDITY
- See Also:
- Constant Field Values
-
FUNCTION_SET_HUMIDITY_CALLBACK_CONFIGURATION
public static final byte FUNCTION_SET_HUMIDITY_CALLBACK_CONFIGURATION
- See Also:
- Constant Field Values
-
FUNCTION_GET_HUMIDITY_CALLBACK_CONFIGURATION
public static final byte FUNCTION_GET_HUMIDITY_CALLBACK_CONFIGURATION
- See Also:
- Constant Field Values
-
FUNCTION_GET_AIR_PRESSURE
public static final byte FUNCTION_GET_AIR_PRESSURE
- See Also:
- Constant Field Values
-
FUNCTION_SET_AIR_PRESSURE_CALLBACK_CONFIGURATION
public static final byte FUNCTION_SET_AIR_PRESSURE_CALLBACK_CONFIGURATION
- See Also:
- Constant Field Values
-
FUNCTION_GET_AIR_PRESSURE_CALLBACK_CONFIGURATION
public static final byte FUNCTION_GET_AIR_PRESSURE_CALLBACK_CONFIGURATION
- See Also:
- Constant Field Values
-
FUNCTION_REMOVE_CALIBRATION
public static final byte FUNCTION_REMOVE_CALIBRATION
- See Also:
- Constant Field Values
-
FUNCTION_SET_BACKGROUND_CALIBRATION_DURATION
public static final byte FUNCTION_SET_BACKGROUND_CALIBRATION_DURATION
- See Also:
- Constant Field Values
-
FUNCTION_GET_BACKGROUND_CALIBRATION_DURATION
public static final byte FUNCTION_GET_BACKGROUND_CALIBRATION_DURATION
- 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
-
ACCURACY_UNRELIABLE
public static final int ACCURACY_UNRELIABLE
- See Also:
- Constant Field Values
-
ACCURACY_LOW
public static final int ACCURACY_LOW
- See Also:
- Constant Field Values
-
ACCURACY_MEDIUM
public static final int ACCURACY_MEDIUM
- See Also:
- Constant Field Values
-
ACCURACY_HIGH
public static final int ACCURACY_HIGH
- 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
-
DURATION_4_DAYS
public static final int DURATION_4_DAYS
- See Also:
- Constant Field Values
-
DURATION_28_DAYS
public static final int DURATION_28_DAYS
- 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
-
BrickletAirQuality
public BrickletAirQuality(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
-
getAllValues
public BrickletAirQuality.AllValues getAllValues() throws TinkerforgeException
Returns all values measured by the Air Quality Bricklet. The values are IAQ (Indoor Air Quality) Index (higher value means greater level of air pollution), IAQ Index Accuracy, Temperature, Humidity and Air Pressure. .. image:: /Images/Misc/bricklet_air_quality_iaq_index.png :scale: 100 % :alt: Air Quality Index description :align: center :target: ../../_images/Misc/bricklet_air_quality_iaq_index.png- Throws:
TinkerforgeException
-
setTemperatureOffset
public void setTemperatureOffset(int offset) throws TinkerforgeException
Sets a temperature offset. A offset of 10 will decrease the measured temperature by 0.1 °C. If you install this Bricklet into an enclosure and you want to measure the ambient temperature, you may have to decrease the measured temperature by some value to compensate for the error because of the heating inside of the enclosure. We recommend that you leave the parts in the enclosure running for at least 24 hours such that a temperature equilibrium can be reached. After that you can measure the temperature directly outside of enclosure and set the difference as offset. This temperature offset is used to calculate the relative humidity and IAQ index measurements. In case the Bricklet is installed in an enclosure, we recommend to measure and set the temperature offset to improve the accuracy of the measurements.- Throws:
TinkerforgeException
-
getTemperatureOffset
public int getTemperatureOffset() throws TinkerforgeException
Returns the temperature offset as set bysetTemperatureOffset(int)
.- Throws:
TinkerforgeException
-
setAllValuesCallbackConfiguration
public void setAllValuesCallbackConfiguration(long period, boolean valueHasToChange) throws TinkerforgeException
The period is the period with which theBrickletAirQuality.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.- Throws:
TinkerforgeException
-
getAllValuesCallbackConfiguration
public BrickletAirQuality.AllValuesCallbackConfiguration getAllValuesCallbackConfiguration() throws TinkerforgeException
Returns the listener configuration as set bysetAllValuesCallbackConfiguration(long, boolean)
.- Throws:
TinkerforgeException
-
getIAQIndex
public BrickletAirQuality.IAQIndex getIAQIndex() throws TinkerforgeException
Returns the IAQ index and accuracy. The higher the IAQ index, the greater the level of air pollution. .. image:: /Images/Misc/bricklet_air_quality_iaq_index.png :scale: 100 % :alt: IAQ index description :align: center :target: ../../_images/Misc/bricklet_air_quality_iaq_index.png If you want to get the value periodically, it is recommended to use theBrickletAirQuality.IAQIndexListener
listener. You can set the listener configuration withsetIAQIndexCallbackConfiguration(long, boolean)
.- Throws:
TinkerforgeException
-
setIAQIndexCallbackConfiguration
public void setIAQIndexCallbackConfiguration(long period, boolean valueHasToChange) throws TinkerforgeException
The period is the period with which theBrickletAirQuality.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.- Throws:
TinkerforgeException
-
getIAQIndexCallbackConfiguration
public BrickletAirQuality.IAQIndexCallbackConfiguration getIAQIndexCallbackConfiguration() throws TinkerforgeException
Returns the listener configuration as set bysetIAQIndexCallbackConfiguration(long, boolean)
.- Throws:
TinkerforgeException
-
getTemperature
public int getTemperature() throws TinkerforgeException
Returns temperature. If you want to get the value periodically, it is recommended to use theBrickletAirQuality.TemperatureListener
listener. You can set the listener configuration withsetTemperatureCallbackConfiguration(long, boolean, char, int, int)
.- Throws:
TinkerforgeException
-
setTemperatureCallbackConfiguration
public void setTemperatureCallbackConfiguration(long period, boolean valueHasToChange, char option, int min, int max) throws TinkerforgeException
The period is the period with which theBrickletAirQuality.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 theBrickletAirQuality.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.- Throws:
TinkerforgeException
-
getTemperatureCallbackConfiguration
public BrickletAirQuality.TemperatureCallbackConfiguration getTemperatureCallbackConfiguration() throws TinkerforgeException
Returns the listener configuration as set bysetTemperatureCallbackConfiguration(long, boolean, char, int, int)
.- Throws:
TinkerforgeException
-
getHumidity
public int getHumidity() throws TinkerforgeException
Returns relative humidity. If you want to get the value periodically, it is recommended to use theBrickletAirQuality.HumidityListener
listener. You can set the listener configuration withsetHumidityCallbackConfiguration(long, boolean, char, int, int)
.- Throws:
TinkerforgeException
-
setHumidityCallbackConfiguration
public void setHumidityCallbackConfiguration(long period, boolean valueHasToChange, char option, int min, int max) throws TinkerforgeException
The period is the period with which theBrickletAirQuality.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 theBrickletAirQuality.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.- Throws:
TinkerforgeException
-
getHumidityCallbackConfiguration
public BrickletAirQuality.HumidityCallbackConfiguration getHumidityCallbackConfiguration() throws TinkerforgeException
Returns the listener configuration as set bysetHumidityCallbackConfiguration(long, boolean, char, int, int)
.- Throws:
TinkerforgeException
-
getAirPressure
public int getAirPressure() throws TinkerforgeException
Returns air pressure. If you want to get the value periodically, it is recommended to use theBrickletAirQuality.AirPressureListener
listener. You can set the listener configuration withsetAirPressureCallbackConfiguration(long, boolean, char, int, int)
.- Throws:
TinkerforgeException
-
setAirPressureCallbackConfiguration
public void setAirPressureCallbackConfiguration(long period, boolean valueHasToChange, char option, int min, int max) throws TinkerforgeException
The period is the period with which theBrickletAirQuality.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 theBrickletAirQuality.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.- Throws:
TinkerforgeException
-
getAirPressureCallbackConfiguration
public BrickletAirQuality.AirPressureCallbackConfiguration getAirPressureCallbackConfiguration() throws TinkerforgeException
Returns the listener configuration as set bysetAirPressureCallbackConfiguration(long, boolean, char, int, int)
.- Throws:
TinkerforgeException
-
removeCalibration
public void removeCalibration() throws TinkerforgeException
Deletes the calibration from flash. After you call this function, you need to power cycle the Air Quality Bricklet. On the next power up the Bricklet will start a new calibration, as if it was started for the very first time. The calibration is based on the data of the last four days, so it takes four days until a full calibration is re-established. .. versionadded:: 2.0.3$nbsp;(Plugin)- Throws:
TinkerforgeException
-
setBackgroundCalibrationDuration
public void setBackgroundCalibrationDuration(int duration) throws TinkerforgeException
The Air Quality Bricklet uses an automatic background calibration mechanism to calculate the IAQ Index. This calibration mechanism considers a history of measured data. The duration of this history can be configured to either be 4 days or 28 days. If you keep the Bricklet mostly at one place and it does not get moved around to different environments, we recommend that you use a duration of 28 days. If you change the duration, the current calibration will be discarded and the calibration will start from beginning again. The configuration of the duration is saved in flash, so you should only have to call this function once in the lifetime of the Bricklet. The Bricklet has to be power cycled after this function is called for a duration change to take effect. Before firmware version 2.0.3 this was not configurable and the duration was 4 days. The default value (since firmware version 2.0.3) is 28 days. .. versionadded:: 2.0.3$nbsp;(Plugin)- Throws:
TinkerforgeException
-
getBackgroundCalibrationDuration
public int getBackgroundCalibrationDuration() throws TinkerforgeException
Returns the background calibration duration as set bysetBackgroundCalibrationDuration(int)
. .. versionadded:: 2.0.3$nbsp;(Plugin)- Throws:
TinkerforgeException
-
getSPITFPErrorCount
public BrickletAirQuality.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
-
addAllValuesListener
public void addAllValuesListener(BrickletAirQuality.AllValuesListener listener)
Adds a AllValues listener.
-
removeAllValuesListener
public void removeAllValuesListener(BrickletAirQuality.AllValuesListener listener)
Removes a AllValues listener.
-
addIAQIndexListener
public void addIAQIndexListener(BrickletAirQuality.IAQIndexListener listener)
Adds a IAQIndex listener.
-
removeIAQIndexListener
public void removeIAQIndexListener(BrickletAirQuality.IAQIndexListener listener)
Removes a IAQIndex listener.
-
addTemperatureListener
public void addTemperatureListener(BrickletAirQuality.TemperatureListener listener)
Adds a Temperature listener.
-
removeTemperatureListener
public void removeTemperatureListener(BrickletAirQuality.TemperatureListener listener)
Removes a Temperature listener.
-
addHumidityListener
public void addHumidityListener(BrickletAirQuality.HumidityListener listener)
Adds a Humidity listener.
-
removeHumidityListener
public void removeHumidityListener(BrickletAirQuality.HumidityListener listener)
Removes a Humidity listener.
-
addAirPressureListener
public void addAirPressureListener(BrickletAirQuality.AirPressureListener listener)
Adds a AirPressure listener.
-
removeAirPressureListener
public void removeAirPressureListener(BrickletAirQuality.AirPressureListener listener)
Removes a AirPressure listener.
-
-