Delphi/Lazarus - Sound Pressure Level Bricklet¶

Simple¶

Download (ExampleSimple.pas)

 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
49
50
51
52

program ExampleSimple;

{$ifdef MSWINDOWS}{$apptype CONSOLE}{$endif}
{$ifdef FPC}{$mode OBJFPC}{$H+}{$endif}

uses
  SysUtils, IPConnection, BrickletSoundPressureLevel;

type
  TExample = class
  private
    ipcon: TIPConnection;
    spl: TBrickletSoundPressureLevel;
  public
    procedure Execute;
  end;

const
  HOST = 'localhost';
  PORT = 4223;
  UID = 'XYZ'; { Change XYZ to the UID of your Sound Pressure Level Bricklet }

var
  e: TExample;

procedure TExample.Execute;
var decibel: word;
begin
  { Create IP connection }
  ipcon := TIPConnection.Create;

  { Create device object }
  spl := TBrickletSoundPressureLevel.Create(UID, ipcon);

  { Connect to brickd }
  ipcon.Connect(HOST, PORT);
  { Don't use device before ipcon is connected }

  { Get current decibel }
  decibel := spl.GetDecibel;
  WriteLn(Format('Decibel: %f dB(A)', [decibel/10.0]));

  WriteLn('Press key to exit');
  ReadLn;
  ipcon.Destroy; { Calls ipcon.Disconnect internally }
end;

begin
  e := TExample.Create;
  e.Execute;
  e.Destroy;
end.

Callback¶

Download (ExampleCallback.pas)

 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
49
50
51
52
53
54
55
56
57
58
59
60

program ExampleCallback;

{$ifdef MSWINDOWS}{$apptype CONSOLE}{$endif}
{$ifdef FPC}{$mode OBJFPC}{$H+}{$endif}

uses
  SysUtils, IPConnection, BrickletSoundPressureLevel;

type
  TExample = class
  private
    ipcon: TIPConnection;
    spl: TBrickletSoundPressureLevel;
  public
    procedure DecibelCB(sender: TBrickletSoundPressureLevel; const decibel: word);
    procedure Execute;
  end;

const
  HOST = 'localhost';
  PORT = 4223;
  UID = 'XYZ'; { Change XYZ to the UID of your Sound Pressure Level Bricklet }

var
  e: TExample;

{ Callback procedure for decibel callback }
procedure TExample.DecibelCB(sender: TBrickletSoundPressureLevel; const decibel: word);
begin
  WriteLn(Format('Decibel: %f dB(A)', [decibel/10.0]));
end;

procedure TExample.Execute;
begin
  { Create IP connection }
  ipcon := TIPConnection.Create;

  { Create device object }
  spl := TBrickletSoundPressureLevel.Create(UID, ipcon);

  { Connect to brickd }
  ipcon.Connect(HOST, PORT);
  { Don't use device before ipcon is connected }

  { Register decibel callback to procedure DecibelCB }
  spl.OnDecibel := {$ifdef FPC}@{$endif}DecibelCB;

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

  WriteLn('Press key to exit');
  ReadLn;
  ipcon.Destroy; { Calls ipcon.Disconnect internally }
end;

begin
  e := TExample.Create;
  e.Execute;
  e.Destroy;
end.

Threshold¶

Download (ExampleThreshold.pas)

 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
49
50
51
52
53
54
55
56
57
58
59
60
61

program ExampleThreshold;

{$ifdef MSWINDOWS}{$apptype CONSOLE}{$endif}
{$ifdef FPC}{$mode OBJFPC}{$H+}{$endif}

uses
  SysUtils, IPConnection, BrickletSoundPressureLevel;

type
  TExample = class
  private
    ipcon: TIPConnection;
    spl: TBrickletSoundPressureLevel;
  public
    procedure DecibelCB(sender: TBrickletSoundPressureLevel; const decibel: word);
    procedure Execute;
  end;

const
  HOST = 'localhost';
  PORT = 4223;
  UID = 'XYZ'; { Change XYZ to the UID of your Sound Pressure Level Bricklet }

var
  e: TExample;

{ Callback procedure for decibel callback }
procedure TExample.DecibelCB(sender: TBrickletSoundPressureLevel; const decibel: word);
begin
  WriteLn(Format('Decibel: %f dB(A)', [decibel/10.0]));
end;

procedure TExample.Execute;
begin
  { Create IP connection }
  ipcon := TIPConnection.Create;

  { Create device object }
  spl := TBrickletSoundPressureLevel.Create(UID, ipcon);

  { Connect to brickd }
  ipcon.Connect(HOST, PORT);
  { Don't use device before ipcon is connected }

  { Register decibel callback to procedure DecibelCB }
  spl.OnDecibel := {$ifdef FPC}@{$endif}DecibelCB;

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

  WriteLn('Press key to exit');
  ReadLn;
  ipcon.Destroy; { Calls ipcon.Disconnect internally }
end;

begin
  e := TExample.Create;
  e.Execute;
  e.Destroy;
end.

Grundfunktionen¶

constructor TBrickletSoundPressureLevel.Create(const uid: string; ipcon: TIPConnection)¶

Parameter:	uid – Typ: string ipcon – Typ: TIPConnection
Rückgabe:	soundPressureLevel – Typ: TBrickletSoundPressureLevel

Erzeugt ein Objekt mit der eindeutigen Geräte ID uid:

soundPressureLevel := TBrickletSoundPressureLevel.Create('YOUR_DEVICE_UID', ipcon);

Dieses Objekt kann benutzt werden, nachdem die IP Connection verbunden ist.

function TBrickletSoundPressureLevel.GetDecibel: word¶

Rückgabe:	decibel – Typ: word, 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 SetConfiguration gesetzt werden.

Standardmäßig wird dB(A) genutzt.

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

function TBrickletSoundPressureLevel.GetSpectrum: array of word¶

Rückgabe:	spectrum – Typ: array of word, 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 SetConfiguration.

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

procedure TBrickletSoundPressureLevel.SetConfiguration(const fftSize: byte; const weighting: byte)¶

Parameter:	fftSize – Typ: byte, Wertebereich: Siehe Konstanten, Standardwert: 3 weighting – Typ: byte, 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 fftSize:

• BRICKLET_SOUND_PRESSURE_LEVEL_FFT_SIZE_128 = 0
• BRICKLET_SOUND_PRESSURE_LEVEL_FFT_SIZE_256 = 1
• BRICKLET_SOUND_PRESSURE_LEVEL_FFT_SIZE_512 = 2
• BRICKLET_SOUND_PRESSURE_LEVEL_FFT_SIZE_1024 = 3

Für weighting:

• BRICKLET_SOUND_PRESSURE_LEVEL_WEIGHTING_A = 0
• BRICKLET_SOUND_PRESSURE_LEVEL_WEIGHTING_B = 1
• BRICKLET_SOUND_PRESSURE_LEVEL_WEIGHTING_C = 2
• BRICKLET_SOUND_PRESSURE_LEVEL_WEIGHTING_D = 3
• BRICKLET_SOUND_PRESSURE_LEVEL_WEIGHTING_Z = 4
• BRICKLET_SOUND_PRESSURE_LEVEL_WEIGHTING_ITU_R_468 = 5

procedure TBrickletSoundPressureLevel.GetConfiguration(out fftSize: byte; out weighting: byte)¶

Ausgabeparameter:	fftSize – Typ: byte, Wertebereich: Siehe Konstanten, Standardwert: 3 weighting – Typ: byte, Wertebereich: Siehe Konstanten, Standardwert: 0

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

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

Für fftSize:

• BRICKLET_SOUND_PRESSURE_LEVEL_FFT_SIZE_128 = 0
• BRICKLET_SOUND_PRESSURE_LEVEL_FFT_SIZE_256 = 1
• BRICKLET_SOUND_PRESSURE_LEVEL_FFT_SIZE_512 = 2
• BRICKLET_SOUND_PRESSURE_LEVEL_FFT_SIZE_1024 = 3

Für weighting:

• BRICKLET_SOUND_PRESSURE_LEVEL_WEIGHTING_A = 0
• BRICKLET_SOUND_PRESSURE_LEVEL_WEIGHTING_B = 1
• BRICKLET_SOUND_PRESSURE_LEVEL_WEIGHTING_C = 2
• BRICKLET_SOUND_PRESSURE_LEVEL_WEIGHTING_D = 3
• BRICKLET_SOUND_PRESSURE_LEVEL_WEIGHTING_Z = 4
• BRICKLET_SOUND_PRESSURE_LEVEL_WEIGHTING_ITU_R_468 = 5

Fortgeschrittene Funktionen¶

procedure TBrickletSoundPressureLevel.GetSPITFPErrorCount(out errorCountAckChecksum: longword; out errorCountMessageChecksum: longword; out errorCountFrame: longword; out errorCountOverflow: longword)¶

Ausgabeparameter:	errorCountAckChecksum – Typ: longword, Wertebereich: [0 bis 232 - 1] errorCountMessageChecksum – Typ: longword, Wertebereich: [0 bis 232 - 1] errorCountFrame – Typ: longword, Wertebereich: [0 bis 232 - 1] errorCountOverflow – Typ: longword, 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.

procedure TBrickletSoundPressureLevel.SetStatusLEDConfig(const config: byte)¶

Parameter:	config – Typ: byte, 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:

• BRICKLET_SOUND_PRESSURE_LEVEL_STATUS_LED_CONFIG_OFF = 0
• BRICKLET_SOUND_PRESSURE_LEVEL_STATUS_LED_CONFIG_ON = 1
• BRICKLET_SOUND_PRESSURE_LEVEL_STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
• BRICKLET_SOUND_PRESSURE_LEVEL_STATUS_LED_CONFIG_SHOW_STATUS = 3

function TBrickletSoundPressureLevel.GetStatusLEDConfig: byte¶

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

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

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

Für config:

• BRICKLET_SOUND_PRESSURE_LEVEL_STATUS_LED_CONFIG_OFF = 0
• BRICKLET_SOUND_PRESSURE_LEVEL_STATUS_LED_CONFIG_ON = 1
• BRICKLET_SOUND_PRESSURE_LEVEL_STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
• BRICKLET_SOUND_PRESSURE_LEVEL_STATUS_LED_CONFIG_SHOW_STATUS = 3

function TBrickletSoundPressureLevel.GetChipTemperature: smallint¶

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

procedure TBrickletSoundPressureLevel.Reset¶

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.

procedure TBrickletSoundPressureLevel.GetIdentity(out uid: string; out connectedUid: string; out position: char; out hardwareVersion: array [0..2] of byte; out firmwareVersion: array [0..2] of byte; out deviceIdentifier: word)¶

Ausgabeparameter:

uid – Typ: string, Länge: bis zu 8 connectedUid – Typ: string, Länge: bis zu 8 position – Typ: char, Wertebereich: ['a' bis 'h', 'z'] hardwareVersion – Typ: array [0..2] of byte 0: major – Typ: byte, Wertebereich: [0 bis 255] 1: minor – Typ: byte, Wertebereich: [0 bis 255] 2: revision – Typ: byte, Wertebereich: [0 bis 255] firmwareVersion – Typ: array [0..2] of byte 0: major – Typ: byte, Wertebereich: [0 bis 255] 1: minor – Typ: byte, Wertebereich: [0 bis 255] 2: revision – Typ: byte, Wertebereich: [0 bis 255] deviceIdentifier – Typ: word, 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¶

procedure TBrickletSoundPressureLevel.SetDecibelCallbackConfiguration(const period: longword; const valueHasToChange: boolean; const option: char; const min: word; const max: word)¶

Parameter:	period – Typ: longword, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0 valueHasToChange – Typ: boolean, Standardwert: false option – Typ: char, Wertebereich: Siehe Konstanten, Standardwert: 'x' min – Typ: word, Einheit: 1/10 dB, Wertebereich: [0 bis 216 - 1], Standardwert: 0 max – Typ: word, Einheit: 1/10 dB, Wertebereich: [0 bis 216 - 1], Standardwert: 0

Die Periode ist die Periode mit der der OnDecibel 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 OnDecibel 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:

• BRICKLET_SOUND_PRESSURE_LEVEL_THRESHOLD_OPTION_OFF = 'x'
• BRICKLET_SOUND_PRESSURE_LEVEL_THRESHOLD_OPTION_OUTSIDE = 'o'
• BRICKLET_SOUND_PRESSURE_LEVEL_THRESHOLD_OPTION_INSIDE = 'i'
• BRICKLET_SOUND_PRESSURE_LEVEL_THRESHOLD_OPTION_SMALLER = '<'
• BRICKLET_SOUND_PRESSURE_LEVEL_THRESHOLD_OPTION_GREATER = '>'

procedure TBrickletSoundPressureLevel.GetDecibelCallbackConfiguration(out period: longword; out valueHasToChange: boolean; out option: char; out min: word; out max: word)¶

Ausgabeparameter:	period – Typ: longword, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0 valueHasToChange – Typ: boolean, Standardwert: false option – Typ: char, Wertebereich: Siehe Konstanten, Standardwert: 'x' min – Typ: word, Einheit: 1/10 dB, Wertebereich: [0 bis 216 - 1], Standardwert: 0 max – Typ: word, Einheit: 1/10 dB, Wertebereich: [0 bis 216 - 1], Standardwert: 0

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

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

Für option:

• BRICKLET_SOUND_PRESSURE_LEVEL_THRESHOLD_OPTION_OFF = 'x'
• BRICKLET_SOUND_PRESSURE_LEVEL_THRESHOLD_OPTION_OUTSIDE = 'o'
• BRICKLET_SOUND_PRESSURE_LEVEL_THRESHOLD_OPTION_INSIDE = 'i'
• BRICKLET_SOUND_PRESSURE_LEVEL_THRESHOLD_OPTION_SMALLER = '<'
• BRICKLET_SOUND_PRESSURE_LEVEL_THRESHOLD_OPTION_GREATER = '>'

procedure TBrickletSoundPressureLevel.SetSpectrumCallbackConfiguration(const period: longword)¶

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

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

function TBrickletSoundPressureLevel.GetSpectrumCallbackConfiguration: longword¶

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

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

Callbacks¶

Callbacks können registriert werden um zeitkritische oder wiederkehrende Daten vom Gerät zu erhalten. Die Registrierung erfolgt indem eine Prozedur einem Callback Property des Geräte Objektes zugewiesen wird:

procedure TExample.MyCallback(sender: TBrickletSoundPressureLevel; const value: longint);
begin
  WriteLn(Format('Value: %d', [value]));
end;

soundPressureLevel.OnExample := {$ifdef FPC}@{$endif}example.MyCallback;

Die verfügbaren Callback Properties und ihre Parametertypen werden weiter unten beschrieben.

property TBrickletSoundPressureLevel.OnDecibel¶

procedure(sender: TBrickletSoundPressureLevel; const decibel: word) of object;

Callback-Parameter:	sender – Typ: TBrickletSoundPressureLevel decibel – Typ: word, Einheit: 1/10 dB, Wertebereich: [0 bis 120]

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

Der Parameter ist der gleiche wie GetDecibel.

property TBrickletSoundPressureLevel.OnSpectrum¶

procedure(sender: TBrickletSoundPressureLevel; const spectrum: array of word) of object;

Callback-Parameter:	sender – Typ: TBrickletSoundPressureLevel spectrum – Typ: array of word, Einheit: ? dB, Wertebereich: [0 bis 216 - 1]

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

Der Parameter ist der gleiche wie GetSpectrum.

Bemerkung

Falls das Rekonstruieren des Wertes fehlschlägt, wird der Callback mit nil 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.

function TBrickletSoundPressureLevel.GetAPIVersion: array [0..2] of byte¶

Ausgabeparameter:	apiVersion – Typ: array [0..2] of byte 0: major – Typ: byte, Wertebereich: [0 bis 255] 1: minor – Typ: byte, Wertebereich: [0 bis 255] 2: revision – Typ: byte, 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.

function TBrickletSoundPressureLevel.GetResponseExpected(const functionId: byte): boolean¶

Parameter:	functionId – Typ: byte, Wertebereich: Siehe Konstanten
Rückgabe:	responseExpected – Typ: boolean

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 SetResponseExpected. 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 functionId:

• BRICKLET_SOUND_PRESSURE_LEVEL_FUNCTION_SET_DECIBEL_CALLBACK_CONFIGURATION = 2
• BRICKLET_SOUND_PRESSURE_LEVEL_FUNCTION_SET_SPECTRUM_CALLBACK_CONFIGURATION = 6
• BRICKLET_SOUND_PRESSURE_LEVEL_FUNCTION_SET_CONFIGURATION = 9
• BRICKLET_SOUND_PRESSURE_LEVEL_FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
• BRICKLET_SOUND_PRESSURE_LEVEL_FUNCTION_SET_STATUS_LED_CONFIG = 239
• BRICKLET_SOUND_PRESSURE_LEVEL_FUNCTION_RESET = 243
• BRICKLET_SOUND_PRESSURE_LEVEL_FUNCTION_WRITE_UID = 248

procedure TBrickletSoundPressureLevel.SetResponseExpected(const functionId: byte; const responseExpected: boolean)¶

Parameter:	functionId – Typ: byte, Wertebereich: Siehe Konstanten responseExpected – Typ: boolean

Ä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 functionId:

• BRICKLET_SOUND_PRESSURE_LEVEL_FUNCTION_SET_DECIBEL_CALLBACK_CONFIGURATION = 2
• BRICKLET_SOUND_PRESSURE_LEVEL_FUNCTION_SET_SPECTRUM_CALLBACK_CONFIGURATION = 6
• BRICKLET_SOUND_PRESSURE_LEVEL_FUNCTION_SET_CONFIGURATION = 9
• BRICKLET_SOUND_PRESSURE_LEVEL_FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
• BRICKLET_SOUND_PRESSURE_LEVEL_FUNCTION_SET_STATUS_LED_CONFIG = 239
• BRICKLET_SOUND_PRESSURE_LEVEL_FUNCTION_RESET = 243
• BRICKLET_SOUND_PRESSURE_LEVEL_FUNCTION_WRITE_UID = 248

procedure TBrickletSoundPressureLevel.SetResponseExpectedAll(const responseExpected: boolean)¶

Parameter:	responseExpected – Typ: boolean

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

function TBrickletSoundPressureLevel.SetBootloaderMode(const mode: byte): byte¶

Parameter:	mode – Typ: byte, Wertebereich: Siehe Konstanten
Rückgabe:	status – Typ: byte, 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:

• BRICKLET_SOUND_PRESSURE_LEVEL_BOOTLOADER_MODE_BOOTLOADER = 0
• BRICKLET_SOUND_PRESSURE_LEVEL_BOOTLOADER_MODE_FIRMWARE = 1
• BRICKLET_SOUND_PRESSURE_LEVEL_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
• BRICKLET_SOUND_PRESSURE_LEVEL_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
• BRICKLET_SOUND_PRESSURE_LEVEL_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4

Für status:

• BRICKLET_SOUND_PRESSURE_LEVEL_BOOTLOADER_STATUS_OK = 0
• BRICKLET_SOUND_PRESSURE_LEVEL_BOOTLOADER_STATUS_INVALID_MODE = 1
• BRICKLET_SOUND_PRESSURE_LEVEL_BOOTLOADER_STATUS_NO_CHANGE = 2
• BRICKLET_SOUND_PRESSURE_LEVEL_BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT = 3
• BRICKLET_SOUND_PRESSURE_LEVEL_BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT = 4
• BRICKLET_SOUND_PRESSURE_LEVEL_BOOTLOADER_STATUS_CRC_MISMATCH = 5

function TBrickletSoundPressureLevel.GetBootloaderMode: byte¶

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

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

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

Für mode:

• BRICKLET_SOUND_PRESSURE_LEVEL_BOOTLOADER_MODE_BOOTLOADER = 0
• BRICKLET_SOUND_PRESSURE_LEVEL_BOOTLOADER_MODE_FIRMWARE = 1
• BRICKLET_SOUND_PRESSURE_LEVEL_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
• BRICKLET_SOUND_PRESSURE_LEVEL_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
• BRICKLET_SOUND_PRESSURE_LEVEL_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4

procedure TBrickletSoundPressureLevel.SetWriteFirmwarePointer(const pointer: longword)¶

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

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

function TBrickletSoundPressureLevel.WriteFirmware(const data: array [0..63] of byte): byte¶

Parameter:	data – Typ: array [0..63] of byte, Wertebereich: [0 bis 255]
Rückgabe:	status – Typ: byte, Wertebereich: [0 bis 255]

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

procedure TBrickletSoundPressureLevel.WriteUID(const uid: longword)¶

Parameter:	uid – Typ: longword, 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.

function TBrickletSoundPressureLevel.ReadUID: longword¶

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

const BRICKLET_SOUND_PRESSURE_LEVEL_DEVICE_IDENTIFIER¶

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

Die GetIdentity Funktion und der TIPConnection.OnEnumerate Callback der IP Connection haben ein deviceIdentifier Parameter um den Typ des Bricks oder Bricklets anzugeben.

const BRICKLET_SOUND_PRESSURE_LEVEL_DEVICE_DISPLAY_NAME¶

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