Shell - HAT Brick¶

Print Voltages¶

Download (example-print-voltages.sh)

1
2
3
4
5
6
7

#!/bin/sh
# Connects to localhost:4223 by default, use --host and --port to change this

uid=XXYYZZ # Change XXYYZZ to the UID of your HAT Brick

# Get current get voltages
tinkerforge call hat-brick $uid get-voltages

Sleep¶

Download (example-sleep.sh)

1
2
3
4
5
6
7

#!/bin/sh
# Connects to localhost:4223 by default, use --host and --port to change this

uid=XXYYZZ # Change XXYYZZ to the UID of your HAT Brick

# Turn Raspberry Pi and Bricklets off in 2 seconds for 30 minutes with sleep indicator enabled
tinkerforge call hat-brick $uid set-sleep-mode 2 1800 true true true

Befehlsstruktur¶

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

tinkerforge call hat-brick [<option>..] <uid> <function> [<argument>..]¶

Parameter:	<uid> – Typ: String <function> – Typ: String

Der call Befehl wird verwendet um eine Funktion des HAT Brick 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 HAT Brick an und endet dann

tinkerforge dispatch hat-brick [<option>..] <uid> <callback>¶

Parameter:	<uid> – Typ: String <callback> – Typ: String

Der dispatch Befehl wird verwendet um eingehende Callbacks des HAT Brick 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 HAT Brick an und endet dann

tinkerforge call hat-brick <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 hat-brick <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 hat-brick <uid> set-sleep-mode <power-off-delay> <power-off-duration> <raspberry-pi-off> <bricklets-off> <enable-sleep-indicator>¶

Parameter:	<power-off-delay> – Typ: Int, Einheit: 1 s, Wertebereich: [0 bis 232 - 1] <power-off-duration> – Typ: Int, Einheit: 1 s, Wertebereich: [0 bis 232 - 1] <raspberry-pi-off> – Typ: Bool <bricklets-off> – Typ: Bool <enable-sleep-indicator> – Typ: Bool
Ausgabe:	keine Ausgabe

Setzt den Schlaf-Modus.

Bemerkung

Diese Funktion schaltet die Stromversorgung des Raspberry Pis nach Power Off Delay Sekunden ab. Das Betriebssystem muss manuell heruntergefahren werden, zum Beispiel durch Ausführen von 'sudo shutdown -h now'.

Parameter:

• Power Off Delay: Zeit in Sekunden bis der RPi/die Bricklets ausgeschaltet werden.
• Power Off Duration: Dauer in Sekunden für die der RPi/die Bricklets ausgeschaltet bleiben.
• Raspberry Pi Off: RPi wird ausgeschaltet, falls auf true gesetzt.
• Bricklets Off: Bricklets werden ausgeschaltet falls auf true gesetzt.
• Enable Sleep Indicator: Wenn dieser Parameter auf true gesetzt wird, blinkt die Status-LED während der Schlafdauer mit einem Intervall von 1s. Dies verbraucht zusätzliche 0,3mA.

Beispiel: Um den RPi und die Bricklets in 5 Sekunden für 10 Minuten mit aktivierter Status-LED auszuschalten, rufe (5, 60*10, true, true, true) auf.

Diese Funktion kann auch genutzt werden um einen Watchdog zu implementieren. Dazu kann ein Programm geschrieben werden, welches in einer Schleife einmal pro Sekunde folgendes aufruft: (10, 2, true, false, false). Dies führt dazu, dass das HAT den RPi nach 10 Sekunden neustartet, wenn dieser abgestürzt oder stecken geblieben ist.

tinkerforge call hat-brick <uid> get-sleep-mode¶

Ausgabe:	power-off-delay – Typ: Int, Einheit: 1 s, Wertebereich: [0 bis 232 - 1] power-off-duration – Typ: Int, Einheit: 1 s, Wertebereich: [0 bis 232 - 1] raspberry-pi-off – Typ: Bool bricklets-off – Typ: Bool enable-sleep-indicator – Typ: Bool

Gibt die Sleep-Mode-Einstellungen zurück, wie von set-sleep-mode gesetzt.

tinkerforge call hat-brick <uid> set-bricklet-power <bricklet-power>¶

Parameter:	<bricklet-power> – Typ: Bool, Standardwert: true
Ausgabe:	keine Ausgabe

Kann auf true/false gesetzt werden um die Spannungsversorgung der angeschlossenen Bricklets an/aus zu stellen.

tinkerforge call hat-brick <uid> get-bricklet-power¶

Ausgabe:	bricklet-power – Typ: Bool, Standardwert: true

Gibt den Status der Stromversorgung der angeschlossenen Bricklets zurück, wie von set-bricklet-power gesetzt.

tinkerforge call hat-brick <uid> get-voltages¶

Ausgabe:	voltage-usb – Typ: Int, Einheit: 1 mV, Wertebereich: [0 bis 216 - 1] voltage-dc – Typ: Int, Einheit: 1 mV, Wertebereich: [0 bis 216 - 1]

Gibt die USB- und DC-Input-Versorgungsspannung zurück.

Es gibt drei mögliche Kombinationen:

• Nur USB verbunden: Die USB-Versorgungsspannung wird auf den DC-Input-Stecker zurückgespeist. Die USB-Spannung wird angezeigt und die DC-Input-Spannung ist etwas niedriger als die USB-Spannung.
• Nur DC-Input verbunden: Die DC-Versorgungsspannung wird nicht auf den USB-Stecker zurückgespeist. Die DC-Versorgungsspannung wird angezeigt und die USB-Spannung ist 0.
• USB und DC-Input verbunden: Beide Spannungen werden angezeigt. In diesem Fall ist die USB-Versorgungsspannung ohne Last, sie wird als Backup verwendet wenn der DC-Input getrennt wird (oder die DC-Input-Versorgungsspannung unter die USB-Spannung fällt).

Fortgeschrittene Funktionen¶

tinkerforge call hat-brick <uid> set-rtc-driver <rtc-driver>¶

Parameter:	<rtc-driver> – Typ: Int, Wertebereich: Siehe Symbole
Ausgabe:	keine Ausgabe

Konfiguriert den RTC-Treiber der dem Raspberry Pi zur Nutzung gegeben wird. Aktuell werden zwei unterschiedliche RTCs verbaut:

• Hardwareversion <= 1.5: PCF8523
• Hardwareversion 1.6: DS1338

Der korrekte Treiber wird während dem ersten Flashens von Tinkerforge gesetzt.

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

Für <rtc-driver>:

• rtc-driver-pcf8523 = 0
• rtc-driver-ds1338 = 1

Neu in Version 2.0.3 (Firmware).

tinkerforge call hat-brick <uid> get-rtc-driver¶

Ausgabe:	rtc-driver – Typ: Int, Wertebereich: Siehe Symbole

Gibt den RTC-Treiber zurück, wie von set-rtc-driver gesetzt.

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

Für rtc-driver:

• rtc-driver-pcf8523 = 0
• rtc-driver-ds1338 = 1

Neu in Version 2.0.3 (Firmware).

tinkerforge call hat-brick <uid> get-spitfp-error-count¶

Ausgabe:	error-count-ack-checksum – Typ: Int, Wertebereich: [0 bis 232 - 1] error-count-message-checksum – Typ: Int, Wertebereich: [0 bis 232 - 1] error-count-frame – Typ: Int, Wertebereich: [0 bis 232 - 1] error-count-overflow – Typ: Int, Wertebereich: [0 bis 232 - 1]

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 hat-brick <uid> set-status-led-config <config>¶

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

Für <config>:

• status-led-config-off = 0
• status-led-config-on = 1
• status-led-config-show-heartbeat = 2
• status-led-config-show-status = 3

tinkerforge call hat-brick <uid> get-status-led-config¶

Ausgabe:	config – Typ: Int, Wertebereich: Siehe Symbole, Standardwert: 3

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

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

Für config:

• status-led-config-off = 0
• status-led-config-on = 1
• status-led-config-show-heartbeat = 2
• status-led-config-show-status = 3

tinkerforge call hat-brick <uid> get-chip-temperature¶

Ausgabe:	temperature – Typ: Int, Einheit: 1 °C, Wertebereich: [-215 bis 215 - 1]

Gibt die Temperatur, 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 hat-brick <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 hat-brick <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: [i] 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 HAT verbunden ist (typischerweise '0' da das HAT das Wurzelgerät der Topologie ist), die Position, die Hard- und Firmware Version sowie den Device Identifier zurück.

Der HAT (Zero) Brick ist immer an Position 'i'.

Eine Liste der Device Identifier Werte ist hier zu finden. 

Konfigurationsfunktionen für Callbacks¶

tinkerforge call hat-brick <uid> set-voltages-callback-configuration <period> <value-has-to-change>¶

Parameter:	<period> – Typ: Int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0 <value-has-to-change> – Typ: Bool, Standardwert: false
Ausgabe:	keine Ausgabe

Die Periode ist die Periode mit der der voltages Callback ausgelöst wird. Ein Wert von 0 schaltet den Callback ab.

Wenn der value has to change-Parameter auf True gesetzt wird, wird der Callback nur ausgelöst, wenn der Wert sich im Vergleich zum letzten mal geändert hat. Ändert der Wert sich nicht innerhalb der Periode, so wird der Callback sofort ausgelöst, wenn der Wert sich das nächste mal ändert.

Wird der Parameter auf False gesetzt, so wird der Callback dauerhaft mit der festen Periode ausgelöst unabhängig von den Änderungen des Werts.

Neu in Version 2.0.1 (Firmware).

tinkerforge call hat-brick <uid> get-voltages-callback-configuration¶

Ausgabe:	period – Typ: Int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0 value-has-to-change – Typ: Bool, Standardwert: false

Gibt die Callback-Konfiguration zurück, wie mittels set-voltages-callback-configuration gesetzt.

Neu in Version 2.0.1 (Firmware).

Callbacks¶

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

tinkerforge dispatch hat-brick <uid> example

Die verfügbaren Callbacks werden weiter unten beschrieben.

tinkerforge dispatch hat-brick <uid> voltages¶

Ausgabe:	voltage-usb – Typ: Int, Einheit: 1 mV, Wertebereich: [0 bis 216 - 1] voltage-dc – Typ: Int, Einheit: 1 mV, Wertebereich: [0 bis 216 - 1]

Dieser Callback wird periodisch ausgelöst abhängig von der mittels set-voltages-callback-configuration gesetzten Konfiguration

Die Parameter sind der gleiche wie get-voltages.

Neu in Version 2.0.1 (Firmware).

Interne Funktionen¶

Interne Funktionen werden für Wartungsaufgaben, wie zum Beispiel das Flashen einer neuen Firmware oder das Ändern der UID eines Bricklets, verwendet. Diese Aufgaben sollten mit Brick Viewer durchgeführt werden, anstelle die internen Funktionen direkt zu verwenden.

tinkerforge call hat-brick <uid> set-bootloader-mode <mode>¶

Parameter:	<mode> – Typ: Int, Wertebereich: Siehe Symbole
Ausgabe:	status – Typ: Int, Wertebereich: Siehe 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 Bootloader- 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:

Für <mode>:

• bootloader-mode-bootloader = 0
• bootloader-mode-firmware = 1
• bootloader-mode-bootloader-wait-for-reboot = 2
• bootloader-mode-firmware-wait-for-reboot = 3
• bootloader-mode-firmware-wait-for-erase-and-reboot = 4

Für status:

• bootloader-status-ok = 0
• bootloader-status-invalid-mode = 1
• bootloader-status-no-change = 2
• bootloader-status-entry-function-not-present = 3
• bootloader-status-device-identifier-incorrect = 4
• bootloader-status-crc-mismatch = 5

tinkerforge call hat-brick <uid> get-bootloader-mode¶

Ausgabe:	mode – Typ: Int, Wertebereich: Siehe Symbole

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

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

Für mode:

• bootloader-mode-bootloader = 0
• bootloader-mode-firmware = 1
• bootloader-mode-bootloader-wait-for-reboot = 2
• bootloader-mode-firmware-wait-for-reboot = 3
• bootloader-mode-firmware-wait-for-erase-and-reboot = 4

tinkerforge call hat-brick <uid> set-write-firmware-pointer <pointer>¶

Parameter:	<pointer> – Typ: Int, Einheit: 1 B, Wertebereich: [0 bis 232 - 1]
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 hat-brick <uid> write-firmware <data>¶

Parameter:	<data> – Typ: Int Array, Länge: 64, Wertebereich: [0 bis 255]
Ausgabe:	status – Typ: Int, Wertebereich: [0 bis 255]

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 hat-brick <uid> write-uid <uid>¶

Parameter:	<uid> – Typ: Int, Wertebereich: [0 bis 232 - 1]
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 hat-brick <uid> read-uid¶

Ausgabe:	uid – Typ: Int, Wertebereich: [0 bis 232 - 1]

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