Dies ist die Beschreibung der Shell 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 Shell API Bindings ist Teil deren allgemeine Beschreibung.
Der folgende Beispielcode ist Public Domain (CC0 1.0).
1#!/bin/sh
2# Connects to localhost:4223 by default, use --host and --port to change this
3
4uid=XYZ # Change XYZ to the UID of your RGB LED Bricklet
5
6# Set light blue color
7tinkerforge call rgb-led-bricklet $uid set-rgb-value 0 170 234
Mögliche Exit Codes für alle tinkerforge Befehle sind:
1: Unterbrochen (Ctrl+C)
2: Syntaxfehler
21: Python 2.5 oder neuer wird benötigt
22: Python argparse Modul fehlt
23: Socket-Fehler
24: Andere Exception
25: Ungültiger Platzhalter in Format-String
26: Authentifizierungsfehler
201: Timeout ist aufgetreten
209: Ungültiger Argumentwert
210: Funktion wird nicht unterstützt
211: Unbekannter Fehler
Allgemeine Optionen des call und des dispatch Befehls sind
hier zu finden. Im Folgenden wird die spezifische
Befehlsstruktur dargestellt.
| Parameter: |
|
|---|
Der call Befehl wird verwendet um eine Funktion des RGB LED Bricklet aufzurufen. Der
Befehl kennt mehrere Optionen:
--help zeigt Hilfe für den spezifischen call Befehl an und endet dann
--list-functions zeigt eine Liste der bekannten Funktionen des RGB LED Bricklet an
und endet dann
| Parameter: |
|
|---|
Der dispatch Befehl wird verwendet um eingehende Callbacks des RGB LED Bricklet
abzufertigen. Der Befehl kennt mehrere Optionen:
--help zeigt Hilfe für den spezifischen dispatch Befehl an und endet
dann
--list-callbacks zeigt eine Liste der bekannten Callbacks des RGB LED Bricklet an
und endet dann
| Parameter: |
|
|---|
Abhängig von der Art der aufzurufenden <function> kennt diese verschiedene
Optionen. Alle Funktionen kennen die folgenden Optionen:
--help zeigt Hilfe für die spezifische <function> an und endet dann
Getter-Funktionen kennen zusätzlich die folgenden Optionen:
--execute <command> Shell-Befehl der für jede eingehende Antwort
ausgeführt wird (siehe den Abschnitt über Ausgabeformatierung für Details)
Setter-Funktionen kennen zusätzlich die folgenden Optionen:
--expect-response fragt Antwort an und wartet auf diese
Mit der --expect-response Option für Setter-Funktionen können Timeouts und
andere Fehlerfälle auch für Aufrufe von Setter-Funktionen detektiert werden.
Das Gerät sendet dann eine Antwort extra für diesen Zweck. Wenn diese Option
für eine Setter-Funktion nicht angegeben ist, dann wird keine Antwort vom
Gerät gesendet und Fehler werden stillschweigend ignoriert, da sie nicht
detektiert werden können.
| Parameter: |
|
|---|
Der abzufertigende <callback> kennt mehrere Optionen:
--help zeigt Hilfe für den spezifische <callback> an und endet dann
--execute <command> Shell-Befehlszeile der für jede eingehende Antwort
ausgeführt wird (siehe den Abschnitt über Ausgabeformatierung für Details)
| Parameter: |
|
|---|---|
| Ausgabe: |
|
Setzt die r, g und b Werte für die LED.
| Ausgabe: |
|
|---|
Gibt die r, g und b Werte der LED zurück, wie von set-rgb-value gesetzt.
| Ausgabe: |
|
|---|
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.