Java - CO2 Bricklet¶

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();
    }
}

Grundfunktionen¶

class BrickletCO2(String uid, IPConnection ipcon)¶

Parameter:	uid – Typ: String ipcon – Typ: IPConnection
Rückgabe:	co2 – Typ: BrickletCO2

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.

int BrickletCO2.getCO2Concentration()¶

Rückgabe:	co2Concentration – Typ: int, Einheit: 1 ppm, Wertebereich: [0 bis 10000]

Gibt die gemessene CO2-Konzentration zurück.

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

Fortgeschrittene Funktionen¶

BrickletCO2.Identity BrickletCO2.getIdentity()¶

Rückgabeobjekt:

uid – Typ: String, Länge: bis zu 8 connectedUid – Typ: String, Länge: bis zu 8 position – Typ: char, Wertebereich: ['a' bis 'h', 'z'] hardwareVersion – Typ: short[], Länge: 3 0: major – Typ: short, Wertebereich: [0 bis 255] 1: minor – Typ: short, Wertebereich: [0 bis 255] 2: revision – Typ: short, Wertebereich: [0 bis 255] firmwareVersion – Typ: short[], Länge: 3 0: major – Typ: short, Wertebereich: [0 bis 255] 1: minor – Typ: short, Wertebereich: [0 bis 255] 2: revision – Typ: short, Wertebereich: [0 bis 255] deviceIdentifier – Typ: int, Wertebereich: [0 bis 216 - 1]

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 ist 'a', 'b', 'c', 'd', 'e', 'f', 'g' oder 'h' (Bricklet Anschluss). Ein Bricklet hinter einem Isolator Bricklet ist immer an Position 'z'.

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

Konfigurationsfunktionen für Listener¶

void BrickletCO2.setCO2ConcentrationCallbackPeriod(long period)¶

Parameter:	period – Typ: long, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0

Setzt die Periode 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.

long BrickletCO2.getCO2ConcentrationCallbackPeriod()¶

Rückgabe:	period – Typ: long, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0

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

void BrickletCO2.setCO2ConcentrationCallbackThreshold(char option, int min, int max)¶

Parameter:	option – Typ: char, Wertebereich: Siehe Konstanten, Standardwert: 'x' min – Typ: int, Einheit: 1 ppm, Wertebereich: [0 bis 216 - 1], Standardwert: 0 max – Typ: int, Einheit: 1 ppm, Wertebereich: [0 bis 216 - 1], Standardwert: 0

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)

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

Für option:

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

BrickletCO2.CO2ConcentrationCallbackThreshold BrickletCO2.getCO2ConcentrationCallbackThreshold()¶

Rückgabeobjekt:	option – Typ: char, Wertebereich: Siehe Konstanten, Standardwert: 'x' min – Typ: int, Einheit: 1 ppm, Wertebereich: [0 bis 216 - 1], Standardwert: 0 max – Typ: int, Einheit: 1 ppm, Wertebereich: [0 bis 216 - 1], Standardwert: 0

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

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

Für option:

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

void BrickletCO2.setDebouncePeriod(long debounce)¶

Parameter:	debounce – Typ: long, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 100

Setzt die Periode mit welcher die Schwellwert Listeners

• CO2ConcentrationReachedListener,

ausgelöst werden, wenn die Schwellwerte

• setCO2ConcentrationCallbackThreshold(),

weiterhin erreicht bleiben.

long BrickletCO2.getDebouncePeriod()¶

Rückgabe:	debounce – Typ: long, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 100

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.

class BrickletCO2.CO2ConcentrationListener()¶

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

void co2Concentration(int co2Concentration)

Parameter:	co2Concentration – Typ: int, Einheit: 1 ppm, Wertebereich: [0 bis 10000]

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.

class BrickletCO2.CO2ConcentrationReachedListener()¶

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

void co2ConcentrationReached(int co2Concentration)

Parameter:	co2Concentration – Typ: int, Einheit: 1 ppm, Wertebereich: [0 bis 10000]

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.

Virtuelle Funktionen¶

Virtuelle Funktionen kommunizieren nicht mit dem Gerät selbst, sie arbeiten nur auf dem API Bindings Objekt. Dadurch können sie auch aufgerufen werden, ohne das das dazugehörige IP Connection Objekt verbunden ist.

short[] BrickletCO2.getAPIVersion()¶

Rückgabeobjekt:	apiVersion – Typ: short[], Länge: 3 0: major – Typ: short, Wertebereich: [0 bis 255] 1: minor – Typ: short, Wertebereich: [0 bis 255] 2: revision – Typ: short, Wertebereich: [0 bis 255]

Gibt die Version der API Definition 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.

boolean BrickletCO2.getResponseExpected(byte functionId)¶

Parameter:	functionId – Typ: byte, Wertebereich: Siehe Konstanten
Rückgabe:	responseExpected – Typ: boolean

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.

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

Für functionId:

• BrickletCO2.FUNCTION_SET_CO2_CONCENTRATION_CALLBACK_PERIOD = 2
• BrickletCO2.FUNCTION_SET_CO2_CONCENTRATION_CALLBACK_THRESHOLD = 4
• BrickletCO2.FUNCTION_SET_DEBOUNCE_PERIOD = 6

void BrickletCO2.setResponseExpected(byte functionId, boolean responseExpected)¶

Parameter:	functionId – Typ: byte, Wertebereich: Siehe Konstanten responseExpected – Typ: boolean

Ä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 Konstanten sind für diese Funktion verfügbar:

Für functionId:

• BrickletCO2.FUNCTION_SET_CO2_CONCENTRATION_CALLBACK_PERIOD = 2
• BrickletCO2.FUNCTION_SET_CO2_CONCENTRATION_CALLBACK_THRESHOLD = 4
• BrickletCO2.FUNCTION_SET_DEBOUNCE_PERIOD = 6

void BrickletCO2.setResponseExpectedAll(boolean responseExpected)¶

Parameter:	responseExpected – Typ: boolean

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

Konstanten¶

int BrickletCO2.DEVICE_IDENTIFIER¶

Diese Konstante wird verwendet um ein CO2 Bricklet zu identifizieren.

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

String BrickletCO2.DEVICE_DISPLAY_NAME¶

Diese Konstante stellt den Anzeigenamen eines CO2 Bricklet dar.