Delphi/Lazarus - Industrial Dual 0-20mA Bricklet¶

Simple¶

Download (ExampleSimple.pas)

 1program ExampleSimple;
 2
 3{$ifdef MSWINDOWS}{$apptype CONSOLE}{$endif}
 4{$ifdef FPC}{$mode OBJFPC}{$H+}{$endif}
 5
 6uses
 7  SysUtils, IPConnection, BrickletIndustrialDual020mA;
 8
 9type
10  TExample = class
11  private
12    ipcon: TIPConnection;
13    id020: TBrickletIndustrialDual020mA;
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 Industrial Dual 0-20mA Bricklet }
22
23var
24  e: TExample;
25
26procedure TExample.Execute;
27var current: longint;
28begin
29  { Create IP connection }
30  ipcon := TIPConnection.Create;
31
32  { Create device object }
33  id020 := TBrickletIndustrialDual020mA.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 current from sensor 1 }
40  current := id020.GetCurrent(1);
41  WriteLn(Format('Current (Sensor 1): %f mA', [current/1000000.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.

Callback¶

Download (ExampleCallback.pas)

 1program ExampleCallback;
 2
 3{$ifdef MSWINDOWS}{$apptype CONSOLE}{$endif}
 4{$ifdef FPC}{$mode OBJFPC}{$H+}{$endif}
 5
 6uses
 7  SysUtils, IPConnection, BrickletIndustrialDual020mA;
 8
 9type
10  TExample = class
11  private
12    ipcon: TIPConnection;
13    id020: TBrickletIndustrialDual020mA;
14  public
15    procedure CurrentCB(sender: TBrickletIndustrialDual020mA; const sensor: byte;
16                        const current: longint);
17    procedure Execute;
18  end;
19
20const
21  HOST = 'localhost';
22  PORT = 4223;
23  UID = 'XYZ'; { Change XYZ to the UID of your Industrial Dual 0-20mA Bricklet }
24
25var
26  e: TExample;
27
28{ Callback procedure for current callback }
29procedure TExample.CurrentCB(sender: TBrickletIndustrialDual020mA; const sensor: byte;
30                             const current: longint);
31begin
32  WriteLn(Format('Sensor: %d', [sensor]));
33  WriteLn(Format('Current: %f mA', [current/1000000.0]));
34  WriteLn('');
35end;
36
37procedure TExample.Execute;
38begin
39  { Create IP connection }
40  ipcon := TIPConnection.Create;
41
42  { Create device object }
43  id020 := TBrickletIndustrialDual020mA.Create(UID, ipcon);
44
45  { Connect to brickd }
46  ipcon.Connect(HOST, PORT);
47  { Don't use device before ipcon is connected }
48
49  { Register current callback to procedure CurrentCB }
50  id020.OnCurrent := {$ifdef FPC}@{$endif}CurrentCB;
51
52  { Set period for current (sensor 1) callback to 1s (1000ms)
53    Note: The current (sensor 1) callback is only called every second
54          if the current (sensor 1) has changed since the last call! }
55  id020.SetCurrentCallbackPeriod(1, 1000);
56
57  WriteLn('Press key to exit');
58  ReadLn;
59  ipcon.Destroy; { Calls ipcon.Disconnect internally }
60end;
61
62begin
63  e := TExample.Create;
64  e.Execute;
65  e.Destroy;
66end.

Threshold¶

Download (ExampleThreshold.pas)

 1program ExampleThreshold;
 2
 3{$ifdef MSWINDOWS}{$apptype CONSOLE}{$endif}
 4{$ifdef FPC}{$mode OBJFPC}{$H+}{$endif}
 5
 6uses
 7  SysUtils, IPConnection, BrickletIndustrialDual020mA;
 8
 9type
10  TExample = class
11  private
12    ipcon: TIPConnection;
13    id020: TBrickletIndustrialDual020mA;
14  public
15    procedure CurrentReachedCB(sender: TBrickletIndustrialDual020mA; const sensor: byte;
16                               const current: longint);
17    procedure Execute;
18  end;
19
20const
21  HOST = 'localhost';
22  PORT = 4223;
23  UID = 'XYZ'; { Change XYZ to the UID of your Industrial Dual 0-20mA Bricklet }
24
25var
26  e: TExample;
27
28{ Callback procedure for current reached callback }
29procedure TExample.CurrentReachedCB(sender: TBrickletIndustrialDual020mA;
30                                    const sensor: byte; const current: longint);
31begin
32  WriteLn(Format('Sensor: %d', [sensor]));
33  WriteLn(Format('Current: %f mA', [current/1000000.0]));
34  WriteLn('');
35end;
36
37procedure TExample.Execute;
38begin
39  { Create IP connection }
40  ipcon := TIPConnection.Create;
41
42  { Create device object }
43  id020 := TBrickletIndustrialDual020mA.Create(UID, ipcon);
44
45  { Connect to brickd }
46  ipcon.Connect(HOST, PORT);
47  { Don't use device before ipcon is connected }
48
49  { Get threshold callbacks with a debounce time of 10 seconds (10000ms) }
50  id020.SetDebouncePeriod(10000);
51
52  { Register current reached callback to procedure CurrentReachedCB }
53  id020.OnCurrentReached := {$ifdef FPC}@{$endif}CurrentReachedCB;
54
55  { Configure threshold for current (sensor 1) "greater than 10 mA" }
56  id020.SetCurrentCallbackThreshold(1, '>', 10*1000000, 0);
57
58  WriteLn('Press key to exit');
59  ReadLn;
60  ipcon.Destroy; { Calls ipcon.Disconnect internally }
61end;
62
63begin
64  e := TExample.Create;
65  e.Execute;
66  e.Destroy;
67end.

Grundfunktionen¶

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

Parameter:	uid – Typ: string ipcon – Typ: TIPConnection
Rückgabe:	industrialDual020mA – Typ: TBrickletIndustrialDual020mA

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

industrialDual020mA := TBrickletIndustrialDual020mA.Create('YOUR_DEVICE_UID', ipcon);

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

function TBrickletIndustrialDual020mA.GetCurrent(const sensor: byte): longint¶

Parameter:	sensor – Typ: byte, Wertebereich: [0 bis 1]
Rückgabe:	current – Typ: longint, Einheit: 1 nA, Wertebereich: [0 bis 22505322]

Gibt die gemessenen Stromstärke des angegebenen Sensors zurück.

Es ist möglich zu erkennen ob ein IEC 60381-1-kompatibler Sensor angeschlossen ist und ob er funktionsfähig ist.

Falls die zurückgegebene Stromstärke kleiner als 4mA ist, ist wahrscheinlich kein Sensor angeschlossen oder der Sensor ist defekt. Falls die zurückgegebene Stromstärke über 20mA ist, besteht entweder ein Kurzschluss oder der Sensor ist defekt. Somit ist erkennbar ob ein Sensor angeschlossen und funktionsfähig ist.

Wenn die Stromstärke periodisch abgefragt werden soll, wird empfohlen den OnCurrent Callback zu nutzen und die Periode mit SetCurrentCallbackPeriod vorzugeben.

Fortgeschrittene Funktionen¶

procedure TBrickletIndustrialDual020mA.SetSampleRate(const rate: byte)¶

Parameter:	rate – Typ: byte, Wertebereich: Siehe Konstanten, Standardwert: 3

Setzt die Abtastrate auf 240, 60, 15 oder 4 Samples pro Sekunde. Die Auflösung für die Raten sind 12, 14, 16 und 18 Bit respektive.

Wert	Beschreibung
0	240 Samples pro Sekunde, 12 Bit Auflösung
1	60 Samples pro Sekunde, 14 Bit Auflösung
2	15 Samples pro Sekunde, 16 Bit Auflösung
3	4 Samples pro Sekunde, 18 Bit Auflösung

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

Für rate:

• BRICKLET_INDUSTRIAL_DUAL_0_20MA_SAMPLE_RATE_240_SPS = 0

• BRICKLET_INDUSTRIAL_DUAL_0_20MA_SAMPLE_RATE_60_SPS = 1

• BRICKLET_INDUSTRIAL_DUAL_0_20MA_SAMPLE_RATE_15_SPS = 2

• BRICKLET_INDUSTRIAL_DUAL_0_20MA_SAMPLE_RATE_4_SPS = 3

function TBrickletIndustrialDual020mA.GetSampleRate: byte¶

Rückgabe:	rate – Typ: byte, Wertebereich: Siehe Konstanten, Standardwert: 3

Gibt die Abtastrate zurück, wie von SetSampleRate gesetzt.

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

Für rate:

• BRICKLET_INDUSTRIAL_DUAL_0_20MA_SAMPLE_RATE_240_SPS = 0

• BRICKLET_INDUSTRIAL_DUAL_0_20MA_SAMPLE_RATE_60_SPS = 1

• BRICKLET_INDUSTRIAL_DUAL_0_20MA_SAMPLE_RATE_15_SPS = 2

• BRICKLET_INDUSTRIAL_DUAL_0_20MA_SAMPLE_RATE_4_SPS = 3

procedure TBrickletIndustrialDual020mA.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 TBrickletIndustrialDual020mA.SetCurrentCallbackPeriod(const sensor: byte; const period: longword)¶

Parameter:	sensor – Typ: byte, Wertebereich: [0 bis 1] period – Typ: longword, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0

Setzt die Periode mit welcher der OnCurrent Callback für den übergebenen Sensor ausgelöst wird. Ein Wert von 0 deaktiviert den Callback.

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

function TBrickletIndustrialDual020mA.GetCurrentCallbackPeriod(const sensor: byte): longword¶

Parameter:	sensor – Typ: byte, Wertebereich: [0 bis 1]
Rückgabe:	period – Typ: longword, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0

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

procedure TBrickletIndustrialDual020mA.SetCurrentCallbackThreshold(const sensor: byte; const option: char; const min: longint; const max: longint)¶

Parameter:	sensor – Typ: byte, Wertebereich: [0 bis 1] option – Typ: char, Wertebereich: Siehe Konstanten, Standardwert: 'x' min – Typ: longint, Einheit: 1 nA, Wertebereich: [-231 bis 231 - 1], Standardwert: 0 max – Typ: longint, Einheit: 1 nA, Wertebereich: [-231 bis 231 - 1], Standardwert: 0

Setzt den Schwellwert des OnCurrentReached Callbacks für den übergebenen Sensor.

Die folgenden Optionen sind möglich:

Option	Beschreibung
'x'	Callback ist inaktiv
'o'	Callback wird ausgelöst, wenn die Stromstärke außerhalb des min und max Wertes ist
'i'	Callback wird ausgelöst, wenn die Stromstärke innerhalb des min und max Wertes ist
'<'	Callback wird ausgelöst, wenn die Stromstärke kleiner als der min Wert ist (max wird ignoriert)
'>'	Callback wird ausgelöst, wenn die Stromstärke größer als der min Wert ist (max wird ignoriert)

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

Für option:

• BRICKLET_INDUSTRIAL_DUAL_0_20MA_THRESHOLD_OPTION_OFF = 'x'

• BRICKLET_INDUSTRIAL_DUAL_0_20MA_THRESHOLD_OPTION_OUTSIDE = 'o'

• BRICKLET_INDUSTRIAL_DUAL_0_20MA_THRESHOLD_OPTION_INSIDE = 'i'

• BRICKLET_INDUSTRIAL_DUAL_0_20MA_THRESHOLD_OPTION_SMALLER = '<'

• BRICKLET_INDUSTRIAL_DUAL_0_20MA_THRESHOLD_OPTION_GREATER = '>'

procedure TBrickletIndustrialDual020mA.GetCurrentCallbackThreshold(const sensor: byte; out option: char; out min: longint; out max: longint)¶

Parameter:	sensor – Typ: byte, Wertebereich: [0 bis 1]
Ausgabeparameter:	option – Typ: char, Wertebereich: Siehe Konstanten, Standardwert: 'x' min – Typ: longint, Einheit: 1 nA, Wertebereich: [-231 bis 231 - 1], Standardwert: 0 max – Typ: longint, Einheit: 1 nA, Wertebereich: [-231 bis 231 - 1], Standardwert: 0

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

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

Für option:

• BRICKLET_INDUSTRIAL_DUAL_0_20MA_THRESHOLD_OPTION_OFF = 'x'

• BRICKLET_INDUSTRIAL_DUAL_0_20MA_THRESHOLD_OPTION_OUTSIDE = 'o'

• BRICKLET_INDUSTRIAL_DUAL_0_20MA_THRESHOLD_OPTION_INSIDE = 'i'

• BRICKLET_INDUSTRIAL_DUAL_0_20MA_THRESHOLD_OPTION_SMALLER = '<'

• BRICKLET_INDUSTRIAL_DUAL_0_20MA_THRESHOLD_OPTION_GREATER = '>'

procedure TBrickletIndustrialDual020mA.SetDebouncePeriod(const debounce: longword)¶

Parameter:	debounce – Typ: longword, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 100

Setzt die Periode mit welcher der Schwellwert Callback

• OnCurrentReached

ausgelöst werden, wenn der Schwellwert

• SetCurrentCallbackThreshold

weiterhin erreicht bleibt.

function TBrickletIndustrialDual020mA.GetDebouncePeriod: longword¶

Rückgabe:	debounce – Typ: longword, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 100

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: TBrickletIndustrialDual020mA; const value: longint);
begin
  WriteLn(Format('Value: %d', [value]));
end;

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

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

property TBrickletIndustrialDual020mA.OnCurrent¶

procedure(sender: TBrickletIndustrialDual020mA; const sensor: byte; const current: longint) of object;

Callback-Parameter:	sender – Typ: TBrickletIndustrialDual020mA sensor – Typ: byte, Wertebereich: [0 bis 1] current – Typ: longint, Einheit: 1 nA, Wertebereich: [0 bis 22505322]

Dieser Callback wird mit der Periode, wie gesetzt mit SetCurrentCallbackPeriod, ausgelöst. Der Parameter ist die Stromstärke des Sensors.

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

property TBrickletIndustrialDual020mA.OnCurrentReached¶

procedure(sender: TBrickletIndustrialDual020mA; const sensor: byte; const current: longint) of object;

Callback-Parameter:	sender – Typ: TBrickletIndustrialDual020mA sensor – Typ: byte, Wertebereich: [0 bis 1] current – Typ: longint, Einheit: 1 nA, Wertebereich: [0 bis 22505322]

Dieser Callback wird ausgelöst, wenn der Schwellwert, wie von SetCurrentCallbackThreshold gesetzt, erreicht wird. Der Parameter ist die Stromstärke des Sensors.

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

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 TBrickletIndustrialDual020mA.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 TBrickletIndustrialDual020mA.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_DUAL_0_20MA_FUNCTION_SET_CURRENT_CALLBACK_PERIOD = 2

• BRICKLET_INDUSTRIAL_DUAL_0_20MA_FUNCTION_SET_CURRENT_CALLBACK_THRESHOLD = 4

• BRICKLET_INDUSTRIAL_DUAL_0_20MA_FUNCTION_SET_DEBOUNCE_PERIOD = 6

• BRICKLET_INDUSTRIAL_DUAL_0_20MA_FUNCTION_SET_SAMPLE_RATE = 8

procedure TBrickletIndustrialDual020mA.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_DUAL_0_20MA_FUNCTION_SET_CURRENT_CALLBACK_PERIOD = 2

• BRICKLET_INDUSTRIAL_DUAL_0_20MA_FUNCTION_SET_CURRENT_CALLBACK_THRESHOLD = 4

• BRICKLET_INDUSTRIAL_DUAL_0_20MA_FUNCTION_SET_DEBOUNCE_PERIOD = 6

• BRICKLET_INDUSTRIAL_DUAL_0_20MA_FUNCTION_SET_SAMPLE_RATE = 8

procedure TBrickletIndustrialDual020mA.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_INDUSTRIAL_DUAL_0_20MA_DEVICE_IDENTIFIER¶

Diese Konstante wird verwendet um ein Industrial Dual 0-20mA 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_DUAL_0_20MA_DEVICE_DISPLAY_NAME¶

Diese Konstante stellt den Anzeigenamen eines Industrial Dual 0-20mA Bricklet dar.