Visual Basic .NET - Rotary Encoder Bricklet

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.

Beispiele

Der folgende Beispielcode ist Public Domain (CC0 1.0).

Simple

Download (ExampleSimple.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 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

Callback

Download (ExampleCallback.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
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

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 BrickletRotaryEncoder(ByVal uid As String, ByVal ipcon As IPConnection)

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).

Function BrickletRotaryEncoder.GetCount(ByVal reset As Boolean) As Integer

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.

Function BrickletRotaryEncoder.IsPressed() As Boolean

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.

Fortgeschrittene Funktionen

Function BrickletRotaryEncoder.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 BrickletRotaryEncoder.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 BrickletRotaryEncoder.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:

  • BrickletRotaryEncoder.FUNCTION_SET_COUNT_CALLBACK_PERIOD = 2
  • BrickletRotaryEncoder.FUNCTION_SET_COUNT_CALLBACK_THRESHOLD = 4
  • BrickletRotaryEncoder.FUNCTION_SET_DEBOUNCE_PERIOD = 6
Sub BrickletRotaryEncoder.SetResponseExpectedAll(ByVal responseExpected As Boolean)

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

Sub BrickletRotaryEncoder.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 BrickletRotaryEncoder.SetCountCallbackPeriod(ByVal period As Long)

Setzt die Periode in ms 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.

Der Standardwert ist 0.

Function BrickletRotaryEncoder.GetCountCallbackPeriod() As Long

Gibt die Periode zurück, wie von SetCountCallbackPeriod() gesetzt.

Sub BrickletRotaryEncoder.SetCountCallbackThreshold(ByVal option As Char, ByVal min As Integer, ByVal max As Integer)

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)

Der Standardwert ist ('x', 0, 0).

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

  • BrickletRotaryEncoder.THRESHOLD_OPTION_OFF = "x"C
  • BrickletRotaryEncoder.THRESHOLD_OPTION_OUTSIDE = "o"C
  • BrickletRotaryEncoder.THRESHOLD_OPTION_INSIDE = "i"C
  • BrickletRotaryEncoder.THRESHOLD_OPTION_SMALLER = "<"C
  • BrickletRotaryEncoder.THRESHOLD_OPTION_GREATER = ">"C
Sub BrickletRotaryEncoder.GetCountCallbackThreshold(ByRef option As Char, ByRef min As Integer, ByRef max As Integer)

Gibt den Schwellwert zurück, wie von SetCountCallbackThreshold() gesetzt.

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

  • BrickletRotaryEncoder.THRESHOLD_OPTION_OFF = "x"C
  • BrickletRotaryEncoder.THRESHOLD_OPTION_OUTSIDE = "o"C
  • BrickletRotaryEncoder.THRESHOLD_OPTION_INSIDE = "i"C
  • BrickletRotaryEncoder.THRESHOLD_OPTION_SMALLER = "<"C
  • BrickletRotaryEncoder.THRESHOLD_OPTION_GREATER = ">"C
Sub BrickletRotaryEncoder.SetDebouncePeriod(ByVal debounce As Long)

Setzt die Periode in ms mit welcher der Schwellwert-Callback

ausgelöst wird, wenn der Schwellwert

weiterhin erreicht bleibt.

Der Standardwert ist 100.

Function BrickletRotaryEncoder.GetDebouncePeriod() As Long

Gibt die Entprellperiode zurück, wie von SetDebouncePeriod() 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 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.

Event BrickletRotaryEncoder.CountCallback(ByVal sender As BrickletRotaryEncoder, ByVal count As Integer)

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.

Event BrickletRotaryEncoder.CountReachedCallback(ByVal sender As BrickletRotaryEncoder, ByVal count As Integer)

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.

Event BrickletRotaryEncoder.PressedCallback(ByVal sender As BrickletRotaryEncoder)

Dieser Callback wird ausgelöst, wenn der Taster gedrückt wird.

Event BrickletRotaryEncoder.ReleasedCallback(ByVal sender As BrickletRotaryEncoder)

Dieser Callback wird ausgelöst, wenn der Taster losgelassen wird.

Konstanten

Const BrickletRotaryEncoder.DEVICE_IDENTIFIER

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.

Const BrickletRotaryEncoder.DEVICE_DISPLAY_NAME

Diese Konstante stellt den Anzeigenamen eines Rotary Encoder Bricklet dar.