Delphi/Lazarus - Barometer Bricklet 2.0

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

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

uses
  SysUtils, IPConnection, BrickletBarometerV2;

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

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

var
  e: TExample;

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

  { Create device object }
  b := TBrickletBarometerV2.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/1000.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
program ExampleCallback;

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

uses
  SysUtils, IPConnection, BrickletBarometerV2;

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

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

var
  e: TExample;

{ Callback procedure for air pressure callback }
procedure TExample.AirPressureCB(sender: TBrickletBarometerV2;
                                 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 := TBrickletBarometerV2.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) without a threshold }
  b.SetAirPressureCallbackConfiguration(1000, false, 'x', 0, 0);

  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
program ExampleThreshold;

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

uses
  SysUtils, IPConnection, BrickletBarometerV2;

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

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

var
  e: TExample;

{ Callback procedure for air pressure callback }
procedure TExample.AirPressureCB(sender: TBrickletBarometerV2;
                                 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 := TBrickletBarometerV2.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;

  { Configure threshold for air pressure "greater than 1025 mbar"
    with a debounce period of 1s (1000ms) }
  b.SetAirPressureCallbackConfiguration(1000, false, '>', 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 TBrickletBarometerV2.Create(const uid: string; ipcon: TIPConnection)
Parameter:
  • uid – Typ: string
  • ipcon – Typ: TIPConnection
Rückgabe:
  • barometerV2 – Typ: TBrickletBarometerV2

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

barometerV2 := TBrickletBarometerV2.Create('YOUR_DEVICE_UID', ipcon);

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

function TBrickletBarometerV2.GetAirPressure: longint
Rückgabe:
  • airPressure – Typ: longint, Wertebereich: [-231 bis 231 - 1]

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

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

function TBrickletBarometerV2.GetAltitude: longint
Rückgabe:
  • altitude – Typ: longint, Wertebereich: [-231 bis 231 - 1]

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

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

function TBrickletBarometerV2.GetTemperature: longint
Rückgabe:
  • temperature – Typ: longint, Wertebereich: [-231 bis 231 - 1]

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 2.0 oder dem Temperature IR Bricklet 2.0 gemessen wird.

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

procedure TBrickletBarometerV2.SetMovingAverageConfiguration(const movingAverageLengthAirPressure: word; const movingAverageLengthTemperature: word)
Parameter:
  • movingAverageLengthAirPressure – Typ: word, Wertebereich: [0 bis 216 - 1]
  • movingAverageLengthTemperature – Typ: word, Wertebereich: [0 bis 216 - 1]

Setzt die Länge eines gleitenden Mittelwerts für die Luftdruck- und Temperaturmessung.

Wenn die Länge auf 1 gesetzt wird, ist die Mittelwertbildung deaktiviert. Je kürzer die Länge des Mittelwerts ist, desto mehr Rauschen ist auf den Daten.

Der Wertebereich liegt bei 1-1000.

Bei Langzeitmessungen gibt ein langer Mittelwert die saubersten Resultate.

Der Standardwert ist 100.

procedure TBrickletBarometerV2.GetMovingAverageConfiguration(out movingAverageLengthAirPressure: word; out movingAverageLengthTemperature: word)
Ausgabeparameter:
  • movingAverageLengthAirPressure – Typ: word, Wertebereich: [0 bis 216 - 1]
  • movingAverageLengthTemperature – Typ: word, Wertebereich: [0 bis 216 - 1]

Gibt die Moving Average-Konfiguration zurück, wie von SetMovingAverageConfiguration gesetzt.

procedure TBrickletBarometerV2.SetReferenceAirPressure(const airPressure: longint)
Parameter:
  • airPressure – Typ: longint, Wertebereich: [-231 bis 231 - 1]

Setzt den Referenzluftdruck in mbar/1000 für die Höhenberechnung. Gültige Werte liegen zwischen 260000 und 1260000. Wenn der aktuelle Luftdruckwert als Referenz übergeben wird dann gibt die Höhenberechnung 0mm 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 TBrickletBarometerV2.GetReferenceAirPressure: longint
Rückgabe:
  • airPressure – Typ: longint, Wertebereich: [-231 bis 231 - 1]

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

Fortgeschrittene Funktionen

procedure TBrickletBarometerV2.SetCalibration(const measuredAirPressure: longint; const actualAirPressure: longint)
Parameter:
  • measuredAirPressure – Typ: longint, Wertebereich: [-231 bis 231 - 1]
  • actualAirPressure – Typ: longint, Wertebereich: [-231 bis 231 - 1]

Setzt den One Point Calibration (OPC) Werte für die Luftdruckmessung.

Bevor das Bricklet kalibriert werden kann muss die möglicherweise vorhandene Kalibierung gelöschet werden, dazu muss Measured Air Pressure und Actual Air Pressure auf 0 gesetzt werden.

Dann muss der aktuelle Luftdruck gleichzeitig mit dem Bricklet (Measured Air Pressure) und einem genauen Referenzbarometer (Actual Air Pressure) gemessen und die Werte in mbar/1000 an diese Funktion übergeben werden.

Nach einer ordentlichen Kalibrierung kann der Luftdruck mit bis zu 0,2 mbar Genauigkeit gemessen werden

Die Kalibrierung wird im EEPROM des Bricklets gespeichert und muss nur einmal gesetzt werden.

procedure TBrickletBarometerV2.GetCalibration(out measuredAirPressure: longint; out actualAirPressure: longint)
Ausgabeparameter:
  • measuredAirPressure – Typ: longint, Wertebereich: [-231 bis 231 - 1]
  • actualAirPressure – Typ: longint, Wertebereich: [-231 bis 231 - 1]

Gibt die Luftdruck One Point Calibration Werte zurück, wie von SetCalibration gesetzt.

procedure TBrickletBarometerV2.SetSensorConfiguration(const dataRate: byte; const airPressureLowPassFilter: byte)
Parameter:
  • dataRate – Typ: byte, Wertebereich: Siehe Konstanten
  • airPressureLowPassFilter – Typ: byte, Wertebereich: Siehe Konstanten

Konfiguriert die Datenrate und de Luftdrucktiefpassfilter. Die Grenzfrequenz des Tiefpassfilters (falls aktiviert) kann auf 1/9tel oder 1/20stel der eingestellten Datenrate gesetzt werden, um das Rauschen auf den Luftdruckdaten zu verringert.

Die Tiefpassfiltereinstellung gilt nur für die Luftdruckmessung. Es gibt keinen Tiefpassfilter für die Temperaturmessung.

Eine Verringerung der Datenrate oder des Wertebereichs verringert auch automatisch das Rauschen auf den Daten. Eine hohe Datenrate erhöht zusätzlich die Selbsterhitzung des Sensors. Wenn eine hohe Temperaturgenauigkeit wichtig ist empfehlen wir eine Datenrate von 1Hz.

Die Standardwerte sind 50Hz Datenrate und 1/9tel Tiefpassfilter.

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

Für dataRate:

  • BRICKLET_BAROMETER_V2_DATA_RATE_OFF = 0
  • BRICKLET_BAROMETER_V2_DATA_RATE_1HZ = 1
  • BRICKLET_BAROMETER_V2_DATA_RATE_10HZ = 2
  • BRICKLET_BAROMETER_V2_DATA_RATE_25HZ = 3
  • BRICKLET_BAROMETER_V2_DATA_RATE_50HZ = 4
  • BRICKLET_BAROMETER_V2_DATA_RATE_75HZ = 5

Für airPressureLowPassFilter:

  • BRICKLET_BAROMETER_V2_LOW_PASS_FILTER_OFF = 0
  • BRICKLET_BAROMETER_V2_LOW_PASS_FILTER_1_9TH = 1
  • BRICKLET_BAROMETER_V2_LOW_PASS_FILTER_1_20TH = 2
procedure TBrickletBarometerV2.GetSensorConfiguration(out dataRate: byte; out airPressureLowPassFilter: byte)
Ausgabeparameter:
  • dataRate – Typ: byte, Wertebereich: Siehe Konstanten
  • airPressureLowPassFilter – Typ: byte, Wertebereich: Siehe Konstanten

Gibt die Sensor-Konfiguration zurück, wie von SetSensorConfiguration gesetzt.

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

Für dataRate:

  • BRICKLET_BAROMETER_V2_DATA_RATE_OFF = 0
  • BRICKLET_BAROMETER_V2_DATA_RATE_1HZ = 1
  • BRICKLET_BAROMETER_V2_DATA_RATE_10HZ = 2
  • BRICKLET_BAROMETER_V2_DATA_RATE_25HZ = 3
  • BRICKLET_BAROMETER_V2_DATA_RATE_50HZ = 4
  • BRICKLET_BAROMETER_V2_DATA_RATE_75HZ = 5

Für airPressureLowPassFilter:

  • BRICKLET_BAROMETER_V2_LOW_PASS_FILTER_OFF = 0
  • BRICKLET_BAROMETER_V2_LOW_PASS_FILTER_1_9TH = 1
  • BRICKLET_BAROMETER_V2_LOW_PASS_FILTER_1_20TH = 2
function TBrickletBarometerV2.GetAPIVersion: array [0..2] of byte
Rückgabe:
  • apiVersion – Typ: array [0..2] of byte, Wertebereich: [0 bis 255]

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 TBrickletBarometerV2.GetResponseExpected(const functionId: byte): boolean
Parameter:
  • functionId – Typ: byte, Wertebereich: Siehe Konstanten
Rückgabe:
  • responseExpected – Typ: boolean

Gibt das Response-Expected-Flag für die Funktion mit der angegebenen Funktions IDs zurück. Es ist true falls für die Funktion beim Aufruf eine Antwort erwartet wird, false andernfalls.

Für Getter-Funktionen ist diese Flag immer gesetzt und kann nicht entfernt werden, da diese Funktionen immer eine Antwort senden. Für Konfigurationsfunktionen für Callbacks ist es standardmäßig gesetzt, kann aber entfernt werden mittels SetResponseExpected. Für Setter-Funktionen ist es standardmäßig nicht gesetzt, kann aber gesetzt werden.

Wenn das Response-Expected-Flag für eine Setter-Funktion gesetzt ist, können Timeouts und andere Fehlerfälle auch für Aufrufe dieser Setter-Funktion detektiert werden. Das Gerät sendet dann eine Antwort extra für diesen Zweck. Wenn das Flag für eine Setter-Funktion nicht gesetzt ist, dann wird keine Antwort vom Gerät gesendet und Fehler werden stillschweigend ignoriert, da sie nicht detektiert werden können.

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

Für functionId:

  • BRICKLET_BAROMETER_V2_FUNCTION_SET_AIR_PRESSURE_CALLBACK_CONFIGURATION = 2
  • BRICKLET_BAROMETER_V2_FUNCTION_SET_ALTITUDE_CALLBACK_CONFIGURATION = 6
  • BRICKLET_BAROMETER_V2_FUNCTION_SET_TEMPERATURE_CALLBACK_CONFIGURATION = 10
  • BRICKLET_BAROMETER_V2_FUNCTION_SET_MOVING_AVERAGE_CONFIGURATION = 13
  • BRICKLET_BAROMETER_V2_FUNCTION_SET_REFERENCE_AIR_PRESSURE = 15
  • BRICKLET_BAROMETER_V2_FUNCTION_SET_CALIBRATION = 17
  • BRICKLET_BAROMETER_V2_FUNCTION_SET_SENSOR_CONFIGURATION = 19
  • BRICKLET_BAROMETER_V2_FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
  • BRICKLET_BAROMETER_V2_FUNCTION_SET_STATUS_LED_CONFIG = 239
  • BRICKLET_BAROMETER_V2_FUNCTION_RESET = 243
  • BRICKLET_BAROMETER_V2_FUNCTION_WRITE_UID = 248
procedure TBrickletBarometerV2.SetResponseExpected(const functionId: byte; const responseExpected: boolean)
Parameter:
  • functionId – Typ: byte, Wertebereich: Siehe Konstanten
  • responseExpected – Typ: boolean

Ändert das Response-Expected-Flag für die Funktion mit der angegebenen Funktion IDs. Diese Flag kann nur für Setter-Funktionen (Standardwert: false) und Konfigurationsfunktionen für Callbacks (Standardwert: true) geändert werden. Für Getter-Funktionen ist das Flag immer gesetzt.

Wenn das Response-Expected-Flag für eine Setter-Funktion gesetzt ist, können Timeouts und andere Fehlerfälle auch für Aufrufe dieser Setter-Funktion detektiert werden. Das Gerät sendet dann eine Antwort extra für diesen Zweck. Wenn das Flag für eine Setter-Funktion nicht gesetzt ist, dann wird keine Antwort vom Gerät gesendet und Fehler werden stillschweigend ignoriert, da sie nicht detektiert werden können.

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

Für functionId:

  • BRICKLET_BAROMETER_V2_FUNCTION_SET_AIR_PRESSURE_CALLBACK_CONFIGURATION = 2
  • BRICKLET_BAROMETER_V2_FUNCTION_SET_ALTITUDE_CALLBACK_CONFIGURATION = 6
  • BRICKLET_BAROMETER_V2_FUNCTION_SET_TEMPERATURE_CALLBACK_CONFIGURATION = 10
  • BRICKLET_BAROMETER_V2_FUNCTION_SET_MOVING_AVERAGE_CONFIGURATION = 13
  • BRICKLET_BAROMETER_V2_FUNCTION_SET_REFERENCE_AIR_PRESSURE = 15
  • BRICKLET_BAROMETER_V2_FUNCTION_SET_CALIBRATION = 17
  • BRICKLET_BAROMETER_V2_FUNCTION_SET_SENSOR_CONFIGURATION = 19
  • BRICKLET_BAROMETER_V2_FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
  • BRICKLET_BAROMETER_V2_FUNCTION_SET_STATUS_LED_CONFIG = 239
  • BRICKLET_BAROMETER_V2_FUNCTION_RESET = 243
  • BRICKLET_BAROMETER_V2_FUNCTION_WRITE_UID = 248
procedure TBrickletBarometerV2.SetResponseExpectedAll(const responseExpected: boolean)
Parameter:
  • responseExpected – Typ: boolean

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

procedure TBrickletBarometerV2.GetSPITFPErrorCount(out errorCountAckChecksum: longword; out errorCountMessageChecksum: longword; out errorCountFrame: longword; out errorCountOverflow: longword)
Ausgabeparameter:
  • errorCountAckChecksum – Typ: longword, Wertebereich: [0 bis 232 - 1]
  • errorCountMessageChecksum – Typ: longword, Wertebereich: [0 bis 232 - 1]
  • errorCountFrame – Typ: longword, Wertebereich: [0 bis 232 - 1]
  • errorCountOverflow – Typ: longword, Wertebereich: [0 bis 232 - 1]

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 TBrickletBarometerV2.SetBootloaderMode(const mode: byte): byte
Parameter:
  • mode – Typ: byte, Wertebereich: Siehe Konstanten
Rückgabe:
  • status – Typ: byte, Wertebereich: Siehe Konstanten

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:

Für mode:

  • BRICKLET_BAROMETER_V2_BOOTLOADER_MODE_BOOTLOADER = 0
  • BRICKLET_BAROMETER_V2_BOOTLOADER_MODE_FIRMWARE = 1
  • BRICKLET_BAROMETER_V2_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
  • BRICKLET_BAROMETER_V2_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
  • BRICKLET_BAROMETER_V2_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4

Für status:

  • BRICKLET_BAROMETER_V2_BOOTLOADER_STATUS_OK = 0
  • BRICKLET_BAROMETER_V2_BOOTLOADER_STATUS_INVALID_MODE = 1
  • BRICKLET_BAROMETER_V2_BOOTLOADER_STATUS_NO_CHANGE = 2
  • BRICKLET_BAROMETER_V2_BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT = 3
  • BRICKLET_BAROMETER_V2_BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT = 4
  • BRICKLET_BAROMETER_V2_BOOTLOADER_STATUS_CRC_MISMATCH = 5
function TBrickletBarometerV2.GetBootloaderMode: byte
Rückgabe:
  • mode – Typ: byte, Wertebereich: Siehe Konstanten

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

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

Für mode:

  • BRICKLET_BAROMETER_V2_BOOTLOADER_MODE_BOOTLOADER = 0
  • BRICKLET_BAROMETER_V2_BOOTLOADER_MODE_FIRMWARE = 1
  • BRICKLET_BAROMETER_V2_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
  • BRICKLET_BAROMETER_V2_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
  • BRICKLET_BAROMETER_V2_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4
procedure TBrickletBarometerV2.SetWriteFirmwarePointer(const pointer: longword)
Parameter:
  • pointer – Typ: longword, Wertebereich: [0 bis 232 - 1]

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 TBrickletBarometerV2.WriteFirmware(const data: array [0..63] of byte): byte
Parameter:
  • data – Typ: array [0..63] of byte, Wertebereich: [0 bis 255]
Rückgabe:
  • status – Typ: byte, Wertebereich: [0 bis 255]

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 TBrickletBarometerV2.SetStatusLEDConfig(const config: byte)
Parameter:
  • config – Typ: byte, Wertebereich: Siehe Konstanten

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:

Für config:

  • BRICKLET_BAROMETER_V2_STATUS_LED_CONFIG_OFF = 0
  • BRICKLET_BAROMETER_V2_STATUS_LED_CONFIG_ON = 1
  • BRICKLET_BAROMETER_V2_STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • BRICKLET_BAROMETER_V2_STATUS_LED_CONFIG_SHOW_STATUS = 3
function TBrickletBarometerV2.GetStatusLEDConfig: byte
Rückgabe:
  • config – Typ: byte, Wertebereich: Siehe Konstanten

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

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

Für config:

  • BRICKLET_BAROMETER_V2_STATUS_LED_CONFIG_OFF = 0
  • BRICKLET_BAROMETER_V2_STATUS_LED_CONFIG_ON = 1
  • BRICKLET_BAROMETER_V2_STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • BRICKLET_BAROMETER_V2_STATUS_LED_CONFIG_SHOW_STATUS = 3
function TBrickletBarometerV2.GetChipTemperature: smallint
Rückgabe:
  • temperature – Typ: smallint, Wertebereich: [-215 bis 215 - 1]

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 TBrickletBarometerV2.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 TBrickletBarometerV2.WriteUID(const uid: longword)
Parameter:
  • uid – Typ: longword, Wertebereich: [0 bis 232 - 1]

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 TBrickletBarometerV2.ReadUID: longword
Rückgabe:
  • uid – Typ: longword, Wertebereich: [0 bis 232 - 1]

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

procedure TBrickletBarometerV2.GetIdentity(out uid: string; out connectedUid: string; out position: char; out hardwareVersion: array [0..2] of byte; out firmwareVersion: array [0..2] of byte; out deviceIdentifier: word)
Ausgabeparameter:
  • uid – Typ: string, Länge: bis zu 8
  • connectedUid – Typ: string, Länge: bis zu 8
  • position – Typ: char
  • hardwareVersion – Typ: array [0..2] of byte, Wertebereich: [0 bis 255]
  • firmwareVersion – Typ: array [0..2] of byte, Wertebereich: [0 bis 255]
  • deviceIdentifier – Typ: word, Wertebereich: [0 bis 216 - 1]

Gibt die UID, die UID zu der das Bricklet verbunden ist, die Position, die Hard- und Firmware Version sowie den Device Identifier zurück.

Die Position 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 TBrickletBarometerV2.SetAirPressureCallbackConfiguration(const period: longword; const valueHasToChange: boolean; const option: char; const min: longint; const max: longint)
Parameter:
  • period – Typ: longword, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0
  • valueHasToChange – Typ: boolean, Standardwert: false
  • option – Typ: char, Wertebereich: Siehe Konstanten, Standardwert: 'x'
  • min – Typ: longint, Wertebereich: [-231 bis 231 - 1]
  • max – Typ: longint, Wertebereich: [-231 bis 231 - 1]

Die Periode 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:

Für option:

  • BRICKLET_BAROMETER_V2_THRESHOLD_OPTION_OFF = 'x'
  • BRICKLET_BAROMETER_V2_THRESHOLD_OPTION_OUTSIDE = 'o'
  • BRICKLET_BAROMETER_V2_THRESHOLD_OPTION_INSIDE = 'i'
  • BRICKLET_BAROMETER_V2_THRESHOLD_OPTION_SMALLER = '<'
  • BRICKLET_BAROMETER_V2_THRESHOLD_OPTION_GREATER = '>'
procedure TBrickletBarometerV2.GetAirPressureCallbackConfiguration(out period: longword; out valueHasToChange: boolean; out option: char; out min: longint; out max: longint)
Ausgabeparameter:
  • period – Typ: longword, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0
  • valueHasToChange – Typ: boolean, Standardwert: false
  • option – Typ: char, Wertebereich: Siehe Konstanten, Standardwert: 'x'
  • min – Typ: longint, Wertebereich: [-231 bis 231 - 1]
  • max – Typ: longint, Wertebereich: [-231 bis 231 - 1]

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

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

Für option:

  • BRICKLET_BAROMETER_V2_THRESHOLD_OPTION_OFF = 'x'
  • BRICKLET_BAROMETER_V2_THRESHOLD_OPTION_OUTSIDE = 'o'
  • BRICKLET_BAROMETER_V2_THRESHOLD_OPTION_INSIDE = 'i'
  • BRICKLET_BAROMETER_V2_THRESHOLD_OPTION_SMALLER = '<'
  • BRICKLET_BAROMETER_V2_THRESHOLD_OPTION_GREATER = '>'
procedure TBrickletBarometerV2.SetAltitudeCallbackConfiguration(const period: longword; const valueHasToChange: boolean; const option: char; const min: longint; const max: longint)
Parameter:
  • period – Typ: longword, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0
  • valueHasToChange – Typ: boolean, Standardwert: false
  • option – Typ: char, Wertebereich: Siehe Konstanten, Standardwert: 'x'
  • min – Typ: longint, Wertebereich: [-231 bis 231 - 1]
  • max – Typ: longint, Wertebereich: [-231 bis 231 - 1]

Die Periode ist die Periode mit der der OnAltitude 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 OnAltitude 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:

Für option:

  • BRICKLET_BAROMETER_V2_THRESHOLD_OPTION_OFF = 'x'
  • BRICKLET_BAROMETER_V2_THRESHOLD_OPTION_OUTSIDE = 'o'
  • BRICKLET_BAROMETER_V2_THRESHOLD_OPTION_INSIDE = 'i'
  • BRICKLET_BAROMETER_V2_THRESHOLD_OPTION_SMALLER = '<'
  • BRICKLET_BAROMETER_V2_THRESHOLD_OPTION_GREATER = '>'
procedure TBrickletBarometerV2.GetAltitudeCallbackConfiguration(out period: longword; out valueHasToChange: boolean; out option: char; out min: longint; out max: longint)
Ausgabeparameter:
  • period – Typ: longword, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0
  • valueHasToChange – Typ: boolean, Standardwert: false
  • option – Typ: char, Wertebereich: Siehe Konstanten, Standardwert: 'x'
  • min – Typ: longint, Wertebereich: [-231 bis 231 - 1]
  • max – Typ: longint, Wertebereich: [-231 bis 231 - 1]

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

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

Für option:

  • BRICKLET_BAROMETER_V2_THRESHOLD_OPTION_OFF = 'x'
  • BRICKLET_BAROMETER_V2_THRESHOLD_OPTION_OUTSIDE = 'o'
  • BRICKLET_BAROMETER_V2_THRESHOLD_OPTION_INSIDE = 'i'
  • BRICKLET_BAROMETER_V2_THRESHOLD_OPTION_SMALLER = '<'
  • BRICKLET_BAROMETER_V2_THRESHOLD_OPTION_GREATER = '>'
procedure TBrickletBarometerV2.SetTemperatureCallbackConfiguration(const period: longword; const valueHasToChange: boolean; const option: char; const min: longint; const max: longint)
Parameter:
  • period – Typ: longword, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0
  • valueHasToChange – Typ: boolean, Standardwert: false
  • option – Typ: char, Wertebereich: Siehe Konstanten, Standardwert: 'x'
  • min – Typ: longint, Wertebereich: [-231 bis 231 - 1]
  • max – Typ: longint, Wertebereich: [-231 bis 231 - 1]

Die Periode 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:

Für option:

  • BRICKLET_BAROMETER_V2_THRESHOLD_OPTION_OFF = 'x'
  • BRICKLET_BAROMETER_V2_THRESHOLD_OPTION_OUTSIDE = 'o'
  • BRICKLET_BAROMETER_V2_THRESHOLD_OPTION_INSIDE = 'i'
  • BRICKLET_BAROMETER_V2_THRESHOLD_OPTION_SMALLER = '<'
  • BRICKLET_BAROMETER_V2_THRESHOLD_OPTION_GREATER = '>'
procedure TBrickletBarometerV2.GetTemperatureCallbackConfiguration(out period: longword; out valueHasToChange: boolean; out option: char; out min: longint; out max: longint)
Ausgabeparameter:
  • period – Typ: longword, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0
  • valueHasToChange – Typ: boolean, Standardwert: false
  • option – Typ: char, Wertebereich: Siehe Konstanten, Standardwert: 'x'
  • min – Typ: longint, Wertebereich: [-231 bis 231 - 1]
  • max – Typ: longint, Wertebereich: [-231 bis 231 - 1]

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

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

Für option:

  • BRICKLET_BAROMETER_V2_THRESHOLD_OPTION_OFF = 'x'
  • BRICKLET_BAROMETER_V2_THRESHOLD_OPTION_OUTSIDE = 'o'
  • BRICKLET_BAROMETER_V2_THRESHOLD_OPTION_INSIDE = 'i'
  • BRICKLET_BAROMETER_V2_THRESHOLD_OPTION_SMALLER = '<'
  • BRICKLET_BAROMETER_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: TBrickletBarometerV2; const param: word);
begin
  WriteLn(param);
end;

barometerV2.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 TBrickletBarometerV2.OnAirPressure
procedure(sender: TBrickletBarometerV2; const airPressure: longint) of object;
Callback-Parameter:
  • sender – Typ: TBrickletBarometerV2
  • airPressure – Typ: longint, Wertebereich: [-231 bis 231 - 1]

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

Der Parameter ist der gleiche wie GetAirPressure.

property TBrickletBarometerV2.OnAltitude
procedure(sender: TBrickletBarometerV2; const altitude: longint) of object;
Callback-Parameter:
  • sender – Typ: TBrickletBarometerV2
  • altitude – Typ: longint, Wertebereich: [-231 bis 231 - 1]

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

Der Parameter ist der gleiche wie GetAltitude.

property TBrickletBarometerV2.OnTemperature
procedure(sender: TBrickletBarometerV2; const temperature: longint) of object;
Callback-Parameter:
  • sender – Typ: TBrickletBarometerV2
  • temperature – Typ: longint, Wertebereich: [-231 bis 231 - 1]

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

Der Parameter ist der gleiche wie GetTemperature.

Konstanten

const BRICKLET_BAROMETER_V2_DEVICE_IDENTIFIER

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

Diese Konstante stellt den Anzeigenamen eines Barometer Bricklet 2.0 dar.