Deutsch
English
Menu
Software / API Bindings / MQTT / API Referenz und Beispiele / Bricklets (Abgekündigt) / Piezo Buzzer Bricklet

MQTT - Piezo Buzzer Bricklet

Dies ist die Beschreibung der MQTT API Bindings für das Piezo Buzzer Bricklet. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des Piezo Buzzer 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).

Beep

Download (example-beep.txt)

1
2
3
4
5
# Change XYZ to the UID of your Piezo Buzzer Bricklet

setup:
    # Make 2 second beep
    publish '{"duration": 2000}' to tinkerforge/request/piezo_buzzer_bricklet/XYZ/beep

Morse Code

Download (example-morse-code.txt)

1
2
3
4
5
# Change XYZ to the UID of your Piezo Buzzer Bricklet

setup:
    # Morse SOS
    publish '{"morse": "... --- ..."}' to tinkerforge/request/piezo_buzzer_bricklet/XYZ/morse_code

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/piezo_buzzer_bricklet/<UID>/beep
Anfrage:
  • duration – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1]
Antwort:
  • keine Antwort

Erzeugt einen Piepton für die angegebene Dauer.

request/piezo_buzzer_bricklet/<UID>/morse_code
Anfrage:
  • morse – Typ: string, Länge: bis zu 60
Antwort:
  • keine Antwort

Setzt Morsecode welcher vom Piezosummer abgespielt wird. Der Morsecode wird als Zeichenkette, mit den Zeichen "." (Punkt), "-" (Minus) und " " (Leerzeichen) für kurzes Signale, langes Signale und Pausen. Alle anderen Zeichen werden ignoriert.

Beispiel: Wenn die Zeichenkette "...---..." gesetzt wird, gibt der Piezosummer neun Pieptöne aus mit den Dauern "kurz kurz kurz lang lang lang kurz kurz kurz".

Fortgeschrittene Funktionen

request/piezo_buzzer_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 Piezo Buzzer.

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/piezo_buzzer_bricklet/<UID>/beep_finished
Registrierungsanfrage:
  • register – Typ: bool
Callback-Antwort:
  • keine Nutzdaten

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

Dieser Callback wird ausgelöst, wenn ein Piepton, wie von request/piezo_buzzer_bricklet/<UID>/beep gesetzt, beendet wurde.

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

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

Dieser Callback wird ausgelöst, wenn die Wiedergabe des Morsecodes, wie von request/piezo_buzzer_bricklet/<UID>/morse_code gesetzt, beendet wurde.