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.
Der folgende Beispielcode ist Public Domain (CC0 1.0).
1program ExampleSimple;
2
3{$ifdef MSWINDOWS}{$apptype CONSOLE}{$endif}
4{$ifdef FPC}{$mode OBJFPC}{$H+}{$endif}
5
6uses
7 SysUtils, IPConnection, BrickletThermocouple;
8
9type
10 TExample = class
11 private
12 ipcon: TIPConnection;
13 t: TBrickletThermocouple;
14 public
15 procedure Execute;
16 end;
17
18const
19 HOST = 'localhost';
20 PORT = 4223;
21 UID = 'XYZ'; { Change XYZ to the UID of your Thermocouple Bricklet }
22
23var
24 e: TExample;
25
26procedure TExample.Execute;
27var temperature: longint;
28begin
29 { Create IP connection }
30 ipcon := TIPConnection.Create;
31
32 { Create device object }
33 t := TBrickletThermocouple.Create(UID, ipcon);
34
35 { Connect to brickd }
36 ipcon.Connect(HOST, PORT);
37 { Don't use device before ipcon is connected }
38
39 { Get current temperature }
40 temperature := t.GetTemperature;
41 WriteLn(Format('Temperature: %f °C', [temperature/100.0]));
42
43 WriteLn('Press key to exit');
44 ReadLn;
45 ipcon.Destroy; { Calls ipcon.Disconnect internally }
46end;
47
48begin
49 e := TExample.Create;
50 e.Execute;
51 e.Destroy;
52end.
Download (ExampleCallback.pas)
1program ExampleCallback;
2
3{$ifdef MSWINDOWS}{$apptype CONSOLE}{$endif}
4{$ifdef FPC}{$mode OBJFPC}{$H+}{$endif}
5
6uses
7 SysUtils, IPConnection, BrickletThermocouple;
8
9type
10 TExample = class
11 private
12 ipcon: TIPConnection;
13 t: TBrickletThermocouple;
14 public
15 procedure TemperatureCB(sender: TBrickletThermocouple; const temperature: longint);
16 procedure Execute;
17 end;
18
19const
20 HOST = 'localhost';
21 PORT = 4223;
22 UID = 'XYZ'; { Change XYZ to the UID of your Thermocouple Bricklet }
23
24var
25 e: TExample;
26
27{ Callback procedure for temperature callback }
28procedure TExample.TemperatureCB(sender: TBrickletThermocouple;
29 const temperature: longint);
30begin
31 WriteLn(Format('Temperature: %f °C', [temperature/100.0]));
32end;
33
34procedure TExample.Execute;
35begin
36 { Create IP connection }
37 ipcon := TIPConnection.Create;
38
39 { Create device object }
40 t := TBrickletThermocouple.Create(UID, ipcon);
41
42 { Connect to brickd }
43 ipcon.Connect(HOST, PORT);
44 { Don't use device before ipcon is connected }
45
46 { Register temperature callback to procedure TemperatureCB }
47 t.OnTemperature := {$ifdef FPC}@{$endif}TemperatureCB;
48
49 { Set period for temperature callback to 1s (1000ms)
50 Note: The temperature callback is only called every second
51 if the temperature has changed since the last call! }
52 t.SetTemperatureCallbackPeriod(1000);
53
54 WriteLn('Press key to exit');
55 ReadLn;
56 ipcon.Destroy; { Calls ipcon.Disconnect internally }
57end;
58
59begin
60 e := TExample.Create;
61 e.Execute;
62 e.Destroy;
63end.
Download (ExampleThreshold.pas)
1program ExampleThreshold;
2
3{$ifdef MSWINDOWS}{$apptype CONSOLE}{$endif}
4{$ifdef FPC}{$mode OBJFPC}{$H+}{$endif}
5
6uses
7 SysUtils, IPConnection, BrickletThermocouple;
8
9type
10 TExample = class
11 private
12 ipcon: TIPConnection;
13 t: TBrickletThermocouple;
14 public
15 procedure TemperatureReachedCB(sender: TBrickletThermocouple;
16 const temperature: longint);
17 procedure Execute;
18 end;
19
20const
21 HOST = 'localhost';
22 PORT = 4223;
23 UID = 'XYZ'; { Change XYZ to the UID of your Thermocouple Bricklet }
24
25var
26 e: TExample;
27
28{ Callback procedure for temperature reached callback }
29procedure TExample.TemperatureReachedCB(sender: TBrickletThermocouple;
30 const temperature: longint);
31begin
32 WriteLn(Format('Temperature: %f °C', [temperature/100.0]));
33end;
34
35procedure TExample.Execute;
36begin
37 { Create IP connection }
38 ipcon := TIPConnection.Create;
39
40 { Create device object }
41 t := TBrickletThermocouple.Create(UID, ipcon);
42
43 { Connect to brickd }
44 ipcon.Connect(HOST, PORT);
45 { Don't use device before ipcon is connected }
46
47 { Get threshold callbacks with a debounce time of 10 seconds (10000ms) }
48 t.SetDebouncePeriod(10000);
49
50 { Register temperature reached callback to procedure TemperatureReachedCB }
51 t.OnTemperatureReached := {$ifdef FPC}@{$endif}TemperatureReachedCB;
52
53 { Configure threshold for temperature "greater than 30 °C" }
54 t.SetTemperatureCallbackThreshold('>', 30*100, 0);
55
56 WriteLn('Press key to exit');
57 ReadLn;
58 ipcon.Destroy; { Calls ipcon.Disconnect internally }
59end;
60
61begin
62 e := TExample.Create;
63 e.Execute;
64 e.Destroy;
65end.
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.
| Parameter: |
|
|---|---|
| Rückgabe: |
|
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.
| Rückgabe: |
|
|---|
Gibt die Temperatur des Thermoelements zurück.
Wenn die Temperatur periodisch abgefragt werden soll, wird empfohlen
den OnTemperature Callback zu nutzen und die Periode mit
SetTemperatureCallbackPeriod vorzugeben.
| Parameter: |
|
|---|
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 folgenden Konstanten sind für diese Funktion verfügbar:
Für averaging:
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
Für thermocoupleType:
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
Für filter:
BRICKLET_THERMOCOUPLE_FILTER_OPTION_50HZ = 0
BRICKLET_THERMOCOUPLE_FILTER_OPTION_60HZ = 1
| Ausgabeparameter: |
|
|---|
Gibt die Konfiguration zurück, wie von SetConfiguration gesetzt.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für averaging:
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
Für thermocoupleType:
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
Für filter:
BRICKLET_THERMOCOUPLE_FILTER_OPTION_50HZ = 0
BRICKLET_THERMOCOUPLE_FILTER_OPTION_60HZ = 1
| Ausgabeparameter: |
|
|---|
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.
| Ausgabeparameter: |
|
|---|
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 ist 'a', 'b', 'c', 'd', 'e', 'f', 'g' oder 'h' (Bricklet Anschluss). Ein 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.
| Parameter: |
|
|---|
Setzt die Periode 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.
| Rückgabe: |
|
|---|
Gibt die Periode zurück, wie von SetTemperatureCallbackPeriod gesetzt.
| Parameter: |
|
|---|
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) |
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für option:
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 = '>'
| Ausgabeparameter: |
|
|---|
Gibt den Schwellwert zurück, wie von SetTemperatureCallbackThreshold gesetzt.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für option:
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 = '>'
| Parameter: |
|
|---|
Setzt die Periode mit welcher die Schwellwert Callback
ausgelöst wird, wenn der Schwellwert
weiterhin erreicht bleibt.
| Rückgabe: |
|
|---|
Gibt die Entprellperiode zurück, wie von SetDebouncePeriod gesetzt.
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 value: longint); begin WriteLn(Format('Value: %d', [value])); 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.
procedure(sender: TBrickletThermocouple; const temperature: longint) of object;
| Callback-Parameter: |
|
|---|
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.
procedure(sender: TBrickletThermocouple; const temperature: longint) of object;
| Callback-Parameter: |
|
|---|
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.
procedure(sender: TBrickletThermocouple; const overUnder: boolean; const openCircuit: boolean) of object;
| Callback-Parameter: |
|
|---|
Dieser Callback wird ausgelöst, wenn der Error-Status sich verändert
(siehe GetErrorState).
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.
| Ausgabeparameter: |
|
|---|
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.
| Parameter: |
|
|---|---|
| Rückgabe: |
|
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_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
| Parameter: |
|
|---|
Ä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_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
| Parameter: |
|
|---|
Ändert das Response-Expected-Flag für alle Setter-Funktionen und Konfigurationsfunktionen für Callbacks diese Gerätes.
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.
Diese Konstante stellt den Anzeigenamen eines Thermocouple Bricklet dar.