LabVIEW - Joystick Bricklet

Dies ist die Beschreibung der LabVIEW 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 LabVIEW API Bindings ist Teil deren allgemeine Beschreibung.

API

Prinzipiell kann jede Funktion der LabVIEW Bindings, welche einen Wert ausgibt eine Tinkerforge.TimeoutException melden. Dieser Fehler wird gemeldet wenn das Gerät nicht antwortet. Wenn eine Kabelverbindung genutzt wird, ist es unwahrscheinlich, dass die Exception geworfen wird (unter der Annahme, dass das Gerät nicht abgesteckt wird). Bei einer drahtlosen Verbindung können Zeitüberschreitungen auftreten, sobald die Entfernung zum Gerät zu groß wird.

Der Namensraum für alle Brick/Bricklet Bindings und die IPConnection ist Tinkerforge.*.

Grundfunktionen

BrickletJoystick(uid, ipcon) → joystick
Eingabe:
  • uid – Typ: String
  • ipcon – Typ: .NET Refnum (IPConnection)
Ausgabe:
  • joystick – Typ: .NET Refnum (BrickletJoystick)

Erzeugt ein Objekt mit der eindeutigen Geräte ID uid. Dieses Objekt kann benutzt werden, nachdem die IP Connection verbunden ist (siehe Beispiele oben).

BrickletJoystick.GetPosition() → x, y
Ausgabe:
  • x – Typ: Int16, Wertebereich: [-100 bis 100]
  • y – Typ: Int16, Wertebereich: [-100 bis 100]

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.

BrickletJoystick.IsPressed() → pressed
Ausgabe:
  • pressed – Typ: 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

BrickletJoystick.GetAnalogValue() → x, y
Ausgabe:
  • x – Typ: Int32, Wertebereich: [0 bis 4095]
  • y – Typ: Int32, Wertebereich: [0 bis 4095]

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.

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.

BrickletJoystick.GetIdentity() → uid, connectedUid, position, hardwareVersion, firmwareVersion, deviceIdentifier
Ausgabe:
  • uid – Typ: String, Länge: bis zu 8
  • connectedUid – Typ: String, Länge: bis zu 8
  • position – Typ: Char, Wertebereich: ["a" bis "h", "i", "z"]
  • hardwareVersion – Typ: Byte[3]
    • 0: major – Typ: Byte, Wertebereich: [0 bis 255]
    • 1: minor – Typ: Byte, Wertebereich: [0 bis 255]
    • 2: revision – Typ: Byte, Wertebereich: [0 bis 255]
  • firmwareVersion – Typ: Byte[3]
    • 0: major – Typ: Byte, Wertebereich: [0 bis 255]
    • 1: minor – Typ: Byte, Wertebereich: [0 bis 255]
    • 2: revision – Typ: Byte, Wertebereich: [0 bis 255]
  • deviceIdentifier – Typ: Int32, Wertebereich: [0 bis 216 - 1]

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.

Konfigurationsfunktionen für Callbacks

BrickletJoystick.SetPositionCallbackPeriod(period)
Eingabe:
  • period – Typ: Int64, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0

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.

BrickletJoystick.GetPositionCallbackPeriod() → period
Ausgabe:
  • period – Typ: Int64, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0

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

BrickletJoystick.SetAnalogValueCallbackPeriod(period)
Eingabe:
  • period – Typ: Int64, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0

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.

BrickletJoystick.GetAnalogValueCallbackPeriod() → period
Ausgabe:
  • period – Typ: Int64, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0

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

BrickletJoystick.SetPositionCallbackThreshold(option, minX, maxX, minY, maxY)
Eingabe:
  • option – Typ: Char, Wertebereich: Siehe Konstanten, Standardwert: "x"
  • minX – Typ: Int16, Wertebereich: [-215 bis 215 - 1], Standardwert: 0
  • maxX – Typ: Int16, Wertebereich: [-215 bis 215 - 1], Standardwert: 0
  • minY – Typ: Int16, Wertebereich: [-215 bis 215 - 1], Standardwert: 0
  • maxY – Typ: Int16, Wertebereich: [-215 bis 215 - 1], Standardwert: 0

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"
  • BrickletJoystick.THRESHOLD_OPTION_OUTSIDE = "o"
  • BrickletJoystick.THRESHOLD_OPTION_INSIDE = "i"
  • BrickletJoystick.THRESHOLD_OPTION_SMALLER = "<"
  • BrickletJoystick.THRESHOLD_OPTION_GREATER = ">"
BrickletJoystick.GetPositionCallbackThreshold() → option, minX, maxX, minY, maxY
Ausgabe:
  • option – Typ: Char, Wertebereich: Siehe Konstanten, Standardwert: "x"
  • minX – Typ: Int16, Wertebereich: [-215 bis 215 - 1], Standardwert: 0
  • maxX – Typ: Int16, Wertebereich: [-215 bis 215 - 1], Standardwert: 0
  • minY – Typ: Int16, Wertebereich: [-215 bis 215 - 1], Standardwert: 0
  • maxY – Typ: Int16, Wertebereich: [-215 bis 215 - 1], Standardwert: 0

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"
  • BrickletJoystick.THRESHOLD_OPTION_OUTSIDE = "o"
  • BrickletJoystick.THRESHOLD_OPTION_INSIDE = "i"
  • BrickletJoystick.THRESHOLD_OPTION_SMALLER = "<"
  • BrickletJoystick.THRESHOLD_OPTION_GREATER = ">"
BrickletJoystick.SetAnalogValueCallbackThreshold(option, minX, maxX, minY, maxY)
Eingabe:
  • option – Typ: Char, Wertebereich: Siehe Konstanten, Standardwert: "x"
  • minX – Typ: Int32, Wertebereich: [0 bis 216 - 1], Standardwert: 0
  • maxX – Typ: Int32, Wertebereich: [0 bis 216 - 1], Standardwert: 0
  • minY – Typ: Int32, Wertebereich: [0 bis 216 - 1], Standardwert: 0
  • maxY – Typ: Int32, Wertebereich: [0 bis 216 - 1], Standardwert: 0

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"
  • BrickletJoystick.THRESHOLD_OPTION_OUTSIDE = "o"
  • BrickletJoystick.THRESHOLD_OPTION_INSIDE = "i"
  • BrickletJoystick.THRESHOLD_OPTION_SMALLER = "<"
  • BrickletJoystick.THRESHOLD_OPTION_GREATER = ">"
BrickletJoystick.GetAnalogValueCallbackThreshold() → option, minX, maxX, minY, maxY
Ausgabe:
  • option – Typ: Char, Wertebereich: Siehe Konstanten, Standardwert: "x"
  • minX – Typ: Int32, Wertebereich: [0 bis 216 - 1], Standardwert: 0
  • maxX – Typ: Int32, Wertebereich: [0 bis 216 - 1], Standardwert: 0
  • minY – Typ: Int32, Wertebereich: [0 bis 216 - 1], Standardwert: 0
  • maxY – Typ: Int32, Wertebereich: [0 bis 216 - 1], Standardwert: 0

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"
  • BrickletJoystick.THRESHOLD_OPTION_OUTSIDE = "o"
  • BrickletJoystick.THRESHOLD_OPTION_INSIDE = "i"
  • BrickletJoystick.THRESHOLD_OPTION_SMALLER = "<"
  • BrickletJoystick.THRESHOLD_OPTION_GREATER = ">"
BrickletJoystick.SetDebouncePeriod(debounce)
Eingabe:
  • debounce – Typ: Int64, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 100

Setzt die Periode mit welcher die Schwellwert Callbacks

ausgelöst werden, wenn die Schwellwerte

weiterhin erreicht bleiben.

BrickletJoystick.GetDebouncePeriod() → debounce
Ausgabe:
  • debounce – Typ: Int64, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 100

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 Funktion einem Callback Property des Geräte Objektes zugewiesen wird. 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 → sender, x, y
Callback-Ausgabe:
  • sender – Typ: .NET Refnum (BrickletJoystick)
  • x – Typ: Int16, Wertebereich: [-100 bis 100]
  • y – Typ: Int16, Wertebereich: [-100 bis 100]

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 → sender, x, y
Callback-Ausgabe:
  • sender – Typ: .NET Refnum (BrickletJoystick)
  • x – Typ: Int32, Wertebereich: [0 bis 4095]
  • y – Typ: Int32, Wertebereich: [0 bis 4095]

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 → sender, x, y
Callback-Ausgabe:
  • sender – Typ: .NET Refnum (BrickletJoystick)
  • x – Typ: Int16, Wertebereich: [-100 bis 100]
  • y – Typ: Int16, Wertebereich: [-100 bis 100]

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 → sender, x, y
Callback-Ausgabe:
  • sender – Typ: .NET Refnum (BrickletJoystick)
  • x – Typ: Int32, Wertebereich: [0 bis 4095]
  • y – Typ: Int32, Wertebereich: [0 bis 4095]

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 → sender
Callback-Ausgabe:
  • sender – Typ: .NET Refnum (BrickletJoystick)

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

event BrickletJoystick.ReleasedCallback → sender
Callback-Ausgabe:
  • sender – Typ: .NET Refnum (BrickletJoystick)

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

Virtuelle Funktionen

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.

BrickletJoystick.GetAPIVersion() → apiVersion
Ausgabe:
  • apiVersion – Typ: Byte[3]
    • 0: major – Typ: Byte, Wertebereich: [0 bis 255]
    • 1: minor – Typ: Byte, Wertebereich: [0 bis 255]
    • 2: revision – Typ: Byte, Wertebereich: [0 bis 255]

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.

BrickletJoystick.GetResponseExpected(functionId) → responseExpected
Eingabe:
  • functionId – Typ: Byte, Wertebereich: Siehe Konstanten
Ausgabe:
  • responseExpected – Typ: 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:

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
BrickletJoystick.SetResponseExpected(functionId, responseExpected)
Eingabe:
  • functionId – Typ: Byte, Wertebereich: Siehe Konstanten
  • responseExpected – Typ: 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:

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
BrickletJoystick.SetResponseExpectedAll(responseExpected)
Eingabe:
  • responseExpected – Typ: Boolean

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

Konstanten

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.

BrickletJoystick.DEVICE_DISPLAY_NAME

Diese Konstante stellt den Anzeigenamen eines Joystick Bricklet dar.