Delphi/Lazarus - CO2 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, BrickletCO2;
 8
 9type
10  TExample = class
11  private
12    ipcon: TIPConnection;
13    co2: TBrickletCO2;
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 CO2 Bricklet }
22
23var
24  e: TExample;
25
26procedure TExample.Execute;
27var co2Concentration: word;
28begin
29  { Create IP connection }
30  ipcon := TIPConnection.Create;
31
32  { Create device object }
33  co2 := TBrickletCO2.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 CO2 concentration }
40  co2Concentration := co2.GetCO2Concentration;
41  WriteLn(Format('CO2 Concentration: %d ppm', [co2Concentration]));
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, BrickletCO2;
 8
 9type
10  TExample = class
11  private
12    ipcon: TIPConnection;
13    co2: TBrickletCO2;
14  public
15    procedure CO2ConcentrationCB(sender: TBrickletCO2; const co2Concentration: word);
16    procedure Execute;
17  end;
18
19const
20  HOST = 'localhost';
21  PORT = 4223;
22  UID = 'XYZ'; { Change XYZ to the UID of your CO2 Bricklet }
23
24var
25  e: TExample;
26
27{ Callback procedure for CO2 concentration callback }
28procedure TExample.CO2ConcentrationCB(sender: TBrickletCO2; const co2Concentration: word);
29begin
30  WriteLn(Format('CO2 Concentration: %d ppm', [co2Concentration]));
31end;
32
33procedure TExample.Execute;
34begin
35  { Create IP connection }
36  ipcon := TIPConnection.Create;
37
38  { Create device object }
39  co2 := TBrickletCO2.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 CO2 concentration callback to procedure CO2ConcentrationCB }
46  co2.OnCO2Concentration := {$ifdef FPC}@{$endif}CO2ConcentrationCB;
47
48  { Set period for CO2 concentration callback to 1s (1000ms)
49    Note: The CO2 concentration callback is only called every second
50          if the CO2 concentration has changed since the last call! }
51  co2.SetCO2ConcentrationCallbackPeriod(1000);
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, BrickletCO2;
 8
 9type
10  TExample = class
11  private
12    ipcon: TIPConnection;
13    co2: TBrickletCO2;
14  public
15    procedure CO2ConcentrationReachedCB(sender: TBrickletCO2;
16                                        const co2Concentration: word);
17    procedure Execute;
18  end;
19
20const
21  HOST = 'localhost';
22  PORT = 4223;
23  UID = 'XYZ'; { Change XYZ to the UID of your CO2 Bricklet }
24
25var
26  e: TExample;
27
28{ Callback procedure for CO2 concentration reached callback }
29procedure TExample.CO2ConcentrationReachedCB(sender: TBrickletCO2;
30                                             const co2Concentration: word);
31begin
32  WriteLn(Format('CO2 Concentration: %d ppm', [co2Concentration]));
33end;
34
35procedure TExample.Execute;
36begin
37  { Create IP connection }
38  ipcon := TIPConnection.Create;
39
40  { Create device object }
41  co2 := TBrickletCO2.Create(UID, ipcon);
42
43  { Connect to brickd }
44  ipcon.Connect(HOST, PORT);
45  { Don't use device before ipcon is connected }
46
47  { Get threshold callbacks with a debounce time of 10 seconds (10000ms) }
48  co2.SetDebouncePeriod(10000);
49
50  { Register CO2 concentration reached callback to procedure CO2ConcentrationReachedCB }
51  co2.OnCO2ConcentrationReached := {$ifdef FPC}@{$endif}CO2ConcentrationReachedCB;
52
53  { Configure threshold for CO2 concentration "greater than 750 ppm" }
54  co2.SetCO2ConcentrationCallbackThreshold('>', 750, 0);
55
56  WriteLn('Press key to exit');
57  ReadLn;
58  ipcon.Destroy; { Calls ipcon.Disconnect internally }
59end;
60
61begin
62  e := TExample.Create;
63  e.Execute;
64  e.Destroy;
65end.

Grundfunktionen¶

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

Parameter:	uid – Typ: string ipcon – Typ: TIPConnection
Rückgabe:	co2 – Typ: TBrickletCO2

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

co2 := TBrickletCO2.Create('YOUR_DEVICE_UID', ipcon);

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

function TBrickletCO2.GetCO2Concentration: word¶

Rückgabe:	co2Concentration – Typ: word, Einheit: 1 ppm, Wertebereich: [0 bis 10000]

Gibt die gemessene CO2-Konzentration zurück.

Wenn die CO2-Konzentration periodisch abgefragt werden soll, wird empfohlen den OnCO2Concentration Callback zu nutzen und die Periode mit SetCO2ConcentrationCallbackPeriod vorzugeben.

Fortgeschrittene Funktionen¶

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

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

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

Der OnCO2Concentration Callback wird nur ausgelöst, wenn sich die CO2-Konzentration seit der letzten Auslösung geändert hat.

function TBrickletCO2.GetCO2ConcentrationCallbackPeriod: longword¶

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

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

procedure TBrickletCO2.SetCO2ConcentrationCallbackThreshold(const option: char; const min: word; const max: word)¶

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

Setzt den Schwellwert für den OnCO2ConcentrationReached Callback.

Die folgenden Optionen sind möglich:

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

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

Für option:

• BRICKLET_CO2_THRESHOLD_OPTION_OFF = 'x'

• BRICKLET_CO2_THRESHOLD_OPTION_OUTSIDE = 'o'

• BRICKLET_CO2_THRESHOLD_OPTION_INSIDE = 'i'

• BRICKLET_CO2_THRESHOLD_OPTION_SMALLER = '<'

• BRICKLET_CO2_THRESHOLD_OPTION_GREATER = '>'

procedure TBrickletCO2.GetCO2ConcentrationCallbackThreshold(out option: char; out min: word; out max: word)¶

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

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

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

Für option:

• BRICKLET_CO2_THRESHOLD_OPTION_OFF = 'x'

• BRICKLET_CO2_THRESHOLD_OPTION_OUTSIDE = 'o'

• BRICKLET_CO2_THRESHOLD_OPTION_INSIDE = 'i'

• BRICKLET_CO2_THRESHOLD_OPTION_SMALLER = '<'

• BRICKLET_CO2_THRESHOLD_OPTION_GREATER = '>'

procedure TBrickletCO2.SetDebouncePeriod(const debounce: longword)¶

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

Setzt die Periode mit welcher die Schwellwert Callbacks

• OnCO2ConcentrationReached,

ausgelöst werden, wenn die Schwellwerte

• SetCO2ConcentrationCallbackThreshold,

weiterhin erreicht bleiben.

function TBrickletCO2.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: TBrickletCO2; const value: longint);
begin
  WriteLn(Format('Value: %d', [value]));
end;

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

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

property TBrickletCO2.OnCO2Concentration¶

procedure(sender: TBrickletCO2; const co2Concentration: word) of object;

Callback-Parameter:	sender – Typ: TBrickletCO2 co2Concentration – Typ: word, Einheit: 1 ppm, Wertebereich: [0 bis 10000]

Dieser Callback wird mit der Periode, wie gesetzt mit SetCO2ConcentrationCallbackPeriod, ausgelöst. Der Parameter ist die gemessene CO2-Konzentration des Sensors.

Der OnCO2Concentration Callback wird nur ausgelöst, wenn sich die CO2-Konzentration seit der letzten Auslösung geändert hat.

property TBrickletCO2.OnCO2ConcentrationReached¶

procedure(sender: TBrickletCO2; const co2Concentration: word) of object;

Callback-Parameter:	sender – Typ: TBrickletCO2 co2Concentration – Typ: word, Einheit: 1 ppm, Wertebereich: [0 bis 10000]

Dieser Callback wird ausgelöst, wenn der Schwellwert, wie von SetCO2ConcentrationCallbackThreshold gesetzt, erreicht wird. Der Parameter ist die gemessene CO2-Konzentration.

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 TBrickletCO2.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 TBrickletCO2.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_CO2_FUNCTION_SET_CO2_CONCENTRATION_CALLBACK_PERIOD = 2

• BRICKLET_CO2_FUNCTION_SET_CO2_CONCENTRATION_CALLBACK_THRESHOLD = 4

• BRICKLET_CO2_FUNCTION_SET_DEBOUNCE_PERIOD = 6

procedure TBrickletCO2.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_CO2_FUNCTION_SET_CO2_CONCENTRATION_CALLBACK_PERIOD = 2

• BRICKLET_CO2_FUNCTION_SET_CO2_CONCENTRATION_CALLBACK_THRESHOLD = 4

• BRICKLET_CO2_FUNCTION_SET_DEBOUNCE_PERIOD = 6

procedure TBrickletCO2.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_CO2_DEVICE_IDENTIFIER¶

Diese Konstante wird verwendet um ein CO2 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_CO2_DEVICE_DISPLAY_NAME¶

Diese Konstante stellt den Anzeigenamen eines CO2 Bricklet dar.