Python - Rotary Poti Bricklet

Dies ist die Beschreibung der Python API Bindings für das Rotary Poti Bricklet. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des Rotary Poti Bricklet sind in dessen Hardware Beschreibung zusammengefasst.

Eine Installationanleitung für die Python API Bindings ist Teil deren allgemeine Beschreibung.

Beispiele

Der folgende Beispielcode ist Public Domain (CC0 1.0).

Simple

Download (example_simple.py)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
#!/usr/bin/env python
# -*- coding: utf-8 -*-

HOST = "localhost"
PORT = 4223
UID = "XYZ" # Change XYZ to the UID of your Rotary Poti Bricklet

from tinkerforge.ip_connection import IPConnection
from tinkerforge.bricklet_rotary_poti import BrickletRotaryPoti

if __name__ == "__main__":
    ipcon = IPConnection() # Create IP connection
    rp = BrickletRotaryPoti(UID, ipcon) # Create device object

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

    # Get current position
    position = rp.get_position()
    print("Position: " + str(position)) # Range: -150 to 150

    raw_input("Press key to exit\n") # Use input() in Python 3
    ipcon.disconnect()

Callback

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
#!/usr/bin/env python
# -*- coding: utf-8 -*-

HOST = "localhost"
PORT = 4223
UID = "XYZ" # Change XYZ to the UID of your Rotary Poti Bricklet

from tinkerforge.ip_connection import IPConnection
from tinkerforge.bricklet_rotary_poti import BrickletRotaryPoti

# Callback function for position callback
def cb_position(position):
    print("Position: " + str(position)) # Range: -150 to 150

if __name__ == "__main__":
    ipcon = IPConnection() # Create IP connection
    rp = BrickletRotaryPoti(UID, ipcon) # Create device object

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

    # Register position callback to function cb_position
    rp.register_callback(rp.CALLBACK_POSITION, cb_position)

    # Set period for position callback to 0.05s (50ms)
    # Note: The position callback is only called every 0.05 seconds
    #       if the position has changed since the last call!
    rp.set_position_callback_period(50)

    raw_input("Press key to exit\n") # Use input() in Python 3
    ipcon.disconnect()

API

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:

  • Error.TIMEOUT = -1
  • Error.NOT_ADDED = -6 (seit Python Bindings Version 2.0.0 nicht mehr verwendet)
  • Error.ALREADY_CONNECTED = -7
  • Error.NOT_CONNECTED = -8
  • Error.INVALID_PARAMETER = -9
  • Error.NOT_SUPPORTED = -10
  • Error.UNKNOWN_ERROR_CODE = -11
  • Error.STREAM_OUT_OF_SYNC = -12
  • Error.INVALID_UID = -13
  • Error.NON_ASCII_CHAR_IN_SECRET = -14

Alle folgend aufgelisteten Funktionen sind Thread-sicher.

Grundfunktionen

BrickletRotaryPoti(uid, ipcon)
Parameter:
  • uid – Typ: str
  • ipcon – Typ: IPConnection
Rückgabe:
  • rotary_poti – Typ: BrickletRotaryPoti

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

rotary_poti = BrickletRotaryPoti("YOUR_DEVICE_UID", ipcon)

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

BrickletRotaryPoti.get_position()
Rückgabe:
  • position – Typ: int, Einheit: 1 °, Wertebereich: [-150 bis 150]

Gibt die Position des Drehpotentiometers zurück. Der Wertebereich ist von -150° (links gedreht) und 150° (rechts gedreht).

Wenn die Position periodisch abgefragt werden soll, wird empfohlen den CALLBACK_POSITION Callback zu nutzen und die Periode mit set_position_callback_period() vorzugeben.

Fortgeschrittene Funktionen

BrickletRotaryPoti.get_analog_value()
Rückgabe:
  • value – Typ: int, Wertebereich: [0 bis 4096]

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 der Analogwert periodisch abgefragt werden soll, wird empfohlen den CALLBACK_ANALOG_VALUE Callback zu nutzen und die Periode mit set_analog_value_callback_period() vorzugeben.

BrickletRotaryPoti.get_identity()
Rückgabeobjekt:
  • uid – Typ: str, Länge: bis zu 8
  • connected_uid – Typ: str, Länge: bis zu 8
  • position – Typ: chr, Wertebereich: ["a" bis "h", "i", "z"]
  • hardware_version – Typ: [int, ...], Länge: 3
    • 0: major – Typ: int, Wertebereich: [0 bis 255]
    • 1: minor – Typ: int, Wertebereich: [0 bis 255]
    • 2: revision – Typ: int, Wertebereich: [0 bis 255]
  • firmware_version – Typ: [int, ...], Länge: 3
    • 0: major – Typ: int, Wertebereich: [0 bis 255]
    • 1: minor – Typ: int, Wertebereich: [0 bis 255]
    • 2: revision – Typ: int, Wertebereich: [0 bis 255]
  • device_identifier – Typ: int, 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

BrickletRotaryPoti.register_callback(callback_id, function)
Parameter:
  • callback_id – Typ: int
  • function – Typ: callable
Rückgabe:
  • None

Registriert die function für die gegebene callback_id.

Die verfügbaren Callback IDs mit den zugehörigen Funktionssignaturen sind unten zu finden.

BrickletRotaryPoti.set_position_callback_period(period)
Parameter:
  • period – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0
Rückgabe:
  • None

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

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

BrickletRotaryPoti.get_position_callback_period()
Rückgabe:
  • period – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0

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

BrickletRotaryPoti.set_analog_value_callback_period(period)
Parameter:
  • period – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0
Rückgabe:
  • None

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 der Analogwert seit der letzten Auslösung geändert hat.

BrickletRotaryPoti.get_analog_value_callback_period()
Rückgabe:
  • period – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0

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

BrickletRotaryPoti.set_position_callback_threshold(option, min, max)
Parameter:
  • option – Typ: chr, Wertebereich: Siehe Konstanten, Standardwert: "x"
  • min – Typ: int, Einheit: 1 °, Wertebereich: [-215 bis 215 - 1], Standardwert: 0
  • max – Typ: int, Einheit: 1 °, Wertebereich: [-215 bis 215 - 1], Standardwert: 0
Rückgabe:
  • None

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 der min Wert ist (max wird ignoriert)
'>' Callback wird ausgelöst, wenn die Position größer als der min Wert ist (max wird ignoriert)

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

Für option:

  • BrickletRotaryPoti.THRESHOLD_OPTION_OFF = "x"
  • BrickletRotaryPoti.THRESHOLD_OPTION_OUTSIDE = "o"
  • BrickletRotaryPoti.THRESHOLD_OPTION_INSIDE = "i"
  • BrickletRotaryPoti.THRESHOLD_OPTION_SMALLER = "<"
  • BrickletRotaryPoti.THRESHOLD_OPTION_GREATER = ">"
BrickletRotaryPoti.get_position_callback_threshold()
Rückgabeobjekt:
  • option – Typ: chr, Wertebereich: Siehe Konstanten, Standardwert: "x"
  • min – Typ: int, Einheit: 1 °, Wertebereich: [-215 bis 215 - 1], Standardwert: 0
  • max – Typ: int, Einheit: 1 °, Wertebereich: [-215 bis 215 - 1], Standardwert: 0

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:

  • BrickletRotaryPoti.THRESHOLD_OPTION_OFF = "x"
  • BrickletRotaryPoti.THRESHOLD_OPTION_OUTSIDE = "o"
  • BrickletRotaryPoti.THRESHOLD_OPTION_INSIDE = "i"
  • BrickletRotaryPoti.THRESHOLD_OPTION_SMALLER = "<"
  • BrickletRotaryPoti.THRESHOLD_OPTION_GREATER = ">"
BrickletRotaryPoti.set_analog_value_callback_threshold(option, min, max)
Parameter:
  • option – Typ: chr, Wertebereich: Siehe Konstanten, Standardwert: "x"
  • min – Typ: int, Einheit: 1 °, Wertebereich: [0 bis 216 - 1], Standardwert: 0
  • max – Typ: int, Einheit: 1 °, Wertebereich: [0 bis 216 - 1], Standardwert: 0
Rückgabe:
  • None

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

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

Für option:

  • BrickletRotaryPoti.THRESHOLD_OPTION_OFF = "x"
  • BrickletRotaryPoti.THRESHOLD_OPTION_OUTSIDE = "o"
  • BrickletRotaryPoti.THRESHOLD_OPTION_INSIDE = "i"
  • BrickletRotaryPoti.THRESHOLD_OPTION_SMALLER = "<"
  • BrickletRotaryPoti.THRESHOLD_OPTION_GREATER = ">"
BrickletRotaryPoti.get_analog_value_callback_threshold()
Rückgabeobjekt:
  • option – Typ: chr, Wertebereich: Siehe Konstanten, Standardwert: "x"
  • min – Typ: int, Einheit: 1 °, Wertebereich: [0 bis 216 - 1], Standardwert: 0
  • max – Typ: int, Einheit: 1 °, Wertebereich: [0 bis 216 - 1], Standardwert: 0

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:

  • BrickletRotaryPoti.THRESHOLD_OPTION_OFF = "x"
  • BrickletRotaryPoti.THRESHOLD_OPTION_OUTSIDE = "o"
  • BrickletRotaryPoti.THRESHOLD_OPTION_INSIDE = "i"
  • BrickletRotaryPoti.THRESHOLD_OPTION_SMALLER = "<"
  • BrickletRotaryPoti.THRESHOLD_OPTION_GREATER = ">"
BrickletRotaryPoti.set_debounce_period(debounce)
Parameter:
  • debounce – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 100
Rückgabe:
  • None

Setzt die Periode mit welcher die Schwellwert Callbacks

ausgelöst werden, wenn die Schwellwerte

weiterhin erreicht bleiben.

BrickletRotaryPoti.get_debounce_period()
Rückgabe:
  • debounce – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 100

Gibt die Entprellperiode zurück, wie von set_debounce_period() gesetzt.

Callbacks

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)

rotary_poti.register_callback(BrickletRotaryPoti.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.

BrickletRotaryPoti.CALLBACK_POSITION
Callback-Parameter:
  • position – Typ: int, Einheit: 1 °, Wertebereich: [-150 bis 150]

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

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

BrickletRotaryPoti.CALLBACK_ANALOG_VALUE
Callback-Parameter:
  • value – Typ: int, Wertebereich: [0 bis 4096]

Dieser Callback wird mit der Periode, wie gesetzt mit set_analog_value_callback_period(), ausgelöst. Der Parameter ist der Analogwert des Drehpotentiometers.

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

BrickletRotaryPoti.CALLBACK_POSITION_REACHED
Callback-Parameter:
  • position – Typ: int, Einheit: 1 °, Wertebereich: [-150 bis 150]

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

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

BrickletRotaryPoti.CALLBACK_ANALOG_VALUE_REACHED
Callback-Parameter:
  • value – Typ: int, Wertebereich: [0 bis 4096]

Dieser Callback wird ausgelöst, wenn der Schwellwert, wie von set_analog_value_callback_threshold() gesetzt, erreicht wird. Der Parameter ist der Analogwert des Drehpotentiometers.

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

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.

BrickletRotaryPoti.get_api_version()
Rückgabeobjekt:
  • api_version – Typ: [int, ...], Länge: 3
    • 0: major – Typ: int, Wertebereich: [0 bis 255]
    • 1: minor – Typ: int, Wertebereich: [0 bis 255]
    • 2: revision – Typ: int, 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.

BrickletRotaryPoti.get_response_expected(function_id)
Parameter:
  • function_id – Typ: int, Wertebereich: Siehe Konstanten
Rückgabe:
  • response_expected – Typ: bool

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:

  • BrickletRotaryPoti.FUNCTION_SET_POSITION_CALLBACK_PERIOD = 3
  • BrickletRotaryPoti.FUNCTION_SET_ANALOG_VALUE_CALLBACK_PERIOD = 5
  • BrickletRotaryPoti.FUNCTION_SET_POSITION_CALLBACK_THRESHOLD = 7
  • BrickletRotaryPoti.FUNCTION_SET_ANALOG_VALUE_CALLBACK_THRESHOLD = 9
  • BrickletRotaryPoti.FUNCTION_SET_DEBOUNCE_PERIOD = 11
BrickletRotaryPoti.set_response_expected(function_id, response_expected)
Parameter:
  • function_id – Typ: int, Wertebereich: Siehe Konstanten
  • response_expected – Typ: bool
Rückgabe:
  • None

Ä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:

  • BrickletRotaryPoti.FUNCTION_SET_POSITION_CALLBACK_PERIOD = 3
  • BrickletRotaryPoti.FUNCTION_SET_ANALOG_VALUE_CALLBACK_PERIOD = 5
  • BrickletRotaryPoti.FUNCTION_SET_POSITION_CALLBACK_THRESHOLD = 7
  • BrickletRotaryPoti.FUNCTION_SET_ANALOG_VALUE_CALLBACK_THRESHOLD = 9
  • BrickletRotaryPoti.FUNCTION_SET_DEBOUNCE_PERIOD = 11
BrickletRotaryPoti.set_response_expected_all(response_expected)
Parameter:
  • response_expected – Typ: bool
Rückgabe:
  • None

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

Konstanten

BrickletRotaryPoti.DEVICE_IDENTIFIER

Diese Konstante wird verwendet um ein Rotary Poti 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.

BrickletRotaryPoti.DEVICE_DISPLAY_NAME

Diese Konstante stellt den Anzeigenamen eines Rotary Poti Bricklet dar.