MQTT - Sound Pressure Level Bricklet¶

Simple¶

Download (example-simple.txt)

1
2
3
4
5
6

# Change XYZ to the UID of your Sound Pressure Level Bricklet

setup:
    # Get current decibel
    subscribe to tinkerforge/response/sound_pressure_level_bricklet/XYZ/get_decibel
    publish '' to tinkerforge/request/sound_pressure_level_bricklet/XYZ/get_decibel

Callback¶

Download (example-callback.txt)

1
2
3
4
5
6
7
8
9

# Change XYZ to the UID of your Sound Pressure Level Bricklet

setup:
    # Handle incoming decibel callbacks
    subscribe to tinkerforge/callback/sound_pressure_level_bricklet/XYZ/decibel
    publish '{"register": true}' to tinkerforge/register/sound_pressure_level_bricklet/XYZ/decibel # Register decibel callback

    # Set period for decibel callback to 1s (1000ms) without a threshold
    publish '{"period": 1000, "value_has_to_change": false, "option": "off", "min": 0, "max": 0}' to tinkerforge/request/sound_pressure_level_bricklet/XYZ/set_decibel_callback_configuration

Threshold¶

Download (example-threshold.txt)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10

# Change XYZ to the UID of your Sound Pressure Level Bricklet

setup:
    # Handle incoming decibel callbacks
    subscribe to tinkerforge/callback/sound_pressure_level_bricklet/XYZ/decibel
    publish '{"register": true}' to tinkerforge/register/sound_pressure_level_bricklet/XYZ/decibel # Register decibel callback

    # Configure threshold for decibel "greater than 60 dB(A)"
    # with a debounce period of 1s (1000ms)
    publish '{"period": 1000, "value_has_to_change": false, "option": "greater", "min": 600, "max": 0}' to tinkerforge/request/sound_pressure_level_bricklet/XYZ/set_decibel_callback_configuration

Grundfunktionen¶

request/sound_pressure_level_bricklet/<UID>/get_decibel¶

Anfrage:	keine Nutzdaten
Antwort:	decibel – Typ: int, Einheit: 1/10 dB, Wertebereich: [0 bis 120]

Gibt die gemessenen Schalldruck in Dezibel zurück.

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

Standardmäßig wird dB(A) genutzt.

Wenn der Wert periodisch benötigt wird, kann auch der register/sound_pressure_level_bricklet/<UID>/decibel Callback verwendet werden. Der Callback wird mit der Funktion request/sound_pressure_level_bricklet/<UID>/set_decibel_callback_configuration konfiguriert.

request/sound_pressure_level_bricklet/<UID>/get_spectrum¶

Anfrage:	keine Nutzdaten
Antwort:	spectrum – Typ: [int, ...], Länge: variabel, Einheit: ? dB, Wertebereich: [0 bis 216 - 1]

Gibt das Frequenzspektrum zurück. Die Länge des Spektrums liegt zwischen 512 (FFT Größe 1024) und 64 (FFT Größe 128). Siehe request/sound_pressure_level_bricklet/<UID>/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 request/sound_pressure_level_bricklet/<UID>/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.

request/sound_pressure_level_bricklet/<UID>/set_configuration¶

Anfrage:	fft_size – Typ: int, Wertebereich: Siehe Symbole, Standardwert: 3 weighting – Typ: int, Wertebereich: Siehe Symbole, Standardwert: 0
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 folgenden Symbole sind für diese Funktion verfügbar:

Für fft_size:

• "128" = 0
• "256" = 1
• "512" = 2
• "1024" = 3

Für weighting:

• "a" = 0
• "b" = 1
• "c" = 2
• "d" = 3
• "z" = 4
• "itu_r_468" = 5

request/sound_pressure_level_bricklet/<UID>/get_configuration¶

Anfrage:	keine Nutzdaten
Antwort:	fft_size – Typ: int, Wertebereich: Siehe Symbole, Standardwert: 3 weighting – Typ: int, Wertebereich: Siehe Symbole, Standardwert: 0

Gibt die Konfiguration, die mittels request/sound_pressure_level_bricklet/<UID>/set_configuration gesetzt werden kann zurück.

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

Für fft_size:

• "128" = 0
• "256" = 1
• "512" = 2
• "1024" = 3

Für weighting:

• "a" = 0
• "b" = 1
• "c" = 2
• "d" = 3
• "z" = 4
• "itu_r_468" = 5

Fortgeschrittene Funktionen¶

request/sound_pressure_level_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/sound_pressure_level_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/sound_pressure_level_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/sound_pressure_level_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/sound_pressure_level_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/sound_pressure_level_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/sound_pressure_level_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 Sound Pressure Level.

Konfigurationsfunktionen für Callbacks¶

request/sound_pressure_level_bricklet/<UID>/set_decibel_callback_configuration¶

Anfrage:	period – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0 value_has_to_change – Typ: bool, Standardwert: false option – Typ: char, Wertebereich: Siehe Symbole, Standardwert: "x" min – Typ: int, Einheit: 1/10 dB, Wertebereich: [0 bis 216 - 1], Standardwert: 0 max – Typ: int, Einheit: 1/10 dB, Wertebereich: [0 bis 216 - 1], Standardwert: 0
Antwort:	keine Antwort

Die Periode ist die Periode mit der der register/sound_pressure_level_bricklet/<UID>/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 register/sound_pressure_level_bricklet/<UID>/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.

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

Für option:

• "off" = "x"
• "outside" = "o"
• "inside" = "i"
• "smaller" = "<"
• "greater" = ">"

request/sound_pressure_level_bricklet/<UID>/get_decibel_callback_configuration¶

Anfrage:	keine Nutzdaten
Antwort:	period – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0 value_has_to_change – Typ: bool, Standardwert: false option – Typ: char, Wertebereich: Siehe Symbole, Standardwert: "x" min – Typ: int, Einheit: 1/10 dB, Wertebereich: [0 bis 216 - 1], Standardwert: 0 max – Typ: int, Einheit: 1/10 dB, Wertebereich: [0 bis 216 - 1], Standardwert: 0

Gibt die Callback-Konfiguration zurück, wie mittels request/sound_pressure_level_bricklet/<UID>/set_decibel_callback_configuration gesetzt.

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

Für option:

• "off" = "x"
• "outside" = "o"
• "inside" = "i"
• "smaller" = "<"
• "greater" = ">"

request/sound_pressure_level_bricklet/<UID>/set_spectrum_callback_configuration¶

Anfrage:	period – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0
Antwort:	keine Antwort

Die Periode ist die Periode mit der der register/sound_pressure_level_bricklet/<UID>/spectrum 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.

request/sound_pressure_level_bricklet/<UID>/get_spectrum_callback_configuration¶

Anfrage:	keine Nutzdaten
Antwort:	period – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0

Gibt die Callback-Konfiguration zurück, wie mittels request/sound_pressure_level_bricklet/<UID>/get_spectrum_callback_configuration gesetzt.

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/sound_pressure_level_bricklet/<UID>/decibel¶

Registrierungsanfrage:	register – Typ: bool
Callback-Antwort:	decibel – Typ: int, Einheit: 1/10 dB, Wertebereich: [0 bis 120]

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

Dieser Callback wird periodisch ausgelöst abhängig von der mittels request/sound_pressure_level_bricklet/<UID>/set_decibel_callback_configuration gesetzten Konfiguration

Der Payload des Callbacks ist der gleiche wie request/sound_pressure_level_bricklet/<UID>/get_decibel.

register/sound_pressure_level_bricklet/<UID>/spectrum¶

Registrierungsanfrage:	register – Typ: bool
Callback-Antwort:	spectrum – Typ: [int, ...], Länge: variabel, Einheit: ? dB, Wertebereich: [0 bis 216 - 1]

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

Dieser Callback wird periodisch ausgelöst abhängig von der mittels request/sound_pressure_level_bricklet/<UID>/set_spectrum_callback_configuration gesetzten Konfiguration

Der Payload des Callbacks ist der gleiche wie request/sound_pressure_level_bricklet/<UID>/get_spectrum.

Bemerkung

Falls das Rekonstruieren des Wertes fehlschlägt, wird der Callback mit null für spectrum ausgelöst.

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/sound_pressure_level_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/sound_pressure_level_bricklet/<UID>/get_bootloader_mode¶

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

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