Delphi/Lazarus - Industrial PTC Bricklet¶

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, BrickletIndustrialPTC;

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

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

var
  e: TExample;

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

  { Create device object }
  ptc := TBrickletIndustrialPTC.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

program ExampleCallback;

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

uses
  SysUtils, IPConnection, BrickletIndustrialPTC;

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

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

var
  e: TExample;

{ Callback procedure for temperature callback }
procedure TExample.TemperatureCB(sender: TBrickletIndustrialPTC;
                                 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 := TBrickletIndustrialPTC.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) without a threshold }
  ptc.SetTemperatureCallbackConfiguration(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, BrickletIndustrialPTC;

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

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

var
  e: TExample;

{ Callback procedure for temperature callback }
procedure TExample.TemperatureCB(sender: TBrickletIndustrialPTC;
                                 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 := TBrickletIndustrialPTC.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;

  { Configure threshold for temperature "greater than 30 °C"
    with a debounce period of 1s (1000ms) }
  ptc.SetTemperatureCallbackConfiguration(1000, false, '>', 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.

Grundfunktionen¶

constructor TBrickletIndustrialPTC.Create(const uid: string; ipcon: TIPConnection)¶

Parameter:	uid – Typ: string ipcon – Typ: TIPConnection
Rückgabe:	industrialPTC – Typ: TBrickletIndustrialPTC

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

industrialPTC := TBrickletIndustrialPTC.Create('YOUR_DEVICE_UID', ipcon);

Dieses Objekt kann benutzt werden, nachdem die IP Connection verbunden ist.

function TBrickletIndustrialPTC.GetTemperature: longint¶

Rückgabe:	temperature – Typ: longint, Einheit: 1/100 °C, Wertebereich: [-24600 bis 84900]

Gibt die Temperatur des verbundenen 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.

function TBrickletIndustrialPTC.GetResistance: longint¶

Rückgabe:	resistance – Typ: longint, Einheit: ? Ω, Wertebereich: [-231 bis 231 - 1]

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 Wert periodisch benötigt wird, kann auch der OnResistance Callback verwendet werden. Der Callback wird mit der Funktion SetResistanceCallbackConfiguration konfiguriert.

function TBrickletIndustrialPTC.IsSensorConnected: boolean¶

Rückgabe:	connected – Typ: 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.

Zum automatischen übertragen des Status kann auch der OnSensorConnected Callback verwendet werden. Der Callback wird mit der Funktion SetSensorConnectedCallbackConfiguration konfiguriert.

procedure TBrickletIndustrialPTC.SetWireMode(const mode: byte)¶

Parameter:	mode – Typ: byte, Wertebereich: Siehe Konstanten, Standardwert: 2

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.

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

Für mode:

• BRICKLET_INDUSTRIAL_PTC_WIRE_MODE_2 = 2
• BRICKLET_INDUSTRIAL_PTC_WIRE_MODE_3 = 3
• BRICKLET_INDUSTRIAL_PTC_WIRE_MODE_4 = 4

function TBrickletIndustrialPTC.GetWireMode: byte¶

Rückgabe:	mode – Typ: byte, Wertebereich: Siehe Konstanten, Standardwert: 2

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

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

Für mode:

• BRICKLET_INDUSTRIAL_PTC_WIRE_MODE_2 = 2
• BRICKLET_INDUSTRIAL_PTC_WIRE_MODE_3 = 3
• BRICKLET_INDUSTRIAL_PTC_WIRE_MODE_4 = 4

procedure TBrickletIndustrialPTC.SetMovingAverageConfiguration(const movingAverageLengthResistance: word; const movingAverageLengthTemperature: word)¶

Parameter:	movingAverageLengthResistance – Typ: word, Wertebereich: [1 bis 1000], Standardwert: 1 movingAverageLengthTemperature – Typ: word, Wertebereich: [1 bis 1000], Standardwert: 40

Setzt die Länge eines gleitenden Mittelwerts für den Widerstand und die 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 20ms gemessen. Mit einer Mittelwerts-Länge von 1000 hat das resultierende gleitende Fenster eine Zeitspanne von 20s. Bei Langzeitmessungen gibt ein langer Mittelwert die saubersten Resultate.

Die Standardwerte entsprechen den nicht-änderbaren Mittelwert-Einstellungen des alten PTC Bricklet 1.0.

procedure TBrickletIndustrialPTC.GetMovingAverageConfiguration(out movingAverageLengthResistance: word; out movingAverageLengthTemperature: word)¶

Ausgabeparameter:	movingAverageLengthResistance – Typ: word, Wertebereich: [1 bis 1000], Standardwert: 1 movingAverageLengthTemperature – Typ: word, Wertebereich: [1 bis 1000], Standardwert: 40

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

Fortgeschrittene Funktionen¶

procedure TBrickletIndustrialPTC.SetNoiseRejectionFilter(const filter: byte)¶

Parameter:	filter – Typ: byte, Wertebereich: Siehe Konstanten, Standardwert: 0

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.

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

Für filter:

• BRICKLET_INDUSTRIAL_PTC_FILTER_OPTION_50HZ = 0
• BRICKLET_INDUSTRIAL_PTC_FILTER_OPTION_60HZ = 1

function TBrickletIndustrialPTC.GetNoiseRejectionFilter: byte¶

Rückgabe:	filter – Typ: byte, Wertebereich: Siehe Konstanten, Standardwert: 0

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

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

Für filter:

• BRICKLET_INDUSTRIAL_PTC_FILTER_OPTION_50HZ = 0
• BRICKLET_INDUSTRIAL_PTC_FILTER_OPTION_60HZ = 1

procedure TBrickletIndustrialPTC.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.

procedure TBrickletIndustrialPTC.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_INDUSTRIAL_PTC_STATUS_LED_CONFIG_OFF = 0
• BRICKLET_INDUSTRIAL_PTC_STATUS_LED_CONFIG_ON = 1
• BRICKLET_INDUSTRIAL_PTC_STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
• BRICKLET_INDUSTRIAL_PTC_STATUS_LED_CONFIG_SHOW_STATUS = 3

function TBrickletIndustrialPTC.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_INDUSTRIAL_PTC_STATUS_LED_CONFIG_OFF = 0
• BRICKLET_INDUSTRIAL_PTC_STATUS_LED_CONFIG_ON = 1
• BRICKLET_INDUSTRIAL_PTC_STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
• BRICKLET_INDUSTRIAL_PTC_STATUS_LED_CONFIG_SHOW_STATUS = 3

function TBrickletIndustrialPTC.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 TBrickletIndustrialPTC.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 TBrickletIndustrialPTC.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', '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 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.

Konfigurationsfunktionen für Callbacks¶

procedure TBrickletIndustrialPTC.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, Einheit: 1/100 °C, Wertebereich: [-231 bis 231 - 1], Standardwert: 0 max – Typ: longint, Einheit: 1/100 °C, Wertebereich: [-231 bis 231 - 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_INDUSTRIAL_PTC_THRESHOLD_OPTION_OFF = 'x'
• BRICKLET_INDUSTRIAL_PTC_THRESHOLD_OPTION_OUTSIDE = 'o'
• BRICKLET_INDUSTRIAL_PTC_THRESHOLD_OPTION_INSIDE = 'i'
• BRICKLET_INDUSTRIAL_PTC_THRESHOLD_OPTION_SMALLER = '<'
• BRICKLET_INDUSTRIAL_PTC_THRESHOLD_OPTION_GREATER = '>'

procedure TBrickletIndustrialPTC.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, Einheit: 1/100 °C, Wertebereich: [-231 bis 231 - 1], Standardwert: 0 max – Typ: longint, Einheit: 1/100 °C, Wertebereich: [-231 bis 231 - 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_INDUSTRIAL_PTC_THRESHOLD_OPTION_OFF = 'x'
• BRICKLET_INDUSTRIAL_PTC_THRESHOLD_OPTION_OUTSIDE = 'o'
• BRICKLET_INDUSTRIAL_PTC_THRESHOLD_OPTION_INSIDE = 'i'
• BRICKLET_INDUSTRIAL_PTC_THRESHOLD_OPTION_SMALLER = '<'
• BRICKLET_INDUSTRIAL_PTC_THRESHOLD_OPTION_GREATER = '>'

procedure TBrickletIndustrialPTC.SetResistanceCallbackConfiguration(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, Einheit: ? Ω, Wertebereich: [-231 bis 231 - 1], Standardwert: 0 max – Typ: longint, Einheit: ? Ω, Wertebereich: [-231 bis 231 - 1], Standardwert: 0

Die Periode ist die Periode mit der der OnResistance 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 OnResistance 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_INDUSTRIAL_PTC_THRESHOLD_OPTION_OFF = 'x'
• BRICKLET_INDUSTRIAL_PTC_THRESHOLD_OPTION_OUTSIDE = 'o'
• BRICKLET_INDUSTRIAL_PTC_THRESHOLD_OPTION_INSIDE = 'i'
• BRICKLET_INDUSTRIAL_PTC_THRESHOLD_OPTION_SMALLER = '<'
• BRICKLET_INDUSTRIAL_PTC_THRESHOLD_OPTION_GREATER = '>'

procedure TBrickletIndustrialPTC.GetResistanceCallbackConfiguration(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, Einheit: ? Ω, Wertebereich: [-231 bis 231 - 1], Standardwert: 0 max – Typ: longint, Einheit: ? Ω, Wertebereich: [-231 bis 231 - 1], Standardwert: 0

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

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

Für option:

• BRICKLET_INDUSTRIAL_PTC_THRESHOLD_OPTION_OFF = 'x'
• BRICKLET_INDUSTRIAL_PTC_THRESHOLD_OPTION_OUTSIDE = 'o'
• BRICKLET_INDUSTRIAL_PTC_THRESHOLD_OPTION_INSIDE = 'i'
• BRICKLET_INDUSTRIAL_PTC_THRESHOLD_OPTION_SMALLER = '<'
• BRICKLET_INDUSTRIAL_PTC_THRESHOLD_OPTION_GREATER = '>'

procedure TBrickletIndustrialPTC.SetSensorConnectedCallbackConfiguration(const enabled: boolean)¶

Parameter:	enabled – Typ: boolean, Standardwert: false

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

function TBrickletIndustrialPTC.GetSensorConnectedCallbackConfiguration: boolean¶

Rückgabe:	enabled – Typ: boolean, Standardwert: false

Gibt die Konfiguration zurück, wie von SetSensorConnectedCallbackConfiguration 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: TBrickletIndustrialPTC; const value: longint);
begin
  WriteLn(Format('Value: %d', [value]));
end;

industrialPTC.OnExample := {$ifdef FPC}@{$endif}example.MyCallback;

Die verfügbaren Callback Properties und ihre Parametertypen werden weiter unten beschrieben.

property TBrickletIndustrialPTC.OnTemperature¶

procedure(sender: TBrickletIndustrialPTC; const temperature: longint) of object;

Callback-Parameter:	sender – Typ: TBrickletIndustrialPTC temperature – Typ: longint, Einheit: 1/100 °C, Wertebereich: [-24600 bis 84900]

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

Der Parameter ist der gleiche wie GetTemperature.

property TBrickletIndustrialPTC.OnResistance¶

procedure(sender: TBrickletIndustrialPTC; const resistance: longint) of object;

Callback-Parameter:	sender – Typ: TBrickletIndustrialPTC resistance – Typ: longint, Einheit: ? Ω, Wertebereich: [-231 bis 231 - 1]

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

Der Parameter ist der gleiche wie GetResistance.

property TBrickletIndustrialPTC.OnSensorConnected¶

procedure(sender: TBrickletIndustrialPTC; const connected: boolean) of object;

Callback-Parameter:	sender – Typ: TBrickletIndustrialPTC connected – Typ: boolean

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

Der Parameter ist der gleiche wie bei IsSensorConnected.

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 TBrickletIndustrialPTC.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 TBrickletIndustrialPTC.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_INDUSTRIAL_PTC_FUNCTION_SET_TEMPERATURE_CALLBACK_CONFIGURATION = 2
• BRICKLET_INDUSTRIAL_PTC_FUNCTION_SET_RESISTANCE_CALLBACK_CONFIGURATION = 6
• BRICKLET_INDUSTRIAL_PTC_FUNCTION_SET_NOISE_REJECTION_FILTER = 9
• BRICKLET_INDUSTRIAL_PTC_FUNCTION_SET_WIRE_MODE = 12
• BRICKLET_INDUSTRIAL_PTC_FUNCTION_SET_MOVING_AVERAGE_CONFIGURATION = 14
• BRICKLET_INDUSTRIAL_PTC_FUNCTION_SET_SENSOR_CONNECTED_CALLBACK_CONFIGURATION = 16
• BRICKLET_INDUSTRIAL_PTC_FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
• BRICKLET_INDUSTRIAL_PTC_FUNCTION_SET_STATUS_LED_CONFIG = 239
• BRICKLET_INDUSTRIAL_PTC_FUNCTION_RESET = 243
• BRICKLET_INDUSTRIAL_PTC_FUNCTION_WRITE_UID = 248

procedure TBrickletIndustrialPTC.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_INDUSTRIAL_PTC_FUNCTION_SET_TEMPERATURE_CALLBACK_CONFIGURATION = 2
• BRICKLET_INDUSTRIAL_PTC_FUNCTION_SET_RESISTANCE_CALLBACK_CONFIGURATION = 6
• BRICKLET_INDUSTRIAL_PTC_FUNCTION_SET_NOISE_REJECTION_FILTER = 9
• BRICKLET_INDUSTRIAL_PTC_FUNCTION_SET_WIRE_MODE = 12
• BRICKLET_INDUSTRIAL_PTC_FUNCTION_SET_MOVING_AVERAGE_CONFIGURATION = 14
• BRICKLET_INDUSTRIAL_PTC_FUNCTION_SET_SENSOR_CONNECTED_CALLBACK_CONFIGURATION = 16
• BRICKLET_INDUSTRIAL_PTC_FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
• BRICKLET_INDUSTRIAL_PTC_FUNCTION_SET_STATUS_LED_CONFIG = 239
• BRICKLET_INDUSTRIAL_PTC_FUNCTION_RESET = 243
• BRICKLET_INDUSTRIAL_PTC_FUNCTION_WRITE_UID = 248

procedure TBrickletIndustrialPTC.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.

Interne Funktionen¶

Interne Funktionen werden für Wartungsaufgaben, wie zum Beispiel das Flashen einer neuen Firmware oder das Ändern der UID eines Bricklets, verwendet. Diese Aufgaben sollten mit Brick Viewer durchgeführt werden, anstelle die internen Funktionen direkt zu verwenden.

function TBrickletIndustrialPTC.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_INDUSTRIAL_PTC_BOOTLOADER_MODE_BOOTLOADER = 0
• BRICKLET_INDUSTRIAL_PTC_BOOTLOADER_MODE_FIRMWARE = 1
• BRICKLET_INDUSTRIAL_PTC_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
• BRICKLET_INDUSTRIAL_PTC_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
• BRICKLET_INDUSTRIAL_PTC_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4

Für status:

• BRICKLET_INDUSTRIAL_PTC_BOOTLOADER_STATUS_OK = 0
• BRICKLET_INDUSTRIAL_PTC_BOOTLOADER_STATUS_INVALID_MODE = 1
• BRICKLET_INDUSTRIAL_PTC_BOOTLOADER_STATUS_NO_CHANGE = 2
• BRICKLET_INDUSTRIAL_PTC_BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT = 3
• BRICKLET_INDUSTRIAL_PTC_BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT = 4
• BRICKLET_INDUSTRIAL_PTC_BOOTLOADER_STATUS_CRC_MISMATCH = 5

function TBrickletIndustrialPTC.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_INDUSTRIAL_PTC_BOOTLOADER_MODE_BOOTLOADER = 0
• BRICKLET_INDUSTRIAL_PTC_BOOTLOADER_MODE_FIRMWARE = 1
• BRICKLET_INDUSTRIAL_PTC_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
• BRICKLET_INDUSTRIAL_PTC_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
• BRICKLET_INDUSTRIAL_PTC_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4

procedure TBrickletIndustrialPTC.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 TBrickletIndustrialPTC.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 TBrickletIndustrialPTC.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 TBrickletIndustrialPTC.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.

Konstanten¶

const BRICKLET_INDUSTRIAL_PTC_DEVICE_IDENTIFIER¶

Diese Konstante wird verwendet um ein Industrial 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_INDUSTRIAL_PTC_DEVICE_DISPLAY_NAME¶

Diese Konstante stellt den Anzeigenamen eines Industrial PTC Bricklet dar.