Für diese Projekt setzen wir voraus, dass eine Java Entwicklungsumgebung eingerichtet ist und ein grundsätzliches Verständnis der Java Programmiersprache vorhanden ist.
Falls dies nicht der Fall ist sollte hier begonnen werden. Informationen über die Tinkerforge API sind dann hier zu finden.
Wir setzen uns folgende Ziele für dieses Projekt:
Da dieses Projekt wahrscheinlich 24/7 laufen wird, wollen wir sicherstellen, dass das Programm möglichst robust gegen externe Einflüsse ist. Das Programm sollte weiterhin funktionieren falls
Im Folgenden werden wir Schritt für Schritt zeigen wie diese Ziele erreicht werden können.
Als Erstes legen wir fest wohin unser Programm sich verbinden soll:
private static final String host = "localhost";
private static final int port = 4223;
Falls eine WIFI Extension verwendet wird, oder der Brick Daemon auf einem anderen PC läuft, dann muss "localhost" durch die IP Adresse oder den Hostnamen der WIFI Extension oder des anderen PCs ersetzt werden.
Nach dem Start des Programms müssen der EnumerateListener
Listener
und der ConnectedListener
Listener registriert und ein erstes
Enumerate ausgelöst werden:
public static void main(String args[]) {
ipcon = new IPConnection();
ipcon.connect(host, port);
weatherListener = new WeatherListener(ipcon);
ipcon.addEnumerateListener(weatherListener);
ipcon.addConnectedListener(weatherListener);
ipcon.enumerate();
}
Der Enumerate Callback wird ausgelöst wenn ein Brick per USB angeschlossen wird
oder wenn die enumerate()
Funktion aufgerufen wird. Dies ermöglicht es die
Bricks und Bricklets im Stapel zu erkennen ohne im Voraus ihre UIDs kennen zu
müssen.
Der Connected Callback wird ausgelöst wenn die Verbindung zur WIFI Extension oder zum Brick Daemon hergestellt wurde. In diesem Callback muss wiederum ein Enumerate angestoßen werden, wenn es sich um ein Auto-Reconnect handelt:
class WeatherListener implements IPConnection.EnumerateListener,
IPConnection.ConnectedListener {
public void connected(short connectedReason) {
if(connectedReason == IPConnection.CONNECT_REASON_AUTO_RECONNECT) {
ipcon.enumerate();
}
}
}
Ein Auto-Reconnect bedeutet, dass die Verbindung zur WIFI Extension oder zum Brick Daemon verloren gegangen ist und automatisch wiederhergestellt werden konnte. In diesem Fall kann es sein, dass die Bricklets ihre Konfiguration verloren haben und wir sie neu konfigurieren müssen. Da die Konfiguration beim Enumerate (siehe unten) durchgeführt wird, lösen wir einfach noch ein Enumerate aus.
Schritt 1 zusammengefügt:
class WeatherListener implements IPConnection.EnumerateListener,
IPConnection.ConnectedListener {
private IPConnection ipcon = null;
public WeatherListener(IPConnection ipcon) {
this.ipcon = ipcon;
}
public void connected(short connectedReason) {
if(connectedReason == IPConnection.CONNECT_REASON_AUTO_RECONNECT) {
ipcon.enumerate();
}
}
}
public class WeatherStation {
private static final String host = "localhost";
private static final int port = 4223;
private static IPConnection ipcon = null;
private static WeatherListener weatherListener = null;
public static void main(String args[]) {
ipcon = new IPConnection();
ipcon.connect(host, port);
weatherListener = new WeatherListener(ipcon);
ipcon.addEnumerateListener(weatherListener);
ipcon.addConnectedListener(weatherListener);
ipcon.enumerate();
}
}
Während des Enumerierungsprozesse sollen alle messenden Bricklets konfiguriert werden. Dadurch ist sichergestellt, dass sie neu konfiguriert werden nach einem Verbindungsabbruch oder einer Unterbrechung der Stromversorgung.
Die Konfiguration soll beim ersten Start (ENUMERATION_TYPE_CONNECTED
)
durchgeführt werden und auch bei jedem extern ausgelösten Enumerate
(ENUMERATION_TYPE_AVAILABLE
):
public void enumerate(String uid, String connectedUid, char position,
short[] hardwareVersion, short[] firmwareVersion,
int deviceIdentifier, short enumerationType) {
if(enumerationType == IPConnection.ENUMERATION_TYPE_CONNECTED ||
enumerationType == IPConnection.ENUMERATION_TYPE_AVAILABLE) {
Die Konfiguration des LCD 20x4 ist einfach, wir löschen den aktuellen Inhalt des Displays und schalten das Backlight ein:
if(deviceIdentifier == BrickletLCD20x4.DEVICE_IDENTIFIER) {
brickletLCD = new BrickletLCD20x4(uid, ipcon);
brickletLCD.clearDisplay();
brickletLCD.backlightOn();
}
Das Ambient Light, Humidity und Barometer Bricklet werden so eingestellt, dass sie uns ihre jeweiligen Messwerte höchsten mit einer Periode von 1000ms (1s) mitteilen:
else if(deviceIdentifier == BrickletAmbientLight.DEVICE_IDENTIFIER) {
brickletAmbientLight = new BrickletAmbientLight(uid, ipcon);
brickletAmbientLight.setIlluminanceCallbackPeriod(1000);
brickletAmbientLight.addIlluminanceListener(this);
} else if(deviceIdentifier == BrickletHumidity.DEVICE_IDENTIFIER) {
brickletHumidity = new BrickletHumidity(uid, ipcon);
brickletHumidity.setHumidityCallbackPeriod(1000);
brickletHumidity.addHumidityListener(this);
} else if(deviceIdentifier == BrickletBarometer.DEVICE_IDENTIFIER) {
brickletBarometer = new BrickletBarometer(uid, ipcon);
brickletBarometer.setAirPressureCallbackPeriod(1000);
brickletBarometer.addAirPressureListener(this);
}
Dies bedeutet, dass die Bricklets die illuminance
, humidity
und airPressure
Callback-Funktionen immer dann aufrufen wenn sich der
Messwert verändert hat, aber höchsten alle 1000ms.
Schritt 2 zusammengefügt:
public void enumerate(String uid, String connectedUid, char position,
short[] hardwareVersion, short[] firmwareVersion,
int deviceIdentifier, short enumerationType) {
if(enumerationType == IPConnection.ENUMERATION_TYPE_CONNECTED ||
enumerationType == IPConnection.ENUMERATION_TYPE_AVAILABLE) {
if(deviceIdentifier == BrickletLCD20x4.DEVICE_IDENTIFIER) {
brickletLCD = new BrickletLCD20x4(uid, ipcon);
brickletLCD.clearDisplay();
brickletLCD.backlightOn();
} else if(deviceIdentifier == BrickletAmbientLight.DEVICE_IDENTIFIER) {
brickletAmbientLight = new BrickletAmbientLight(uid, ipcon);
brickletAmbientLight.setIlluminanceCallbackPeriod(1000);
brickletAmbientLight.addIlluminanceListener(this);
} else if(deviceIdentifier == BrickletHumidity.DEVICE_IDENTIFIER) {
brickletHumidity = new BrickletHumidity(uid, ipcon);
brickletHumidity.setHumidityCallbackPeriod(1000);
brickletHumidity.addHumidityListener(this);
} else if(deviceIdentifier == BrickletBarometer.DEVICE_IDENTIFIER) {
brickletBarometer = new BrickletBarometer(uid, ipcon);
brickletBarometer.setAirPressureCallbackPeriod(1000);
brickletBarometer.addAirPressureListener(this);
}
}
}
Wir wollen eine hübsche Darstellung der Messwerte auf dem Display. Zum Beispiel:
Illuminanc 137.39 lx
Humidity 34.10 %
Air Press 987.70 mb
Temperature 22.64 °C
Die Dezimaltrennzeichen und die Einheiten sollen in jeweils einer Spalte übereinander stehen. Daher verwenden wird zwei Zeichen für jede Einheit, zwei Nachkommastellen und kürzen die Namen so, dass sie in den restlichen Platz der jeweiligen Zeile passen. Das ist auch der Grund, warum dem "Illuminanc" das letzte "e" fehlt.
String text = String.format("%6.2f", value);
Der obige Ausdruck wandelt eine Fließkommazahl in eine Zeichenkette um, gemäß der gegebenen Formatspezifikation. Das Ergebnis ist dann mindestens 6 Zeichen lang mit 2 Nachkommastellen. Fall es weniger als 6 Zeichen sind wird von Links mit Leerzeichen aufgefüllt.
public void illuminance(int illuminance) {
String text = String.format("Illuminanc %6.2f lx", illuminance/10.0);
brickletLCD.writeLine((short)0, (short)0, text);
}
public void humidity(int humidity) {
String text = String.format("Humidity %6.2f %%", humidity/10.0);
brickletLCD.writeLine((short)1, (short)0, text);
}
public void airPressure(int airPressure) {
String text = String.format("Air Press %7.2f mb", airPressure/1000.0);
brickletLCD.writeLine((short)2, (short)0, text);
}
Es fehlt noch die Temperatur. Das Barometer Bricklet kann auch die Temperatur
messen, aber es hat dafür keinen Callback. Als einfacher Workaround können wir
die Temperatur in der airPressure
Callback-Funktion abfragen:
public void airPressure(int airPressure) {
String text = String.format("Air Press %7.2f mb", airPressure/1000.0);
brickletLCD.writeLine((short)2, (short)0, text);
int temperature = brickletBarometer.getChipTemperature();
text = String.format("Temperature %5.2f %cC", temperature/100.0, 0xDF);
brickletLCD.writeLine((short)3, (short)0, text);
}
Schritt 3 zusammengefügt:
public void illuminance(int illuminance) {
String text = String.format("Illuminanc %6.2f lx", illuminance/10.0);
brickletLCD.writeLine((short)0, (short)0, text);
}
public void humidity(int humidity) {
String text = String.format("Humidity %6.2f %%", humidity/10.0);
brickletLCD.writeLine((short)1, (short)0, text);
}
public void airPressure(int airPressure) {
String text = String.format("Air Press %7.2f mb", airPressure/1000.0);
brickletLCD.writeLine((short)2, (short)0, text);
int temperature = brickletBarometer.getChipTemperature();
// 0xDF == ° on LCD 20x4 charset
text = String.format("Temperature %5.2f %cC", temperature/100.0, 0xDF);
brickletLCD.writeLine((short)3, (short)0, text);
}
Das ist es. Wenn wir diese drei Schritte zusammen in eine Datei kopieren und ausführen, dann hätten wir jetzt eine funktionierenden Wetterstation.
Es gibt einige offensichtliche Möglichkeiten die Ausgabe der Messdaten noch zu
verbessern. Die Namen könnten dynamisch exakt gekürzt werden, abhängig vom
aktuell freien Raum der jeweiligen Zeile. Auch könnten die Namen können noch
ins Deutsche übersetzt werden. Ein anderes Problem ist die Abfrage der
Temperatur in der airPressure
Callback-Funktion. Wenn sich der Luftdruck
nicht ändert dann wird auch die Anzeige der Temperatur nicht aktualisiert, auch
wenn sich diese eigentlich geändert hat. Es wäre besser die Temperatur jede Sekunde in einem eigenen Thread anzufragen.
Aber wir wollen das Programm für den Anfang einfach halten.
Wie dem auch sei, wir haben noch nicht alle Ziele erreicht. Das Programm ist noch nicht robust genug. Was passiert wenn die Verbindung beim Start des Programms nicht hergestellt werden kann, oder wenn das Enumerate nach einem Auto-Reconnect nicht funktioniert?
Wir brauchen noch Fehlerbehandlung!
Beim Start des Programms versuchen wir solange die Verbindung herzustellen, bis es klappt:
while(true) {
try {
ipcon.connect(host, port);
break;
} catch(java.net.UnknownHostException e) {
} catch(java.io.IOException e) {
} catch(com.tinkerforge.AlreadyConnectedException e) {
}
try {
Thread.sleep(1000);
} catch(InterruptedException ei) {
}
}
und es wird solange versucht ein Enumerate zu starten bis auch dis geklappt hat:
while(true) {
try {
ipcon.enumerate();
break;
} catch(com.tinkerforge.NotConnectedException e) {
}
try {
Thread.sleep(1000);
} catch(InterruptedException ei) {
}
}
Mit diesen Änderungen kann das Programm schon gestartet werden bevor die Wetterstation angeschlossen ist.
Es muss auch sichergestellt werden, dass wir nur auf das LCD schreiben nachdem es initialisiert wurde:
public void illuminance(int illuminance) {
if(brickletLCD != null) {
String text = String.format("Illuminanc %6.2f lx", illuminance/10.0);
try {
brickletLCD.writeLine((short)0, (short)0, text);
} catch(com.tinkerforge.TinkerforgeException e) {
}
System.out.println("Write to line 0: " + text);
}
}
und es müssen mögliche Fehler während des Enumerierungsprozesses behandelt werden:
if(deviceIdentifier == BrickletAmbientLight.DEVICE_IDENTIFIER) {
try {
brickletAmbientLight = new BrickletAmbientLight(uid, ipcon);
brickletAmbientLight.setIlluminanceCallbackPeriod(1000);
brickletAmbientLight.addIlluminanceListener(this);
System.out.println("Ambient Light initialized");
} catch(com.tinkerforge.TinkerforgeException e) {
brickletAmbientLight = null;
System.out.println("Ambient Light init failed: " + e);
}
}
Zusätzlich wollen wir noch ein paar Logausgaben einfügen. Diese ermöglichen es später herauszufinden was ein Problem ausgelöst hat, wenn die Wetterstation nach einer Weile möglicherweise nicht mehr funktioniert wie erwartet.
Zum Beispiel, wenn die Wetterstation über WLAN angebunden ist und häufig Auto-Reconnects auftreten, dann ist wahrscheinlich die WLAN Verbindung nicht sehr stabil.
Jetzt sind alle für diese Projekt gesteckten Ziele erreicht.
Das gesamte Programm für die Wetterstation (download):
import com.tinkerforge.IPConnection;
import com.tinkerforge.BrickletLCD20x4;
import com.tinkerforge.BrickletAmbientLight;
import com.tinkerforge.BrickletAmbientLightV2;
import com.tinkerforge.BrickletAmbientLightV3;
import com.tinkerforge.BrickletHumidity;
import com.tinkerforge.BrickletHumidityV2;
import com.tinkerforge.BrickletBarometer;
import com.tinkerforge.BrickletBarometerV2;
class WeatherListener implements IPConnection.EnumerateListener,
IPConnection.ConnectedListener,
BrickletAmbientLight.IlluminanceListener,
BrickletAmbientLightV2.IlluminanceListener,
BrickletAmbientLightV3.IlluminanceListener,
BrickletHumidity.HumidityListener,
BrickletHumidityV2.HumidityListener,
BrickletBarometer.AirPressureListener,
BrickletBarometerV2.AirPressureListener {
private IPConnection ipcon = null;
private BrickletLCD20x4 brickletLCD = null;
private BrickletAmbientLight brickletAmbientLight = null;
private BrickletAmbientLightV2 brickletAmbientLightV2 = null;
private BrickletAmbientLightV3 brickletAmbientLightV3 = null;
private BrickletHumidity brickletHumidity = null;
private BrickletHumidityV2 brickletHumidityV2 = null;
private BrickletBarometer brickletBarometer = null;
private BrickletBarometerV2 brickletBarometerV2 = null;
public WeatherListener(IPConnection ipcon) {
this.ipcon = ipcon;
}
public void illuminance(int illuminance) {
if(brickletLCD != null) {
String text = String.format("Illuminanc %6.2f lx", illuminance/10.0);
try {
brickletLCD.writeLine((short)0, (short)0, text);
} catch(com.tinkerforge.TinkerforgeException e) {
}
System.out.println("Write to line 0: " + text);
}
}
public void illuminance(long illuminance) {
if(brickletLCD != null) {
String text = String.format("Illumina %8.2f lx", illuminance/100.0);
try {
brickletLCD.writeLine((short)0, (short)0, text);
} catch(com.tinkerforge.TinkerforgeException e) {
}
System.out.println("Write to line 0: " + text);
}
}
public void humidity(int humidity) {
if(brickletLCD != null) {
float factor = 10.0f;
if (brickletHumidityV2 != null) {
factor = 100.0f; // FIXME: assuming that only one Humiditiy Bricklet (2.0) is connected
}
String text = String.format("Humidity %6.2f %%", humidity/factor);
try {
brickletLCD.writeLine((short)1, (short)0, text);
} catch(com.tinkerforge.TinkerforgeException e) {
}
System.out.println("Write to line 1: " + text);
}
}
public void airPressure(int airPressure) {
if(brickletLCD != null) {
String text = String.format("Air Press %7.2f mb", airPressure/1000.0);
try {
brickletLCD.writeLine((short)2, (short)0, text);
} catch(com.tinkerforge.TinkerforgeException e) {
}
System.out.println("Write to line 2: " + text);
int temperature;
try {
if (brickletBarometerV2 != null) {
temperature = brickletBarometerV2.getTemperature();
}
else {
temperature = brickletBarometer.getChipTemperature();
}
} catch(com.tinkerforge.TinkerforgeException e) {
System.out.println("Could not get temperature: " + e);
return;
}
// 0xDF == ° on LCD 20x4 charset
text = String.format("Temperature %5.2f %cC", temperature/100.0, 0xDF);
try {
brickletLCD.writeLine((short)3, (short)0, text);
} catch(com.tinkerforge.TinkerforgeException e) {
}
System.out.println("Write to line 3: " + text.replace((char)0xDF, '°'));
}
}
public void enumerate(String uid, String connectedUid, char position,
short[] hardwareVersion, short[] firmwareVersion,
int deviceIdentifier, short enumerationType) {
if(enumerationType == IPConnection.ENUMERATION_TYPE_CONNECTED ||
enumerationType == IPConnection.ENUMERATION_TYPE_AVAILABLE) {
if(deviceIdentifier == BrickletLCD20x4.DEVICE_IDENTIFIER) {
try {
brickletLCD = new BrickletLCD20x4(uid, ipcon);
brickletLCD.clearDisplay();
brickletLCD.backlightOn();
System.out.println("LCD 20x4 initialized");
} catch(com.tinkerforge.TinkerforgeException e) {
brickletLCD = null;
System.out.println("LCD 20x4 init failed: " + e);
}
} else if(deviceIdentifier == BrickletAmbientLight.DEVICE_IDENTIFIER) {
try {
brickletAmbientLight = new BrickletAmbientLight(uid, ipcon);
brickletAmbientLight.setIlluminanceCallbackPeriod(1000);
brickletAmbientLight.addIlluminanceListener(this);
System.out.println("Ambient Light initialized");
} catch(com.tinkerforge.TinkerforgeException e) {
brickletAmbientLight = null;
System.out.println("Ambient Light init failed: " + e);
}
} else if(deviceIdentifier == BrickletAmbientLightV2.DEVICE_IDENTIFIER) {
try {
brickletAmbientLightV2 = new BrickletAmbientLightV2(uid, ipcon);
brickletAmbientLightV2.setConfiguration(BrickletAmbientLightV2.ILLUMINANCE_RANGE_64000LUX,
BrickletAmbientLightV2.INTEGRATION_TIME_200MS);
brickletAmbientLightV2.setIlluminanceCallbackPeriod(1000);
brickletAmbientLightV2.addIlluminanceListener(this);
System.out.println("Ambient Light 2.0 initialized");
} catch(com.tinkerforge.TinkerforgeException e) {
brickletAmbientLightV2 = null;
System.out.println("Ambient Light 2.0 init failed: " + e);
}
} else if(deviceIdentifier == BrickletAmbientLightV3.DEVICE_IDENTIFIER) {
try {
brickletAmbientLightV3 = new BrickletAmbientLightV3(uid, ipcon);
brickletAmbientLightV3.setConfiguration(BrickletAmbientLightV3.ILLUMINANCE_RANGE_64000LUX,
BrickletAmbientLightV3.INTEGRATION_TIME_200MS);
brickletAmbientLightV3.setIlluminanceCallbackConfiguration(1000, false, 'x', 0, 0);
brickletAmbientLightV3.addIlluminanceListener(this);
System.out.println("Ambient Light 3.0 initialized");
} catch(com.tinkerforge.TinkerforgeException e) {
brickletAmbientLightV3 = null;
System.out.println("Ambient Light 3.0 init failed: " + e);
}
} else if(deviceIdentifier == BrickletHumidity.DEVICE_IDENTIFIER) {
try {
brickletHumidity = new BrickletHumidity(uid, ipcon);
brickletHumidity.setHumidityCallbackPeriod(1000);
brickletHumidity.addHumidityListener(this);
System.out.println("Humidity initialized");
} catch(com.tinkerforge.TinkerforgeException e) {
brickletHumidity = null;
System.out.println("Humidity init failed: " + e);
}
} else if(deviceIdentifier == BrickletHumidityV2.DEVICE_IDENTIFIER) {
try {
brickletHumidityV2 = new BrickletHumidityV2(uid, ipcon);
brickletHumidityV2.setHumidityCallbackConfiguration(1000, true, 'x', 0, 0);
brickletHumidityV2.addHumidityListener(this);
System.out.println("Humidity 2.0 initialized");
} catch(com.tinkerforge.TinkerforgeException e) {
brickletHumidityV2 = null;
System.out.println("Humidity 2.0 init failed: " + e);
}
} else if(deviceIdentifier == BrickletBarometer.DEVICE_IDENTIFIER) {
try {
brickletBarometer = new BrickletBarometer(uid, ipcon);
brickletBarometer.setAirPressureCallbackPeriod(1000);
brickletBarometer.addAirPressureListener(this);
System.out.println("Barometer initialized");
} catch(com.tinkerforge.TinkerforgeException e) {
brickletBarometer = null;
System.out.println("Barometer init failed: " + e);
}
} else if(deviceIdentifier == BrickletBarometerV2.DEVICE_IDENTIFIER) {
try {
brickletBarometerV2 = new BrickletBarometerV2(uid, ipcon);
brickletBarometerV2.setAirPressureCallbackConfiguration(1000, false, 'x', 0, 0);
brickletBarometerV2.addAirPressureListener(this);
System.out.println("Barometer 2.0 initialized");
} catch(com.tinkerforge.TinkerforgeException e) {
brickletBarometerV2 = null;
System.out.println("Barometer 2.0 init failed: " + e);
}
}
}
}
public void connected(short connectedReason) {
if(connectedReason == IPConnection.CONNECT_REASON_AUTO_RECONNECT) {
System.out.println("Auto Reconnect");
while(true) {
try {
ipcon.enumerate();
break;
} catch(com.tinkerforge.NotConnectedException e) {
}
try {
Thread.sleep(1000);
} catch(InterruptedException ei) {
}
}
}
}
}
public class WeatherStation {
private static final String HOST = "localhost";
private static final int PORT = 4223;
private static IPConnection ipcon = null;
private static WeatherListener weatherListener = null;
public static void main(String args[]) {
ipcon = new IPConnection();
while(true) {
try {
ipcon.connect(HOST, PORT);
break;
} catch(com.tinkerforge.TinkerforgeException e) {
}
try {
Thread.sleep(1000);
} catch(InterruptedException ei) {
}
}
weatherListener = new WeatherListener(ipcon);
ipcon.addEnumerateListener(weatherListener);
ipcon.addConnectedListener(weatherListener);
while(true) {
try {
ipcon.enumerate();
break;
} catch(com.tinkerforge.NotConnectedException e) {
}
try {
Thread.sleep(1000);
} catch(InterruptedException ei) {
}
}
try {
System.out.println("Press key to exit"); System.in.read();
} catch(java.io.IOException e) {
}
try {
ipcon.disconnect();
} catch(com.tinkerforge.NotConnectedException e) {
}
}
}