Dies ist die Beschreibung der C# API Bindings für das Analog In Bricklet. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des Analog In 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 Analog In Bricklet
static void Main()
{
IPConnection ipcon = new IPConnection(); // Create IP connection
BrickletAnalogIn ai = new BrickletAnalogIn(UID, ipcon); // Create device object
ipcon.Connect(HOST, PORT); // Connect to brickd
// Don't use device before ipcon is connected
// Get current voltage
int voltage = ai.GetVoltage();
Console.WriteLine("Voltage: " + voltage/1000.0 + " V");
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 Analog In Bricklet
// Callback function for voltage callback
static void VoltageCB(BrickletAnalogIn sender, int voltage)
{
Console.WriteLine("Voltage: " + voltage/1000.0 + " V");
}
static void Main()
{
IPConnection ipcon = new IPConnection(); // Create IP connection
BrickletAnalogIn ai = new BrickletAnalogIn(UID, ipcon); // Create device object
ipcon.Connect(HOST, PORT); // Connect to brickd
// Don't use device before ipcon is connected
// Register voltage callback to function VoltageCB
ai.VoltageCallback += VoltageCB;
// Set period for voltage callback to 1s (1000ms)
// Note: The voltage callback is only called every second
// if the voltage has changed since the last call!
ai.SetVoltageCallbackPeriod(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 Analog In Bricklet
// Callback function for voltage reached callback
static void VoltageReachedCB(BrickletAnalogIn sender, int voltage)
{
Console.WriteLine("Voltage: " + voltage/1000.0 + " V");
}
static void Main()
{
IPConnection ipcon = new IPConnection(); // Create IP connection
BrickletAnalogIn ai = new BrickletAnalogIn(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)
ai.SetDebouncePeriod(10000);
// Register voltage reached callback to function VoltageReachedCB
ai.VoltageReachedCallback += VoltageReachedCB;
// Configure threshold for voltage "smaller than 5 V"
ai.SetVoltageCallbackThreshold('<', 5*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.
BrickletAnalogIn
(string uid, IPConnection ipcon)¶Parameter: |
|
---|---|
Rückgabe: |
|
Erzeugt ein Objekt mit der eindeutigen Geräte ID uid
:
BrickletAnalogIn analogIn = new BrickletAnalogIn("YOUR_DEVICE_UID", ipcon);
Dieses Objekt kann benutzt werden, nachdem die IP Connection verbunden ist.
BrickletAnalogIn.
GetVoltage
()¶Rückgabe: |
|
---|
Gibt die gemessene Spannung des Sensors zurück. Die Auflösung im Bereich 0 bis 6V beträgt rund 2mV. Zwischen 6 und 45V ist die Auflösung rund 10mV.
Wenn die Spannung periodisch abgefragt werden soll, wird empfohlen
den VoltageCallback
Callback zu nutzen und die Periode mit
SetVoltageCallbackPeriod()
vorzugeben.
BrickletAnalogIn.
SetRange
(byte range)¶Parameter: |
|
---|
Setzt den Messbereich. Mögliche Bereiche:
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für range:
Neu in Version 2.0.1 (Plugin).
BrickletAnalogIn.
GetRange
()¶Rückgabe: |
|
---|
Gibt den Messbereich zurück, wie von SetRange()
gesetzt.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für range:
Neu in Version 2.0.1 (Plugin).
BrickletAnalogIn.
GetAnalogValue
()¶Rückgabe: |
|
---|
Gibt den Wert, wie vom 12-Bit Analog-Digital-Wandler gelesen, zurück.
Bemerkung
Der von GetVoltage()
zurückgegebene Wert ist über mehrere
Messwerte gemittelt um das Rauschen zu vermindern, während GetAnalogValue()
unverarbeitete Analogwerte zurück gibt. Der einzige Grund GetAnalogValue()
zu nutzen, ist die volle Auflösung des Analog-Digital-Wandlers zu erhalten.
Wenn der Analogwert periodisch abgefragt werden soll, wird empfohlen
den AnalogValueCallback
Callback zu nutzen und die Periode mit
SetAnalogValueCallbackPeriod()
vorzugeben.
BrickletAnalogIn.
SetAveraging
(byte average)¶Parameter: |
|
---|
Setzt die Länge des Mittelwerts für die Spannung.
Wenn die Länge auf 0 gesetzt wird, ist das Averaging komplett aus. In diesem Fall gibt es mehr Rauschen auf den Daten, allerdings sind die Daten dann ohne Verzögerung.
Neu in Version 2.0.3 (Plugin).
BrickletAnalogIn.
GetAveraging
()¶Rückgabe: |
|
---|
Gibt die Averaging-Konfiguration zurück, wie von SetAveraging()
gesetzt.
Neu in Version 2.0.3 (Plugin).
BrickletAnalogIn.
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.
BrickletAnalogIn.
SetVoltageCallbackPeriod
(long period)¶Parameter: |
|
---|
Setzt die Periode mit welcher der VoltageCallback
Callback ausgelöst wird.
Ein Wert von 0 deaktiviert den Callback.
Der VoltageCallback
Callback wird nur ausgelöst, wenn sich die Spannung seit der
letzten Auslösung geändert hat.
BrickletAnalogIn.
GetVoltageCallbackPeriod
()¶Rückgabe: |
|
---|
Gibt die Periode zurück, wie von SetVoltageCallbackPeriod()
gesetzt.
BrickletAnalogIn.
SetAnalogValueCallbackPeriod
(long period)¶Parameter: |
|
---|
Setzt die Periode mit welcher der AnalogValueCallback
Callback ausgelöst
wird. Ein Wert von 0 deaktiviert den Callback.
Der AnalogValueCallback
Callback wird nur ausgelöst, wenn sich der Analogwert
seit der letzten Auslösung geändert hat.
BrickletAnalogIn.
GetAnalogValueCallbackPeriod
()¶Rückgabe: |
|
---|
Gibt die Periode zurück, wie von SetAnalogValueCallbackPeriod()
gesetzt.
BrickletAnalogIn.
SetVoltageCallbackThreshold
(char option, int min, int max)¶Parameter: |
|
---|
Setzt den Schwellwert für den VoltageReachedCallback
Callback.
Die folgenden Optionen sind möglich:
Option | Beschreibung |
---|---|
'x' | Callback ist inaktiv |
'o' | Callback wird ausgelöst, wenn die Spannung außerhalb des min und max Wertes ist |
'i' | Callback wird ausgelöst, wenn die Spannung innerhalb des min und max Wertes ist |
'<' | Callback wird ausgelöst, wenn die Spannung kleiner als der min Wert ist (max wird ignoriert) |
'>' | Callback wird ausgelöst, wenn die Spannung größer als der min Wert ist (max wird ignoriert) |
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für option:
BrickletAnalogIn.
GetVoltageCallbackThreshold
(out char option, out int min, out int max)¶Ausgabeparameter: |
|
---|
Gibt den Schwellwert zurück, wie von SetVoltageCallbackThreshold()
gesetzt.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für option:
BrickletAnalogIn.
SetAnalogValueCallbackThreshold
(char option, int min, int max)¶Parameter: |
|
---|
Setzt den Schwellwert für den AnalogValueReachedCallback
Callback.
Die folgenden Optionen sind möglich:
Option | Beschreibung |
---|---|
'x' | Callback ist inaktiv |
'o' | Callback wird ausgelöst, wenn der Analogwert außerhalb des min und max Wertes ist |
'i' | Callback wird ausgelöst, wenn der Analogwert innerhalb des min und max Wertes ist |
'<' | Callback wird ausgelöst, wenn der Analogwert kleiner als der min Wert ist (max wird ignoriert) |
'>' | Callback wird ausgelöst, wenn der Analogwert größer als der min Wert ist (max wird ignoriert) |
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für option:
BrickletAnalogIn.
GetAnalogValueCallbackThreshold
(out char option, out int min, out int max)¶Ausgabeparameter: |
|
---|
Gibt den Schwellwert zurück, wie von SetAnalogValueCallbackThreshold()
gesetzt.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für option:
BrickletAnalogIn.
SetDebouncePeriod
(long debounce)¶Parameter: |
|
---|
Setzt die Periode mit welcher die Schwellwert Callbacks
ausgelöst werden, wenn die Schwellwerte
weiterhin erreicht bleiben.
BrickletAnalogIn.
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(BrickletAnalogIn sender, int value)
{
System.Console.WriteLine("Value: " + value);
}
analogIn.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.
BrickletAnalogIn.
VoltageCallback
(BrickletAnalogIn sender, int voltage)¶Callback-Parameter: |
|
---|
Dieser Callback wird mit der Periode, wie gesetzt mit
SetVoltageCallbackPeriod()
, ausgelöst. Der Parameter ist die
gemessene Spannung des Sensors.
Der VoltageCallback
Callback wird nur ausgelöst, wenn sich die Spannung seit der
letzten Auslösung geändert hat.
BrickletAnalogIn.
AnalogValueCallback
(BrickletAnalogIn sender, int value)¶Callback-Parameter: |
|
---|
Dieser Callback wird mit der Periode, wie gesetzt mit
SetAnalogValueCallbackPeriod()
, ausgelöst. Der Parameter
ist der Analogwert des Sensors.
Der AnalogValueCallback
Callback wird nur ausgelöst, wenn sich der Analogwert
seit der letzten Auslösung geändert hat.
BrickletAnalogIn.
VoltageReachedCallback
(BrickletAnalogIn sender, int voltage)¶Callback-Parameter: |
|
---|
Dieser Callback wird ausgelöst, wenn der Schwellwert, wie von
SetVoltageCallbackThreshold()
gesetzt, erreicht wird.
Der Parameter ist die gemessene Spannung des Sensors.
Wenn der Schwellwert erreicht bleibt, wird der Callback mit der Periode, wie
mit SetDebouncePeriod()
gesetzt, ausgelöst.
BrickletAnalogIn.
AnalogValueReachedCallback
(BrickletAnalogIn sender, int value)¶Callback-Parameter: |
|
---|
Dieser Callback wird ausgelöst, wenn der Schwellwert, wie von
SetAnalogValueCallbackThreshold()
gesetzt, erreicht wird.
Der Parameter ist der Analogwert des Sensors.
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.
BrickletAnalogIn.
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.
BrickletAnalogIn.
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:
BrickletAnalogIn.
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:
BrickletAnalogIn.
SetResponseExpectedAll
(bool responseExpected)¶Parameter: |
|
---|
Ändert das Response-Expected-Flag für alle Setter-Funktionen und Konfigurationsfunktionen für Callbacks diese Gerätes.
BrickletAnalogIn.
DEVICE_IDENTIFIER
¶Diese Konstante wird verwendet um ein Analog In 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.
BrickletAnalogIn.
DEVICE_DISPLAY_NAME
¶Diese Konstante stellt den Anzeigenamen eines Analog In Bricklet dar.