Modbus - Sound Pressure Level Bricklet

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

API

Eine allgemeine Beschreibung der Modbus Protokollstruktur findet sich hier.

Grundfunktionen

BrickletSoundPressureLevel.get_decibel
Funktions ID:

1

Anfrage:

keine Nutzdaten

Antwort:
  • decibel -- uint16

Gibt die gemessenen Schalldruck in Dezibel zurück. Die Werte werden in dB/10 (Zehntel dB) zurückgegeben.

Das Bricklet unterstützt die Gewichtungen dB(A), dB(B), dB(C), dB(D), dB(Z) und ITU-R 468. Die Gewichtungsfunktion kann mittels set_configuration gesetzt werden.

Standardmäßig wird dB(A) genutzt.

Wenn der Wert periodisch benötigt wird, kann auch der CALLBACK_DECIBEL Callback verwendet werden. Der Callback wird mit der Funktion set_decibel_callback_configuration konfiguriert.

BrickletSoundPressureLevel.get_spectrum_low_level
Funktions ID:

5

Anfrage:

keine Nutzdaten

Antwort:
  • spectrum_length -- uint16
  • spectrum_chunk_offset -- uint16
  • spectrum_chunk_data -- uint16[30]

Gibt das Frequenzspektrum zurück. Die Länge des Spektrums liegt zwischen 512 (FFT Größe 1024) und 64 (FFT Größe 128). Siehe set_configuration.

Jedes Listen-Element ist eine Gruppe des FFTs. Die erste Gruppe stellt immer das DC Offset dar. Die anderen Gruppen haben eine Größe zwischen 40Hz (FFT Größe 1024) und 320Hz (FFT Größe 128).

Der Frequenzbereich des Spektrums besitzt immer einen Umfang von 0 bis 20480Hz (FFT wird auf Samples mit bis zu 40960Hz angewendet).

Die zurückgegebenen Daten sind bereits ausgeglichen, was bedeutet dass der Mikrofon-Frequenzgang kompensiert wurde, und die Gewichtungsfunktion wurde angewendet (siehe set_configuration für die zur Verfügung stehenden Gewichtungen). Für ein ungewichtets Spektrum kann dB(Z) genutzt werden.

Die Daten sind nicht in dB skaliert. Um diese in einer dB Form darzustellen muss die Formel f(x) = 20*log10(max(1, x/sqrt(2))) auf jeden Wert angewendet werden.

BrickletSoundPressureLevel.set_configuration
Funktions ID:

9

Anfrage:
  • fft_size -- uint8
  • weighting -- uint8
Antwort:

keine Antwort

Setzt die Sound Pressure Level Bricklet Konfiguration.

Verschiedene FFT Größen führen zu unterschiedlichen Abtastraten und FFT Größen. Umso größer die FFT Größe ist, umso genauer ist das Ergebnis der dB(X) Berechnung.

Verfügbare FFT Größen sind:

  • 1024: 512 Gruppen, 10 Samples pro Sekunde, jede Gruppe hat Größe 40Hz
  • 512: 256 Gruppen, 20 Samples per Sekunde, jede Gruppe hat Größe 80Hz
  • 256: 128 Gruppen, 40 Samples per Sekunde, jede Gruppe hat Größe 160Hz
  • 128: 64 Gruppen, 80 Samples pro Sekunde, jede Gruppe hat Größe 320Hz

Das Bricklet unterstützt verschiedene Gewichtungsfunktionen. Es kann zwischen dB(A), dB(B), dB(C), dB(D), dB(Z) und ITU-R 468 gewählt werden.

dB(A/B/C/D) sind Standard-Gewichtungskurven. dB(A) wird of genutzt um Lautstärke in Konzerten zu messen. dB(Z) besitzt keine Gewichtung und gibt die Daten ungewichtet zurück. ITU-R 468 ist ein ITU Gewichtungsstandard der hauptsächlich in UK und Europa verwendet wird.

Die Standardeinstellungen sind FFT Größe 1024 und Gewichtung dB(A).

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

  • 0: 128, für fft_size
  • 1: 256, für fft_size
  • 2: 512, für fft_size
  • 3: 1024, für fft_size
  • 0: a, für weighting
  • 1: b, für weighting
  • 2: c, für weighting
  • 3: d, für weighting
  • 4: z, für weighting
  • 5: itu r 468, für weighting
BrickletSoundPressureLevel.get_configuration
Funktions ID:

10

Anfrage:

keine Nutzdaten

Antwort:
  • fft_size -- uint8
  • weighting -- uint8

Gibt die Konfiguration, die mittels set_configuration gesetzt werden kann zurück.

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

  • 0: 128, für fft_size
  • 1: 256, für fft_size
  • 2: 512, für fft_size
  • 3: 1024, für fft_size
  • 0: a, für weighting
  • 1: b, für weighting
  • 2: c, für weighting
  • 3: d, für weighting
  • 4: z, für weighting
  • 5: itu r 468, für weighting

Fortgeschrittene Funktionen

BrickletSoundPressureLevel.get_spitfp_error_count
Funktions ID:

234

Anfrage:

keine Nutzdaten

Antwort:
  • error_count_ack_checksum -- uint32
  • error_count_message_checksum -- uint32
  • error_count_frame -- uint32
  • error_count_overflow -- uint32

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.

BrickletSoundPressureLevel.set_bootloader_mode
Funktions ID:

235

Anfrage:
  • mode -- uint8
Antwort:
  • status -- uint8

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 Bootlodaer- 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 Parameter dieser Funktion definiert:

  • 0: bootloader, für mode
  • 1: firmware, für mode
  • 2: bootloader wait for reboot, für mode
  • 3: firmware wait for reboot, für mode
  • 4: firmware wait for erase and reboot, für mode
  • 0: ok, für status
  • 1: invalid mode, für status
  • 2: no change, für status
  • 3: entry function not present, für status
  • 4: device identifier incorrect, für status
  • 5: crc mismatch, für status
BrickletSoundPressureLevel.get_bootloader_mode
Funktions ID:

236

Anfrage:

keine Nutzdaten

Antwort:
  • mode -- uint8

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

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

  • 0: bootloader, für mode
  • 1: firmware, für mode
  • 2: bootloader wait for reboot, für mode
  • 3: firmware wait for reboot, für mode
  • 4: firmware wait for erase and reboot, für mode
BrickletSoundPressureLevel.set_write_firmware_pointer
Funktions ID:

237

Anfrage:
  • pointer -- uint32
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.

BrickletSoundPressureLevel.write_firmware
Funktions ID:

238

Anfrage:
  • data -- uint8[64]
Antwort:
  • status -- uint8

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.

BrickletSoundPressureLevel.set_status_led_config
Funktions ID:

239

Anfrage:
  • config -- uint8
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 Parameter dieser Funktion definiert:

  • 0: off, für config
  • 1: on, für config
  • 2: show heartbeat, für config
  • 3: show status, für config
BrickletSoundPressureLevel.get_status_led_config
Funktions ID:

240

Anfrage:

keine Nutzdaten

Antwort:
  • config -- uint8

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

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

  • 0: off, für config
  • 1: on, für config
  • 2: show heartbeat, für config
  • 3: show status, für config
BrickletSoundPressureLevel.get_chip_temperature
Funktions ID:

242

Anfrage:

keine Nutzdaten

Antwort:
  • temperature -- int16

Gibt die Temperatur in °C, 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.

BrickletSoundPressureLevel.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.

BrickletSoundPressureLevel.write_uid
Funktions ID:

248

Anfrage:
  • uid -- uint32
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.

BrickletSoundPressureLevel.read_uid
Funktions ID:

249

Anfrage:

keine Nutzdaten

Antwort:
  • uid -- uint32

Gibt die aktuelle UID als Integer zurück. Dieser Integer kann als Base58 encodiert werden um an den üblichen UID-String zu gelangen.

BrickletSoundPressureLevel.get_identity
Funktions ID:

255

Anfrage:

keine Nutzdaten

Antwort:
  • uid -- char[8]
  • connected_uid -- char[8]
  • position -- char
  • hardware_version -- uint8[3]
  • firmware_version -- uint8[3]
  • device_identifier -- uint16

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 kann 'a', 'b', 'c' oder 'd' sein.

Eine Liste der Device Identifier Werte ist hier zu finden. 

Konfigurationsfunktionen für Callbacks

BrickletSoundPressureLevel.set_decibel_callback_configuration
Funktions ID:

2

Anfrage:
  • period -- uint32
  • value_has_to_change -- bool
  • option -- char
  • min -- uint16
  • max -- uint16
Antwort:

keine Antwort

Die Periode in ms ist die Periode mit der der CALLBACK_DECIBEL Callback ausgelöst wird. Ein Wert von 0 schaltet den Callback ab.

Wenn der value has to change-Parameter auf True gesetzt wird, wird der Callback nur ausgelöst, wenn der Wert sich im Vergleich zum letzten mal geändert hat. Ändert der Wert sich nicht innerhalb der Periode, so wird der Callback sofort ausgelöst, wenn der Wert sich das nächste mal ändert.

Wird der Parameter auf False gesetzt, so wird der Callback dauerhaft mit der festen Periode ausgelöst unabhängig von den Änderungen des Werts.

Desweiteren ist es möglich den Callback mittels Thresholds einzuschränken.

Der option-Parameter`zusammen mit min/max setzt einen Threshold für den CALLBACK_DECIBEL Callback.

Die folgenden Optionen sind möglich:

Option Beschreibung
'x' Threshold ist abgeschaltet
'o' Threshold wird ausgelöst, wenn der Wert außerhalb der Min und Max Werte sind
'i' Threshold wird ausgelöst, wenn der Wert innerhalb der Min und Max Werte sind
'<' Threshold wird ausgelöst, wenn der Wert kleiner ist wie der Min Wert (Max wird ignoriert)
'>' Threshold wird ausgelöst, wenn der Wert größer ist wie der Max Wert (Min wird ignoriert)

Wird die Option auf 'x' gesetzt (Threshold abgeschaltet), so wird der Callback mit der festen Periode ausgelöst.

Der Standardwert ist (0, false, 'x', 0, 0).

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

  • x: off, für option
  • o: outside, für option
  • i: inside, für option
  • <: smaller, für option
  • >: greater, für option
BrickletSoundPressureLevel.get_decibel_callback_configuration
Funktions ID:

3

Anfrage:

keine Nutzdaten

Antwort:
  • period -- uint32
  • value_has_to_change -- bool
  • option -- char
  • min -- uint16
  • max -- uint16

Gibt die Callback-Konfiguration zurück, wie mittels set_decibel_callback_configuration gesetzt.

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

  • x: off, für option
  • o: outside, für option
  • i: inside, für option
  • <: smaller, für option
  • >: greater, für option
BrickletSoundPressureLevel.set_spectrum_callback_configuration
Funktions ID:

6

Anfrage:
  • period -- uint32
Antwort:

keine Antwort

Die Periode in ms ist die Periode mit der der CALLBACK_SPECTRUM_LOW_LEVEL Callback ausgelöst wird. Ein Wert von 0 schaltet den Callback ab.

Jedes gemessene Spektrum wird maximal einmal gesendet. Setze die Periode auf 1 um sicher zu stellen das jedes Spektrum gesendet wird.

Der Standardwert ist 0.

BrickletSoundPressureLevel.get_spectrum_callback_configuration
Funktions ID:

7

Anfrage:

keine Nutzdaten

Antwort:
  • period -- uint32

Gibt die Callback-Konfiguration zurück, wie mittels get_spectrum_callback_configuration gesetzt.

Callbacks

BrickletSoundPressureLevel.CALLBACK_DECIBEL
Funktions ID:

4

Antwort:
  • decibel -- uint16

Dieser Callback wird periodisch ausgelöst abhängig von der mittels set_decibel_callback_configuration gesetzten Konfiguration

Der Rückgabewert ist der gleiche wie get_decibel.

BrickletSoundPressureLevel.CALLBACK_SPECTRUM_LOW_LEVEL
Funktions ID:

8

Antwort:
  • spectrum_length -- uint16
  • spectrum_chunk_offset -- uint16
  • spectrum_chunk_data -- uint16[30]

Dieser Callback wird periodisch ausgelöst abhängig von der mittels set_spectrum_callback_configuration gesetzten Konfiguration

Der Rückgabewert ist der gleiche wie get_spectrum_low_level.