Delphi/Lazarus - Humidity Bricklet 2.0

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

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

uses
  SysUtils, IPConnection, BrickletHumidityV2;

type
  TExample = class
  private
    ipcon: TIPConnection;
    h: TBrickletHumidityV2;
  public
    procedure Execute;
  end;

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

var
  e: TExample;

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

  { Create device object }
  h := TBrickletHumidityV2.Create(UID, ipcon);

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

  { Get current humidity }
  humidity := h.GetHumidity;
  WriteLn(Format('Humidity: %f %%RH', [humidity/100.0]));

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

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

Callback

Download (ExampleCallback.pas)

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

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

uses
  SysUtils, IPConnection, BrickletHumidityV2;

type
  TExample = class
  private
    ipcon: TIPConnection;
    h: TBrickletHumidityV2;
  public
    procedure HumidityCB(sender: TBrickletHumidityV2; const humidity: word);
    procedure Execute;
  end;

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

var
  e: TExample;

{ Callback procedure for humidity callback }
procedure TExample.HumidityCB(sender: TBrickletHumidityV2; const humidity: word);
begin
  WriteLn(Format('Humidity: %f %%RH', [humidity/100.0]));
end;

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

  { Create device object }
  h := TBrickletHumidityV2.Create(UID, ipcon);

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

  { Register humidity callback to procedure HumidityCB }
  h.OnHumidity := {$ifdef FPC}@{$endif}HumidityCB;

  { Set period for humidity callback to 1s (1000ms) without a threshold }
  h.SetHumidityCallbackConfiguration(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
program ExampleThreshold;

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

uses
  SysUtils, IPConnection, BrickletHumidityV2;

type
  TExample = class
  private
    ipcon: TIPConnection;
    h: TBrickletHumidityV2;
  public
    procedure HumidityCB(sender: TBrickletHumidityV2; const humidity: word);
    procedure Execute;
  end;

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

var
  e: TExample;

{ Callback procedure for humidity callback }
procedure TExample.HumidityCB(sender: TBrickletHumidityV2; const humidity: word);
begin
  WriteLn(Format('Humidity: %f %%RH', [humidity/100.0]));
  WriteLn('Recommended humidity for human comfort is 30 to 60 %RH.');
end;

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

  { Create device object }
  h := TBrickletHumidityV2.Create(UID, ipcon);

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

  { Register humidity callback to procedure HumidityCB }
  h.OnHumidity := {$ifdef FPC}@{$endif}HumidityCB;

  { Configure threshold for humidity "outside of 30 to 60 %RH"
    with a debounce period of 10s (10000ms) }
  h.SetHumidityCallbackConfiguration(10000, false, 'o', 30*100, 60*100);

  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 TBrickletHumidityV2.Create(const uid: string; ipcon: TIPConnection)
Parameter:
  • uid – Typ: string
  • ipcon – Typ: TIPConnection
Rückgabe:
  • humidityV2 – Typ: TBrickletHumidityV2

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

humidityV2 := TBrickletHumidityV2.Create('YOUR_DEVICE_UID', ipcon);

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

function TBrickletHumidityV2.GetHumidity: word
Rückgabe:
  • humidity – Typ: word, Einheit: 1/100 %, Wertebereich: [0 bis 10000]

Gibt die gemessene Luftfeuchtigkeit des Sensors 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 TBrickletHumidityV2.GetTemperature: smallint
Rückgabe:
  • temperature – Typ: smallint, Einheit: 1/100 °C, Wertebereich: [-4000 bis 16500]

Gibt die gemessene Temperatur des Sensors zurück.

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

procedure TBrickletHumidityV2.SetHeaterConfiguration(const heaterConfig: byte)
Parameter:
  • heaterConfig – Typ: byte, Wertebereich: Siehe Konstanten, Standardwert: False

Aktiviert/deaktiviert das Heizelement. Das Heizelement kann genutzt werden um den Sensor bei extremer Feuchtigkeit zu trocknen.

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

Für heaterConfig:

  • BRICKLET_HUMIDITY_V2_HEATER_CONFIG_DISABLED = 0
  • BRICKLET_HUMIDITY_V2_HEATER_CONFIG_ENABLED = 1
function TBrickletHumidityV2.GetHeaterConfiguration: byte
Rückgabe:
  • heaterConfig – Typ: byte, Wertebereich: Siehe Konstanten, Standardwert: False

Gibt die Heizelement-Konfiguration zurück, wie von SetHeaterConfiguration gesetzt.

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

Für heaterConfig:

  • BRICKLET_HUMIDITY_V2_HEATER_CONFIG_DISABLED = 0
  • BRICKLET_HUMIDITY_V2_HEATER_CONFIG_ENABLED = 1
procedure TBrickletHumidityV2.SetMovingAverageConfiguration(const movingAverageLengthHumidity: word; const movingAverageLengthTemperature: word)
Parameter:
  • movingAverageLengthHumidity – Typ: word, Wertebereich: [1 bis 1000], Standardwert: 5
  • movingAverageLengthTemperature – Typ: word, Wertebereich: [1 bis 1000], Standardwert: 5

Setzt die Länge eines gleitenden Mittelwerts für die Luftfeuchtigkeit und Temperatur.

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.

Einer neue Wert wird alle 50ms* gemessen. Mit einer Mittelwerts-Länge von 1000 hat das resultierende gleitende Fenster eine Zeitspanne von 50s. Bei Langzeitmessungen gibt ein langer Mittelwert die saubersten Resultate.

* In Firmware Version 2.0.3 haben wir die Funktion SetSamplesPerSecond hinzugefügt. Diese konfiguriert die Messfrequenz. Da eine hohe Messfrequenz zu Selbsterhitzung führen kann haben wir die Standardeinstellung von 20 SPS auf 1 SPS geändert. Mit einer Messung pro Sekunde entspricht eine Mittelwert-Länge von 1000 einem Zeitfenster von 1000 Sekunden!

procedure TBrickletHumidityV2.GetMovingAverageConfiguration(out movingAverageLengthHumidity: word; out movingAverageLengthTemperature: word)
Ausgabeparameter:
  • movingAverageLengthHumidity – Typ: word, Wertebereich: [1 bis 1000], Standardwert: 5
  • movingAverageLengthTemperature – Typ: word, Wertebereich: [1 bis 1000], Standardwert: 5

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

procedure TBrickletHumidityV2.SetSamplesPerSecond(const sps: byte)
Parameter:
  • sps – Typ: byte, Wertebereich: Siehe Konstanten, Standardwert: 3

Setzt die Messungen pro Sekunde mit denen neue Luftfeuchte/Temperatur-Werte vom HDC1080 Sensor gelesen werden.

Wir haben diese Funktion hinzugefügt, da eine hohe Messfrequenz zu einer Selbsterhitzung des Sensors führen kann. Diese kann die Temperaturmessung verfälschen.

Wenn wenig Messwerte benötigt werden kann die Frequenz auf bis zu 0,1 Messungen pro Sekunde verringert werden um einen Fehler durch Selbsterhitzung möglichst weit zu minimieren.

Vor Version 2.0.3 wurden 20 Messungen pro Sekunde gemacht. Der neue Standardwert seit 2.0.3 ist 1 Messung pro Sekunde.

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

Für sps:

  • BRICKLET_HUMIDITY_V2_SPS_20 = 0
  • BRICKLET_HUMIDITY_V2_SPS_10 = 1
  • BRICKLET_HUMIDITY_V2_SPS_5 = 2
  • BRICKLET_HUMIDITY_V2_SPS_1 = 3
  • BRICKLET_HUMIDITY_V2_SPS_02 = 4
  • BRICKLET_HUMIDITY_V2_SPS_01 = 5

Neu in Version 2.0.3 (Plugin).

function TBrickletHumidityV2.GetSamplesPerSecond: byte
Rückgabe:
  • sps – Typ: byte, Wertebereich: Siehe Konstanten, Standardwert: 3

Gibt die Messwerte pro Sekunde zurück, wie von SetSamplesPerSecond gesetzt.

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

Für sps:

  • BRICKLET_HUMIDITY_V2_SPS_20 = 0
  • BRICKLET_HUMIDITY_V2_SPS_10 = 1
  • BRICKLET_HUMIDITY_V2_SPS_5 = 2
  • BRICKLET_HUMIDITY_V2_SPS_1 = 3
  • BRICKLET_HUMIDITY_V2_SPS_02 = 4
  • BRICKLET_HUMIDITY_V2_SPS_01 = 5

Neu in Version 2.0.3 (Plugin).

Fortgeschrittene Funktionen

procedure TBrickletHumidityV2.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 TBrickletHumidityV2.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 Bootloader- 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_HUMIDITY_V2_BOOTLOADER_MODE_BOOTLOADER = 0
  • BRICKLET_HUMIDITY_V2_BOOTLOADER_MODE_FIRMWARE = 1
  • BRICKLET_HUMIDITY_V2_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
  • BRICKLET_HUMIDITY_V2_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
  • BRICKLET_HUMIDITY_V2_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4

Für status:

  • BRICKLET_HUMIDITY_V2_BOOTLOADER_STATUS_OK = 0
  • BRICKLET_HUMIDITY_V2_BOOTLOADER_STATUS_INVALID_MODE = 1
  • BRICKLET_HUMIDITY_V2_BOOTLOADER_STATUS_NO_CHANGE = 2
  • BRICKLET_HUMIDITY_V2_BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT = 3
  • BRICKLET_HUMIDITY_V2_BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT = 4
  • BRICKLET_HUMIDITY_V2_BOOTLOADER_STATUS_CRC_MISMATCH = 5
function TBrickletHumidityV2.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_HUMIDITY_V2_BOOTLOADER_MODE_BOOTLOADER = 0
  • BRICKLET_HUMIDITY_V2_BOOTLOADER_MODE_FIRMWARE = 1
  • BRICKLET_HUMIDITY_V2_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
  • BRICKLET_HUMIDITY_V2_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
  • BRICKLET_HUMIDITY_V2_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4
procedure TBrickletHumidityV2.SetWriteFirmwarePointer(const pointer: longword)
Parameter:
  • pointer – Typ: longword, Einheit: 1 B, 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 TBrickletHumidityV2.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 TBrickletHumidityV2.SetStatusLEDConfig(const config: byte)
Parameter:
  • config – Typ: byte, Wertebereich: Siehe Konstanten, Standardwert: 3

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_HUMIDITY_V2_STATUS_LED_CONFIG_OFF = 0
  • BRICKLET_HUMIDITY_V2_STATUS_LED_CONFIG_ON = 1
  • BRICKLET_HUMIDITY_V2_STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • BRICKLET_HUMIDITY_V2_STATUS_LED_CONFIG_SHOW_STATUS = 3
function TBrickletHumidityV2.GetStatusLEDConfig: byte
Rückgabe:
  • config – Typ: byte, Wertebereich: Siehe Konstanten, Standardwert: 3

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

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

Für config:

  • BRICKLET_HUMIDITY_V2_STATUS_LED_CONFIG_OFF = 0
  • BRICKLET_HUMIDITY_V2_STATUS_LED_CONFIG_ON = 1
  • BRICKLET_HUMIDITY_V2_STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • BRICKLET_HUMIDITY_V2_STATUS_LED_CONFIG_SHOW_STATUS = 3
function TBrickletHumidityV2.GetChipTemperature: smallint
Rückgabe:
  • temperature – Typ: smallint, Einheit: 1 °C, Wertebereich: [-215 bis 215 - 1]

Gibt die Temperatur, 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 TBrickletHumidityV2.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 TBrickletHumidityV2.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 TBrickletHumidityV2.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 TBrickletHumidityV2.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, Wertebereich: ['a' bis 'h', 'i', 'z']
  • hardwareVersion – Typ: array [0..2] of byte
    • 0: major – Typ: byte, Wertebereich: [0 bis 255]
    • 1: minor – Typ: byte, Wertebereich: [0 bis 255]
    • 2: revision – Typ: byte, Wertebereich: [0 bis 255]
  • firmwareVersion – Typ: array [0..2] of byte
    • 0: major – Typ: byte, Wertebereich: [0 bis 255]
    • 1: minor – Typ: byte, Wertebereich: [0 bis 255]
    • 2: revision – Typ: 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 'a', 'b', 'c', 'd', 'e', 'f', 'g' oder 'h' (Bricklet Anschluss) sein. Der Raspberry Pi HAT (Zero) Brick ist immer an Position 'i' und das Bricklet hinter einem Isolator Bricklet ist immer an Position 'z'.

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 TBrickletHumidityV2.SetHumidityCallbackConfiguration(const period: longword; const valueHasToChange: boolean; const option: char; const min: word; const max: word)
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: word, Einheit: 1/100 %, Wertebereich: [0 bis 216 - 1], Standardwert: 0
  • max – Typ: word, Einheit: 1/100 %, Wertebereich: [0 bis 216 - 1], Standardwert: 0

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

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

Für option:

  • BRICKLET_HUMIDITY_V2_THRESHOLD_OPTION_OFF = 'x'
  • BRICKLET_HUMIDITY_V2_THRESHOLD_OPTION_OUTSIDE = 'o'
  • BRICKLET_HUMIDITY_V2_THRESHOLD_OPTION_INSIDE = 'i'
  • BRICKLET_HUMIDITY_V2_THRESHOLD_OPTION_SMALLER = '<'
  • BRICKLET_HUMIDITY_V2_THRESHOLD_OPTION_GREATER = '>'
procedure TBrickletHumidityV2.GetHumidityCallbackConfiguration(out period: longword; out valueHasToChange: boolean; out option: char; out min: word; out max: word)
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: word, Einheit: 1/100 %, Wertebereich: [0 bis 216 - 1], Standardwert: 0
  • max – Typ: word, Einheit: 1/100 %, Wertebereich: [0 bis 216 - 1], Standardwert: 0

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

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

Für option:

  • BRICKLET_HUMIDITY_V2_THRESHOLD_OPTION_OFF = 'x'
  • BRICKLET_HUMIDITY_V2_THRESHOLD_OPTION_OUTSIDE = 'o'
  • BRICKLET_HUMIDITY_V2_THRESHOLD_OPTION_INSIDE = 'i'
  • BRICKLET_HUMIDITY_V2_THRESHOLD_OPTION_SMALLER = '<'
  • BRICKLET_HUMIDITY_V2_THRESHOLD_OPTION_GREATER = '>'
procedure TBrickletHumidityV2.SetTemperatureCallbackConfiguration(const period: longword; const valueHasToChange: boolean; const option: char; const min: smallint; const max: smallint)
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: smallint, Einheit: 1/100 °C, Wertebereich: [-215 bis 215 - 1], Standardwert: 0
  • max – Typ: smallint, Einheit: 1/100 °C, Wertebereich: [-215 bis 215 - 1], Standardwert: 0

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.

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

Für option:

  • BRICKLET_HUMIDITY_V2_THRESHOLD_OPTION_OFF = 'x'
  • BRICKLET_HUMIDITY_V2_THRESHOLD_OPTION_OUTSIDE = 'o'
  • BRICKLET_HUMIDITY_V2_THRESHOLD_OPTION_INSIDE = 'i'
  • BRICKLET_HUMIDITY_V2_THRESHOLD_OPTION_SMALLER = '<'
  • BRICKLET_HUMIDITY_V2_THRESHOLD_OPTION_GREATER = '>'
procedure TBrickletHumidityV2.GetTemperatureCallbackConfiguration(out period: longword; out valueHasToChange: boolean; out option: char; out min: smallint; out max: smallint)
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: smallint, Einheit: 1/100 °C, Wertebereich: [-215 bis 215 - 1], Standardwert: 0
  • max – Typ: smallint, Einheit: 1/100 °C, Wertebereich: [-215 bis 215 - 1], Standardwert: 0

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

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

Für option:

  • BRICKLET_HUMIDITY_V2_THRESHOLD_OPTION_OFF = 'x'
  • BRICKLET_HUMIDITY_V2_THRESHOLD_OPTION_OUTSIDE = 'o'
  • BRICKLET_HUMIDITY_V2_THRESHOLD_OPTION_INSIDE = 'i'
  • BRICKLET_HUMIDITY_V2_THRESHOLD_OPTION_SMALLER = '<'
  • BRICKLET_HUMIDITY_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: TBrickletHumidityV2; const value: longint);
begin
  WriteLn(Format('Value: %d', [value]));
end;

humidityV2.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 TBrickletHumidityV2.OnHumidity
procedure(sender: TBrickletHumidityV2; const humidity: word) of object;
Callback-Parameter:
  • sender – Typ: TBrickletHumidityV2
  • humidity – Typ: word, Einheit: 1/100 %, Wertebereich: [0 bis 10000]

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

Der Parameter ist der gleiche wie GetHumidity.

property TBrickletHumidityV2.OnTemperature
procedure(sender: TBrickletHumidityV2; const temperature: smallint) of object;
Callback-Parameter:
  • sender – Typ: TBrickletHumidityV2
  • temperature – Typ: smallint, Einheit: 1/100 °C, Wertebereich: [-4000 bis 16500]

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

Der Parameter ist der gleiche wie GetTemperature.

Virtuelle Funktionen

Virtuelle Funktionen kommunizieren nicht mit dem Gerät selbst, sie arbeiten nur auf dem API Bindings Objekt. Dadurch können sie auch aufgerufen werden, ohne das das dazugehörige IP Connection Objekt verbunden ist.

function TBrickletHumidityV2.GetAPIVersion: array [0..2] of byte
Ausgabeparameter:
  • apiVersion – Typ: array [0..2] of byte
    • 0: major – Typ: byte, Wertebereich: [0 bis 255]
    • 1: minor – Typ: byte, Wertebereich: [0 bis 255]
    • 2: revision – Typ: byte, Wertebereich: [0 bis 255]

Gibt die Version der API Definition 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 TBrickletHumidityV2.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_HUMIDITY_V2_FUNCTION_SET_HUMIDITY_CALLBACK_CONFIGURATION = 2
  • BRICKLET_HUMIDITY_V2_FUNCTION_SET_TEMPERATURE_CALLBACK_CONFIGURATION = 6
  • BRICKLET_HUMIDITY_V2_FUNCTION_SET_HEATER_CONFIGURATION = 9
  • BRICKLET_HUMIDITY_V2_FUNCTION_SET_MOVING_AVERAGE_CONFIGURATION = 11
  • BRICKLET_HUMIDITY_V2_FUNCTION_SET_SAMPLES_PER_SECOND = 13
  • BRICKLET_HUMIDITY_V2_FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
  • BRICKLET_HUMIDITY_V2_FUNCTION_SET_STATUS_LED_CONFIG = 239
  • BRICKLET_HUMIDITY_V2_FUNCTION_RESET = 243
  • BRICKLET_HUMIDITY_V2_FUNCTION_WRITE_UID = 248
procedure TBrickletHumidityV2.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_HUMIDITY_V2_FUNCTION_SET_HUMIDITY_CALLBACK_CONFIGURATION = 2
  • BRICKLET_HUMIDITY_V2_FUNCTION_SET_TEMPERATURE_CALLBACK_CONFIGURATION = 6
  • BRICKLET_HUMIDITY_V2_FUNCTION_SET_HEATER_CONFIGURATION = 9
  • BRICKLET_HUMIDITY_V2_FUNCTION_SET_MOVING_AVERAGE_CONFIGURATION = 11
  • BRICKLET_HUMIDITY_V2_FUNCTION_SET_SAMPLES_PER_SECOND = 13
  • BRICKLET_HUMIDITY_V2_FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
  • BRICKLET_HUMIDITY_V2_FUNCTION_SET_STATUS_LED_CONFIG = 239
  • BRICKLET_HUMIDITY_V2_FUNCTION_RESET = 243
  • BRICKLET_HUMIDITY_V2_FUNCTION_WRITE_UID = 248
procedure TBrickletHumidityV2.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.

Konstanten

const BRICKLET_HUMIDITY_V2_DEVICE_IDENTIFIER

Diese Konstante wird verwendet um ein Humidity 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_HUMIDITY_V2_DEVICE_DISPLAY_NAME

Diese Konstante stellt den Anzeigenamen eines Humidity Bricklet 2.0 dar.