Shell - Outdoor Weather Bricklet

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

Callback

Download (example-callback.sh)

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

uid=XYZ # Change XYZ to the UID of your Outdoor Weather Bricklet

# Enable station data callbacks
tinkerforge call outdoor-weather-bricklet $uid set-station-callback-configuration true

# Enable sensor data callbacks
tinkerforge call outdoor-weather-bricklet $uid set-sensor-callback-configuration true

# Handle incoming station data callbacks
tinkerforge dispatch outdoor-weather-bricklet $uid station-data &

# Handle incoming sensor data callbacks
tinkerforge dispatch outdoor-weather-bricklet $uid sensor-data &

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 outdoor-weather-bricklet [<option>..] <uid> <function> [<argument>..]
Parameter:
  • <uid> -- string
  • <function> -- string

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

Der dispatch Befehl wird verwendet um eingehende Callbacks des Outdoor Weather 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 Outdoor Weather Bricklet an und endet dann
tinkerforge call outdoor-weather-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 outdoor-weather-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 outdoor-weather-bricklet <uid> get-station-identifiers-low-level
Ausgabe:
  • identifiers-length -- int
  • identifiers-chunk-offset -- int
  • identifiers-chunk-data -- int,int,..57x..,int

Gibt die Identifier (Zahl zwischen 0 und 255) von allen 'Stationen <https://www.tinkerforge.com/de/shop/accessories/sensors/outdoor-weather-station-ws-6147.html>`__ die seit dem Start des Bricklets entdeckt wurden.

Jede Station gibt sich selbst einen zufälligen Identifier beim ersten Start.

Seit Firmware-Version 2.0.2 wird eine Station von der Liste wieder entfernt wenn für 12 Stunden am Stück keine Daten empfangen werden.

tinkerforge call outdoor-weather-bricklet <uid> get-sensor-identifiers-low-level
Ausgabe:
  • identifiers-length -- int
  • identifiers-chunk-offset -- int
  • identifiers-chunk-data -- int,int,..57x..,int

Gibt die Identifier (Zahl zwischen 0 und 255) von allen 'Sensoren <https://www.tinkerforge.com/en/shop/accessories/sensors/temperature-humidity-sensor-th-6148.html>`__ die seit dem Start des Bricklets entdeckt wurden.

Jede Sensor gibt sich selbst einen zufälligen Identifier beim ersten Start.

Seit Firmware-Version 2.0.2 wird ein Sensor von der Liste wieder entfernt wenn für 12 Stunden am Stück keine Daten empfangen werden.

tinkerforge call outdoor-weather-bricklet <uid> get-station-data <identifier>
Parameter:
  • <identifier> -- int
Ausgabe:
  • temperature -- int
  • humidity -- int
  • wind-speed -- int
  • gust-speed -- int
  • rain -- int
  • wind-direction -- int (hat Symbole)
  • battery-low -- bool
  • last-change -- int

Gibt die zuletzt empfangenen Daten für die Station mit dem entsprechenden Identifier zurück.

Die Rückgabewerte sind:

  • Temperatur in °C/10,
  • Luftfeuchte in %RH,
  • Windgeschwindigkeit in m/10s,
  • Windböengeschwindigkeit in m/10s,
  • Niederschlag in mm/10,
  • Windrichtung (N, NNE, NE, ENE, E, ESE, SE, SSE, S, SSW, SW, WSW, W, WNW, NW, NNW),
  • Batteriewarnung (true oder false) und
  • Letzte Änderung (Zeit in Sekunden seitdem diese Daten empfangen wurden).

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

  • wind-direction-n = 0, für wind-direction
  • wind-direction-nne = 1, für wind-direction
  • wind-direction-ne = 2, für wind-direction
  • wind-direction-ene = 3, für wind-direction
  • wind-direction-e = 4, für wind-direction
  • wind-direction-ese = 5, für wind-direction
  • wind-direction-se = 6, für wind-direction
  • wind-direction-sse = 7, für wind-direction
  • wind-direction-s = 8, für wind-direction
  • wind-direction-ssw = 9, für wind-direction
  • wind-direction-sw = 10, für wind-direction
  • wind-direction-wsw = 11, für wind-direction
  • wind-direction-w = 12, für wind-direction
  • wind-direction-wnw = 13, für wind-direction
  • wind-direction-nw = 14, für wind-direction
  • wind-direction-nnw = 15, für wind-direction
  • wind-direction-error = 255, für wind-direction
tinkerforge call outdoor-weather-bricklet <uid> get-sensor-data <identifier>
Parameter:
  • <identifier> -- int
Ausgabe:
  • temperature -- int
  • humidity -- int
  • last-change -- int

Gibt die zuletzt empfangenen Daten für den Sensor mit dem entsprechenden Identifier zurück.

Die Rückgabewerte sind:

  • Temperatur in °C/10,
  • Luftfeuchte in %RH und
  • Letzte Änderung (Zeit in Sekunden seitdem diese Daten empfangen wurden).

Fortgeschrittene Funktionen

tinkerforge call outdoor-weather-bricklet <uid> get-spitfp-error-count
Ausgabe:
  • error-count-ack-checksum -- int
  • error-count-message-checksum -- int
  • error-count-frame -- int
  • error-count-overflow -- int

Gibt die Anzahl der Fehler die während der Kommunikation zwischen Brick und Bricklet aufgetreten sind zurück.

Die Fehler sind aufgeteilt in

  • ACK-Checksummen Fehler,
  • Message-Checksummen Fehler,
  • Framing Fehler und
  • Overflow Fehler.

Die Fehlerzähler sind für Fehler die auf der Seite des Bricklets auftreten. Jedes Brick hat eine ähnliche Funktion welche die Fehler auf Brickseite ausgibt.

tinkerforge call outdoor-weather-bricklet <uid> set-bootloader-mode <mode>
Parameter:
  • <mode> -- int (hat Symbole)
Ausgabe:
  • status -- int (hat Symbole)

Setzt den Bootloader-Modus und gibt den Status zurück nachdem die Modusänderungsanfrage bearbeitet wurde.

Mit dieser Funktion ist es möglich vom Bootloader- in den Firmware-Modus zu wechseln und umgekehrt. Ein Welchsel vom Bootlodaer- in der den Firmware-Modus ist nur möglich wenn Entry-Funktion, Device Identifier und CRC vorhanden und korrekt sind.

Diese Funktion wird vom Brick Viewer während des flashens benutzt. In einem normalem Nutzerprogramm sollte diese Funktion nicht benötigt werden.

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

  • bootloader-mode-bootloader = 0, für <mode>
  • bootloader-mode-firmware = 1, für <mode>
  • bootloader-mode-bootloader-wait-for-reboot = 2, für <mode>
  • bootloader-mode-firmware-wait-for-reboot = 3, für <mode>
  • bootloader-mode-firmware-wait-for-erase-and-reboot = 4, für <mode>
  • bootloader-status-ok = 0, für status
  • bootloader-status-invalid-mode = 1, für status
  • bootloader-status-no-change = 2, für status
  • bootloader-status-entry-function-not-present = 3, für status
  • bootloader-status-device-identifier-incorrect = 4, für status
  • bootloader-status-crc-mismatch = 5, für status
tinkerforge call outdoor-weather-bricklet <uid> get-bootloader-mode
Ausgabe:
  • mode -- int (hat Symbole)

Gibt den aktuellen Bootloader-Modus zurück, siehe set-bootloader-mode.

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

  • bootloader-mode-bootloader = 0, für mode
  • bootloader-mode-firmware = 1, für mode
  • bootloader-mode-bootloader-wait-for-reboot = 2, für mode
  • bootloader-mode-firmware-wait-for-reboot = 3, für mode
  • bootloader-mode-firmware-wait-for-erase-and-reboot = 4, für mode
tinkerforge call outdoor-weather-bricklet <uid> set-write-firmware-pointer <pointer>
Parameter:
  • <pointer> -- int
Ausgabe:

keine Ausgabe

Setzt den Firmware-Pointer für write-firmware. Der Pointer muss um je 64 Byte erhöht werden. Die Daten werden alle 4 Datenblöcke in den Flash geschrieben (4 Datenblöcke entsprechen einer Page mit 256 Byte).

Diese Funktion wird vom Brick Viewer während des flashens benutzt. In einem normalem Nutzerprogramm sollte diese Funktion nicht benötigt werden.

tinkerforge call outdoor-weather-bricklet <uid> write-firmware <data>
Parameter:
  • <data> -- int,int,..61x..,int
Ausgabe:
  • status -- int

Schreibt 64 Bytes Firmware an die Position die vorher von set-write-firmware-pointer gesetzt wurde. Die Firmware wird alle 4 Datenblöcke in den Flash geschrieben.

Eine Firmware kann nur im Bootloader-Mode geschrieben werden.

Diese Funktion wird vom Brick Viewer während des flashens benutzt. In einem normalem Nutzerprogramm sollte diese Funktion nicht benötigt werden.

tinkerforge call outdoor-weather-bricklet <uid> set-status-led-config <config>
Parameter:
  • <config> -- int (hat Symbole)
Ausgabe:

keine Ausgabe

Setzt die Konfiguration der Status-LED. Standardmäßig zeigt die LED die Kommunikationsdatenmenge an. Sie blinkt einmal auf pro 10 empfangenen Datenpaketen zwischen Brick und Bricklet.

Die LED kann auch permanent an/aus gestellt werden oder einen Herzschlag anzeigen.

Wenn das Bricklet sich im Bootlodermodus befindet ist die LED aus.

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

  • status-led-config-off = 0, für <config>
  • status-led-config-on = 1, für <config>
  • status-led-config-show-heartbeat = 2, für <config>
  • status-led-config-show-status = 3, für <config>
tinkerforge call outdoor-weather-bricklet <uid> get-status-led-config
Ausgabe:
  • config -- int (hat Symbole)

Gibt die Konfiguration zurück, wie von set-status-led-config gesetzt.

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

  • status-led-config-off = 0, für config
  • status-led-config-on = 1, für config
  • status-led-config-show-heartbeat = 2, für config
  • status-led-config-show-status = 3, für config
tinkerforge call outdoor-weather-bricklet <uid> get-chip-temperature
Ausgabe:
  • temperature -- int

Gibt die Temperatur in °C, gemessen im Mikrocontroller, aus. Der Rückgabewert ist nicht die Umgebungstemperatur.

Die Temperatur ist lediglich proportional zur echten Temperatur und hat eine hohe Ungenauigkeit. Daher beschränkt sich der praktische Nutzen auf die Indikation von Temperaturveränderungen.

tinkerforge call outdoor-weather-bricklet <uid> reset
Ausgabe:keine Ausgabe

Ein Aufruf dieser Funktion setzt das Bricklet zurück. Nach einem Neustart sind alle Konfiguration verloren.

Nach dem Zurücksetzen ist es notwendig neue Objekte zu erzeugen, Funktionsaufrufe auf bestehenden führen zu undefiniertem Verhalten.

tinkerforge call outdoor-weather-bricklet <uid> write-uid <uid>
Parameter:
  • <uid> -- int
Ausgabe:

keine Ausgabe

Schreibt eine neue UID in den Flash. Die UID muss zuerst vom Base58 encodierten String in einen Integer decodiert werden.

Wir empfehlen die Nutzung des Brick Viewers zum ändern der UID.

tinkerforge call outdoor-weather-bricklet <uid> read-uid
Ausgabe:
  • uid -- int

Gibt die aktuelle UID als Integer zurück. Dieser Integer kann als Base58 encodiert werden um an den üblichen UID-String zu gelangen.

tinkerforge call outdoor-weather-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 outdoor-weather-bricklet <uid> set-station-callback-configuration <enable-callback>
Parameter:
  • <enable-callback> -- bool
Ausgabe:

keine Ausgabe

Aktiviert/Deaktiviert den Callback für Stationsdaten. Standardmäßig ist der Callback deaktiviert.

tinkerforge call outdoor-weather-bricklet <uid> get-station-callback-configuration
Ausgabe:
  • enable-callback -- bool

Gibt die Konfiguration zurück wie von set-station-callback-configuration gesetzt.

tinkerforge call outdoor-weather-bricklet <uid> set-sensor-callback-configuration <enable-callback>
Parameter:
  • <enable-callback> -- bool
Ausgabe:

keine Ausgabe

Aktiviert/Deaktiviert den Callback für Sensordaten. Standardmäßig ist der Callback deaktiviert.

tinkerforge call outdoor-weather-bricklet <uid> get-sensor-callback-configuration
Ausgabe:
  • enable-callback -- bool

Gibt die Konfiguration zurück wie von set-sensor-callback-configuration gesetzt.

Callbacks

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

tinkerforge dispatch outdoor-weather-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 outdoor-weather-bricklet <uid> station-data
Ausgabe:
  • identifier -- int
  • temperature -- int
  • humidity -- int
  • wind-speed -- int
  • gust-speed -- int
  • rain -- int
  • wind-direction -- int (hat Symbole)
  • battery-low -- bool

Meldet die Stationsdaten bei jedem eingehenden Datenpaket. Siehe get-station-data für Details über die Daten.

Für jede Station wird dieser Callback ca. alle 45 Sekunden ausgelöst werden.

Der Callback kann mittels set-station-callback-configuration aktiviert/deaktiviert werden (standardmäßig ist der Callback deaktiviert).

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

  • wind-direction-n = 0, für wind-direction
  • wind-direction-nne = 1, für wind-direction
  • wind-direction-ne = 2, für wind-direction
  • wind-direction-ene = 3, für wind-direction
  • wind-direction-e = 4, für wind-direction
  • wind-direction-ese = 5, für wind-direction
  • wind-direction-se = 6, für wind-direction
  • wind-direction-sse = 7, für wind-direction
  • wind-direction-s = 8, für wind-direction
  • wind-direction-ssw = 9, für wind-direction
  • wind-direction-sw = 10, für wind-direction
  • wind-direction-wsw = 11, für wind-direction
  • wind-direction-w = 12, für wind-direction
  • wind-direction-wnw = 13, für wind-direction
  • wind-direction-nw = 14, für wind-direction
  • wind-direction-nnw = 15, für wind-direction
  • wind-direction-error = 255, für wind-direction
tinkerforge dispatch outdoor-weather-bricklet <uid> sensor-data
Ausgabe:
  • identifier -- int
  • temperature -- int
  • humidity -- int

Meldet die Sensordaten bei jedem eingehenden Datenpaket. Siehe get-sensor-data für Details über die Daten.

Für jeden Sensor wird dieser Callback ca. alle 45 Sekunden ausgelöst werden.

Der Callback kann mittels set-sensor-callback-configuration aktiviert/deaktiviert werden (standardmäßig ist der Callback deaktiviert).