MQTT - RGB LED Bricklet

Dies ist die Beschreibung der MQTT API Bindings für das RGB LED Bricklet. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des RGB LED Bricklet sind in dessen Hardware Beschreibung zusammengefasst.

Eine Installationanleitung für die MQTT API Bindings ist Teil deren allgemeine Beschreibung.

Beispiele

Der folgende Beispielcode ist Public Domain (CC0 1.0).

Simple

Download (example-simple.txt)

1
2
3
4
5
# Change XYZ to the UID of your RGB LED Bricklet

setup:
    # Set light blue color
    publish '{"r": 0, "g": 170, "b": 234}' to tinkerforge/request/rgb_led_bricklet/XYZ/set_rgb_value

API

Alle veröffentlichten Payloads an die und von den MQTT-Bindings sind im JSON Format.

Falls ein Fehler auftritt, veröffentlichen die Bindings ein JSON-Objekt, das die Fehlermeldung als _ERROR-Member enthält. Das Objekt wird auf dem zugehörigen Antwort-Topic veröffentlicht: .../response/... für .../request/... und .../callback/... für .../register/....

Grundfunktionen

request/rgb_led_bricklet/<UID>/set_rgb_value
Anfrage:
  • r – Typ: int, Wertebereich: [0 bis 255], Standardwert: 0
  • g – Typ: int, Wertebereich: [0 bis 255], Standardwert: 0
  • b – Typ: int, Wertebereich: [0 bis 255], Standardwert: 0
Antwort:
  • keine Antwort

Setzt die r, g und b Werte für die LED.

request/rgb_led_bricklet/<UID>/get_rgb_value
Anfrage:
  • keine Nutzdaten
Antwort:
  • r – Typ: int, Wertebereich: [0 bis 255], Standardwert: 0
  • g – Typ: int, Wertebereich: [0 bis 255], Standardwert: 0
  • b – Typ: int, Wertebereich: [0 bis 255], Standardwert: 0

Gibt die r, g und b Werte der LED zurück, wie von request/rgb_led_bricklet/<UID>/set_rgb_value gesetzt.

Fortgeschrittene Funktionen

request/rgb_led_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", "i", "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 'a', 'b', 'c', 'd', 'e', 'f', 'g' oder 'h' (Bricklet Anschluss) sein. Der Raspberry Pi HAT (Zero) Brick ist immer an Position 'i' und das 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.