MQTT - Dual Button Bricklet 2.0¶

Callback¶

Download (example-callback.txt)

1# Change XYZ to the UID of your Dual Button Bricklet 2.0
2
3setup:
4    # Handle incoming state changed callbacks
5    subscribe to tinkerforge/callback/dual_button_v2_bricklet/XYZ/state_changed
6    publish '{"register": true}' to tinkerforge/register/dual_button_v2_bricklet/XYZ/state_changed # Register state_changed callback
7
8    # Enable state changed callback
9    publish '{"enabled": true}' to tinkerforge/request/dual_button_v2_bricklet/XYZ/set_state_changed_callback_configuration

Grundfunktionen¶

request/dual_button_v2_bricklet/<UID>/set_led_state¶

Anfrage:	led_l – Typ: int, Wertebereich: Siehe Symbole, Standardwert: 1 led_r – Typ: int, Wertebereich: Siehe Symbole, Standardwert: 1
Antwort:	keine Antwort

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 request/dual_button_v2_bricklet/<UID>/get_led_state() ausgelesen werden oder es kann request/dual_button_v2_bricklet/<UID>/set_selected_led_state() genutzt werden.

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

Für led_l:

• "auto_toggle_on" = 0

• "auto_toggle_off" = 1

• "on" = 2

• "off" = 3

Für led_r:

• "auto_toggle_on" = 0

• "auto_toggle_off" = 1

• "on" = 2

• "off" = 3

request/dual_button_v2_bricklet/<UID>/get_led_state¶

Anfrage:	keine Nutzdaten
Antwort:	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 request/dual_button_v2_bricklet/<UID>/set_led_state() gesetzt.

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

Für led_l:

• "auto_toggle_on" = 0

• "auto_toggle_off" = 1

• "on" = 2

• "off" = 3

Für led_r:

• "auto_toggle_on" = 0

• "auto_toggle_off" = 1

• "on" = 2

• "off" = 3

request/dual_button_v2_bricklet/<UID>/get_button_state¶

Anfrage:	keine Nutzdaten
Antwort:	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:

• "pressed" = 0

• "released" = 1

Für button_r:

• "pressed" = 0

• "released" = 1

Fortgeschrittene Funktionen¶

request/dual_button_v2_bricklet/<UID>/set_selected_led_state¶

Anfrage:	led – Typ: int, Wertebereich: Siehe Symbole state – Typ: int, Wertebereich: Siehe Symbole
Antwort:	keine Antwort

Setzt den Zustand der selektierten LED.

Die andere LED bleibt unangetastet.

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

Für led:

• "left" = 0

• "right" = 1

Für state:

• "auto_toggle_on" = 0

• "auto_toggle_off" = 1

• "on" = 2

• "off" = 3

request/dual_button_v2_bricklet/<UID>/get_spitfp_error_count¶

Anfrage:	keine Nutzdaten
Antwort:	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.

request/dual_button_v2_bricklet/<UID>/set_status_led_config¶

Anfrage:	config – Typ: int, Wertebereich: Siehe Symbole, Standardwert: 3
Antwort:	keine Antwort

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:

• "off" = 0

• "on" = 1

• "show_heartbeat" = 2

• "show_status" = 3

request/dual_button_v2_bricklet/<UID>/get_status_led_config¶

Anfrage:	keine Nutzdaten
Antwort:	config – Typ: int, Wertebereich: Siehe Symbole, Standardwert: 3

Gibt die Konfiguration zurück, wie von request/dual_button_v2_bricklet/<UID>/set_status_led_config() gesetzt.

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

Für config:

• "off" = 0

• "on" = 1

• "show_heartbeat" = 2

• "show_status" = 3

request/dual_button_v2_bricklet/<UID>/get_chip_temperature¶

Anfrage:	keine Nutzdaten
Antwort:	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.

request/dual_button_v2_bricklet/<UID>/reset¶

Anfrage:	keine Nutzdaten
Antwort:	keine Antwort

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.

request/dual_button_v2_bricklet/<UID>/get_identity¶

Anfrage:

keine Nutzdaten

Antwort:

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, ...], 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, ...], 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] _display_name – Typ: string

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. Falls die symbolische Ausgabe nicht deaktiviert wurde, wird der Device Identifier auf den entsprechenden Namen im Format, welches die Topics verwenden, abgebildet.

Der Display Name enthält den Anzeigenamen des Dual Button 2.0.

Konfigurationsfunktionen für Callbacks¶

request/dual_button_v2_bricklet/<UID>/set_state_changed_callback_configuration¶

Anfrage:	enabled – Typ: bool, Standardwert: false
Antwort:	keine Antwort

Wenn dieser Callback aktiviert ist, wird der register/dual_button_v2_bricklet/<UID>/state_changed() Callback jedes mal ausgelöst, wenn ein Taster gedrückt/losgelassen wird.

request/dual_button_v2_bricklet/<UID>/get_state_changed_callback_configuration¶

Anfrage:	keine Nutzdaten
Antwort:	enabled – Typ: bool, Standardwert: false

Gibt die Konfiguration zurück, wie von request/dual_button_v2_bricklet/<UID>/set_state_changed_callback_configuration() gesetzt.

Callbacks¶

Callbacks können registriert werden um zeitkritische oder wiederkehrende Daten vom Gerät zu erhalten. Die Registrierung kann mit dem entsprechenden .../register/...-Topic und einem optionalen Suffix durchgeführt werden. Mit diesem Suffix kann das Callback später deregistriert werden.

register/dual_button_v2_bricklet/<UID>/state_changed¶

Registrierungsanfrage:	register – Typ: bool
Callback-Antwort:	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

Ein Callback für dieses Event kann durch Senden des Payloads "true" an das .../register/dual_button_v2_bricklet/<UID>/state_changed[/<SUFFIX>]-Topic hinzugefügt werden. Ein hinzugefügtes Callback kann durch Senden des Payloads "false" an das selbe Topic wieder entfernt werden. Um mehrere (De-)Registrierungen zu unterstützen, z.B. um Nachrichten filtern zu können, kann ein optionaler Suffix verwendet werden.

Wenn das Callback ausgelöst wird, wird dessen Payload für jeden Suffix auf dem entsprechenden .../callback/dual_button_v2_bricklet/<UID>/state_changed[/<SUFFIX>]-Topic veröffentlicht.

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 request/dual_button_v2_bricklet/<UID>/set_state_changed_callback_configuration() aktiviert werden.

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

Für button_l:

• "pressed" = 0

• "released" = 1

Für button_r:

• "pressed" = 0

• "released" = 1

Für led_l:

• "auto_toggle_on" = 0

• "auto_toggle_off" = 1

• "on" = 2

• "off" = 3

Für led_r:

• "auto_toggle_on" = 0

• "auto_toggle_off" = 1

• "on" = 2

• "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.

request/dual_button_v2_bricklet/<UID>/set_bootloader_mode¶

Anfrage:	mode – Typ: int, Wertebereich: Siehe Symbole
Antwort:	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" = 0

• "firmware" = 1

• "bootloader_wait_for_reboot" = 2

• "firmware_wait_for_reboot" = 3

• "firmware_wait_for_erase_and_reboot" = 4

Für status:

• "ok" = 0

• "invalid_mode" = 1

• "no_change" = 2

• "entry_function_not_present" = 3

• "device_identifier_incorrect" = 4

• "crc_mismatch" = 5

request/dual_button_v2_bricklet/<UID>/get_bootloader_mode¶

Anfrage:	keine Nutzdaten
Antwort:	mode – Typ: int, Wertebereich: Siehe Symbole

Gibt den aktuellen Bootloader-Modus zurück, siehe request/dual_button_v2_bricklet/<UID>/set_bootloader_mode().

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

Für mode:

• "bootloader" = 0

• "firmware" = 1

• "bootloader_wait_for_reboot" = 2

• "firmware_wait_for_reboot" = 3

• "firmware_wait_for_erase_and_reboot" = 4

request/dual_button_v2_bricklet/<UID>/set_write_firmware_pointer¶

Anfrage:	pointer – Typ: int, Einheit: 1 B, Wertebereich: [0 bis 232 - 1]
Antwort:	keine Antwort

Setzt den Firmware-Pointer für request/dual_button_v2_bricklet/<UID>/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.

request/dual_button_v2_bricklet/<UID>/write_firmware¶

Anfrage:	data – Typ: [int, ...], Länge: 64, Wertebereich: [0 bis 255]
Antwort:	status – Typ: int, Wertebereich: [0 bis 255]

Schreibt 64 Bytes Firmware an die Position die vorher von request/dual_button_v2_bricklet/<UID>/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.

request/dual_button_v2_bricklet/<UID>/write_uid¶

Anfrage:	uid – Typ: int, Wertebereich: [0 bis 232 - 1]
Antwort:	keine Antwort

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.

request/dual_button_v2_bricklet/<UID>/read_uid¶

Anfrage:	keine Nutzdaten
Antwort:	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.