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.

Basic Functions¶

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

Parameters:	uid – Type: string ipcon – Type: TIPConnection
Returns:	soundIntensity – Type: TBrickletSoundIntensity

Creates an object with the unique device ID uid:

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

This object can then be used after the IP Connection is connected.

function TBrickletSoundIntensity.GetIntensity: word¶

Returns:	intensity – Type: word, Range: [0 to 212 - 1]

Returns the current sound intensity.

The value corresponds to the upper envelop of the signal of the microphone capsule.

If you want to get the intensity periodically, it is recommended to use the OnIntensity callback and set the period with SetIntensityCallbackPeriod.

Advanced Functions¶

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)¶

Output Parameters:

uid – Type: string, Length: up to 8 connectedUid – Type: string, Length: up to 8 position – Type: char, Range: ['a' to 'h', 'z'] hardwareVersion – Type: array [0..2] of byte 0: major – Type: byte, Range: [0 to 255] 1: minor – Type: byte, Range: [0 to 255] 2: revision – Type: byte, Range: [0 to 255] firmwareVersion – Type: array [0..2] of byte 0: major – Type: byte, Range: [0 to 255] 1: minor – Type: byte, Range: [0 to 255] 2: revision – Type: byte, Range: [0 to 255] deviceIdentifier – Type: word, Range: [0 to 216 - 1]

Returns the UID, the UID where the Bricklet is connected to, the position, the hardware and firmware version as well as the device identifier.

The position can be 'a', 'b', 'c', 'd', 'e', 'f', 'g' or 'h' (Bricklet Port). A Bricklet connected to an Isolator Bricklet is always at position 'z'.

The device identifier numbers can be found here. There is also a constant for the device identifier of this Bricklet.

Callback Configuration Functions¶

procedure TBrickletSoundIntensity.SetIntensityCallbackPeriod(const period: longword)¶

Parameters:	period – Type: longword, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0

Sets the period with which the OnIntensity callback is triggered periodically. A value of 0 turns the callback off.

The OnIntensity callback is only triggered if the intensity has changed since the last triggering.

function TBrickletSoundIntensity.GetIntensityCallbackPeriod: longword¶

Returns:	period – Type: longword, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0

Returns the period as set by SetIntensityCallbackPeriod.

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

Parameters:	option – Type: char, Range: See constants, Default: 'x' min – Type: word, Range: [0 to 216 - 1], Default: 0 max – Type: word, Range: [0 to 216 - 1], Default: 0

Sets the thresholds for the OnIntensityReached callback.

The following options are possible:

Option	Description
'x'	Callback is turned off
'o'	Callback is triggered when the intensity is outside the min and max values
'i'	Callback is triggered when the intensity is inside the min and max values
'<'	Callback is triggered when the intensity is smaller than the min value (max is ignored)
'>'	Callback is triggered when the intensity is greater than the min value (max is ignored)

The following constants are available for this function:

For 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)¶

Output Parameters:	option – Type: char, Range: See constants, Default: 'x' min – Type: word, Range: [0 to 216 - 1], Default: 0 max – Type: word, Range: [0 to 216 - 1], Default: 0

Returns the threshold as set by SetIntensityCallbackThreshold.

The following constants are available for this function:

For 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)¶

Parameters:	debounce – Type: longword, Unit: 1 ms, Range: [0 to 232 - 1], Default: 100

Sets the period with which the threshold callback

• OnIntensityReached

is triggered, if the thresholds

• SetIntensityCallbackThreshold

keeps being reached.

function TBrickletSoundIntensity.GetDebouncePeriod: longword¶

Returns:	debounce – Type: longword, Unit: 1 ms, Range: [0 to 232 - 1], Default: 100

Returns the debounce period as set by SetDebouncePeriod.

Callbacks¶

Callbacks can be registered to receive time critical or recurring data from the device. The registration is done by assigning a procedure to an callback property of the device object:

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

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

The available callback properties and their parameter types are described below.

property TBrickletSoundIntensity.OnIntensity¶

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

Callback Parameters:	sender – Type: TBrickletSoundIntensity intensity – Type: word, Range: [0 to 212 - 1]

This callback is triggered periodically with the period that is set by SetIntensityCallbackPeriod. The parameter is the intensity of the sensor.

The OnIntensity callback is only triggered if the intensity has changed since the last triggering.

property TBrickletSoundIntensity.OnIntensityReached¶

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

Callback Parameters:	sender – Type: TBrickletSoundIntensity intensity – Type: word, Range: [0 to 212 - 1]

This callback is triggered when the threshold as set by SetIntensityCallbackThreshold is reached. The parameter is the intensity of the encoder.

If the threshold keeps being reached, the callback is triggered periodically with the period as set by SetDebouncePeriod.

Virtual Functions¶

Virtual functions don't communicate with the device itself, but operate only on the API bindings device object. They can be called without the corresponding IP Connection object being connected.

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

Output Parameters:	apiVersion – Type: array [0..2] of byte 0: major – Type: byte, Range: [0 to 255] 1: minor – Type: byte, Range: [0 to 255] 2: revision – Type: byte, Range: [0 to 255]

Returns the version of the API definition implemented by this API bindings. This is neither the release version of this API bindings nor does it tell you anything about the represented Brick or Bricklet.

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

Parameters:	functionId – Type: byte, Range: See constants
Returns:	responseExpected – Type: boolean

Returns the response expected flag for the function specified by the function ID parameter. It is true if the function is expected to send a response, false otherwise.

For getter functions this is enabled by default and cannot be disabled, because those functions will always send a response. For callback configuration functions it is enabled by default too, but can be disabled by SetResponseExpected. For setter functions it is disabled by default and can be enabled.

Enabling the response expected flag for a setter function allows to detect timeouts and other error conditions calls of this setter as well. The device will then send a response for this purpose. If this flag is disabled for a setter function then no response is sent and errors are silently ignored, because they cannot be detected.

The following constants are available for this function:

For 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)¶

Parameters:	functionId – Type: byte, Range: See constants responseExpected – Type: boolean

Changes the response expected flag of the function specified by the function ID parameter. This flag can only be changed for setter (default value: false) and callback configuration functions (default value: true). For getter functions it is always enabled.

Enabling the response expected flag for a setter function allows to detect timeouts and other error conditions calls of this setter as well. The device will then send a response for this purpose. If this flag is disabled for a setter function then no response is sent and errors are silently ignored, because they cannot be detected.

The following constants are available for this function:

For 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)¶

Parameters:	responseExpected – Type: boolean

Changes the response expected flag for all setter and callback configuration functions of this device at once.

Constants¶

const BRICKLET_SOUND_INTENSITY_DEVICE_IDENTIFIER¶

This constant is used to identify a Sound Intensity Bricklet.

The GetIdentity function and the TIPConnection.OnEnumerate callback of the IP Connection have a deviceIdentifier parameter to specify the Brick's or Bricklet's type.

const BRICKLET_SOUND_INTENSITY_DEVICE_DISPLAY_NAME¶

This constant represents the human readable name of a Sound Intensity Bricklet.