Java - Air Quality Bricklet

This is the description of the Java API bindings for the Air Quality Bricklet. General information and technical specifications for the Air Quality Bricklet are summarized in its hardware description.

An installation guide for the Java API bindings is part of their general description.

Examples

The example code below is Public Domain (CC0 1.0).

Simple

Download (ExampleSimple.java)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
import com.tinkerforge.IPConnection;
import com.tinkerforge.BrickletAirQuality;
import com.tinkerforge.BrickletAirQuality.AllValues;

public class ExampleSimple {
    private static final String HOST = "localhost";
    private static final int PORT = 4223;

    // Change XYZ to the UID of your Air Quality Bricklet
    private static final String UID = "XYZ";

    // Note: To make the example code cleaner we do not handle exceptions. Exceptions
    //       you might normally want to catch are described in the documentation
    public static void main(String args[]) throws Exception {
        IPConnection ipcon = new IPConnection(); // Create IP connection
        BrickletAirQuality aq = new BrickletAirQuality(UID, ipcon); // Create device object

        ipcon.connect(HOST, PORT); // Connect to brickd
        // Don't use device before ipcon is connected

        // Get current all values
        AllValues allValues = aq.getAllValues(); // Can throw com.tinkerforge.TimeoutException

        System.out.println("IAQ Index: " + allValues.iaqIndex);

        if(allValues.iaqIndexAccuracy == BrickletAirQuality.ACCURACY_UNRELIABLE) {
            System.out.println("IAQ Index Accuracy: Unreliable");
        } else if(allValues.iaqIndexAccuracy == BrickletAirQuality.ACCURACY_LOW) {
            System.out.println("IAQ Index Accuracy: Low");
        } else if(allValues.iaqIndexAccuracy == BrickletAirQuality.ACCURACY_MEDIUM) {
            System.out.println("IAQ Index Accuracy: Medium");
        } else if(allValues.iaqIndexAccuracy == BrickletAirQuality.ACCURACY_HIGH) {
            System.out.println("IAQ Index Accuracy: High");
        }

        System.out.println("Temperature: " + allValues.temperature/100.0 + " °C");
        System.out.println("Humidity: " + allValues.humidity/100.0 + " %RH");
        System.out.println("Air Pressure: " + allValues.airPressure/100.0 + " mbar");

        System.out.println("Press key to exit"); System.in.read();
        ipcon.disconnect();
    }
}

Callback

Download (ExampleCallback.java)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
import com.tinkerforge.IPConnection;
import com.tinkerforge.BrickletAirQuality;

public class ExampleCallback {
    private static final String HOST = "localhost";
    private static final int PORT = 4223;

    // Change XYZ to the UID of your Air Quality Bricklet
    private static final String UID = "XYZ";

    // Note: To make the example code cleaner we do not handle exceptions. Exceptions
    //       you might normally want to catch are described in the documentation
    public static void main(String args[]) throws Exception {
        IPConnection ipcon = new IPConnection(); // Create IP connection
        BrickletAirQuality aq = new BrickletAirQuality(UID, ipcon); // Create device object

        ipcon.connect(HOST, PORT); // Connect to brickd
        // Don't use device before ipcon is connected

        // Add all values listener
        aq.addAllValuesListener(new BrickletAirQuality.AllValuesListener() {
            public void allValues(int iaqIndex, int iaqIndexAccuracy, int temperature,
                                  int humidity, int airPressure) {
                System.out.println("IAQ Index: " + iaqIndex);

                if(iaqIndexAccuracy == BrickletAirQuality.ACCURACY_UNRELIABLE) {
                    System.out.println("IAQ Index Accuracy: Unreliable");
                } else if(iaqIndexAccuracy == BrickletAirQuality.ACCURACY_LOW) {
                    System.out.println("IAQ Index Accuracy: Low");
                } else if(iaqIndexAccuracy == BrickletAirQuality.ACCURACY_MEDIUM) {
                    System.out.println("IAQ Index Accuracy: Medium");
                } else if(iaqIndexAccuracy == BrickletAirQuality.ACCURACY_HIGH) {
                    System.out.println("IAQ Index Accuracy: High");
                }

                System.out.println("Temperature: " + temperature/100.0 + " °C");
                System.out.println("Humidity: " + humidity/100.0 + " %RH");
                System.out.println("Air Pressure: " + airPressure/100.0 + " mbar");
                System.out.println("");
            }
        });

        // Set period for all values callback to 1s (1000ms)
        aq.setAllValuesCallbackConfiguration(1000, false);

        System.out.println("Press key to exit"); System.in.read();
        ipcon.disconnect();
    }
}

API

Generally, every method of the Java bindings that returns a value can throw a TimeoutException. This exception gets thrown if the device did not respond. If a cable based connection is used, it is unlikely that this exception gets thrown (assuming nobody unplugs the device). However, if a wireless connection is used, timeouts will occur if the distance to the device gets too big.

Beside the TimeoutException there is also a NotConnectedException that is thrown if a method needs to communicate with the device while the IP Connection is not connected.

Since Java does not support multiple return values and return by reference is not possible for primitive types, we use small classes that only consist of member variables. The member variables of the returned objects are described in the corresponding method descriptions.

The package for all Brick/Bricklet bindings and the IP Connection is com.tinkerforge.*

All methods listed below are thread-safe.

Basic Functions

public class BrickletAirQuality(String uid, IPConnection ipcon)

Creates an object with the unique device ID uid:

BrickletAirQuality airQuality = new BrickletAirQuality("YOUR_DEVICE_UID", ipcon);

This object can then be used after the IP Connection is connected (see examples above).

public BrickletAirQuality.AllValues getAllValues()

Returns all values measured by the Air Quality Bricklet. The values are IAQ (Indoor Air Quality) Index, IAQ Index Accuracy, Temperature, Humidity and Air Pressure.

Air Quality Index description

The values have these ranges and units:

  • IAQ Index: 0 to 500, higher value means greater level of air pollution
  • IAQ Index Accuracy: 0 = unreliable to 3 = high
  • Temperature: in steps of 0.01 °C
  • Humidity: in steps of 0.01 %RH
  • Air Pressure: in steps of 0.01 mbar

The following constants are available for this function:

  • BrickletAirQuality.ACCURACY_UNRELIABLE = 0
  • BrickletAirQuality.ACCURACY_LOW = 1
  • BrickletAirQuality.ACCURACY_MEDIUM = 2
  • BrickletAirQuality.ACCURACY_HIGH = 3

The returned object has the public member variables int iaqIndex, int iaqIndexAccuracy, int temperature, int humidity and int airPressure.

public void setTemperatureOffset(int offset)

Sets a temperature offset in 1/100°C. 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 imporve the accuracy of the measurements.

public int getTemperatureOffset()

Returns the temperature offset as set by setTemperatureOffset().

public BrickletAirQuality.IAQIndex getIAQIndex()

Returns the IAQ index and accuracy. The IAQ index goes from 0 to 500. The higher the IAQ index, the greater the level of air pollution.

IAQ index description

If you want to get the value periodically, it is recommended to use the IAQIndexListener listener. You can set the listener configuration with setIAQIndexCallbackConfiguration().

The following constants are available for this function:

  • BrickletAirQuality.ACCURACY_UNRELIABLE = 0
  • BrickletAirQuality.ACCURACY_LOW = 1
  • BrickletAirQuality.ACCURACY_MEDIUM = 2
  • BrickletAirQuality.ACCURACY_HIGH = 3

The returned object has the public member variables int iaqIndex and int iaqIndexAccuracy.

public int getTemperature()

Returns temperature in steps of 0.01 °C.

If you want to get the value periodically, it is recommended to use the TemperatureListener listener. You can set the listener configuration with setTemperatureCallbackConfiguration().

public int getHumidity()

Returns relative humidity in steps of 0.01 %RH.

If you want to get the value periodically, it is recommended to use the HumidityListener listener. You can set the listener configuration with setHumidityCallbackConfiguration().

public int getAirPressure()

Returns air pressure in steps of 0.01 mbar.

If you want to get the value periodically, it is recommended to use the AirPressureListener listener. You can set the listener configuration with setAirPressureCallbackConfiguration().

Advanced Functions

public int[] getAPIVersion()

Returns the version of the API definition (major, minor, revision) implemented by this API bindings. This is neither the release version of this API bindings nor does it tell you anything about the represented Brick or Bricklet.

public boolean getResponseExpected(int functionId)

Returns the response expected flag for the function specified by the function ID parameter. It is true if the function is expected to send a response, false otherwise.

For getter functions this is enabled by default and cannot be disabled, because those functions will always send a response. For listener configuration functions it is enabled by default too, but can be disabled by setResponseExpected(). For setter functions it is disabled by default and can be enabled.

Enabling the response expected flag for a setter function allows to detect timeouts and other error conditions calls of this setter as well. The device will then send a response for this purpose. If this flag is disabled for a setter function then no response is send and errors are silently ignored, because they cannot be detected.

See setResponseExpected() for the list of function ID constants available for this function.

public void setResponseExpected(int functionId, boolean responseExpected)

Changes the response expected flag of the function specified by the function ID parameter. This flag can only be changed for setter (default value: false) and listener configuration functions (default value: true). For getter functions it is always enabled.

Enabling the response expected flag for a setter function allows to detect timeouts and other error conditions calls of this setter as well. The device will then send a response for this purpose. If this flag is disabled for a setter function then no response is send and errors are silently ignored, because they cannot be detected.

The following function ID constants are available for this function:

  • BrickletAirQuality.FUNCTION_SET_TEMPERATURE_OFFSET = 2
  • BrickletAirQuality.FUNCTION_SET_ALL_VALUES_CALLBACK_CONFIGURATION = 4
  • BrickletAirQuality.FUNCTION_SET_IAQ_INDEX_CALLBACK_CONFIGURATION = 8
  • BrickletAirQuality.FUNCTION_SET_TEMPERATURE_CALLBACK_CONFIGURATION = 12
  • BrickletAirQuality.FUNCTION_SET_HUMIDITY_CALLBACK_CONFIGURATION = 16
  • BrickletAirQuality.FUNCTION_SET_AIR_PRESSURE_CALLBACK_CONFIGURATION = 20
  • BrickletAirQuality.FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
  • BrickletAirQuality.FUNCTION_SET_STATUS_LED_CONFIG = 239
  • BrickletAirQuality.FUNCTION_RESET = 243
  • BrickletAirQuality.FUNCTION_WRITE_UID = 248
public void setResponseExpectedAll(boolean responseExpected)

Changes the response expected flag for all setter and listener configuration functions of this device at once.

public BrickletAirQuality.SPITFPErrorCount getSPITFPErrorCount()

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.

The returned object has the public member variables long errorCountAckChecksum, long errorCountMessageChecksum, long errorCountFrame and long errorCountOverflow.

public int setBootloaderMode(int mode)

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.

The following constants are available for this function:

  • BrickletAirQuality.BOOTLOADER_MODE_BOOTLOADER = 0
  • BrickletAirQuality.BOOTLOADER_MODE_FIRMWARE = 1
  • BrickletAirQuality.BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
  • BrickletAirQuality.BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
  • BrickletAirQuality.BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4
  • BrickletAirQuality.BOOTLOADER_STATUS_OK = 0
  • BrickletAirQuality.BOOTLOADER_STATUS_INVALID_MODE = 1
  • BrickletAirQuality.BOOTLOADER_STATUS_NO_CHANGE = 2
  • BrickletAirQuality.BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT = 3
  • BrickletAirQuality.BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT = 4
  • BrickletAirQuality.BOOTLOADER_STATUS_CRC_MISMATCH = 5
public int getBootloaderMode()

Returns the current bootloader mode, see setBootloaderMode().

The following constants are available for this function:

  • BrickletAirQuality.BOOTLOADER_MODE_BOOTLOADER = 0
  • BrickletAirQuality.BOOTLOADER_MODE_FIRMWARE = 1
  • BrickletAirQuality.BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
  • BrickletAirQuality.BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
  • BrickletAirQuality.BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4
public void setWriteFirmwarePointer(long pointer)

Sets the firmware pointer for writeFirmware(). 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.

public int writeFirmware(int[] data)

Writes 64 Bytes of firmware at the position as written by setWriteFirmwarePointer() 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.

public void setStatusLEDConfig(int config)

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.

The following constants are available for this function:

  • BrickletAirQuality.STATUS_LED_CONFIG_OFF = 0
  • BrickletAirQuality.STATUS_LED_CONFIG_ON = 1
  • BrickletAirQuality.STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • BrickletAirQuality.STATUS_LED_CONFIG_SHOW_STATUS = 3
public int getStatusLEDConfig()

Returns the configuration as set by setStatusLEDConfig()

The following constants are available for this function:

  • BrickletAirQuality.STATUS_LED_CONFIG_OFF = 0
  • BrickletAirQuality.STATUS_LED_CONFIG_ON = 1
  • BrickletAirQuality.STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • BrickletAirQuality.STATUS_LED_CONFIG_SHOW_STATUS = 3
public int getChipTemperature()

Returns the temperature in °C 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.

public void reset()

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!

public void writeUID(long uid)

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.

public long readUID()

Returns the current UID as an integer. Encode as Base58 to get the usual string version.

public BrickletAirQuality.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.

The position can be 'a', 'b', 'c' or 'd'.

The device identifier numbers can be found here. There is also a constant for the device identifier of this Bricklet.

The returned object has the public member variables String uid, String connectedUid, char position, int[] hardwareVersion, int[] firmwareVersion and int deviceIdentifier.

Listener Configuration Functions

public void setAllValuesCallbackConfiguration(long period, boolean valueHasToChange)

The period in ms is the period with which the 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.

The default value is (0, false).

public BrickletAirQuality.AllValuesCallbackConfiguration getAllValuesCallbackConfiguration()

Returns the listener configuration as set by setAllValuesCallbackConfiguration().

The returned object has the public member variables long period and boolean valueHasToChange.

public void setIAQIndexCallbackConfiguration(long period, boolean valueHasToChange)

The period in ms is the period with which the 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.

The default value is (0, false).

public BrickletAirQuality.IAQIndexCallbackConfiguration getIAQIndexCallbackConfiguration()

Returns the listener configuration as set by setIAQIndexCallbackConfiguration().

The returned object has the public member variables long period and boolean valueHasToChange.

public void setTemperatureCallbackConfiguration(long period, boolean valueHasToChange, char option, int min, int max)

The period in ms is the period with which the 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 TemperatureListener listener.

The following options are possible:

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)

If the option is set to 'x' (threshold turned off) the listener is triggered with the fixed period.

The default value is (0, false, 'x', 0, 0).

The following constants are available for this function:

  • BrickletAirQuality.THRESHOLD_OPTION_OFF = 'x'
  • BrickletAirQuality.THRESHOLD_OPTION_OUTSIDE = 'o'
  • BrickletAirQuality.THRESHOLD_OPTION_INSIDE = 'i'
  • BrickletAirQuality.THRESHOLD_OPTION_SMALLER = '<'
  • BrickletAirQuality.THRESHOLD_OPTION_GREATER = '>'
public BrickletAirQuality.TemperatureCallbackConfiguration getTemperatureCallbackConfiguration()

Returns the listener configuration as set by setTemperatureCallbackConfiguration().

The following constants are available for this function:

  • BrickletAirQuality.THRESHOLD_OPTION_OFF = 'x'
  • BrickletAirQuality.THRESHOLD_OPTION_OUTSIDE = 'o'
  • BrickletAirQuality.THRESHOLD_OPTION_INSIDE = 'i'
  • BrickletAirQuality.THRESHOLD_OPTION_SMALLER = '<'
  • BrickletAirQuality.THRESHOLD_OPTION_GREATER = '>'

The returned object has the public member variables long period, boolean valueHasToChange, char option, int min and int max.

public void setHumidityCallbackConfiguration(long period, boolean valueHasToChange, char option, int min, int max)

The period in ms is the period with which the 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 HumidityListener listener.

The following options are possible:

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)

If the option is set to 'x' (threshold turned off) the listener is triggered with the fixed period.

The default value is (0, false, 'x', 0, 0).

The following constants are available for this function:

  • BrickletAirQuality.THRESHOLD_OPTION_OFF = 'x'
  • BrickletAirQuality.THRESHOLD_OPTION_OUTSIDE = 'o'
  • BrickletAirQuality.THRESHOLD_OPTION_INSIDE = 'i'
  • BrickletAirQuality.THRESHOLD_OPTION_SMALLER = '<'
  • BrickletAirQuality.THRESHOLD_OPTION_GREATER = '>'
public BrickletAirQuality.HumidityCallbackConfiguration getHumidityCallbackConfiguration()

Returns the listener configuration as set by setHumidityCallbackConfiguration().

The following constants are available for this function:

  • BrickletAirQuality.THRESHOLD_OPTION_OFF = 'x'
  • BrickletAirQuality.THRESHOLD_OPTION_OUTSIDE = 'o'
  • BrickletAirQuality.THRESHOLD_OPTION_INSIDE = 'i'
  • BrickletAirQuality.THRESHOLD_OPTION_SMALLER = '<'
  • BrickletAirQuality.THRESHOLD_OPTION_GREATER = '>'

The returned object has the public member variables long period, boolean valueHasToChange, char option, int min and int max.

public void setAirPressureCallbackConfiguration(long period, boolean valueHasToChange, char option, int min, int max)

The period in ms is the period with which the 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 AirPressureListener listener.

The following options are possible:

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)

If the option is set to 'x' (threshold turned off) the listener is triggered with the fixed period.

The default value is (0, false, 'x', 0, 0).

The following constants are available for this function:

  • BrickletAirQuality.THRESHOLD_OPTION_OFF = 'x'
  • BrickletAirQuality.THRESHOLD_OPTION_OUTSIDE = 'o'
  • BrickletAirQuality.THRESHOLD_OPTION_INSIDE = 'i'
  • BrickletAirQuality.THRESHOLD_OPTION_SMALLER = '<'
  • BrickletAirQuality.THRESHOLD_OPTION_GREATER = '>'
public BrickletAirQuality.AirPressureCallbackConfiguration getAirPressureCallbackConfiguration()

Returns the listener configuration as set by setAirPressureCallbackConfiguration().

The following constants are available for this function:

  • BrickletAirQuality.THRESHOLD_OPTION_OFF = 'x'
  • BrickletAirQuality.THRESHOLD_OPTION_OUTSIDE = 'o'
  • BrickletAirQuality.THRESHOLD_OPTION_INSIDE = 'i'
  • BrickletAirQuality.THRESHOLD_OPTION_SMALLER = '<'
  • BrickletAirQuality.THRESHOLD_OPTION_GREATER = '>'

The returned object has the public member variables long period, boolean valueHasToChange, char option, int min and int max.

Listeners

Listeners can be registered to receive time critical or recurring data from the device. The registration is done with "add*Listener" functions of the device object.

The parameter is a listener class object, for example:

device.addExampleListener(new BrickletAirQuality.ExampleListener() {
    public void property(int value) {
        System.out.println("Value: " + value);
    }
});

The available listener classes with inherent methods to be overwritten are described below. It is possible to add several listeners and to remove them with the corresponding "remove*Listener" function.

Note

Using listeners for recurring events is always preferred compared to using getters. It will use less USB bandwidth and the latency will be a lot better, since there is no round trip time.

public class BrickletAirQuality.AllValuesListener()

This listener can be added with the addAllValuesListener() function. An added listener can be removed with the removeAllValuesListener() function.

public void allValues(int iaqIndex, int iaqIndexAccuracy, int temperature, int humidity, int airPressure)

This listener is triggered periodically according to the configuration set by setAllValuesCallbackConfiguration().

The parameters are the same as getAllValues().

The following constants are available for this function:

  • BrickletAirQuality.ACCURACY_UNRELIABLE = 0
  • BrickletAirQuality.ACCURACY_LOW = 1
  • BrickletAirQuality.ACCURACY_MEDIUM = 2
  • BrickletAirQuality.ACCURACY_HIGH = 3
public class BrickletAirQuality.IAQIndexListener()

This listener can be added with the addIAQIndexListener() function. An added listener can be removed with the removeIAQIndexListener() function.

public void iaqIndex(int iaqIndex, int iaqIndexAccuracy)

This listener is triggered periodically according to the configuration set by setIAQIndexCallbackConfiguration().

The parameters are the same as getIAQIndex().

The following constants are available for this function:

  • BrickletAirQuality.ACCURACY_UNRELIABLE = 0
  • BrickletAirQuality.ACCURACY_LOW = 1
  • BrickletAirQuality.ACCURACY_MEDIUM = 2
  • BrickletAirQuality.ACCURACY_HIGH = 3
public class BrickletAirQuality.TemperatureListener()

This listener can be added with the addTemperatureListener() function. An added listener can be removed with the removeTemperatureListener() function.

public void temperature(int temperature)

This listener is triggered periodically according to the configuration set by setTemperatureCallbackConfiguration().

The parameter is the same as getTemperature().

public class BrickletAirQuality.HumidityListener()

This listener can be added with the addHumidityListener() function. An added listener can be removed with the removeHumidityListener() function.

public void humidity(int humidity)

This listener is triggered periodically according to the configuration set by setHumidityCallbackConfiguration().

The parameter is the same as getHumidity().

public class BrickletAirQuality.AirPressureListener()

This listener can be added with the addAirPressureListener() function. An added listener can be removed with the removeAirPressureListener() function.

public void airPressure(int airPressure)

This listener is triggered periodically according to the configuration set by setAirPressureCallbackConfiguration().

The parameter is the same as getAirPressure().

Constants

public static final int BrickletAirQuality.DEVICE_IDENTIFIER

This constant is used to identify a Air Quality Bricklet.

The getIdentity() function and the EnumerateListener listener of the IP Connection have a deviceIdentifier parameter to specify the Brick's or Bricklet's type.

public static final String BrickletAirQuality.DEVICE_DISPLAY_NAME

This constant represents the human readable name of a Air Quality Bricklet.