MQTT - Piezo Speaker Bricklet 2.0¶

Alarm¶

Download (example-alarm.txt)

1
2
3
4
5

# Change XYZ to the UID of your Piezo Speaker Bricklet 2.0

setup:
    # 10 seconds of loud annoying fast alarm
    publish '{"start_frequency": 800, "end_frequency": 2000, "step_size": 10, "step_delay": 1, "volume": 10, "duration": 10000}' to tinkerforge/request/piezo_speaker_v2_bricklet/XYZ/set_alarm

Beep¶

Download (example-beep.txt)

1
2
3
4
5

# Change XYZ to the UID of your Piezo Speaker Bricklet 2.0

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

Grundfunktionen¶

request/piezo_speaker_v2_bricklet/<UID>/set_beep¶

Anfrage:	frequency – Typ: int, Einheit: 1 Hz, Wertebereich: [50 bis 15000] volume – Typ: int, Wertebereich: [0 bis 10] duration – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1] mit Symbolen
Antwort:	keine Antwort

Erzeugt einen Piepton mit der gegebenen Frequenz und Lautstärke für die angegebene Dauer.

Eine duration von 0 stoppt den aktuellen Piepton. Eine duration von 4294967295 führt zu einem unendlich langen Piepton.

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

Für duration:

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

request/piezo_speaker_v2_bricklet/<UID>/get_beep¶

Anfrage:	keine Nutzdaten
Antwort:	frequency – Typ: int, Einheit: 1 Hz, Wertebereich: [50 bis 15000] volume – Typ: int, Wertebereich: [0 bis 10] duration – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1] mit Symbolen duration_remaining – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1]

Gibt die letzten Beep-Einstellungen zurück, wie von request/piezo_speaker_v2_bricklet/<UID>/set_beep gesetzt. Wenn ein Beep aktuell läuft, wird auch die verbleibende Zeit des Beeps zurück gegeben.

Wenn die Frequenz oder Lautstärke während eines Beeps aktualisiert wird (mit request/piezo_speaker_v2_bricklet/<UID>/update_frequency oder request/piezo_speaker_v2_bricklet/<UID>/update_volume), gibt diese Funktion die aktualisierten Werte zurück.

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

Für duration:

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

request/piezo_speaker_v2_bricklet/<UID>/set_alarm¶

Anfrage:	start_frequency – Typ: int, Einheit: 1 Hz, Wertebereich: [50 bis 14999] end_frequency – Typ: int, Einheit: 1 Hz, Wertebereich: [51 bis 15000] step_size – Typ: int, Einheit: 1 Hz, Wertebereich: [0 bis 14950] step_delay – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 216 - 1] volume – Typ: int, Wertebereich: [0 bis 10] duration – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1] mit Symbolen
Antwort:	keine Antwort

Startet einen Alarm (Einen Ton der zwischen zwei spezifizierten Frequenzen hin und her läuft).

Die folgenden Parameter können genutzt werden:

• Start Frequency: Startfrequenz des Alarms.
• End Frequency: Endfrequenz des Alarms.
• Step Size: Schrittgröße eines Schritts im Frequenzdurchlauf zwischen Start-/Endfrequenz.
• Step Delay: Zeit zwischen zwei Schritten (Dauer eines Tons im Frequenzdurchlauf).
• Duration: Dauer des Alarm.

Nachfolgend gibt es zwei Beispiele zum ausprobieren. Diese Beispiele können als Startpunkt genutzt werden um ein Alarm-Signal passend für die eigene Anwendung zu entwerfen.

Beispiel 1: 10 Sekunden eines lauten nervigen schnellen Alarms

• Start Frequency = 800
• End Frequency = 2000
• Step Size = 10
• Step Delay = 1
• Volume = 10
• Duration = 10000

Beispiel 2: 10 Sekunden eines Sirenengeräusches mit langsamen Frequenzdurchlauf

• Start Frequency = 250
• End Frequency = 750
• Step Size = 1
• Step Delay = 5
• Volume = 0
• Duration = 10000

Die folgenden Einschränkungen müssen eingehalten werden:

• Start Frequency: muss kleiner als End Frequency sein
• End Frequency: muss größer als Start Frequency sein
• Step Size: muss klein genug sein um in den Frequenzbereich zu passen
• Step Delay: muss kleiner als Duration sein

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

Für duration:

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

request/piezo_speaker_v2_bricklet/<UID>/get_alarm¶

Anfrage:

keine Nutzdaten

Antwort:

start_frequency – Typ: int, Einheit: 1 Hz, Wertebereich: [50 bis 14999] end_frequency – Typ: int, Einheit: 1 Hz, Wertebereich: [51 bis 15000] step_size – Typ: int, Einheit: 1 Hz, Wertebereich: [50 bis 14950] step_delay – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 216 - 1] volume – Typ: int, Wertebereich: [0 bis 10] duration – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1] mit Symbolen duration_remaining – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1] mit Symbolen current_frequency – Typ: int, Einheit: 1 Hz, Wertebereich: [50 bis 15000]

Gibt die letzten Alarm-Einstellungen zurück, wie von request/piezo_speaker_v2_bricklet/<UID>/set_alarm gesetzt. Wenn ein Alarm aktuell läuft, wird auch die verbleibende Zeit des Alarms sowie die aktuelle Frequenz zurück gegeben.

Wenn die Lautstärke während eines Alarms aktualisiert wird (mit request/piezo_speaker_v2_bricklet/<UID>/update_volume), gibt diese Funktion die aktualisierten Werte zurück.

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

Für duration:

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

Für duration_remaining:

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

request/piezo_speaker_v2_bricklet/<UID>/update_volume¶

Anfrage:	volume – Typ: int, Wertebereich: [0 bis 10]
Antwort:	keine Antwort

Aktualisiert die Lautstärke eines aktuell laufenden Beep oder Alarm.

request/piezo_speaker_v2_bricklet/<UID>/update_frequency¶

Anfrage:	frequency – Typ: int, Einheit: 1 Hz, Wertebereich: [50 bis 15000]
Antwort:	keine Antwort

Aktualisiert die Frequenz eines aktuell laufenden Beeps.

Fortgeschrittene Funktionen¶

request/piezo_speaker_v2_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/piezo_speaker_v2_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/piezo_speaker_v2_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/piezo_speaker_v2_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/piezo_speaker_v2_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/piezo_speaker_v2_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/piezo_speaker_v2_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 2.0.

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_v2_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_v2_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_v2_bricklet/<UID>/beep_finished[/<SUFFIX>]-Topic veröffentlicht.

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

register/piezo_speaker_v2_bricklet/<UID>/alarm_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_v2_bricklet/<UID>/alarm_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_v2_bricklet/<UID>/alarm_finished[/<SUFFIX>]-Topic veröffentlicht.

Dieser Callback wird ausgelöst, wenn ein Alarm, wie von request/piezo_speaker_v2_bricklet/<UID>/set_alarm gesetzt, beendet wurde.

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/piezo_speaker_v2_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/piezo_speaker_v2_bricklet/<UID>/get_bootloader_mode¶

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

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