MQTT - Segment Display 4x7 Bricklet

Dies ist die Beschreibung der MQTT API Bindings für das Segment Display 4x7 Bricklet. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des Segment Display 4x7 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
6
7
# Change XYZ to the UID of your Segment Display 4x7 Bricklet

setup:
    # 102 = 0x66 = the segments to show a 4
    # 91  = 0x5b = the segments to show a 2
    # 79  = 0x4f = the segments to show a 3
    publish {"segments": [102, 91, 91, 79], "brightness": 7, "colon": false} to tinkerforge/request/segment_display_4x7_bricklet/XYZ/set_segments # Will display 4223

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/segment_display_4x7_bricklet/<UID>/set_segments
Anfrage:
  • segments – Typ: [int, ...], Länge: 4, Wertebereich: [0 bis 127]
  • brightness – Typ: int, Wertebereich: [0 bis 7]
  • colon – Typ: bool
Antwort:
  • keine Antwort

Die 7-Segment-Anzeige kann mit Bitmaps gesetzt werden. Jedes Bit kontrolliert ein Segment:

Bitreihenfolge eines Segments

Beispiel: Um eine "5" auf der Anzeige darzustellen müssen die Segment 0, 2, 3, 5 und 6 aktiviert werden. Dies kann mit der Zahl 0b01101101 = 0x6d = 109 repräsentiert werden.

Die Helligkeit kann zwischen 0 (dunkel) und 7 (hell) gesetzt werden. Der dritte Parameter aktiviert/deaktiviert den Doppelpunkt auf der Anzeige.

request/segment_display_4x7_bricklet/<UID>/get_segments
Anfrage:
  • keine Nutzdaten
Antwort:
  • segments – Typ: [int, ...], Länge: 4, Wertebereich: [0 bis 127]
  • brightness – Typ: int, Wertebereich: [0 bis 7]
  • colon – Typ: bool

Gibt die Segment-, Helligkeit- und Doppelpunktdaten zurück, wie von request/segment_display_4x7_bricklet/<UID>/set_segments gesetzt.

Fortgeschrittene Funktionen

request/segment_display_4x7_bricklet/<UID>/start_counter
Anfrage:
  • value_from – Typ: int, Wertebereich: [-999 bis 9999]
  • value_to – Typ: int, Wertebereich: [-999 bis 9999]
  • increment – Typ: int, Wertebereich: [-999 bis 9999]
  • length – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1]
Antwort:
  • keine Antwort

Starter einen Zähler mit dem from Wert der bis zum to Wert Zählt mit einer Schrittweite von increment. Das Argument length ist die Länge der Pause zwischen zwei Inkrements.

Beispiel: Wenn from auf 0, to auf 100, increment auf 1 und length auf 1000 gesetzt wird, wird ein Zähler gestartet der von 0 bis 100 zählt mit Rate von einer Sekunde zwischen jeder Erhöhung.

Wenn das increment negativ ist läuft der Zähler rückwärts.

Der Zähler kann jederzeit durch einen Aufruf von request/segment_display_4x7_bricklet/<UID>/set_segments gestoppt werden.

request/segment_display_4x7_bricklet/<UID>/get_counter_value
Anfrage:
  • keine Nutzdaten
Antwort:
  • value – Typ: int, Wertebereich: [-999 bis 9999]

Gibt den aktuellen Zählerstand zurück der auf der Anzeige angezeigt wird.

Wenn kein Zähler am laufen ist wird eine 0 zurückgegeben.

request/segment_display_4x7_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 Segment Display 4x7.

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.

Bemerkung

Callbacks für wiederkehrende Ereignisse zu verwenden ist immer zu bevorzugen gegenüber der Verwendung von Abfragen. Es wird weniger USB-Bandbreite benutzt und die Latenz ist erheblich geringer, da es keine Paketumlaufzeit gibt.

register/segment_display_4x7_bricklet/<UID>/counter_finished
Registrierungsanfrage:
  • register – Typ: bool
Callback-Antwort:
  • keine Nutzdaten

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

Diese Callback wird ausgelöst, wenn der Zähler (siehe request/segment_display_4x7_bricklet/<UID>/start_counter) fertig ist.