Python - RGB LED Button Bricklet

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

Simple Color

Download (example_simple_color.py)

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

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

from tinkerforge.ip_connection import IPConnection
from tinkerforge.bricklet_rgb_led_button import BrickletRGBLEDButton

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

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

    # Set light blue color
    rlb.set_color(0, 170, 234)

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

Simple Button

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

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

from tinkerforge.ip_connection import IPConnection
from tinkerforge.bricklet_rgb_led_button import BrickletRGBLEDButton

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

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

    # Get current button state
    state = rlb.get_button_state()

    if state == rlb.BUTTON_STATE_PRESSED:
        print("State: Pressed")
    elif state == rlb.BUTTON_STATE_RELEASED:
        print("State: Released")

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

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

from tinkerforge.ip_connection import IPConnection
from tinkerforge.bricklet_rgb_led_button import BrickletRGBLEDButton

# Callback function for button state changed callback
def cb_button_state_changed(state):
    if state == BrickletRGBLEDButton.BUTTON_STATE_PRESSED:
        print("State: Pressed")
    elif state == BrickletRGBLEDButton.BUTTON_STATE_RELEASED:
        print("State: Released")

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

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

    # Register button state changed callback to function cb_button_state_changed
    rlb.register_callback(rlb.CALLBACK_BUTTON_STATE_CHANGED, cb_button_state_changed)

    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

BrickletRGBLEDButton(uid, ipcon)
Parameter:
  • uid – Typ: str
  • ipcon – Typ: IPConnection
Rückgabe:
  • rgb_led_button – Typ: BrickletRGBLEDButton

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

rgb_led_button = BrickletRGBLEDButton("YOUR_DEVICE_UID", ipcon)

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

BrickletRGBLEDButton.set_color(red, green, blue)
Parameter:
  • red – Typ: int, Wertebereich: [0 bis 255], Standardwert: 0
  • green – Typ: int, Wertebereich: [0 bis 255], Standardwert: 0
  • blue – Typ: int, Wertebereich: [0 bis 255], Standardwert: 0
Rückgabe:
  • None

Setzt die LED-Farbe.

BrickletRGBLEDButton.get_color()
Rückgabeobjekt:
  • red – Typ: int, Wertebereich: [0 bis 255], Standardwert: 0
  • green – Typ: int, Wertebereich: [0 bis 255], Standardwert: 0
  • blue – Typ: int, Wertebereich: [0 bis 255], Standardwert: 0

Gibt die LED-Farbe zurück, wie von set_color() gesetzt.

BrickletRGBLEDButton.get_button_state()
Rückgabe:
  • state – Typ: int, Wertebereich: Siehe Konstanten

Gibt den aktuellen Zustand des Knopfes zurück (entweder gedrückt oder nicht gedrückt).

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

Für state:

  • BrickletRGBLEDButton.BUTTON_STATE_PRESSED = 0
  • BrickletRGBLEDButton.BUTTON_STATE_RELEASED = 1
BrickletRGBLEDButton.get_color_calibration()
Rückgabeobjekt:
  • red – Typ: int, Einheit: 1 %, Wertebereich: [0 bis 100], Standardwert: 100
  • green – Typ: int, Einheit: 1 %, Wertebereich: [0 bis 100], Standardwert: 100
  • blue – Typ: int, Einheit: 1 %, Wertebereich: [0 bis 100], Standardwert: 55

Gibt die Farbwert-Kalibrierung zurück, wie von set_color_calibration() gesetzt.

Fortgeschrittene Funktionen

BrickletRGBLEDButton.set_color_calibration(red, green, blue)
Parameter:
  • red – Typ: int, Einheit: 1 %, Wertebereich: [0 bis 100], Standardwert: 100
  • green – Typ: int, Einheit: 1 %, Wertebereich: [0 bis 100], Standardwert: 100
  • blue – Typ: int, Einheit: 1 %, Wertebereich: [0 bis 100], Standardwert: 55
Rückgabe:
  • None

Setzt die Farbwert-Kalibrierung. Einige Farben erscheinen heller als andere, daher kann eine Kalibrierung nötig sein um gleichmäßige Farben zu erzielen.

Die Kalibrierung wird im Flash des Bricklets gespeichert und muss daher nicht bei jedem Start erneut vorgenommen werden.

BrickletRGBLEDButton.get_spitfp_error_count()
Rückgabeobjekt:
  • error_count_ack_checksum – Typ: int, Wertebereich: [0 bis 232 - 1]
  • error_count_message_checksum – Typ: int, Wertebereich: [0 bis 232 - 1]
  • error_count_frame – Typ: int, Wertebereich: [0 bis 232 - 1]
  • error_count_overflow – Typ: int, Wertebereich: [0 bis 232 - 1]

Gibt die Anzahl der Fehler die während der Kommunikation zwischen Brick und Bricklet aufgetreten sind zurück.

Die Fehler sind aufgeteilt in

  • ACK-Checksummen Fehler,
  • Message-Checksummen Fehler,
  • Framing Fehler und
  • Overflow Fehler.

Die Fehlerzähler sind für Fehler die auf der Seite des Bricklets auftreten. Jedes Brick hat eine ähnliche Funktion welche die Fehler auf Brickseite ausgibt.

BrickletRGBLEDButton.set_bootloader_mode(mode)
Parameter:
  • mode – Typ: int, Wertebereich: Siehe Konstanten
Rückgabe:
  • status – Typ: int, Wertebereich: Siehe Konstanten

Setzt den Bootloader-Modus und gibt den Status zurück nachdem die Modusänderungsanfrage bearbeitet wurde.

Mit dieser Funktion ist es möglich vom Bootloader- in den Firmware-Modus zu wechseln und umgekehrt. Ein Welchsel vom Bootloader- in der den Firmware-Modus ist nur möglich wenn Entry-Funktion, Device Identifier und CRC vorhanden und korrekt sind.

Diese Funktion wird vom Brick Viewer während des Flashens benutzt. In einem normalem Nutzerprogramm sollte diese Funktion nicht benötigt werden.

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

Für mode:

  • BrickletRGBLEDButton.BOOTLOADER_MODE_BOOTLOADER = 0
  • BrickletRGBLEDButton.BOOTLOADER_MODE_FIRMWARE = 1
  • BrickletRGBLEDButton.BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
  • BrickletRGBLEDButton.BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
  • BrickletRGBLEDButton.BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4

Für status:

  • BrickletRGBLEDButton.BOOTLOADER_STATUS_OK = 0
  • BrickletRGBLEDButton.BOOTLOADER_STATUS_INVALID_MODE = 1
  • BrickletRGBLEDButton.BOOTLOADER_STATUS_NO_CHANGE = 2
  • BrickletRGBLEDButton.BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT = 3
  • BrickletRGBLEDButton.BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT = 4
  • BrickletRGBLEDButton.BOOTLOADER_STATUS_CRC_MISMATCH = 5
BrickletRGBLEDButton.get_bootloader_mode()
Rückgabe:
  • mode – Typ: int, Wertebereich: Siehe Konstanten

Gibt den aktuellen Bootloader-Modus zurück, siehe set_bootloader_mode().

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

Für mode:

  • BrickletRGBLEDButton.BOOTLOADER_MODE_BOOTLOADER = 0
  • BrickletRGBLEDButton.BOOTLOADER_MODE_FIRMWARE = 1
  • BrickletRGBLEDButton.BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
  • BrickletRGBLEDButton.BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
  • BrickletRGBLEDButton.BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4
BrickletRGBLEDButton.set_write_firmware_pointer(pointer)
Parameter:
  • pointer – Typ: int, Einheit: 1 B, Wertebereich: [0 bis 232 - 1]
Rückgabe:
  • None

Setzt den Firmware-Pointer für write_firmware(). Der Pointer muss um je 64 Byte erhöht werden. Die Daten werden alle 4 Datenblöcke in den Flash geschrieben (4 Datenblöcke entsprechen einer Page mit 256 Byte).

Diese Funktion wird vom Brick Viewer während des flashens benutzt. In einem normalem Nutzerprogramm sollte diese Funktion nicht benötigt werden.

BrickletRGBLEDButton.write_firmware(data)
Parameter:
  • data – Typ: [int, ...], Länge: 64, Wertebereich: [0 bis 255]
Rückgabe:
  • status – Typ: int, Wertebereich: [0 bis 255]

Schreibt 64 Bytes Firmware an die Position die vorher von set_write_firmware_pointer() gesetzt wurde. Die Firmware wird alle 4 Datenblöcke in den Flash geschrieben.

Eine Firmware kann nur im Bootloader-Mode geschrieben werden.

Diese Funktion wird vom Brick Viewer während des flashens benutzt. In einem normalem Nutzerprogramm sollte diese Funktion nicht benötigt werden.

BrickletRGBLEDButton.set_status_led_config(config)
Parameter:
  • config – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 3
Rückgabe:
  • None

Setzt die Konfiguration der Status-LED. Standardmäßig zeigt die LED die Kommunikationsdatenmenge an. Sie blinkt einmal auf pro 10 empfangenen Datenpaketen zwischen Brick und Bricklet.

Die LED kann auch permanent an/aus gestellt werden oder einen Herzschlag anzeigen.

Wenn das Bricklet sich im Bootlodermodus befindet ist die LED aus.

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

Für config:

  • BrickletRGBLEDButton.STATUS_LED_CONFIG_OFF = 0
  • BrickletRGBLEDButton.STATUS_LED_CONFIG_ON = 1
  • BrickletRGBLEDButton.STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • BrickletRGBLEDButton.STATUS_LED_CONFIG_SHOW_STATUS = 3
BrickletRGBLEDButton.get_status_led_config()
Rückgabe:
  • config – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 3

Gibt die Konfiguration zurück, wie von set_status_led_config() gesetzt.

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

Für config:

  • BrickletRGBLEDButton.STATUS_LED_CONFIG_OFF = 0
  • BrickletRGBLEDButton.STATUS_LED_CONFIG_ON = 1
  • BrickletRGBLEDButton.STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • BrickletRGBLEDButton.STATUS_LED_CONFIG_SHOW_STATUS = 3
BrickletRGBLEDButton.get_chip_temperature()
Rückgabe:
  • temperature – Typ: int, Einheit: 1 °C, Wertebereich: [-215 bis 215 - 1]

Gibt die Temperatur, gemessen im Mikrocontroller, aus. Der Rückgabewert ist nicht die Umgebungstemperatur.

Die Temperatur ist lediglich proportional zur echten Temperatur und hat eine hohe Ungenauigkeit. Daher beschränkt sich der praktische Nutzen auf die Indikation von Temperaturveränderungen.

BrickletRGBLEDButton.reset()
Rückgabe:
  • None

Ein Aufruf dieser Funktion setzt das Bricklet zurück. Nach einem Neustart sind alle Konfiguration verloren.

Nach dem Zurücksetzen ist es notwendig neue Objekte zu erzeugen, Funktionsaufrufe auf bestehenden führen zu undefiniertem Verhalten.

BrickletRGBLEDButton.write_uid(uid)
Parameter:
  • uid – Typ: int, Wertebereich: [0 bis 232 - 1]
Rückgabe:
  • None

Schreibt eine neue UID in den Flash. Die UID muss zuerst vom Base58 encodierten String in einen Integer decodiert werden.

Wir empfehlen die Nutzung des Brick Viewers zum ändern der UID.

BrickletRGBLEDButton.read_uid()
Rückgabe:
  • uid – Typ: int, Wertebereich: [0 bis 232 - 1]

Gibt die aktuelle UID als Integer zurück. Dieser Integer kann als Base58 encodiert werden um an den üblichen UID-String zu gelangen.

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

BrickletRGBLEDButton.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)

rgb_led_button.register_callback(BrickletRGBLEDButton.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.

BrickletRGBLEDButton.CALLBACK_BUTTON_STATE_CHANGED
Callback-Parameter:
  • state – Typ: int, Wertebereich: Siehe Konstanten

Dieser Callback wird jedes mal ausgelöst, wenn sich der Zustand es Knopfes ändert von gedrückt zu nicht gedrückt oder anders herum

Der Parameter ist der aktuelle Zustand des Knopfes.

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

Für state:

  • BrickletRGBLEDButton.BUTTON_STATE_PRESSED = 0
  • BrickletRGBLEDButton.BUTTON_STATE_RELEASED = 1

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.

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

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

  • BrickletRGBLEDButton.FUNCTION_SET_COLOR = 1
  • BrickletRGBLEDButton.FUNCTION_SET_COLOR_CALIBRATION = 5
  • BrickletRGBLEDButton.FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
  • BrickletRGBLEDButton.FUNCTION_SET_STATUS_LED_CONFIG = 239
  • BrickletRGBLEDButton.FUNCTION_RESET = 243
  • BrickletRGBLEDButton.FUNCTION_WRITE_UID = 248
BrickletRGBLEDButton.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:

  • BrickletRGBLEDButton.FUNCTION_SET_COLOR = 1
  • BrickletRGBLEDButton.FUNCTION_SET_COLOR_CALIBRATION = 5
  • BrickletRGBLEDButton.FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
  • BrickletRGBLEDButton.FUNCTION_SET_STATUS_LED_CONFIG = 239
  • BrickletRGBLEDButton.FUNCTION_RESET = 243
  • BrickletRGBLEDButton.FUNCTION_WRITE_UID = 248
BrickletRGBLEDButton.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

BrickletRGBLEDButton.DEVICE_IDENTIFIER

Diese Konstante wird verwendet um ein RGB LED 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.

BrickletRGBLEDButton.DEVICE_DISPLAY_NAME

Diese Konstante stellt den Anzeigenamen eines RGB LED Button Bricklet dar.