Delphi/Lazarus - Particulate Matter Bricklet

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

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

uses
  SysUtils, IPConnection, BrickletParticulateMatter;

type
  TExample = class
  private
    ipcon: TIPConnection;
    pm: TBrickletParticulateMatter;
  public
    procedure Execute;
  end;

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

var
  e: TExample;

procedure TExample.Execute;
var pm10, pm25, pm100: word;
begin
  { Create IP connection }
  ipcon := TIPConnection.Create;

  { Create device object }
  pm := TBrickletParticulateMatter.Create(UID, ipcon);

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

  { Get current PM concentration }
  pm.GetPMConcentration(pm10, pm25, pm100);

  WriteLn(Format('PM 1.0: %d µg/m³', [pm10]));
  WriteLn(Format('PM 2.5: %d µg/m³', [pm25]));
  WriteLn(Format('PM 10.0: %d µg/m³', [pm100]));

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

type
  TExample = class
  private
    ipcon: TIPConnection;
    pm: TBrickletParticulateMatter;
  public
    procedure PMConcentrationCB(sender: TBrickletParticulateMatter; const pm10: word;
                                const pm25: word; const pm100: word);
    procedure Execute;
  end;

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

var
  e: TExample;

{ Callback procedure for PM concentration callback }
procedure TExample.PMConcentrationCB(sender: TBrickletParticulateMatter; const pm10: word;
                                     const pm25: word; const pm100: word);
begin
  WriteLn(Format('PM 1.0: %d µg/m³', [pm10]));
  WriteLn(Format('PM 2.5: %d µg/m³', [pm25]));
  WriteLn(Format('PM 10.0: %d µg/m³', [pm100]));
  WriteLn('');
end;

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

  { Create device object }
  pm := TBrickletParticulateMatter.Create(UID, ipcon);

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

  { Register PM concentration callback to procedure PMConcentrationCB }
  pm.OnPMConcentration := {$ifdef FPC}@{$endif}PMConcentrationCB;

  { Set period for PM concentration callback to 1s (1000ms) }
  pm.SetPMConcentrationCallbackConfiguration(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 TBrickletParticulateMatter.Create(const uid: string; ipcon: TIPConnection)

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

particulateMatter := TBrickletParticulateMatter.Create('YOUR_DEVICE_UID', ipcon);

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

procedure TBrickletParticulateMatter.GetPMConcentration(out pm10: word; out pm25: word; out pm100: word)

Gibt die Feinstaub-Konzentration in µg/m³ zurück, aufgeschlüsselt nach:

  • PM1.0,
  • PM2.5 und
  • PM10.0.

Wenn der Sensor deaktiviert ist (siehe SetEnable), dann wird weiterhin der letzte Sensorwert zurückgegeben.

procedure TBrickletParticulateMatter.GetPMCount(out greater03um: word; out greater05um: word; out greater10um: word; out greater25um: word; out greater50um: word; out greater100um: word)

Gibt die Anzahl der Feinstaub-Teilchen in 100ml Luft zurück, aufgeschlüsselt nach deren Durchmesser:

  • größer 0,3µm,
  • größer 0,5µm,
  • größer 1,0µm,
  • größer 2,5µm,
  • größer 5,0µm und
  • größer 10,0µm.

Wenn der Sensor deaktiviert ist (siehe SetEnable), dann wird weiterhin der letzte Sensorwert zurückgegeben.

Fortgeschrittene Funktionen

procedure TBrickletParticulateMatter.SetEnable(const enable: boolean)

Aktiviert/deaktiviert den Lüfter und die Laserdiode des Sensors. Der Sensor ist standardmäßig aktiv.

Der Sensor benötigt ca. 30 Sekunden nach der Aktivierung um sich einzuschwingen und stabile Werte zu produzieren.

Die Lebensdauer der Laserdiode beträgt ca. 8000 Stunden. Wenn Messungen in größeren Abständen stattfinden sollen (z.B. stündlich) lohnt es sich die Laserdiode zwischen den Messungen auszumachen.

function TBrickletParticulateMatter.GetEnable: boolean

Gibt den Zustand des Sensors zurück, wie von SetEnable gesetzt.

procedure TBrickletParticulateMatter.GetSensorInfo(out sensorVersion: byte; out lastErrorCode: byte; out framingErrorCount: byte; out checksumErrorCount: byte)

Gibt Informationen über den Sensor zurück:

  • die Versionsnummer des Sensors,
  • den letzten Fehlercode den der Sensor gemeldet (0 bedeute kein Fehler) hat,
  • die Anzahl der Framing und Prüfsummenfehler die in der Kommunikation mit dem Sensor aufgetreten sind.
function TBrickletParticulateMatter.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 TBrickletParticulateMatter.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 TBrickletParticulateMatter.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_PARTICULATE_MATTER_FUNCTION_SET_ENABLE = 3
  • BRICKLET_PARTICULATE_MATTER_FUNCTION_SET_PM_CONCENTRATION_CALLBACK_CONFIGURATION = 6
  • BRICKLET_PARTICULATE_MATTER_FUNCTION_SET_PM_COUNT_CALLBACK_CONFIGURATION = 8
  • BRICKLET_PARTICULATE_MATTER_FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
  • BRICKLET_PARTICULATE_MATTER_FUNCTION_SET_STATUS_LED_CONFIG = 239
  • BRICKLET_PARTICULATE_MATTER_FUNCTION_RESET = 243
  • BRICKLET_PARTICULATE_MATTER_FUNCTION_WRITE_UID = 248
procedure TBrickletParticulateMatter.SetResponseExpectedAll(const responseExpected: boolean)

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

procedure TBrickletParticulateMatter.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 TBrickletParticulateMatter.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_PARTICULATE_MATTER_BOOTLOADER_MODE_BOOTLOADER = 0
  • BRICKLET_PARTICULATE_MATTER_BOOTLOADER_MODE_FIRMWARE = 1
  • BRICKLET_PARTICULATE_MATTER_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
  • BRICKLET_PARTICULATE_MATTER_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
  • BRICKLET_PARTICULATE_MATTER_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4
  • BRICKLET_PARTICULATE_MATTER_BOOTLOADER_STATUS_OK = 0
  • BRICKLET_PARTICULATE_MATTER_BOOTLOADER_STATUS_INVALID_MODE = 1
  • BRICKLET_PARTICULATE_MATTER_BOOTLOADER_STATUS_NO_CHANGE = 2
  • BRICKLET_PARTICULATE_MATTER_BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT = 3
  • BRICKLET_PARTICULATE_MATTER_BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT = 4
  • BRICKLET_PARTICULATE_MATTER_BOOTLOADER_STATUS_CRC_MISMATCH = 5
function TBrickletParticulateMatter.GetBootloaderMode: byte

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

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

  • BRICKLET_PARTICULATE_MATTER_BOOTLOADER_MODE_BOOTLOADER = 0
  • BRICKLET_PARTICULATE_MATTER_BOOTLOADER_MODE_FIRMWARE = 1
  • BRICKLET_PARTICULATE_MATTER_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
  • BRICKLET_PARTICULATE_MATTER_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
  • BRICKLET_PARTICULATE_MATTER_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4
procedure TBrickletParticulateMatter.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 TBrickletParticulateMatter.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 TBrickletParticulateMatter.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_PARTICULATE_MATTER_STATUS_LED_CONFIG_OFF = 0
  • BRICKLET_PARTICULATE_MATTER_STATUS_LED_CONFIG_ON = 1
  • BRICKLET_PARTICULATE_MATTER_STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • BRICKLET_PARTICULATE_MATTER_STATUS_LED_CONFIG_SHOW_STATUS = 3
function TBrickletParticulateMatter.GetStatusLEDConfig: byte

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

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

  • BRICKLET_PARTICULATE_MATTER_STATUS_LED_CONFIG_OFF = 0
  • BRICKLET_PARTICULATE_MATTER_STATUS_LED_CONFIG_ON = 1
  • BRICKLET_PARTICULATE_MATTER_STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • BRICKLET_PARTICULATE_MATTER_STATUS_LED_CONFIG_SHOW_STATUS = 3
function TBrickletParticulateMatter.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 TBrickletParticulateMatter.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 TBrickletParticulateMatter.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 TBrickletParticulateMatter.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 TBrickletParticulateMatter.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 TBrickletParticulateMatter.SetPMConcentrationCallbackConfiguration(const period: longword; const valueHasToChange: boolean)

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

Der Standardwert ist (0, false).

procedure TBrickletParticulateMatter.GetPMConcentrationCallbackConfiguration(out period: longword; out valueHasToChange: boolean)

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

procedure TBrickletParticulateMatter.SetPMCountCallbackConfiguration(const period: longword; const valueHasToChange: boolean)

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

Der Standardwert ist (0, false).

procedure TBrickletParticulateMatter.GetPMCountCallbackConfiguration(out period: longword; out valueHasToChange: boolean)

Gibt die Callback-Konfiguration zurück, wie mittels SetPMCountCallbackConfiguration 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: TBrickletParticulateMatter; const param: word);
begin
  WriteLn(param);
end;

particulateMatter.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 TBrickletParticulateMatter.OnPMConcentration
procedure(sender: TBrickletParticulateMatter; const pm10: word; const pm25: word; const pm100: word) of object;

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

Die Parameter sind der gleiche wie GetPMConcentration.

property TBrickletParticulateMatter.OnPMCount
procedure(sender: TBrickletParticulateMatter; const greater03um: word; const greater05um: word; const greater10um: word; const greater25um: word; const greater50um: word; const greater100um: word) of object;

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

Die Parameter sind der gleiche wie GetPMCount.

Konstanten

const BRICKLET_PARTICULATE_MATTER_DEVICE_IDENTIFIER

Diese Konstante wird verwendet um ein Particulate Matter Bricklet zu identifizieren.

Die GetIdentity Funktion und der OnEnumerate Callback der IP Connection haben ein deviceIdentifier Parameter um den Typ des Bricks oder Bricklets anzugeben.

const BRICKLET_PARTICULATE_MATTER_DEVICE_DISPLAY_NAME

Diese Konstante stellt den Anzeigenamen eines Particulate Matter Bricklet dar.