Dies ist die Beschreibung der Python 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 Python 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 25 | #!/usr/bin/env python
# -*- coding: utf-8 -*-
HOST = "localhost"
PORT = 4223
UID = "XYZ" # Change XYZ to the UID of your Joystick Bricklet
from tinkerforge.ip_connection import IPConnection
from tinkerforge.bricklet_joystick import BrickletJoystick
if __name__ == "__main__":
ipcon = IPConnection() # Create IP connection
j = BrickletJoystick(UID, ipcon) # Create device object
ipcon.connect(HOST, PORT) # Connect to brickd
# Don't use device before ipcon is connected
# Get current position
x, y = j.get_position()
print("Position [X]: " + str(x))
print("Position [Y]: " + str(y))
input("Press key to exit\n") # Use raw_input() in Python 2
ipcon.disconnect()
|
Download (example_callback.py)
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 | #!/usr/bin/env python
# -*- coding: utf-8 -*-
HOST = "localhost"
PORT = 4223
UID = "XYZ" # Change XYZ to the UID of your Joystick Bricklet
from tinkerforge.ip_connection import IPConnection
from tinkerforge.bricklet_joystick import BrickletJoystick
# Callback function for pressed callback
def cb_pressed():
print("Pressed")
# Callback function for released callback
def cb_released():
print("Released")
if __name__ == "__main__":
ipcon = IPConnection() # Create IP connection
j = 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 function cb_pressed
j.register_callback(j.CALLBACK_PRESSED, cb_pressed)
# Register released callback to function cb_released
j.register_callback(j.CALLBACK_RELEASED, cb_released)
input("Press key to exit\n") # Use raw_input() in Python 2
ipcon.disconnect()
|
Download (example_find_borders.py)
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 | #!/usr/bin/env python
# -*- coding: utf-8 -*-
HOST = "localhost"
PORT = 4223
UID = "XYZ" # Change XYZ to the UID of your Joystick Bricklet
from tinkerforge.ip_connection import IPConnection
from tinkerforge.bricklet_joystick import BrickletJoystick
# Callback function for position reached callback
def cb_position_reached(x, y):
if y == 100:
print('Top')
elif y == -100:
print('Bottom')
if x == 100:
print('Right')
elif x == -100:
print('Left')
print("")
if __name__ == "__main__":
ipcon = IPConnection() # Create IP connection
j = 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.set_debounce_period(200)
# Register position reached callback to function cb_position_reached
j.register_callback(j.CALLBACK_POSITION_REACHED, cb_position_reached)
# Configure threshold for position "outside of -99, -99 to 99, 99"
j.set_position_callback_threshold("o", -99, 99, -99, 99)
input("Press key to exit\n") # Use raw_input() in Python 2
ipcon.disconnect()
|
Prinzipiell kann jede Funktion der Python Bindings
tinkerforge.ip_connection.Error
Exception werfen, welche ein value
und
eine description
Property hat. value
kann verschiende Werte haben:
Alle folgend aufgelisteten Funktionen sind Thread-sicher.
BrickletJoystick
(uid, ipcon)¶Parameter: |
|
---|---|
Rückgabe: |
|
Erzeugt ein Objekt mit der eindeutigen Geräte ID uid
:
joystick = BrickletJoystick("YOUR_DEVICE_UID", ipcon)
Dieses Objekt kann benutzt werden, nachdem die IP Connection verbunden ist.
BrickletJoystick.
get_position
()¶Rückgabeobjekt: |
|
---|
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 CALLBACK_POSITION
Callback zu nutzen und die Periode mit
set_position_callback_period()
vorzugeben.
BrickletJoystick.
is_pressed
()¶Rückgabe: |
|
---|
Gibt true zurück wenn die Taste gedrückt ist und sonst false.
Es wird empfohlen die CALLBACK_PRESSED
und CALLBACK_RELEASED
Callbacks
zu nutzen, um die Taste programmatisch zu behandeln.
BrickletJoystick.
get_analog_value
()¶Rückgabeobjekt: |
|
---|
Gibt den Wert, wie vom 12-Bit Analog-Digital-Wandler gelesen, zurück.
Bemerkung
Der von get_position()
zurückgegebene Wert ist über mehrere
Messwerte gemittelt um das Rauschen zu vermindern, während get_analog_value()
unverarbeitete Analogwerte zurück gibt. Der einzige Grund get_analog_value()
zu nutzen, ist die volle Auflösung des Analog-Digital-Wandlers zu erhalten.
Wenn die Analogwerte periodisch abgefragt werden sollen, wird empfohlen
den CALLBACK_ANALOG_VALUE
Callback zu nutzen und die Periode mit
set_analog_value_callback_period()
vorzugeben.
BrickletJoystick.
calibrate
()¶Rückgabe: |
|
---|
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.
get_identity
()¶Rückgabeobjekt: |
|
---|
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.
BrickletJoystick.
register_callback
(callback_id, function)¶Parameter: |
|
---|---|
Rückgabe: |
|
Registriert die function
für die gegebene callback_id
.
Die verfügbaren Callback IDs mit den zugehörigen Funktionssignaturen sind unten zu finden.
BrickletJoystick.
set_position_callback_period
(period)¶Parameter: |
|
---|---|
Rückgabe: |
|
Setzt die Periode mit welcher der CALLBACK_POSITION
Callback ausgelöst wird.
Ein Wert von 0 deaktiviert den Callback.
The CALLBACK_POSITION
Callback wird nur ausgelöst, wenn sich die Position seit der
letzten Auslösung geändert hat.
BrickletJoystick.
get_position_callback_period
()¶Rückgabe: |
|
---|
Gibt die Periode zurück, wie von set_position_callback_period()
gesetzt.
BrickletJoystick.
set_analog_value_callback_period
(period)¶Parameter: |
|
---|---|
Rückgabe: |
|
Setzt die Periode mit welcher der CALLBACK_ANALOG_VALUE
Callback ausgelöst
wird. Ein Wert von 0 deaktiviert den Callback.
Der CALLBACK_ANALOG_VALUE
Callback wird nur ausgelöst, wenn sich die Analogwerte
seit der letzten Auslösung geändert hat.
BrickletJoystick.
get_analog_value_callback_period
()¶Rückgabe: |
|
---|
Gibt die Periode zurück, wie von set_analog_value_callback_period()
gesetzt.
BrickletJoystick.
set_position_callback_threshold
(option, min_x, max_x, min_y, max_y)¶Parameter: |
|
---|---|
Rückgabe: |
|
Setzt den Schwellwert für den CALLBACK_POSITION_REACHED
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.
get_position_callback_threshold
()¶Rückgabeobjekt: |
|
---|
Gibt den Schwellwert zurück, wie von set_position_callback_threshold()
gesetzt.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für option:
BrickletJoystick.
set_analog_value_callback_threshold
(option, min_x, max_x, min_y, max_y)¶Parameter: |
|
---|---|
Rückgabe: |
|
Setzt den Schwellwert für den CALLBACK_ANALOG_VALUE_REACHED
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.
get_analog_value_callback_threshold
()¶Rückgabeobjekt: |
|
---|
Gibt den Schwellwert zurück, wie von set_analog_value_callback_threshold()
gesetzt.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für option:
BrickletJoystick.
set_debounce_period
(debounce)¶Parameter: |
|
---|---|
Rückgabe: |
|
Setzt die Periode mit welcher die Schwellwert Callbacks
ausgelöst werden, wenn die Schwellwerte
weiterhin erreicht bleiben.
BrickletJoystick.
get_debounce_period
()¶Rückgabe: |
|
---|
Gibt die Entprellperiode zurück, wie von set_debounce_period()
gesetzt.
Callbacks können registriert werden um zeitkritische
oder wiederkehrende Daten vom Gerät zu erhalten. Die Registrierung kann
mit der Funktion register_callback()
des
Geräte Objektes durchgeführt werden. Der erste Parameter ist die Callback ID
und der zweite Parameter die Callback-Funktion:
def my_callback(param):
print(param)
joystick.register_callback(BrickletJoystick.CALLBACK_EXAMPLE, my_callback)
Die verfügbaren IDs mit der dazugehörigen Parameteranzahl und -typen 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.
BrickletJoystick.
CALLBACK_POSITION
¶Callback-Parameter: |
|
---|
Dieser Callback wird mit der Periode, wie gesetzt mit set_position_callback_period()
,
ausgelöst. Der Parameter ist die Position des Joysticks.
Der CALLBACK_POSITION
Callback wird nur ausgelöst, wenn sich die Position seit der
letzten Auslösung geändert hat.
BrickletJoystick.
CALLBACK_ANALOG_VALUE
¶Callback-Parameter: |
|
---|
Dieser Callback wird mit der Periode, wie gesetzt mit set_analog_value_callback_period()
,
ausgelöst. Der Parameter sind die Analogwerte des Joysticks.
Der CALLBACK_ANALOG_VALUE
Callback wird nur ausgelöst, wenn sich die Analogwerte
seit der letzten Auslösung geändert hat.
BrickletJoystick.
CALLBACK_POSITION_REACHED
¶Callback-Parameter: |
|
---|
Dieser Callback wird ausgelöst, wenn der Schwellwert, wie von
set_position_callback_threshold()
gesetzt, erreicht wird.
Der Parameter ist die Position des Joysticks.
Wenn der Schwellwert erreicht bleibt, wird der Callback mit der Periode, wie
mit set_debounce_period()
gesetzt, ausgelöst.
BrickletJoystick.
CALLBACK_ANALOG_VALUE_REACHED
¶Callback-Parameter: |
|
---|
Dieser Callback wird ausgelöst, wenn der Schwellwert, wie von
set_analog_value_callback_threshold()
gesetzt, erreicht wird.
Der Parameter sind die Analogwerte des Joystick.
Wenn der Schwellwert erreicht bleibt, wird der Callback mit der Periode, wie
mit set_debounce_period()
gesetzt, ausgelöst.
BrickletJoystick.
CALLBACK_PRESSED
¶Callback-Parameter: |
|
---|
Dieser Callback wird ausgelöst, wenn die Taste gedrückt wird.
BrickletJoystick.
CALLBACK_RELEASED
¶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.
BrickletJoystick.
get_api_version
()¶Rückgabeobjekt: |
|
---|
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.
get_response_expected
(function_id)¶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 set_response_expected()
. 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 function_id:
BrickletJoystick.
set_response_expected
(function_id, response_expected)¶Parameter: |
|
---|---|
Rückgabe: |
|
Ä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 function_id:
BrickletJoystick.
set_response_expected_all
(response_expected)¶Parameter: |
|
---|---|
Rückgabe: |
|
Ändert das Response-Expected-Flag für alle Setter-Funktionen und Konfigurationsfunktionen für Callbacks diese Gerätes.
BrickletJoystick.
DEVICE_IDENTIFIER
¶Diese Konstante wird verwendet um ein Joystick Bricklet zu identifizieren.
Die get_identity()
Funktion und der
IPConnection.CALLBACK_ENUMERATE
Callback der IP Connection haben ein device_identifier
Parameter um den Typ
des Bricks oder Bricklets anzugeben.
BrickletJoystick.
DEVICE_DISPLAY_NAME
¶Diese Konstante stellt den Anzeigenamen eines Joystick Bricklet dar.