MQTT - Piezo Speaker Bricklet¶

Beep¶

Download (example-beep.txt)

1
2
3
4
5

# Change XYZ to the UID of your Piezo Speaker Bricklet

setup:
    # Make 2 second beep with a frequency of 1kHz
    publish '{"duration": 2000, "frequency": 1000}' to tinkerforge/request/piezo_speaker_bricklet/XYZ/beep

Morse Code¶

Download (example-morse-code.txt)

1
2
3
4
5

# Change XYZ to the UID of your Piezo Speaker Bricklet

setup:
    # Morse SOS with a frequency of 2kHz
    publish '{"morse": "... --- ...", "frequency": 2000}' to tinkerforge/request/piezo_speaker_bricklet/XYZ/morse_code

Grundfunktionen¶

request/piezo_speaker_bricklet/<UID>/beep¶

Anfrage:	duration – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1] mit Symbolen frequency – Typ: int, Einheit: 1 Hz, Wertebereich: [585 bis 7100]
Antwort:	keine Antwort

Erzeugt einen Piepton mit der gegebenen Frequenz für die angegebene Dauer.

Geändert in Version 2.0.2 (Plugin): Eine durarion von 0 stoppt den aktuellen Piepton, der frequency Parameter wird ignoriert. Eine durarion von 4294967295 führt zu einem unendlich langen Piepton.

Das Piezo Speaker Bricklet kann die angegebenen Frequenzen nur approximieren, es wählt die bestmögliche Zuordnung anhand der Kalibrierung (siehe request/piezo_speaker_bricklet/<UID>/calibrate).

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

Für duration:

• "off" = 0
• "infinite" = 4294967295

request/piezo_speaker_bricklet/<UID>/morse_code¶

Anfrage:	morse – Typ: string, Länge: bis zu 60 frequency – Typ: int, Einheit: 1 Hz, Wertebereich: [585 bis 7100]
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_speaker_bricklet/<UID>/calibrate¶

Anfrage:	keine Nutzdaten
Antwort:	calibration – Typ: bool

Das Piezo Speaker Bricklet kann 512 unterschiedliche Töne spielen. Diese Funktion spielt jeden Ton einmal und misst die exakte Frequenz zurück. Das Ergebnis ist eine Zuordnung von Stellwerten zu Frequenzen. Diese Zuordnung wird im EEPROM gespeichert und bei jedem start des Bricklets geladen.

Das Bricklet sollte bei Auslieferung bereits kalibriert sein. Diese Funktion muss lediglich (einmalig) nach jedem neuflashen des Bricklet-Plugins ausgeführt werden.

Gibt true nach Abschluss der Kalibrierung zurück.

request/piezo_speaker_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 Speaker.

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/piezo_speaker_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_speaker_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_speaker_bricklet/<UID>/beep_finished[/<SUFFIX>]-Topic veröffentlicht.

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

register/piezo_speaker_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_speaker_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_speaker_bricklet/<UID>/morse_code_finished[/<SUFFIX>]-Topic veröffentlicht.

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