Delphi/Lazarus - Dust Detector Bricklet

Dies ist die Beschreibung der Delphi/Lazarus API Bindings für das Dust Detector Bricklet. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des Dust Detector Bricklet sind in dessen Hardware Beschreibung zusammengefasst.

Eine Installationanleitung für die Delphi/Lazarus API Bindings ist Teil deren allgemeine Beschreibung.

Beispiele

Der folgende Beispielcode ist Public Domain (CC0 1.0).

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, BrickletDustDetector;

type
  TExample = class
  private
    ipcon: TIPConnection;
    dd: TBrickletDustDetector;
  public
    procedure Execute;
  end;

const
  HOST = 'localhost';
  PORT = 4223;
  UID = 'XYZ'; { Change XYZ to the UID of your Dust Detector Bricklet }

var
  e: TExample;

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

  { Create device object }
  dd := TBrickletDustDetector.Create(UID, ipcon);

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

  { Get current dust density }
  dustDensity := dd.GetDustDensity;
  WriteLn(Format('Dust Density: %d µg/m³', [dustDensity]));

  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
61
62
program ExampleCallback;

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

uses
  SysUtils, IPConnection, BrickletDustDetector;

type
  TExample = class
  private
    ipcon: TIPConnection;
    dd: TBrickletDustDetector;
  public
    procedure DustDensityCB(sender: TBrickletDustDetector; const dustDensity: word);
    procedure Execute;
  end;

const
  HOST = 'localhost';
  PORT = 4223;
  UID = 'XYZ'; { Change XYZ to the UID of your Dust Detector Bricklet }

var
  e: TExample;

{ Callback procedure for dust density callback }
procedure TExample.DustDensityCB(sender: TBrickletDustDetector; const dustDensity: word);
begin
  WriteLn(Format('Dust Density: %d µg/m³', [dustDensity]));
end;

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

  { Create device object }
  dd := TBrickletDustDetector.Create(UID, ipcon);

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

  { Register dust density callback to procedure DustDensityCB }
  dd.OnDustDensity := {$ifdef FPC}@{$endif}DustDensityCB;

  { Set period for dust density callback to 1s (1000ms)
    Note: The dust density callback is only called every second
          if the dust density has changed since the last call! }
  dd.SetDustDensityCallbackPeriod(1000);

  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
62
63
64
65
program ExampleThreshold;

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

uses
  SysUtils, IPConnection, BrickletDustDetector;

type
  TExample = class
  private
    ipcon: TIPConnection;
    dd: TBrickletDustDetector;
  public
    procedure DustDensityReachedCB(sender: TBrickletDustDetector;
                                   const dustDensity: word);
    procedure Execute;
  end;

const
  HOST = 'localhost';
  PORT = 4223;
  UID = 'XYZ'; { Change XYZ to the UID of your Dust Detector Bricklet }

var
  e: TExample;

{ Callback procedure for dust density reached callback }
procedure TExample.DustDensityReachedCB(sender: TBrickletDustDetector;
                                        const dustDensity: word);
begin
  WriteLn(Format('Dust Density: %d µg/m³', [dustDensity]));
end;

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

  { Create device object }
  dd := TBrickletDustDetector.Create(UID, ipcon);

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

  { Get threshold callbacks with a debounce time of 10 seconds (10000ms) }
  dd.SetDebouncePeriod(10000);

  { Register dust density reached callback to procedure DustDensityReachedCB }
  dd.OnDustDensityReached := {$ifdef FPC}@{$endif}DustDensityReachedCB;

  { Configure threshold for dust density "greater than 10 µg/m³" }
  dd.SetDustDensityCallbackThreshold('>', 10, 0);

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

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

API

Da Delphi nicht mehrere Rückgabewerte direkt unterstützt, wird das out Schlüsselwort genutzt um mehrere Werte von einer Funktion zurückzugeben.

Alle folgend aufgelisteten Funktionen und Prozeduren sind Thread-sicher.

Grundfunktionen

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

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

dustDetector := TBrickletDustDetector.Create('YOUR_DEVICE_UID', ipcon);

Dieses Objekt kann benutzt werden, nachdem die IP Connection verbunden ist (siehe Beispiele oben).

function TBrickletDustDetector.GetDustDensity: word

Gibt die Staubdichte in µg/m³ zurück.

Wenn die Staubdichte periodisch abgefragt werden soll, wird empfohlen den OnDustDensity Callback zu nutzen und die Periode mit SetDustDensityCallbackPeriod vorzugeben.

Fortgeschrittene Funktionen

procedure TBrickletDustDetector.SetMovingAverage(const average: byte)

Setzt die Länge eines gleitenden Mittelwerts für die Staubdichte.

Wenn die Länge auf 0 gesetzt wird, ist das Averaging komplett aus. Desto kleiner die Länge des Mittelwerts ist, desto mehr Rauschen ist auf den Daten.

Der Wertebereich liegt bei 0-100.

Der Standardwert ist 100.

function TBrickletDustDetector.GetMovingAverage: byte

Gibt die Länge des gleitenden Mittelwerts zurück, wie von SetMovingAverage gesetzt.

function TBrickletDustDetector.GetAPIVersion: array [0..2] of byte

Gibt die Version der API Definition (Major, Minor, Revision) 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 TBrickletDustDetector.GetResponseExpected(const functionId: byte): 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:

  • BRICKLET_DUST_DETECTOR_FUNCTION_SET_DUST_DENSITY_CALLBACK_PERIOD = 2
  • BRICKLET_DUST_DETECTOR_FUNCTION_SET_DUST_DENSITY_CALLBACK_THRESHOLD = 4
  • BRICKLET_DUST_DETECTOR_FUNCTION_SET_DEBOUNCE_PERIOD = 6
  • BRICKLET_DUST_DETECTOR_FUNCTION_SET_MOVING_AVERAGE = 10
procedure TBrickletDustDetector.SetResponseExpected(const functionId: byte; const responseExpected: 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:

  • BRICKLET_DUST_DETECTOR_FUNCTION_SET_DUST_DENSITY_CALLBACK_PERIOD = 2
  • BRICKLET_DUST_DETECTOR_FUNCTION_SET_DUST_DENSITY_CALLBACK_THRESHOLD = 4
  • BRICKLET_DUST_DETECTOR_FUNCTION_SET_DEBOUNCE_PERIOD = 6
  • BRICKLET_DUST_DETECTOR_FUNCTION_SET_MOVING_AVERAGE = 10
procedure TBrickletDustDetector.SetResponseExpectedAll(const responseExpected: boolean)

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

procedure TBrickletDustDetector.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)

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 kann 'a', 'b', 'c' oder 'd' sein.

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 TBrickletDustDetector.SetDustDensityCallbackPeriod(const period: longword)

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

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

Der Standardwert ist 0.

function TBrickletDustDetector.GetDustDensityCallbackPeriod: longword

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

procedure TBrickletDustDetector.SetDustDensityCallbackThreshold(const option: char; const min: word; const max: word)

Setzt den Schwellwert für den OnDustDensityReached Callback.

Die folgenden Optionen sind möglich:

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

Der Standardwert ist ('x', 0, 0).

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

  • BRICKLET_DUST_DETECTOR_THRESHOLD_OPTION_OFF = 'x'
  • BRICKLET_DUST_DETECTOR_THRESHOLD_OPTION_OUTSIDE = 'o'
  • BRICKLET_DUST_DETECTOR_THRESHOLD_OPTION_INSIDE = 'i'
  • BRICKLET_DUST_DETECTOR_THRESHOLD_OPTION_SMALLER = '<'
  • BRICKLET_DUST_DETECTOR_THRESHOLD_OPTION_GREATER = '>'
procedure TBrickletDustDetector.GetDustDensityCallbackThreshold(out option: char; out min: word; out max: word)

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

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

  • BRICKLET_DUST_DETECTOR_THRESHOLD_OPTION_OFF = 'x'
  • BRICKLET_DUST_DETECTOR_THRESHOLD_OPTION_OUTSIDE = 'o'
  • BRICKLET_DUST_DETECTOR_THRESHOLD_OPTION_INSIDE = 'i'
  • BRICKLET_DUST_DETECTOR_THRESHOLD_OPTION_SMALLER = '<'
  • BRICKLET_DUST_DETECTOR_THRESHOLD_OPTION_GREATER = '>'
procedure TBrickletDustDetector.SetDebouncePeriod(const debounce: longword)

Setzt die Periode in ms mit welcher die Schwellwert Callback

ausgelöst wird, wenn der Schwellwert

weiterhin erreicht bleibt.

Der Standardwert ist 100.

function TBrickletDustDetector.GetDebouncePeriod: longword

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: TBrickletDustDetector; const param: word);
begin
  WriteLn(param);
end;

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

Die verfügbaren Callback Properties und ihre Parametertypen 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.

property TBrickletDustDetector.OnDustDensity
procedure(sender: TBrickletDustDetector; const dustDensity: word) of object;

Dieser Callback wird mit der Periode, wie gesetzt mit SetDustDensityCallbackPeriod, ausgelöst. Der Parameter ist die Staubdichte des Sensors.

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

property TBrickletDustDetector.OnDustDensityReached
procedure(sender: TBrickletDustDetector; const dustDensity: word) of object;

Dieser Callback wird ausgelöst, wenn der Schwellwert, wie von SetDustDensityCallbackThreshold gesetzt, erreicht wird. Der Parameter ist die Staubdichte des Sensors.

Wenn der Schwellwert erreicht bleibt, wird der Callback mit der Periode, wie mit SetDebouncePeriod gesetzt, ausgelöst.

Konstanten

const BRICKLET_DUST_DETECTOR_DEVICE_IDENTIFIER

Diese Konstante wird verwendet um ein Dust Detector 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_DUST_DETECTOR_DEVICE_DISPLAY_NAME

Diese Konstante stellt den Anzeigenamen eines Dust Detector Bricklet dar.