C/C++ - Sound Pressure Level Bricklet

Dies ist die Beschreibung der C/C++ API Bindings 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.

Eine Installationanleitung für die C/C++ API Bindings ist Teil deren allgemeine Beschreibung.

Beispiele

Der folgende Beispielcode ist Public Domain (CC0 1.0).

Simple

Download (example_simple.c)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
#include <stdio.h>

#include "ip_connection.h"
#include "bricklet_sound_pressure_level.h"

#define HOST "localhost"
#define PORT 4223
#define UID "XYZ" // Change XYZ to the UID of your Sound Pressure Level Bricklet

int main(void) {
    // Create IP connection
    IPConnection ipcon;
    ipcon_create(&ipcon);

    // Create device object
    SoundPressureLevel spl;
    sound_pressure_level_create(&spl, UID, &ipcon);

    // Connect to brickd
    if(ipcon_connect(&ipcon, HOST, PORT) < 0) {
        fprintf(stderr, "Could not connect\n");
        return 1;
    }
    // Don't use device before ipcon is connected

    // Get current decibel
    uint16_t decibel;
    if(sound_pressure_level_get_decibel(&spl, &decibel) < 0) {
        fprintf(stderr, "Could not get decibel, probably timeout\n");
        return 1;
    }

    printf("Decibel: %f dB(A)\n", decibel/10.0);

    printf("Press key to exit\n");
    getchar();
    sound_pressure_level_destroy(&spl);
    ipcon_destroy(&ipcon); // Calls ipcon_disconnect internally
    return 0;
}

Callback

Download (example_callback.c)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
#include <stdio.h>

#include "ip_connection.h"
#include "bricklet_sound_pressure_level.h"

#define HOST "localhost"
#define PORT 4223
#define UID "XYZ" // Change XYZ to the UID of your Sound Pressure Level Bricklet

// Callback function for decibel callback
void cb_decibel(uint16_t decibel, void *user_data) {
    (void)user_data; // avoid unused parameter warning

    printf("Decibel: %f dB(A)\n", decibel/10.0);
}

int main(void) {
    // Create IP connection
    IPConnection ipcon;
    ipcon_create(&ipcon);

    // Create device object
    SoundPressureLevel spl;
    sound_pressure_level_create(&spl, UID, &ipcon);

    // Connect to brickd
    if(ipcon_connect(&ipcon, HOST, PORT) < 0) {
        fprintf(stderr, "Could not connect\n");
        return 1;
    }
    // Don't use device before ipcon is connected

    // Register decibel callback to function cb_decibel
    sound_pressure_level_register_callback(&spl,
                                           SOUND_PRESSURE_LEVEL_CALLBACK_DECIBEL,
                                           (void (*)(void))cb_decibel,
                                           NULL);

    // Set period for decibel callback to 1s (1000ms) without a threshold
    sound_pressure_level_set_decibel_callback_configuration(&spl, 1000, false, 'x', 0, 0);

    printf("Press key to exit\n");
    getchar();
    sound_pressure_level_destroy(&spl);
    ipcon_destroy(&ipcon); // Calls ipcon_disconnect internally
    return 0;
}

Threshold

Download (example_threshold.c)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
#include <stdio.h>

#include "ip_connection.h"
#include "bricklet_sound_pressure_level.h"

#define HOST "localhost"
#define PORT 4223
#define UID "XYZ" // Change XYZ to the UID of your Sound Pressure Level Bricklet

// Callback function for decibel callback
void cb_decibel(uint16_t decibel, void *user_data) {
    (void)user_data; // avoid unused parameter warning

    printf("Decibel: %f dB(A)\n", decibel/10.0);
}

int main(void) {
    // Create IP connection
    IPConnection ipcon;
    ipcon_create(&ipcon);

    // Create device object
    SoundPressureLevel spl;
    sound_pressure_level_create(&spl, UID, &ipcon);

    // Connect to brickd
    if(ipcon_connect(&ipcon, HOST, PORT) < 0) {
        fprintf(stderr, "Could not connect\n");
        return 1;
    }
    // Don't use device before ipcon is connected

    // Register decibel callback to function cb_decibel
    sound_pressure_level_register_callback(&spl,
                                           SOUND_PRESSURE_LEVEL_CALLBACK_DECIBEL,
                                           (void (*)(void))cb_decibel,
                                           NULL);

    // Configure threshold for decibel "greater than 60 dB(A)"
    // with a debounce period of 1s (1000ms)
    sound_pressure_level_set_decibel_callback_configuration(&spl, 1000, false, '>', 60*10, 0);

    printf("Press key to exit\n");
    getchar();
    sound_pressure_level_destroy(&spl);
    ipcon_destroy(&ipcon); // Calls ipcon_disconnect internally
    return 0;
}

API

Jede Funktion der C/C++ Bindings gibt einen Integer zurück, welcher einen Fehlercode beschreibt. Vom Gerät zurückgegebene Daten werden, wenn eine Abfrage aufgerufen wurde, über Ausgabeparameter gehandhabt. Diese Parameter sind mit dem ret_ Präfix gekennzeichnet.

Mögliche Fehlercodes sind:

  • E_OK = 0
  • E_TIMEOUT = -1
  • E_NO_STREAM_SOCKET = -2
  • E_HOSTNAME_INVALID = -3
  • E_NO_CONNECT = -4
  • E_NO_THREAD = -5
  • E_NOT_ADDED = -6 (wird seit C/C++ Bindings Version 2.0.0 nicht mehr verwendet)
  • E_ALREADY_CONNECTED = -7
  • E_NOT_CONNECTED = -8
  • E_INVALID_PARAMETER = -9
  • E_NOT_SUPPORTED = -10
  • E_UNKNOWN_ERROR_CODE = -11
  • E_STREAM_OUT_OF_SYNC = -12
  • E_INVALID_UID = -13
  • E_NON_ASCII_CHAR_IN_SECRET = -14

wie in ip_connection.h definiert.

Alle folgend aufgelisteten Funktionen sind Thread-sicher.

Grundfunktionen

void sound_pressure_level_create(SoundPressureLevel *sound_pressure_level, const char *uid, IPConnection *ipcon)
Parameter:
  • sound_pressure_level – Typ: SoundPressureLevel *
  • uid – Typ: const char *
  • ipcon – Typ: IPConnection *

Erzeugt ein Geräteobjekt sound_pressure_level mit der eindeutigen Geräte ID uid und fügt es der IP Connection ipcon hinzu:

SoundPressureLevel sound_pressure_level;
sound_pressure_level_create(&sound_pressure_level, "YOUR_DEVICE_UID", &ipcon);

Dieses Geräteobjekt kann benutzt werden, nachdem die IP Connection verbunden wurde (siehe Beispiele oben).

void sound_pressure_level_destroy(SoundPressureLevel *sound_pressure_level)
Parameter:
  • sound_pressure_level – Typ: SoundPressureLevel *

Entfernt das Geräteobjekt sound_pressure_level von dessen IP Connection und zerstört es. Das Geräteobjekt kann hiernach nicht mehr verwendet werden.

int sound_pressure_level_get_decibel(SoundPressureLevel *sound_pressure_level, uint16_t *ret_decibel)
Parameter:
  • sound_pressure_level – Typ: SoundPressureLevel *
Ausgabeparameter:
  • ret_decibel – Typ: uint16_t, Einheit: 1/10 dB, Wertebereich: [0 bis 120]
Rückgabe:
  • error_code – Typ: int

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 sound_pressure_level_set_configuration() gesetzt werden.

Standardmäßig wird dB(A) genutzt.

Wenn der Wert periodisch benötigt wird, kann auch der SOUND_PRESSURE_LEVEL_CALLBACK_DECIBEL Callback verwendet werden. Der Callback wird mit der Funktion sound_pressure_level_set_decibel_callback_configuration() konfiguriert.

int sound_pressure_level_get_spectrum(SoundPressureLevel *sound_pressure_level, uint16_t *ret_spectrum, uint16_t *ret_spectrum_length)
Parameter:
  • sound_pressure_level – Typ: SoundPressureLevel *
Ausgabeparameter:
  • ret_spectrum – Typ: uint16_t *, Einheit: ? dB, Wertebereich: [0 bis 216 - 1]
  • ret_spectrum_length – Typ: uint16_t
Rückgabe:
  • error_code – Typ: int

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

int sound_pressure_level_set_configuration(SoundPressureLevel *sound_pressure_level, uint8_t fft_size, uint8_t weighting)
Parameter:
  • sound_pressure_level – Typ: SoundPressureLevel *
  • fft_size – Typ: uint8_t, Wertebereich: Siehe Konstanten, Standardwert: 3
  • weighting – Typ: uint8_t, Wertebereich: Siehe Konstanten, Standardwert: 0
Rückgabe:
  • error_code – Typ: int

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 Konstanten sind für diese Funktion verfügbar:

Für fft_size:

  • SOUND_PRESSURE_LEVEL_FFT_SIZE_128 = 0
  • SOUND_PRESSURE_LEVEL_FFT_SIZE_256 = 1
  • SOUND_PRESSURE_LEVEL_FFT_SIZE_512 = 2
  • SOUND_PRESSURE_LEVEL_FFT_SIZE_1024 = 3

Für weighting:

  • SOUND_PRESSURE_LEVEL_WEIGHTING_A = 0
  • SOUND_PRESSURE_LEVEL_WEIGHTING_B = 1
  • SOUND_PRESSURE_LEVEL_WEIGHTING_C = 2
  • SOUND_PRESSURE_LEVEL_WEIGHTING_D = 3
  • SOUND_PRESSURE_LEVEL_WEIGHTING_Z = 4
  • SOUND_PRESSURE_LEVEL_WEIGHTING_ITU_R_468 = 5
int sound_pressure_level_get_configuration(SoundPressureLevel *sound_pressure_level, uint8_t *ret_fft_size, uint8_t *ret_weighting)
Parameter:
  • sound_pressure_level – Typ: SoundPressureLevel *
Ausgabeparameter:
  • ret_fft_size – Typ: uint8_t, Wertebereich: Siehe Konstanten, Standardwert: 3
  • ret_weighting – Typ: uint8_t, Wertebereich: Siehe Konstanten, Standardwert: 0
Rückgabe:
  • error_code – Typ: int

Gibt die Konfiguration, die mittels sound_pressure_level_set_configuration() gesetzt werden kann zurück.

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

Für ret_fft_size:

  • SOUND_PRESSURE_LEVEL_FFT_SIZE_128 = 0
  • SOUND_PRESSURE_LEVEL_FFT_SIZE_256 = 1
  • SOUND_PRESSURE_LEVEL_FFT_SIZE_512 = 2
  • SOUND_PRESSURE_LEVEL_FFT_SIZE_1024 = 3

Für ret_weighting:

  • SOUND_PRESSURE_LEVEL_WEIGHTING_A = 0
  • SOUND_PRESSURE_LEVEL_WEIGHTING_B = 1
  • SOUND_PRESSURE_LEVEL_WEIGHTING_C = 2
  • SOUND_PRESSURE_LEVEL_WEIGHTING_D = 3
  • SOUND_PRESSURE_LEVEL_WEIGHTING_Z = 4
  • SOUND_PRESSURE_LEVEL_WEIGHTING_ITU_R_468 = 5

Fortgeschrittene Funktionen

int sound_pressure_level_get_spitfp_error_count(SoundPressureLevel *sound_pressure_level, uint32_t *ret_error_count_ack_checksum, uint32_t *ret_error_count_message_checksum, uint32_t *ret_error_count_frame, uint32_t *ret_error_count_overflow)
Parameter:
  • sound_pressure_level – Typ: SoundPressureLevel *
Ausgabeparameter:
  • ret_error_count_ack_checksum – Typ: uint32_t, Wertebereich: [0 bis 232 - 1]
  • ret_error_count_message_checksum – Typ: uint32_t, Wertebereich: [0 bis 232 - 1]
  • ret_error_count_frame – Typ: uint32_t, Wertebereich: [0 bis 232 - 1]
  • ret_error_count_overflow – Typ: uint32_t, Wertebereich: [0 bis 232 - 1]
Rückgabe:
  • error_code – Typ: int

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.

int sound_pressure_level_set_bootloader_mode(SoundPressureLevel *sound_pressure_level, uint8_t mode, uint8_t *ret_status)
Parameter:
  • sound_pressure_level – Typ: SoundPressureLevel *
  • mode – Typ: uint8_t, Wertebereich: Siehe Konstanten
Ausgabeparameter:
  • ret_status – Typ: uint8_t, Wertebereich: Siehe Konstanten
Rückgabe:
  • error_code – Typ: int

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 Konstanten sind für diese Funktion verfügbar:

Für mode:

  • SOUND_PRESSURE_LEVEL_BOOTLOADER_MODE_BOOTLOADER = 0
  • SOUND_PRESSURE_LEVEL_BOOTLOADER_MODE_FIRMWARE = 1
  • SOUND_PRESSURE_LEVEL_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
  • SOUND_PRESSURE_LEVEL_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
  • SOUND_PRESSURE_LEVEL_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4

Für ret_status:

  • SOUND_PRESSURE_LEVEL_BOOTLOADER_STATUS_OK = 0
  • SOUND_PRESSURE_LEVEL_BOOTLOADER_STATUS_INVALID_MODE = 1
  • SOUND_PRESSURE_LEVEL_BOOTLOADER_STATUS_NO_CHANGE = 2
  • SOUND_PRESSURE_LEVEL_BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT = 3
  • SOUND_PRESSURE_LEVEL_BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT = 4
  • SOUND_PRESSURE_LEVEL_BOOTLOADER_STATUS_CRC_MISMATCH = 5
int sound_pressure_level_get_bootloader_mode(SoundPressureLevel *sound_pressure_level, uint8_t *ret_mode)
Parameter:
  • sound_pressure_level – Typ: SoundPressureLevel *
Ausgabeparameter:
  • ret_mode – Typ: uint8_t, Wertebereich: Siehe Konstanten
Rückgabe:
  • error_code – Typ: int

Gibt den aktuellen Bootloader-Modus zurück, siehe sound_pressure_level_set_bootloader_mode().

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

Für ret_mode:

  • SOUND_PRESSURE_LEVEL_BOOTLOADER_MODE_BOOTLOADER = 0
  • SOUND_PRESSURE_LEVEL_BOOTLOADER_MODE_FIRMWARE = 1
  • SOUND_PRESSURE_LEVEL_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
  • SOUND_PRESSURE_LEVEL_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
  • SOUND_PRESSURE_LEVEL_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4
int sound_pressure_level_set_write_firmware_pointer(SoundPressureLevel *sound_pressure_level, uint32_t pointer)
Parameter:
  • sound_pressure_level – Typ: SoundPressureLevel *
  • pointer – Typ: uint32_t, Einheit: 1 B, Wertebereich: [0 bis 232 - 1]
Rückgabe:
  • error_code – Typ: int

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

int sound_pressure_level_write_firmware(SoundPressureLevel *sound_pressure_level, uint8_t data[64], uint8_t *ret_status)
Parameter:
  • sound_pressure_level – Typ: SoundPressureLevel *
  • data – Typ: uint8_t[64], Wertebereich: [0 bis 255]
Ausgabeparameter:
  • ret_status – Typ: uint8_t, Wertebereich: [0 bis 255]
Rückgabe:
  • error_code – Typ: int

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

int sound_pressure_level_set_status_led_config(SoundPressureLevel *sound_pressure_level, uint8_t config)
Parameter:
  • sound_pressure_level – Typ: SoundPressureLevel *
  • config – Typ: uint8_t, Wertebereich: Siehe Konstanten, Standardwert: 3
Rückgabe:
  • error_code – Typ: int

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 Konstanten sind für diese Funktion verfügbar:

Für config:

  • SOUND_PRESSURE_LEVEL_STATUS_LED_CONFIG_OFF = 0
  • SOUND_PRESSURE_LEVEL_STATUS_LED_CONFIG_ON = 1
  • SOUND_PRESSURE_LEVEL_STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • SOUND_PRESSURE_LEVEL_STATUS_LED_CONFIG_SHOW_STATUS = 3
int sound_pressure_level_get_status_led_config(SoundPressureLevel *sound_pressure_level, uint8_t *ret_config)
Parameter:
  • sound_pressure_level – Typ: SoundPressureLevel *
Ausgabeparameter:
  • ret_config – Typ: uint8_t, Wertebereich: Siehe Konstanten, Standardwert: 3
Rückgabe:
  • error_code – Typ: int

Gibt die Konfiguration zurück, wie von sound_pressure_level_set_status_led_config() gesetzt.

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

Für ret_config:

  • SOUND_PRESSURE_LEVEL_STATUS_LED_CONFIG_OFF = 0
  • SOUND_PRESSURE_LEVEL_STATUS_LED_CONFIG_ON = 1
  • SOUND_PRESSURE_LEVEL_STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • SOUND_PRESSURE_LEVEL_STATUS_LED_CONFIG_SHOW_STATUS = 3
int sound_pressure_level_get_chip_temperature(SoundPressureLevel *sound_pressure_level, int16_t *ret_temperature)
Parameter:
  • sound_pressure_level – Typ: SoundPressureLevel *
Ausgabeparameter:
  • ret_temperature – Typ: int16_t, Einheit: 1 °C, Wertebereich: [-215 bis 215 - 1]
Rückgabe:
  • error_code – Typ: int

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.

int sound_pressure_level_reset(SoundPressureLevel *sound_pressure_level)
Parameter:
  • sound_pressure_level – Typ: SoundPressureLevel *
Rückgabe:
  • error_code – Typ: int

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.

int sound_pressure_level_write_uid(SoundPressureLevel *sound_pressure_level, uint32_t uid)
Parameter:
  • sound_pressure_level – Typ: SoundPressureLevel *
  • uid – Typ: uint32_t, Wertebereich: [0 bis 232 - 1]
Rückgabe:
  • error_code – Typ: int

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.

int sound_pressure_level_read_uid(SoundPressureLevel *sound_pressure_level, uint32_t *ret_uid)
Parameter:
  • sound_pressure_level – Typ: SoundPressureLevel *
Ausgabeparameter:
  • ret_uid – Typ: uint32_t, Wertebereich: [0 bis 232 - 1]
Rückgabe:
  • error_code – Typ: int

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

int sound_pressure_level_get_identity(SoundPressureLevel *sound_pressure_level, char ret_uid[8], char ret_connected_uid[8], char *ret_position, uint8_t ret_hardware_version[3], uint8_t ret_firmware_version[3], uint16_t *ret_device_identifier)
Parameter:
  • sound_pressure_level – Typ: SoundPressureLevel *
Ausgabeparameter:
  • ret_uid – Typ: char[8]
  • ret_connected_uid – Typ: char[8]
  • ret_position – Typ: char, Wertebereich: ['a' bis 'h', 'i', 'z']
  • ret_hardware_version – Typ: uint8_t[3]
    • 0: major – Typ: uint8_t, Wertebereich: [0 bis 255]
    • 1: minor – Typ: uint8_t, Wertebereich: [0 bis 255]
    • 2: revision – Typ: uint8_t, Wertebereich: [0 bis 255]
  • ret_firmware_version – Typ: uint8_t[3]
    • 0: major – Typ: uint8_t, Wertebereich: [0 bis 255]
    • 1: minor – Typ: uint8_t, Wertebereich: [0 bis 255]
    • 2: revision – Typ: uint8_t, Wertebereich: [0 bis 255]
  • ret_device_identifier – Typ: uint16_t, Wertebereich: [0 bis 216 - 1]
Rückgabe:
  • error_code – Typ: int

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. Es gibt auch eine Konstante für den Device Identifier dieses Bricklets.

Konfigurationsfunktionen für Callbacks

void sound_pressure_level_register_callback(SoundPressureLevel *sound_pressure_level, int16_t callback_id, void (*function)(void), void *user_data)
Parameter:
  • sound_pressure_level – Typ: SoundPressureLevel *
  • callback_id – Typ: int16_t
  • function – Typ: void (*)(void)
  • user_data – Typ: void *

Registriert die function für die gegebene callback_id. Die user_data werden der Funktion als letztes Parameter mit übergeben.

Die verfügbaren Callback IDs mit den zugehörigen Funktionssignaturen sind unten zu finden.

int sound_pressure_level_set_decibel_callback_configuration(SoundPressureLevel *sound_pressure_level, uint32_t period, bool value_has_to_change, char option, uint16_t min, uint16_t max)
Parameter:
  • sound_pressure_level – Typ: SoundPressureLevel *
  • period – Typ: uint32_t, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0
  • value_has_to_change – Typ: bool, Standardwert: false
  • option – Typ: char, Wertebereich: Siehe Konstanten, Standardwert: 'x'
  • min – Typ: uint16_t, Einheit: 1/10 dB, Wertebereich: [0 bis 216 - 1], Standardwert: 0
  • max – Typ: uint16_t, Einheit: 1/10 dB, Wertebereich: [0 bis 216 - 1], Standardwert: 0
Rückgabe:
  • error_code – Typ: int

Die Periode ist die Periode mit der der SOUND_PRESSURE_LEVEL_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 SOUND_PRESSURE_LEVEL_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.

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

Für option:

  • SOUND_PRESSURE_LEVEL_THRESHOLD_OPTION_OFF = 'x'
  • SOUND_PRESSURE_LEVEL_THRESHOLD_OPTION_OUTSIDE = 'o'
  • SOUND_PRESSURE_LEVEL_THRESHOLD_OPTION_INSIDE = 'i'
  • SOUND_PRESSURE_LEVEL_THRESHOLD_OPTION_SMALLER = '<'
  • SOUND_PRESSURE_LEVEL_THRESHOLD_OPTION_GREATER = '>'
int sound_pressure_level_get_decibel_callback_configuration(SoundPressureLevel *sound_pressure_level, uint32_t *ret_period, bool *ret_value_has_to_change, char *ret_option, uint16_t *ret_min, uint16_t *ret_max)
Parameter:
  • sound_pressure_level – Typ: SoundPressureLevel *
Ausgabeparameter:
  • ret_period – Typ: uint32_t, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0
  • ret_value_has_to_change – Typ: bool, Standardwert: false
  • ret_option – Typ: char, Wertebereich: Siehe Konstanten, Standardwert: 'x'
  • ret_min – Typ: uint16_t, Einheit: 1/10 dB, Wertebereich: [0 bis 216 - 1], Standardwert: 0
  • ret_max – Typ: uint16_t, Einheit: 1/10 dB, Wertebereich: [0 bis 216 - 1], Standardwert: 0
Rückgabe:
  • error_code – Typ: int

Gibt die Callback-Konfiguration zurück, wie mittels sound_pressure_level_set_decibel_callback_configuration() gesetzt.

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

Für ret_option:

  • SOUND_PRESSURE_LEVEL_THRESHOLD_OPTION_OFF = 'x'
  • SOUND_PRESSURE_LEVEL_THRESHOLD_OPTION_OUTSIDE = 'o'
  • SOUND_PRESSURE_LEVEL_THRESHOLD_OPTION_INSIDE = 'i'
  • SOUND_PRESSURE_LEVEL_THRESHOLD_OPTION_SMALLER = '<'
  • SOUND_PRESSURE_LEVEL_THRESHOLD_OPTION_GREATER = '>'
int sound_pressure_level_set_spectrum_callback_configuration(SoundPressureLevel *sound_pressure_level, uint32_t period)
Parameter:
  • sound_pressure_level – Typ: SoundPressureLevel *
  • period – Typ: uint32_t, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0
Rückgabe:
  • error_code – Typ: int

Die Periode ist die Periode mit der der SOUND_PRESSURE_LEVEL_CALLBACK_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.

int sound_pressure_level_get_spectrum_callback_configuration(SoundPressureLevel *sound_pressure_level, uint32_t *ret_period)
Parameter:
  • sound_pressure_level – Typ: SoundPressureLevel *
Ausgabeparameter:
  • ret_period – Typ: uint32_t, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0
Rückgabe:
  • error_code – Typ: int

Gibt die Callback-Konfiguration zurück, wie mittels sound_pressure_level_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 der sound_pressure_level_register_callback() Funktion durchgeführt werden:

void my_callback(int value, void *user_data) {
    printf("Value: %d\n", value);
}

sound_pressure_level_register_callback(&sound_pressure_level,
                                       SOUND_PRESSURE_LEVEL_CALLBACK_EXAMPLE,
                                       (void (*)(void))my_callback,
                                       NULL);

Die verfügbaren Konstanten mit den zugehörigen Funktionssignaturen werden weiter unten beschrieben.

Bemerkung

Callbacks für wiederkehrende Ereignisse zu verwenden ist immer zu bevorzugen gegenüber der Verwendung von Abfragen. Es wird weniger USB-Bandbreite benutzt und die Latenz ist erheblich geringer, da es keine Paketumlaufzeit gibt.

SOUND_PRESSURE_LEVEL_CALLBACK_DECIBEL
void callback(uint16_t decibel, void *user_data)
Callback-Parameter:
  • decibel – Typ: uint16_t, Einheit: 1/10 dB, Wertebereich: [0 bis 120]
  • user_data – Typ: void *

Dieser Callback wird periodisch ausgelöst abhängig von der mittels sound_pressure_level_set_decibel_callback_configuration() gesetzten Konfiguration

Der Parameter ist der gleiche wie sound_pressure_level_get_decibel().

SOUND_PRESSURE_LEVEL_CALLBACK_SPECTRUM
void callback(uint16_t *spectrum, uint16_t spectrum_length, void *user_data)
Callback-Parameter:
  • spectrum – Typ: uint16_t *, Einheit: ? dB, Wertebereich: [0 bis 216 - 1]
  • spectrum_length – Typ: uint16_t
  • user_data – Typ: void *

Dieser Callback wird periodisch ausgelöst abhängig von der mittels sound_pressure_level_set_spectrum_callback_configuration() gesetzten Konfiguration

Der Parameter ist der gleiche wie sound_pressure_level_get_spectrum().

Bemerkung

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

Virtuelle Funktionen

Virtuelle Funktionen kommunizieren nicht mit dem Gerät selbst, sie arbeiten nur auf dem API Bindings Objekt. Dadurch können sie auch aufgerufen werden, ohne das das dazugehörige IP Connection Objekt verbunden ist.

int sound_pressure_level_get_api_version(SoundPressureLevel *sound_pressure_level, uint8_t ret_api_version[3])
Parameter:
  • sound_pressure_level – Typ: SoundPressureLevel *
Ausgabeparameter:
  • ret_api_version – Typ: uint8_t[3]
    • 0: major – Typ: uint8_t, Wertebereich: [0 bis 255]
    • 1: minor – Typ: uint8_t, Wertebereich: [0 bis 255]
    • 2: revision – Typ: uint8_t, Wertebereich: [0 bis 255]
Rückgabe:
  • error_code – Typ: int

Gibt die Version der API Definition zurück, die diese API Bindings implementieren. Dies ist weder die Release-Version dieser API Bindings noch gibt es in irgendeiner Weise Auskunft über den oder das repräsentierte(n) Brick oder Bricklet.

int sound_pressure_level_get_response_expected(SoundPressureLevel *sound_pressure_level, uint8_t function_id, bool *ret_response_expected)
Parameter:
  • sound_pressure_level – Typ: SoundPressureLevel *
  • function_id – Typ: uint8_t, Wertebereich: Siehe Konstanten
Ausgabeparameter:
  • ret_response_expected – Typ: bool
Rückgabe:
  • error_code – Typ: int

Gibt das Response-Expected-Flag für die Funktion mit der angegebenen Funktions IDs zurück. Es ist true falls für die Funktion beim Aufruf eine Antwort erwartet wird, false andernfalls.

Für Getter-Funktionen ist diese Flag immer gesetzt und kann nicht entfernt werden, da diese Funktionen immer eine Antwort senden. Für Konfigurationsfunktionen für Callbacks ist es standardmäßig gesetzt, kann aber entfernt werden mittels sound_pressure_level_set_response_expected(). Für Setter-Funktionen ist es standardmäßig nicht gesetzt, kann aber gesetzt werden.

Wenn das Response-Expected-Flag für eine Setter-Funktion gesetzt ist, können Timeouts und andere Fehlerfälle auch für Aufrufe dieser Setter-Funktion detektiert werden. Das Gerät sendet dann eine Antwort extra für diesen Zweck. Wenn das Flag für eine Setter-Funktion nicht gesetzt ist, dann wird keine Antwort vom Gerät gesendet und Fehler werden stillschweigend ignoriert, da sie nicht detektiert werden können.

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

Für function_id:

  • SOUND_PRESSURE_LEVEL_FUNCTION_SET_DECIBEL_CALLBACK_CONFIGURATION = 2
  • SOUND_PRESSURE_LEVEL_FUNCTION_SET_SPECTRUM_CALLBACK_CONFIGURATION = 6
  • SOUND_PRESSURE_LEVEL_FUNCTION_SET_CONFIGURATION = 9
  • SOUND_PRESSURE_LEVEL_FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
  • SOUND_PRESSURE_LEVEL_FUNCTION_SET_STATUS_LED_CONFIG = 239
  • SOUND_PRESSURE_LEVEL_FUNCTION_RESET = 243
  • SOUND_PRESSURE_LEVEL_FUNCTION_WRITE_UID = 248
int sound_pressure_level_set_response_expected(SoundPressureLevel *sound_pressure_level, uint8_t function_id, bool response_expected)
Parameter:
  • sound_pressure_level – Typ: SoundPressureLevel *
  • function_id – Typ: uint8_t, Wertebereich: Siehe Konstanten
  • response_expected – Typ: bool
Rückgabe:
  • error_code – Typ: int

Ändert das Response-Expected-Flag für die Funktion mit der angegebenen Funktion IDs. Diese Flag kann nur für Setter-Funktionen (Standardwert: false) und Konfigurationsfunktionen für Callbacks (Standardwert: true) geändert werden. Für Getter-Funktionen ist das Flag immer gesetzt.

Wenn das Response-Expected-Flag für eine Setter-Funktion gesetzt ist, können Timeouts und andere Fehlerfälle auch für Aufrufe dieser Setter-Funktion detektiert werden. Das Gerät sendet dann eine Antwort extra für diesen Zweck. Wenn das Flag für eine Setter-Funktion nicht gesetzt ist, dann wird keine Antwort vom Gerät gesendet und Fehler werden stillschweigend ignoriert, da sie nicht detektiert werden können.

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

Für function_id:

  • SOUND_PRESSURE_LEVEL_FUNCTION_SET_DECIBEL_CALLBACK_CONFIGURATION = 2
  • SOUND_PRESSURE_LEVEL_FUNCTION_SET_SPECTRUM_CALLBACK_CONFIGURATION = 6
  • SOUND_PRESSURE_LEVEL_FUNCTION_SET_CONFIGURATION = 9
  • SOUND_PRESSURE_LEVEL_FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
  • SOUND_PRESSURE_LEVEL_FUNCTION_SET_STATUS_LED_CONFIG = 239
  • SOUND_PRESSURE_LEVEL_FUNCTION_RESET = 243
  • SOUND_PRESSURE_LEVEL_FUNCTION_WRITE_UID = 248
int sound_pressure_level_set_response_expected_all(SoundPressureLevel *sound_pressure_level, bool response_expected)
Parameter:
  • sound_pressure_level – Typ: SoundPressureLevel *
  • response_expected – Typ: bool
Rückgabe:
  • error_code – Typ: int

Ändert das Response-Expected-Flag für alle Setter-Funktionen und Konfigurationsfunktionen für Callbacks diese Gerätes.

Konstanten

SOUND_PRESSURE_LEVEL_DEVICE_IDENTIFIER

Diese Konstante wird verwendet um ein Sound Pressure Level Bricklet zu identifizieren.

Die sound_pressure_level_get_identity() Funktion und der IPCON_CALLBACK_ENUMERATE Callback der IP Connection haben ein device_identifier Parameter um den Typ des Bricks oder Bricklets anzugeben.

SOUND_PRESSURE_LEVEL_DEVICE_DISPLAY_NAME

Diese Konstante stellt den Anzeigenamen eines Sound Pressure Level Bricklet dar.