Java - CO2 Bricklet

Dies ist die Beschreibung der Java API Bindings für das CO2 Bricklet. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des CO2 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
import com.tinkerforge.IPConnection;
import com.tinkerforge.BrickletCO2;

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

    // Change XYZ to the UID of your CO2 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
        BrickletCO2 co2 = new BrickletCO2(UID, ipcon); // Create device object

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

        // Get current CO2 concentration
        int co2Concentration = co2.getCO2Concentration(); // Can throw com.tinkerforge.TimeoutException
        System.out.println("CO2 Concentration: " + co2Concentration + " ppm");

        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
import com.tinkerforge.IPConnection;
import com.tinkerforge.BrickletCO2;

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

    // Change XYZ to the UID of your CO2 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
        BrickletCO2 co2 = new BrickletCO2(UID, ipcon); // Create device object

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

        // Add CO2 concentration listener
        co2.addCO2ConcentrationListener(new BrickletCO2.CO2ConcentrationListener() {
            public void co2Concentration(int co2Concentration) {
                System.out.println("CO2 Concentration: " + co2Concentration + " ppm");
            }
        });

        // Set period for CO2 concentration callback to 1s (1000ms)
        // Note: The CO2 concentration callback is only called every second
        //       if the CO2 concentration has changed since the last call!
        co2.setCO2ConcentrationCallbackPeriod(1000);

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

Threshold

Download (ExampleThreshold.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
import com.tinkerforge.IPConnection;
import com.tinkerforge.BrickletCO2;

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

    // Change XYZ to the UID of your CO2 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
        BrickletCO2 co2 = new BrickletCO2(UID, ipcon); // Create device object

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

        // Get threshold callbacks with a debounce time of 10 seconds (10000ms)
        co2.setDebouncePeriod(10000);

        // Add CO2 concentration reached listener
        co2.addCO2ConcentrationReachedListener(new BrickletCO2.CO2ConcentrationReachedListener() {
            public void co2ConcentrationReached(int co2Concentration) {
                System.out.println("CO2 Concentration: " + co2Concentration + " ppm");
            }
        });

        // Configure threshold for CO2 concentration "greater than 750 ppm"
        co2.setCO2ConcentrationCallbackThreshold('>', 750, 0);

        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 BrickletCO2(String uid, IPConnection ipcon)

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

BrickletCO2 co2 = new BrickletCO2("YOUR_DEVICE_UID", ipcon);

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

public int getCO2Concentration()

Gibt die gemessene CO2-Konzentration zurück. Der Wert ist in ppm (Teile pro Million) und im Bereich von 0 bis 10000.

Wenn die CO2-Konzentration periodisch abgefragt werden soll, wird empfohlen den CO2ConcentrationListener Listener zu nutzen und die Periode mit setCO2ConcentrationCallbackPeriod() vorzugeben.

Fortgeschrittene Funktionen

public short[] 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(short 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(short 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:

  • BrickletCO2.FUNCTION_SET_CO2_CONCENTRATION_CALLBACK_PERIOD = 2
  • BrickletCO2.FUNCTION_SET_CO2_CONCENTRATION_CALLBACK_THRESHOLD = 4
  • BrickletCO2.FUNCTION_SET_DEBOUNCE_PERIOD = 6
public void setResponseExpectedAll(boolean responseExpected)

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

public BrickletCO2.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, short[] hardwareVersion, short[] firmwareVersion und int deviceIdentifier.

Konfigurationsfunktionen für Listener

public void setCO2ConcentrationCallbackPeriod(long period)

Setzt die Periode in ms mit welcher der CO2ConcentrationListener Listener ausgelöst wird. Ein Wert von 0 deaktiviert den Listener.

Der CO2ConcentrationListener Listener wird nur ausgelöst wenn sich die CO2-Konzentration seit der letzten Auslösung geändert hat.

Der Standardwert ist 0.

public long getCO2ConcentrationCallbackPeriod()

Gibt die Periode zurück, wie von setCO2ConcentrationCallbackPeriod() gesetzt.

public void setCO2ConcentrationCallbackThreshold(char option, int min, int max)

Setzt den Schwellwert für den CO2ConcentrationReachedListener Listener.

Die folgenden Optionen sind möglich:

Option Beschreibung
'x' Listener ist inaktiv
'o' Listener wird ausgelöst wenn die CO2-Konzentration außerhalb des min und max Wertes ist
'i' Listener wird ausgelöst wenn die CO2-Konzentration innerhalb des min und max Wertes ist
'<' Listener wird ausgelöst wenn die CO2-Konzentration kleiner als der min Wert ist (max wird ignoriert)
'>' Listener wird ausgelöst wenn die CO2-Konzentration größer als der min Wert ist (max wird ignoriert)

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

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

  • BrickletCO2.THRESHOLD_OPTION_OFF = 'x'
  • BrickletCO2.THRESHOLD_OPTION_OUTSIDE = 'o'
  • BrickletCO2.THRESHOLD_OPTION_INSIDE = 'i'
  • BrickletCO2.THRESHOLD_OPTION_SMALLER = '<'
  • BrickletCO2.THRESHOLD_OPTION_GREATER = '>'
public BrickletCO2.CO2ConcentrationCallbackThreshold getCO2ConcentrationCallbackThreshold()

Gibt den Schwellwert zurück, wie von setCO2ConcentrationCallbackThreshold() gesetzt.

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

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

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

public void setDebouncePeriod(long debounce)

Setzt die Periode in ms mit welcher die Schwellwert Listeners

ausgelöst werden, wenn die Schwellwerte

weiterhin erreicht bleiben.

Der Standardwert ist 100.

public long getDebouncePeriod()

Gibt die Entprellperiode zurück, wie von setDebouncePeriod() gesetzt.

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 BrickletCO2.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 BrickletCO2.CO2ConcentrationListener()

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

public void co2Concentration(int co2Concentration)

Dieser Listener wird mit der Periode, wie gesetzt mit setCO2ConcentrationCallbackPeriod(), ausgelöst. Der Parameter ist die gemessene CO2-Konzentration des Sensors.

Der CO2ConcentrationListener Listener wird nur ausgelöst wenn sich die CO2-Konzentration seit der letzten Auslösung geändert hat.

public class BrickletCO2.CO2ConcentrationReachedListener()

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

public void co2ConcentrationReached(int co2Concentration)

Dieser Listener wird ausgelöst wenn der Schwellwert, wie von setCO2ConcentrationCallbackThreshold() gesetzt, erreicht wird. Der Parameter ist die gemessene CO2-Konzentration.

Wenn der Schwellwert erreicht bleibt, wird der Listener mit der Periode, wie mit setDebouncePeriod() gesetzt, ausgelöst.

Konstanten

public static final int BrickletCO2.DEVICE_IDENTIFIER

Diese Konstante wird verwendet um ein CO2 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 BrickletCO2.DEVICE_DISPLAY_NAME

Diese Konstante stellt den Anzeigenamen eines CO2 Bricklet dar.