Delphi/Lazarus - PTC Bricklet

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

type
  TExample = class
  private
    ipcon: TIPConnection;
    ptc: TBrickletPTC;
  public
    procedure Execute;
  end;

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

var
  e: TExample;

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

  { Create device object }
  ptc := TBrickletPTC.Create(UID, ipcon);

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

  { Get current temperature }
  temperature := ptc.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
program ExampleCallback;

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

uses
  SysUtils, IPConnection, BrickletPTC;

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

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

var
  e: TExample;

{ Callback procedure for temperature callback }
procedure TExample.TemperatureCB(sender: TBrickletPTC; 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 }
  ptc := TBrickletPTC.Create(UID, ipcon);

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

  { Register temperature callback to procedure TemperatureCB }
  ptc.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! }
  ptc.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
program ExampleThreshold;

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

uses
  SysUtils, IPConnection, BrickletPTC;

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

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

var
  e: TExample;

{ Callback procedure for temperature reached callback }
procedure TExample.TemperatureReachedCB(sender: TBrickletPTC; 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 }
  ptc := TBrickletPTC.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) }
  ptc.SetDebouncePeriod(10000);

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

  { Configure threshold for temperature "greater than 30 °C" }
  ptc.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 TBrickletPTC.Create(const uid: string; ipcon: TIPConnection)

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

ptc := TBrickletPTC.Create('YOUR_DEVICE_UID', ipcon);

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

function TBrickletPTC.GetTemperature: longint

Gibt die Temperatur des verbundenen Sensors zurück. Der Wertebereich ist von -246 bis 849 °C und 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.

function TBrickletPTC.IsSensorConnected: boolean

Gibt true zurück wenn ein Sensor korrekt verbunden ist.

Falls diese Funktion false zurück gibt, ist entweder kein Pt100 oder Pt1000 Sensor verbunden, der Sensor ist inkorrekt verbunden oder der Sensor selbst ist fehlerhaft.

procedure TBrickletPTC.SetWireMode(const mode: byte)

Stellt die Leiter-Konfiguration des Sensors ein. Mögliche Werte sind 2, 3 und 4, dies entspricht 2-, 3- und 4-Leiter-Sensoren. Der Wert muss er Jumper-Konfiguration am Bricklet entsprechen.

Der Standardwert ist 2 = 2-Leiter.

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

  • BRICKLET_PTC_WIRE_MODE_2 = 2
  • BRICKLET_PTC_WIRE_MODE_3 = 3
  • BRICKLET_PTC_WIRE_MODE_4 = 4
function TBrickletPTC.GetWireMode: byte

Gibt die Leiter-Konfiguration zurück, wie von SetWireMode gesetzt.

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

  • BRICKLET_PTC_WIRE_MODE_2 = 2
  • BRICKLET_PTC_WIRE_MODE_3 = 3
  • BRICKLET_PTC_WIRE_MODE_4 = 4

Fortgeschrittene Funktionen

function TBrickletPTC.GetResistance: longint

Gibt den Wert zurück, wie vom "MAX31865 Präzisions Delta-Sigma ADC" berechnet.

Der Wert kann mit den folgenden Formeln in einen Widerstand konvertiert werden:

  • Pt100: Widerstand = (Wert * 390) / 32768
  • Pt1000: Widerstand = (Wert * 3900) / 32768

Wenn der Widerstand periodisch abgefragt werden soll, wird empfohlen den OnResistance Callback zu nutzen und die Periode mit SetResistanceCallbackPeriod vorzugeben.

procedure TBrickletPTC.SetNoiseRejectionFilter(const filter: byte)

Setzt den Entstörfilter auf 50Hz (0) oder 60Hz (1). Störungen von 50Hz oder 60Hz Stromquellen (inklusive Oberwellen der Stromquellen-Grundfrequenz) werden um 82dB abgeschwächt.

Der Standardwert ist 0 = 50Hz.

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

  • BRICKLET_PTC_FILTER_OPTION_50HZ = 0
  • BRICKLET_PTC_FILTER_OPTION_60HZ = 1
function TBrickletPTC.GetNoiseRejectionFilter: byte

Gibt die Einstellung des Entstörfilters zurück, wie von SetNoiseRejectionFilter gesetzt.

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

  • BRICKLET_PTC_FILTER_OPTION_50HZ = 0
  • BRICKLET_PTC_FILTER_OPTION_60HZ = 1
function TBrickletPTC.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 TBrickletPTC.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 TBrickletPTC.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_PTC_FUNCTION_SET_TEMPERATURE_CALLBACK_PERIOD = 3
  • BRICKLET_PTC_FUNCTION_SET_RESISTANCE_CALLBACK_PERIOD = 5
  • BRICKLET_PTC_FUNCTION_SET_TEMPERATURE_CALLBACK_THRESHOLD = 7
  • BRICKLET_PTC_FUNCTION_SET_RESISTANCE_CALLBACK_THRESHOLD = 9
  • BRICKLET_PTC_FUNCTION_SET_DEBOUNCE_PERIOD = 11
  • BRICKLET_PTC_FUNCTION_SET_NOISE_REJECTION_FILTER = 17
  • BRICKLET_PTC_FUNCTION_SET_WIRE_MODE = 20
  • BRICKLET_PTC_FUNCTION_SET_SENSOR_CONNECTED_CALLBACK_CONFIGURATION = 22
procedure TBrickletPTC.SetResponseExpectedAll(const responseExpected: boolean)

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

procedure TBrickletPTC.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 TBrickletPTC.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 TBrickletPTC.GetTemperatureCallbackPeriod: longword

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

procedure TBrickletPTC.SetResistanceCallbackPeriod(const period: longword)

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

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

Der Standardwert ist 0.

function TBrickletPTC.GetResistanceCallbackPeriod: longword

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

procedure TBrickletPTC.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_PTC_THRESHOLD_OPTION_OFF = 'x'
  • BRICKLET_PTC_THRESHOLD_OPTION_OUTSIDE = 'o'
  • BRICKLET_PTC_THRESHOLD_OPTION_INSIDE = 'i'
  • BRICKLET_PTC_THRESHOLD_OPTION_SMALLER = '<'
  • BRICKLET_PTC_THRESHOLD_OPTION_GREATER = '>'
procedure TBrickletPTC.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_PTC_THRESHOLD_OPTION_OFF = 'x'
  • BRICKLET_PTC_THRESHOLD_OPTION_OUTSIDE = 'o'
  • BRICKLET_PTC_THRESHOLD_OPTION_INSIDE = 'i'
  • BRICKLET_PTC_THRESHOLD_OPTION_SMALLER = '<'
  • BRICKLET_PTC_THRESHOLD_OPTION_GREATER = '>'
procedure TBrickletPTC.SetResistanceCallbackThreshold(const option: char; const min: longint; const max: longint)

Setzt den Schwellwert für den OnResistanceReached 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_PTC_THRESHOLD_OPTION_OFF = 'x'
  • BRICKLET_PTC_THRESHOLD_OPTION_OUTSIDE = 'o'
  • BRICKLET_PTC_THRESHOLD_OPTION_INSIDE = 'i'
  • BRICKLET_PTC_THRESHOLD_OPTION_SMALLER = '<'
  • BRICKLET_PTC_THRESHOLD_OPTION_GREATER = '>'
procedure TBrickletPTC.GetResistanceCallbackThreshold(out option: char; out min: longint; out max: longint)

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

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

  • BRICKLET_PTC_THRESHOLD_OPTION_OFF = 'x'
  • BRICKLET_PTC_THRESHOLD_OPTION_OUTSIDE = 'o'
  • BRICKLET_PTC_THRESHOLD_OPTION_INSIDE = 'i'
  • BRICKLET_PTC_THRESHOLD_OPTION_SMALLER = '<'
  • BRICKLET_PTC_THRESHOLD_OPTION_GREATER = '>'
procedure TBrickletPTC.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 TBrickletPTC.GetDebouncePeriod: longword

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

procedure TBrickletPTC.SetSensorConnectedCallbackConfiguration(const enabled: boolean)

Wenn dieser Callback aktiviert ist, wird der OnSensorConnected Callback jedes mal ausgelöst, wenn ein Pt-Sensor verbunden/getrennt wird.

Standardmäßig ist dieser Callback deaktiviert.

Neu in Version 2.0.2 (Plugin).

function TBrickletPTC.GetSensorConnectedCallbackConfiguration: boolean

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

Neu in Version 2.0.2 (Plugin).

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

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

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

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

property TBrickletPTC.OnTemperatureReached
procedure(sender: TBrickletPTC; 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 verbundenen Sensors.

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

property TBrickletPTC.OnResistance
procedure(sender: TBrickletPTC; const resistance: longint) of object;

Dieser Callback wird mit der Periode, wie gesetzt mit SetResistanceCallbackPeriod, ausgelöst. Der Parameter ist der Widerstand des verbundenen Sensors.

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

property TBrickletPTC.OnResistanceReached
procedure(sender: TBrickletPTC; const resistance: longint) of object;

Dieser Callback wird ausgelöst, wenn der Schwellwert, wie von SetResistanceCallbackThreshold gesetzt, erreicht wird. Der Parameter ist der Widerstand des verbundenen Sensors.

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

property TBrickletPTC.OnSensorConnected
procedure(sender: TBrickletPTC; const connected: boolean) of object;

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

Der Parameter ist der gleiche wie bei IsSensorConnected.

Neu in Version 2.0.2 (Plugin).

Konstanten

const BRICKLET_PTC_DEVICE_IDENTIFIER

Diese Konstante wird verwendet um ein PTC 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_PTC_DEVICE_DISPLAY_NAME

Diese Konstante stellt den Anzeigenamen eines PTC Bricklet dar.