Python - Dual Button Bricklet¶

Dies ist die Beschreibung der Python API Bindings für das Dual Button Bricklet. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des Dual Button 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).

Callback¶

Download (example_callback.py)

#!/usr/bin/env python
# -*- coding: utf-8 -*-

HOST = "localhost"
PORT = 4223
UID = "XYZ" # Change XYZ to the UID of your Dual Button Bricklet

from tinkerforge.ip_connection import IPConnection
from tinkerforge.bricklet_dual_button import BrickletDualButton

# Callback function for state changed callback
def cb_state_changed(button_l, button_r, led_l, led_r):
    if button_l == BrickletDualButton.BUTTON_STATE_PRESSED:
        print("Left Button: Pressed")
    elif button_l == BrickletDualButton.BUTTON_STATE_RELEASED:
        print("Left Button: Released")

    if button_r == BrickletDualButton.BUTTON_STATE_PRESSED:
        print("Right Button: Pressed")
    elif button_r == BrickletDualButton.BUTTON_STATE_RELEASED:
        print("Right Button: Released")

    print("")

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

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

    # Register state changed callback to function cb_state_changed
    db.register_callback(db.CALLBACK_STATE_CHANGED, cb_state_changed)

    input("Press key to exit\n") # Use raw_input() in Python 2
    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
Error.WRONG_DEVICE_TYPE = -15
Error.DEVICE_REPLACED = -16
Error.WRONG_RESPONSE_LENGTH = -17

Alle folgend aufgelisteten Funktionen sind Thread-sicher.

Grundfunktionen¶

BrickletDualButton(uid, ipcon)¶

Parameter:	uid – Typ: str ipcon – Typ: IPConnection
Rückgabe:	dual_button – Typ: BrickletDualButton

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

dual_button = BrickletDualButton("YOUR_DEVICE_UID", ipcon)

Dieses Objekt kann benutzt werden, nachdem die IP Connection verbunden ist.

BrickletDualButton.set_led_state(led_l, led_r)¶

Parameter:	led_l – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 1 led_r – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 1
Rückgabe:	None

Setzt den Zustand der LEDs. Möglich Zustände sind:

0 = AutoToggleOn: Aktiviert Auto-Toggle und anfänglich aktiviert LED
1 = AutoToggleOff: Aktiviert Auto-Toggle und anfänglich deaktiviert LED.
2 = On: Aktiviert LED (Auto-Toggle is deaktiviert).
3 = Off: Deaktiviert LED (Auto-Toggle is deaktiviert).

Im Auto-Toggle Modus wechselt die LED automatisch zwischen aus und an bei jedem Tasterdruck.

Wenn nur eine der LEDs gesetzt werden soll und der aktuelle Zustand der anderen LED nicht bekannt ist, dann kann der Zustand mit get_led_state() ausgelesen werden oder es kann set_selected_led_state() genutzt werden.

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

Für led_l:

BrickletDualButton.LED_STATE_AUTO_TOGGLE_ON = 0
BrickletDualButton.LED_STATE_AUTO_TOGGLE_OFF = 1
BrickletDualButton.LED_STATE_ON = 2
BrickletDualButton.LED_STATE_OFF = 3

Für led_r:

BrickletDualButton.LED_STATE_AUTO_TOGGLE_ON = 0
BrickletDualButton.LED_STATE_AUTO_TOGGLE_OFF = 1
BrickletDualButton.LED_STATE_ON = 2
BrickletDualButton.LED_STATE_OFF = 3

BrickletDualButton.get_led_state()¶

Rückgabeobjekt:	led_l – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 1 led_r – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 1

Gibt den aktuellen Zustand der LEDs zurück, wie von set_led_state() gesetzt.

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

Für led_l:

BrickletDualButton.LED_STATE_AUTO_TOGGLE_ON = 0
BrickletDualButton.LED_STATE_AUTO_TOGGLE_OFF = 1
BrickletDualButton.LED_STATE_ON = 2
BrickletDualButton.LED_STATE_OFF = 3

Für led_r:

BrickletDualButton.LED_STATE_AUTO_TOGGLE_ON = 0
BrickletDualButton.LED_STATE_AUTO_TOGGLE_OFF = 1
BrickletDualButton.LED_STATE_ON = 2
BrickletDualButton.LED_STATE_OFF = 3

BrickletDualButton.get_button_state()¶

Rückgabeobjekt:	button_l – Typ: int, Wertebereich: Siehe Konstanten button_r – Typ: int, Wertebereich: Siehe Konstanten

Gibt den aktuellen Zustand beider Taster zurück. Mögliche Zustände sind:

0 = pressed (gedrückt)
1 = released (losgelassen)

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

Für button_l:

BrickletDualButton.BUTTON_STATE_PRESSED = 0
BrickletDualButton.BUTTON_STATE_RELEASED = 1

Für button_r:

BrickletDualButton.BUTTON_STATE_PRESSED = 0
BrickletDualButton.BUTTON_STATE_RELEASED = 1

Fortgeschrittene Funktionen¶

BrickletDualButton.set_selected_led_state(led, state)¶

Parameter:	led – Typ: int, Wertebereich: Siehe Konstanten state – Typ: int, Wertebereich: Siehe Konstanten
Rückgabe:	None

Setzt den Zustand der selektierten LED (0 oder 1).

Die andere LED bleibt unangetastet.

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

Für led:

BrickletDualButton.LED_LEFT = 0
BrickletDualButton.LED_RIGHT = 1

Für state:

BrickletDualButton.LED_STATE_AUTO_TOGGLE_ON = 0
BrickletDualButton.LED_STATE_AUTO_TOGGLE_OFF = 1
BrickletDualButton.LED_STATE_ON = 2
BrickletDualButton.LED_STATE_OFF = 3

BrickletDualButton.get_identity()¶

Rückgabeobjekt:

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", "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 2¹⁶ - 1]

uid – Typ: str, Länge: bis zu 8
connected_uid – Typ: str, Länge: bis zu 8
position – Typ: chr, Wertebereich: ["a" bis "h", "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 2¹⁶ - 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 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.

Konfigurationsfunktionen für Callbacks¶

BrickletDualButton.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.

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)

dual_button.register_callback(BrickletDualButton.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.

BrickletDualButton.CALLBACK_STATE_CHANGED¶

Callback-Parameter:	button_l – Typ: int, Wertebereich: Siehe Konstanten button_r – Typ: int, Wertebereich: Siehe Konstanten led_l – Typ: int, Wertebereich: Siehe Konstanten led_r – Typ: int, Wertebereich: Siehe Konstanten

Dieser Callback wird aufgerufen wenn einer der Taster gedrückt wird.

Mögliche Zustände der Taster sind:

0 = pressed (gedrückt)
1 = released (losgelassen)

Mögliche Zustände der LEDs sind:

0 = AutoToggleOn: Auto-Toggle aktiv und LED an.
1 = AutoToggleOff: Auto-Toggle aktiv und LED aus.
2 = On: Aktiviert LED (Auto-Toggle ist deaktiviert).
3 = Off: Deaktiviert LED (Auto-Toggle ist deaktiviert).

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

Für button_l:

BrickletDualButton.BUTTON_STATE_PRESSED = 0
BrickletDualButton.BUTTON_STATE_RELEASED = 1

Für button_r:

BrickletDualButton.BUTTON_STATE_PRESSED = 0
BrickletDualButton.BUTTON_STATE_RELEASED = 1

Für led_l:

BrickletDualButton.LED_STATE_AUTO_TOGGLE_ON = 0
BrickletDualButton.LED_STATE_AUTO_TOGGLE_OFF = 1
BrickletDualButton.LED_STATE_ON = 2
BrickletDualButton.LED_STATE_OFF = 3

Für led_r:

BrickletDualButton.LED_STATE_AUTO_TOGGLE_ON = 0
BrickletDualButton.LED_STATE_AUTO_TOGGLE_OFF = 1
BrickletDualButton.LED_STATE_ON = 2
BrickletDualButton.LED_STATE_OFF = 3

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.

BrickletDualButton.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.

BrickletDualButton.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:

BrickletDualButton.FUNCTION_SET_LED_STATE = 1
BrickletDualButton.FUNCTION_SET_SELECTED_LED_STATE = 5

BrickletDualButton.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.

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

Für function_id:

BrickletDualButton.FUNCTION_SET_LED_STATE = 1
BrickletDualButton.FUNCTION_SET_SELECTED_LED_STATE = 5

BrickletDualButton.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¶

BrickletDualButton.DEVICE_IDENTIFIER¶

Diese Konstante wird verwendet um ein Dual Button 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.

BrickletDualButton.DEVICE_DISPLAY_NAME¶: Diese Konstante stellt den Anzeigenamen eines Dual Button Bricklet dar.