Dies ist die Beschreibung der C# API Bindings für das PTC Bricklet. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des PTC 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 | 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 PTC Bricklet
static void Main()
{
IPConnection ipcon = new IPConnection(); // Create IP connection
BrickletPTC ptc = new BrickletPTC(UID, ipcon); // Create device object
ipcon.Connect(HOST, PORT); // Connect to brickd
// Don't use device before ipcon is connected
// Get current temperature
int temperature = ptc.GetTemperature();
Console.WriteLine("Temperature: " + temperature/100.0 + " °C");
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 PTC Bricklet
// Callback function for temperature callback
static void TemperatureCB(BrickletPTC sender, int temperature)
{
Console.WriteLine("Temperature: " + temperature/100.0 + " °C");
}
static void Main()
{
IPConnection ipcon = new IPConnection(); // Create IP connection
BrickletPTC ptc = new BrickletPTC(UID, ipcon); // Create device object
ipcon.Connect(HOST, PORT); // Connect to brickd
// Don't use device before ipcon is connected
// Register temperature callback to function TemperatureCB
ptc.TemperatureCallback += TemperatureCB;
// Set period for temperature callback to 1s (1000ms)
// Note: The temperature callback is only called every second
// if the temperature has changed since the last call!
ptc.SetTemperatureCallbackPeriod(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 | 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 PTC Bricklet
// Callback function for temperature reached callback
static void TemperatureReachedCB(BrickletPTC sender, int temperature)
{
Console.WriteLine("Temperature: " + temperature/100.0 + " °C");
}
static void Main()
{
IPConnection ipcon = new IPConnection(); // Create IP connection
BrickletPTC ptc = new BrickletPTC(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)
ptc.SetDebouncePeriod(10000);
// Register temperature reached callback to function TemperatureReachedCB
ptc.TemperatureReachedCallback += TemperatureReachedCB;
// Configure threshold for temperature "greater than 30 °C"
ptc.SetTemperatureCallbackThreshold('>', 30*100, 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.
BrickletPTC
(string uid, IPConnection ipcon)¶Parameter: |
|
---|---|
Rückgabe: |
|
Erzeugt ein Objekt mit der eindeutigen Geräte ID uid
:
BrickletPTC ptc = new BrickletPTC("YOUR_DEVICE_UID", ipcon);
Dieses Objekt kann benutzt werden, nachdem die IP Connection verbunden ist.
BrickletPTC.
GetTemperature
()¶Rückgabe: |
|
---|
Gibt die Temperatur des verbundenen Sensors zurück.
Wenn die Temperatur periodisch abgefragt werden soll, wird empfohlen
den TemperatureCallback
Callback zu nutzen und die Periode mit
SetTemperatureCallbackPeriod()
vorzugeben.
BrickletPTC.
IsSensorConnected
()¶Rückgabe: |
|
---|
Gibt true zurück wenn ein Sensor korrekt verbunden ist.
Falls diese Funktion false zurück gibt, ist entweder kein Pt100 oder Pt1000 Sensor verbunden, der Sensor ist inkorrekt verbunden oder der Sensor selbst ist fehlerhaft.
BrickletPTC.
SetWireMode
(byte mode)¶Parameter: |
|
---|
Stellt die Leiter-Konfiguration des Sensors ein. Mögliche Werte sind 2, 3 und 4, dies entspricht 2-, 3- und 4-Leiter-Sensoren. Der Wert muss er Jumper-Konfiguration am Bricklet entsprechen.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für mode:
BrickletPTC.
GetWireMode
()¶Rückgabe: |
|
---|
Gibt die Leiter-Konfiguration zurück, wie von SetWireMode()
gesetzt.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für mode:
BrickletPTC.
GetResistance
()¶Rückgabe: |
|
---|
Gibt den Wert zurück, wie vom "MAX31865 Präzisions Delta-Sigma ADC" berechnet.
Der Wert kann mit den folgenden Formeln in einen Widerstand konvertiert werden:
Wenn der Widerstand periodisch abgefragt werden soll, wird empfohlen
den ResistanceCallback
Callback zu nutzen und die Periode mit
SetResistanceCallbackPeriod()
vorzugeben.
BrickletPTC.
SetNoiseRejectionFilter
(byte filter)¶Parameter: |
|
---|
Setzt den Entstörfilter auf 50Hz (0) oder 60Hz (1). Störungen von 50Hz oder 60Hz Stromquellen (inklusive Oberwellen der Stromquellen-Grundfrequenz) werden um 82dB abgeschwächt.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für filter:
BrickletPTC.
GetNoiseRejectionFilter
()¶Rückgabe: |
|
---|
Gibt die Einstellung des Entstörfilters zurück, wie von
SetNoiseRejectionFilter()
gesetzt.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für filter:
BrickletPTC.
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.
BrickletPTC.
SetTemperatureCallbackPeriod
(long period)¶Parameter: |
|
---|
Setzt die Periode mit welcher der TemperatureCallback
Callback ausgelöst
wird. Ein Wert von 0 deaktiviert den Callback.
Der TemperatureCallback
Callback wird nur ausgelöst, wenn sich die Temperatur seit
der letzten Auslösung geändert hat.
BrickletPTC.
GetTemperatureCallbackPeriod
()¶Rückgabe: |
|
---|
Gibt die Periode zurück, wie von SetTemperatureCallbackPeriod()
gesetzt.
BrickletPTC.
SetResistanceCallbackPeriod
(long period)¶Parameter: |
|
---|
Setzt die Periode mit welcher der ResistanceCallback
Callback ausgelöst
wird. Ein Wert von 0 deaktiviert den Callback.
Der ResistanceCallback
Callback wird nur ausgelöst, wenn sich der Widerstand seit
der letzten Auslösung geändert hat.
BrickletPTC.
GetResistanceCallbackPeriod
()¶Rückgabe: |
|
---|
Gibt die Periode zurück, wie von SetResistanceCallbackPeriod()
gesetzt.
BrickletPTC.
SetTemperatureCallbackThreshold
(char option, int min, int max)¶Parameter: |
|
---|
Setzt den Schwellwert für den TemperatureReachedCallback
Callback.
Die folgenden Optionen sind möglich:
Option | Beschreibung |
---|---|
'x' | Callback ist inaktiv |
'o' | Callback wird ausgelöst, wenn die Temperatur außerhalb des min und max Wertes ist |
'i' | Callback wird ausgelöst, wenn die Temperatur innerhalb des min und max Wertes ist |
'<' | Callback wird ausgelöst, wenn die Temperatur kleiner als der min Wert ist (max wird ignoriert) |
'>' | Callback wird ausgelöst, wenn die Temperatur größer als der min Wert ist (max wird ignoriert) |
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für option:
BrickletPTC.
GetTemperatureCallbackThreshold
(out char option, out int min, out int max)¶Ausgabeparameter: |
|
---|
Gibt den Schwellwert zurück, wie von SetTemperatureCallbackThreshold()
gesetzt.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für option:
BrickletPTC.
SetResistanceCallbackThreshold
(char option, int min, int max)¶Parameter: |
|
---|
Setzt den Schwellwert für den ResistanceReachedCallback
Callback.
Die folgenden Optionen sind möglich:
Option | Beschreibung |
---|---|
'x' | Callback ist inaktiv |
'o' | Callback wird ausgelöst, wenn die Temperatur außerhalb des min und max Wertes ist |
'i' | Callback wird ausgelöst, wenn die Temperatur innerhalb des min und max Wertes ist |
'<' | Callback wird ausgelöst, wenn die Temperatur kleiner als der min Wert ist (max wird ignoriert) |
'>' | Callback wird ausgelöst, wenn die Temperatur größer als der min Wert ist (max wird ignoriert) |
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für option:
BrickletPTC.
GetResistanceCallbackThreshold
(out char option, out int min, out int max)¶Ausgabeparameter: |
|
---|
Gibt den Schwellwert zurück, wie von SetResistanceCallbackThreshold()
gesetzt.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für option:
BrickletPTC.
SetDebouncePeriod
(long debounce)¶Parameter: |
|
---|
Setzt die Periode mit welcher die Schwellwert Callback
ausgelöst wird, wenn der Schwellwert
weiterhin erreicht bleibt.
BrickletPTC.
GetDebouncePeriod
()¶Rückgabe: |
|
---|
Gibt die Entprellperiode zurück, wie von SetDebouncePeriod()
gesetzt.
BrickletPTC.
SetSensorConnectedCallbackConfiguration
(bool enabled)¶Parameter: |
|
---|
Wenn dieser Callback aktiviert ist, wird der SensorConnectedCallback
Callback
jedes mal ausgelöst, wenn ein Pt-Sensor verbunden/getrennt wird.
Neu in Version 2.0.2 (Plugin).
BrickletPTC.
GetSensorConnectedCallbackConfiguration
()¶Rückgabe: |
|
---|
Gibt die Konfiguration zurück, wie von SetSensorConnectedCallbackConfiguration()
gesetzt.
Neu in Version 2.0.2 (Plugin).
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(BrickletPTC sender, int value)
{
System.Console.WriteLine("Value: " + value);
}
ptc.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.
BrickletPTC.
TemperatureCallback
(BrickletPTC sender, int temperature)¶Callback-Parameter: |
|
---|
Dieser Callback wird mit der Periode, wie gesetzt mit SetTemperatureCallbackPeriod()
,
ausgelöst. Der Parameter ist die Temperatur des verbundenen Sensors.
Der TemperatureCallback
Callback wird nur ausgelöst, wenn sich die Temperatur
seit der letzten Auslösung geändert hat.
BrickletPTC.
TemperatureReachedCallback
(BrickletPTC sender, int temperature)¶Callback-Parameter: |
|
---|
Dieser Callback wird ausgelöst, wenn der Schwellwert, wie von
SetTemperatureCallbackThreshold()
gesetzt, erreicht wird.
Der Parameter ist die Temperatur des verbundenen Sensors.
Wenn der Schwellwert erreicht bleibt, wird der Callback mit der Periode, wie
mit SetDebouncePeriod()
gesetzt, ausgelöst.
BrickletPTC.
ResistanceCallback
(BrickletPTC sender, int resistance)¶Callback-Parameter: |
|
---|
Dieser Callback wird mit der Periode, wie gesetzt mit SetResistanceCallbackPeriod()
,
ausgelöst. Der Parameter ist der Widerstand des verbundenen Sensors.
Der ResistanceCallback
Callback wird nur ausgelöst, wenn sich der Widerstand seit
der letzten Auslösung geändert hat.
BrickletPTC.
ResistanceReachedCallback
(BrickletPTC sender, int resistance)¶Callback-Parameter: |
|
---|
Dieser Callback wird ausgelöst, wenn der Schwellwert, wie von
SetResistanceCallbackThreshold()
gesetzt, erreicht wird.
Der Parameter ist der Widerstand des verbundenen Sensors.
Wenn der Schwellwert erreicht bleibt, wird der Callback mit der Periode, wie
mit SetDebouncePeriod()
gesetzt, ausgelöst.
BrickletPTC.
SensorConnectedCallback
(BrickletPTC sender, bool connected)¶Callback-Parameter: |
|
---|
Dieser Callback wird periodisch ausgelöst abhängig von der mittels
SetSensorConnectedCallbackConfiguration()
gesetzten Konfiguration
Der Parameter ist der gleiche wie bei IsSensorConnected()
.
Neu in Version 2.0.2 (Plugin).
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.
BrickletPTC.
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.
BrickletPTC.
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:
BrickletPTC.
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:
BrickletPTC.
SetResponseExpectedAll
(bool responseExpected)¶Parameter: |
|
---|
Ändert das Response-Expected-Flag für alle Setter-Funktionen und Konfigurationsfunktionen für Callbacks diese Gerätes.
BrickletPTC.
DEVICE_IDENTIFIER
¶Diese Konstante wird verwendet um ein PTC 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.
BrickletPTC.
DEVICE_DISPLAY_NAME
¶Diese Konstante stellt den Anzeigenamen eines PTC Bricklet dar.