MQTT - RGB LED Button Bricklet¶

Simple Color¶

Download (example-simple-color.txt)

1# Change XYZ to the UID of your RGB LED Button Bricklet
2
3setup:
4    # Set light blue color
5    publish '{"red": 0, "green": 170, "blue": 234}' to tinkerforge/request/rgb_led_button_bricklet/XYZ/set_color

Callback¶

Download (example-callback.txt)

1# Change XYZ to the UID of your RGB LED Button Bricklet
2
3setup:
4    # Handle incoming button state changed callbacks
5    subscribe to tinkerforge/callback/rgb_led_button_bricklet/XYZ/button_state_changed
6    publish '{"register": true}' to tinkerforge/register/rgb_led_button_bricklet/XYZ/button_state_changed # Register button_state_changed callback

Simple Button¶

Download (example-simple-button.txt)

1# Change XYZ to the UID of your RGB LED Button Bricklet
2
3setup:
4    # Get current button state
5    subscribe to tinkerforge/response/rgb_led_button_bricklet/XYZ/get_button_state
6    publish '' to tinkerforge/request/rgb_led_button_bricklet/XYZ/get_button_state

Grundfunktionen¶

request/rgb_led_button_bricklet/<UID>/set_color¶

Anfrage:	red – Typ: int, Wertebereich: [0 bis 255], Standardwert: 0 green – Typ: int, Wertebereich: [0 bis 255], Standardwert: 0 blue – Typ: int, Wertebereich: [0 bis 255], Standardwert: 0
Antwort:	keine Antwort

Setzt die LED-Farbe.

request/rgb_led_button_bricklet/<UID>/get_color¶

Anfrage:	keine Nutzdaten
Antwort:	red – Typ: int, Wertebereich: [0 bis 255], Standardwert: 0 green – Typ: int, Wertebereich: [0 bis 255], Standardwert: 0 blue – Typ: int, Wertebereich: [0 bis 255], Standardwert: 0

Gibt die LED-Farbe zurück, wie von request/rgb_led_button_bricklet/<UID>/set_color() gesetzt.

request/rgb_led_button_bricklet/<UID>/get_button_state¶

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

Gibt den aktuellen Zustand des Knopfes zurück (entweder gedrückt oder nicht gedrückt).

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

Für state:

• "pressed" = 0

• "released" = 1

request/rgb_led_button_bricklet/<UID>/get_color_calibration¶

Anfrage:	keine Nutzdaten
Antwort:	red – Typ: int, Einheit: 1 %, Wertebereich: [0 bis 100], Standardwert: 100 green – Typ: int, Einheit: 1 %, Wertebereich: [0 bis 100], Standardwert: 100 blue – Typ: int, Einheit: 1 %, Wertebereich: [0 bis 100], Standardwert: 55

Gibt die Farbwert-Kalibrierung zurück, wie von request/rgb_led_button_bricklet/<UID>/set_color_calibration() gesetzt.

Fortgeschrittene Funktionen¶

request/rgb_led_button_bricklet/<UID>/set_color_calibration¶

Anfrage:	red – Typ: int, Einheit: 1 %, Wertebereich: [0 bis 100], Standardwert: 100 green – Typ: int, Einheit: 1 %, Wertebereich: [0 bis 100], Standardwert: 100 blue – Typ: int, Einheit: 1 %, Wertebereich: [0 bis 100], Standardwert: 55
Antwort:	keine Antwort

Setzt die Farbwert-Kalibrierung. Einige Farben erscheinen heller als andere, daher kann eine Kalibrierung nötig sein um gleichmäßige Farben zu erzielen.

Die Kalibrierung wird im Flash des Bricklets gespeichert und muss daher nicht bei jedem Start erneut vorgenommen werden.

request/rgb_led_button_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/rgb_led_button_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/rgb_led_button_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/rgb_led_button_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/rgb_led_button_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/rgb_led_button_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/rgb_led_button_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 RGB LED Button.

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/rgb_led_button_bricklet/<UID>/button_state_changed¶

Registrierungsanfrage:	register – Typ: bool
Callback-Antwort:	state – Typ: int, Wertebereich: Siehe Symbole

Ein Callback für dieses Event kann durch Senden des Payloads "true" an das .../register/rgb_led_button_bricklet/<UID>/button_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/rgb_led_button_bricklet/<UID>/button_state_changed[/<SUFFIX>]-Topic veröffentlicht.

Dieser Callback wird jedes mal ausgelöst, wenn sich der Zustand es Knopfes ändert von gedrückt zu nicht gedrückt oder anders herum

Der Payload des Callbacks ist der aktuelle Zustand des Knopfes.

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

Für state:

• "pressed" = 0

• "released" = 1

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/rgb_led_button_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/rgb_led_button_bricklet/<UID>/get_bootloader_mode¶

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

Gibt den aktuellen Bootloader-Modus zurück, siehe request/rgb_led_button_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/rgb_led_button_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/rgb_led_button_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/rgb_led_button_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/rgb_led_button_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/rgb_led_button_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/rgb_led_button_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.