Dies ist die Beschreibung der Visual Basic .NET API Bindings für das Rotary Encoder Bricklet. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des Rotary Encoder Bricklet sind in dessen Hardware Beschreibung zusammengefasst.
Eine Installationanleitung für die Visual Basic .NET 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 | Imports System
Imports Tinkerforge
Module ExampleSimple
Const HOST As String = "localhost"
Const PORT As Integer = 4223
Const UID As String = "XYZ" ' Change XYZ to the UID of your Rotary Encoder Bricklet
Sub Main()
Dim ipcon As New IPConnection() ' Create IP connection
Dim re As New BrickletRotaryEncoder(UID, ipcon) ' Create device object
ipcon.Connect(HOST, PORT) ' Connect to brickd
' Don't use device before ipcon is connected
' Get current count without reset
Dim count As Integer = re.GetCount(False)
Console.WriteLine("Count: " + count.ToString())
Console.WriteLine("Press key to exit")
Console.ReadLine()
ipcon.Disconnect()
End Sub
End Module
|
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 | Imports System
Imports Tinkerforge
Module ExampleCallback
Const HOST As String = "localhost"
Const PORT As Integer = 4223
Const UID As String = "XYZ" ' Change XYZ to the UID of your Rotary Encoder Bricklet
' Callback subroutine for count callback
Sub CountCB(ByVal sender As BrickletRotaryEncoder, ByVal count As Integer)
Console.WriteLine("Count: " + count.ToString())
End Sub
Sub Main()
Dim ipcon As New IPConnection() ' Create IP connection
Dim re As New BrickletRotaryEncoder(UID, ipcon) ' Create device object
ipcon.Connect(HOST, PORT) ' Connect to brickd
' Don't use device before ipcon is connected
' Register count callback to subroutine CountCB
AddHandler re.CountCallback, AddressOf CountCB
' Set period for count callback to 0.05s (50ms)
' Note: The count callback is only called every 0.05 seconds
' if the count has changed since the last call!
re.SetCountCallbackPeriod(50)
Console.WriteLine("Press key to exit")
Console.ReadLine()
ipcon.Disconnect()
End Sub
End Module
|
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.
Erzeugt ein Objekt mit der eindeutigen Geräte ID uid:
Dim rotaryEncoder As New BrickletRotaryEncoder("YOUR_DEVICE_UID", ipcon)
Dieses Objekt kann benutzt werden, nachdem die IP Connection verbunden ist (siehe Beispiele oben).
Parameter: |
|
---|---|
Rückgabe: |
|
Gibt den aktuellen Zählerwert des Encoders zurück. Wenn reset auf true gesetzt wird, wird der Zählerstand direkt nach dem auslesen auf 0 zurück gesetzt.
Der Encoder hat 24 Schritte pro Umdrehung.
Wenn der Encoder nach links gedreht wird wird der Zählerwert dekrementiert, d.h. negative Zählerwerte sind möglich.
Rückgabe: |
|
---|
Gibt true zurück wenn der Taster gedrückt ist und sonst false.
Es wird empfohlen die PressedCallback und ReleasedCallback Callbacks zu nutzen, um den Taster programmatisch zu behandeln.
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 'a', 'b', 'c', 'd', 'e', 'f', 'g' oder 'h' (Bricklet Anschluss) sein. Der Raspberry Pi HAT (Zero) Brick ist immer an Position 'i' und das 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.
Parameter: |
|
---|
Setzt die Periode mit welcher der CountCallback Callback ausgelöst wird. Ein Wert von 0 deaktiviert den Callback.
Der CountCallback Callback wird nur ausgelöst, wenn sich der Zählerwert seit der letzten Auslösung geändert hat.
Rückgabe: |
|
---|
Gibt die Periode zurück, wie von SetCountCallbackPeriod() gesetzt.
Parameter: |
|
---|
Setzt den Schwellwert für den CountReachedCallback Callback.
Die folgenden Optionen sind möglich:
Option | Beschreibung |
---|---|
'x' | Callback ist inaktiv |
'o' | Callback wird ausgelöst, wenn der Zählerwert außerhalb der min und max Werte ist |
'i' | Callback wird ausgelöst, wenn die Zählerwert innerhalb der min und max Werte ist |
'<' | Callback wird ausgelöst, wenn die Zählerwert kleiner als der min Wert ist (max wird ignoriert) |
'>' | Callback wird ausgelöst, wenn die Zählerwert größer als der min Wert ist (max wird ignoriert) |
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für option:
Ausgabeparameter: |
|
---|
Gibt den Schwellwert zurück, wie von SetCountCallbackThreshold() gesetzt.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für option:
Parameter: |
|
---|
Setzt die Periode mit welcher der Schwellwert-Callback
ausgelöst wird, wenn der Schwellwert
weiterhin erreicht bleibt.
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 erfolgt indem eine Prozedur einem Callback Property des Geräte Objektes zugewiesen wird:
Sub MyCallback(ByVal sender As BrickletRotaryEncoder, ByVal value As Short) Console.WriteLine("Value: {0}", value) End Sub AddHandler rotaryEncoder.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.
Callback-Parameter: |
|
---|
Dieser Callback wird mit der Periode, wie gesetzt mit SetCountCallbackPeriod(), ausgelöst. Der Parameter ist der Zählerwert des Encoders.
Der CountCallback Callback wird nur ausgelöst, wenn sich der Zähler seit der letzten Auslösung geändert hat.
Callback-Parameter: |
|
---|
Dieser Callback wird ausgelöst, wenn der Schwellwert, wie von SetCountCallbackThreshold() gesetzt, erreicht wird. Der Parameter ist der Zählerwert des Encoders.
Wenn der Schwellwert erreicht bleibt, wird der Callback mit der Periode, wie mit SetDebouncePeriod() gesetzt, ausgelöst.
Callback-Parameter: |
|
---|
Dieser Callback wird ausgelöst, wenn der Taster gedrückt wird.
Callback-Parameter: |
|
---|
Dieser Callback wird ausgelöst, wenn der Taster losgelassen wird.
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.
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.
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:
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:
Parameter: |
|
---|
Ändert das Response-Expected-Flag für alle Setter-Funktionen und Konfigurationsfunktionen für Callbacks diese Gerätes.
Diese Konstante wird verwendet um ein Rotary Encoder 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.
Diese Konstante stellt den Anzeigenamen eines Rotary Encoder Bricklet dar.