Python - RGB LED Bricklet

Dies ist die Beschreibung der Python API Bindings für das RGB LED Bricklet. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des RGB LED 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
#!/usr/bin/env python
# -*- coding: utf-8 -*-

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

from tinkerforge.ip_connection import IPConnection
from tinkerforge.bricklet_rgb_led import BrickletRGBLED

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

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

    # Set light blue color
    rl.set_rgb_value(0, 170, 234)

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

Rainbow

Download (example_rainbow.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 = "zHN" # Change to your UID

from tinkerforge.ip_connection import IPConnection
from tinkerforge.bricklet_rgb_led import BrickletRGBLED

import colorsys
import time

SECONDS_PER_ROUND = 1.5
COLORS_PER_ROUND = 256

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

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

    print("Press ctrl+c to exit")

    while True:
        for i in range(COLORS_PER_ROUND):
            r, g, b = colorsys.hsv_to_rgb(1.0*i/COLORS_PER_ROUND, 1, 0.1) # Calculate color
            rl.set_rgb_value(int(r*255), int(g*255), int(b*255)) # Set color

            time.sleep(SECONDS_PER_ROUND/COLORS_PER_ROUND) # Wait for next color change

    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

BrickletRGBLED(uid, ipcon)
Parameter:
  • uid – Typ: str
  • ipcon – Typ: IPConnection
Rückgabe:
  • rgb_led – Typ: BrickletRGBLED

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

rgb_led = BrickletRGBLED("YOUR_DEVICE_UID", ipcon)

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

BrickletRGBLED.set_rgb_value(r, g, b)
Parameter:
  • r – Typ: int, Wertebereich: [0 bis 255]
  • g – Typ: int, Wertebereich: [0 bis 255]
  • b – Typ: int, Wertebereich: [0 bis 255]
Rückgabe:
  • None

Setzt die r, g und b Werte für die LED. Jeder Wert kann zwischen 0 und 255 liegen.

BrickletRGBLED.get_rgb_value()
Rückgabeobjekt:
  • r – Typ: int, Wertebereich: [0 bis 255]
  • g – Typ: int, Wertebereich: [0 bis 255]
  • b – Typ: int, Wertebereich: [0 bis 255]

Gibt die r, g und b Werte der LED zurück, wie von set_rgb_value() gesetzt.

Fortgeschrittene Funktionen

BrickletRGBLED.get_api_version()
Rückgabe:
  • api_version – Typ: [int, ...], Länge: 3, Wertebereich: [0 bis 255]

Gibt die Version der API Definition (Major, Minor, Revision) 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.

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

  • BrickletRGBLED.FUNCTION_SET_RGB_VALUE = 1
BrickletRGBLED.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:

  • BrickletRGBLED.FUNCTION_SET_RGB_VALUE = 1
BrickletRGBLED.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.

BrickletRGBLED.get_identity()
Rückgabeobjekt:
  • uid – Typ: str, Länge: bis zu 8
  • connected_uid – Typ: str, Länge: bis zu 8
  • position – Typ: chr
  • hardware_version – Typ: [int, ...], Länge: 3, Wertebereich: [0 bis 255]
  • firmware_version – Typ: [int, ...], Länge: 3, 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 kann 'a', 'b', 'c' oder 'd' sein.

Eine Liste der Device Identifier Werte ist hier zu finden. Es gibt auch eine Konstante für den Device Identifier dieses Bricklets.

Konstanten

BrickletRGBLED.DEVICE_IDENTIFIER

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

BrickletRGBLED.DEVICE_DISPLAY_NAME

Diese Konstante stellt den Anzeigenamen eines RGB LED Bricklet dar.