Visual Basic .NET - Joystick Bricklet

Dies ist die Beschreibung der Visual Basic .NET API Bindings für das Joystick Bricklet. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des Joystick 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
25
26
27
28
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 Joystick Bricklet

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

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

        ' Get current position
        Dim x, y As Short

        j.GetPosition(x, y)

        Console.WriteLine("Position [X]: " + x.ToString())
        Console.WriteLine("Position [Y]: " + y.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
34
35
36
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 Joystick Bricklet

    ' Callback subroutine for pressed callback
    Sub PressedCB(ByVal sender As BrickletJoystick)
        Console.WriteLine("Pressed")
    End Sub

    ' Callback subroutine for released callback
    Sub ReleasedCB(ByVal sender As BrickletJoystick)
        Console.WriteLine("Released")
    End Sub

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

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

        ' Register pressed callback to subroutine PressedCB
        AddHandler j.PressedCallback, AddressOf PressedCB

        ' Register released callback to subroutine ReleasedCB
        AddHandler j.ReleasedCallback, AddressOf ReleasedCB

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

Find Borders

Download (ExampleFindBorders.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
35
36
37
38
39
40
41
42
43
44
45
46
47
Imports System
Imports Tinkerforge

Module ExampleFindBorders
    Const HOST As String = "localhost"
    Const PORT As Integer = 4223
    Const UID As String = "XYZ" ' Change XYZ to the UID of your Joystick Bricklet

    ' Callback subroutine for position reached callback
    Sub PositionReachedCB(ByVal sender As BrickletJoystick, ByVal x As Short, _
                          ByVal y As Short)
        If y = 100 Then
            Console.WriteLine("Top")
        Else If y = -100 Then
            Console.WriteLine("Bottom")
        End If

        If x = 100 Then
            Console.WriteLine("Right")
        Else If x = -100 Then
            Console.WriteLine("Left")
        End If

        Console.WriteLine("")
    End Sub

    Sub Main()
        Dim ipcon As New IPConnection() ' Create IP connection
        Dim j As New BrickletJoystick(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 0.2 seconds (200ms)
        j.SetDebouncePeriod(200)

        ' Register position reached callback to subroutine PositionReachedCB
        AddHandler j.PositionReachedCallback, AddressOf PositionReachedCB

        ' Configure threshold for position "outside of -99, -99 to 99, 99"
        j.SetPositionCallbackThreshold("o"C, -99, 99, -99, 99)

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

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

Dim joystick As New BrickletJoystick("YOUR_DEVICE_UID", ipcon)

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

Sub BrickletJoystick.GetPosition(ByRef x As Short, ByRef y As Short)

Gibt die Position des Joystick zurück. Der Wertebereich ist von -100 bis 100 für beide Achsen. Die Mittelposition des Joysticks ist x=0, y=0. Die zurückgegebenen Werte sind gemittelt und kalibriert (siehe Calibrate()).

Wenn die Position periodisch abgefragt werden sollen, wird empfohlen den PositionCallback Callback zu nutzen und die Periode mit SetPositionCallbackPeriod() vorzugeben.

Function BrickletJoystick.IsPressed() As Boolean

Gibt true zurück wenn die Taste gedrückt ist und sonst false.

Es wird empfohlen die PressedCallback und ReleasedCallback Callbacks zu nutzen, um die Taste programmatisch zu behandeln.

Fortgeschrittene Funktionen

Sub BrickletJoystick.GetAnalogValue(ByRef x As Integer, ByRef y As Integer)

Gibt den Wert, wie vom 12-Bit Analog-Digital-Wandler gelesen, zurück. Der Wertebereich ist 0 bis 4095.

Bemerkung

Der von GetPosition() 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 die Analogwerte periodisch abgefragt werden sollen, wird empfohlen den AnalogValueCallback Callback zu nutzen und die Periode mit SetAnalogValueCallbackPeriod() vorzugeben.

Sub BrickletJoystick.Calibrate()

Kalibriert die Mittelposition des Joysticks. Sollte der Joystick Bricklet nicht x=0 und y=0 in der Mittelposition zurückgeben, kann diese Funktion aufgerufen werden wenn der Joystick sich unbewegt in der Mittelposition befindet.

Die resultierende Kalibrierung wird in den EEPROM des Joystick Bricklet gespeichert, somit ist die Kalibrierung nur einmalig notwendig.

Function BrickletJoystick.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 BrickletJoystick.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.

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

  • BrickletJoystick.FUNCTION_CALIBRATE = 4
  • BrickletJoystick.FUNCTION_SET_POSITION_CALLBACK_PERIOD = 5
  • BrickletJoystick.FUNCTION_SET_ANALOG_VALUE_CALLBACK_PERIOD = 7
  • BrickletJoystick.FUNCTION_SET_POSITION_CALLBACK_THRESHOLD = 9
  • BrickletJoystick.FUNCTION_SET_ANALOG_VALUE_CALLBACK_THRESHOLD = 11
  • BrickletJoystick.FUNCTION_SET_DEBOUNCE_PERIOD = 13
Sub BrickletJoystick.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 Konstanten sind für diese Funktion verfügbar:

  • BrickletJoystick.FUNCTION_CALIBRATE = 4
  • BrickletJoystick.FUNCTION_SET_POSITION_CALLBACK_PERIOD = 5
  • BrickletJoystick.FUNCTION_SET_ANALOG_VALUE_CALLBACK_PERIOD = 7
  • BrickletJoystick.FUNCTION_SET_POSITION_CALLBACK_THRESHOLD = 9
  • BrickletJoystick.FUNCTION_SET_ANALOG_VALUE_CALLBACK_THRESHOLD = 11
  • BrickletJoystick.FUNCTION_SET_DEBOUNCE_PERIOD = 13
Sub BrickletJoystick.SetResponseExpectedAll(ByVal responseExpected As Boolean)

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

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

Setzt die Periode in ms mit welcher der PositionCallback Callback ausgelöst wird. Ein Wert von 0 deaktiviert den Callback.

The PositionCallback Callback wird nur ausgelöst, wenn sich die Position seit der letzten Auslösung geändert hat.

Der Standardwert ist 0.

Function BrickletJoystick.GetPositionCallbackPeriod() As Long

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

Sub BrickletJoystick.SetAnalogValueCallbackPeriod(ByVal period As Long)

Setzt die Periode in ms mit welcher der AnalogValueCallback Callback ausgelöst wird. Ein Wert von 0 deaktiviert den Callback.

Der AnalogValueCallback Callback wird nur ausgelöst, wenn sich die Analogwerte seit der letzten Auslösung geändert hat.

Der Standardwert ist 0.

Function BrickletJoystick.GetAnalogValueCallbackPeriod() As Long

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

Sub BrickletJoystick.SetPositionCallbackThreshold(ByVal option As Char, ByVal minX As Short, ByVal maxX As Short, ByVal minY As Short, ByVal maxY As Short)

Setzt den Schwellwert für den PositionReachedCallback Callback.

Die folgenden Optionen sind möglich:

Option Beschreibung
'x' Callback ist inaktiv
'o' Callback wird ausgelöst, wenn die Position außerhalb der min und max Werte ist
'i' Callback wird ausgelöst, wenn die Position innerhalb der min und max Werte ist
'<' Callback wird ausgelöst, wenn die Position kleiner als die min Werte ist (max wird ignoriert)
'>' Callback wird ausgelöst, wenn die Position größer als die min Werte ist (max wird ignoriert)

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

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

  • BrickletJoystick.THRESHOLD_OPTION_OFF = "x"C
  • BrickletJoystick.THRESHOLD_OPTION_OUTSIDE = "o"C
  • BrickletJoystick.THRESHOLD_OPTION_INSIDE = "i"C
  • BrickletJoystick.THRESHOLD_OPTION_SMALLER = "<"C
  • BrickletJoystick.THRESHOLD_OPTION_GREATER = ">"C
Sub BrickletJoystick.GetPositionCallbackThreshold(ByRef option As Char, ByRef minX As Short, ByRef maxX As Short, ByRef minY As Short, ByRef maxY As Short)

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

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

  • BrickletJoystick.THRESHOLD_OPTION_OFF = "x"C
  • BrickletJoystick.THRESHOLD_OPTION_OUTSIDE = "o"C
  • BrickletJoystick.THRESHOLD_OPTION_INSIDE = "i"C
  • BrickletJoystick.THRESHOLD_OPTION_SMALLER = "<"C
  • BrickletJoystick.THRESHOLD_OPTION_GREATER = ">"C
Sub BrickletJoystick.SetAnalogValueCallbackThreshold(ByVal option As Char, ByVal minX As Integer, ByVal maxX As Integer, ByVal minY As Integer, ByVal maxY As Integer)

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 die Analogwerte außerhalb der min und max Werte ist
'i' Callback wird ausgelöst, wenn die Analogwerte innerhalb der min und max Werte ist
'<' Callback wird ausgelöst, wenn die Analogwerte kleiner als die min Werte ist (max wird ignoriert)
'>' Callback wird ausgelöst, wenn die Analogwerte größer als die min Werte ist (max wird ignoriert)

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

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

  • BrickletJoystick.THRESHOLD_OPTION_OFF = "x"C
  • BrickletJoystick.THRESHOLD_OPTION_OUTSIDE = "o"C
  • BrickletJoystick.THRESHOLD_OPTION_INSIDE = "i"C
  • BrickletJoystick.THRESHOLD_OPTION_SMALLER = "<"C
  • BrickletJoystick.THRESHOLD_OPTION_GREATER = ">"C
Sub BrickletJoystick.GetAnalogValueCallbackThreshold(ByRef option As Char, ByRef minX As Integer, ByRef maxX As Integer, ByRef minY As Integer, ByRef maxY As Integer)

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

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

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

Setzt die Periode in ms mit welcher die Schwellwert Callbacks

ausgelöst werden, wenn die Schwellwerte

weiterhin erreicht bleiben.

Der Standardwert ist 100.

Function BrickletJoystick.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 BrickletJoystick, ByVal value As Short)
    Console.WriteLine("Value: {0}", value)
End Sub

AddHandler joystick.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 BrickletJoystick.PositionCallback(ByVal sender As BrickletJoystick, ByVal x As Short, ByVal y As Short)

Dieser Callback wird mit der Periode, wie gesetzt mit SetPositionCallbackPeriod(), ausgelöst. Der Parameter ist die Position des Joysticks.

Der PositionCallback Callback wird nur ausgelöst, wenn sich die Position seit der letzten Auslösung geändert hat.

Event BrickletJoystick.AnalogValueCallback(ByVal sender As BrickletJoystick, ByVal x As Integer, ByVal y As Integer)

Dieser Callback wird mit der Periode, wie gesetzt mit SetAnalogValueCallbackPeriod(), ausgelöst. Der Parameter sind die Analogwerte des Joysticks.

Der AnalogValueCallback Callback wird nur ausgelöst, wenn sich die Analogwerte seit der letzten Auslösung geändert hat.

Event BrickletJoystick.PositionReachedCallback(ByVal sender As BrickletJoystick, ByVal x As Short, ByVal y As Short)

Dieser Callback wird ausgelöst, wenn der Schwellwert, wie von SetPositionCallbackThreshold() gesetzt, erreicht wird. Der Parameter ist die Position des Joysticks.

Wenn der Schwellwert erreicht bleibt, wird der Callback mit der Periode, wie mit SetDebouncePeriod() gesetzt, ausgelöst.

Event BrickletJoystick.AnalogValueReachedCallback(ByVal sender As BrickletJoystick, ByVal x As Integer, ByVal y As Integer)

Dieser Callback wird ausgelöst, wenn der Schwellwert, wie von SetAnalogValueCallbackThreshold() gesetzt, erreicht wird. Der Parameter sind die Analogwerte des Joystick.

Wenn der Schwellwert erreicht bleibt, wird der Callback mit der Periode, wie mit SetDebouncePeriod() gesetzt, ausgelöst.

Event BrickletJoystick.PressedCallback(ByVal sender As BrickletJoystick)

Dieser Callback wird ausgelöst, wenn die Taste gedrückt wird.

Event BrickletJoystick.ReleasedCallback(ByVal sender As BrickletJoystick)

Dieser Callback wird ausgelöst, wenn die Taste losgelassen wird.

Konstanten

Const BrickletJoystick.DEVICE_IDENTIFIER

Diese Konstante wird verwendet um ein Joystick 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 BrickletJoystick.DEVICE_DISPLAY_NAME

Diese Konstante stellt den Anzeigenamen eines Joystick Bricklet dar.