Java - CO2 Bricklet 2.0

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

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

    // Change XYZ to the UID of your CO2 Bricklet 2.0
    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
        BrickletCO2V2 co2 = new BrickletCO2V2(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 = co2.getAllValues(); // Can throw com.tinkerforge.TimeoutException

        System.out.println("CO2 Concentration: " + allValues.co2Concentration + " ppm");
        System.out.println("Temperature: " + allValues.temperature/100.0 + " °C");
        System.out.println("Humidity: " + allValues.humidity/100.0 + " %RH");

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

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

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

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

        // Add all values listener
        co2.addAllValuesListener(new BrickletCO2V2.AllValuesListener() {
            public void allValues(int co2Concentration, int temperature, int humidity) {
                System.out.println("CO2 Concentration: " + co2Concentration + " ppm");
                System.out.println("Temperature: " + temperature/100.0 + " °C");
                System.out.println("Humidity: " + humidity/100.0 + " %RH");
                System.out.println("");
            }
        });

        // Set period for all values callback to 1s (1000ms)
        co2.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

class BrickletCO2V2(String uid, IPConnection ipcon)
Parameter:
  • uid – Typ: String
  • ipcon – Typ: IPConnection
Rückgabe:
  • co2V2 – Typ: BrickletCO2V2

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

BrickletCO2V2 co2V2 = new BrickletCO2V2("YOUR_DEVICE_UID", ipcon);

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

BrickletCO2V2.AllValues BrickletCO2V2.getAllValues()
Rückgabeobjekt:
  • co2Concentration – Typ: int, Wertebereich: [0 bis 216 - 1]
  • temperature – Typ: int, Wertebereich: [-215 bis 215 - 1]
  • humidity – Typ: int, Wertebereich: [0 bis 216 - 1]

Gibt alle Werte zurück, die das CO2 Bricklet 2.0 misst. Diese Werte umfassen: CO2-Konzentration (in ppm), Temperatur (in 0,01 °C) und Luftfeuchte (in 0,01 %RH).

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

void BrickletCO2V2.setAirPressure(int airPressure)
Parameter:
  • airPressure – Typ: int, Wertebereich: [0 bis 216 - 1]

Die CO2-Konzentration hängt (unter anderem) vom Umgebungs-Luftdruck ab.

Um die Genauigkeit des CO2 Bricklet 2.0 zu verbessern ist es möglich den aktuellen Luftdruck zu setzen. Dazu kann das Barometer Bricklet 2.0 oder auch das Air Quality Bricklet genutzt werden.

Die erwartete Einheit des Umgebungs-Luftdrucks ist mbar.

Standardmäßig ist die Luftdruck-Kompensation deaktiviert. Sobald ein Wert gesetzt wird, wird dieser zur Kompensation verwendet. Die Kompensation kann wieder ausgestellt werden in dem der Wert zurück auf 0 gesetzt wird.

Es ist hinreichend den Wert alle paar Minuten zu aktualisieren.

int BrickletCO2V2.getAirPressure()
Rückgabe:
  • airPressure – Typ: int, Wertebereich: [0 bis 216 - 1]

Gibt den Umgebungs-Luftdruch zurück, wie von setAirPressure() gesetzt.

void BrickletCO2V2.setTemperatureOffset(int offset)
Parameter:
  • offset – Typ: int, Wertebereich: [0 bis 216 - 1]

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 der CO2-Konzentration mit ein. Um die Genauigkeit der Messwerte innerhalb eines Gehäuses zu verbessern sollte der Temperatur-Offset bestimmt und eingestellt werden.

Es ist hinreichend den Temperatur-Offset einmal zu setzen. Der Offset wird in einem nicht-flüchtigen Speicher gespeichert und auch nach einem Neustart wieder angewendet.

int BrickletCO2V2.getTemperatureOffset()
Rückgabe:
  • offset – Typ: int, Wertebereich: [0 bis 216 - 1]

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

int BrickletCO2V2.getCO2Concentration()
Rückgabe:
  • co2Concentration – Typ: int, Wertebereich: [0 bis 216 - 1]

Gibt die CO2-Konzentration in ppm zurück.

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

int BrickletCO2V2.getTemperature()
Rückgabe:
  • temperature – Typ: int, Wertebereich: [-215 bis 215 - 1]

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.

int BrickletCO2V2.getHumidity()
Rückgabe:
  • humidity – Typ: int, Wertebereich: [0 bis 216 - 1]

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.

Fortgeschrittene Funktionen

int[] BrickletCO2V2.getAPIVersion()
Rückgabe:
  • apiVersion – Typ: int[], Länge: 3, Wertebereich: [0 bis 255]

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.

boolean BrickletCO2V2.getResponseExpected(int functionId)
Parameter:
  • functionId – Typ: int, 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:

  • BrickletCO2V2.FUNCTION_SET_AIR_PRESSURE = 2
  • BrickletCO2V2.FUNCTION_SET_TEMPERATURE_OFFSET = 4
  • BrickletCO2V2.FUNCTION_SET_ALL_VALUES_CALLBACK_CONFIGURATION = 6
  • BrickletCO2V2.FUNCTION_SET_CO2_CONCENTRATION_CALLBACK_CONFIGURATION = 10
  • BrickletCO2V2.FUNCTION_SET_TEMPERATURE_CALLBACK_CONFIGURATION = 14
  • BrickletCO2V2.FUNCTION_SET_HUMIDITY_CALLBACK_CONFIGURATION = 18
  • BrickletCO2V2.FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
  • BrickletCO2V2.FUNCTION_SET_STATUS_LED_CONFIG = 239
  • BrickletCO2V2.FUNCTION_RESET = 243
  • BrickletCO2V2.FUNCTION_WRITE_UID = 248
void BrickletCO2V2.setResponseExpected(int functionId, boolean responseExpected)
Parameter:
  • functionId – Typ: int, 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:

  • BrickletCO2V2.FUNCTION_SET_AIR_PRESSURE = 2
  • BrickletCO2V2.FUNCTION_SET_TEMPERATURE_OFFSET = 4
  • BrickletCO2V2.FUNCTION_SET_ALL_VALUES_CALLBACK_CONFIGURATION = 6
  • BrickletCO2V2.FUNCTION_SET_CO2_CONCENTRATION_CALLBACK_CONFIGURATION = 10
  • BrickletCO2V2.FUNCTION_SET_TEMPERATURE_CALLBACK_CONFIGURATION = 14
  • BrickletCO2V2.FUNCTION_SET_HUMIDITY_CALLBACK_CONFIGURATION = 18
  • BrickletCO2V2.FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
  • BrickletCO2V2.FUNCTION_SET_STATUS_LED_CONFIG = 239
  • BrickletCO2V2.FUNCTION_RESET = 243
  • BrickletCO2V2.FUNCTION_WRITE_UID = 248
void BrickletCO2V2.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.

BrickletCO2V2.SPITFPErrorCount BrickletCO2V2.getSPITFPErrorCount()
Rückgabeobjekt:
  • errorCountAckChecksum – Typ: long, Wertebereich: [0 bis 232 - 1]
  • errorCountMessageChecksum – Typ: long, Wertebereich: [0 bis 232 - 1]
  • errorCountFrame – Typ: long, Wertebereich: [0 bis 232 - 1]
  • errorCountOverflow – Typ: long, Wertebereich: [0 bis 232 - 1]

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.

int BrickletCO2V2.setBootloaderMode(int mode)
Parameter:
  • mode – Typ: int, Wertebereich: Siehe Konstanten
Rückgabe:
  • status – Typ: int, Wertebereich: Siehe Konstanten

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:

Für mode:

  • BrickletCO2V2.BOOTLOADER_MODE_BOOTLOADER = 0
  • BrickletCO2V2.BOOTLOADER_MODE_FIRMWARE = 1
  • BrickletCO2V2.BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
  • BrickletCO2V2.BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
  • BrickletCO2V2.BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4

Für status:

  • BrickletCO2V2.BOOTLOADER_STATUS_OK = 0
  • BrickletCO2V2.BOOTLOADER_STATUS_INVALID_MODE = 1
  • BrickletCO2V2.BOOTLOADER_STATUS_NO_CHANGE = 2
  • BrickletCO2V2.BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT = 3
  • BrickletCO2V2.BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT = 4
  • BrickletCO2V2.BOOTLOADER_STATUS_CRC_MISMATCH = 5
int BrickletCO2V2.getBootloaderMode()
Rückgabe:
  • mode – Typ: int, Wertebereich: Siehe Konstanten

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

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

Für mode:

  • BrickletCO2V2.BOOTLOADER_MODE_BOOTLOADER = 0
  • BrickletCO2V2.BOOTLOADER_MODE_FIRMWARE = 1
  • BrickletCO2V2.BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
  • BrickletCO2V2.BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
  • BrickletCO2V2.BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4
void BrickletCO2V2.setWriteFirmwarePointer(long pointer)
Parameter:
  • pointer – Typ: long, Wertebereich: [0 bis 232 - 1]

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.

int BrickletCO2V2.writeFirmware(int[] data)
Parameter:
  • data – Typ: int[], Länge: 64, Wertebereich: [0 bis 255]
Rückgabe:
  • status – Typ: int, Wertebereich: [0 bis 255]

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.

void BrickletCO2V2.setStatusLEDConfig(int config)
Parameter:
  • config – Typ: int, Wertebereich: Siehe Konstanten

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:

Für config:

  • BrickletCO2V2.STATUS_LED_CONFIG_OFF = 0
  • BrickletCO2V2.STATUS_LED_CONFIG_ON = 1
  • BrickletCO2V2.STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • BrickletCO2V2.STATUS_LED_CONFIG_SHOW_STATUS = 3
int BrickletCO2V2.getStatusLEDConfig()
Rückgabe:
  • config – Typ: int, Wertebereich: Siehe Konstanten

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

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

Für config:

  • BrickletCO2V2.STATUS_LED_CONFIG_OFF = 0
  • BrickletCO2V2.STATUS_LED_CONFIG_ON = 1
  • BrickletCO2V2.STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • BrickletCO2V2.STATUS_LED_CONFIG_SHOW_STATUS = 3
int BrickletCO2V2.getChipTemperature()
Rückgabe:
  • temperature – Typ: int, Wertebereich: [-215 bis 215 - 1]

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.

void BrickletCO2V2.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.

void BrickletCO2V2.writeUID(long uid)
Parameter:
  • uid – Typ: long, Wertebereich: [0 bis 232 - 1]

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.

long BrickletCO2V2.readUID()
Rückgabe:
  • uid – Typ: long, Wertebereich: [0 bis 232 - 1]

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

BrickletCO2V2.Identity BrickletCO2V2.getIdentity()
Rückgabeobjekt:
  • uid – Typ: String, Länge: bis zu 8
  • connectedUid – Typ: String, Länge: bis zu 8
  • position – Typ: char
  • hardwareVersion – Typ: int[], Länge: 3, Wertebereich: [0 bis 255]
  • firmwareVersion – Typ: int[], Länge: 3, 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 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.

Konfigurationsfunktionen für Listener

void BrickletCO2V2.setAllValuesCallbackConfiguration(long period, boolean valueHasToChange)
Parameter:
  • period – Typ: long, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0
  • valueHasToChange – Typ: boolean, Standardwert: false

Die Periode 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.

BrickletCO2V2.AllValuesCallbackConfiguration BrickletCO2V2.getAllValuesCallbackConfiguration()
Rückgabeobjekt:
  • period – Typ: long, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0
  • valueHasToChange – Typ: boolean, Standardwert: false

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

void BrickletCO2V2.setCO2ConcentrationCallbackConfiguration(long period, boolean valueHasToChange, char option, int min, int max)
Parameter:
  • period – Typ: long, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0
  • valueHasToChange – Typ: boolean, Standardwert: false
  • option – Typ: char, Wertebereich: Siehe Konstanten, Standardwert: 'x'
  • min – Typ: int, Wertebereich: [0 bis 216 - 1]
  • max – Typ: int, Wertebereich: [0 bis 216 - 1]

Die Periode ist die Periode mit der der CO2ConcentrationListener 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 CO2ConcentrationListener 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:

Für option:

  • BrickletCO2V2.THRESHOLD_OPTION_OFF = 'x'
  • BrickletCO2V2.THRESHOLD_OPTION_OUTSIDE = 'o'
  • BrickletCO2V2.THRESHOLD_OPTION_INSIDE = 'i'
  • BrickletCO2V2.THRESHOLD_OPTION_SMALLER = '<'
  • BrickletCO2V2.THRESHOLD_OPTION_GREATER = '>'
BrickletCO2V2.CO2ConcentrationCallbackConfiguration BrickletCO2V2.getCO2ConcentrationCallbackConfiguration()
Rückgabeobjekt:
  • period – Typ: long, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0
  • valueHasToChange – Typ: boolean, Standardwert: false
  • option – Typ: char, Wertebereich: Siehe Konstanten, Standardwert: 'x'
  • min – Typ: int, Wertebereich: [0 bis 216 - 1]
  • max – Typ: int, Wertebereich: [0 bis 216 - 1]

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

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

Für option:

  • BrickletCO2V2.THRESHOLD_OPTION_OFF = 'x'
  • BrickletCO2V2.THRESHOLD_OPTION_OUTSIDE = 'o'
  • BrickletCO2V2.THRESHOLD_OPTION_INSIDE = 'i'
  • BrickletCO2V2.THRESHOLD_OPTION_SMALLER = '<'
  • BrickletCO2V2.THRESHOLD_OPTION_GREATER = '>'
void BrickletCO2V2.setTemperatureCallbackConfiguration(long period, boolean valueHasToChange, char option, int min, int max)
Parameter:
  • period – Typ: long, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0
  • valueHasToChange – Typ: boolean, Standardwert: false
  • option – Typ: char, Wertebereich: Siehe Konstanten, Standardwert: 'x'
  • min – Typ: int, Wertebereich: [-215 bis 215 - 1]
  • max – Typ: int, Wertebereich: [-215 bis 215 - 1]

Die Periode 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:

Für option:

  • BrickletCO2V2.THRESHOLD_OPTION_OFF = 'x'
  • BrickletCO2V2.THRESHOLD_OPTION_OUTSIDE = 'o'
  • BrickletCO2V2.THRESHOLD_OPTION_INSIDE = 'i'
  • BrickletCO2V2.THRESHOLD_OPTION_SMALLER = '<'
  • BrickletCO2V2.THRESHOLD_OPTION_GREATER = '>'
BrickletCO2V2.TemperatureCallbackConfiguration BrickletCO2V2.getTemperatureCallbackConfiguration()
Rückgabeobjekt:
  • period – Typ: long, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0
  • valueHasToChange – Typ: boolean, Standardwert: false
  • option – Typ: char, Wertebereich: Siehe Konstanten, Standardwert: 'x'
  • min – Typ: int, Wertebereich: [-215 bis 215 - 1]
  • max – Typ: int, Wertebereich: [-215 bis 215 - 1]

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

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

Für option:

  • BrickletCO2V2.THRESHOLD_OPTION_OFF = 'x'
  • BrickletCO2V2.THRESHOLD_OPTION_OUTSIDE = 'o'
  • BrickletCO2V2.THRESHOLD_OPTION_INSIDE = 'i'
  • BrickletCO2V2.THRESHOLD_OPTION_SMALLER = '<'
  • BrickletCO2V2.THRESHOLD_OPTION_GREATER = '>'
void BrickletCO2V2.setHumidityCallbackConfiguration(long period, boolean valueHasToChange, char option, int min, int max)
Parameter:
  • period – Typ: long, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0
  • valueHasToChange – Typ: boolean, Standardwert: false
  • option – Typ: char, Wertebereich: Siehe Konstanten, Standardwert: 'x'
  • min – Typ: int, Wertebereich: [0 bis 216 - 1]
  • max – Typ: int, Wertebereich: [0 bis 216 - 1]

Die Periode 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:

Für option:

  • BrickletCO2V2.THRESHOLD_OPTION_OFF = 'x'
  • BrickletCO2V2.THRESHOLD_OPTION_OUTSIDE = 'o'
  • BrickletCO2V2.THRESHOLD_OPTION_INSIDE = 'i'
  • BrickletCO2V2.THRESHOLD_OPTION_SMALLER = '<'
  • BrickletCO2V2.THRESHOLD_OPTION_GREATER = '>'
BrickletCO2V2.HumidityCallbackConfiguration BrickletCO2V2.getHumidityCallbackConfiguration()
Rückgabeobjekt:
  • period – Typ: long, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0
  • valueHasToChange – Typ: boolean, Standardwert: false
  • option – Typ: char, Wertebereich: Siehe Konstanten, Standardwert: 'x'
  • min – Typ: int, Wertebereich: [0 bis 216 - 1]
  • max – Typ: int, Wertebereich: [0 bis 216 - 1]

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

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

Für option:

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

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 BrickletCO2V2.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.

class BrickletCO2V2.AllValuesListener()

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

void allValues(int co2Concentration, int temperature, int humidity)
Parameter:
  • co2Concentration – Typ: int, Wertebereich: [0 bis 216 - 1]
  • temperature – Typ: int, Wertebereich: [-215 bis 215 - 1]
  • humidity – Typ: int, Wertebereich: [0 bis 216 - 1]

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

Die Parameter sind die gleichen wie getAllValues().

class BrickletCO2V2.CO2ConcentrationListener()

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

void co2Concentration(int co2Concentration)
Parameter:
  • co2Concentration – Typ: int, Wertebereich: [0 bis 216 - 1]

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

Der Parameter ist der gleiche wie getCO2Concentration().

class BrickletCO2V2.TemperatureListener()

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

void temperature(int temperature)
Parameter:
  • temperature – Typ: int, Wertebereich: [-215 bis 215 - 1]

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

Der Parameter ist der gleiche wie getTemperature().

class BrickletCO2V2.HumidityListener()

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

void humidity(int humidity)
Parameter:
  • humidity – Typ: int, Wertebereich: [0 bis 216 - 1]

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

Der Parameter ist der gleiche wie getHumidity().

Konstanten

int BrickletCO2V2.DEVICE_IDENTIFIER

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

Diese Konstante stellt den Anzeigenamen eines CO2 Bricklet 2.0 dar.