Shell - Dual Button Bricklet 2.0¶

Callback¶

Download (example-callback.sh)

 1#!/bin/sh
 2# Connects to localhost:4223 by default, use --host and --port to change this
 3
 4uid=XYZ # Change XYZ to the UID of your Dual Button Bricklet 2.0
 5
 6# Handle incoming state changed callbacks
 7tinkerforge dispatch dual-button-v2-bricklet $uid state-changed &
 8
 9# Enable state changed callback
10tinkerforge call dual-button-v2-bricklet $uid set-state-changed-callback-configuration true
11
12echo "Press key to exit"; read dummy
13
14kill -- -$$ # 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 dual-button-v2-bricklet [<option>..] <uid> <function> [<argument>..]¶

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

Der call Befehl wird verwendet um eine Funktion des Dual Button Bricklet 2.0 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 Dual Button Bricklet 2.0 an und endet dann

tinkerforge dispatch dual-button-v2-bricklet [<option>..] <uid> <callback>¶

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

Der dispatch Befehl wird verwendet um eingehende Callbacks des Dual Button Bricklet 2.0 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 Dual Button Bricklet 2.0 an und endet dann

tinkerforge call dual-button-v2-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 dual-button-v2-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 dual-button-v2-bricklet <uid> set-led-state <led-l> <led-r>¶

Parameter:	<led-l> – Typ: Int, Wertebereich: Siehe Symbole, Standardwert: 1 <led-r> – Typ: Int, Wertebereich: Siehe Symbole, Standardwert: 1
Ausgabe:	keine Ausgabe

Setzt den Zustand der LEDs. Möglich Zustände sind:

• 0 = AutoToggleOn: Aktiviert Auto-Toggle und anfänglich aktiviert LED

• 1 = AutoToggleOff: Aktiviert Auto-Toggle und anfänglich deaktiviert LED.

• 2 = On: Aktiviert LED (Auto-Toggle is deaktiviert).

• 3 = Off: Deaktiviert LED (Auto-Toggle is deaktiviert).

Im Auto-Toggle Modus wechselt die LED automatisch zwischen aus und an bei jedem Tasterdruck.

Wenn nur eine der LEDs gesetzt werden soll und der aktuelle Zustand der anderen LED nicht bekannt ist, dann kann der Zustand mit get-led-state ausgelesen werden oder es kann set-selected-led-state genutzt werden.

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

Für <led-l>:

• led-state-auto-toggle-on = 0

• led-state-auto-toggle-off = 1

• led-state-on = 2

• led-state-off = 3

Für <led-r>:

• led-state-auto-toggle-on = 0

• led-state-auto-toggle-off = 1

• led-state-on = 2

• led-state-off = 3

tinkerforge call dual-button-v2-bricklet <uid> get-led-state¶

Ausgabe:	led-l – Typ: Int, Wertebereich: Siehe Symbole, Standardwert: 1 led-r – Typ: Int, Wertebereich: Siehe Symbole, Standardwert: 1

Gibt den aktuellen Zustand der LEDs zurück, wie von set-led-state gesetzt.

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

Für led-l:

• led-state-auto-toggle-on = 0

• led-state-auto-toggle-off = 1

• led-state-on = 2

• led-state-off = 3

Für led-r:

• led-state-auto-toggle-on = 0

• led-state-auto-toggle-off = 1

• led-state-on = 2

• led-state-off = 3

tinkerforge call dual-button-v2-bricklet <uid> get-button-state¶

Ausgabe:	button-l – Typ: Int, Wertebereich: Siehe Symbole button-r – Typ: Int, Wertebereich: Siehe Symbole

Gibt den aktuellen Zustand beider Taster zurück. Mögliche Zustände sind:

• 0 = pressed (gedrückt)

• 1 = released (losgelassen)

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

Für button-l:

• button-state-pressed = 0

• button-state-released = 1

Für button-r:

• button-state-pressed = 0

• button-state-released = 1

Fortgeschrittene Funktionen¶

tinkerforge call dual-button-v2-bricklet <uid> set-selected-led-state <led> <state>¶

Parameter:	<led> – Typ: Int, Wertebereich: Siehe Symbole <state> – Typ: Int, Wertebereich: Siehe Symbole
Ausgabe:	keine Ausgabe

Setzt den Zustand der selektierten LED.

Die andere LED bleibt unangetastet.

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

Für <led>:

• led-left = 0

• led-right = 1

Für <state>:

• led-state-auto-toggle-on = 0

• led-state-auto-toggle-off = 1

• led-state-on = 2

• led-state-off = 3

tinkerforge call dual-button-v2-bricklet <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 dual-button-v2-bricklet <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 dual-button-v2-bricklet <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 dual-button-v2-bricklet <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 dual-button-v2-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 dual-button-v2-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 dual-button-v2-bricklet <uid> set-state-changed-callback-configuration <enabled>¶

Parameter:	<enabled> – Typ: Bool, Standardwert: false
Ausgabe:	keine Ausgabe

Wenn dieser Callback aktiviert ist, wird der state-changed Callback jedes mal ausgelöst, wenn ein Taster gedrückt/losgelassen wird.

tinkerforge call dual-button-v2-bricklet <uid> get-state-changed-callback-configuration¶

Ausgabe:	enabled – Typ: Bool, Standardwert: false

Gibt die Konfiguration zurück, wie von set-state-changed-callback-configuration gesetzt.

Callbacks¶

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

tinkerforge dispatch dual-button-v2-bricklet <uid> example

Die verfügbaren Callbacks werden weiter unten beschrieben.

tinkerforge dispatch dual-button-v2-bricklet <uid> state-changed¶

Ausgabe:	button-l – Typ: Int, Wertebereich: Siehe Symbole button-r – Typ: Int, Wertebereich: Siehe Symbole led-l – Typ: Int, Wertebereich: Siehe Symbole led-r – Typ: Int, Wertebereich: Siehe Symbole

Dieser Callback wird aufgerufen wenn einer der Taster gedrückt wird.

Mögliche Zustände der Taster sind:

• 0 = pressed (gedrückt)

• 1 = released (losgelassen)

Mögliche Zustände der LEDs sind:

• 0 = AutoToggleOn: Auto-Toggle aktiv und LED an.

• 1 = AutoToggleOff: Auto-Toggle aktiv und LED aus.

• 2 = On: Aktiviert LED (Auto-Toggle ist deaktiviert).

• 3 = Off: Deaktiviert LED (Auto-Toggle ist deaktiviert).

Dieser Callback kann über set-state-changed-callback-configuration aktiviert werden.

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

Für button-l:

• button-state-pressed = 0

• button-state-released = 1

Für button-r:

• button-state-pressed = 0

• button-state-released = 1

Für led-l:

• led-state-auto-toggle-on = 0

• led-state-auto-toggle-off = 1

• led-state-on = 2

• led-state-off = 3

Für led-r:

• led-state-auto-toggle-on = 0

• led-state-auto-toggle-off = 1

• led-state-on = 2

• led-state-off = 3

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 dual-button-v2-bricklet <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 dual-button-v2-bricklet <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 dual-button-v2-bricklet <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 dual-button-v2-bricklet <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 dual-button-v2-bricklet <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 dual-button-v2-bricklet <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.