Dies ist die Beschreibung der C# 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 C# API Bindings ist Teil deren allgemeine Beschreibung.
Der folgende Beispielcode ist Public Domain (CC0 1.0).
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 | using System;
using Tinkerforge;
class Example
{
private static string HOST = "localhost";
private static int PORT = 4223;
private static string UID = "XYZ"; // Change XYZ to the UID of your Barometer Bricklet
static void Main()
{
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();
Console.WriteLine("Air Pressure: " + airPressure/1000.0 + " hPa");
// Get current altitude
int altitude = b.GetAltitude();
Console.WriteLine("Altitude: " + altitude/100.0 + " m");
Console.WriteLine("Press enter to exit");
Console.ReadLine();
ipcon.Disconnect();
}
}
|
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 | using System;
using Tinkerforge;
class Example
{
private static string HOST = "localhost";
private static int PORT = 4223;
private static string UID = "XYZ"; // Change XYZ to the UID of your Barometer Bricklet
// Callback function for air pressure callback
static void AirPressureCB(BrickletBarometer sender, int airPressure)
{
Console.WriteLine("Air Pressure: " + airPressure/1000.0 + " hPa");
}
static void Main()
{
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
// Register air pressure callback to function AirPressureCB
b.AirPressureCallback += AirPressureCB;
// 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);
Console.WriteLine("Press enter to exit");
Console.ReadLine();
ipcon.Disconnect();
}
}
|
Download (ExampleThreshold.cs)
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 38 | using System;
using Tinkerforge;
class Example
{
private static string HOST = "localhost";
private static int PORT = 4223;
private static string UID = "XYZ"; // Change XYZ to the UID of your Barometer Bricklet
// Callback function for air pressure reached callback
static void AirPressureReachedCB(BrickletBarometer sender, int airPressure)
{
Console.WriteLine("Air Pressure: " + airPressure/1000.0 + " hPa");
Console.WriteLine("Enjoy the potentially good weather!");
}
static void Main()
{
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);
// Register air pressure reached callback to function AirPressureReachedCB
b.AirPressureReachedCallback += AirPressureReachedCB;
// Configure threshold for air pressure "greater than 1025 hPa"
b.SetAirPressureCallbackThreshold('>', 1025*1000, 0);
Console.WriteLine("Press enter to exit");
Console.ReadLine();
ipcon.Disconnect();
}
}
|
Prinzipiell kann jede Funktion der C# Bindings, welche einen Wert zurück gibt
eine Tinkerforge.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.
Da C# nicht mehrere Rückgabewerte direkt unterstützt, wird das out
Schlüsselwort
genutzt, um mehrere Werte aus einer Funktion zurückzugeben.
Der Namensraum für alle Brick/Bricklet Bindings und die IPConnection ist
Tinkerforge.*
.
Alle folgend aufgelisteten Methoden sind Thread-sicher.
BrickletBarometer
(string uid, IPConnection ipcon)¶Parameter: |
|
---|---|
Rückgabe: |
|
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.
BrickletBarometer.
GetAirPressure
()¶Rückgabe: |
|
---|
Gibt den Luftdruck des Luftdrucksensors zurück.
Wenn der Luftdruck periodisch abgefragt werden soll, wird empfohlen
den AirPressureCallback
Callback zu nutzen und die Periode mit
SetAirPressureCallbackPeriod()
vorzugeben.
BrickletBarometer.
GetAltitude
()¶Rückgabe: |
|
---|
Gibt die relative Höhe des Luftdrucksensors zurück. Der Wert 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
AltitudeCallback
Callback zu nutzen und die Periode mit
SetAltitudeCallbackPeriod()
vorzugeben.
BrickletBarometer.
SetReferenceAirPressure
(int airPressure)¶Parameter: |
|
---|
Setzt den Referenzluftdruck für die Höhenberechnung. 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.
BrickletBarometer.
GetReferenceAirPressure
()¶Rückgabe: |
|
---|
Gibt den Referenzluftdruckwert zurück, wie von SetReferenceAirPressure()
gesetzt.
BrickletBarometer.
GetChipTemperature
()¶Rückgabe: |
|
---|
Gibt die Temperatur des Luftdrucksensors zurück.
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.
BrickletBarometer.
SetAveraging
(byte movingAveragePressure, byte averagePressure, byte averageTemperature)¶Parameter: |
|
---|
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.
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.
Neu in Version 2.0.1 (Plugin).
BrickletBarometer.
GetAveraging
(out byte movingAveragePressure, out byte averagePressure, out byte averageTemperature)¶Ausgabeparameter: |
|
---|
Gibt die Averaging-Konfiguration zurück, wie von SetAveraging()
gesetzt.
Neu in Version 2.0.1 (Plugin).
BrickletBarometer.
SetI2CMode
(byte mode)¶Parameter: |
|
---|
Setzt den I2C Modus. Mögliche Modi sind:
Wenn Probleme mit offensichtlichen Ausreißern in den Barometer Bricklet Messungen auftreten, können diese eventuell aufgrund von elektromagnetischen Störungen sein. In diesem Fall kann es helfen die I2C Geschwindigkeit zu verringern.
Falls in einem System ein hoher Durchsatz an Nachrichten erwünscht ist, sollte die I2C Geschwindigkeit allerdings nicht verringert werden.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für mode:
Neu in Version 2.0.3 (Plugin).
BrickletBarometer.
GetI2CMode
()¶Rückgabe: |
|
---|
Gibt den I2C Modus zurück, wie von SetI2CMode()
gesetzt.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für mode:
Neu in Version 2.0.3 (Plugin).
BrickletBarometer.
GetIdentity
(out string uid, out string connectedUid, out char position, out byte[] hardwareVersion, out byte[] firmwareVersion, out int deviceIdentifier)¶Ausgabeparameter: |
|
---|
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.
BrickletBarometer.
SetAirPressureCallbackPeriod
(long period)¶Parameter: |
|
---|
Setzt die Periode mit welcher der AirPressureCallback
Callback ausgelöst
wird. Ein Wert von 0 deaktiviert den Callback.
Der AirPressureCallback
Callback wird nur ausgelöst, wenn sich der Luftdruck
seit der letzten Auslösung geändert hat.
BrickletBarometer.
GetAirPressureCallbackPeriod
()¶Rückgabe: |
|
---|
Gibt die Periode zurück, wie von SetAirPressureCallbackPeriod()
gesetzt.
BrickletBarometer.
SetAltitudeCallbackPeriod
(long period)¶Parameter: |
|
---|
Setzt die Periode mit welcher der AltitudeCallback
Callback ausgelöst wird.
Ein Wert von 0 deaktiviert den Callback.
Der AltitudeCallback
Callback wird nur ausgelöst, wenn sich Höhe seit der letzten
Auslösung geändert hat.
BrickletBarometer.
GetAltitudeCallbackPeriod
()¶Rückgabe: |
|
---|
Gibt die Periode zurück, wie von SetAltitudeCallbackPeriod()
gesetzt.
BrickletBarometer.
SetAirPressureCallbackThreshold
(char option, int min, int max)¶Parameter: |
|
---|
Setzt den Schwellwert für den AirPressureReachedCallback
Callback.
Die folgenden Optionen sind möglich:
Option | Beschreibung |
---|---|
'x' | Callback ist inaktiv |
'o' | Callback wird ausgelöst, wenn der Luftdruck außerhalb des min und max Wertes ist |
'i' | Callback wird ausgelöst, wenn der Luftdruck innerhalb des min und max Wertes ist |
'<' | Callback wird ausgelöst, wenn der Luftdruck kleiner als der min Wert ist (max wird ignoriert) |
'>' | Callback wird ausgelöst, wenn der Luftdruck größer als der min Wert ist (max wird ignoriert) |
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für option:
BrickletBarometer.
GetAirPressureCallbackThreshold
(out char option, out int min, out int max)¶Ausgabeparameter: |
|
---|
Gibt den Schwellwert zurück, wie von SetAirPressureCallbackThreshold()
gesetzt.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für option:
BrickletBarometer.
SetAltitudeCallbackThreshold
(char option, int min, int max)¶Parameter: |
|
---|
Setzt den Schwellwert für den AltitudeReachedCallback
Callback.
Die folgenden Optionen sind möglich:
Option | Beschreibung |
---|---|
'x' | Callback ist inaktiv |
'o' | Callback wird ausgelöst, wenn die Höhe außerhalb des min und max Wertes ist |
'i' | Callback wird ausgelöst, wenn die Höhe innerhalb des min und max Wertes ist |
'<' | Callback wird ausgelöst, wenn die Höhe kleiner als der min Wert ist (max wird ignoriert) |
'>' | Callback wird ausgelöst, wenn die Höhe größer als der min Wert ist (max wird ignoriert) |
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für option:
BrickletBarometer.
GetAltitudeCallbackThreshold
(out char option, out int min, out int max)¶Ausgabeparameter: |
|
---|
Gibt den Schwellwert zurück, wie von SetAltitudeCallbackThreshold()
gesetzt.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für option:
BrickletBarometer.
SetDebouncePeriod
(long debounce)¶Parameter: |
|
---|
Setzt die Periode mit welcher die Schwellwert Callbacks
ausgelöst werden, wenn die Schwellwerte
weiterhin erreicht bleiben.
BrickletBarometer.
GetDebouncePeriod
()¶Rückgabe: |
|
---|
Gibt die Entprellperiode zurück, wie von SetDebouncePeriod()
gesetzt.
Callbacks können registriert werden um zeitkritische oder wiederkehrende Daten vom Gerät zu erhalten. Die Registrierung geschieht durch Anhängen des Callback Handlers an den passenden Event:
void MyCallback(BrickletBarometer sender, int value)
{
System.Console.WriteLine("Value: " + value);
}
barometer.ExampleCallback += MyCallback;
Die verfügbaren Events werden weiter unten beschrieben.
Bemerkung
Callbacks 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.
BrickletBarometer.
AirPressureCallback
(BrickletBarometer sender, int airPressure)¶Callback-Parameter: |
|
---|
Dieser Callback wird mit der Periode, wie gesetzt mit
SetAirPressureCallbackPeriod()
, ausgelöst. Der Parameter ist
der Luftdruck des Luftdrucksensors.
Der AirPressureCallback
Callback wird nur ausgelöst, wenn sich der Luftdruck
seit der letzten Auslösung geändert hat.
BrickletBarometer.
AltitudeCallback
(BrickletBarometer sender, int altitude)¶Callback-Parameter: |
|
---|
Dieser Callback wird mit der Periode, wie gesetzt mit
SetAltitudeCallbackPeriod()
, ausgelöst. Der Parameter ist
die Höhe des Luftdrucksensors.
Der AltitudeCallback
Callback wird nur ausgelöst, wenn sich die Höhe seit der
letzten Auslösung geändert hat.
BrickletBarometer.
AirPressureReachedCallback
(BrickletBarometer sender, int airPressure)¶Callback-Parameter: |
|
---|
Dieser Callback 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 Callback mit der Periode, wie
mit SetDebouncePeriod()
gesetzt, ausgelöst.
BrickletBarometer.
AltitudeReachedCallback
(BrickletBarometer sender, int altitude)¶Callback-Parameter: |
|
---|
Dieser Callback 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 Callback mit der Periode, wie
mit SetDebouncePeriod()
gesetzt, ausgelöst.
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.
BrickletBarometer.
GetAPIVersion
()¶Ausgabeparameter: |
|
---|
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.
BrickletBarometer.
GetResponseExpected
(byte functionId)¶Parameter: |
|
---|---|
Rückgabe: |
|
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 Callbacks 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:
BrickletBarometer.
SetResponseExpected
(byte functionId, bool responseExpected)¶Parameter: |
|
---|
Ä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 Callbacks (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:
BrickletBarometer.
SetResponseExpectedAll
(bool responseExpected)¶Parameter: |
|
---|
Ändert das Response-Expected-Flag für alle Setter-Funktionen und Konfigurationsfunktionen für Callbacks diese Gerätes.
BrickletBarometer.
DEVICE_IDENTIFIER
¶Diese Konstante wird verwendet um ein Barometer Bricklet zu identifizieren.
Die GetIdentity()
Funktion und der
IPConnection.EnumerateCallback
Callback der IP Connection haben ein deviceIdentifier
Parameter um den Typ
des Bricks oder Bricklets anzugeben.
BrickletBarometer.
DEVICE_DISPLAY_NAME
¶Diese Konstante stellt den Anzeigenamen eines Barometer Bricklet dar.