Dies ist die Beschreibung der C# API Bindings für das IO-16 Bricklet. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des IO-16 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 | 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 IO-16 Bricklet
static void Main()
{
IPConnection ipcon = new IPConnection(); // Create IP connection
BrickletIO16 io = new BrickletIO16(UID, ipcon); // Create device object
ipcon.Connect(HOST, PORT); // Connect to brickd
// Don't use device before ipcon is connected
// Set pin 0 on port A to output low
io.SetPortConfiguration('a', 1 << 0, 'o', false);
// Set pin 0 and 7 on port B to output high
io.SetPortConfiguration('b', (1 << 0) | (1 << 7), 'o', true);
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 | 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 IO-16 Bricklet
static void Main()
{
IPConnection ipcon = new IPConnection(); // Create IP connection
BrickletIO16 io = new BrickletIO16(UID, ipcon); // Create device object
ipcon.Connect(HOST, PORT); // Connect to brickd
// Don't use device before ipcon is connected
// Get current value from port A as bitmask
byte valueMaskA = io.GetPort('a');
Console.WriteLine("Value Mask (Port A): " + Convert.ToString(valueMaskA, 2));
// Get current value from port B as bitmask
byte valueMaskB = io.GetPort('b');
Console.WriteLine("Value Mask (Port B): " + Convert.ToString(valueMaskB, 2));
Console.WriteLine("Press enter to exit");
Console.ReadLine();
ipcon.Disconnect();
}
}
|
Download (ExampleInterrupt.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 IO-16 Bricklet
// Callback function for interrupt callback
static void InterruptCB(BrickletIO16 sender, char port, byte interruptMask,
byte valueMask)
{
Console.WriteLine("Port: " + port);
Console.WriteLine("Interrupt Mask: " + Convert.ToString(interruptMask, 2));
Console.WriteLine("Value Mask: " + Convert.ToString(valueMask, 2));
Console.WriteLine("");
}
static void Main()
{
IPConnection ipcon = new IPConnection(); // Create IP connection
BrickletIO16 io = new BrickletIO16(UID, ipcon); // Create device object
ipcon.Connect(HOST, PORT); // Connect to brickd
// Don't use device before ipcon is connected
// Register interrupt callback to function InterruptCB
io.InterruptCallback += InterruptCB;
// Enable interrupt on pin 2 of port A
io.SetPortInterrupt('a', 1 << 2);
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.
BrickletIO16
(string uid, IPConnection ipcon)¶Parameter: |
|
---|---|
Rückgabe: |
|
Erzeugt ein Objekt mit der eindeutigen Geräte ID uid
:
BrickletIO16 io16 = new BrickletIO16("YOUR_DEVICE_UID", ipcon);
Dieses Objekt kann benutzt werden, nachdem die IP Connection verbunden ist.
BrickletIO16.
SetPort
(char port, byte valueMask)¶Parameter: |
|
---|
Setzt den Ausgangszustand (logisch 1 oder logisch 0) für einen Port ("a" oder "b") mittels einer Bitmaske (8Bit). Eine 1 in der Bitmaske bedeutet logisch 1 und eine 0 in der Bitmaske bedeutet logisch 0.
Beispiel: Der Wert 15 bzw. 0b00001111 setzt die Pins 0-3 auf logisch 1 und die Pins 4-7 auf logisch 0.
Alle laufenden Monoflop Timer für den angegebenen Port werden abgebrochen, wenn diese Funktion aufgerufen wird.
Bemerkung
Diese Funktion bewirkt keine Änderung an Pins die als Eingang konfiguriert sind.
Pull-Up Widerstände können mit SetPortConfiguration()
zugeschaltet werden.
BrickletIO16.
GetPort
(char port)¶Parameter: |
|
---|---|
Rückgabe: |
|
Gibt eine Bitmaske der aktuell gemessenen Zustände des gewählten Ports zurück. Diese Funktion gibt die Zustände aller Pins zurück, unabhängig ob diese als Ein- oder Ausgang konfiguriert sind.
BrickletIO16.
SetPortConfiguration
(char port, byte selectionMask, char direction, bool value)¶Parameter: |
|
---|
Konfiguriert den Zustand und die Richtung des angegebenen Ports. Mögliche Richtungen sind 'i' und 'o' für Ein- und Ausgang.
Wenn die Richtung als Ausgang konfiguriert ist, ist der Zustand entweder logisch 1 oder logisch 0 (gesetzt als true oder false).
Wenn die Richtung als Eingang konfiguriert ist, ist der Zustand entweder Pull-Up oder Standard (gesetzt als true oder false).
Beispiele:
Laufende Monoflop Timer für die ausgewählten Pins werden abgebrochen, wenn diese Funktion aufgerufen wird.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für direction:
BrickletIO16.
GetPortConfiguration
(char port, out byte directionMask, out byte valueMask)¶Parameter: |
|
---|---|
Ausgabeparameter: |
|
Gibt eine Bitmaske für die Richtung und eine Bitmaske für den Zustand der Pins des gewählten Ports zurück. Eine 1 in der Bitmaske für die Richtung bedeutet Eingang und eine 0 in der Bitmaske bedeutet Ausgang.
Beispiel: Ein Rückgabewert von (15, 51) bzw. (0b00001111, 0b00110011) für Richtung und Zustand bedeutet:
BrickletIO16.
GetEdgeCount
(byte pin, bool resetCounter)¶Parameter: |
|
---|---|
Rückgabe: |
|
Gibt den aktuellen Wert des Flankenzählers für den ausgewählten Pin von Port A
zurück. Die zu zählenden Flanken können mit SetEdgeCountConfig()
konfiguriert werden.
Wenn reset counter auf true gesetzt wird, wird der Zählerstand direkt nach dem auslesen auf 0 zurückgesetzt.
Neu in Version 2.0.3 (Plugin).
BrickletIO16.
SetPortMonoflop
(char port, byte selectionMask, byte valueMask, long time)¶Parameter: |
|
---|
Konfiguriert einen Monoflop für die Pins, wie mittels der 8 Bit langen Bitmaske des zweiten Parameters festgelegt. Die festgelegten Pins müssen als Ausgänge konfiguriert sein. Als Eingänge konfigurierte Pins werden ignoriert.
Der dritte Parameter ist eine Bitmaske mit den gewünschten Zuständen der festgelegten Ausgangspins. Eine 1 in der Bitmaske bedeutet logisch 1 und eine 0 in der Bitmaske bedeutet logisch 0.
Der vierte Parameter stellt die Zeit dar, welche die Pins den Zustand halten sollen.
Wenn diese Funktion mit den Parametern ('a', 9, 1, 1500) bzw. ('a', 0b00001001, 0b00000001, 1500) aufgerufen wird: Pin 0 wird auf logisch 1 und Pin 3 auf logisch 0 am Port 'a' gesetzt. Nach 1,5s wird Pin 0 wieder logisch 0 und Pin 3 logisch 1 gesetzt.
Ein Monoflop kann zur Ausfallsicherung verwendet werden. Beispiel: Angenommen ein RS485 Bus und ein IO-16 Bricklet ist an ein Slave Stapel verbunden. Jetzt kann diese Funktion sekündlich, mit einem Zeitparameter von 2 Sekunden, aufgerufen werden. Der Pin wird die gesamte Zeit im Zustand logisch 1 sein. Wenn jetzt die RS485 Verbindung getrennt wird, wird der Pin nach spätestens zwei Sekunden in den Zustand logisch 0 wechseln.
BrickletIO16.
GetPortMonoflop
(char port, byte pin, out byte value, out long time, out long timeRemaining)¶Parameter: |
|
---|---|
Ausgabeparameter: |
|
Gibt (für den angegebenen Pin) den aktuellen Zustand und die Zeit, wie von
SetPortMonoflop()
gesetzt, sowie die noch verbleibende Zeit bis zum
Zustandswechsel, zurück.
Wenn der Timer aktuell nicht läuft, ist die noch verbleibende Zeit 0.
BrickletIO16.
SetSelectedValues
(char port, byte selectionMask, byte valueMask)¶Parameter: |
|
---|
Setzt den Ausgangszustand (logisch 1 oder logisch 0) mittels einer Bitmaske, entsprechend der Selektionsmaske. Die Bitmaske hat eine Länge von 8 Bit und eine 1 in der Bitmaske bedeutet logisch 1 und eine 0 in der Bitmaske bedeutet logisch 0.
Beispiel: Die Parameter ('a', 192, 128) bzw. ('a', 0b11000000, 0b10000000) setzen den Pin 7 auf logisch 1 und den Pin 6 auf logisch 0 an Port A. Die Pins 0-6 bleiben unangetastet.
Laufende Monoflop Timer für die ausgewählten Pins werden abgebrochen, wenn diese Funktion aufgerufen wird.
Bemerkung
Diese Funktion bewirkt keine Änderung an Pins die als Eingang konfiguriert sind.
Pull-Up Widerstände können mit SetPortConfiguration()
zugeschaltet werden.
BrickletIO16.
SetEdgeCountConfig
(byte pin, byte edgeType, byte debounce)¶Parameter: |
|
---|
Konfiguriert den Flankenzähler für den ausgewählten Pin von Port A. Der Flankenzähler steht für Pins 0 und 1 zur Verfügung.
Der edge type Parameter konfiguriert den zu zählenden Flankentyp. Es können steigende, fallende oder beide Flanken gezählt werden für Pins die als Eingang konfiguriert sind. Mögliche Flankentypen sind:
Durch das Konfigurieren wird der Wert des Flankenzählers auf 0 zurückgesetzt.
Falls unklar ist was dies alles bedeutet, kann diese Funktion einfach ignoriert werden. Die Standardwerte sind in fast allen Situationen OK.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für edgeType:
Neu in Version 2.0.3 (Plugin).
BrickletIO16.
GetEdgeCountConfig
(byte pin, out byte edgeType, out byte debounce)¶Parameter: |
|
---|---|
Ausgabeparameter: |
|
Gibt den Flankentyp sowie die Entprellzeit für den ausgewählten Pin von Port A
zurück, wie von SetEdgeCountConfig()
gesetzt.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für edgeType:
Neu in Version 2.0.3 (Plugin).
BrickletIO16.
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.
BrickletIO16.
SetDebouncePeriod
(long debounce)¶Parameter: |
|
---|
Setzt die Entprellperiode der InterruptCallback
Callback.
Beispiel: Wenn dieser Wert auf 100 gesetzt wird, erhält man den Interrupt maximal alle 100ms. Dies ist notwendig falls etwas prellendes an das IO-16 Bricklet angeschlossen ist, wie z.B. eine Taste.
BrickletIO16.
GetDebouncePeriod
()¶Rückgabe: |
|
---|
Gibt die Entprellperiode zurück, wie von SetDebouncePeriod()
gesetzt.
BrickletIO16.
SetPortInterrupt
(char port, byte interruptMask)¶Parameter: |
|
---|
Setzt durch eine Bitmaske die Pins für welche der Interrupt aktiv ist. Interrupts werden ausgelöst bei Änderung des Spannungspegels eines Pins, z.B. ein Wechsel von logisch 1 zu logisch 0 und logisch 0 zu logisch 1.
Beispiel: ('a', 129) bzw. ('a', 0b10000001) aktiviert den Interrupt für die Pins 0 und 7 des Ports a.
Der Interrupt wird mit dem InterruptCallback
Callback zugestellt.
BrickletIO16.
GetPortInterrupt
(char port)¶Parameter: |
|
---|---|
Rückgabe: |
|
Gibt die Interrupt Bitmaske für den angegebenen Port zurück, wie von
SetPortInterrupt()
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(BrickletIO16 sender, int value)
{
System.Console.WriteLine("Value: " + value);
}
io16.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.
BrickletIO16.
InterruptCallback
(BrickletIO16 sender, char port, byte interruptMask, byte valueMask)¶Callback-Parameter: |
|
---|
Dieser Callback wird ausgelöst sobald eine Änderung des Spannungspegels
detektiert wird, an Pins für welche der Interrupt mit SetPortInterrupt()
aktiviert wurde.
Die Rückgabewerte sind der Port, eine Bitmaske der aufgetretenen Interrupts und der aktuellen Zustände des Ports.
Beispiele:
BrickletIO16.
MonoflopDoneCallback
(BrickletIO16 sender, char port, byte selectionMask, byte valueMask)¶Callback-Parameter: |
|
---|
Dieser Callback wird ausgelöst, wenn ein Monoflop Timer abläuft (0 erreicht). Parameter enthalten den Port, die beteiligten Pins als Bitmaske und den aktuellen Zustand als Bitmaske (der Zustand nach dem Monoflop).
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.
BrickletIO16.
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.
BrickletIO16.
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:
BrickletIO16.
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:
BrickletIO16.
SetResponseExpectedAll
(bool responseExpected)¶Parameter: |
|
---|
Ändert das Response-Expected-Flag für alle Setter-Funktionen und Konfigurationsfunktionen für Callbacks diese Gerätes.
BrickletIO16.
DEVICE_IDENTIFIER
¶Diese Konstante wird verwendet um ein IO-16 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.
BrickletIO16.
DEVICE_DISPLAY_NAME
¶Diese Konstante stellt den Anzeigenamen eines IO-16 Bricklet dar.