Modbus - Piezo Speaker Bricklet 2.0

Dies ist die Beschreibung des Modbus Protokolls für das Piezo Speaker Bricklet 2.0. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des Piezo Speaker Bricklet 2.0 sind in dessen Hardware Beschreibung zusammengefasst.

API

Eine allgemeine Beschreibung der Modbus Protokollstruktur findet sich hier.

Grundfunktionen

BrickletPiezoSpeakerV2.set_beep
Funktions-ID:
  • 1
Anfrage:
  • frequency – Typ: uint16, Einheit: 1 Hz, Wertebereich: [50 bis 15000]
  • volume – Typ: uint8, Wertebereich: [0 bis 10]
  • duration – Typ: uint32, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1] mit Bedeutungen
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 Bedeutungen sind für die Elemente dieser Funktion definiert:

Für duration:

  • 0 = Off
  • 4294967295 = Infinite
BrickletPiezoSpeakerV2.get_beep
Funktions-ID:
  • 2
Anfrage:
  • keine Nutzdaten
Antwort:
  • frequency – Typ: uint16, Einheit: 1 Hz, Wertebereich: [50 bis 15000]
  • volume – Typ: uint8, Wertebereich: [0 bis 10]
  • duration – Typ: uint32, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1] mit Bedeutungen
  • duration_remaining – Typ: uint32, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1]

Gibt die letzten Beep-Einstellungen zurück, wie von 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 update_frequency oder update_volume), gibt diese Funktion die aktualisierten Werte zurück.

Die folgenden Bedeutungen sind für die Elemente dieser Funktion definiert:

Für duration:

  • 0 = Off
  • 4294967295 = Infinite
BrickletPiezoSpeakerV2.set_alarm
Funktions-ID:
  • 3
Anfrage:
  • start_frequency – Typ: uint16, Einheit: 1 Hz, Wertebereich: [50 bis 14999]
  • end_frequency – Typ: uint16, Einheit: 1 Hz, Wertebereich: [51 bis 15000]
  • step_size – Typ: uint16, Einheit: 1 Hz, Wertebereich: [50 bis 14950]
  • step_delay – Typ: uint16, Einheit: 1 ms, Wertebereich: [0 bis 216 - 1]
  • volume – Typ: uint8, Wertebereich: [0 bis 10]
  • duration – Typ: uint32, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1] mit Bedeutungen
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 Bedeutungen sind für die Elemente dieser Funktion definiert:

Für duration:

  • 0 = Off
  • 4294967295 = Infinite
BrickletPiezoSpeakerV2.get_alarm
Funktions-ID:
  • 4
Anfrage:
  • keine Nutzdaten
Antwort:
  • start_frequency – Typ: uint16, Einheit: 1 Hz, Wertebereich: [50 bis 14999]
  • end_frequency – Typ: uint16, Einheit: 1 Hz, Wertebereich: [51 bis 15000]
  • step_size – Typ: uint16, Einheit: 1 Hz, Wertebereich: [50 bis 14950]
  • step_delay – Typ: uint16, Einheit: 1 ms, Wertebereich: [0 bis 216 - 1]
  • volume – Typ: uint8, Wertebereich: [0 bis 10]
  • duration – Typ: uint32, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1] mit Bedeutungen
  • duration_remaining – Typ: uint32, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1] mit Bedeutungen
  • current_frequency – Typ: uint16, Einheit: 1 Hz, Wertebereich: [50 bis 15000]

Gibt die letzten Alarm-Einstellungen zurück, wie von 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 update_volume), gibt diese Funktion die aktualisierten Werte zurück.

Die folgenden Bedeutungen sind für die Elemente dieser Funktion definiert:

Für duration:

  • 0 = Off
  • 4294967295 = Infinite

Für duration_remaining:

  • 0 = Off
  • 4294967295 = Infinite
BrickletPiezoSpeakerV2.update_volume
Funktions-ID:
  • 5
Anfrage:
  • volume – Typ: uint8, Wertebereich: [0 bis 10]
Antwort:
  • keine Antwort

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

BrickletPiezoSpeakerV2.update_frequency
Funktions-ID:
  • 6
Anfrage:
  • frequency – Typ: uint16, Einheit: 1 Hz, Wertebereich: [50 bis 15000]
Antwort:
  • keine Antwort

Aktualisiert die Frequenz eines aktuell laufenden Beeps.

Fortgeschrittene Funktionen

BrickletPiezoSpeakerV2.get_spitfp_error_count
Funktions-ID:
  • 234
Anfrage:
  • keine Nutzdaten
Antwort:
  • error_count_ack_checksum – Typ: uint32, Wertebereich: [0 bis 232 - 1]
  • error_count_message_checksum – Typ: uint32, Wertebereich: [0 bis 232 - 1]
  • error_count_frame – Typ: uint32, Wertebereich: [0 bis 232 - 1]
  • error_count_overflow – Typ: uint32, 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.

BrickletPiezoSpeakerV2.set_bootloader_mode
Funktions-ID:
  • 235
Anfrage:
  • mode – Typ: uint8, Wertebereich: Siehe Bedeutungen
Antwort:
  • status – Typ: uint8, Wertebereich: Siehe Bedeutungen

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 Bedeutungen sind für die Elemente dieser Funktion definiert:

Für mode:

  • 0 = Bootloader
  • 1 = Firmware
  • 2 = Bootloader Wait For Reboot
  • 3 = Firmware Wait For Reboot
  • 4 = Firmware Wait For Erase And Reboot

Für status:

  • 0 = OK
  • 1 = Invalid Mode
  • 2 = No Change
  • 3 = Entry Function Not Present
  • 4 = Device Identifier Incorrect
  • 5 = CRC Mismatch
BrickletPiezoSpeakerV2.get_bootloader_mode
Funktions-ID:
  • 236
Anfrage:
  • keine Nutzdaten
Antwort:
  • mode – Typ: uint8, Wertebereich: Siehe Bedeutungen

Gibt den aktuellen Bootloader-Modus zurück, siehe set_bootloader_mode.

Die folgenden Bedeutungen sind für die Elemente dieser Funktion definiert:

Für mode:

  • 0 = Bootloader
  • 1 = Firmware
  • 2 = Bootloader Wait For Reboot
  • 3 = Firmware Wait For Reboot
  • 4 = Firmware Wait For Erase And Reboot
BrickletPiezoSpeakerV2.set_write_firmware_pointer
Funktions-ID:
  • 237
Anfrage:
  • pointer – Typ: uint32, Einheit: 1 B, Wertebereich: [0 bis 232 - 1]
Antwort:
  • keine Antwort

Setzt den Firmware-Pointer für 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.

BrickletPiezoSpeakerV2.write_firmware
Funktions-ID:
  • 238
Anfrage:
  • data – Typ: uint8[64], Wertebereich: [0 bis 255]
Antwort:
  • status – Typ: uint8, Wertebereich: [0 bis 255]

Schreibt 64 Bytes Firmware an die Position die vorher von 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.

BrickletPiezoSpeakerV2.set_status_led_config
Funktions-ID:
  • 239
Anfrage:
  • config – Typ: uint8, Wertebereich: Siehe Bedeutungen, 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 Bedeutungen sind für die Elemente dieser Funktion definiert:

Für config:

  • 0 = Off
  • 1 = On
  • 2 = Show Heartbeat
  • 3 = Show Status
BrickletPiezoSpeakerV2.get_status_led_config
Funktions-ID:
  • 240
Anfrage:
  • keine Nutzdaten
Antwort:
  • config – Typ: uint8, Wertebereich: Siehe Bedeutungen, Standardwert: 3

Gibt die Konfiguration zurück, wie von set_status_led_config gesetzt.

Die folgenden Bedeutungen sind für die Elemente dieser Funktion definiert:

Für config:

  • 0 = Off
  • 1 = On
  • 2 = Show Heartbeat
  • 3 = Show Status
BrickletPiezoSpeakerV2.get_chip_temperature
Funktions-ID:
  • 242
Anfrage:
  • keine Nutzdaten
Antwort:
  • temperature – Typ: int16, 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.

BrickletPiezoSpeakerV2.reset
Funktions-ID:
  • 243
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.

BrickletPiezoSpeakerV2.write_uid
Funktions-ID:
  • 248
Anfrage:
  • uid – Typ: uint32, 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.

BrickletPiezoSpeakerV2.read_uid
Funktions-ID:
  • 249
Anfrage:
  • keine Nutzdaten
Antwort:
  • uid – Typ: uint32, 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.

BrickletPiezoSpeakerV2.get_identity
Funktions-ID:
  • 255
Anfrage:
  • keine Nutzdaten
Antwort:
  • uid – Typ: char[8]
  • connected_uid – Typ: char[8]
  • position – Typ: char, Wertebereich: ['a' bis 'h', 'i', 'z']
  • hardware_version – Typ: uint8[3]
    • 0: major – Typ: uint8, Wertebereich: [0 bis 255]
    • 1: minor – Typ: uint8, Wertebereich: [0 bis 255]
    • 2: revision – Typ: uint8, Wertebereich: [0 bis 255]
  • firmware_version – Typ: uint8[3]
    • 0: major – Typ: uint8, Wertebereich: [0 bis 255]
    • 1: minor – Typ: uint8, Wertebereich: [0 bis 255]
    • 2: revision – Typ: uint8, Wertebereich: [0 bis 255]
  • device_identifier – Typ: uint16, Wertebereich: [0 bis 216 - 1]

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. 

Callbacks

BrickletPiezoSpeakerV2.CALLBACK_BEEP_FINISHED
Funktions-ID:
  • 7
Antwort:
  • keine Nutzdaten

Dieser Callback wird ausgelöst, wenn ein Piepton, wie von set_beep gesetzt, beendet wurde.

BrickletPiezoSpeakerV2.CALLBACK_ALARM_FINISHED
Funktions-ID:
  • 8
Antwort:
  • keine Nutzdaten

Dieser Callback wird ausgelöst, wenn ein Alarm, wie von set_alarm gesetzt, beendet wurde.