Java - Particulate Matter Bricklet

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

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

    // Change XYZ to the UID of your Particulate Matter 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
        BrickletParticulateMatter pm =
          new BrickletParticulateMatter(UID, ipcon); // Create device object

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

        // Get current PM concentration
        PMConcentration pmConcentration = pm.getPMConcentration(); // Can throw com.tinkerforge.TimeoutException

        System.out.println("PM 1.0: " + pmConcentration.pm10 + " µg/m³");
        System.out.println("PM 2.5: " + pmConcentration.pm25 + " µg/m³");
        System.out.println("PM 10.0: " + pmConcentration.pm100 + " µg/m³");

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

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

    // Change XYZ to the UID of your Particulate Matter 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
        BrickletParticulateMatter pm =
          new BrickletParticulateMatter(UID, ipcon); // Create device object

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

        // Add PM concentration listener
        pm.addPMConcentrationListener(new BrickletParticulateMatter.PMConcentrationListener() {
            public void pmConcentration(int pm10, int pm25, int pm100) {
                System.out.println("PM 1.0: " + pm10 + " µg/m³");
                System.out.println("PM 2.5: " + pm25 + " µg/m³");
                System.out.println("PM 10.0: " + pm100 + " µg/m³");
                System.out.println("");
            }
        });

        // Set period for PM concentration callback to 1s (1000ms)
        pm.setPMConcentrationCallbackConfiguration(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 BrickletParticulateMatter(String uid, IPConnection ipcon)
Parameter:
  • uid – Typ: String
  • ipcon – Typ: IPConnection
Rückgabe:
  • particulateMatter – Typ: BrickletParticulateMatter

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

BrickletParticulateMatter particulateMatter = new BrickletParticulateMatter("YOUR_DEVICE_UID", ipcon);

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

BrickletParticulateMatter.PMConcentration BrickletParticulateMatter.getPMConcentration()
Rückgabeobjekt:
  • pm10 – Typ: int, Wertebereich: [0 bis 216 - 1]
  • pm25 – Typ: int, Wertebereich: [0 bis 216 - 1]
  • pm100 – Typ: int, Wertebereich: [0 bis 216 - 1]

Gibt die Feinstaub-Konzentration in µg/m³ zurück, aufgeschlüsselt nach:

  • PM1.0,
  • PM2.5 und
  • PM10.0.

Wenn der Sensor deaktiviert ist (siehe setEnable()), dann wird weiterhin der letzte Sensorwert zurückgegeben.

Wenn die Werte periodisch benötigt werden, kann auch der PMConcentrationListener Listener verwendet werden. Der Listener wird mit der Funktion setPMConcentrationCallbackConfiguration() konfiguriert.

BrickletParticulateMatter.PMCount BrickletParticulateMatter.getPMCount()
Rückgabeobjekt:
  • greater03um – Typ: int, Wertebereich: [0 bis 216 - 1]
  • greater05um – Typ: int, Wertebereich: [0 bis 216 - 1]
  • greater10um – Typ: int, Wertebereich: [0 bis 216 - 1]
  • greater25um – Typ: int, Wertebereich: [0 bis 216 - 1]
  • greater50um – Typ: int, Wertebereich: [0 bis 216 - 1]
  • greater100um – Typ: int, Wertebereich: [0 bis 216 - 1]

Gibt die Anzahl der Feinstaub-Teilchen in 100ml Luft zurück, aufgeschlüsselt nach deren Durchmesser:

  • größer 0,3µm,
  • größer 0,5µm,
  • größer 1,0µm,
  • größer 2,5µm,
  • größer 5,0µm und
  • größer 10,0µm.

Wenn der Sensor deaktiviert ist (siehe setEnable()), dann wird weiterhin der letzte Sensorwert zurückgegeben.

Wenn die Werte periodisch benötigt werden, kann auch der PMCountListener Listener verwendet werden. Der Listener wird mit der Funktion setPMCountCallbackConfiguration() konfiguriert.

Fortgeschrittene Funktionen

void BrickletParticulateMatter.setEnable(boolean enable)
Parameter:
  • enable – Typ: boolean

Aktiviert/deaktiviert den Lüfter und die Laserdiode des Sensors. Der Sensor ist standardmäßig aktiv.

Der Sensor benötigt ca. 30 Sekunden nach der Aktivierung um sich einzuschwingen und stabile Werte zu produzieren.

Die Lebensdauer der Laserdiode beträgt ca. 8000 Stunden. Wenn Messungen in größeren Abständen stattfinden sollen (z.B. stündlich) lohnt es sich die Laserdiode zwischen den Messungen auszumachen.

boolean BrickletParticulateMatter.getEnable()
Rückgabe:
  • enable – Typ: boolean

Gibt den Zustand des Sensors zurück, wie von setEnable() gesetzt.

BrickletParticulateMatter.SensorInfo BrickletParticulateMatter.getSensorInfo()
Rückgabeobjekt:
  • sensorVersion – Typ: int, Wertebereich: [0 bis 255]
  • lastErrorCode – Typ: int, Wertebereich: [0 bis 255]
  • framingErrorCount – Typ: int, Wertebereich: [0 bis 255]
  • checksumErrorCount – Typ: int, Wertebereich: [0 bis 255]

Gibt Informationen über den Sensor zurück:

  • die Versionsnummer des Sensors,
  • den letzten Fehlercode den der Sensor gemeldet (0 bedeute kein Fehler) hat,
  • die Anzahl der Framing und Prüfsummenfehler die in der Kommunikation mit dem Sensor aufgetreten sind.
int[] BrickletParticulateMatter.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 BrickletParticulateMatter.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:

  • BrickletParticulateMatter.FUNCTION_SET_ENABLE = 3
  • BrickletParticulateMatter.FUNCTION_SET_PM_CONCENTRATION_CALLBACK_CONFIGURATION = 6
  • BrickletParticulateMatter.FUNCTION_SET_PM_COUNT_CALLBACK_CONFIGURATION = 8
  • BrickletParticulateMatter.FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
  • BrickletParticulateMatter.FUNCTION_SET_STATUS_LED_CONFIG = 239
  • BrickletParticulateMatter.FUNCTION_RESET = 243
  • BrickletParticulateMatter.FUNCTION_WRITE_UID = 248
void BrickletParticulateMatter.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:

  • BrickletParticulateMatter.FUNCTION_SET_ENABLE = 3
  • BrickletParticulateMatter.FUNCTION_SET_PM_CONCENTRATION_CALLBACK_CONFIGURATION = 6
  • BrickletParticulateMatter.FUNCTION_SET_PM_COUNT_CALLBACK_CONFIGURATION = 8
  • BrickletParticulateMatter.FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
  • BrickletParticulateMatter.FUNCTION_SET_STATUS_LED_CONFIG = 239
  • BrickletParticulateMatter.FUNCTION_RESET = 243
  • BrickletParticulateMatter.FUNCTION_WRITE_UID = 248
void BrickletParticulateMatter.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.

BrickletParticulateMatter.SPITFPErrorCount BrickletParticulateMatter.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 BrickletParticulateMatter.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:

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

Für status:

  • BrickletParticulateMatter.BOOTLOADER_STATUS_OK = 0
  • BrickletParticulateMatter.BOOTLOADER_STATUS_INVALID_MODE = 1
  • BrickletParticulateMatter.BOOTLOADER_STATUS_NO_CHANGE = 2
  • BrickletParticulateMatter.BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT = 3
  • BrickletParticulateMatter.BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT = 4
  • BrickletParticulateMatter.BOOTLOADER_STATUS_CRC_MISMATCH = 5
int BrickletParticulateMatter.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:

  • BrickletParticulateMatter.BOOTLOADER_MODE_BOOTLOADER = 0
  • BrickletParticulateMatter.BOOTLOADER_MODE_FIRMWARE = 1
  • BrickletParticulateMatter.BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
  • BrickletParticulateMatter.BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
  • BrickletParticulateMatter.BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4
void BrickletParticulateMatter.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 BrickletParticulateMatter.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 BrickletParticulateMatter.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:

  • BrickletParticulateMatter.STATUS_LED_CONFIG_OFF = 0
  • BrickletParticulateMatter.STATUS_LED_CONFIG_ON = 1
  • BrickletParticulateMatter.STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • BrickletParticulateMatter.STATUS_LED_CONFIG_SHOW_STATUS = 3
int BrickletParticulateMatter.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:

  • BrickletParticulateMatter.STATUS_LED_CONFIG_OFF = 0
  • BrickletParticulateMatter.STATUS_LED_CONFIG_ON = 1
  • BrickletParticulateMatter.STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • BrickletParticulateMatter.STATUS_LED_CONFIG_SHOW_STATUS = 3
int BrickletParticulateMatter.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 BrickletParticulateMatter.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 BrickletParticulateMatter.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 BrickletParticulateMatter.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.

BrickletParticulateMatter.Identity BrickletParticulateMatter.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 BrickletParticulateMatter.setPMConcentrationCallbackConfiguration(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 PMConcentrationListener 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.

BrickletParticulateMatter.PMConcentrationCallbackConfiguration BrickletParticulateMatter.getPMConcentrationCallbackConfiguration()
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 setPMConcentrationCallbackConfiguration() gesetzt.

void BrickletParticulateMatter.setPMCountCallbackConfiguration(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 PMCountListener 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.

BrickletParticulateMatter.PMCountCallbackConfiguration BrickletParticulateMatter.getPMCountCallbackConfiguration()
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 setPMCountCallbackConfiguration() 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 BrickletParticulateMatter.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 BrickletParticulateMatter.PMConcentrationListener()

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

void pmConcentration(int pm10, int pm25, int pm100)
Parameter:
  • pm10 – Typ: int, Wertebereich: [0 bis 216 - 1]
  • pm25 – Typ: int, Wertebereich: [0 bis 216 - 1]
  • pm100 – Typ: int, Wertebereich: [0 bis 216 - 1]

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

Die Parameter sind der gleiche wie getPMConcentration().

class BrickletParticulateMatter.PMCountListener()

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

void pmCount(int greater03um, int greater05um, int greater10um, int greater25um, int greater50um, int greater100um)
Parameter:
  • greater03um – Typ: int, Wertebereich: [0 bis 216 - 1]
  • greater05um – Typ: int, Wertebereich: [0 bis 216 - 1]
  • greater10um – Typ: int, Wertebereich: [0 bis 216 - 1]
  • greater25um – Typ: int, Wertebereich: [0 bis 216 - 1]
  • greater50um – Typ: int, Wertebereich: [0 bis 216 - 1]
  • greater100um – Typ: int, Wertebereich: [0 bis 216 - 1]

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

Die Parameter sind der gleiche wie getPMCount().

Konstanten

int BrickletParticulateMatter.DEVICE_IDENTIFIER

Diese Konstante wird verwendet um ein Particulate Matter 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 BrickletParticulateMatter.DEVICE_DISPLAY_NAME

Diese Konstante stellt den Anzeigenamen eines Particulate Matter Bricklet dar.