Delphi/Lazarus - CO2 Bricklet 2.0

Dies ist die Beschreibung der Delphi/Lazarus API Bindings für das CO2 Bricklet 2.0. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des CO2 Bricklet 2.0 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
53
54
55
program ExampleSimple;

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

uses
  SysUtils, IPConnection, BrickletCO2V2;

type
  TExample = class
  private
    ipcon: TIPConnection;
    co2: TBrickletCO2V2;
  public
    procedure Execute;
  end;

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

var
  e: TExample;

procedure TExample.Execute;
var co2Concentration, humidity: word; temperature: smallint;
begin
  { Create IP connection }
  ipcon := TIPConnection.Create;

  { Create device object }
  co2 := TBrickletCO2V2.Create(UID, ipcon);

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

  { Get current all values }
  co2.GetAllValues(co2Concentration, temperature, humidity);

  WriteLn(Format('CO2 Concentration: %d ppm', [co2Concentration]));
  WriteLn(Format('Temperature: %f °C', [temperature/100.0]));
  WriteLn(Format('Humidity: %f %%RH', [humidity/100.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
61
62
63
64
65
program ExampleCallback;

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

uses
  SysUtils, IPConnection, BrickletCO2V2;

type
  TExample = class
  private
    ipcon: TIPConnection;
    co2: TBrickletCO2V2;
  public
    procedure AllValuesCB(sender: TBrickletCO2V2; const co2Concentration: word;
                          const temperature: smallint; const humidity: word);
    procedure Execute;
  end;

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

var
  e: TExample;

{ Callback procedure for all values callback }
procedure TExample.AllValuesCB(sender: TBrickletCO2V2; const co2Concentration: word;
                               const temperature: smallint; const humidity: word);
begin
  WriteLn(Format('CO2 Concentration: %d ppm', [co2Concentration]));
  WriteLn(Format('Temperature: %f °C', [temperature/100.0]));
  WriteLn(Format('Humidity: %f %%RH', [humidity/100.0]));
  WriteLn('');
end;

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

  { Create device object }
  co2 := TBrickletCO2V2.Create(UID, ipcon);

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

  { Register all values callback to procedure AllValuesCB }
  co2.OnAllValues := {$ifdef FPC}@{$endif}AllValuesCB;

  { Set period for all values callback to 1s (1000ms) }
  co2.SetAllValuesCallbackConfiguration(1000, false);

  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 TBrickletCO2V2.Create(const uid: string; ipcon: TIPConnection)

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

co2V2 := TBrickletCO2V2.Create('YOUR_DEVICE_UID', ipcon);

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

procedure TBrickletCO2V2.GetAllValues(out co2Concentration: word; out temperature: smallint; out humidity: word)

Gibt alle Werte zurück, die das CO2 Bricklet 2.0 misst. Diese Werte umfassen: CO2-Konzentration (in ppm), Temperatur (in 0,01 °C) und Luftfeuchte (in 0,01 %RH).

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

procedure TBrickletCO2V2.SetAirPressure(const airPressure: word)

Die CO2-Konzentration hängt (unter anderem) vom Umgebungs-Luftdruck ab.

Um die Genauigkeit des CO2 Bricklet 2.0 zu verbessern ist es möglich den aktuellen Luftdruck zu setzen. Dazu kann das Barometer Bricklet 2.0 oder auch das Air Quality Bricklet genutzt werden.

Die erwartete Einheit des Umgebungs-Luftdrucks ist mbar.

Standardmäßig ist die Luftdruck-Kompensation deaktiviert. Sobald ein Wert gesetzt wird, wird dieser zur Kompensation verwendet. Die Kompensation kann wieder ausgestellt werden in dem der Wert zurück auf 0 gesetzt wird.

Es ist hinreichend den Wert alle paar Minuten zu aktualisieren.

function TBrickletCO2V2.GetAirPressure: word

Gibt den Umgebungs-Luftdruch zurück, wie von SetAirPressure gesetzt.

procedure TBrickletCO2V2.SetTemperatureOffset(const offset: word)

Setzt ein Temperatur-Offset mit Auflösung 1/100°C. Ein Offset von 10 verringert die gemessene Temperatur um 0,1°C.

Wenn das Bricklet in einem Gehäuse verbaut wird, aber die Umgebungstemperatur außerhalb des Gehäuses gemessen werden soll, dann muss vom gemessenen Temperatur ein bestimmter Wert abgezogen werden, um den Messfehler durch das Aufheizen des Gehäuses zu kompensieren.

Wir empfehlen den Messaufbau im Gehäuse mindestens 24 Stunden laufen zu lassen, damit sich ein Temperaturgleichgewicht einstellt. Danach muss die Temperatur außerhalb des Gehäuses gemessen werden und die Differenz zur Temperatur innerhalb des Gehäuses als Offset eingestellt werden.

Dieses Temperatur-Offset geht in die Berechnung der Luftfeuchte und der CO2-Konzentration mit ein. Um die Genauigkeit der Messwerte innerhalb eines Gehäuses zu verbessern sollte der Temperatur-Offset bestimmt und eingestellt werden.

Es ist hinreichend den Temperatur-Offset einmal zu setzen. Der Offset wird in einem nicht-flüchtigen Speicher gespeichert und auch nach einem Neustart wieder angewendet.

function TBrickletCO2V2.GetTemperatureOffset: word

Gibt das Temperatur-Offset zurück, wie mittels SetTemperatureOffset gesetzt.

function TBrickletCO2V2.GetCO2Concentration: word

Gibt die CO2-Konzentration in ppm zurück.

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

function TBrickletCO2V2.GetTemperature: smallint

Gibt die Temperatur in 0,01 °C Schritten zurück.

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

function TBrickletCO2V2.GetHumidity: word

Gibt die relative Luftfeuchtigkeit in 0,01 %RH Schritten zurück.

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

Fortgeschrittene Funktionen

function TBrickletCO2V2.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 TBrickletCO2V2.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_CO2_V2_FUNCTION_SET_AIR_PRESSURE = 2
  • BRICKLET_CO2_V2_FUNCTION_SET_TEMPERATURE_OFFSET = 4
  • BRICKLET_CO2_V2_FUNCTION_SET_ALL_VALUES_CALLBACK_CONFIGURATION = 6
  • BRICKLET_CO2_V2_FUNCTION_SET_CO2_CONCENTRATION_CALLBACK_CONFIGURATION = 10
  • BRICKLET_CO2_V2_FUNCTION_SET_TEMPERATURE_CALLBACK_CONFIGURATION = 14
  • BRICKLET_CO2_V2_FUNCTION_SET_HUMIDITY_CALLBACK_CONFIGURATION = 18
  • BRICKLET_CO2_V2_FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
  • BRICKLET_CO2_V2_FUNCTION_SET_STATUS_LED_CONFIG = 239
  • BRICKLET_CO2_V2_FUNCTION_RESET = 243
  • BRICKLET_CO2_V2_FUNCTION_WRITE_UID = 248
procedure TBrickletCO2V2.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_CO2_V2_FUNCTION_SET_AIR_PRESSURE = 2
  • BRICKLET_CO2_V2_FUNCTION_SET_TEMPERATURE_OFFSET = 4
  • BRICKLET_CO2_V2_FUNCTION_SET_ALL_VALUES_CALLBACK_CONFIGURATION = 6
  • BRICKLET_CO2_V2_FUNCTION_SET_CO2_CONCENTRATION_CALLBACK_CONFIGURATION = 10
  • BRICKLET_CO2_V2_FUNCTION_SET_TEMPERATURE_CALLBACK_CONFIGURATION = 14
  • BRICKLET_CO2_V2_FUNCTION_SET_HUMIDITY_CALLBACK_CONFIGURATION = 18
  • BRICKLET_CO2_V2_FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
  • BRICKLET_CO2_V2_FUNCTION_SET_STATUS_LED_CONFIG = 239
  • BRICKLET_CO2_V2_FUNCTION_RESET = 243
  • BRICKLET_CO2_V2_FUNCTION_WRITE_UID = 248
procedure TBrickletCO2V2.SetResponseExpectedAll(const responseExpected: boolean)

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

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

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.

function TBrickletCO2V2.SetBootloaderMode(const mode: byte): byte

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 Bootlodaer- 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:

  • BRICKLET_CO2_V2_BOOTLOADER_MODE_BOOTLOADER = 0
  • BRICKLET_CO2_V2_BOOTLOADER_MODE_FIRMWARE = 1
  • BRICKLET_CO2_V2_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
  • BRICKLET_CO2_V2_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
  • BRICKLET_CO2_V2_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4
  • BRICKLET_CO2_V2_BOOTLOADER_STATUS_OK = 0
  • BRICKLET_CO2_V2_BOOTLOADER_STATUS_INVALID_MODE = 1
  • BRICKLET_CO2_V2_BOOTLOADER_STATUS_NO_CHANGE = 2
  • BRICKLET_CO2_V2_BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT = 3
  • BRICKLET_CO2_V2_BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT = 4
  • BRICKLET_CO2_V2_BOOTLOADER_STATUS_CRC_MISMATCH = 5
function TBrickletCO2V2.GetBootloaderMode: byte

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

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

  • BRICKLET_CO2_V2_BOOTLOADER_MODE_BOOTLOADER = 0
  • BRICKLET_CO2_V2_BOOTLOADER_MODE_FIRMWARE = 1
  • BRICKLET_CO2_V2_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
  • BRICKLET_CO2_V2_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
  • BRICKLET_CO2_V2_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4
procedure TBrickletCO2V2.SetWriteFirmwarePointer(const pointer: longword)

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 TBrickletCO2V2.WriteFirmware(const data: array [0..63] of byte): byte

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 TBrickletCO2V2.SetStatusLEDConfig(const config: byte)

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:

  • BRICKLET_CO2_V2_STATUS_LED_CONFIG_OFF = 0
  • BRICKLET_CO2_V2_STATUS_LED_CONFIG_ON = 1
  • BRICKLET_CO2_V2_STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • BRICKLET_CO2_V2_STATUS_LED_CONFIG_SHOW_STATUS = 3
function TBrickletCO2V2.GetStatusLEDConfig: byte

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

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

  • BRICKLET_CO2_V2_STATUS_LED_CONFIG_OFF = 0
  • BRICKLET_CO2_V2_STATUS_LED_CONFIG_ON = 1
  • BRICKLET_CO2_V2_STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • BRICKLET_CO2_V2_STATUS_LED_CONFIG_SHOW_STATUS = 3
function TBrickletCO2V2.GetChipTemperature: smallint

Gibt die Temperatur in °C, 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 TBrickletCO2V2.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 TBrickletCO2V2.WriteUID(const uid: longword)

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 TBrickletCO2V2.ReadUID: longword

Gibt die aktuelle UID als Integer zurück. Dieser Integer kann als Base58 encodiert werden um an den üblichen UID-String zu gelangen.

procedure TBrickletCO2V2.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 TBrickletCO2V2.SetAllValuesCallbackConfiguration(const period: longword; const valueHasToChange: boolean)

Die Periode in ms ist die Periode mit der der OnAllValues 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 sich mindestens ein Wert im Vergleich zum letzten mal geändert hat. Ändert sich kein Wert innerhalb der Periode, so wird der Callback sofort ausgelöst, wenn ein 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 der Werte.

Der Standardwert ist (0, false).

procedure TBrickletCO2V2.GetAllValuesCallbackConfiguration(out period: longword; out valueHasToChange: boolean)

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

procedure TBrickletCO2V2.SetCO2ConcentrationCallbackConfiguration(const period: longword; const valueHasToChange: boolean; const option: char; const min: word; const max: word)

Die Periode in ms ist die Periode mit der der OnCO2Concentration 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 OnCO2Concentration 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.

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

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

  • BRICKLET_CO2_V2_THRESHOLD_OPTION_OFF = 'x'
  • BRICKLET_CO2_V2_THRESHOLD_OPTION_OUTSIDE = 'o'
  • BRICKLET_CO2_V2_THRESHOLD_OPTION_INSIDE = 'i'
  • BRICKLET_CO2_V2_THRESHOLD_OPTION_SMALLER = '<'
  • BRICKLET_CO2_V2_THRESHOLD_OPTION_GREATER = '>'
procedure TBrickletCO2V2.GetCO2ConcentrationCallbackConfiguration(out period: longword; out valueHasToChange: boolean; out option: char; out min: word; out max: word)

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

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

  • BRICKLET_CO2_V2_THRESHOLD_OPTION_OFF = 'x'
  • BRICKLET_CO2_V2_THRESHOLD_OPTION_OUTSIDE = 'o'
  • BRICKLET_CO2_V2_THRESHOLD_OPTION_INSIDE = 'i'
  • BRICKLET_CO2_V2_THRESHOLD_OPTION_SMALLER = '<'
  • BRICKLET_CO2_V2_THRESHOLD_OPTION_GREATER = '>'
procedure TBrickletCO2V2.SetTemperatureCallbackConfiguration(const period: longword; const valueHasToChange: boolean; const option: char; const min: smallint; const max: smallint)

Die Periode in ms ist die Periode mit der der OnTemperature 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 OnTemperature 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.

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

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

  • BRICKLET_CO2_V2_THRESHOLD_OPTION_OFF = 'x'
  • BRICKLET_CO2_V2_THRESHOLD_OPTION_OUTSIDE = 'o'
  • BRICKLET_CO2_V2_THRESHOLD_OPTION_INSIDE = 'i'
  • BRICKLET_CO2_V2_THRESHOLD_OPTION_SMALLER = '<'
  • BRICKLET_CO2_V2_THRESHOLD_OPTION_GREATER = '>'
procedure TBrickletCO2V2.GetTemperatureCallbackConfiguration(out period: longword; out valueHasToChange: boolean; out option: char; out min: smallint; out max: smallint)

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

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

  • BRICKLET_CO2_V2_THRESHOLD_OPTION_OFF = 'x'
  • BRICKLET_CO2_V2_THRESHOLD_OPTION_OUTSIDE = 'o'
  • BRICKLET_CO2_V2_THRESHOLD_OPTION_INSIDE = 'i'
  • BRICKLET_CO2_V2_THRESHOLD_OPTION_SMALLER = '<'
  • BRICKLET_CO2_V2_THRESHOLD_OPTION_GREATER = '>'
procedure TBrickletCO2V2.SetHumidityCallbackConfiguration(const period: longword; const valueHasToChange: boolean; const option: char; const min: word; const max: word)

Die Periode in ms ist die Periode mit der der OnHumidity 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 OnHumidity 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.

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

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

  • BRICKLET_CO2_V2_THRESHOLD_OPTION_OFF = 'x'
  • BRICKLET_CO2_V2_THRESHOLD_OPTION_OUTSIDE = 'o'
  • BRICKLET_CO2_V2_THRESHOLD_OPTION_INSIDE = 'i'
  • BRICKLET_CO2_V2_THRESHOLD_OPTION_SMALLER = '<'
  • BRICKLET_CO2_V2_THRESHOLD_OPTION_GREATER = '>'
procedure TBrickletCO2V2.GetHumidityCallbackConfiguration(out period: longword; out valueHasToChange: boolean; out option: char; out min: word; out max: word)

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

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

  • BRICKLET_CO2_V2_THRESHOLD_OPTION_OFF = 'x'
  • BRICKLET_CO2_V2_THRESHOLD_OPTION_OUTSIDE = 'o'
  • BRICKLET_CO2_V2_THRESHOLD_OPTION_INSIDE = 'i'
  • BRICKLET_CO2_V2_THRESHOLD_OPTION_SMALLER = '<'
  • BRICKLET_CO2_V2_THRESHOLD_OPTION_GREATER = '>'

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

co2V2.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 TBrickletCO2V2.OnAllValues
procedure(sender: TBrickletCO2V2; const co2Concentration: word; const temperature: smallint; const humidity: word) of object;

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

Die Parameter sind die gleichen wie GetAllValues.

property TBrickletCO2V2.OnCO2Concentration
procedure(sender: TBrickletCO2V2; const co2Concentration: word) of object;

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

Der Parameter ist der gleiche wie GetCO2Concentration.

property TBrickletCO2V2.OnTemperature
procedure(sender: TBrickletCO2V2; const temperature: smallint) of object;

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

Der Parameter ist der gleiche wie GetTemperature.

property TBrickletCO2V2.OnHumidity
procedure(sender: TBrickletCO2V2; const humidity: word) of object;

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

Der Parameter ist der gleiche wie GetHumidity.

Konstanten

const BRICKLET_CO2_V2_DEVICE_IDENTIFIER

Diese Konstante wird verwendet um ein CO2 Bricklet 2.0 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_V2_DEVICE_DISPLAY_NAME

Diese Konstante stellt den Anzeigenamen eines CO2 Bricklet 2.0 dar.