Shell - Color Bricklet¶

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

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> – Typ: String <function> – Typ: 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> – Typ: String <callback> – Typ: 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> – Typ: String <function> – Typ: 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> – Typ: String <callback> – Typ: 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 – Typ: Int, Wertebereich: [0 bis 216 - 1] g – Typ: Int, Wertebereich: [0 bis 216 - 1] b – Typ: Int, Wertebereich: [0 bis 216 - 1] c – Typ: Int, Wertebereich: [0 bis 216 - 1]

Gibt die gemessene Farbe des Sensors zurück.

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

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 – Typ: Int, Wertebereich: Siehe Symbole, Standardwert: 1

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:

Für light:

• light-on = 0
• light-off = 1

tinkerforge call color-bricklet <uid> set-config <gain> <integration-time>¶

Parameter:	<gain> – Typ: Int, Wertebereich: Siehe Symbole, Standardwert: 3 <integration-time> – Typ: Int, Wertebereich: Siehe Symbole, Standardwert: 3
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 folgenden Symbole sind für diese Funktion verfügbar:

Für <gain>:

• gain-1x = 0
• gain-4x = 1
• gain-16x = 2
• gain-60x = 3

Für <integration-time>:

• integration-time-2ms = 0
• integration-time-24ms = 1
• integration-time-101ms = 2
• integration-time-154ms = 3
• integration-time-700ms = 4

tinkerforge call color-bricklet <uid> get-config¶

Ausgabe:	gain – Typ: Int, Wertebereich: Siehe Symbole, Standardwert: 3 integration-time – Typ: Int, Wertebereich: Siehe Symbole, Standardwert: 3

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

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

Für gain:

• gain-1x = 0
• gain-4x = 1
• gain-16x = 2
• gain-60x = 3

Für integration-time:

• integration-time-2ms = 0
• integration-time-24ms = 1
• integration-time-101ms = 2
• integration-time-154ms = 3
• integration-time-700ms = 4

tinkerforge call color-bricklet <uid> get-illuminance¶

Ausgabe:	illuminance – Typ: Int, Einheit: ? lx, Wertebereich: [0 bis 103438]

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 – Typ: Int, Einheit: 1 K, Wertebereich: [0 bis 216 - 1]

Gibt die Farbtemperatur 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 – Typ: String, Länge: bis zu 8 connected-uid – Typ: String, Länge: bis zu 8 position – Typ: Char, Wertebereich: [a bis h, z] hardware-version – Typ: Int Array, 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 Array, 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 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. 

Konfigurationsfunktionen für Callbacks¶

tinkerforge call color-bricklet <uid> set-color-callback-period <period>¶

Parameter:	<period> – Typ: Int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0
Ausgabe:	keine Ausgabe

Setzt die Periode 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.

tinkerforge call color-bricklet <uid> get-color-callback-period¶

Ausgabe:	period – Typ: Int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0

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> – Typ: Char, Wertebereich: Siehe Symbole, Standardwert: x <min-r> – Typ: Int, Wertebereich: [0 bis 216 - 1], Standardwert: 0 <max-r> – Typ: Int, Wertebereich: [0 bis 216 - 1], Standardwert: 0 <min-g> – Typ: Int, Wertebereich: [0 bis 216 - 1], Standardwert: 0 <max-g> – Typ: Int, Wertebereich: [0 bis 216 - 1], Standardwert: 0 <min-b> – Typ: Int, Wertebereich: [0 bis 216 - 1], Standardwert: 0 <max-b> – Typ: Int, Wertebereich: [0 bis 216 - 1], Standardwert: 0 <min-c> – Typ: Int, Wertebereich: [0 bis 216 - 1], Standardwert: 0 <max-c> – Typ: Int, Wertebereich: [0 bis 216 - 1], Standardwert: 0

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)

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

Für <option>:

• threshold-option-off = x
• threshold-option-outside = o
• threshold-option-inside = i
• threshold-option-smaller = <
• threshold-option-greater = >

tinkerforge call color-bricklet <uid> get-color-callback-threshold¶

Ausgabe:

option – Typ: Char, Wertebereich: Siehe Symbole, Standardwert: x min-r – Typ: Int, Wertebereich: [0 bis 216 - 1], Standardwert: 0 max-r – Typ: Int, Wertebereich: [0 bis 216 - 1], Standardwert: 0 min-g – Typ: Int, Wertebereich: [0 bis 216 - 1], Standardwert: 0 max-g – Typ: Int, Wertebereich: [0 bis 216 - 1], Standardwert: 0 min-b – Typ: Int, Wertebereich: [0 bis 216 - 1], Standardwert: 0 max-b – Typ: Int, Wertebereich: [0 bis 216 - 1], Standardwert: 0 min-c – Typ: Int, Wertebereich: [0 bis 216 - 1], Standardwert: 0 max-c – Typ: Int, Wertebereich: [0 bis 216 - 1], Standardwert: 0

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

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

Für option:

• threshold-option-off = x
• threshold-option-outside = o
• threshold-option-inside = i
• threshold-option-smaller = <
• threshold-option-greater = >

tinkerforge call color-bricklet <uid> set-debounce-period <debounce>¶

Parameter:	<debounce> – Typ: Int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 100
Ausgabe:	keine Ausgabe

Setzt die Periode mit welcher die Schwellwert Callback

• color-reached

ausgelöst wird, wenn der Schwellwert

• set-color-callback-threshold

weiterhin erreicht bleibt.

tinkerforge call color-bricklet <uid> get-debounce-period¶

Ausgabe:	debounce – Typ: Int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 100

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

tinkerforge call color-bricklet <uid> set-illuminance-callback-period <period>¶

Parameter:	<period> – Typ: Int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0
Ausgabe:	keine Ausgabe

Setzt die Periode 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.

tinkerforge call color-bricklet <uid> get-illuminance-callback-period¶

Ausgabe:	period – Typ: Int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0

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> – Typ: Int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0
Ausgabe:	keine Ausgabe

Setzt die Periode 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.

tinkerforge call color-bricklet <uid> get-color-temperature-callback-period¶

Ausgabe:	period – Typ: Int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0

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.

tinkerforge dispatch color-bricklet <uid> color¶

Ausgabe:	r – Typ: Int, Wertebereich: [0 bis 216 - 1] g – Typ: Int, Wertebereich: [0 bis 216 - 1] b – Typ: Int, Wertebereich: [0 bis 216 - 1] c – Typ: Int, Wertebereich: [0 bis 216 - 1]

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 – Typ: Int, Wertebereich: [0 bis 216 - 1] g – Typ: Int, Wertebereich: [0 bis 216 - 1] b – Typ: Int, Wertebereich: [0 bis 216 - 1] c – Typ: Int, Wertebereich: [0 bis 216 - 1]

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 – Typ: Int, Einheit: ? lx, Wertebereich: [0 bis 103438]

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 – Typ: Int, Einheit: 1 K, Wertebereich: [0 bis 216 - 1]

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

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