Für diese Projekt setzen wir voraus, dass eine C# Entwicklungsumgebung eingerichtet ist und ein grundsätzliches Verständnis der C# 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 string HOST = "localhost";
private static 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 EnumerateCallback
Callback
und der Connected
Callback registriert und ein erstes
Enumerate ausgelöst werden:
static void Main()
{
ipcon = new IPConnection();
ipcon.Connect(HOST, PORT);
ipcon.EnumerateCallback += EnumerateCB;
ipcon.Connected += ConnectedCB;
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:
static void ConnectedCB(IPConnection sender, 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 WeatherStation
{
private static string HOST = "localhost";
private static int PORT = 4223;
static void ConnectedCB(IPConnection sender, short connectedReason)
{
if(connectedReason == IPConnection.CONNECT_REASON_AUTO_RECONNECT)
{
ipcon.Enumerate();
}
}
static void Main()
{
ipcon = new IPConnection();
ipcon.Connect(HOST, PORT);
ipcon.EnumerateCallback += EnumerateCB;
ipcon.Connected += ConnectedCB;
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
):
static void EnumerateCB(IPConnection sender, 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.Illuminance += IlluminanceCB;
}
else if(deviceIdentifier == BrickletHumidity.DEVICE_IDENTIFIER)
{
brickletHumidity = new BrickletHumidity(UID, ipcon);
brickletHumidity.SetHumidityCallbackPeriod(1000);
brickletHumidity.Humidity += HumidityCB;
}
else if(deviceIdentifier == BrickletBarometer.DEVICE_IDENTIFIER)
{
brickletBarometer = new BrickletBarometer(UID, ipcon);
brickletBarometer.SetAirPressureCallbackPeriod(1000);
brickletBarometer.AirPressure += AirPressureCB;
}
Dies bedeutet, dass die Bricklets die IlluminanceCB
, HumidityCB
und AirPressureCB
Callback-Funktionen immer dann aufrufen wenn sich der
Messwert verändert hat, aber höchsten alle 1000ms.
Schritt 2 zusammengefügt:
static void EnumerateCB(IPConnection sender, 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.Illuminance += IlluminanceCB;
}
else if(deviceIdentifier == BrickletHumidity.DEVICE_IDENTIFIER)
{
brickletHumidity = new BrickletHumidity(UID, ipcon);
brickletHumidity.SetHumidityCallbackPeriod(1000);
brickletHumidity.Humidity += HumidityCB;
}
else if(deviceIdentifier == BrickletBarometer.DEVICE_IDENTIFIER)
{
brickletBarometer = new BrickletBarometer(UID, ipcon);
brickletBarometer.SetAirPressureCallbackPeriod(1000);
brickletBarometer.AirPressure += AirPressureCB;
}
}
}
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("{0,6:###.00}", 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.
static void IlluminanceCB(BrickletAmbientLight sender, int illuminance)
{
string text = string.Format("Illuminanc {0,6:###.00} lx", illuminance/10.0);
brickletLCD.WriteLine(0, 0, text);
}
static void HumidityCB(BrickletHumidity sender, int humidity)
{
string text = string.Format("Humidity {0,6:###.00} %", humidity/10.0);
brickletLCD.WriteLine(1, 0, text);
}
static void AirPressureCB(BrickletBarometer sender, int airPressure)
{
string text = string.Format("Air Press {0,7:####.00} mb", airPressure/1000.0);
brickletLCD.WriteLine(2, 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 AirPressureCB
Callback-Funktion abfragen:
static void AirPressureCB(BrickletBarometer sender, int airPressure)
{
string text = string.Format("Air Press {0,7:####.00} mb", airPressure/1000.0);
brickletLCD.WriteLine(2, 0, text);
int temperature = sender.GetChipTemperature();
text = string.Format("Temperature {0,5:##.00} {1}C", temperature/100.0, (char)0xDF);
brickletLCD.WriteLine(3, 0, text);
}
Schritt 3 zusammengefügt:
static void IlluminanceCB(BrickletAmbientLight sender, int illuminance)
{
string text = string.Format("Illuminanc {0,6:###.00} lx", illuminance/10.0);
brickletLCD.WriteLine(0, 0, text);
}
static void HumidityCB(BrickletHumidity sender, int humidity)
{
string text = string.Format("Humidity {0,6:###.00} %", humidity/10.0);
brickletLCD.WriteLine(1, 0, text);
}
static void AirPressureCB(BrickletBarometer sender, int airPressure)
{
string text = string.Format("Air Press {0,7:####.00} mb", airPressure/1000.0);
brickletLCD.WriteLine(2, 0, text);
int temperature = sender.GetChipTemperature();
// 0xDF == ° on LCD 20x4 charset
text = string.Format("Temperature {0,5:##.00} {1}C", temperature/100.0, (char)0xDF);
brickletLCD.WriteLine(3, 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 AirPressureCB
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(System.Net.Sockets.SocketException e)
{
System.Console.WriteLine("Connection Error: " + e.Message);
System.Threading.Thread.Sleep(1000);
}
}
und es wird solange versucht ein Enumerate zu starten bis auch dis geklappt hat:
while(true)
{
try
{
ipcon.Enumerate();
break;
}
catch(NotConnectedException e)
{
System.Console.WriteLine("Enumeration Error: " + e.Message);
System.Threading.Thread.Sleep(1000);
}
}
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:
static void IlluminanceCB(BrickletAmbientLight sender, int illuminance)
{
if(brickletLCD != null)
{
string text = string.Format("Illuminanc {0,6:###.00} lx", illuminance/10.0);
brickletLCD.WriteLine(0, 0, text);
System.Console.WriteLine("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.Illuminance += IlluminanceCB;
System.Console.WriteLine("Ambient Light initialized");
}
catch(TinkerforgeException e)
{
System.Console.WriteLine("Ambient Light init failed: " + e.Message);
brickletAmbientLight = null;
}
}
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):
using Tinkerforge;
class WeatherStation
{
private static string HOST = "localhost";
private static int PORT = 4223;
private static IPConnection ipcon = null;
private static BrickletLCD20x4 brickletLCD = null;
private static BrickletAmbientLight brickletAmbientLight = null;
private static BrickletAmbientLightV2 brickletAmbientLightV2 = null;
private static BrickletAmbientLightV3 brickletAmbientLightV3 = null;
private static BrickletHumidity brickletHumidity = null;
private static BrickletHumidityV2 brickletHumidityV2 = null;
private static BrickletBarometer brickletBarometer = null;
private static BrickletBarometerV2 brickletBarometerV2 = null;
static void IlluminanceCB(BrickletAmbientLight sender, int illuminance)
{
if(brickletLCD != null)
{
string text = string.Format("Illuminanc {0,6:###.00} lx", illuminance / 10.0);
brickletLCD.WriteLine(0, 0, text);
System.Console.WriteLine("Write to line 0: " + text);
}
}
static void IlluminanceV2CB(BrickletAmbientLightV2 sender, long illuminance)
{
if(brickletLCD != null)
{
string text = string.Format("Illumina {0,8:###.00} lx", illuminance / 100.0);
brickletLCD.WriteLine(0, 0, text);
System.Console.WriteLine("Write to line 0: " + text);
}
}
static void IlluminanceV3CB(BrickletAmbientLightV3 sender, long illuminance)
{
if(brickletLCD != null)
{
string text = string.Format("Illumina {0,8:###.00} lx", illuminance / 100.0);
brickletLCD.WriteLine(0, 0, text);
System.Console.WriteLine("Write to line 0: " + text);
}
}
static void HumidityCB(BrickletHumidity sender, int humidity)
{
if(brickletLCD != null)
{
string text = string.Format("Humidity {0,6:###.00} %", humidity / 10.0);
brickletLCD.WriteLine(1, 0, text);
System.Console.WriteLine("Write to line 1: " + text);
}
}
static void HumidityV2CB(BrickletHumidityV2 sender, int humidity)
{
if(brickletLCD != null)
{
string text = string.Format("Humidity {0,6:###.00} %", humidity / 100.0);
brickletLCD.WriteLine(1, 0, text);
System.Console.WriteLine("Write to line 1: " + text);
}
}
static void AirPressureCB(BrickletBarometer sender, int airPressure)
{
if(brickletLCD != null)
{
string text = string.Format("Air Press {0,7:####.00} mb", airPressure / 1000.0);
brickletLCD.WriteLine(2, 0, text);
System.Console.WriteLine("Write to line 2: " + text);
int temperature;
try
{
temperature = sender.GetChipTemperature();
}
catch(TinkerforgeException e)
{
System.Console.WriteLine("Could not get temperature: " + e.Message);
return;
}
// 0xDF == ° on LCD 20x4 charset.
text = string.Format("Temperature {0,5:##.00} {1}C", temperature / 100.0, (char)0xDF);
brickletLCD.WriteLine(3, 0, text);
System.Console.WriteLine("Write to line 3: " + text.Replace((char)0xDF, '°'));
}
}
static void AirPressureV2CB(BrickletBarometerV2 sender, int airPressure)
{
if(brickletLCD != null)
{
string text = string.Format("Air Press {0,7:####.00} mb", airPressure / 1000.0);
brickletLCD.WriteLine(2, 0, text);
System.Console.WriteLine("Write to line 2: " + text);
int temperature;
try
{
temperature = sender.GetTemperature();
}
catch(TinkerforgeException e)
{
System.Console.WriteLine("Could not get temperature: " + e.Message);
return;
}
// 0xDF == ° on LCD 20x4 charset.
text = string.Format("Temperature {0,5:##.00} {1}C", temperature / 100.0, (char)0xDF);
brickletLCD.WriteLine(3, 0, text);
System.Console.WriteLine("Write to line 3: " + text.Replace((char)0xDF, '°'));
}
}
static void EnumerateCB(IPConnection sender,
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.Console.WriteLine("LCD 20x4 initialized");
}
catch(TinkerforgeException e)
{
System.Console.WriteLine("LCD 20x4 init failed: " + e.Message);
brickletLCD = null;
}
}
else if(deviceIdentifier == BrickletAmbientLight.DEVICE_IDENTIFIER)
{
try
{
brickletAmbientLight = new BrickletAmbientLight(UID, ipcon);
brickletAmbientLight.SetIlluminanceCallbackPeriod(1000);
brickletAmbientLight.Illuminance += IlluminanceCB;
System.Console.WriteLine("Ambient Light initialized");
}
catch(TinkerforgeException e)
{
System.Console.WriteLine("Ambient Light init failed: " + e.Message);
brickletAmbientLight = null;
}
}
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.Illuminance += IlluminanceV2CB;
System.Console.WriteLine("Ambient Light 2.0 initialized");
}
catch(TinkerforgeException e)
{
System.Console.WriteLine("Ambient Light 2.0 init failed: " + e.Message);
brickletAmbientLightV2 = null;
}
}
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.IlluminanceCallback += IlluminanceV3CB;
System.Console.WriteLine("Ambient Light 3.0 initialized");
}
catch(TinkerforgeException e)
{
System.Console.WriteLine("Ambient Light 3.0 init failed: " + e.Message);
brickletAmbientLightV3 = null;
}
}
else if(deviceIdentifier == BrickletHumidity.DEVICE_IDENTIFIER)
{
try
{
brickletHumidity = new BrickletHumidity(UID, ipcon);
brickletHumidity.SetHumidityCallbackPeriod(1000);
brickletHumidity.Humidity += HumidityCB;
System.Console.WriteLine("Humidity initialized");
}
catch(TinkerforgeException e)
{
System.Console.WriteLine("Humidity init failed: " + e.Message);
brickletHumidity = null;
}
}
else if(deviceIdentifier == BrickletHumidityV2.DEVICE_IDENTIFIER)
{
try
{
brickletHumidityV2 = new BrickletHumidityV2(UID, ipcon);
brickletHumidityV2.SetHumidityCallbackConfiguration(1000, true, 'x', 0, 0);
brickletHumidityV2.HumidityCallback += HumidityV2CB;
System.Console.WriteLine("Humidity 2.0 initialized");
}
catch(TinkerforgeException e)
{
System.Console.WriteLine("Humidity 2.0 init failed: " + e.Message);
brickletHumidityV2 = null;
}
}
else if(deviceIdentifier == BrickletBarometer.DEVICE_IDENTIFIER)
{
try
{
brickletBarometer = new BrickletBarometer(UID, ipcon);
brickletBarometer.SetAirPressureCallbackPeriod(1000);
brickletBarometer.AirPressure += AirPressureCB;
System.Console.WriteLine("Barometer initialized");
}
catch(TinkerforgeException e)
{
System.Console.WriteLine("Barometer init failed: " + e.Message);
brickletBarometer = null;
}
}
else if(deviceIdentifier == BrickletBarometerV2.DEVICE_IDENTIFIER)
{
try
{
brickletBarometerV2 = new BrickletBarometerV2(UID, ipcon);
brickletBarometerV2.SetAirPressureCallbackConfiguration(1000, false, 'x', 0, 0);
brickletBarometerV2.AirPressureCallback += AirPressureV2CB;
System.Console.WriteLine("Barometer 2.0 initialized");
}
catch(TinkerforgeException e)
{
System.Console.WriteLine("Barometer 2.0 init failed: " + e.Message);
brickletBarometerV2 = null;
}
}
}
}
static void ConnectedCB(IPConnection sender, short connectedReason)
{
if(connectedReason == IPConnection.CONNECT_REASON_AUTO_RECONNECT)
{
System.Console.WriteLine("Auto Reconnect");
while(true)
{
try
{
ipcon.Enumerate();
break;
}
catch(NotConnectedException e)
{
System.Console.WriteLine("Enumeration Error: " + e.Message);
System.Threading.Thread.Sleep(1000);
}
}
}
}
static void Main()
{
ipcon = new IPConnection();
while(true)
{
try
{
ipcon.Connect(HOST, PORT);
break;
}
catch(System.Net.Sockets.SocketException e)
{
System.Console.WriteLine("Connection Error: " + e.Message);
System.Threading.Thread.Sleep(1000);
}
}
ipcon.EnumerateCallback += EnumerateCB;
ipcon.Connected += ConnectedCB;
while(true)
{
try
{
ipcon.Enumerate();
break;
}
catch(NotConnectedException e)
{
System.Console.WriteLine("Enumeration Error: " + e.Message);
System.Threading.Thread.Sleep(1000);
}
}
System.Console.WriteLine("Press enter to exit");
System.Console.ReadLine();
ipcon.Disconnect();
}
}