Delphi/Lazarus - Sound Intensity Bricklet¶

Simple¶

Download (ExampleSimple.pas)

 1program ExampleSimple;
 2
 3{$ifdef MSWINDOWS}{$apptype CONSOLE}{$endif}
 4{$ifdef FPC}{$mode OBJFPC}{$H+}{$endif}
 5
 6uses
 7  SysUtils, IPConnection, BrickletSoundIntensity;
 8
 9type
10  TExample = class
11  private
12    ipcon: TIPConnection;
13    si: TBrickletSoundIntensity;
14  public
15    procedure Execute;
16  end;
17
18const
19  HOST = 'localhost';
20  PORT = 4223;
21  UID = 'XYZ'; { Change XYZ to the UID of your Sound Intensity Bricklet }
22
23var
24  e: TExample;
25
26procedure TExample.Execute;
27var intensity: word;
28begin
29  { Create IP connection }
30  ipcon := TIPConnection.Create;
31
32  { Create device object }
33  si := TBrickletSoundIntensity.Create(UID, ipcon);
34
35  { Connect to brickd }
36  ipcon.Connect(HOST, PORT);
37  { Don't use device before ipcon is connected }
38
39  { Get current intensity }
40  intensity := si.GetIntensity;
41  WriteLn(Format('Intensity: %d', [intensity]));
42
43  WriteLn('Press key to exit');
44  ReadLn;
45  ipcon.Destroy; { Calls ipcon.Disconnect internally }
46end;
47
48begin
49  e := TExample.Create;
50  e.Execute;
51  e.Destroy;
52end.

Callback¶

Download (ExampleCallback.pas)

 1program ExampleCallback;
 2
 3{$ifdef MSWINDOWS}{$apptype CONSOLE}{$endif}
 4{$ifdef FPC}{$mode OBJFPC}{$H+}{$endif}
 5
 6uses
 7  SysUtils, IPConnection, BrickletSoundIntensity;
 8
 9type
10  TExample = class
11  private
12    ipcon: TIPConnection;
13    si: TBrickletSoundIntensity;
14  public
15    procedure IntensityCB(sender: TBrickletSoundIntensity; const intensity: word);
16    procedure Execute;
17  end;
18
19const
20  HOST = 'localhost';
21  PORT = 4223;
22  UID = 'XYZ'; { Change XYZ to the UID of your Sound Intensity Bricklet }
23
24var
25  e: TExample;
26
27{ Callback procedure for intensity callback }
28procedure TExample.IntensityCB(sender: TBrickletSoundIntensity; const intensity: word);
29begin
30  WriteLn(Format('Intensity: %d', [intensity]));
31end;
32
33procedure TExample.Execute;
34begin
35  { Create IP connection }
36  ipcon := TIPConnection.Create;
37
38  { Create device object }
39  si := TBrickletSoundIntensity.Create(UID, ipcon);
40
41  { Connect to brickd }
42  ipcon.Connect(HOST, PORT);
43  { Don't use device before ipcon is connected }
44
45  { Register intensity callback to procedure IntensityCB }
46  si.OnIntensity := {$ifdef FPC}@{$endif}IntensityCB;
47
48  { Set period for intensity callback to 0.05s (50ms)
49    Note: The intensity callback is only called every 0.05 seconds
50          if the intensity has changed since the last call! }
51  si.SetIntensityCallbackPeriod(50);
52
53  WriteLn('Press key to exit');
54  ReadLn;
55  ipcon.Destroy; { Calls ipcon.Disconnect internally }
56end;
57
58begin
59  e := TExample.Create;
60  e.Execute;
61  e.Destroy;
62end.

Threshold¶

Download (ExampleThreshold.pas)

 1program ExampleThreshold;
 2
 3{$ifdef MSWINDOWS}{$apptype CONSOLE}{$endif}
 4{$ifdef FPC}{$mode OBJFPC}{$H+}{$endif}
 5
 6uses
 7  SysUtils, IPConnection, BrickletSoundIntensity;
 8
 9type
10  TExample = class
11  private
12    ipcon: TIPConnection;
13    si: TBrickletSoundIntensity;
14  public
15    procedure IntensityReachedCB(sender: TBrickletSoundIntensity; const intensity: word);
16    procedure Execute;
17  end;
18
19const
20  HOST = 'localhost';
21  PORT = 4223;
22  UID = 'XYZ'; { Change XYZ to the UID of your Sound Intensity Bricklet }
23
24var
25  e: TExample;
26
27{ Callback procedure for intensity reached callback }
28procedure TExample.IntensityReachedCB(sender: TBrickletSoundIntensity;
29                                      const intensity: word);
30begin
31  WriteLn(Format('Intensity: %d', [intensity]));
32end;
33
34procedure TExample.Execute;
35begin
36  { Create IP connection }
37  ipcon := TIPConnection.Create;
38
39  { Create device object }
40  si := TBrickletSoundIntensity.Create(UID, ipcon);
41
42  { Connect to brickd }
43  ipcon.Connect(HOST, PORT);
44  { Don't use device before ipcon is connected }
45
46  { Get threshold callbacks with a debounce time of 1 second (1000ms) }
47  si.SetDebouncePeriod(1000);
48
49  { Register intensity reached callback to procedure IntensityReachedCB }
50  si.OnIntensityReached := {$ifdef FPC}@{$endif}IntensityReachedCB;
51
52  { Configure threshold for intensity "greater than 2000" }
53  si.SetIntensityCallbackThreshold('>', 2000, 0);
54
55  WriteLn('Press key to exit');
56  ReadLn;
57  ipcon.Destroy; { Calls ipcon.Disconnect internally }
58end;
59
60begin
61  e := TExample.Create;
62  e.Execute;
63  e.Destroy;
64end.

Grundfunktionen¶

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

Parameter:	uid – Typ: string ipcon – Typ: TIPConnection
Rückgabe:	soundIntensity – Typ: TBrickletSoundIntensity

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

soundIntensity := TBrickletSoundIntensity.Create('YOUR_DEVICE_UID', ipcon);

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

function TBrickletSoundIntensity.GetIntensity: word¶

Rückgabe:	intensity – Typ: word, Wertebereich: [0 bis 212 - 1]

Gibt die aktuelle Schallintensität zurück.

Der Wert entspricht der Hüllkurve des Signals der Mikrophonkapsel.

Wenn die Schallintensität periodisch abgefragt werden soll, wird empfohlen den OnIntensity Callback zu nutzen und die Periode mit SetIntensityCallbackPeriod vorzugeben.

Fortgeschrittene Funktionen¶

procedure TBrickletSoundIntensity.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 TBrickletSoundIntensity.SetIntensityCallbackPeriod(const period: longword)¶

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

Setzt die Periode mit welcher der OnIntensity Callback ausgelöst wird. Ein Wert von 0 deaktiviert den Callback.

The OnIntensity Callback wird nur ausgelöst, wenn sich die Intensität seit der letzten Auslösung geändert hat.

function TBrickletSoundIntensity.GetIntensityCallbackPeriod: longword¶

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

Gibt die Periode zurück, wie von SetIntensityCallbackPeriod gesetzt.

procedure TBrickletSoundIntensity.SetIntensityCallbackThreshold(const option: char; const min: word; const max: word)¶

Parameter:	option – Typ: char, Wertebereich: Siehe Konstanten, Standardwert: 'x' min – Typ: word, Wertebereich: [0 bis 216 - 1], Standardwert: 0 max – Typ: word, Wertebereich: [0 bis 216 - 1], Standardwert: 0

Setzt den Schwellwert für den OnIntensityReached Callback.

Die folgenden Optionen sind möglich:

Option	Beschreibung
'x'	Callback ist inaktiv
'o'	Callback wird ausgelöst, wenn die Intensität außerhalb der min und max Werte ist
'i'	Callback wird ausgelöst, wenn die Intensität innerhalb der min und max Werte ist
'<'	Callback wird ausgelöst, wenn die Intensität kleiner als der min Wert ist (max wird ignoriert)
'>'	Callback wird ausgelöst, wenn die Intensität größer als der min Wert ist (max wird ignoriert)

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

Für option:

• BRICKLET_SOUND_INTENSITY_THRESHOLD_OPTION_OFF = 'x'

• BRICKLET_SOUND_INTENSITY_THRESHOLD_OPTION_OUTSIDE = 'o'

• BRICKLET_SOUND_INTENSITY_THRESHOLD_OPTION_INSIDE = 'i'

• BRICKLET_SOUND_INTENSITY_THRESHOLD_OPTION_SMALLER = '<'

• BRICKLET_SOUND_INTENSITY_THRESHOLD_OPTION_GREATER = '>'

procedure TBrickletSoundIntensity.GetIntensityCallbackThreshold(out option: char; out min: word; out max: word)¶

Ausgabeparameter:	option – Typ: char, Wertebereich: Siehe Konstanten, Standardwert: 'x' min – Typ: word, Wertebereich: [0 bis 216 - 1], Standardwert: 0 max – Typ: word, Wertebereich: [0 bis 216 - 1], Standardwert: 0

Gibt den Schwellwert zurück, wie von SetIntensityCallbackThreshold gesetzt.

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

Für option:

• BRICKLET_SOUND_INTENSITY_THRESHOLD_OPTION_OFF = 'x'

• BRICKLET_SOUND_INTENSITY_THRESHOLD_OPTION_OUTSIDE = 'o'

• BRICKLET_SOUND_INTENSITY_THRESHOLD_OPTION_INSIDE = 'i'

• BRICKLET_SOUND_INTENSITY_THRESHOLD_OPTION_SMALLER = '<'

• BRICKLET_SOUND_INTENSITY_THRESHOLD_OPTION_GREATER = '>'

procedure TBrickletSoundIntensity.SetDebouncePeriod(const debounce: longword)¶

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

Setzt die Periode mit welcher der Schwellwert-Callback

• OnIntensityReached

ausgelöst wird, wenn der Schwellwert

• SetIntensityCallbackThreshold

weiterhin erreicht bleibt.

function TBrickletSoundIntensity.GetDebouncePeriod: longword¶

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

Gibt die Entprellperiode zurück, wie von SetDebouncePeriod 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: TBrickletSoundIntensity; const value: longint);
begin
  WriteLn(Format('Value: %d', [value]));
end;

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

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

property TBrickletSoundIntensity.OnIntensity¶

procedure(sender: TBrickletSoundIntensity; const intensity: word) of object;

Callback-Parameter:	sender – Typ: TBrickletSoundIntensity intensity – Typ: word, Wertebereich: [0 bis 212 - 1]

Dieser Callback wird mit der Periode, wie gesetzt mit SetIntensityCallbackPeriod, ausgelöst. Der Parameter ist gemessene Schallintensität.

Der OnIntensity Callback wird nur ausgelöst, wenn sich die Intensität seit der letzten Auslösung geändert hat.

property TBrickletSoundIntensity.OnIntensityReached¶

procedure(sender: TBrickletSoundIntensity; const intensity: word) of object;

Callback-Parameter:	sender – Typ: TBrickletSoundIntensity intensity – Typ: word, Wertebereich: [0 bis 212 - 1]

Dieser Callback wird ausgelöst, wenn der Schwellwert, wie von SetIntensityCallbackThreshold gesetzt, erreicht wird. Der Parameter ist die gemessene Schallintensität.

Wenn der Schwellwert erreicht bleibt, wird der Callback mit der Periode, wie mit SetDebouncePeriod gesetzt, 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 TBrickletSoundIntensity.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 TBrickletSoundIntensity.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_INTENSITY_FUNCTION_SET_INTENSITY_CALLBACK_PERIOD = 2

• BRICKLET_SOUND_INTENSITY_FUNCTION_SET_INTENSITY_CALLBACK_THRESHOLD = 4

• BRICKLET_SOUND_INTENSITY_FUNCTION_SET_DEBOUNCE_PERIOD = 6

procedure TBrickletSoundIntensity.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_INTENSITY_FUNCTION_SET_INTENSITY_CALLBACK_PERIOD = 2

• BRICKLET_SOUND_INTENSITY_FUNCTION_SET_INTENSITY_CALLBACK_THRESHOLD = 4

• BRICKLET_SOUND_INTENSITY_FUNCTION_SET_DEBOUNCE_PERIOD = 6

procedure TBrickletSoundIntensity.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.

Konstanten¶

const BRICKLET_SOUND_INTENSITY_DEVICE_IDENTIFIER¶

Diese Konstante wird verwendet um ein Sound Intensity 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_INTENSITY_DEVICE_DISPLAY_NAME¶

Diese Konstante stellt den Anzeigenamen eines Sound Intensity Bricklet dar.