Shell - Color Bricklet

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

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

Beispiele

Der folgende Beispielcode ist Public Domain (CC0 1.0).

Simple

Download (example-simple.sh)

1
2
3
4
5
6
7
#!/bin/sh
# Connects to localhost:4223 by default, use --host and --port to change this

uid=XYZ # Change XYZ to the UID of your Color Bricklet

# Get current color
tinkerforge call color-bricklet $uid get-color

Callback

Download (example-callback.sh)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
#!/bin/sh
# Connects to localhost:4223 by default, use --host and --port to change this

uid=XYZ # Change XYZ to the UID of your Color Bricklet

# Handle incoming color callbacks
tinkerforge dispatch color-bricklet $uid color &

# Set period for color callback to 1s (1000ms)
# Note: The color callback is only called every second
#       if the color has changed since the last call!
tinkerforge call color-bricklet $uid set-color-callback-period 1000

echo "Press key to exit"; read dummy

kill -- -$$ # Stop callback dispatch in background

Threshold

Download (example-threshold.sh)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
#!/bin/sh
# Connects to localhost:4223 by default, use --host and --port to change this

uid=XYZ # Change XYZ to the UID of your Color Bricklet

# Get threshold callbacks with a debounce time of 10 seconds (10000ms)
tinkerforge call color-bricklet $uid set-debounce-period 10000

# Handle incoming color reached callbacks
tinkerforge dispatch color-bricklet $uid color-reached &

# Configure threshold for color "greater than 100, 200, 300, 400"
tinkerforge call color-bricklet $uid set-color-callback-threshold threshold-option-greater 100 0 200 0 300 0 400 0

echo "Press key to exit"; read dummy

kill -- -$$ # Stop callback dispatch in background

API

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

Befehlsstruktur

Allgemeine Optionen des call und des dispatch Befehls sind hier zu finden. Im Folgenden wird die spezifische Befehlsstruktur dargestellt.

tinkerforge call color-bricklet [<option>..] <uid> <function> [<argument>..]
Parameter:
  • <uid> -- string
  • <function> -- string

Der call Befehl wird verwendet um eine Funktion des Color 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 Color Bricklet an und endet dann
tinkerforge dispatch color-bricklet [<option>..] <uid> <callback>
Parameter:
  • <uid> -- string
  • <callback> -- string

Der dispatch Befehl wird verwendet um eingehende Callbacks des Color 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 Color Bricklet an und endet dann
tinkerforge call color-bricklet <uid> <function> [<option>..] [<argument>..]
Parameter:
  • <uid> -- string
  • <function> -- string

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.

tinkerforge dispatch color-bricklet <uid> <callback> [<option>..]
Parameter:
  • <uid> -- string
  • <callback> -- string

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)

Grundfunktionen

tinkerforge call color-bricklet <uid> get-color
Ausgabe:
  • r -- int
  • g -- int
  • b -- int
  • c -- int

Gibt die gemessene Farbe des Sensors zurück. Der Wertebereich ist von 0 bis 65535.

Die rot (r), grün (g), blau (b) und clear (c) werden mit vier unterschiedlichen Fotodioden gemessen. Diese sind Empfindlich in unterschiedlichen Wellenlängen:

Chart Responsivity / Wavelength

Wenn die Farbe periodisch abgefragt werden soll, wird empfohlen den color Callback zu nutzen und die Periode mit set-color-callback-period vorzugeben.

tinkerforge call color-bricklet <uid> light-on
Ausgabe:keine Ausgabe

Aktiviert die LED.

tinkerforge call color-bricklet <uid> light-off
Ausgabe:keine Ausgabe

Deaktiviert die LED.

tinkerforge call color-bricklet <uid> is-light-on
Ausgabe:
  • light -- int (hat Symbole)

Gibt den Zustand der LED zurück. Mögliche Werte sind:

  • 0: On
  • 1: Off

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

  • light-on = 0, für light
  • light-off = 1, für light
tinkerforge call color-bricklet <uid> set-config <gain> <integration-time>
Parameter:
  • <gain> -- int (hat Symbole)
  • <integration-time> -- int (hat Symbole)
Ausgabe:

keine Ausgabe

Setzt die Konfiguration des Sensors. Verstärkung und Integrationszeit können eingestellt werden.

Für die Konfiguration der Verstärkung:

  • 0: 1x Gain
  • 1: 4x Gain
  • 2: 16x Gain
  • 3: 60x Gain

Für die Konfiguration der Integrationszeit:

  • 0: 2,4ms
  • 1: 24ms
  • 2: 101ms
  • 3: 154ms
  • 4: 700ms

Eine Erhöhung der Verstärkung ermöglicht es dem Sensor Farben aus größeren Entfernungen zu erkennen.

Die Integrationszeit ist ein Trade-off zwischen Konvertierungszeit und Genauigkeit. Mit einer höheren Integrationszeit werden die Werte genauer, es dauert allerdings länger bis ein Resultat bereitsteht.

Die Standardwerte sind 60x Verstärkung und 154ms Integrationszeit.

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

  • gain-1x = 0, für <gain>
  • gain-4x = 1, für <gain>
  • gain-16x = 2, für <gain>
  • gain-60x = 3, für <gain>
  • integration-time-2ms = 0, für <integration-time>
  • integration-time-24ms = 1, für <integration-time>
  • integration-time-101ms = 2, für <integration-time>
  • integration-time-154ms = 3, für <integration-time>
  • integration-time-700ms = 4, für <integration-time>
tinkerforge call color-bricklet <uid> get-config
Ausgabe:
  • gain -- int (hat Symbole)
  • integration-time -- int (hat Symbole)

Gibt die Einstellungen zurück, wie von set-config gesetzt.

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

  • gain-1x = 0, für gain
  • gain-4x = 1, für gain
  • gain-16x = 2, für gain
  • gain-60x = 3, für gain
  • integration-time-2ms = 0, für integration-time
  • integration-time-24ms = 1, für integration-time
  • integration-time-101ms = 2, für integration-time
  • integration-time-154ms = 3, für integration-time
  • integration-time-700ms = 4, für integration-time
tinkerforge call color-bricklet <uid> get-illuminance
Ausgabe:
  • illuminance -- int

Gibt die Beleuchtungsstärke beeinflusst durch die Verstärkung und die Integrationszeit zurück. Verstärkung und Integrationszeit können mit set-config eingestellt werden. Um die Beleuchtungsstärke in Lux zu ermitteln muss folgende Formel angewendet werden:

lux = illuminance * 700 / gain / integration_time

Für eine korrekte Messung der Beleuchtungsstärke muss sichergestellt sein, dass die Farbwerte (R, G oder B) nicht saturiert sind. Ein Farbwert ist saturiert wenn der Wert 65535 beträgt. In diesem Fall kann die Verstärkung per set-config reduziert werden.

tinkerforge call color-bricklet <uid> get-color-temperature
Ausgabe:
  • color-temperature -- int

Gibt die Farbtemperatur in Kelvin zurück.

Für eine korrekte Messung der Farbtemperatur muss sichergestellt sein das die Farbwerte (R, G oder B) nicht saturiert sind. Ein Farbwert ist saturiert wenn der Wert 65535 beträgt. In diesem Fall kann die Verstärkung per set-config reduziert werden.

Fortgeschrittene Funktionen

tinkerforge call color-bricklet <uid> get-identity
Ausgabe:
  • uid -- string
  • connected-uid -- string
  • position -- char
  • hardware-version -- int,int,int
  • firmware-version -- int,int,int
  • device-identifier -- int (hat Symbole)

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. 

Konfigurationsfunktionen für Callbacks

tinkerforge call color-bricklet <uid> set-color-callback-period <period>
Parameter:
  • <period> -- int
Ausgabe:

keine Ausgabe

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

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

Der Standardwert ist 0.

tinkerforge call color-bricklet <uid> get-color-callback-period
Ausgabe:
  • period -- int

Gibt die Periode zurück, wie von set-color-callback-period gesetzt.

tinkerforge call color-bricklet <uid> set-color-callback-threshold <option> <min-r> <max-r> <min-g> <max-g> <min-b> <max-b> <min-c> <max-c>
Parameter:
  • <option> -- char (hat Symbole)
  • <min-r> -- int
  • <max-r> -- int
  • <min-g> -- int
  • <max-g> -- int
  • <min-b> -- int
  • <max-b> -- int
  • <min-c> -- int
  • <max-c> -- int
Ausgabe:

keine Ausgabe

Setzt den Schwellwert für den color-reached Callback.

Die folgenden Optionen sind möglich:

Option Beschreibung
'x' Callback ist inaktiv
'o' Callback wird ausgelöst wenn die Temperatur außerhalb des min und max Wertes ist
'i' Callback wird ausgelöst wenn die Temperatur innerhalb des min und max Wertes ist
'<' Callback wird ausgelöst wenn die Temperatur kleiner als der min Wert ist (max wird ignoriert)
'>' Callback wird ausgelöst wenn die Temperatur größer als der min Wert ist (max wird ignoriert)

Der Standardwert ist ('x', 0, 0, 0, 0, 0, 0, 0, 0).

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

  • threshold-option-off = x, für <option>
  • threshold-option-outside = o, für <option>
  • threshold-option-inside = i, für <option>
  • threshold-option-smaller = <, für <option>
  • threshold-option-greater = >, für <option>
tinkerforge call color-bricklet <uid> get-color-callback-threshold
Ausgabe:
  • option -- char (hat Symbole)
  • min-r -- int
  • max-r -- int
  • min-g -- int
  • max-g -- int
  • min-b -- int
  • max-b -- int
  • min-c -- int
  • max-c -- int

Gibt den Schwellwert zurück, wie von set-color-callback-threshold gesetzt.

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

  • threshold-option-off = x, für option
  • threshold-option-outside = o, für option
  • threshold-option-inside = i, für option
  • threshold-option-smaller = <, für option
  • threshold-option-greater = >, für option
tinkerforge call color-bricklet <uid> set-debounce-period <debounce>
Parameter:
  • <debounce> -- int
Ausgabe:

keine Ausgabe

Setzt die Periode in ms mit welcher die Schwellwert Callback

ausgelöst wird, wenn der Schwellwert

weiterhin erreicht bleibt.

Der Standardwert ist 100.

tinkerforge call color-bricklet <uid> get-debounce-period
Ausgabe:
  • debounce -- int

Gibt die Entprellperiode zurück, wie von set-debounce-period gesetzt.

tinkerforge call color-bricklet <uid> set-illuminance-callback-period <period>
Parameter:
  • <period> -- int
Ausgabe:

keine Ausgabe

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

Der illuminance Callback wird nur ausgelöst wenn sich die Beleuchtungsstärke seit der letzten Auslösung geändert hat.

Der Standardwert ist 0.

tinkerforge call color-bricklet <uid> get-illuminance-callback-period
Ausgabe:
  • period -- int

Gibt die Periode zurück, wie von set-illuminance-callback-period gesetzt.

tinkerforge call color-bricklet <uid> set-color-temperature-callback-period <period>
Parameter:
  • <period> -- int
Ausgabe:

keine Ausgabe

Setzt die Periode in ms mit welcher der color-temperature Callback ausgelöst wird. Ein Wert von 0 deaktiviert den Callback.

Der color-temperature Callback wird nur ausgelöst wenn sich die Farbtemperatur seit der letzten Auslösung geändert hat.

Der Standardwert ist 0.

tinkerforge call color-bricklet <uid> get-color-temperature-callback-period
Ausgabe:
  • period -- int

Gibt die Periode zurück, wie von set-color-temperature-callback-period gesetzt.

Callbacks

Callbacks können registriert werden um zeitkritische oder wiederkehrende Daten vom Gerät zu erhalten:

tinkerforge dispatch color-bricklet <uid> example

Die verfügbaren Callbacks 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.

tinkerforge dispatch color-bricklet <uid> color
Ausgabe:
  • r -- int
  • g -- int
  • b -- int
  • c -- int

Dieser Callback wird mit der Periode, wie gesetzt mit set-color-callback-period, ausgelöst. Der Parameter ist die Farbe des Sensors als RGBC.

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

tinkerforge dispatch color-bricklet <uid> color-reached
Ausgabe:
  • r -- int
  • g -- int
  • b -- int
  • c -- int

Dieser Callback wird ausgelöst wenn der Schwellwert, wie von set-color-callback-threshold gesetzt, erreicht wird. Der Parameter ist die Farbe des Sensors als RGBC.

Wenn der Schwellwert erreicht bleibt, wird der Callback mit der Periode, wie mit set-debounce-period gesetzt, ausgelöst.

tinkerforge dispatch color-bricklet <uid> illuminance
Ausgabe:
  • illuminance -- int

Dieser Callback wird mit der Periode, wie gesetzt mit set-illuminance-callback-period, ausgelöst. Der Parameter ist die Beleuchtungsstärke des Sensors. Siehe get-illuminance für eine Erklärung wie dieser zu interpretieren ist.

Der illuminance Callback wird nur ausgelöst wenn sich die Beleuchtungsstärke seit der letzten Auslösung geändert hat.

tinkerforge dispatch color-bricklet <uid> color-temperature
Ausgabe:
  • color-temperature -- int

Dieser Callback wird mit der Periode, wie gesetzt mit set-color-temperature-callback-period, ausgelöst. Der Parameter ist die Farbtemperatur des Sensors in Kelvin.

Der color-temperature Callback wird nur ausgelöst wenn sich die Farbtemperatur seit der letzten Auslösung geändert hat.