Shell - UV Light Bricklet

Dies ist die Beschreibung der Shell API Bindings für das UV Light Bricklet. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des UV Light 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 UV Light Bricklet

# Get current UV light
tinkerforge call uv-light-bricklet $uid get-uv-light

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 UV Light Bricklet

# Handle incoming UV light callbacks
tinkerforge dispatch uv-light-bricklet $uid uv-light &

# Set period for UV light callback to 1s (1000ms)
# Note: The UV light callback is only called every second
#       if the UV light has changed since the last call!
tinkerforge call uv-light-bricklet $uid set-uv-light-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
18
#!/bin/sh
# Connects to localhost:4223 by default, use --host and --port to change this

uid=XYZ # Change XYZ to the UID of your UV Light Bricklet

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

# Handle incoming UV light reached callbacks
tinkerforge dispatch uv-light-bricklet $uid uv-light-reached\
 --execute "echo UV Light: {uv_light}/10 mW/m². UV Index > 3. Use sunscreen!" &

# Configure threshold for UV light "greater than 75 mW/m²"
tinkerforge call uv-light-bricklet $uid set-uv-light-callback-threshold threshold-option-greater 750 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 uv-light-bricklet [<option>..] <uid> <function> [<argument>..]
Parameter:
  • <uid> -- string
  • <function> -- string

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

Der dispatch Befehl wird verwendet um eingehende Callbacks des UV Light 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 UV Light Bricklet an und endet dann
tinkerforge call uv-light-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 uv-light-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 uv-light-bricklet <uid> get-uv-light
Ausgabe:
  • uv-light -- int

Gibt die UV-Licht-Intensität des Sensors zurück. Die Intensität wird in der Einheit 1/10 mW/m² gegeben. Der Sensor hat die Intensität bereits mit dem Erythem-Wirkungsspektrum gewichtet, um die hautbeeinflussende Bestrahlungsstärke zu bestimmen.

Die Intensität kann dann einfach durch 250 geteilt werden um den UV Index zu bestimmen. Beispiel: Eine UV-Licht-Intensität von 500 entspricht einem UV Index von 2.

Wenn die Intensität periodisch abgefragt werden soll, wird empfohlen den uv-light Callback zu nutzen und die Periode mit set-uv-light-callback-period vorzugeben.

Fortgeschrittene Funktionen

tinkerforge call uv-light-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 uv-light-bricklet <uid> set-uv-light-callback-period <period>
Parameter:
  • <period> -- int
Ausgabe:

keine Ausgabe

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

Der uv-light Callback wird nur ausgelöst wenn sich die Intensität seit der letzten Auslösung geändert hat.

Der Standardwert ist 0.

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

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

tinkerforge call uv-light-bricklet <uid> set-uv-light-callback-threshold <option> <min> <max>
Parameter:
  • <option> -- char (hat Symbole)
  • <min> -- int
  • <max> -- int
Ausgabe:

keine Ausgabe

Setzt den Schwellwert für den uv-light-reached Callback.

Die folgenden Optionen sind möglich:

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

Der Standardwert ist ('x', 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 uv-light-bricklet <uid> get-uv-light-callback-threshold
Ausgabe:
  • option -- char (hat Symbole)
  • min -- int
  • max -- int

Gibt den Schwellwert zurück, wie von set-uv-light-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 uv-light-bricklet <uid> set-debounce-period <debounce>
Parameter:
  • <debounce> -- int
Ausgabe:

keine Ausgabe

Setzt die Periode in ms mit welcher die Schwellwert Callbacks

ausgelöst werden, wenn die Schwellwerte

weiterhin erreicht bleiben.

Der Standardwert ist 100.

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

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

Callbacks

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

tinkerforge dispatch uv-light-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 uv-light-bricklet <uid> uv-light
Ausgabe:
  • uv-light -- int

Dieser Callback wird mit der Periode, wie gesetzt mit set-uv-light-callback-period, ausgelöst. Der Parameter ist die UV-Licht-Intensität des Sensors.

Der uv-light Callback wird nur ausgelöst wenn sich die Intensität seit der letzten Auslösung geändert hat.

tinkerforge dispatch uv-light-bricklet <uid> uv-light-reached
Ausgabe:
  • uv-light -- int

Dieser Callback wird ausgelöst wenn der Schwellwert, wie von set-uv-light-callback-threshold gesetzt, erreicht wird. Der Parameter ist die UV-Licht-Intensität des Sensors.

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