Java - Humidity Bricklet

Dies ist die Beschreibung der Java API Bindings für das Humidity Bricklet. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des Humidity 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.BrickletHumidity;

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

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

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

        // Get current humidity
        int humidity = h.getHumidity(); // Can throw com.tinkerforge.TimeoutException
        System.out.println("Humidity: " + humidity/10.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
import com.tinkerforge.IPConnection;
import com.tinkerforge.BrickletHumidity;

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

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

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

        // Add humidity listener
        h.addHumidityListener(new BrickletHumidity.HumidityListener() {
            public void humidity(int humidity) {
                System.out.println("Humidity: " + humidity/10.0 + " %RH");
            }
        });

        // Set period for humidity callback to 1s (1000ms)
        // Note: The humidity callback is only called every second
        //       if the humidity has changed since the last call!
        h.setHumidityCallbackPeriod(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
37
import com.tinkerforge.IPConnection;
import com.tinkerforge.BrickletHumidity;

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

    // Change XYZ to the UID of your Humidity 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
        BrickletHumidity h = new BrickletHumidity(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)
        h.setDebouncePeriod(10000);

        // Add humidity reached listener
        h.addHumidityReachedListener(new BrickletHumidity.HumidityReachedListener() {
            public void humidityReached(int humidity) {
                System.out.println("Humidity: " + humidity/10.0 + " %RH");
                System.out.println("Recommended humidity for human comfort is 30 to 60 %RH.");
            }
        });

        // Configure threshold for humidity "outside of 30 to 60 %RH"
        h.setHumidityCallbackThreshold('o', 30*10, 60*10);

        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 BrickletHumidity(String uid, IPConnection ipcon)
Parameter:
  • uid – Typ: String
  • ipcon – Typ: IPConnection
Rückgabe:
  • humidity – Typ: BrickletHumidity

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

BrickletHumidity humidity = new BrickletHumidity("YOUR_DEVICE_UID", ipcon);

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

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

Gibt die gemessene Luftfeuchtigkeit des Sensors zurück. Der Wertebereich ist von 0 bis 1000 und wird in %RH/10 angegeben (relative Luftfeuchtigkeit), z.B. bedeutet ein Wert von 421 eine gemessene Luftfeuchtigkeit von 42,1 %RH.

Wenn die Luftfeuchtigkeit periodisch abgefragt werden soll, wird empfohlen den HumidityListener Listener zu nutzen und die Periode mit setHumidityCallbackPeriod() vorzugeben.

Fortgeschrittene Funktionen

int BrickletHumidity.getAnalogValue()
Rückgabe:
  • value – Typ: int, Wertebereich: [0 bis 216 - 1]

Gibt den Wert, wie vom 12-Bit Analog-Digital-Wandler gelesen, zurück. Der Wertebereich ist 0 bis 4095.

Bemerkung

Der von getHumidity() zurückgegebene Wert ist über mehrere Messwerte gemittelt um das Rauschen zu vermindern, während getAnalogValue() unverarbeitete Analogwerte zurück gibt. Der zurückgegebene Luftfeuchtigkeitswert ist auf Raumtemperatur kalibriert, d.h. wenn der Sensor in sehr kalten oder warmen Umgebungen verwendet wird, ist es ratsam den Luftfeuchtigkeitswert direkt aus den Analogwerten zu berechnen. Siehe hierzu das HIH 5030 Datenblatt.

Wenn der Analogwert periodisch abgefragt werden soll, wird empfohlen den AnalogValueListener Listener zu nutzen und die Periode mit setAnalogValueCallbackPeriod() vorzugeben.

short[] BrickletHumidity.getAPIVersion()
Rückgabe:
  • apiVersion – Typ: short[], 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 BrickletHumidity.getResponseExpected(short functionId)
Parameter:
  • functionId – Typ: short, 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:

  • BrickletHumidity.FUNCTION_SET_HUMIDITY_CALLBACK_PERIOD = 3
  • BrickletHumidity.FUNCTION_SET_ANALOG_VALUE_CALLBACK_PERIOD = 5
  • BrickletHumidity.FUNCTION_SET_HUMIDITY_CALLBACK_THRESHOLD = 7
  • BrickletHumidity.FUNCTION_SET_ANALOG_VALUE_CALLBACK_THRESHOLD = 9
  • BrickletHumidity.FUNCTION_SET_DEBOUNCE_PERIOD = 11
void BrickletHumidity.setResponseExpected(short functionId, boolean responseExpected)
Parameter:
  • functionId – Typ: short, 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:

  • BrickletHumidity.FUNCTION_SET_HUMIDITY_CALLBACK_PERIOD = 3
  • BrickletHumidity.FUNCTION_SET_ANALOG_VALUE_CALLBACK_PERIOD = 5
  • BrickletHumidity.FUNCTION_SET_HUMIDITY_CALLBACK_THRESHOLD = 7
  • BrickletHumidity.FUNCTION_SET_ANALOG_VALUE_CALLBACK_THRESHOLD = 9
  • BrickletHumidity.FUNCTION_SET_DEBOUNCE_PERIOD = 11
void BrickletHumidity.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.

BrickletHumidity.Identity BrickletHumidity.getIdentity()
Rückgabeobjekt:
  • uid – Typ: String, Länge: bis zu 8
  • connectedUid – Typ: String, Länge: bis zu 8
  • position – Typ: char
  • hardwareVersion – Typ: short[], Länge: 3, Wertebereich: [0 bis 255]
  • firmwareVersion – Typ: short[], 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 BrickletHumidity.setHumidityCallbackPeriod(long period)
Parameter:
  • period – Typ: long, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0

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

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

long BrickletHumidity.getHumidityCallbackPeriod()
Rückgabe:
  • period – Typ: long, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0

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

void BrickletHumidity.setAnalogValueCallbackPeriod(long period)
Parameter:
  • period – Typ: long, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0

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

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

long BrickletHumidity.getAnalogValueCallbackPeriod()
Rückgabe:
  • period – Typ: long, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0

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

void BrickletHumidity.setHumidityCallbackThreshold(char option, int min, int max)
Parameter:
  • option – Typ: char, Wertebereich: Siehe Konstanten, Standardwert: 'x'
  • min – Typ: int, Wertebereich: [0 bis 216 - 1]
  • max – Typ: int, Wertebereich: [0 bis 216 - 1]

Setzt den Schwellwert für den HumidityReachedListener Listener.

Die folgenden Optionen sind möglich:

Option Beschreibung
'x' Listener ist inaktiv
'o' Listener wird ausgelöst, wenn die Luftfeuchtigkeit außerhalb des min und max Wertes ist
'i' Listener wird ausgelöst, wenn die Luftfeuchtigkeit innerhalb des min und max Wertes ist
'<' Listener wird ausgelöst, wenn die Luftfeuchtigkeit kleiner als der min Wert ist (max wird ignoriert)
'>' Listener wird ausgelöst, wenn die Luftfeuchtigkeit 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:

Für option:

  • BrickletHumidity.THRESHOLD_OPTION_OFF = 'x'
  • BrickletHumidity.THRESHOLD_OPTION_OUTSIDE = 'o'
  • BrickletHumidity.THRESHOLD_OPTION_INSIDE = 'i'
  • BrickletHumidity.THRESHOLD_OPTION_SMALLER = '<'
  • BrickletHumidity.THRESHOLD_OPTION_GREATER = '>'
BrickletHumidity.HumidityCallbackThreshold BrickletHumidity.getHumidityCallbackThreshold()
Rückgabeobjekt:
  • 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 den Schwellwert zurück, wie von setHumidityCallbackThreshold() gesetzt.

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

Für option:

  • BrickletHumidity.THRESHOLD_OPTION_OFF = 'x'
  • BrickletHumidity.THRESHOLD_OPTION_OUTSIDE = 'o'
  • BrickletHumidity.THRESHOLD_OPTION_INSIDE = 'i'
  • BrickletHumidity.THRESHOLD_OPTION_SMALLER = '<'
  • BrickletHumidity.THRESHOLD_OPTION_GREATER = '>'
void BrickletHumidity.setAnalogValueCallbackThreshold(char option, int min, int max)
Parameter:
  • option – Typ: char, Wertebereich: Siehe Konstanten, Standardwert: 'x'
  • min – Typ: int, Wertebereich: [0 bis 216 - 1]
  • max – Typ: int, Wertebereich: [0 bis 216 - 1]

Setzt den Schwellwert für den AnalogValueReachedListener Listener.

Die folgenden Optionen sind möglich:

Option Beschreibung
'x' Listener ist inaktiv
'o' Listener wird ausgelöst, wenn der Analogwert außerhalb des min und max Wertes ist
'i' Listener wird ausgelöst, wenn der Analogwert innerhalb des min und max Wertes ist
'<' Listener wird ausgelöst, wenn der Analogwert kleiner als der min Wert ist (max wird ignoriert)
'>' Listener wird ausgelöst, wenn der Analogwert 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:

Für option:

  • BrickletHumidity.THRESHOLD_OPTION_OFF = 'x'
  • BrickletHumidity.THRESHOLD_OPTION_OUTSIDE = 'o'
  • BrickletHumidity.THRESHOLD_OPTION_INSIDE = 'i'
  • BrickletHumidity.THRESHOLD_OPTION_SMALLER = '<'
  • BrickletHumidity.THRESHOLD_OPTION_GREATER = '>'
BrickletHumidity.AnalogValueCallbackThreshold BrickletHumidity.getAnalogValueCallbackThreshold()
Rückgabeobjekt:
  • 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 den Schwellwert zurück, wie von setAnalogValueCallbackThreshold() gesetzt.

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

Für option:

  • BrickletHumidity.THRESHOLD_OPTION_OFF = 'x'
  • BrickletHumidity.THRESHOLD_OPTION_OUTSIDE = 'o'
  • BrickletHumidity.THRESHOLD_OPTION_INSIDE = 'i'
  • BrickletHumidity.THRESHOLD_OPTION_SMALLER = '<'
  • BrickletHumidity.THRESHOLD_OPTION_GREATER = '>'
void BrickletHumidity.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

ausgelöst werden, wenn die Schwellwerte

weiterhin erreicht bleiben.

long BrickletHumidity.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 BrickletHumidity.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 BrickletHumidity.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 mit der Periode, wie gesetzt mit setHumidityCallbackPeriod(), ausgelöst. Der Parameter ist die Luftfeuchtigkeit des Sensors.

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

class BrickletHumidity.AnalogValueListener()

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

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

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

AnalogValueListener Listener wird nur ausgelöst, wenn sich der Analogwert seit der letzten Auslösung geändert hat.

class BrickletHumidity.HumidityReachedListener()

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

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

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

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

class BrickletHumidity.AnalogValueReachedListener()

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

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

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

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

Konstanten

int BrickletHumidity.DEVICE_IDENTIFIER

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

Diese Konstante stellt den Anzeigenamen eines Humidity Bricklet dar.