Java - Air Quality Bricklet

Dies ist die Beschreibung der Java API Bindings für das Air Quality Bricklet. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des Air Quality Bricklet sind in dessen Hardware Beschreibung zusammengefasst.

Eine Installationanleitung für die Java API Bindings ist Teil deren allgemeine Beschreibung.

Beispiele

Der folgende Beispielcode ist 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

Prinzipiell kann jede Methode der Java Bindings eine TimeoutException werfen. Diese Exception wird geworfen wenn das Gerät nicht antwortet. Wenn eine Kabelverbindung genutzt wird, ist es unwahrscheinlich, dass die Exception geworfen wird (unter der Annahme, dass das Gerät nicht abgesteckt wird). Bei einer drahtlosen Verbindung können Zeitüberschreitungen auftreten, sobald die Entfernung zum Gerät zu groß wird.

Neben der TimeoutException kann auch noch eine NotConnectedException geworfen werden, wenn versucht wird mit einem Brick oder Bricklet zu kommunizieren, aber die IP Connection nicht verbunden ist.

Da Java nicht mehrere Rückgabewerte unterstützt und eine Referenzrückgabe für elementare Type nicht möglich ist, werden kleine Klassen verwendet, die nur aus Member-Variablen bestehen. Die Member-Variablen des zurückgegebenen Objektes werden in der jeweiligen Methodenbeschreibung erläutert.

Das Package für alle Brick/Bricklet Bindings und die IP Connection ist com.tinkerforge.*

Alle folgend aufgelisteten Methoden sind Thread-sicher.

Grundfunktionen

public class BrickletAirQuality(String uid, IPConnection ipcon)

Erzeugt ein Objekt mit der eindeutigen Geräte ID uid:

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

Dieses Objekt kann benutzt werden, nachdem die IP Connection verbunden ist (siehe Beispiele oben).

public BrickletAirQuality.AllValues getAllValues()

Gibt alle Werte zurück, die das Air Quality Bricklet misst. Diese Werte umfassen: IAQ (Indoor Air Quality = Innenraumluftqualität) Index, IAQ Index Genauigkeit, Temperatur, Luftfeuchte und Luftdruck.

Air Quality Index description

Die Werte haben diese Bereiche und Einheiten:

  • IAQ Index: 0 bis 500, ein höhere Werte bedeutet eine stärkere Luftverschmutzung
  • IAQ Index Genauigkeit: 0 = unzuverlässig bis 3 = hoch
  • Temperatur: in 0,01 °C Schritten
  • Luftfeuchte: in 0,01 %RH Schritten
  • Luftdruck: in 0,01 mbar Schritten

Die folgenden Konstanten sind für diese Funktion verfügbar:

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

Das zurückgegebene Objekt enthält die Public-Member-Variablen int iaqIndex, int iaqIndexAccuracy, int temperature, int humidity und int airPressure.

public void setTemperatureOffset(int offset)

Setzt ein Temperatur-Offset mit Auflösung 1/100°C. Ein Offset von 10 verringert die gemessene Temperatur um 0,1°C.

Wenn das Bricklet in einem Gehäuse verbaut wird, aber die Umgebungstemperatur außerhalb des Gehäuses gemessen werden soll, dann muss vom gemessenen Temperatur ein bestimmter Wert abgezogen werden, um den Messfehler durch das Aufheizen des Gehäuses zu kompensieren.

Wir empfehlen den Messaufbau im Gehäuse mindestens 24 Stunden laufen zu lassen, damit sich ein Temperaturgleichgewicht einstellt. Danach muss die Temperatur außerhalb des Gehäuses gemessen werden und die Differenz zur Temperatur innerhalb des Gehäuses als Offset eingestellt werden.

Dieses Temperatur-Offset geht in die Berechnung der Luftfeuchte und des IAQ Index mit ein. Um die Genauigkeit der Messwerte innerhalb eines Gehäuses zu verbessern sollte der Temperatur-Offset unbedingt bestimmt und eingestellt werden.

public int getTemperatureOffset()

Gibt das Temperatur-Offset zurück, wie mittels setTemperatureOffset() gesetzt.

public BrickletAirQuality.IAQIndex getIAQIndex()

Gibt den IAQ Index und dessen Genaugkeit zurück. Der IAQ Index hate einen Wertebereich von 0 bis 500, ein höhere Werte bedeutet eine stärkere Luftverschmutzung.

IAQ Index Beschreibung

Wenn der Wert periodisch benötigt wird, kann auch der IAQIndexListener Listener verwendet werden. Der Listener wird mit der Funktion setIAQIndexCallbackConfiguration() konfiguriert.

Die folgenden Konstanten sind für diese Funktion verfügbar:

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

Das zurückgegebene Objekt enthält die Public-Member-Variablen int iaqIndex und int iaqIndexAccuracy.

public int getTemperature()

Gibt die Temperatur in 0,01 °C Schritten zurück.

Wenn der Wert periodisch benötigt wird, kann auch der TemperatureListener Listener verwendet werden. Der Listener wird mit der Funktion setTemperatureCallbackConfiguration() konfiguriert.

public int getHumidity()

Gibt die relative Luftfeuchtigkeit in 0,01 %RH Schritten zurück.

Wenn der Wert periodisch benötigt wird, kann auch der HumidityListener Listener verwendet werden. Der Listener wird mit der Funktion setHumidityCallbackConfiguration() konfiguriert.

public int getAirPressure()

Gibt den Luftdruck in 0,01 mbar Schritten zurück.

Wenn der Wert periodisch benötigt wird, kann auch der AirPressureListener Listener verwendet werden. Der Listener wird mit der Funktion setAirPressureCallbackConfiguration() konfiguriert.

Fortgeschrittene Funktionen

public void removeCalibration()

Löscht die Kalibrierung auf dem Flash. Nach dem diese Funktion aufgerufen wird muss das Air Quality Bricklet vom Strom getrennt werden.

Beim nächsten starten des Bricklet wird eine komplett neue Kalibrierung gestartet, wie beim allerersten Starten des Bricklets.

Die Kalibrierung basiert auf den Daten der letzten vier Tage, daher dauert es vier Tage bis eine volle Kalibrierung wieder hergestellt ist.

Neu in Version 2.0.3 (Plugin).

public void setBackgroundCalibrationDuration(int duration)

Das Air Quality Bricklet nutzt eine automatische Hintergrundkalibrierung um den IAQ-Index zu bestimmen. Der Kalibrierungsmechanismus nutzt eine Historie von gemessenen Werte. Die Länge dieser Historie kann zwischen 4 und 28 Tagen konfiguriert werden.

Wenn das Bricklet hauptsächlich am gleichen Ort bleibt und die Umgebung nicht oft verändert wird, empfehlen wir eine Länge von 28 Tagen zu verwenden.

Wenn die Länge geändert wird,wird die aktuelle Kalibrierung verworfen und die Kalibrierung beginnt von vorne. Die Konfiguration der Länge wird im Flash gespeichert, diese Funktion sollte also nur einmal in der Lebenszeit des Bricklets aufgerufen werden müssen.

Eine Änderung der Kalibrierungslänge wird beim nächsten Start des Bricklets übernommen.

Vor Firmware-Version 2.0.3 war die Hintergrundkalibrierungslänge 4 Tage und nicht konfigurierbare.

Der Standardwert (seit Firmware-Version 2.0.3) beträgt 28 Tage.

Die folgenden Konstanten sind für diese Funktion verfügbar:

  • BrickletAirQuality.DURATION_4_DAYS = 0
  • BrickletAirQuality.DURATION_28_DAYS = 1

Neu in Version 2.0.3 (Plugin).

public int getBackgroundCalibrationDuration()

Gibt die Länge der Hintergrundkalibrierung zurück, wie von setBackgroundCalibrationDuration() gesetzt.

Die folgenden Konstanten sind für diese Funktion verfügbar:

  • BrickletAirQuality.DURATION_4_DAYS = 0
  • BrickletAirQuality.DURATION_28_DAYS = 1

Neu in Version 2.0.3 (Plugin).

public int[] getAPIVersion()

Gibt die Version der API Definition (Major, Minor, Revision) zurück, die diese API Bindings implementieren. Dies ist weder die Release-Version dieser API Bindings noch gibt es in irgendeiner Weise Auskunft über den oder das repräsentierte(n) Brick oder Bricklet.

public boolean getResponseExpected(int functionId)

Gibt das Response-Expected-Flag für die Funktion mit der angegebenen Funktions IDs zurück. Es ist true falls für die Funktion beim Aufruf eine Antwort erwartet wird, false andernfalls.

Für Getter-Funktionen ist diese Flag immer gesetzt und kann nicht entfernt werden, da diese Funktionen immer eine Antwort senden. Für Konfigurationsfunktionen für Listeners ist es standardmäßig gesetzt, kann aber entfernt werden mittels setResponseExpected(). Für Setter-Funktionen ist es standardmäßig nicht gesetzt, kann aber gesetzt werden.

Wenn das Response-Expected-Flag für eine Setter-Funktion gesetzt ist, können Timeouts und andere Fehlerfälle auch für Aufrufe dieser Setter-Funktion detektiert werden. Das Gerät sendet dann eine Antwort extra für diesen Zweck. Wenn das Flag für eine Setter-Funktion nicht gesetzt ist, dann wird keine Antwort vom Gerät gesendet und Fehler werden stillschweigend ignoriert, da sie nicht detektiert werden können.

Siehe setResponseExpected() für die Liste der verfügbaren Funktions ID Konstanten für diese Funktion.

public void setResponseExpected(int functionId, boolean responseExpected)

Ändert das Response-Expected-Flag für die Funktion mit der angegebenen Funktion IDs. Diese Flag kann nur für Setter-Funktionen (Standardwert: false) und Konfigurationsfunktionen für Listeners (Standardwert: true) geändert werden. Für Getter-Funktionen ist das Flag immer gesetzt.

Wenn das Response-Expected-Flag für eine Setter-Funktion gesetzt ist, können Timeouts und andere Fehlerfälle auch für Aufrufe dieser Setter-Funktion detektiert werden. Das Gerät sendet dann eine Antwort extra für diesen Zweck. Wenn das Flag für eine Setter-Funktion nicht gesetzt ist, dann wird keine Antwort vom Gerät gesendet und Fehler werden stillschweigend ignoriert, da sie nicht detektiert werden können.

Die folgenden Funktions ID Konstanten sind für diese Funktion verfügbar:

  • 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_REMOVE_CALIBRATION = 23
  • BrickletAirQuality.FUNCTION_SET_BACKGROUND_CALIBRATION_DURATION = 24
  • 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)

Ändert das Response-Expected-Flag für alle Setter-Funktionen und Konfigurationsfunktionen für Listeners diese Gerätes.

public BrickletAirQuality.SPITFPErrorCount getSPITFPErrorCount()

Gibt die Anzahl der Fehler die während der Kommunikation zwischen Brick und Bricklet aufgetreten sind zurück.

Die Fehler sind aufgeteilt in

  • ACK-Checksummen Fehler,
  • Message-Checksummen Fehler,
  • Framing Fehler und
  • Overflow Fehler.

Die Fehlerzähler sind für Fehler die auf der Seite des Bricklets auftreten. Jedes Brick hat eine ähnliche Funktion welche die Fehler auf Brickseite ausgibt.

Das zurückgegebene Objekt enthält die Public-Member-Variablen long errorCountAckChecksum, long errorCountMessageChecksum, long errorCountFrame und long errorCountOverflow.

public int setBootloaderMode(int mode)

Setzt den Bootloader-Modus und gibt den Status zurück nachdem die Modusänderungsanfrage bearbeitet wurde.

Mit dieser Funktion ist es möglich vom Bootloader- in den Firmware-Modus zu wechseln und umgekehrt. Ein Welchsel vom Bootlodaer- in der den Firmware-Modus ist nur möglich wenn Entry-Funktion, Device Identifier und CRC vorhanden und korrekt sind.

Diese Funktion wird vom Brick Viewer während des flashens benutzt. In einem normalem Nutzerprogramm sollte diese Funktion nicht benötigt werden.

Die folgenden Konstanten sind für diese Funktion verfügbar:

  • 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()

Gibt den aktuellen Bootloader-Modus zurück, siehe setBootloaderMode().

Die folgenden Konstanten sind für diese Funktion verfügbar:

  • 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)

Setzt den Firmware-Pointer für writeFirmware(). Der Pointer muss um je 64 Byte erhöht werden. Die Daten werden alle 4 Datenblöcke in den Flash geschrieben (4 Datenblöcke entsprechen einer Page mit 256 Byte).

Diese Funktion wird vom Brick Viewer während des flashens benutzt. In einem normalem Nutzerprogramm sollte diese Funktion nicht benötigt werden.

public int writeFirmware(int[] data)

Schreibt 64 Bytes Firmware an die Position die vorher von setWriteFirmwarePointer() gesetzt wurde. Die Firmware wird alle 4 Datenblöcke in den Flash geschrieben.

Eine Firmware kann nur im Bootloader-Mode geschrieben werden.

Diese Funktion wird vom Brick Viewer während des flashens benutzt. In einem normalem Nutzerprogramm sollte diese Funktion nicht benötigt werden.

public void setStatusLEDConfig(int config)

Setzt die Konfiguration der Status-LED. Standardmäßig zeigt die LED die Kommunikationsdatenmenge an. Sie blinkt einmal auf pro 10 empfangenen Datenpaketen zwischen Brick und Bricklet.

Die LED kann auch permanent an/aus gestellt werden oder einen Herzschlag anzeigen.

Wenn das Bricklet sich im Bootlodermodus befindet ist die LED aus.

Die folgenden Konstanten sind für diese Funktion verfügbar:

  • 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()

Gibt die Konfiguration zurück, wie von setStatusLEDConfig() gesetzt.

Die folgenden Konstanten sind für diese Funktion verfügbar:

  • 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()

Gibt die Temperatur in °C, gemessen im Mikrocontroller, aus. Der Rückgabewert ist nicht die Umgebungstemperatur.

Die Temperatur ist lediglich proportional zur echten Temperatur und hat eine hohe Ungenauigkeit. Daher beschränkt sich der praktische Nutzen auf die Indikation von Temperaturveränderungen.

public void reset()

Ein Aufruf dieser Funktion setzt das Bricklet zurück. Nach einem Neustart sind alle Konfiguration verloren.

Nach dem Zurücksetzen ist es notwendig neue Objekte zu erzeugen, Funktionsaufrufe auf bestehenden führen zu undefiniertem Verhalten.

public void writeUID(long uid)

Schreibt eine neue UID in den Flash. Die UID muss zuerst vom Base58 encodierten String in einen Integer decodiert werden.

Wir empfehlen die Nutzung des Brick Viewers zum ändern der UID.

public long readUID()

Gibt die aktuelle UID als Integer zurück. Dieser Integer kann als Base58 encodiert werden um an den üblichen UID-String zu gelangen.

public BrickletAirQuality.Identity getIdentity()

Gibt die UID, die UID zu der das Bricklet verbunden ist, die Position, die Hard- und Firmware Version sowie den Device Identifier zurück.

Die Position kann 'a', 'b', 'c' oder 'd' sein.

Eine Liste der Device Identifier Werte ist hier zu finden. Es gibt auch eine Konstante für den Device Identifier dieses Bricklets.

Das zurückgegebene Objekt enthält die Public-Member-Variablen String uid, String connectedUid, char position, int[] hardwareVersion, int[] firmwareVersion und int deviceIdentifier.

Konfigurationsfunktionen für Listener

public void setAllValuesCallbackConfiguration(long period, boolean valueHasToChange)

Die Periode in ms ist die Periode mit der der AllValuesListener Listener ausgelöst wird. Ein Wert von 0 schaltet den Listener ab.

Wenn der value has to change-Parameter auf True gesetzt wird, wird der Listener nur ausgelöst, wenn sich mindestens ein Wert im Vergleich zum letzten mal geändert hat. Ändert sich kein Wert innerhalb der Periode, so wird der Listener sofort ausgelöst, wenn ein Wert sich das nächste mal ändert.

Wird der Parameter auf False gesetzt, so wird der Listener dauerhaft mit der festen Periode ausgelöst unabhängig von den Änderungen der Werte.

Der Standardwert ist (0, false).

public BrickletAirQuality.AllValuesCallbackConfiguration getAllValuesCallbackConfiguration()

Gibt die Listener-Konfiguration zurück, wie mittels setAllValuesCallbackConfiguration() gesetzt.

Das zurückgegebene Objekt enthält die Public-Member-Variablen long period und boolean valueHasToChange.

public void setIAQIndexCallbackConfiguration(long period, boolean valueHasToChange)

Die Periode in ms ist die Periode mit der der IAQIndexListener Listener ausgelöst wird. Ein Wert von 0 schaltet den Listener ab.

Wenn der value has to change-Parameter auf True gesetzt wird, wird der Listener nur ausgelöst, wenn sich mindestens ein Wert im Vergleich zum letzten mal geändert hat. Ändert sich kein Wert innerhalb der Periode, so wird der Listener sofort ausgelöst, wenn ein Wert sich das nächste mal ändert.

Wird der Parameter auf False gesetzt, so wird der Listener dauerhaft mit der festen Periode ausgelöst unabhängig von den Änderungen der Werte.

Der Standardwert ist (0, false).

public BrickletAirQuality.IAQIndexCallbackConfiguration getIAQIndexCallbackConfiguration()

Gibt die Listener-Konfiguration zurück, wie mittels setIAQIndexCallbackConfiguration() gesetzt.

Das zurückgegebene Objekt enthält die Public-Member-Variablen long period und boolean valueHasToChange.

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

Die Periode in ms ist die Periode mit der der TemperatureListener Listener ausgelöst wird. Ein Wert von 0 schaltet den Listener ab.

Wenn der value has to change-Parameter auf True gesetzt wird, wird der Listener nur ausgelöst, wenn der Wert sich im Vergleich zum letzten mal geändert hat. Ändert der Wert sich nicht innerhalb der Periode, so wird der Listener sofort ausgelöst, wenn der Wert sich das nächste mal ändert.

Wird der Parameter auf False gesetzt, so wird der Listener dauerhaft mit der festen Periode ausgelöst unabhängig von den Änderungen des Werts.

Desweiteren ist es möglich den Listener mittels Thresholds einzuschränken.

Der option-Parameter`zusammen mit min/max setzt einen Threshold für den TemperatureListener Listener.

Die folgenden Optionen sind möglich:

Option Beschreibung
'x' Threshold ist abgeschaltet
'o' Threshold wird ausgelöst, wenn der Wert außerhalb der Min und Max Werte sind
'i' Threshold wird ausgelöst, wenn der Wert innerhalb der Min und Max Werte sind
'<' Threshold wird ausgelöst, wenn der Wert kleiner ist wie der Min Wert (Max wird ignoriert)
'>' Threshold wird ausgelöst, wenn der Wert größer ist wie der Max Wert (Min wird ignoriert)

Wird die Option auf 'x' gesetzt (Threshold abgeschaltet), so wird der Listener mit der festen Periode ausgelöst.

Der Standardwert ist (0, false, 'x', 0, 0).

Die folgenden Konstanten sind für diese Funktion verfügbar:

  • 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()

Gibt die Listener-Konfiguration zurück, wie mittels setTemperatureCallbackConfiguration() gesetzt.

Die folgenden Konstanten sind für diese Funktion verfügbar:

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

Das zurückgegebene Objekt enthält die Public-Member-Variablen long period, boolean valueHasToChange, char option, int min und int max.

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

Die Periode in ms ist die Periode mit der der HumidityListener Listener ausgelöst wird. Ein Wert von 0 schaltet den Listener ab.

Wenn der value has to change-Parameter auf True gesetzt wird, wird der Listener nur ausgelöst, wenn der Wert sich im Vergleich zum letzten mal geändert hat. Ändert der Wert sich nicht innerhalb der Periode, so wird der Listener sofort ausgelöst, wenn der Wert sich das nächste mal ändert.

Wird der Parameter auf False gesetzt, so wird der Listener dauerhaft mit der festen Periode ausgelöst unabhängig von den Änderungen des Werts.

Desweiteren ist es möglich den Listener mittels Thresholds einzuschränken.

Der option-Parameter`zusammen mit min/max setzt einen Threshold für den HumidityListener Listener.

Die folgenden Optionen sind möglich:

Option Beschreibung
'x' Threshold ist abgeschaltet
'o' Threshold wird ausgelöst, wenn der Wert außerhalb der Min und Max Werte sind
'i' Threshold wird ausgelöst, wenn der Wert innerhalb der Min und Max Werte sind
'<' Threshold wird ausgelöst, wenn der Wert kleiner ist wie der Min Wert (Max wird ignoriert)
'>' Threshold wird ausgelöst, wenn der Wert größer ist wie der Max Wert (Min wird ignoriert)

Wird die Option auf 'x' gesetzt (Threshold abgeschaltet), so wird der Listener mit der festen Periode ausgelöst.

Der Standardwert ist (0, false, 'x', 0, 0).

Die folgenden Konstanten sind für diese Funktion verfügbar:

  • 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()

Gibt die Listener-Konfiguration zurück, wie mittels setHumidityCallbackConfiguration() gesetzt.

Die folgenden Konstanten sind für diese Funktion verfügbar:

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

Das zurückgegebene Objekt enthält die Public-Member-Variablen long period, boolean valueHasToChange, char option, int min und int max.

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

Die Periode in ms ist die Periode mit der der AirPressureListener Listener ausgelöst wird. Ein Wert von 0 schaltet den Listener ab.

Wenn der value has to change-Parameter auf True gesetzt wird, wird der Listener nur ausgelöst, wenn der Wert sich im Vergleich zum letzten mal geändert hat. Ändert der Wert sich nicht innerhalb der Periode, so wird der Listener sofort ausgelöst, wenn der Wert sich das nächste mal ändert.

Wird der Parameter auf False gesetzt, so wird der Listener dauerhaft mit der festen Periode ausgelöst unabhängig von den Änderungen des Werts.

Desweiteren ist es möglich den Listener mittels Thresholds einzuschränken.

Der option-Parameter`zusammen mit min/max setzt einen Threshold für den AirPressureListener Listener.

Die folgenden Optionen sind möglich:

Option Beschreibung
'x' Threshold ist abgeschaltet
'o' Threshold wird ausgelöst, wenn der Wert außerhalb der Min und Max Werte sind
'i' Threshold wird ausgelöst, wenn der Wert innerhalb der Min und Max Werte sind
'<' Threshold wird ausgelöst, wenn der Wert kleiner ist wie der Min Wert (Max wird ignoriert)
'>' Threshold wird ausgelöst, wenn der Wert größer ist wie der Max Wert (Min wird ignoriert)

Wird die Option auf 'x' gesetzt (Threshold abgeschaltet), so wird der Listener mit der festen Periode ausgelöst.

Der Standardwert ist (0, false, 'x', 0, 0).

Die folgenden Konstanten sind für diese Funktion verfügbar:

  • 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()

Gibt die Listener-Konfiguration zurück, wie mittels setAirPressureCallbackConfiguration() gesetzt.

Die folgenden Konstanten sind für diese Funktion verfügbar:

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

Das zurückgegebene Objekt enthält die Public-Member-Variablen long period, boolean valueHasToChange, char option, int min und int max.

Listener

Listener können registriert werden um zeitkritische oder wiederkehrende Daten vom Gerät zu erhalten. Die Registrierung kann mit "add*Listener" Funktionen eines Geräteobjekts durchgeführt werden.

Der Parameter ist ein Listener Klassen Objekt, z.B.:

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

Die verfügbaren Listener Klassen mit den Methoden welche überschrieben werden können werden unterhalb beschrieben. Es ist möglich mehrere Listener hinzuzufügen und auch mit einem korrespondierenden "remove*Listener" wieder zu entfernen.

Bemerkung

Listener für wiederkehrende Ereignisse zu verwenden ist immer zu bevorzugen gegenüber der Verwendung von Abfragen. Es wird weniger USB-Bandbreite benutzt und die Latenz ist erheblich geringer, da es keine Paketumlaufzeit gibt.

public class BrickletAirQuality.AllValuesListener()

Dieser Listener kann mit der Funktion addAllValuesListener() hinzugefügt werde. Ein hinzugefügter Listener kann mit der Funktion removeAllValuesListener() wieder entfernt werden.

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

Dieser Listener wird periodisch ausgelöst abhängig von der mittels setAllValuesCallbackConfiguration() gesetzten Konfiguration

Die Parameter sind der gleiche wie getAllValues().

Die folgenden Konstanten sind für diese Funktion verfügbar:

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

Dieser Listener kann mit der Funktion addIAQIndexListener() hinzugefügt werde. Ein hinzugefügter Listener kann mit der Funktion removeIAQIndexListener() wieder entfernt werden.

public void iaqIndex(int iaqIndex, int iaqIndexAccuracy)

Dieser Listener wird periodisch ausgelöst abhängig von der mittels setIAQIndexCallbackConfiguration() gesetzten Konfiguration

Die Parameter sind die gleichen wie getIAQIndex().

Die folgenden Konstanten sind für diese Funktion verfügbar:

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

Dieser Listener kann mit der Funktion addTemperatureListener() hinzugefügt werde. Ein hinzugefügter Listener kann mit der Funktion removeTemperatureListener() wieder entfernt werden.

public void temperature(int temperature)

Dieser Listener wird periodisch ausgelöst abhängig von der mittels setTemperatureCallbackConfiguration() gesetzten Konfiguration

Der Parameter ist der gleiche wie getTemperature().

public class BrickletAirQuality.HumidityListener()

Dieser Listener kann mit der Funktion addHumidityListener() hinzugefügt werde. Ein hinzugefügter Listener kann mit der Funktion removeHumidityListener() wieder entfernt werden.

public void humidity(int humidity)

Dieser Listener wird periodisch ausgelöst abhängig von der mittels setHumidityCallbackConfiguration() gesetzten Konfiguration

Der Parameter ist der gleiche wie getHumidity().

public class BrickletAirQuality.AirPressureListener()

Dieser Listener kann mit der Funktion addAirPressureListener() hinzugefügt werde. Ein hinzugefügter Listener kann mit der Funktion removeAirPressureListener() wieder entfernt werden.

public void airPressure(int airPressure)

Dieser Listener wird periodisch ausgelöst abhängig von der mittels setAirPressureCallbackConfiguration() gesetzten Konfiguration

Der Parameter ist der gleiche wie getAirPressure().

Konstanten

public static final int BrickletAirQuality.DEVICE_IDENTIFIER

Diese Konstante wird verwendet um ein Air Quality Bricklet zu identifizieren.

Die getIdentity() Funktion und der EnumerateListener Listener der IP Connection haben ein deviceIdentifier Parameter um den Typ des Bricks oder Bricklets anzugeben.

public static final String BrickletAirQuality.DEVICE_DISPLAY_NAME

Diese Konstante stellt den Anzeigenamen eines Air Quality Bricklet dar.