Visual Basic .NET - IO-4 Bricklet

Dies ist die Beschreibung der Visual Basic .NET API Bindings für das IO-4 Bricklet. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des IO-4 Bricklet sind in dessen Hardware Beschreibung zusammengefasst.

Eine Installationanleitung für die Visual Basic .NET API Bindings ist Teil deren allgemeine Beschreibung.

Beispiele

Der folgende Beispielcode ist Public Domain (CC0 1.0).

Input

Download (ExampleInput.vb)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
Imports System
Imports Tinkerforge

Module ExampleInput
    Const HOST As String = "localhost"
    Const PORT As Integer = 4223
    Const UID As String = "XYZ" ' Change XYZ to the UID of your IO-4 Bricklet

    Sub Main()
        Dim ipcon As New IPConnection() ' Create IP connection
        Dim io As New BrickletIO4(UID, ipcon) ' Create device object

        ipcon.Connect(HOST, PORT) ' Connect to brickd
        ' Don't use device before ipcon is connected

        ' Get current value as bitmask
        Dim valueMask As Byte = io.GetValue()
        Console.WriteLine("Value Mask: " + Convert.ToString(valueMask, 2))

        Console.WriteLine("Press key to exit")
        Console.ReadLine()
        ipcon.Disconnect()
    End Sub
End Module

Output

Download (ExampleOutput.vb)

 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
Imports System
Imports Tinkerforge

Module ExampleOutput
    Const HOST As String = "localhost"
    Const PORT As Integer = 4223
    Const UID As String = "XYZ" ' Change XYZ to the UID of your IO-4 Bricklet

    Sub Main()
        Dim ipcon As New IPConnection() ' Create IP connection
        Dim io As New BrickletIO4(UID, ipcon) ' Create device object

        ipcon.Connect(HOST, PORT) ' Connect to brickd
        ' Don't use device before ipcon is connected

        ' Set pin 1 to output low
        io.SetConfiguration(1 << 1, "o"C, False)

        ' Set pin 2 and 3 to output high
        io.SetConfiguration((1 << 2) or (1 << 3), "o"C, True)

        Console.WriteLine("Press key to exit")
        Console.ReadLine()
        ipcon.Disconnect()
    End Sub
End Module

Interrupt

Download (ExampleInterrupt.vb)

 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
Imports System
Imports Tinkerforge

Module ExampleInterrupt
    Const HOST As String = "localhost"
    Const PORT As Integer = 4223
    Const UID As String = "XYZ" ' Change XYZ to the UID of your IO-4 Bricklet

    ' Callback subroutine for interrupt callback
    Sub InterruptCB(ByVal sender As BrickletIO4, ByVal interruptMask As Byte, _
                    ByVal valueMask As Byte)
        Console.WriteLine("Interrupt Mask: " + Convert.ToString(interruptMask, 2))
        Console.WriteLine("Value Mask: " + Convert.ToString(valueMask, 2))
        Console.WriteLine("")
    End Sub

    Sub Main()
        Dim ipcon As New IPConnection() ' Create IP connection
        Dim io As New BrickletIO4(UID, ipcon) ' Create device object

        ipcon.Connect(HOST, PORT) ' Connect to brickd
        ' Don't use device before ipcon is connected

        ' Register interrupt callback to subroutine InterruptCB
        AddHandler io.InterruptCallback, AddressOf InterruptCB

        ' Enable interrupt on pin 0
        io.SetInterrupt(1 << 0)

        Console.WriteLine("Press key to exit")
        Console.ReadLine()
        ipcon.Disconnect()
    End Sub
End Module

API

Da Visual Basic .NET nicht mehrere Rückgabewerte direkt unterstützt, wird das ByRef Schlüsselwort genutzt um mehrere Werte von einer Funktion zurückzugeben.

Alle folgend aufgelisteten Funktionen und Prozeduren sind Thread-sicher.

Grundfunktionen

Class BrickletIO4(ByVal uid As String, ByVal ipcon As IPConnection)

Erzeugt ein Objekt mit der eindeutigen Geräte ID uid:

Dim io4 As New BrickletIO4("YOUR_DEVICE_UID", ipcon)

Dieses Objekt kann benutzt werden, nachdem die IP Connection verbunden ist (siehe Beispiele oben).

Sub BrickletIO4.SetValue(ByVal valueMask As Byte)

Setzt den Ausgangszustand (logisch 1 oder logisch 0) mittels einer Bitmaske (4Bit). Eine 1 in der Bitmaske bedeutet logisch 1 und eine 0 in der Bitmaske bedeutet logisch 0.

Beispiel: Der Wert 3 bzw. 0b0011 setzt die Pins 0-1 auf logisch 1 und die Pins 2-3 auf logisch 0.

Alle laufenden Monoflop Timer 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 SetConfiguration() zugeschaltet werden.

Function BrickletIO4.GetValue() As Byte

Gibt eine Bitmaske der aktuell gemessenen Zustände zurück. Diese Funktion gibt die Zustände aller Pins zurück, unabhängig ob diese als Ein- oder Ausgang konfiguriert sind.

Sub BrickletIO4.SetConfiguration(ByVal selectionMask As Byte, ByVal direction As Char, ByVal value As Boolean)

Konfiguriert den Zustand und die Richtung eines angegebenen Pins. 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:

  • (15, 'i', true) bzw. (0b1111, 'i', true) setzt alle Pins als Eingang mit Pull-Up.
  • (8, 'i', false) bzw. (0b1000, 'i', false) setzt Pin 3 als Standard Eingang (potentialfrei wenn nicht verbunden).
  • (3, 'o', false) bzw. (0b0011, 'o', false) setzt die Pins 0 und 1 als Ausgang im Zustand logisch 0.
  • (4, 'o', true) bzw. (0b0100, 'o', true) setzt Pin 2 als Ausgang im Zustand logisch 1.

Laufende Monoflop Timer für die angegebenen Pins werden abgebrochen, wenn diese Funktion aufgerufen wird.

Die Standardkonfiguration ist Eingang mit Pull-Up.

Die folgenden Konstanten sind für diese Funktion verfügbar:

  • BrickletIO4.DIRECTION_IN = "i"C
  • BrickletIO4.DIRECTION_OUT = "o"C
Sub BrickletIO4.GetConfiguration(ByRef directionMask As Byte, ByRef valueMask As Byte)

Gibt eine Bitmaske für die Richtung und eine Bitmaske für den Zustand der Pins 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 (3, 5) bzw. (0b0011, 0b0101) für Richtung und Zustand bedeutet:

  • Pin 0 ist als Eingang mit Pull-Up konfiguriert,
  • Pin 1 ist als Standard Eingang konfiguriert,
  • Pin 2 ist als Ausgang im Zustand logisch 1 konfiguriert und
  • Pin 3 ist als Ausgang im Zustand logisch 0 konfiguriert.
Function BrickletIO4.GetEdgeCount(ByVal pin As Byte, ByVal resetCounter As Boolean) As Long

Gibt den aktuellen Wert des Flankenzählers für den ausgewählten Pin 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.1 (Plugin).

Fortgeschrittene Funktionen

Sub BrickletIO4.SetMonoflop(ByVal selectionMask As Byte, ByVal valueMask As Byte, ByVal time As Long)

Konfiguriert einen Monoflop für die Pins, wie mittels der 4 Bit langen Bitmaske des ersten Parameters festgelegt. Die festgelegten Pins müssen als Ausgänge konfiguriert sein. Als Eingänge konfigurierte Pins werden ignoriert.

Der zweite Parameter ist eine Bitmaske mit den gewünschten Zustanden der festgelegten Ausgangspins. Eine 1 in der Bitmaske bedeutet logisch 1 und eine 0 in der Bitmaske bedeutet logisch 0.

Der dritte Parameter stellt die Zeit (in ms) dar, welche die Pins den Zustand halten sollen.

Wenn diese Funktion mit den Parametern (9, 1, 1500) bzw. (0b1001, 0b0001, 1500) aufgerufen wird: Pin 0 wird auf logisch 1 und Pin 3 auf logisch 0 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-4 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.

Sub BrickletIO4.GetMonoflop(ByVal pin As Byte, ByRef value As Byte, ByRef time As Long, ByRef timeRemaining As Long)

Gibt (für den angegebenen Pin) den aktuellen Zustand und die Zeit, wie von SetMonoflop() gesetzt, sowie die noch verbleibende Zeit bis zum Zustandswechsel, zurück.

Wenn der Timer aktuell nicht läuft, ist die noch verbleibende Zeit 0.

Sub BrickletIO4.SetSelectedValues(ByVal selectionMask As Byte, ByVal valueMask As Byte)

Setzt den Ausgangszustand (logisch 1 oder logisch 0) mittels einer Bitmaske, entsprechend der Selektionsmaske. Die Bitmaske hat eine Länge von 4 Bit, true bedeutet logisch 1 und false logisch 0.

Beispiel: Die Parameter (9, 4) bzw (0b0110, 0b0100) setzen den Pin 1 auf logisch 0 und den Pin 2 auf logisch 1. Die Pins 0 und 3 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 SetConfiguration() zugeschaltet werden.

Sub BrickletIO4.SetEdgeCountConfig(ByVal selectionMask As Byte, ByVal edgeType As Byte, ByVal debounce As Byte)

Konfiguriert den Flankenzähler für die ausgewählten Pins.

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:

  • 0 = steigend (Standard)
  • 1 = fallend
  • 2 = beide

Die Entprellzeit (debounce) wird in ms angegeben.

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.

Standardwerte: 0 (edge type) und 100ms (debounce).

Die folgenden Konstanten sind für diese Funktion verfügbar:

  • BrickletIO4.EDGE_TYPE_RISING = 0
  • BrickletIO4.EDGE_TYPE_FALLING = 1
  • BrickletIO4.EDGE_TYPE_BOTH = 2

Neu in Version 2.0.1 (Plugin).

Sub BrickletIO4.GetEdgeCountConfig(ByVal pin As Byte, ByRef edgeType As Byte, ByRef debounce As Byte)

Gibt den Flankentyp sowie die Entprellzeit für den ausgewählten Pin zurück, wie von SetEdgeCountConfig() gesetzt.

Die folgenden Konstanten sind für diese Funktion verfügbar:

  • BrickletIO4.EDGE_TYPE_RISING = 0
  • BrickletIO4.EDGE_TYPE_FALLING = 1
  • BrickletIO4.EDGE_TYPE_BOTH = 2

Neu in Version 2.0.1 (Plugin).

Function BrickletIO4.GetAPIVersion() As Byte()

Gibt die Version der API Definition (Major, Minor, Revision) 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.

Function BrickletIO4.GetResponseExpected(ByVal functionId As Byte) As Boolean

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.

Siehe SetResponseExpected() für die Liste der verfügbaren Funktions ID Konstanten für diese Funktion.

Sub BrickletIO4.SetResponseExpected(ByVal functionId As Byte, ByVal responseExpected As Boolean)

Ä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 Funktions ID Konstanten sind für diese Funktion verfügbar:

  • BrickletIO4.FUNCTION_SET_VALUE = 1
  • BrickletIO4.FUNCTION_SET_CONFIGURATION = 3
  • BrickletIO4.FUNCTION_SET_DEBOUNCE_PERIOD = 5
  • BrickletIO4.FUNCTION_SET_INTERRUPT = 7
  • BrickletIO4.FUNCTION_SET_MONOFLOP = 10
  • BrickletIO4.FUNCTION_SET_SELECTED_VALUES = 13
  • BrickletIO4.FUNCTION_SET_EDGE_COUNT_CONFIG = 15
Sub BrickletIO4.SetResponseExpectedAll(ByVal responseExpected As Boolean)

Ändert das Response-Expected-Flag für alle Setter-Funktionen und Konfigurationsfunktionen für Callbacks diese Gerätes.

Sub BrickletIO4.GetIdentity(ByRef uid As String, ByRef connectedUid As String, ByRef position As Char, ByRef hardwareVersion() As Byte, ByRef firmwareVersion() As Byte, ByRef deviceIdentifier As Integer)

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 kann 'a', 'b', 'c' oder 'd' sein.

Eine Liste der Device Identifier Werte ist hier zu finden. Es gibt auch eine Konstante für den Device Identifier dieses Bricklets.

Konfigurationsfunktionen für Callbacks

Sub BrickletIO4.SetDebouncePeriod(ByVal debounce As Long)

Setzt die Entprellperiode der InterruptCallback Callback in ms.

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-4 Bricklet angeschlossen ist, wie z.B. eine Taste.

Der Standardwert ist 100.

Function BrickletIO4.GetDebouncePeriod() As Long

Gibt die Entprellperiode zurück, wie von SetDebouncePeriod() gesetzt.

Sub BrickletIO4.SetInterrupt(ByVal interruptMask As Byte)

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: Eine Interrupt Bitmaske von 10 bzw. 0b1010 aktiviert den Interrupt für die Pins 1 und 3.

Der Interrupt wird mit dem InterruptCallback Callback zugestellt.

Function BrickletIO4.GetInterrupt() As Byte

Gibt die Interrupt Bitmaske zurück, wie von SetInterrupt() gesetzt.

Callbacks

Callbacks können registriert werden um zeitkritische oder wiederkehrende Daten vom Gerät zu erhalten. Die Registrierung erfolgt indem eine Prozedur einem Callback Property des Geräte Objektes zugewiesen wird:

Sub MyCallback(ByVal sender As BrickletIO4, ByVal value As Short)
    Console.WriteLine("Value: {0}", value)
End Sub

AddHandler io4.ExampleCallback, AddressOf MyCallback

Die verfügbaren Callback Properties und ihre Parametertypen 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.

Event BrickletIO4.InterruptCallback(ByVal sender As BrickletIO4, ByVal interruptMask As Byte, ByVal valueMask As Byte)

Dieser Callback wird ausgelöst sobald eine Änderung des Spannungspegels detektiert wird, an Pins für welche der Interrupt mit SetInterrupt() aktiviert wurde.

Die Rückgabewerte sind eine Bitmaske der aufgetretenen Interrupts und der aktuellen Zustände.

Beispiele:

  • (1, 1) bzw. (0b0001, 0b0001) bedeutet, dass ein Interrupt am Pin 0 aufgetreten ist und aktuell Pin 0 logisch 1 ist und die Pins 1-3 logisch 0 sind.
  • (9, 14) bzw. (0b1001, 0b1110) bedeutet, dass Interrupts an den Pins 0 und 3 aufgetreten sind und aktuell Pin 0 logisch 0 ist und die Pins 1-3 logisch 1 sind.
Event BrickletIO4.MonoflopDoneCallback(ByVal sender As BrickletIO4, ByVal selectionMask As Byte, ByVal valueMask As Byte)

Dieser Callback wird ausgelöst, wenn ein Monoflop Timer abläuft (0 erreicht). Parameter enthalten die beteiligten Pins als Bitmaske und den aktuellen Zustand als Bitmaske (der Zustand nach dem Monoflop).

Konstanten

Const BrickletIO4.DEVICE_IDENTIFIER

Diese Konstante wird verwendet um ein IO-4 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.

Const BrickletIO4.DEVICE_DISPLAY_NAME

Diese Konstante stellt den Anzeigenamen eines IO-4 Bricklet dar.