Java - Barometer Bricklet

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

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

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

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

        // Get current air pressure
        int airPressure = b.getAirPressure(); // Can throw com.tinkerforge.TimeoutException
        System.out.println("Air Pressure: " + airPressure/1000.0 + " mbar");

        // Get current altitude
        int altitude = b.getAltitude(); // Can throw com.tinkerforge.TimeoutException
        System.out.println("Altitude: " + altitude/100.0 + " 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.BrickletBarometer;

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

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

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

        // Add air pressure listener
        b.addAirPressureListener(new BrickletBarometer.AirPressureListener() {
            public void airPressure(int airPressure) {
                System.out.println("Air Pressure: " + airPressure/1000.0 + " mbar");
            }
        });

        // Set period for air pressure callback to 1s (1000ms)
        // Note: The air pressure callback is only called every second
        //       if the air pressure has changed since the last call!
        b.setAirPressureCallbackPeriod(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.BrickletBarometer;

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

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

        // Add air pressure reached listener
        b.addAirPressureReachedListener(new BrickletBarometer.AirPressureReachedListener() {
            public void airPressureReached(int airPressure) {
                System.out.println("Air Pressure: " + airPressure/1000.0 + " mbar");
                System.out.println("Enjoy the potentially good weather!");
            }
        });

        // Configure threshold for air pressure "greater than 1025 mbar"
        b.setAirPressureCallbackThreshold('>', 1025*1000, 0);

        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

public class BrickletBarometer(String uid, IPConnection ipcon)

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

BrickletBarometer barometer = new BrickletBarometer("YOUR_DEVICE_UID", ipcon);

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

public int getAirPressure()

Gibt den Luftdruck des Luftdrucksensors zurück. Der Wertbereich geht von 10000 bis 1200000 und ist in mbar/1000 angegeben, d.h. bei einem Wert von 1001092 wurde ein Luftdruck von 1001,092 mbar gemessen.

Wenn der Luftdruck periodisch abgefragt werden soll, wird empfohlen den AirPressureListener Listener zu nutzen und die Periode mit setAirPressureCallbackPeriod() vorzugeben.

public int getAltitude()

Gibt die relative Höhe des Luftdrucksensors zurück. Der Wert ist in cm angegeben und wird auf Basis der Differenz zwischen dem aktuellen Luftdruck und dem Referenzluftdruck berechnet, welcher mit setReferenceAirPressure() gesetzt werden kann.

Wenn die Höhe periodisch abgefragt werden soll, wird empfohlen den AltitudeListener Listener zu nutzen und die Periode mit setAltitudeCallbackPeriod() vorzugeben.

public void setReferenceAirPressure(int airPressure)

Setzt den Referenzluftdruck in mbar/1000 für die Höhenberechnung. Gültige Werte liegen zwischen 10000 und 1200000. Wenn der aktuelle Luftdruckwert als Referenz übergeben wird dann gibt die Höhenberechnung 0cm aus. Als Abkürzung kann auch 0 übergeben werden, dadurch wird der Referenzluftdruck intern auf den aktuellen Luftdruckwert gesetzt.

Wohl bekannte Referenzluftdruckwerte, die in der Luftfahrt verwendet werden, sind QNH und QFE aus dem Q-Schlüssel.

Der Standardwert ist 1013,25mbar.

public int getReferenceAirPressure()

Gibt den Referenzluftdruckwert zurück, wie von setReferenceAirPressure() gesetzt.

Fortgeschrittene Funktionen

public short getChipTemperature()

Gibt die Temperatur des Luftdrucksensors zurück. Der Wertbereich ist von -4000 bis 8500 und ist in °C/100 angegeben, d.h. bei einem Wert von 2007 wurde eine Temperatur von 20,07 °C gemessen.

Diese Temperatur wird intern zur Temperaturkompensation der Luftdruckmessung verwendet. Sie ist nicht so genau wie die Temperatur die vom Temperature Bricklet oder dem Temperature IR Bricklet gemessen wird.

public void setAveraging(short movingAveragePressure, short averagePressure, short averageTemperature)

Setzt die unterschiedlichen Averaging-Parameter (Mittelwertbildung). Es ist möglich die Länge des Mittelwerts für Temperatur und Luftdruck anzugeben. Zusätzlich gibt kann die Länge für einen gleitenden Mittelwert für den Luftdruck angegeben werden. Der gleitende Mittelwert wird mit den Werten des normalen Mittelwerts berechnet. Es gibt keinen gleitenden Mittelwert für die Temperatur.

Die maximale Länge des Luftdruckmittelwerts ist 10, des Temperaturmittelwerts 255 und des gleitenden Mittelwertes 25.

Wenn alle drei Parameter auf 0 gesetzt werden, ist das Averaging komplett aus. In diesem Fall gibt es viel Rauschen auf den Daten, allerdings sind die Daten dann ohne Verzögerung. Wir empfehlen das Averaging auszustellen wenn die Daten des Barometer Bricklets zusammen mit anderen Sensordaten fusioniert werden sollen.

Der Standardwert ist 10 für die normalen Mittelwerte und 25 für den gleitenden Mittelwert

Neu in Version 2.0.1 (Plugin).

public BrickletBarometer.Averaging getAveraging()

Gibt die Averaging-Konfiguration zurück, wie von setAveraging() gesetzt.

Neu in Version 2.0.1 (Plugin).

Das zurückgegebene Objekt enthält die Public-Member-Variablen short movingAveragePressure, short averagePressure und short averageTemperature.

public short[] getAPIVersion()

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.

public boolean getResponseExpected(short functionId)

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.

Siehe setResponseExpected() für die Liste der verfügbaren Funktions ID Konstanten für diese Funktion.

public void setResponseExpected(short functionId, boolean responseExpected)

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

  • BrickletBarometer.FUNCTION_SET_AIR_PRESSURE_CALLBACK_PERIOD = 3
  • BrickletBarometer.FUNCTION_SET_ALTITUDE_CALLBACK_PERIOD = 5
  • BrickletBarometer.FUNCTION_SET_AIR_PRESSURE_CALLBACK_THRESHOLD = 7
  • BrickletBarometer.FUNCTION_SET_ALTITUDE_CALLBACK_THRESHOLD = 9
  • BrickletBarometer.FUNCTION_SET_DEBOUNCE_PERIOD = 11
  • BrickletBarometer.FUNCTION_SET_REFERENCE_AIR_PRESSURE = 13
  • BrickletBarometer.FUNCTION_SET_AVERAGING = 20
public void setResponseExpectedAll(boolean responseExpected)

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

public BrickletBarometer.Identity getIdentity()

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

Das zurückgegebene Objekt enthält die Public-Member-Variablen String uid, String connectedUid, char position, short[] hardwareVersion, short[] firmwareVersion und int deviceIdentifier.

Konfigurationsfunktionen für Listener

public void setAirPressureCallbackPeriod(long period)

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

Der AirPressureListener Listener wird nur ausgelöst wenn sich der Luftdruck seit der letzten Auslösung geändert hat.

Der Standardwert ist 0.

public long getAirPressureCallbackPeriod()

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

public void setAltitudeCallbackPeriod(long period)

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

Der AltitudeListener Listener wird nur ausgelöst wenn sich Höhe seit der letzten Auslösung geändert hat.

Der Standardwert ist 0.

public long getAltitudeCallbackPeriod()

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

public void setAirPressureCallbackThreshold(char option, int min, int max)

Setzt den Schwellwert für den AirPressureReachedListener Listener.

Die folgenden Optionen sind möglich:

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

  • BrickletBarometer.THRESHOLD_OPTION_OFF = 'x'
  • BrickletBarometer.THRESHOLD_OPTION_OUTSIDE = 'o'
  • BrickletBarometer.THRESHOLD_OPTION_INSIDE = 'i'
  • BrickletBarometer.THRESHOLD_OPTION_SMALLER = '<'
  • BrickletBarometer.THRESHOLD_OPTION_GREATER = '>'
public BrickletBarometer.AirPressureCallbackThreshold getAirPressureCallbackThreshold()

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

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

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

Das zurückgegebene Objekt enthält die Public-Member-Variablen char option, int min und int max.

public void setAltitudeCallbackThreshold(char option, int min, int max)

Setzt den Schwellwert für den AltitudeReachedListener Listener.

Die folgenden Optionen sind möglich:

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

  • BrickletBarometer.THRESHOLD_OPTION_OFF = 'x'
  • BrickletBarometer.THRESHOLD_OPTION_OUTSIDE = 'o'
  • BrickletBarometer.THRESHOLD_OPTION_INSIDE = 'i'
  • BrickletBarometer.THRESHOLD_OPTION_SMALLER = '<'
  • BrickletBarometer.THRESHOLD_OPTION_GREATER = '>'
public BrickletBarometer.AltitudeCallbackThreshold getAltitudeCallbackThreshold()

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

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

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

Das zurückgegebene Objekt enthält die Public-Member-Variablen char option, int min und int max.

public void setDebouncePeriod(long debounce)

Setzt die Periode in ms mit welcher die Schwellwert Listeners

ausgelöst werden, wenn die Schwellwerte

weiterhin erreicht bleiben.

Der Standardwert ist 100.

public long getDebouncePeriod()

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

public class BrickletBarometer.AirPressureListener()

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

public void airPressure(int airPressure)

Dieser Listener wird mit der Periode, wie gesetzt mit setAirPressureCallbackPeriod(), ausgelöst. Der Parameter ist der Luftdruck des Luftdrucksensors.

Der AirPressureListener Listener wird nur ausgelöst wenn sich der Luftdruck seit der letzten Auslösung geändert hat.

public class BrickletBarometer.AltitudeListener()

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

public void altitude(int altitude)

Dieser Listener wird mit der Periode, wie gesetzt mit setAltitudeCallbackPeriod(), ausgelöst. Der Parameter ist die Höhe des Luftdrucksensors.

Der AltitudeListener Listener wird nur ausgelöst wenn sich die Höhe seit der letzten Auslösung geändert hat.

public class BrickletBarometer.AirPressureReachedListener()

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

public void airPressureReached(int airPressure)

Dieser Listener wird ausgelöst wenn der Schwellwert, wie von setAirPressureCallbackThreshold() gesetzt, erreicht wird. Der Parameter ist der Luftdruck des Luftdrucksensors.

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

public class BrickletBarometer.AltitudeReachedListener()

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

public void altitudeReached(int altitude)

Dieser Listener wird ausgelöst wenn der Schwellwert, wie von setAltitudeCallbackThreshold() gesetzt, erreicht wird. Der Parameter ist die Höhe des Luftdrucksensors.

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

Konstanten

public static final int BrickletBarometer.DEVICE_IDENTIFIER

Diese Konstante wird verwendet um ein Barometer Bricklet zu identifizieren.

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

public static final String BrickletBarometer.DEVICE_DISPLAY_NAME

Diese Konstante stellt den Anzeigenamen eines Barometer Bricklet dar.