Deutsch
English
Menu
Software / API Bindings / Delphi/Lazarus / API Referenz und Beispiele / Bricklets / Industrial Dual 0-20mA Bricklet 2.0

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

Dies ist die Beschreibung der Delphi/Lazarus API Bindings für das Industrial Dual 0-20mA Bricklet 2.0. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des Industrial Dual 0-20mA Bricklet 2.0 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, BrickletIndustrialDual020mAV2;

type
  TExample = class
  private
    ipcon: TIPConnection;
    id020: TBrickletIndustrialDual020mAV2;
  public
    procedure Execute;
  end;

const
  HOST = 'localhost';
  PORT = 4223;
  UID = 'XYZ'; { Change XYZ to the UID of your Industrial Dual 0-20mA Bricklet 2.0 }

var
  e: TExample;

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

  { Create device object }
  id020 := TBrickletIndustrialDual020mAV2.Create(UID, ipcon);

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

  { Get current current from channel 0 }
  current := id020.GetCurrent(0);
  WriteLn(Format('Current (Channel 0): %f mA', [current/1000000.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
64
program ExampleCallback;

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

uses
  SysUtils, IPConnection, BrickletIndustrialDual020mAV2;

type
  TExample = class
  private
    ipcon: TIPConnection;
    id020: TBrickletIndustrialDual020mAV2;
  public
    procedure CurrentCB(sender: TBrickletIndustrialDual020mAV2; const channel: byte;
                        const current: longint);
    procedure Execute;
  end;

const
  HOST = 'localhost';
  PORT = 4223;
  UID = 'XYZ'; { Change XYZ to the UID of your Industrial Dual 0-20mA Bricklet 2.0 }

var
  e: TExample;

{ Callback procedure for current callback }
procedure TExample.CurrentCB(sender: TBrickletIndustrialDual020mAV2; const channel: byte;
                             const current: longint);
begin
  WriteLn(Format('Channel: %d', [channel]));
  WriteLn(Format('Current: %f mA', [current/1000000.0]));
  WriteLn('');
end;

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

  { Create device object }
  id020 := TBrickletIndustrialDual020mAV2.Create(UID, ipcon);

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

  { Register current callback to procedure CurrentCB }
  id020.OnCurrent := {$ifdef FPC}@{$endif}CurrentCB;

  { Set period for current (channel 0) callback to 1s (1000ms) without a threshold }
  id020.SetCurrentCallbackConfiguration(0, 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
63
64
65
program ExampleThreshold;

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

uses
  SysUtils, IPConnection, BrickletIndustrialDual020mAV2;

type
  TExample = class
  private
    ipcon: TIPConnection;
    id020: TBrickletIndustrialDual020mAV2;
  public
    procedure CurrentCB(sender: TBrickletIndustrialDual020mAV2; const channel: byte;
                        const current: longint);
    procedure Execute;
  end;

const
  HOST = 'localhost';
  PORT = 4223;
  UID = 'XYZ'; { Change XYZ to the UID of your Industrial Dual 0-20mA Bricklet 2.0 }

var
  e: TExample;

{ Callback procedure for current callback }
procedure TExample.CurrentCB(sender: TBrickletIndustrialDual020mAV2; const channel: byte;
                             const current: longint);
begin
  WriteLn(Format('Channel: %d', [channel]));
  WriteLn(Format('Current: %f mA', [current/1000000.0]));
  WriteLn('');
end;

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

  { Create device object }
  id020 := TBrickletIndustrialDual020mAV2.Create(UID, ipcon);

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

  { Register current callback to procedure CurrentCB }
  id020.OnCurrent := {$ifdef FPC}@{$endif}CurrentCB;

  { Configure threshold for current (channel 0) "greater than 10 mA"
    with a debounce period of 10s (10000ms) }
  id020.SetCurrentCallbackConfiguration(0, 10000, false, '>', 10*1000000, 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 TBrickletIndustrialDual020mAV2.Create(const uid: string; ipcon: TIPConnection)
Parameter:
  • uid – Typ: string
  • ipcon – Typ: TIPConnection
Rückgabe:
  • industrialDual020mAV2 – Typ: TBrickletIndustrialDual020mAV2

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

industrialDual020mAV2 := TBrickletIndustrialDual020mAV2.Create('YOUR_DEVICE_UID', ipcon);

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

function TBrickletIndustrialDual020mAV2.GetCurrent(const channel: byte): longint
Parameter:
  • channel – Typ: byte, Wertebereich: [0 bis 1]
Rückgabe:
  • current – Typ: longint, Einheit: 1 nA, Wertebereich: [0 bis 22505322]

Gibt die gemessenen Stromstärke des spezifizierten Kanals 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 der Wert periodisch benötigt wird, kann auch der OnCurrent Callback verwendet werden. Der Callback wird mit der Funktion SetCurrentCallbackConfiguration konfiguriert.

procedure TBrickletIndustrialDual020mAV2.SetChannelLEDConfig(const channel: byte; const config: byte)
Parameter:
  • channel – Typ: byte, Wertebereich: [0 bis 1]
  • config – Typ: byte, Wertebereich: Siehe Konstanten, Standardwert: 3

Jeder Kanal hat eine dazugehörige LED. Die LEDs können individuell an- oder ausgeschaltet werden. Zusätzlich kann ein Heartbeat oder der Kanalstatus angezeigt werden. Falls Kanalstatus gewählt wird kann die LED entweder ab einem vordefinierten Schwellwert eingeschaltet werden oder ihre Helligkeit anhand des gemessenen Wertes skaliert werden.

Das Verhalten des Kanalstatus kann mittels SetChannelLEDStatusConfig eingestellt werden.

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

Für config:

  • BRICKLET_INDUSTRIAL_DUAL_0_20MA_V2_CHANNEL_LED_CONFIG_OFF = 0
  • BRICKLET_INDUSTRIAL_DUAL_0_20MA_V2_CHANNEL_LED_CONFIG_ON = 1
  • BRICKLET_INDUSTRIAL_DUAL_0_20MA_V2_CHANNEL_LED_CONFIG_SHOW_HEARTBEAT = 2
  • BRICKLET_INDUSTRIAL_DUAL_0_20MA_V2_CHANNEL_LED_CONFIG_SHOW_CHANNEL_STATUS = 3
function TBrickletIndustrialDual020mAV2.GetChannelLEDConfig(const channel: byte): byte
Parameter:
  • channel – Typ: byte, Wertebereich: [0 bis 1]
Rückgabe:
  • config – Typ: byte, Wertebereich: Siehe Konstanten, Standardwert: 3

Gibt die Kanal-LED-Konfiguration zurück, wie von SetChannelLEDConfig gesetzt.

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

Für config:

  • BRICKLET_INDUSTRIAL_DUAL_0_20MA_V2_CHANNEL_LED_CONFIG_OFF = 0
  • BRICKLET_INDUSTRIAL_DUAL_0_20MA_V2_CHANNEL_LED_CONFIG_ON = 1
  • BRICKLET_INDUSTRIAL_DUAL_0_20MA_V2_CHANNEL_LED_CONFIG_SHOW_HEARTBEAT = 2
  • BRICKLET_INDUSTRIAL_DUAL_0_20MA_V2_CHANNEL_LED_CONFIG_SHOW_CHANNEL_STATUS = 3
procedure TBrickletIndustrialDual020mAV2.SetChannelLEDStatusConfig(const channel: byte; const min: longint; const max: longint; const config: byte)
Parameter:
  • channel – Typ: byte, Wertebereich: [0 bis 1]
  • min – Typ: longint, Einheit: 1 nA, Wertebereich: [-231 bis 231 - 1], Standardwert: 4000000
  • max – Typ: longint, Einheit: 1 nA, Wertebereich: [-231 bis 231 - 1], Standardwert: 20000000
  • config – Typ: byte, Wertebereich: Siehe Konstanten, Standardwert: 1

Setzt die Kanal-LED-Status-Konfiguration. Diese Einstellung wird verwendet wenn die Kanal-LED auf Kanalstatus eingestellt ist, siehe SetChannelLEDConfig.

Für jeden Kanal kann zwischen Schwellwert- und Intensitätsmodus gewählt werden.

Im Schwellwertmodus kann ein positiver oder negativer Schwellwert definiert werden. Für einen positiven Schwellwert muss der "min" Parameter auf den gewünschten Schwellwert in nA gesetzt werden, über dem die LED eingeschaltet werden soll. Der "max" Parameter muss auf 0 gesetzt werden. Beispiel: Bei einem positiven Schwellwert von 10mA wird die LED eingeschaltet sobald der gemessene Strom über 10mA steigt und wieder ausgeschaltet sobald der Strom unter 10mA fällt. Für einen negativen Schwellwert muss der "max" Parameter auf den gewünschten Schwellwert in nA gesetzt werden, unter dem die LED eingeschaltet werden soll. Der "max" Parameter muss auf 0 gesetzt werden. Beispiel: Bei einem negativen Schwellwert von 10mA wird die LED eingeschaltet sobald der gemessene Strom unter 10mA fällt und wieder ausgeschaltet sobald der Strom über 10mA steigt.

Im Intensitätsmodus kann ein Bereich in nA angegeben werden über den die Helligkeit der LED skaliert wird. Beispiel mit min=4mA und max=20mA: Die LED ist bei 4mA und darunter aus, bei 20mA und darüber an und zwischen 4mA und 20mA wird die Helligkeit linear skaliert. Wenn der min Wert größer als der max Wert ist, dann wird die Helligkeit andersherum skaliert.

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

Für config:

  • BRICKLET_INDUSTRIAL_DUAL_0_20MA_V2_CHANNEL_LED_STATUS_CONFIG_THRESHOLD = 0
  • BRICKLET_INDUSTRIAL_DUAL_0_20MA_V2_CHANNEL_LED_STATUS_CONFIG_INTENSITY = 1
procedure TBrickletIndustrialDual020mAV2.GetChannelLEDStatusConfig(const channel: byte; out min: longint; out max: longint; out config: byte)
Parameter:
  • channel – Typ: byte, Wertebereich: [0 bis 1]
Ausgabeparameter:
  • min – Typ: longint, Einheit: 1 nA, Wertebereich: [-231 bis 231 - 1], Standardwert: 4000000
  • max – Typ: longint, Einheit: 1 nA, Wertebereich: [-231 bis 231 - 1], Standardwert: 20000000
  • config – Typ: byte, Wertebereich: Siehe Konstanten, Standardwert: 1

Gibt die Kanal-LED-Status-Konfiguration zurück, wie von SetChannelLEDStatusConfig gesetzt.

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

Für config:

  • BRICKLET_INDUSTRIAL_DUAL_0_20MA_V2_CHANNEL_LED_STATUS_CONFIG_THRESHOLD = 0
  • BRICKLET_INDUSTRIAL_DUAL_0_20MA_V2_CHANNEL_LED_STATUS_CONFIG_INTENSITY = 1

Fortgeschrittene Funktionen

procedure TBrickletIndustrialDual020mAV2.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_V2_SAMPLE_RATE_240_SPS = 0
  • BRICKLET_INDUSTRIAL_DUAL_0_20MA_V2_SAMPLE_RATE_60_SPS = 1
  • BRICKLET_INDUSTRIAL_DUAL_0_20MA_V2_SAMPLE_RATE_15_SPS = 2
  • BRICKLET_INDUSTRIAL_DUAL_0_20MA_V2_SAMPLE_RATE_4_SPS = 3
function TBrickletIndustrialDual020mAV2.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_V2_SAMPLE_RATE_240_SPS = 0
  • BRICKLET_INDUSTRIAL_DUAL_0_20MA_V2_SAMPLE_RATE_60_SPS = 1
  • BRICKLET_INDUSTRIAL_DUAL_0_20MA_V2_SAMPLE_RATE_15_SPS = 2
  • BRICKLET_INDUSTRIAL_DUAL_0_20MA_V2_SAMPLE_RATE_4_SPS = 3
procedure TBrickletIndustrialDual020mAV2.SetGain(const gain: byte)
Parameter:
  • gain – Typ: byte, Wertebereich: Siehe Konstanten, Standardwert: 0

Setzt die Verstärkung zwischen 1x und 8x. Wenn ein sehr kleiner Strom gemessen werden soll, dann kann die Verstärkung hochgesetzt werden, um die Auflösung zu verbessern.

Beispiel: Wenn 0,5mA gemessen werden mit einer Verstärkung von 8x dann wird 4mA zurückgegeben.

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

Für gain:

  • BRICKLET_INDUSTRIAL_DUAL_0_20MA_V2_GAIN_1X = 0
  • BRICKLET_INDUSTRIAL_DUAL_0_20MA_V2_GAIN_2X = 1
  • BRICKLET_INDUSTRIAL_DUAL_0_20MA_V2_GAIN_4X = 2
  • BRICKLET_INDUSTRIAL_DUAL_0_20MA_V2_GAIN_8X = 3
function TBrickletIndustrialDual020mAV2.GetGain: byte
Rückgabe:
  • gain – Typ: byte, Wertebereich: Siehe Konstanten, Standardwert: 0

Gibt die Verstärkung zurück, wie von SetGain gesetzt.

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

Für gain:

  • BRICKLET_INDUSTRIAL_DUAL_0_20MA_V2_GAIN_1X = 0
  • BRICKLET_INDUSTRIAL_DUAL_0_20MA_V2_GAIN_2X = 1
  • BRICKLET_INDUSTRIAL_DUAL_0_20MA_V2_GAIN_4X = 2
  • BRICKLET_INDUSTRIAL_DUAL_0_20MA_V2_GAIN_8X = 3
procedure TBrickletIndustrialDual020mAV2.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 TBrickletIndustrialDual020mAV2.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_DUAL_0_20MA_V2_STATUS_LED_CONFIG_OFF = 0
  • BRICKLET_INDUSTRIAL_DUAL_0_20MA_V2_STATUS_LED_CONFIG_ON = 1
  • BRICKLET_INDUSTRIAL_DUAL_0_20MA_V2_STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • BRICKLET_INDUSTRIAL_DUAL_0_20MA_V2_STATUS_LED_CONFIG_SHOW_STATUS = 3
function TBrickletIndustrialDual020mAV2.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_DUAL_0_20MA_V2_STATUS_LED_CONFIG_OFF = 0
  • BRICKLET_INDUSTRIAL_DUAL_0_20MA_V2_STATUS_LED_CONFIG_ON = 1
  • BRICKLET_INDUSTRIAL_DUAL_0_20MA_V2_STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • BRICKLET_INDUSTRIAL_DUAL_0_20MA_V2_STATUS_LED_CONFIG_SHOW_STATUS = 3
function TBrickletIndustrialDual020mAV2.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 TBrickletIndustrialDual020mAV2.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 TBrickletIndustrialDual020mAV2.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 TBrickletIndustrialDual020mAV2.SetCurrentCallbackConfiguration(const channel: byte; const period: longword; const valueHasToChange: boolean; const option: char; const min: longint; const max: longint)
Parameter:
  • channel – Typ: byte, Wertebereich: [0 bis 1]
  • 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 nA, Wertebereich: [-231 bis 231 - 1], Standardwert: 0
  • max – Typ: longint, Einheit: 1 nA, Wertebereich: [-231 bis 231 - 1], Standardwert: 0

Die Periode ist die Periode mit der der OnCurrent 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 OnCurrent 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_DUAL_0_20MA_V2_THRESHOLD_OPTION_OFF = 'x'
  • BRICKLET_INDUSTRIAL_DUAL_0_20MA_V2_THRESHOLD_OPTION_OUTSIDE = 'o'
  • BRICKLET_INDUSTRIAL_DUAL_0_20MA_V2_THRESHOLD_OPTION_INSIDE = 'i'
  • BRICKLET_INDUSTRIAL_DUAL_0_20MA_V2_THRESHOLD_OPTION_SMALLER = '<'
  • BRICKLET_INDUSTRIAL_DUAL_0_20MA_V2_THRESHOLD_OPTION_GREATER = '>'
procedure TBrickletIndustrialDual020mAV2.GetCurrentCallbackConfiguration(const channel: byte; out period: longword; out valueHasToChange: boolean; out option: char; out min: longint; out max: longint)
Parameter:
  • channel – Typ: byte, Wertebereich: [0 bis 1]
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 nA, Wertebereich: [-231 bis 231 - 1], Standardwert: 0
  • max – Typ: longint, Einheit: 1 nA, Wertebereich: [-231 bis 231 - 1], Standardwert: 0

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

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

Für option:

  • BRICKLET_INDUSTRIAL_DUAL_0_20MA_V2_THRESHOLD_OPTION_OFF = 'x'
  • BRICKLET_INDUSTRIAL_DUAL_0_20MA_V2_THRESHOLD_OPTION_OUTSIDE = 'o'
  • BRICKLET_INDUSTRIAL_DUAL_0_20MA_V2_THRESHOLD_OPTION_INSIDE = 'i'
  • BRICKLET_INDUSTRIAL_DUAL_0_20MA_V2_THRESHOLD_OPTION_SMALLER = '<'
  • BRICKLET_INDUSTRIAL_DUAL_0_20MA_V2_THRESHOLD_OPTION_GREATER = '>'

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

industrialDual020mAV2.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 TBrickletIndustrialDual020mAV2.OnCurrent
procedure(sender: TBrickletIndustrialDual020mAV2; const channel: byte; const current: longint) of object;
Callback-Parameter:
  • sender – Typ: TBrickletIndustrialDual020mAV2
  • channel – Typ: byte, Wertebereich: [0 bis 1]
  • current – Typ: longint, Einheit: 1 nA, Wertebereich: [0 bis 22505322]

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

Der Parameter ist der gleiche wie GetCurrent.

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 TBrickletIndustrialDual020mAV2.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 TBrickletIndustrialDual020mAV2.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_V2_FUNCTION_SET_CURRENT_CALLBACK_CONFIGURATION = 2
  • BRICKLET_INDUSTRIAL_DUAL_0_20MA_V2_FUNCTION_SET_SAMPLE_RATE = 5
  • BRICKLET_INDUSTRIAL_DUAL_0_20MA_V2_FUNCTION_SET_GAIN = 7
  • BRICKLET_INDUSTRIAL_DUAL_0_20MA_V2_FUNCTION_SET_CHANNEL_LED_CONFIG = 9
  • BRICKLET_INDUSTRIAL_DUAL_0_20MA_V2_FUNCTION_SET_CHANNEL_LED_STATUS_CONFIG = 11
  • BRICKLET_INDUSTRIAL_DUAL_0_20MA_V2_FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
  • BRICKLET_INDUSTRIAL_DUAL_0_20MA_V2_FUNCTION_SET_STATUS_LED_CONFIG = 239
  • BRICKLET_INDUSTRIAL_DUAL_0_20MA_V2_FUNCTION_RESET = 243
  • BRICKLET_INDUSTRIAL_DUAL_0_20MA_V2_FUNCTION_WRITE_UID = 248
procedure TBrickletIndustrialDual020mAV2.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_V2_FUNCTION_SET_CURRENT_CALLBACK_CONFIGURATION = 2
  • BRICKLET_INDUSTRIAL_DUAL_0_20MA_V2_FUNCTION_SET_SAMPLE_RATE = 5
  • BRICKLET_INDUSTRIAL_DUAL_0_20MA_V2_FUNCTION_SET_GAIN = 7
  • BRICKLET_INDUSTRIAL_DUAL_0_20MA_V2_FUNCTION_SET_CHANNEL_LED_CONFIG = 9
  • BRICKLET_INDUSTRIAL_DUAL_0_20MA_V2_FUNCTION_SET_CHANNEL_LED_STATUS_CONFIG = 11
  • BRICKLET_INDUSTRIAL_DUAL_0_20MA_V2_FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
  • BRICKLET_INDUSTRIAL_DUAL_0_20MA_V2_FUNCTION_SET_STATUS_LED_CONFIG = 239
  • BRICKLET_INDUSTRIAL_DUAL_0_20MA_V2_FUNCTION_RESET = 243
  • BRICKLET_INDUSTRIAL_DUAL_0_20MA_V2_FUNCTION_WRITE_UID = 248
procedure TBrickletIndustrialDual020mAV2.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 TBrickletIndustrialDual020mAV2.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_DUAL_0_20MA_V2_BOOTLOADER_MODE_BOOTLOADER = 0
  • BRICKLET_INDUSTRIAL_DUAL_0_20MA_V2_BOOTLOADER_MODE_FIRMWARE = 1
  • BRICKLET_INDUSTRIAL_DUAL_0_20MA_V2_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
  • BRICKLET_INDUSTRIAL_DUAL_0_20MA_V2_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
  • BRICKLET_INDUSTRIAL_DUAL_0_20MA_V2_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4

Für status:

  • BRICKLET_INDUSTRIAL_DUAL_0_20MA_V2_BOOTLOADER_STATUS_OK = 0
  • BRICKLET_INDUSTRIAL_DUAL_0_20MA_V2_BOOTLOADER_STATUS_INVALID_MODE = 1
  • BRICKLET_INDUSTRIAL_DUAL_0_20MA_V2_BOOTLOADER_STATUS_NO_CHANGE = 2
  • BRICKLET_INDUSTRIAL_DUAL_0_20MA_V2_BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT = 3
  • BRICKLET_INDUSTRIAL_DUAL_0_20MA_V2_BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT = 4
  • BRICKLET_INDUSTRIAL_DUAL_0_20MA_V2_BOOTLOADER_STATUS_CRC_MISMATCH = 5
function TBrickletIndustrialDual020mAV2.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_DUAL_0_20MA_V2_BOOTLOADER_MODE_BOOTLOADER = 0
  • BRICKLET_INDUSTRIAL_DUAL_0_20MA_V2_BOOTLOADER_MODE_FIRMWARE = 1
  • BRICKLET_INDUSTRIAL_DUAL_0_20MA_V2_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
  • BRICKLET_INDUSTRIAL_DUAL_0_20MA_V2_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
  • BRICKLET_INDUSTRIAL_DUAL_0_20MA_V2_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4
procedure TBrickletIndustrialDual020mAV2.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 TBrickletIndustrialDual020mAV2.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 TBrickletIndustrialDual020mAV2.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 TBrickletIndustrialDual020mAV2.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_DUAL_0_20MA_V2_DEVICE_IDENTIFIER

Diese Konstante wird verwendet um ein Industrial Dual 0-20mA Bricklet 2.0 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_V2_DEVICE_DISPLAY_NAME

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