Java - Dust Detector 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.BrickletDustDetector;

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

    // Change XYZ to the UID of your Dust Detector 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
        BrickletDustDetector dd = new BrickletDustDetector(UID, ipcon); // Create device object

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

        // Get current dust density
        int dustDensity = dd.getDustDensity(); // Can throw com.tinkerforge.TimeoutException
        System.out.println("Dust Density: " + dustDensity + " µ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

import com.tinkerforge.IPConnection;
import com.tinkerforge.BrickletDustDetector;

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

    // Change XYZ to the UID of your Dust Detector 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
        BrickletDustDetector dd = new BrickletDustDetector(UID, ipcon); // Create device object

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

        // Add dust density listener
        dd.addDustDensityListener(new BrickletDustDetector.DustDensityListener() {
            public void dustDensity(int dustDensity) {
                System.out.println("Dust Density: " + dustDensity + " µg/m³");
            }
        });

        // Set period for dust density callback to 1s (1000ms)
        // Note: The dust density callback is only called every second
        //       if the dust density has changed since the last call!
        dd.setDustDensityCallbackPeriod(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.BrickletDustDetector;

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

    // Change XYZ to the UID of your Dust Detector 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
        BrickletDustDetector dd = new BrickletDustDetector(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)
        dd.setDebouncePeriod(10000);

        // Add dust density reached listener
        dd.addDustDensityReachedListener(new BrickletDustDetector.DustDensityReachedListener() {
            public void dustDensityReached(int dustDensity) {
                System.out.println("Dust Density: " + dustDensity + " µg/m³");
            }
        });

        // Configure threshold for dust density "greater than 10 µg/m³"
        dd.setDustDensityCallbackThreshold('>', 10, 0);

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

Grundfunktionen¶

class BrickletDustDetector(String uid, IPConnection ipcon)¶

Parameter:	uid – Typ: String ipcon – Typ: IPConnection
Rückgabe:	dustDetector – Typ: BrickletDustDetector

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

BrickletDustDetector dustDetector = new BrickletDustDetector("YOUR_DEVICE_UID", ipcon);

Dieses Objekt kann benutzt werden, nachdem die IP Connection verbunden ist.

int BrickletDustDetector.getDustDensity()¶

Rückgabe:	dustDensity – Typ: int, Einheit: 1 µg/m³, Wertebereich: [0 bis 500]

Gibt die Staubdichte zurück.

Wenn die Staubdichte periodisch abgefragt werden soll, wird empfohlen den DustDensityListener Listener zu nutzen und die Periode mit setDustDensityCallbackPeriod() vorzugeben.

Fortgeschrittene Funktionen¶

void BrickletDustDetector.setMovingAverage(short average)¶

Parameter:	average – Typ: short, Wertebereich: [0 bis 100], Standardwert: 100

Setzt die Länge eines gleitenden Mittelwerts für die Staubdichte.

Wenn die Länge auf 0 gesetzt wird, ist das Averaging komplett aus. Desto kleiner die Länge des Mittelwerts ist, desto mehr Rauschen ist auf den Daten.

short BrickletDustDetector.getMovingAverage()¶

Rückgabe:	average – Typ: short, Wertebereich: [0 bis 100], Standardwert: 100

Gibt die Länge des gleitenden Mittelwerts zurück, wie von setMovingAverage() gesetzt.

BrickletDustDetector.Identity BrickletDustDetector.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 BrickletDustDetector.setDustDensityCallbackPeriod(long period)¶

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

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

Der DustDensityListener Listener wird nur ausgelöst, wenn sich die Staubdichte seit der letzten Auslösung geändert hat.

long BrickletDustDetector.getDustDensityCallbackPeriod()¶

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

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

void BrickletDustDetector.setDustDensityCallbackThreshold(char option, int min, int max)¶

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

Setzt den Schwellwert für den DustDensityReachedListener Listener.

Die folgenden Optionen sind möglich:

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

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

Für option:

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

BrickletDustDetector.DustDensityCallbackThreshold BrickletDustDetector.getDustDensityCallbackThreshold()¶

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

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

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

Für option:

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

void BrickletDustDetector.setDebouncePeriod(long debounce)¶

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

Setzt die Periode mit welcher die Schwellwert Listener

• DustDensityReachedListener

ausgelöst wird, wenn der Schwellwert

• setDustDensityCallbackThreshold()

weiterhin erreicht bleibt.

long BrickletDustDetector.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 BrickletDustDetector.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 BrickletDustDetector.DustDensityListener()¶

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

void dustDensity(int dustDensity)

Parameter:	dustDensity – Typ: int, Einheit: 1 µg/m³, Wertebereich: [0 bis 500]

Dieser Listener wird mit der Periode, wie gesetzt mit setDustDensityCallbackPeriod(), ausgelöst. Der Parameter ist die Staubdichte des Sensors.

Der DustDensityListener Listener wird nur ausgelöst, wenn sich die Staubdichte seit der letzten Auslösung geändert hat.

class BrickletDustDetector.DustDensityReachedListener()¶

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

void dustDensityReached(int dustDensity)

Parameter:	dustDensity – Typ: int, Einheit: 1 µg/m³, Wertebereich: [0 bis 500]

Dieser Listener wird ausgelöst, wenn der Schwellwert, wie von setDustDensityCallbackThreshold() gesetzt, erreicht wird. Der Parameter ist die Staubdichte des Sensors.

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[] BrickletDustDetector.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 BrickletDustDetector.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:

• BrickletDustDetector.FUNCTION_SET_DUST_DENSITY_CALLBACK_PERIOD = 2
• BrickletDustDetector.FUNCTION_SET_DUST_DENSITY_CALLBACK_THRESHOLD = 4
• BrickletDustDetector.FUNCTION_SET_DEBOUNCE_PERIOD = 6
• BrickletDustDetector.FUNCTION_SET_MOVING_AVERAGE = 10

void BrickletDustDetector.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:

• BrickletDustDetector.FUNCTION_SET_DUST_DENSITY_CALLBACK_PERIOD = 2
• BrickletDustDetector.FUNCTION_SET_DUST_DENSITY_CALLBACK_THRESHOLD = 4
• BrickletDustDetector.FUNCTION_SET_DEBOUNCE_PERIOD = 6
• BrickletDustDetector.FUNCTION_SET_MOVING_AVERAGE = 10

void BrickletDustDetector.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 BrickletDustDetector.DEVICE_IDENTIFIER¶

Diese Konstante wird verwendet um ein Dust Detector 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 BrickletDustDetector.DEVICE_DISPLAY_NAME¶

Diese Konstante stellt den Anzeigenamen eines Dust Detector Bricklet dar.