Delphi/Lazarus - Thermocouple Bricklet

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

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

uses
  SysUtils, IPConnection, BrickletThermocouple;

type
  TExample = class
  private
    ipcon: TIPConnection;
    t: TBrickletThermocouple;
  public
    procedure Execute;
  end;

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

var
  e: TExample;

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

  { Create device object }
  t := TBrickletThermocouple.Create(UID, ipcon);

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

  { Get current temperature }
  temperature := t.GetTemperature;
  WriteLn(Format('Temperature: %f °C', [temperature/100.0]));

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

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

Callback

Download (ExampleCallback.pas)

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

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

uses
  SysUtils, IPConnection, BrickletThermocouple;

type
  TExample = class
  private
    ipcon: TIPConnection;
    t: TBrickletThermocouple;
  public
    procedure TemperatureCB(sender: TBrickletThermocouple; const temperature: longint);
    procedure Execute;
  end;

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

var
  e: TExample;

{ Callback procedure for temperature callback }
procedure TExample.TemperatureCB(sender: TBrickletThermocouple;
                                 const temperature: longint);
begin
  WriteLn(Format('Temperature: %f °C', [temperature/100.0]));
end;

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

  { Create device object }
  t := TBrickletThermocouple.Create(UID, ipcon);

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

  { Register temperature callback to procedure TemperatureCB }
  t.OnTemperature := {$ifdef FPC}@{$endif}TemperatureCB;

  { Set period for temperature callback to 1s (1000ms)
    Note: The temperature callback is only called every second
          if the temperature has changed since the last call! }
  t.SetTemperatureCallbackPeriod(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
program ExampleThreshold;

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

uses
  SysUtils, IPConnection, BrickletThermocouple;

type
  TExample = class
  private
    ipcon: TIPConnection;
    t: TBrickletThermocouple;
  public
    procedure TemperatureReachedCB(sender: TBrickletThermocouple;
                                   const temperature: longint);
    procedure Execute;
  end;

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

var
  e: TExample;

{ Callback procedure for temperature reached callback }
procedure TExample.TemperatureReachedCB(sender: TBrickletThermocouple;
                                        const temperature: longint);
begin
  WriteLn(Format('Temperature: %f °C', [temperature/100.0]));
end;

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

  { Create device object }
  t := TBrickletThermocouple.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) }
  t.SetDebouncePeriod(10000);

  { Register temperature reached callback to procedure TemperatureReachedCB }
  t.OnTemperatureReached := {$ifdef FPC}@{$endif}TemperatureReachedCB;

  { Configure threshold for temperature "greater than 30 °C" }
  t.SetTemperatureCallbackThreshold('>', 30*100, 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 TBrickletThermocouple.Create(const uid: string; ipcon: TIPConnection)

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

thermocouple := TBrickletThermocouple.Create('YOUR_DEVICE_UID', ipcon);

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

function TBrickletThermocouple.GetTemperature: longint

Gibt die Temperatur des Thermoelements zurück. Der Wert wird in °C/100 angegeben, z.B. bedeutet ein Wert von 4223 eine gemessene Temperatur von 42,23 °C.

Wenn die Temperatur periodisch abgefragt werden soll, wird empfohlen den OnTemperature Callback zu nutzen und die Periode mit SetTemperatureCallbackPeriod vorzugeben.

Fortgeschrittene Funktionen

procedure TBrickletThermocouple.SetConfiguration(const averaging: byte; const thermocoupleType: byte; const filter: byte)

Konfiguriert werden können Averaging-Größe, Thermoelement-Typ und Frequenz-Filterung.

Mögliche Averaging-Größen sind 1, 2, 4, 8 und 16 Samples.

Als Thermoelement-Typ stehen B, E, J, K, N, R, S und T zur Verfügung. Falls ein anderes Thermoelement benutzt werden soll, können G8 und G32 genutzt werden. Mit diesen Typen wird der Wert nicht in °C/100 zurückgegeben sondern er wird durch folgende Formeln bestimmt:

  • G8: Wert = 8 * 1.6 * 2^17 * Vin
  • G32: Wert = 32 * 1.6 * 2^17 * Vin

dabei ist Vin die Eingangsspannung des Thermoelements.

Der Frequenz-Filter kann auf 50Hz und 60Hz konfiguriert werden. Er sollte abhängig von der lokalen Netzfrequenz gewählt werden.

Die Konvertierungszeit ist abhängig von der Averaging-Größe und der Frequenz-Filter-Konfiguration. Sie kann wie folgt bestimmt werden:

  • 60Hz: Zeit = 82 + (Samples - 1) * 16.67
  • 50Hz: Zeit = 98 + (Samples - 1) * 20

Die Standardkonfiguration ist 16 Samples, Typ K und 50Hz.

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

  • BRICKLET_THERMOCOUPLE_AVERAGING_1 = 1
  • BRICKLET_THERMOCOUPLE_AVERAGING_2 = 2
  • BRICKLET_THERMOCOUPLE_AVERAGING_4 = 4
  • BRICKLET_THERMOCOUPLE_AVERAGING_8 = 8
  • BRICKLET_THERMOCOUPLE_AVERAGING_16 = 16
  • BRICKLET_THERMOCOUPLE_TYPE_B = 0
  • BRICKLET_THERMOCOUPLE_TYPE_E = 1
  • BRICKLET_THERMOCOUPLE_TYPE_J = 2
  • BRICKLET_THERMOCOUPLE_TYPE_K = 3
  • BRICKLET_THERMOCOUPLE_TYPE_N = 4
  • BRICKLET_THERMOCOUPLE_TYPE_R = 5
  • BRICKLET_THERMOCOUPLE_TYPE_S = 6
  • BRICKLET_THERMOCOUPLE_TYPE_T = 7
  • BRICKLET_THERMOCOUPLE_TYPE_G8 = 8
  • BRICKLET_THERMOCOUPLE_TYPE_G32 = 9
  • BRICKLET_THERMOCOUPLE_FILTER_OPTION_50HZ = 0
  • BRICKLET_THERMOCOUPLE_FILTER_OPTION_60HZ = 1
procedure TBrickletThermocouple.GetConfiguration(out averaging: byte; out thermocoupleType: byte; out filter: byte)

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

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

  • BRICKLET_THERMOCOUPLE_AVERAGING_1 = 1
  • BRICKLET_THERMOCOUPLE_AVERAGING_2 = 2
  • BRICKLET_THERMOCOUPLE_AVERAGING_4 = 4
  • BRICKLET_THERMOCOUPLE_AVERAGING_8 = 8
  • BRICKLET_THERMOCOUPLE_AVERAGING_16 = 16
  • BRICKLET_THERMOCOUPLE_TYPE_B = 0
  • BRICKLET_THERMOCOUPLE_TYPE_E = 1
  • BRICKLET_THERMOCOUPLE_TYPE_J = 2
  • BRICKLET_THERMOCOUPLE_TYPE_K = 3
  • BRICKLET_THERMOCOUPLE_TYPE_N = 4
  • BRICKLET_THERMOCOUPLE_TYPE_R = 5
  • BRICKLET_THERMOCOUPLE_TYPE_S = 6
  • BRICKLET_THERMOCOUPLE_TYPE_T = 7
  • BRICKLET_THERMOCOUPLE_TYPE_G8 = 8
  • BRICKLET_THERMOCOUPLE_TYPE_G32 = 9
  • BRICKLET_THERMOCOUPLE_FILTER_OPTION_50HZ = 0
  • BRICKLET_THERMOCOUPLE_FILTER_OPTION_60HZ = 1
procedure TBrickletThermocouple.GetErrorState(out overUnder: boolean; out openCircuit: boolean)

Gibt den aktuellen Error-Status zurück. Es gibt zwei mögliche Status:

  • Over/Under Voltage und
  • Open Circuit.

Over/Under Voltage bei Spannungen unter 0V oder über 3.3V ausgelöst. In diesem Fall ist mit hoher Wahrscheinlichkeit das Thermoelement defekt. Ein Open Circuit-Error deutet darauf hin, das kein Thermoelement angeschlossen ist.

Der OnErrorState Callback wird automatisch jedes mal ausgelöst, wenn sich der Error-Status ändert.

function TBrickletThermocouple.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 TBrickletThermocouple.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 TBrickletThermocouple.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_THERMOCOUPLE_FUNCTION_SET_TEMPERATURE_CALLBACK_PERIOD = 2
  • BRICKLET_THERMOCOUPLE_FUNCTION_SET_TEMPERATURE_CALLBACK_THRESHOLD = 4
  • BRICKLET_THERMOCOUPLE_FUNCTION_SET_DEBOUNCE_PERIOD = 6
  • BRICKLET_THERMOCOUPLE_FUNCTION_SET_CONFIGURATION = 10
procedure TBrickletThermocouple.SetResponseExpectedAll(const responseExpected: boolean)

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

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

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

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

Der Standardwert ist 0.

function TBrickletThermocouple.GetTemperatureCallbackPeriod: longword

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

procedure TBrickletThermocouple.SetTemperatureCallbackThreshold(const option: char; const min: longint; const max: longint)

Setzt den Schwellwert für den OnTemperatureReached Callback.

Die folgenden Optionen sind möglich:

Option Beschreibung
'x' Callback ist inaktiv
'o' Callback wird ausgelöst, wenn die Temperatur außerhalb des min und max Wertes ist
'i' Callback wird ausgelöst, wenn die Temperatur innerhalb des min und max Wertes ist
'<' Callback wird ausgelöst, wenn die Temperatur kleiner als der min Wert ist (max wird ignoriert)
'>' Callback wird ausgelöst, wenn die Temperatur 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_THERMOCOUPLE_THRESHOLD_OPTION_OFF = 'x'
  • BRICKLET_THERMOCOUPLE_THRESHOLD_OPTION_OUTSIDE = 'o'
  • BRICKLET_THERMOCOUPLE_THRESHOLD_OPTION_INSIDE = 'i'
  • BRICKLET_THERMOCOUPLE_THRESHOLD_OPTION_SMALLER = '<'
  • BRICKLET_THERMOCOUPLE_THRESHOLD_OPTION_GREATER = '>'
procedure TBrickletThermocouple.GetTemperatureCallbackThreshold(out option: char; out min: longint; out max: longint)

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

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

  • BRICKLET_THERMOCOUPLE_THRESHOLD_OPTION_OFF = 'x'
  • BRICKLET_THERMOCOUPLE_THRESHOLD_OPTION_OUTSIDE = 'o'
  • BRICKLET_THERMOCOUPLE_THRESHOLD_OPTION_INSIDE = 'i'
  • BRICKLET_THERMOCOUPLE_THRESHOLD_OPTION_SMALLER = '<'
  • BRICKLET_THERMOCOUPLE_THRESHOLD_OPTION_GREATER = '>'
procedure TBrickletThermocouple.SetDebouncePeriod(const debounce: longword)

Setzt die Periode in ms mit welcher die Schwellwert Callback

ausgelöst wird, wenn der Schwellwert

weiterhin erreicht bleibt.

Der Standardwert ist 100.

function TBrickletThermocouple.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: TBrickletThermocouple; const param: word);
begin
  WriteLn(param);
end;

thermocouple.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 TBrickletThermocouple.OnTemperature
procedure(sender: TBrickletThermocouple; const temperature: longint) of object;

Dieser Callback wird mit der Periode, wie gesetzt mit SetTemperatureCallbackPeriod, ausgelöst. Der Parameter ist die Temperatur des Thermoelements.

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

property TBrickletThermocouple.OnTemperatureReached
procedure(sender: TBrickletThermocouple; const temperature: longint) of object;

Dieser Callback wird ausgelöst, wenn der Schwellwert, wie von SetTemperatureCallbackThreshold gesetzt, erreicht wird. Der Parameter ist die Temperatur des Thermoelements.

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

property TBrickletThermocouple.OnErrorState
procedure(sender: TBrickletThermocouple; const overUnder: boolean; const openCircuit: boolean) of object;

Dieser Callback wird ausgelöst, wenn der Error-Status sich verändert (siehe GetErrorState).

Konstanten

const BRICKLET_THERMOCOUPLE_DEVICE_IDENTIFIER

Diese Konstante wird verwendet um ein Thermocouple 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_THERMOCOUPLE_DEVICE_DISPLAY_NAME

Diese Konstante stellt den Anzeigenamen eines Thermocouple Bricklet dar.