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.
Der folgende Beispielcode ist Public Domain (CC0 1.0).
1Imports System
2Imports Tinkerforge
3
4Module ExampleSimple
5 Const HOST As String = "localhost"
6 Const PORT As Integer = 4223
7 Const UID As String = "XYZ" ' Change XYZ to the UID of your Joystick Bricklet
8
9 Sub Main()
10 Dim ipcon As New IPConnection() ' Create IP connection
11 Dim j As New BrickletJoystick(UID, ipcon) ' Create device object
12
13 ipcon.Connect(HOST, PORT) ' Connect to brickd
14 ' Don't use device before ipcon is connected
15
16 ' Get current position
17 Dim x, y As Short
18
19 j.GetPosition(x, y)
20
21 Console.WriteLine("Position [X]: " + x.ToString())
22 Console.WriteLine("Position [Y]: " + y.ToString())
23
24 Console.WriteLine("Press key to exit")
25 Console.ReadLine()
26 ipcon.Disconnect()
27 End Sub
28End Module
1Imports System
2Imports Tinkerforge
3
4Module ExampleCallback
5 Const HOST As String = "localhost"
6 Const PORT As Integer = 4223
7 Const UID As String = "XYZ" ' Change XYZ to the UID of your Joystick Bricklet
8
9 ' Callback subroutine for pressed callback
10 Sub PressedCB(ByVal sender As BrickletJoystick)
11 Console.WriteLine("Pressed")
12 End Sub
13
14 ' Callback subroutine for released callback
15 Sub ReleasedCB(ByVal sender As BrickletJoystick)
16 Console.WriteLine("Released")
17 End Sub
18
19 Sub Main()
20 Dim ipcon As New IPConnection() ' Create IP connection
21 Dim j As New BrickletJoystick(UID, ipcon) ' Create device object
22
23 ipcon.Connect(HOST, PORT) ' Connect to brickd
24 ' Don't use device before ipcon is connected
25
26 ' Register pressed callback to subroutine PressedCB
27 AddHandler j.PressedCallback, AddressOf PressedCB
28
29 ' Register released callback to subroutine ReleasedCB
30 AddHandler j.ReleasedCallback, AddressOf ReleasedCB
31
32 Console.WriteLine("Press key to exit")
33 Console.ReadLine()
34 ipcon.Disconnect()
35 End Sub
36End Module
Download (ExampleFindBorders.vb)
1Imports System
2Imports Tinkerforge
3
4Module ExampleFindBorders
5 Const HOST As String = "localhost"
6 Const PORT As Integer = 4223
7 Const UID As String = "XYZ" ' Change XYZ to the UID of your Joystick Bricklet
8
9 ' Callback subroutine for position reached callback
10 Sub PositionReachedCB(ByVal sender As BrickletJoystick, ByVal x As Short, _
11 ByVal y As Short)
12 If y = 100 Then
13 Console.WriteLine("Top")
14 Else If y = -100 Then
15 Console.WriteLine("Bottom")
16 End If
17
18 If x = 100 Then
19 Console.WriteLine("Right")
20 Else If x = -100 Then
21 Console.WriteLine("Left")
22 End If
23
24 Console.WriteLine("")
25 End Sub
26
27 Sub Main()
28 Dim ipcon As New IPConnection() ' Create IP connection
29 Dim j As New BrickletJoystick(UID, ipcon) ' Create device object
30
31 ipcon.Connect(HOST, PORT) ' Connect to brickd
32 ' Don't use device before ipcon is connected
33
34 ' Get threshold callbacks with a debounce time of 0.2 seconds (200ms)
35 j.SetDebouncePeriod(200)
36
37 ' Register position reached callback to subroutine PositionReachedCB
38 AddHandler j.PositionReachedCallback, AddressOf PositionReachedCB
39
40 ' Configure threshold for position "outside of -99, -99 to 99, 99"
41 j.SetPositionCallbackThreshold("o"C, -99, 99, -99, 99)
42
43 Console.WriteLine("Press key to exit")
44 Console.ReadLine()
45 ipcon.Disconnect()
46 End Sub
47End 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 joystick As New BrickletJoystick("YOUR_DEVICE_UID", ipcon)
Dieses Objekt kann benutzt werden, nachdem die IP Connection verbunden ist.
| Ausgabeparameter: |
|
|---|
Gibt die Position des Joystick zurück. 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.
| Rückgabe: |
|
|---|
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.
| Ausgabeparameter: |
|
|---|
Gibt den Wert, wie vom 12-Bit Analog-Digital-Wandler gelesen, zurück.
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.
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.
| 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.
| Parameter: |
|
|---|
Setzt die Periode 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.
| Rückgabe: |
|
|---|
Gibt die Periode zurück, wie von SetPositionCallbackPeriod() gesetzt.
| Parameter: |
|
|---|
Setzt die Periode 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.
| Rückgabe: |
|
|---|
Gibt die Periode zurück, wie von SetAnalogValueCallbackPeriod() gesetzt.
| Parameter: |
|
|---|
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) |
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für option:
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
| Ausgabeparameter: |
|
|---|
Gibt den Schwellwert zurück, wie von SetPositionCallbackThreshold() gesetzt.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für option:
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
| Parameter: |
|
|---|
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) |
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für option:
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
| Ausgabeparameter: |
|
|---|
Gibt den Schwellwert zurück, wie von SetAnalogValueCallbackThreshold() gesetzt.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für option:
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
| Parameter: |
|
|---|
Setzt die Periode mit welcher die Schwellwert Callbacks
ausgelöst werden, wenn die Schwellwerte
weiterhin erreicht bleiben.
| 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 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.
| Callback-Parameter: |
|
|---|
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.
| Callback-Parameter: |
|
|---|
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.
| Callback-Parameter: |
|
|---|
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.
| Callback-Parameter: |
|
|---|
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.
| Callback-Parameter: |
|
|---|
Dieser Callback wird ausgelöst, wenn die Taste gedrückt wird.
| Callback-Parameter: |
|
|---|
Dieser Callback wird ausgelöst, wenn die Taste 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:
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
| 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:
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
| 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 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.
Diese Konstante stellt den Anzeigenamen eines Joystick Bricklet dar.