Rust - Sound Pressure Level Bricklet¶

Simple¶

Download (example_simple.rs)

 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

use std::{error::Error, io};

use tinkerforge::{ip_connection::IpConnection, sound_pressure_level_bricklet::*};

const HOST: &str = "localhost";
const PORT: u16 = 4223;
const UID: &str = "XYZ"; // Change XYZ to the UID of your Sound Pressure Level Bricklet.

fn main() -> Result<(), Box<dyn Error>> {
    let ipcon = IpConnection::new(); // Create IP connection.
    let spl = SoundPressureLevelBricklet::new(UID, &ipcon); // Create device object.

    ipcon.connect((HOST, PORT)).recv()??; // Connect to brickd.
                                          // Don't use device before ipcon is connected.

    // Get current decibel.
    let decibel = spl.get_decibel().recv()?;
    println!("Decibel: {} dB(A)", decibel as f32 / 10.0);

    println!("Press enter to exit.");
    let mut _input = String::new();
    io::stdin().read_line(&mut _input)?;
    ipcon.disconnect();
    Ok(())
}

Callback¶

Download (example_callback.rs)

 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

use std::{error::Error, io, thread};
use tinkerforge::{ip_connection::IpConnection, sound_pressure_level_bricklet::*};

const HOST: &str = "localhost";
const PORT: u16 = 4223;
const UID: &str = "XYZ"; // Change XYZ to the UID of your Sound Pressure Level Bricklet.

fn main() -> Result<(), Box<dyn Error>> {
    let ipcon = IpConnection::new(); // Create IP connection.
    let spl = SoundPressureLevelBricklet::new(UID, &ipcon); // Create device object.

    ipcon.connect((HOST, PORT)).recv()??; // Connect to brickd.
                                          // Don't use device before ipcon is connected.

    let decibel_receiver = spl.get_decibel_callback_receiver();

    // Spawn thread to handle received callback messages.
    // This thread ends when the `spl` object
    // is dropped, so there is no need for manual cleanup.
    thread::spawn(move || {
        for decibel in decibel_receiver {
            println!("Decibel: {} dB(A)", decibel as f32 / 10.0);
        }
    });

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

    println!("Press enter to exit.");
    let mut _input = String::new();
    io::stdin().read_line(&mut _input)?;
    ipcon.disconnect();
    Ok(())
}

Threshold¶

Download (example_threshold.rs)

 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

use std::{error::Error, io, thread};
use tinkerforge::{ip_connection::IpConnection, sound_pressure_level_bricklet::*};

const HOST: &str = "localhost";
const PORT: u16 = 4223;
const UID: &str = "XYZ"; // Change XYZ to the UID of your Sound Pressure Level Bricklet.

fn main() -> Result<(), Box<dyn Error>> {
    let ipcon = IpConnection::new(); // Create IP connection.
    let spl = SoundPressureLevelBricklet::new(UID, &ipcon); // Create device object.

    ipcon.connect((HOST, PORT)).recv()??; // Connect to brickd.
                                          // Don't use device before ipcon is connected.

    let decibel_receiver = spl.get_decibel_callback_receiver();

    // Spawn thread to handle received callback messages.
    // This thread ends when the `spl` object
    // is dropped, so there is no need for manual cleanup.
    thread::spawn(move || {
        for decibel in decibel_receiver {
            println!("Decibel: {} dB(A)", decibel as f32 / 10.0);
        }
    });

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

    println!("Press enter to exit.");
    let mut _input = String::new();
    io::stdin().read_line(&mut _input)?;
    ipcon.disconnect();
    Ok(())
}

Grundfunktionen¶

pub fn SoundPressureLevelBricklet::new(uid: &str, ip_connection: &IpConnection) → SoundPressureLevelBricklet¶

Parameter:	uid – Typ: &str ip_connection – Typ: &IPConnection
Rückgabe:	sound_pressure_level – Typ: SoundPressureLevelBricklet

Erzeugt ein neues SoundPressureLevelBricklet-Objekt mit der eindeutigen Geräte ID uid und fügt es der IP-Connection ip_connection hinzu:

let sound_pressure_level = SoundPressureLevelBricklet::new("YOUR_DEVICE_UID", &ip_connection);

Dieses Geräteobjekt kann benutzt werden, nachdem die IP-Connection verbunden.

pub fn SoundPressureLevelBricklet::get_decibel(&self) → ConvertingReceiver<u16>¶

Rückgabe:	decibel – Typ: u16, 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 SoundPressureLevelBricklet::set_configuration gesetzt werden.

Standardmäßig wird dB(A) genutzt.

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

pub fn SoundPressureLevelBricklet::get_spectrum(&self) → Result<Vec<u16>, BrickletRecvTimeoutError>¶

Rückgabe:	spectrum – Typ: Vec<u16>, 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 SoundPressureLevelBricklet::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 SoundPressureLevelBricklet::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.

pub fn SoundPressureLevelBricklet::set_configuration(&self, fft_size: u8, weighting: u8) → ConvertingReceiver<()>¶

Parameter:	fft_size – Typ: u8, Wertebereich: Siehe Konstanten, Standardwert: 3 weighting – Typ: u8, Wertebereich: Siehe Konstanten, Standardwert: 0

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_BRICKLET_FFT_SIZE_128 = 0
• SOUND_PRESSURE_LEVEL_BRICKLET_FFT_SIZE_256 = 1
• SOUND_PRESSURE_LEVEL_BRICKLET_FFT_SIZE_512 = 2
• SOUND_PRESSURE_LEVEL_BRICKLET_FFT_SIZE_1024 = 3

Für weighting:

• SOUND_PRESSURE_LEVEL_BRICKLET_WEIGHTING_A = 0
• SOUND_PRESSURE_LEVEL_BRICKLET_WEIGHTING_B = 1
• SOUND_PRESSURE_LEVEL_BRICKLET_WEIGHTING_C = 2
• SOUND_PRESSURE_LEVEL_BRICKLET_WEIGHTING_D = 3
• SOUND_PRESSURE_LEVEL_BRICKLET_WEIGHTING_Z = 4
• SOUND_PRESSURE_LEVEL_BRICKLET_WEIGHTING_ITU_R_468 = 5

pub fn SoundPressureLevelBricklet::get_configuration(&self) → ConvertingReceiver<Configuration>¶

Rückgabeobjekt:	fft_size – Typ: u8, Wertebereich: Siehe Konstanten, Standardwert: 3 weighting – Typ: u8, Wertebereich: Siehe Konstanten, Standardwert: 0

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

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

Für fft_size:

• SOUND_PRESSURE_LEVEL_BRICKLET_FFT_SIZE_128 = 0
• SOUND_PRESSURE_LEVEL_BRICKLET_FFT_SIZE_256 = 1
• SOUND_PRESSURE_LEVEL_BRICKLET_FFT_SIZE_512 = 2
• SOUND_PRESSURE_LEVEL_BRICKLET_FFT_SIZE_1024 = 3

Für weighting:

• SOUND_PRESSURE_LEVEL_BRICKLET_WEIGHTING_A = 0
• SOUND_PRESSURE_LEVEL_BRICKLET_WEIGHTING_B = 1
• SOUND_PRESSURE_LEVEL_BRICKLET_WEIGHTING_C = 2
• SOUND_PRESSURE_LEVEL_BRICKLET_WEIGHTING_D = 3
• SOUND_PRESSURE_LEVEL_BRICKLET_WEIGHTING_Z = 4
• SOUND_PRESSURE_LEVEL_BRICKLET_WEIGHTING_ITU_R_468 = 5

Fortgeschrittene Funktionen¶

pub fn SoundPressureLevelBricklet::get_spitfp_error_count(&self) → ConvertingReceiver<SpitfpErrorCount>¶

Rückgabeobjekt:	error_count_ack_checksum – Typ: u32, Wertebereich: [0 bis 232 - 1] error_count_message_checksum – Typ: u32, Wertebereich: [0 bis 232 - 1] error_count_frame – Typ: u32, Wertebereich: [0 bis 232 - 1] error_count_overflow – Typ: u32, 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.

pub fn SoundPressureLevelBricklet::set_status_led_config(&self, config: u8) → ConvertingReceiver<()>¶

Parameter:	config – Typ: u8, Wertebereich: Siehe Konstanten, Standardwert: 3

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_BRICKLET_STATUS_LED_CONFIG_OFF = 0
• SOUND_PRESSURE_LEVEL_BRICKLET_STATUS_LED_CONFIG_ON = 1
• SOUND_PRESSURE_LEVEL_BRICKLET_STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
• SOUND_PRESSURE_LEVEL_BRICKLET_STATUS_LED_CONFIG_SHOW_STATUS = 3

pub fn SoundPressureLevelBricklet::get_status_led_config(&self) → ConvertingReceiver<u8>¶

Rückgabe:	config – Typ: u8, Wertebereich: Siehe Konstanten, Standardwert: 3

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

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

Für config:

• SOUND_PRESSURE_LEVEL_BRICKLET_STATUS_LED_CONFIG_OFF = 0
• SOUND_PRESSURE_LEVEL_BRICKLET_STATUS_LED_CONFIG_ON = 1
• SOUND_PRESSURE_LEVEL_BRICKLET_STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
• SOUND_PRESSURE_LEVEL_BRICKLET_STATUS_LED_CONFIG_SHOW_STATUS = 3

pub fn SoundPressureLevelBricklet::get_chip_temperature(&self) → ConvertingReceiver<i16>¶

Rückgabe:	temperature – Typ: i16, 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.

pub fn SoundPressureLevelBricklet::reset(&self) → ConvertingReceiver<()>¶

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.

pub fn SoundPressureLevelBricklet::get_identity(&self) → ConvertingReceiver<Identity>¶

Rückgabeobjekt:

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: [u8; 3] 0: major – Typ: u8, Wertebereich: [0 bis 255] 1: minor – Typ: u8, Wertebereich: [0 bis 255] 2: revision – Typ: u8, Wertebereich: [0 bis 255] firmware_version – Typ: [u8; 3] 0: major – Typ: u8, Wertebereich: [0 bis 255] 1: minor – Typ: u8, Wertebereich: [0 bis 255] 2: revision – Typ: u8, Wertebereich: [0 bis 255] device_identifier – Typ: u16, 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 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. Es gibt auch eine Konstante für den Device Identifier dieses Bricklets.

Konfigurationsfunktionen für Callbacks¶

pub fn SoundPressureLevelBricklet::set_decibel_callback_configuration(&self, period: u32, value_has_to_change: bool, option: char, min: u16, max: u16) → ConvertingReceiver<()>¶

Parameter:	period – Typ: u32, 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: u16, Einheit: 1/10 dB, Wertebereich: [0 bis 216 - 1], Standardwert: 0 max – Typ: u16, Einheit: 1/10 dB, Wertebereich: [0 bis 216 - 1], Standardwert: 0

Die Periode ist die Periode mit der der SoundPressureLevelBricklet::get_decibel_callback_receiver 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 SoundPressureLevelBricklet::get_decibel_callback_receiver 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_BRICKLET_THRESHOLD_OPTION_OFF = 'x'
• SOUND_PRESSURE_LEVEL_BRICKLET_THRESHOLD_OPTION_OUTSIDE = 'o'
• SOUND_PRESSURE_LEVEL_BRICKLET_THRESHOLD_OPTION_INSIDE = 'i'
• SOUND_PRESSURE_LEVEL_BRICKLET_THRESHOLD_OPTION_SMALLER = '<'
• SOUND_PRESSURE_LEVEL_BRICKLET_THRESHOLD_OPTION_GREATER = '>'

pub fn SoundPressureLevelBricklet::get_decibel_callback_configuration(&self) → ConvertingReceiver<DecibelCallbackConfiguration>¶

Rückgabeobjekt:	period – Typ: u32, 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: u16, Einheit: 1/10 dB, Wertebereich: [0 bis 216 - 1], Standardwert: 0 max – Typ: u16, Einheit: 1/10 dB, Wertebereich: [0 bis 216 - 1], Standardwert: 0

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

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

Für option:

• SOUND_PRESSURE_LEVEL_BRICKLET_THRESHOLD_OPTION_OFF = 'x'
• SOUND_PRESSURE_LEVEL_BRICKLET_THRESHOLD_OPTION_OUTSIDE = 'o'
• SOUND_PRESSURE_LEVEL_BRICKLET_THRESHOLD_OPTION_INSIDE = 'i'
• SOUND_PRESSURE_LEVEL_BRICKLET_THRESHOLD_OPTION_SMALLER = '<'
• SOUND_PRESSURE_LEVEL_BRICKLET_THRESHOLD_OPTION_GREATER = '>'

pub fn SoundPressureLevelBricklet::set_spectrum_callback_configuration(&self, period: u32) → ConvertingReceiver<()>¶

Parameter:	period – Typ: u32, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0

Die Periode ist die Periode mit der der SoundPressureLevelBricklet::get_spectrum_callback_receiver 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.

pub fn SoundPressureLevelBricklet::get_spectrum_callback_configuration(&self) → ConvertingReceiver<u32>¶

Rückgabe:	period – Typ: u32, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0

Gibt die Callback-Konfiguration zurück, wie mittels SoundPressureLevelBricklet::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 entsprechenden get_*_callback_receiver-Function durchgeführt werden, welche einen Receiver für Callback-Events zurück gibt.

pub fn SoundPressureLevelBricklet::get_decibel_callback_receiver(&self) → ConvertingCallbackReceiver<u16>¶

Event:	decibel – Typ: u16, Einheit: 1/10 dB, Wertebereich: [0 bis 120]

Receiver die mit dieser Funktion erstellt werden, empfangen Decibel-Events.

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

Der empfangene Variable ist der gleiche wie SoundPressureLevelBricklet::get_decibel.

pub fn SoundPressureLevelBricklet::get_spectrum_callback_receiver(&self) → ConvertingHighLevelCallbackReceiver<u16, SpectrumResult, SpectrumLowLevelEvent>¶

Event:	spectrum – Typ: Vec<u16>, Einheit: ? dB, Wertebereich: [0 bis 216 - 1]

Receiver die mit dieser Funktion erstellt werden, empfangen Spectrum-Events.

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

Der empfangene Variable ist der gleiche wie SoundPressureLevelBricklet::get_spectrum.

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.

pub fn SoundPressureLevelBricklet::get_api_version(&self) → [u8; 3]¶

Rückgabeobjekt:	api_version – Typ: [u8; 3] 0: major – Typ: u8, Wertebereich: [0 bis 255] 1: minor – Typ: u8, Wertebereich: [0 bis 255] 2: revision – Typ: u8, Wertebereich: [0 bis 255]

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.

pub fn SoundPressureLevelBricklet::get_response_expected(&mut self, function_id: u8) → bool¶

Parameter:	function_id – Typ: u8, Wertebereich: Siehe Konstanten
Rückgabe:	response_expected – Typ: bool

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 SoundPressureLevelBricklet::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_BRICKLET_FUNCTION_SET_DECIBEL_CALLBACK_CONFIGURATION = 2
• SOUND_PRESSURE_LEVEL_BRICKLET_FUNCTION_SET_SPECTRUM_CALLBACK_CONFIGURATION = 6
• SOUND_PRESSURE_LEVEL_BRICKLET_FUNCTION_SET_CONFIGURATION = 9
• SOUND_PRESSURE_LEVEL_BRICKLET_FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
• SOUND_PRESSURE_LEVEL_BRICKLET_FUNCTION_SET_STATUS_LED_CONFIG = 239
• SOUND_PRESSURE_LEVEL_BRICKLET_FUNCTION_RESET = 243
• SOUND_PRESSURE_LEVEL_BRICKLET_FUNCTION_WRITE_UID = 248

pub fn SoundPressureLevelBricklet::set_response_expected(&mut self, function_id: u8, response_expected: bool) → ()¶

Parameter:	function_id – Typ: u8, Wertebereich: Siehe Konstanten response_expected – Typ: bool

Ä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_BRICKLET_FUNCTION_SET_DECIBEL_CALLBACK_CONFIGURATION = 2
• SOUND_PRESSURE_LEVEL_BRICKLET_FUNCTION_SET_SPECTRUM_CALLBACK_CONFIGURATION = 6
• SOUND_PRESSURE_LEVEL_BRICKLET_FUNCTION_SET_CONFIGURATION = 9
• SOUND_PRESSURE_LEVEL_BRICKLET_FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
• SOUND_PRESSURE_LEVEL_BRICKLET_FUNCTION_SET_STATUS_LED_CONFIG = 239
• SOUND_PRESSURE_LEVEL_BRICKLET_FUNCTION_RESET = 243
• SOUND_PRESSURE_LEVEL_BRICKLET_FUNCTION_WRITE_UID = 248

pub fn SoundPressureLevelBricklet::set_response_expected_all(&mut self, response_expected: bool) → ()¶

Parameter:	response_expected – Typ: bool

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

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.

pub fn SoundPressureLevelBricklet::set_bootloader_mode(&self, mode: u8) → ConvertingReceiver<u8>¶

Parameter:	mode – Typ: u8, Wertebereich: Siehe Konstanten
Rückgabe:	status – Typ: u8, Wertebereich: Siehe Konstanten

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_BRICKLET_BOOTLOADER_MODE_BOOTLOADER = 0
• SOUND_PRESSURE_LEVEL_BRICKLET_BOOTLOADER_MODE_FIRMWARE = 1
• SOUND_PRESSURE_LEVEL_BRICKLET_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
• SOUND_PRESSURE_LEVEL_BRICKLET_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
• SOUND_PRESSURE_LEVEL_BRICKLET_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4

Für status:

• SOUND_PRESSURE_LEVEL_BRICKLET_BOOTLOADER_STATUS_OK = 0
• SOUND_PRESSURE_LEVEL_BRICKLET_BOOTLOADER_STATUS_INVALID_MODE = 1
• SOUND_PRESSURE_LEVEL_BRICKLET_BOOTLOADER_STATUS_NO_CHANGE = 2
• SOUND_PRESSURE_LEVEL_BRICKLET_BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT = 3
• SOUND_PRESSURE_LEVEL_BRICKLET_BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT = 4
• SOUND_PRESSURE_LEVEL_BRICKLET_BOOTLOADER_STATUS_CRC_MISMATCH = 5

pub fn SoundPressureLevelBricklet::get_bootloader_mode(&self) → ConvertingReceiver<u8>¶

Rückgabe:	mode – Typ: u8, Wertebereich: Siehe Konstanten

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

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

Für mode:

• SOUND_PRESSURE_LEVEL_BRICKLET_BOOTLOADER_MODE_BOOTLOADER = 0
• SOUND_PRESSURE_LEVEL_BRICKLET_BOOTLOADER_MODE_FIRMWARE = 1
• SOUND_PRESSURE_LEVEL_BRICKLET_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
• SOUND_PRESSURE_LEVEL_BRICKLET_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
• SOUND_PRESSURE_LEVEL_BRICKLET_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4

pub fn SoundPressureLevelBricklet::set_write_firmware_pointer(&self, pointer: u32) → ConvertingReceiver<()>¶

Parameter:	pointer – Typ: u32, Einheit: 1 B, Wertebereich: [0 bis 232 - 1]

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

pub fn SoundPressureLevelBricklet::write_firmware(&self, data: [u8; 64]) → ConvertingReceiver<u8>¶

Parameter:	data – Typ: [u8; 64], Wertebereich: [0 bis 255]
Rückgabe:	status – Typ: u8, Wertebereich: [0 bis 255]

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

pub fn SoundPressureLevelBricklet::write_uid(&self, uid: u32) → ConvertingReceiver<()>¶

Parameter:	uid – Typ: u32, Wertebereich: [0 bis 232 - 1]

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.

pub fn SoundPressureLevelBricklet::read_uid(&self) → ConvertingReceiver<u32>¶

Rückgabe:	uid – Typ: u32, 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.

Konstanten¶

pub const SoundPressureLevelBricklet::DEVICE_IDENTIFIER¶

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

Die SoundPressureLevelBricklet::get_identity Funktion und der IpConnection::get_enumerate_callback_receiver Callback der IP Connection haben ein device_identifier Parameter um den Typ des Bricks oder Bricklets anzugeben.

pub const SoundPressureLevelBricklet::DEVICE_DISPLAY_NAME¶

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