Delphi/Lazarus - Barometer Bricklet

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

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

uses
  SysUtils, IPConnection, BrickletBarometer;

type
  TExample = class
  private
    ipcon: TIPConnection;
    b: TBrickletBarometer;
  public
    procedure Execute;
  end;

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

var
  e: TExample;

procedure TExample.Execute;
var airPressure, altitude: longint;
begin
  { Create IP connection }
  ipcon := TIPConnection.Create;

  { Create device object }
  b := TBrickletBarometer.Create(UID, ipcon);

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

  { Get current air pressure }
  airPressure := b.GetAirPressure;
  WriteLn(Format('Air Pressure: %f mbar', [airPressure/1000.0]));

  { Get current altitude }
  altitude := b.GetAltitude;
  WriteLn(Format('Altitude: %f m', [altitude/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
program ExampleCallback;

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

uses
  SysUtils, IPConnection, BrickletBarometer;

type
  TExample = class
  private
    ipcon: TIPConnection;
    b: TBrickletBarometer;
  public
    procedure AirPressureCB(sender: TBrickletBarometer; const airPressure: longint);
    procedure Execute;
  end;

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

var
  e: TExample;

{ Callback procedure for air pressure callback }
procedure TExample.AirPressureCB(sender: TBrickletBarometer; const airPressure: longint);
begin
  WriteLn(Format('Air Pressure: %f mbar', [airPressure/1000.0]));
end;

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

  { Create device object }
  b := TBrickletBarometer.Create(UID, ipcon);

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

  { Register air pressure callback to procedure AirPressureCB }
  b.OnAirPressure := {$ifdef FPC}@{$endif}AirPressureCB;

  { Set period for air pressure callback to 1s (1000ms)
    Note: The air pressure callback is only called every second
          if the air pressure has changed since the last call! }
  b.SetAirPressureCallbackPeriod(1000);

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

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

Threshold

Download (ExampleThreshold.pas)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
program ExampleThreshold;

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

uses
  SysUtils, IPConnection, BrickletBarometer;

type
  TExample = class
  private
    ipcon: TIPConnection;
    b: TBrickletBarometer;
  public
    procedure AirPressureReachedCB(sender: TBrickletBarometer;
                                   const airPressure: longint);
    procedure Execute;
  end;

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

var
  e: TExample;

{ Callback procedure for air pressure reached callback }
procedure TExample.AirPressureReachedCB(sender: TBrickletBarometer;
                                        const airPressure: longint);
begin
  WriteLn(Format('Air Pressure: %f mbar', [airPressure/1000.0]));
  WriteLn('Enjoy the potentially good weather!');
end;

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

  { Create device object }
  b := TBrickletBarometer.Create(UID, ipcon);

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

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

  { Register air pressure reached callback to procedure AirPressureReachedCB }
  b.OnAirPressureReached := {$ifdef FPC}@{$endif}AirPressureReachedCB;

  { Configure threshold for air pressure "greater than 1025 mbar" }
  b.SetAirPressureCallbackThreshold('>', 1025*1000, 0);

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

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

API

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

Alle folgend aufgelisteten Funktionen und Prozeduren sind Thread-sicher.

Grundfunktionen

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

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

barometer := TBrickletBarometer.Create('YOUR_DEVICE_UID', ipcon);

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

function TBrickletBarometer.GetAirPressure: longint

Gibt den Luftdruck des Luftdrucksensors zurück. Der Wertbereich geht von 10000 bis 1200000 und ist in mbar/1000 angegeben, d.h. bei einem Wert von 1001092 wurde ein Luftdruck von 1001,092 mbar gemessen.

Wenn der Luftdruck periodisch abgefragt werden soll, wird empfohlen den OnAirPressure Callback zu nutzen und die Periode mit SetAirPressureCallbackPeriod vorzugeben.

function TBrickletBarometer.GetAltitude: longint

Gibt die relative Höhe des Luftdrucksensors zurück. Der Wert ist in cm angegeben und wird auf Basis der Differenz zwischen dem aktuellen Luftdruck und dem Referenzluftdruck berechnet, welcher mit SetReferenceAirPressure gesetzt werden kann.

Wenn die Höhe periodisch abgefragt werden soll, wird empfohlen den OnAltitude Callback zu nutzen und die Periode mit SetAltitudeCallbackPeriod vorzugeben.

procedure TBrickletBarometer.SetReferenceAirPressure(const airPressure: longint)

Setzt den Referenzluftdruck in mbar/1000 für die Höhenberechnung. Gültige Werte liegen zwischen 10000 und 1200000. Wenn der aktuelle Luftdruckwert als Referenz übergeben wird dann gibt die Höhenberechnung 0cm aus. Als Abkürzung kann auch 0 übergeben werden, dadurch wird der Referenzluftdruck intern auf den aktuellen Luftdruckwert gesetzt.

Wohl bekannte Referenzluftdruckwerte, die in der Luftfahrt verwendet werden, sind QNH und QFE aus dem Q-Schlüssel.

Der Standardwert ist 1013,25mbar.

function TBrickletBarometer.GetReferenceAirPressure: longint

Gibt den Referenzluftdruckwert zurück, wie von SetReferenceAirPressure gesetzt.

Fortgeschrittene Funktionen

function TBrickletBarometer.GetChipTemperature: smallint

Gibt die Temperatur des Luftdrucksensors zurück. Der Wertbereich ist von -4000 bis 8500 und ist in °C/100 angegeben, d.h. bei einem Wert von 2007 wurde eine Temperatur von 20,07 °C gemessen.

Diese Temperatur wird intern zur Temperaturkompensation der Luftdruckmessung verwendet. Sie ist nicht so genau wie die Temperatur die vom Temperature Bricklet oder dem Temperature IR Bricklet gemessen wird.

procedure TBrickletBarometer.SetAveraging(const movingAveragePressure: byte; const averagePressure: byte; const averageTemperature: byte)

Setzt die unterschiedlichen Averaging-Parameter (Mittelwertbildung). Es ist möglich die Länge des Mittelwerts für Temperatur und Luftdruck anzugeben. Zusätzlich gibt kann die Länge für einen gleitenden Mittelwert für den Luftdruck angegeben werden. Der gleitende Mittelwert wird mit den Werten des normalen Mittelwerts berechnet. Es gibt keinen gleitenden Mittelwert für die Temperatur.

Die maximale Länge des Luftdruckmittelwerts ist 10, des Temperaturmittelwerts 255 und des gleitenden Mittelwertes 25.

Wenn alle drei Parameter auf 0 gesetzt werden, ist das Averaging komplett aus. In diesem Fall gibt es viel Rauschen auf den Daten, allerdings sind die Daten dann ohne Verzögerung. Wir empfehlen das Averaging auszustellen wenn die Daten des Barometer Bricklets zusammen mit anderen Sensordaten fusioniert werden sollen.

Der Standardwert ist 10 für die normalen Mittelwerte und 25 für den gleitenden Mittelwert

Neu in Version 2.0.1 (Plugin).

procedure TBrickletBarometer.GetAveraging(out movingAveragePressure: byte; out averagePressure: byte; out averageTemperature: byte)

Gibt die Averaging-Konfiguration zurück, wie von SetAveraging gesetzt.

Neu in Version 2.0.1 (Plugin).

function TBrickletBarometer.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 TBrickletBarometer.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 TBrickletBarometer.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_BAROMETER_FUNCTION_SET_AIR_PRESSURE_CALLBACK_PERIOD = 3
  • BRICKLET_BAROMETER_FUNCTION_SET_ALTITUDE_CALLBACK_PERIOD = 5
  • BRICKLET_BAROMETER_FUNCTION_SET_AIR_PRESSURE_CALLBACK_THRESHOLD = 7
  • BRICKLET_BAROMETER_FUNCTION_SET_ALTITUDE_CALLBACK_THRESHOLD = 9
  • BRICKLET_BAROMETER_FUNCTION_SET_DEBOUNCE_PERIOD = 11
  • BRICKLET_BAROMETER_FUNCTION_SET_REFERENCE_AIR_PRESSURE = 13
  • BRICKLET_BAROMETER_FUNCTION_SET_AVERAGING = 20
procedure TBrickletBarometer.SetResponseExpectedAll(const responseExpected: boolean)

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

procedure TBrickletBarometer.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 TBrickletBarometer.SetAirPressureCallbackPeriod(const period: longword)

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

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

Der Standardwert ist 0.

function TBrickletBarometer.GetAirPressureCallbackPeriod: longword

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

procedure TBrickletBarometer.SetAltitudeCallbackPeriod(const period: longword)

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

Der OnAltitude Callback wird nur ausgelöst, wenn sich Höhe seit der letzten Auslösung geändert hat.

Der Standardwert ist 0.

function TBrickletBarometer.GetAltitudeCallbackPeriod: longword

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

procedure TBrickletBarometer.SetAirPressureCallbackThreshold(const option: char; const min: longint; const max: longint)

Setzt den Schwellwert für den OnAirPressureReached Callback.

Die folgenden Optionen sind möglich:

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

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

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

  • BRICKLET_BAROMETER_THRESHOLD_OPTION_OFF = 'x'
  • BRICKLET_BAROMETER_THRESHOLD_OPTION_OUTSIDE = 'o'
  • BRICKLET_BAROMETER_THRESHOLD_OPTION_INSIDE = 'i'
  • BRICKLET_BAROMETER_THRESHOLD_OPTION_SMALLER = '<'
  • BRICKLET_BAROMETER_THRESHOLD_OPTION_GREATER = '>'
procedure TBrickletBarometer.GetAirPressureCallbackThreshold(out option: char; out min: longint; out max: longint)

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

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

  • BRICKLET_BAROMETER_THRESHOLD_OPTION_OFF = 'x'
  • BRICKLET_BAROMETER_THRESHOLD_OPTION_OUTSIDE = 'o'
  • BRICKLET_BAROMETER_THRESHOLD_OPTION_INSIDE = 'i'
  • BRICKLET_BAROMETER_THRESHOLD_OPTION_SMALLER = '<'
  • BRICKLET_BAROMETER_THRESHOLD_OPTION_GREATER = '>'
procedure TBrickletBarometer.SetAltitudeCallbackThreshold(const option: char; const min: longint; const max: longint)

Setzt den Schwellwert für den OnAltitudeReached Callback.

Die folgenden Optionen sind möglich:

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

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

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

  • BRICKLET_BAROMETER_THRESHOLD_OPTION_OFF = 'x'
  • BRICKLET_BAROMETER_THRESHOLD_OPTION_OUTSIDE = 'o'
  • BRICKLET_BAROMETER_THRESHOLD_OPTION_INSIDE = 'i'
  • BRICKLET_BAROMETER_THRESHOLD_OPTION_SMALLER = '<'
  • BRICKLET_BAROMETER_THRESHOLD_OPTION_GREATER = '>'
procedure TBrickletBarometer.GetAltitudeCallbackThreshold(out option: char; out min: longint; out max: longint)

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

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

  • BRICKLET_BAROMETER_THRESHOLD_OPTION_OFF = 'x'
  • BRICKLET_BAROMETER_THRESHOLD_OPTION_OUTSIDE = 'o'
  • BRICKLET_BAROMETER_THRESHOLD_OPTION_INSIDE = 'i'
  • BRICKLET_BAROMETER_THRESHOLD_OPTION_SMALLER = '<'
  • BRICKLET_BAROMETER_THRESHOLD_OPTION_GREATER = '>'
procedure TBrickletBarometer.SetDebouncePeriod(const debounce: longword)

Setzt die Periode in ms mit welcher die Schwellwert Callbacks

ausgelöst werden, wenn die Schwellwerte

weiterhin erreicht bleiben.

Der Standardwert ist 100.

function TBrickletBarometer.GetDebouncePeriod: longword

Gibt die Entprellperiode zurück, wie von SetDebouncePeriod gesetzt.

Callbacks

Callbacks können registriert werden um zeitkritische oder wiederkehrende Daten vom Gerät zu erhalten. Die Registrierung erfolgt indem eine Prozedur einem Callback Property des Geräte Objektes zugewiesen wird:

procedure TExample.MyCallback(sender: TBrickletBarometer; const param: word);
begin
  WriteLn(param);
end;

barometer.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 TBrickletBarometer.OnAirPressure
procedure(sender: TBrickletBarometer; const airPressure: longint) of object;

Dieser Callback wird mit der Periode, wie gesetzt mit SetAirPressureCallbackPeriod, ausgelöst. Der Parameter ist der Luftdruck des Luftdrucksensors.

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

property TBrickletBarometer.OnAltitude
procedure(sender: TBrickletBarometer; const altitude: longint) of object;

Dieser Callback wird mit der Periode, wie gesetzt mit SetAltitudeCallbackPeriod, ausgelöst. Der Parameter ist die Höhe des Luftdrucksensors.

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

property TBrickletBarometer.OnAirPressureReached
procedure(sender: TBrickletBarometer; const airPressure: longint) of object;

Dieser Callback wird ausgelöst, wenn der Schwellwert, wie von SetAirPressureCallbackThreshold gesetzt, erreicht wird. Der Parameter ist der Luftdruck des Luftdrucksensors.

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

property TBrickletBarometer.OnAltitudeReached
procedure(sender: TBrickletBarometer; const altitude: longint) of object;

Dieser Callback wird ausgelöst, wenn der Schwellwert, wie von SetAltitudeCallbackThreshold gesetzt, erreicht wird. Der Parameter ist die Höhe des Luftdrucksensors.

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

Konstanten

const BRICKLET_BAROMETER_DEVICE_IDENTIFIER

Diese Konstante wird verwendet um ein Barometer 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_BAROMETER_DEVICE_DISPLAY_NAME

Diese Konstante stellt den Anzeigenamen eines Barometer Bricklet dar.