Delphi/Lazarus - Air Quality Bricklet

Dies ist die Beschreibung der Delphi/Lazarus API Bindings für das Air Quality Bricklet. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des Air Quality 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
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
program ExampleSimple;

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

uses
  SysUtils, IPConnection, BrickletAirQuality;

type
  TExample = class
  private
    ipcon: TIPConnection;
    aq: TBrickletAirQuality;
  public
    procedure Execute;
  end;

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

var
  e: TExample;

procedure TExample.Execute;
var iaqIndex, temperature, humidity, airPressure: longint; iaqIndexAccuracy: byte;
begin
  { Create IP connection }
  ipcon := TIPConnection.Create;

  { Create device object }
  aq := TBrickletAirQuality.Create(UID, ipcon);

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

  { Get current all values }
  aq.GetAllValues(iaqIndex, iaqIndexAccuracy, temperature, humidity, airPressure);

  WriteLn(Format('IAQ Index: %d', [iaqIndex]));

  if (iaqIndexAccuracy = BRICKLET_AIR_QUALITY_ACCURACY_UNRELIABLE) then begin
    WriteLn('IAQ Index Accuracy: Unreliable');
  end
  else if (iaqIndexAccuracy = BRICKLET_AIR_QUALITY_ACCURACY_LOW) then begin
    WriteLn('IAQ Index Accuracy: Low');
  end
  else if (iaqIndexAccuracy = BRICKLET_AIR_QUALITY_ACCURACY_MEDIUM) then begin
    WriteLn('IAQ Index Accuracy: Medium');
  end
  else if (iaqIndexAccuracy = BRICKLET_AIR_QUALITY_ACCURACY_HIGH) then begin
    WriteLn('IAQ Index Accuracy: High');
  end;

  WriteLn(Format('Temperature: %f °C', [temperature/100.0]));
  WriteLn(Format('Humidity: %f %%RH', [humidity/100.0]));
  WriteLn(Format('Air Pressure: %f mbar', [airPressure/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
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
program ExampleCallback;

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

uses
  SysUtils, IPConnection, BrickletAirQuality;

type
  TExample = class
  private
    ipcon: TIPConnection;
    aq: TBrickletAirQuality;
  public
    procedure AllValuesCB(sender: TBrickletAirQuality; const iaqIndex: longint;
                          const iaqIndexAccuracy: byte; const temperature: longint;
                          const humidity: longint; const airPressure: longint);
    procedure Execute;
  end;

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

var
  e: TExample;

{ Callback procedure for all values callback }
procedure TExample.AllValuesCB(sender: TBrickletAirQuality; const iaqIndex: longint;
                               const iaqIndexAccuracy: byte; const temperature: longint;
                               const humidity: longint; const airPressure: longint);
begin
  WriteLn(Format('IAQ Index: %d', [iaqIndex]));

  if (iaqIndexAccuracy = BRICKLET_AIR_QUALITY_ACCURACY_UNRELIABLE) then begin
    WriteLn('IAQ Index Accuracy: Unreliable');
  end
  else if (iaqIndexAccuracy = BRICKLET_AIR_QUALITY_ACCURACY_LOW) then begin
    WriteLn('IAQ Index Accuracy: Low');
  end
  else if (iaqIndexAccuracy = BRICKLET_AIR_QUALITY_ACCURACY_MEDIUM) then begin
    WriteLn('IAQ Index Accuracy: Medium');
  end
  else if (iaqIndexAccuracy = BRICKLET_AIR_QUALITY_ACCURACY_HIGH) then begin
    WriteLn('IAQ Index Accuracy: High');
  end;

  WriteLn(Format('Temperature: %f °C', [temperature/100.0]));
  WriteLn(Format('Humidity: %f %%RH', [humidity/100.0]));
  WriteLn(Format('Air Pressure: %f mbar', [airPressure/100.0]));
  WriteLn('');
end;

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

  { Create device object }
  aq := TBrickletAirQuality.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 }
  aq.OnAllValues := {$ifdef FPC}@{$endif}AllValuesCB;

  { Set period for all values callback to 1s (1000ms) }
  aq.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 TBrickletAirQuality.Create(const uid: string; ipcon: TIPConnection)

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

airQuality := TBrickletAirQuality.Create('YOUR_DEVICE_UID', ipcon);

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

procedure TBrickletAirQuality.GetAllValues(out iaqIndex: longint; out iaqIndexAccuracy: byte; out temperature: longint; out humidity: longint; out airPressure: longint)

Gibt alle Werte zurück, die das Air Quality Bricklet misst. Diese Werte umfassen: IAQ (Indoor Air Quality = Innenraumluftqualität) Index, IAQ Index Genauigkeit, Temperatur, Luftfeuchte und Luftdruck.

Air Quality Index description

Die Werte haben diese Bereiche und Einheiten:

  • IAQ Index: 0 bis 500, ein höhere Werte bedeutet eine stärkere Luftverschmutzung
  • IAQ Index Genauigkeit: 0 = unzuverlässig bis 3 = hoch
  • Temperatur: in 0,01 °C Schritten
  • Luftfeuchte: in 0,01 %RH Schritten
  • Luftdruck: in 0,01 mbar Schritten

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

  • BRICKLET_AIR_QUALITY_ACCURACY_UNRELIABLE = 0
  • BRICKLET_AIR_QUALITY_ACCURACY_LOW = 1
  • BRICKLET_AIR_QUALITY_ACCURACY_MEDIUM = 2
  • BRICKLET_AIR_QUALITY_ACCURACY_HIGH = 3
procedure TBrickletAirQuality.SetTemperatureOffset(const offset: longint)

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 des IAQ Index mit ein. Um die Genauigkeit der Messwerte innerhalb eines Gehäuses zu verbessern sollte der Temperatur-Offset unbedingt bestimmt und eingestellt werden.

function TBrickletAirQuality.GetTemperatureOffset: longint

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

procedure TBrickletAirQuality.GetIAQIndex(out iaqIndex: longint; out iaqIndexAccuracy: byte)

Gibt den IAQ Index und dessen Genaugkeit zurück. Der IAQ Index hate einen Wertebereich von 0 bis 500, ein höhere Werte bedeutet eine stärkere Luftverschmutzung.

IAQ Index Beschreibung

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

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

  • BRICKLET_AIR_QUALITY_ACCURACY_UNRELIABLE = 0
  • BRICKLET_AIR_QUALITY_ACCURACY_LOW = 1
  • BRICKLET_AIR_QUALITY_ACCURACY_MEDIUM = 2
  • BRICKLET_AIR_QUALITY_ACCURACY_HIGH = 3
function TBrickletAirQuality.GetTemperature: longint

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 TBrickletAirQuality.GetHumidity: longint

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.

function TBrickletAirQuality.GetAirPressure: longint

Gibt den Luftdruck in 0,01 mbar Schritten zurück.

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

Fortgeschrittene Funktionen

procedure TBrickletAirQuality.RemoveCalibration

Löscht die Kalibrierung auf dem Flash. Nach dem diese Funktion aufgerufen wird muss das Air Quality Bricklet vom Strom getrennt werden.

Beim nächsten starten des Bricklet wird eine komplett neue Kalibrierung gestartet, wie beim allerersten Starten des Bricklets.

Die Kalibrierung basiert auf den Daten der letzten vier Tage, daher dauert es vier Tage bis eine volle Kalibrierung wieder hergestellt ist.

Neu in Version 2.0.3 (Plugin).

procedure TBrickletAirQuality.SetBackgroundCalibrationDuration(const duration: byte)

Das Air Quality Bricklet nutzt eine automatische Hintergrundkalibrierung um den IAQ-Index zu bestimmen. Der Kalibrierungsmechanismus nutzt eine Historie von gemessenen Werte. Die Länge dieser Historie kann zwischen 4 und 28 Tagen konfiguriert werden.

Wenn das Bricklet hauptsächlich am gleichen Ort bleibt und die Umgebung nicht oft verändert wird, empfehlen wir eine Länge von 28 Tagen zu verwenden.

Wenn die Länge geändert wird,wird die aktuelle Kalibrierung verworfen und die Kalibrierung beginnt von vorne. Die Konfiguration der Länge wird im Flash gespeichert, diese Funktion sollte also nur einmal in der Lebenszeit des Bricklets aufgerufen werden müssen.

Eine Änderung der Kalibrierungslänge wird beim nächsten Start des Bricklets übernommen.

Vor Firmware-Version 2.0.3 war die Hintergrundkalibrierungslänge 4 Tage und nicht konfigurierbare.

Der Standardwert (seit Firmware-Version 2.0.3) beträgt 28 Tage.

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

  • BRICKLET_AIR_QUALITY_DURATION_4_DAYS = 0
  • BRICKLET_AIR_QUALITY_DURATION_28_DAYS = 1

Neu in Version 2.0.3 (Plugin).

function TBrickletAirQuality.GetBackgroundCalibrationDuration: byte

Gibt die Länge der Hintergrundkalibrierung zurück, wie von SetBackgroundCalibrationDuration gesetzt.

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

  • BRICKLET_AIR_QUALITY_DURATION_4_DAYS = 0
  • BRICKLET_AIR_QUALITY_DURATION_28_DAYS = 1

Neu in Version 2.0.3 (Plugin).

function TBrickletAirQuality.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 TBrickletAirQuality.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.

Siehe SetResponseExpected für die Liste der verfügbaren Funktions ID Konstanten für diese Funktion.

procedure TBrickletAirQuality.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 Funktions ID Konstanten sind für diese Funktion verfügbar:

  • BRICKLET_AIR_QUALITY_FUNCTION_SET_TEMPERATURE_OFFSET = 2
  • BRICKLET_AIR_QUALITY_FUNCTION_SET_ALL_VALUES_CALLBACK_CONFIGURATION = 4
  • BRICKLET_AIR_QUALITY_FUNCTION_SET_IAQ_INDEX_CALLBACK_CONFIGURATION = 8
  • BRICKLET_AIR_QUALITY_FUNCTION_SET_TEMPERATURE_CALLBACK_CONFIGURATION = 12
  • BRICKLET_AIR_QUALITY_FUNCTION_SET_HUMIDITY_CALLBACK_CONFIGURATION = 16
  • BRICKLET_AIR_QUALITY_FUNCTION_SET_AIR_PRESSURE_CALLBACK_CONFIGURATION = 20
  • BRICKLET_AIR_QUALITY_FUNCTION_REMOVE_CALIBRATION = 23
  • BRICKLET_AIR_QUALITY_FUNCTION_SET_BACKGROUND_CALIBRATION_DURATION = 24
  • BRICKLET_AIR_QUALITY_FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
  • BRICKLET_AIR_QUALITY_FUNCTION_SET_STATUS_LED_CONFIG = 239
  • BRICKLET_AIR_QUALITY_FUNCTION_RESET = 243
  • BRICKLET_AIR_QUALITY_FUNCTION_WRITE_UID = 248
procedure TBrickletAirQuality.SetResponseExpectedAll(const responseExpected: boolean)

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

procedure TBrickletAirQuality.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 TBrickletAirQuality.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_AIR_QUALITY_BOOTLOADER_MODE_BOOTLOADER = 0
  • BRICKLET_AIR_QUALITY_BOOTLOADER_MODE_FIRMWARE = 1
  • BRICKLET_AIR_QUALITY_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
  • BRICKLET_AIR_QUALITY_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
  • BRICKLET_AIR_QUALITY_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4
  • BRICKLET_AIR_QUALITY_BOOTLOADER_STATUS_OK = 0
  • BRICKLET_AIR_QUALITY_BOOTLOADER_STATUS_INVALID_MODE = 1
  • BRICKLET_AIR_QUALITY_BOOTLOADER_STATUS_NO_CHANGE = 2
  • BRICKLET_AIR_QUALITY_BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT = 3
  • BRICKLET_AIR_QUALITY_BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT = 4
  • BRICKLET_AIR_QUALITY_BOOTLOADER_STATUS_CRC_MISMATCH = 5
function TBrickletAirQuality.GetBootloaderMode: byte

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

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

  • BRICKLET_AIR_QUALITY_BOOTLOADER_MODE_BOOTLOADER = 0
  • BRICKLET_AIR_QUALITY_BOOTLOADER_MODE_FIRMWARE = 1
  • BRICKLET_AIR_QUALITY_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
  • BRICKLET_AIR_QUALITY_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
  • BRICKLET_AIR_QUALITY_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4
procedure TBrickletAirQuality.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 TBrickletAirQuality.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 TBrickletAirQuality.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_AIR_QUALITY_STATUS_LED_CONFIG_OFF = 0
  • BRICKLET_AIR_QUALITY_STATUS_LED_CONFIG_ON = 1
  • BRICKLET_AIR_QUALITY_STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • BRICKLET_AIR_QUALITY_STATUS_LED_CONFIG_SHOW_STATUS = 3
function TBrickletAirQuality.GetStatusLEDConfig: byte

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

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

  • BRICKLET_AIR_QUALITY_STATUS_LED_CONFIG_OFF = 0
  • BRICKLET_AIR_QUALITY_STATUS_LED_CONFIG_ON = 1
  • BRICKLET_AIR_QUALITY_STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • BRICKLET_AIR_QUALITY_STATUS_LED_CONFIG_SHOW_STATUS = 3
function TBrickletAirQuality.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 TBrickletAirQuality.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 TBrickletAirQuality.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 TBrickletAirQuality.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 TBrickletAirQuality.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 TBrickletAirQuality.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 TBrickletAirQuality.GetAllValuesCallbackConfiguration(out period: longword; out valueHasToChange: boolean)

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

procedure TBrickletAirQuality.SetIAQIndexCallbackConfiguration(const period: longword; const valueHasToChange: boolean)

Die Periode in ms ist die Periode mit der der OnIAQIndex 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 TBrickletAirQuality.GetIAQIndexCallbackConfiguration(out period: longword; out valueHasToChange: boolean)

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

procedure TBrickletAirQuality.SetTemperatureCallbackConfiguration(const period: longword; const valueHasToChange: boolean; const option: char; const min: longint; const max: longint)

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_AIR_QUALITY_THRESHOLD_OPTION_OFF = 'x'
  • BRICKLET_AIR_QUALITY_THRESHOLD_OPTION_OUTSIDE = 'o'
  • BRICKLET_AIR_QUALITY_THRESHOLD_OPTION_INSIDE = 'i'
  • BRICKLET_AIR_QUALITY_THRESHOLD_OPTION_SMALLER = '<'
  • BRICKLET_AIR_QUALITY_THRESHOLD_OPTION_GREATER = '>'
procedure TBrickletAirQuality.GetTemperatureCallbackConfiguration(out period: longword; out valueHasToChange: boolean; out option: char; out min: longint; out max: longint)

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

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

  • BRICKLET_AIR_QUALITY_THRESHOLD_OPTION_OFF = 'x'
  • BRICKLET_AIR_QUALITY_THRESHOLD_OPTION_OUTSIDE = 'o'
  • BRICKLET_AIR_QUALITY_THRESHOLD_OPTION_INSIDE = 'i'
  • BRICKLET_AIR_QUALITY_THRESHOLD_OPTION_SMALLER = '<'
  • BRICKLET_AIR_QUALITY_THRESHOLD_OPTION_GREATER = '>'
procedure TBrickletAirQuality.SetHumidityCallbackConfiguration(const period: longword; const valueHasToChange: boolean; const option: char; const min: longint; const max: longint)

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_AIR_QUALITY_THRESHOLD_OPTION_OFF = 'x'
  • BRICKLET_AIR_QUALITY_THRESHOLD_OPTION_OUTSIDE = 'o'
  • BRICKLET_AIR_QUALITY_THRESHOLD_OPTION_INSIDE = 'i'
  • BRICKLET_AIR_QUALITY_THRESHOLD_OPTION_SMALLER = '<'
  • BRICKLET_AIR_QUALITY_THRESHOLD_OPTION_GREATER = '>'
procedure TBrickletAirQuality.GetHumidityCallbackConfiguration(out period: longword; out valueHasToChange: boolean; out option: char; out min: longint; out max: longint)

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

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

  • BRICKLET_AIR_QUALITY_THRESHOLD_OPTION_OFF = 'x'
  • BRICKLET_AIR_QUALITY_THRESHOLD_OPTION_OUTSIDE = 'o'
  • BRICKLET_AIR_QUALITY_THRESHOLD_OPTION_INSIDE = 'i'
  • BRICKLET_AIR_QUALITY_THRESHOLD_OPTION_SMALLER = '<'
  • BRICKLET_AIR_QUALITY_THRESHOLD_OPTION_GREATER = '>'
procedure TBrickletAirQuality.SetAirPressureCallbackConfiguration(const period: longword; const valueHasToChange: boolean; const option: char; const min: longint; const max: longint)

Die Periode in ms ist die Periode mit der der OnAirPressure 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 OnAirPressure 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_AIR_QUALITY_THRESHOLD_OPTION_OFF = 'x'
  • BRICKLET_AIR_QUALITY_THRESHOLD_OPTION_OUTSIDE = 'o'
  • BRICKLET_AIR_QUALITY_THRESHOLD_OPTION_INSIDE = 'i'
  • BRICKLET_AIR_QUALITY_THRESHOLD_OPTION_SMALLER = '<'
  • BRICKLET_AIR_QUALITY_THRESHOLD_OPTION_GREATER = '>'
procedure TBrickletAirQuality.GetAirPressureCallbackConfiguration(out period: longword; out valueHasToChange: boolean; out option: char; out min: longint; out max: longint)

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

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

  • BRICKLET_AIR_QUALITY_THRESHOLD_OPTION_OFF = 'x'
  • BRICKLET_AIR_QUALITY_THRESHOLD_OPTION_OUTSIDE = 'o'
  • BRICKLET_AIR_QUALITY_THRESHOLD_OPTION_INSIDE = 'i'
  • BRICKLET_AIR_QUALITY_THRESHOLD_OPTION_SMALLER = '<'
  • BRICKLET_AIR_QUALITY_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: TBrickletAirQuality; const param: word);
begin
  WriteLn(param);
end;

airQuality.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 TBrickletAirQuality.OnAllValues
procedure(sender: TBrickletAirQuality; const iaqIndex: longint; const iaqIndexAccuracy: byte; const temperature: longint; const humidity: longint; const airPressure: longint) of object;

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

Die Parameter sind der gleiche wie GetAllValues.

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

  • BRICKLET_AIR_QUALITY_ACCURACY_UNRELIABLE = 0
  • BRICKLET_AIR_QUALITY_ACCURACY_LOW = 1
  • BRICKLET_AIR_QUALITY_ACCURACY_MEDIUM = 2
  • BRICKLET_AIR_QUALITY_ACCURACY_HIGH = 3
property TBrickletAirQuality.OnIAQIndex
procedure(sender: TBrickletAirQuality; const iaqIndex: longint; const iaqIndexAccuracy: byte) of object;

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

Die Parameter sind die gleichen wie GetIAQIndex.

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

  • BRICKLET_AIR_QUALITY_ACCURACY_UNRELIABLE = 0
  • BRICKLET_AIR_QUALITY_ACCURACY_LOW = 1
  • BRICKLET_AIR_QUALITY_ACCURACY_MEDIUM = 2
  • BRICKLET_AIR_QUALITY_ACCURACY_HIGH = 3
property TBrickletAirQuality.OnTemperature
procedure(sender: TBrickletAirQuality; const temperature: longint) of object;

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

Der Parameter ist der gleiche wie GetTemperature.

property TBrickletAirQuality.OnHumidity
procedure(sender: TBrickletAirQuality; const humidity: longint) of object;

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

Der Parameter ist der gleiche wie GetHumidity.

property TBrickletAirQuality.OnAirPressure
procedure(sender: TBrickletAirQuality; const airPressure: longint) of object;

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

Der Parameter ist der gleiche wie GetAirPressure.

Konstanten

const BRICKLET_AIR_QUALITY_DEVICE_IDENTIFIER

Diese Konstante wird verwendet um ein Air Quality 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_AIR_QUALITY_DEVICE_DISPLAY_NAME

Diese Konstante stellt den Anzeigenamen eines Air Quality Bricklet dar.