Delphi/Lazarus - Industrial Digital In 4 Bricklet 2.0¶

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, BrickletIndustrialDigitalIn4V2;
 8
 9type
10  TExample = class
11  private
12    ipcon: TIPConnection;
13    idi4: TBrickletIndustrialDigitalIn4V2;
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 Digital In 4 Bricklet 2.0 }
22
23var
24  e: TExample;
25
26procedure TExample.Execute;
27var value: TArray0To3OfBoolean;
28begin
29  { Create IP connection }
30  ipcon := TIPConnection.Create;
31
32  { Create device object }
33  idi4 := TBrickletIndustrialDigitalIn4V2.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 value }
40  value := idi4.GetValue;
41
42  WriteLn(Format('Channel 0: %d', [value[0]]));
43  WriteLn(Format('Channel 1: %d', [value[1]]));
44  WriteLn(Format('Channel 2: %d', [value[2]]));
45  WriteLn(Format('Channel 3: %d', [value[3]]));
46
47  WriteLn('Press key to exit');
48  ReadLn;
49  ipcon.Destroy; { Calls ipcon.Disconnect internally }
50end;
51
52begin
53  e := TExample.Create;
54  e.Execute;
55  e.Destroy;
56end.

Edge Count¶

Download (ExampleEdgeCount.pas)

 1program ExampleEdgeCount;
 2
 3{$ifdef MSWINDOWS}{$apptype CONSOLE}{$endif}
 4{$ifdef FPC}{$mode OBJFPC}{$H+}{$endif}
 5
 6uses
 7  SysUtils, IPConnection, BrickletIndustrialDigitalIn4V2;
 8
 9type
10  TExample = class
11  private
12    ipcon: TIPConnection;
13    idi4: TBrickletIndustrialDigitalIn4V2;
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 Digital In 4 Bricklet 2.0 }
22
23var
24  e: TExample;
25
26procedure TExample.Execute;
27var i: integer; count: longword;
28begin
29  { Create IP connection }
30  ipcon := TIPConnection.Create;
31
32  { Create device object }
33  idi4 := TBrickletIndustrialDigitalIn4V2.Create(UID, ipcon);
34
35  { Connect to brickd }
36  ipcon.Connect(HOST, PORT);
37  { Don't use device before ipcon is connected }
38
39  { Configure rising edge count (channel 3) with 10ms debounce }
40  idi4.SetEdgeCountConfiguration(3, 0, 10);
41
42  { Get edge count 10 times with 1s delay }
43  for i := 0 to 9 do begin
44    Sleep(1000);
45
46    { Get current edge count }
47    count := idi4.GetEdgeCount(3, false);
48    WriteLn(Format('Count: %d', [count]));
49  end;
50
51  WriteLn('Press key to exit');
52  ReadLn;
53  ipcon.Destroy; { Calls ipcon.Disconnect internally }
54end;
55
56begin
57  e := TExample.Create;
58  e.Execute;
59  e.Destroy;
60end.

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, BrickletIndustrialDigitalIn4V2;
 8
 9type
10  TExample = class
11  private
12    ipcon: TIPConnection;
13    idi4: TBrickletIndustrialDigitalIn4V2;
14  public
15    procedure ValueCB(sender: TBrickletIndustrialDigitalIn4V2; const channel: byte;
16                      const changed: boolean; const value: boolean);
17    procedure Execute;
18  end;
19
20const
21  HOST = 'localhost';
22  PORT = 4223;
23  UID = 'XYZ'; { Change XYZ to the UID of your Industrial Digital In 4 Bricklet 2.0 }
24
25var
26  e: TExample;
27
28{ Callback procedure for value callback }
29procedure TExample.ValueCB(sender: TBrickletIndustrialDigitalIn4V2; const channel: byte;
30                           const changed: boolean; const value: boolean);
31begin
32  if (channel = BRICKLET_INDUSTRIAL_DIGITAL_IN_4_V2_CHANNEL_0) then begin
33    WriteLn('Channel: 0');
34  end
35  else if (channel = BRICKLET_INDUSTRIAL_DIGITAL_IN_4_V2_CHANNEL_1) then begin
36    WriteLn('Channel: 1');
37  end
38  else if (channel = BRICKLET_INDUSTRIAL_DIGITAL_IN_4_V2_CHANNEL_2) then begin
39    WriteLn('Channel: 2');
40  end
41  else if (channel = BRICKLET_INDUSTRIAL_DIGITAL_IN_4_V2_CHANNEL_3) then begin
42    WriteLn('Channel: 3');
43  end;
44
45  WriteLn(Format('Changed: %d', [changed]));
46  WriteLn(Format('Value: %d', [value]));
47  WriteLn('');
48end;
49
50procedure TExample.Execute;
51begin
52  { Create IP connection }
53  ipcon := TIPConnection.Create;
54
55  { Create device object }
56  idi4 := TBrickletIndustrialDigitalIn4V2.Create(UID, ipcon);
57
58  { Connect to brickd }
59  ipcon.Connect(HOST, PORT);
60  { Don't use device before ipcon is connected }
61
62  { Register value callback to procedure ValueCB }
63  idi4.OnValue := {$ifdef FPC}@{$endif}ValueCB;
64
65  { Set period for value (channel 1) callback to 0.1s (100ms) }
66  idi4.SetValueCallbackConfiguration(1, 100, false);
67
68  WriteLn('Press key to exit');
69  ReadLn;
70  ipcon.Destroy; { Calls ipcon.Disconnect internally }
71end;
72
73begin
74  e := TExample.Create;
75  e.Execute;
76  e.Destroy;
77end.

Grundfunktionen¶

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

Parameter:	uid – Typ: string ipcon – Typ: TIPConnection
Rückgabe:	industrialDigitalIn4V2 – Typ: TBrickletIndustrialDigitalIn4V2

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

industrialDigitalIn4V2 := TBrickletIndustrialDigitalIn4V2.Create('YOUR_DEVICE_UID', ipcon);

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

function TBrickletIndustrialDigitalIn4V2.GetValue: array [0..3] of boolean¶

Rückgabe:	value – Typ: array [0..3] of boolean

Gibt die Eingangswerte als Bools zurück, true bedeutet logisch 1 und false logisch 0.

procedure TBrickletIndustrialDigitalIn4V2.SetChannelLEDConfig(const channel: byte; const config: byte)¶

Parameter:	channel – Typ: byte, Wertebereich: Siehe Konstanten 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 ist die LED an wenn ein High-Signal am Kanal anliegt und sonst aus.

Standardmäßig sind die LEDs für alle Kanäle auf Kanalstatus konfiguriert.

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

Für channel:

• BRICKLET_INDUSTRIAL_DIGITAL_IN_4_V2_CHANNEL_0 = 0

• BRICKLET_INDUSTRIAL_DIGITAL_IN_4_V2_CHANNEL_1 = 1

• BRICKLET_INDUSTRIAL_DIGITAL_IN_4_V2_CHANNEL_2 = 2

• BRICKLET_INDUSTRIAL_DIGITAL_IN_4_V2_CHANNEL_3 = 3

Für config:

• BRICKLET_INDUSTRIAL_DIGITAL_IN_4_V2_CHANNEL_LED_CONFIG_OFF = 0

• BRICKLET_INDUSTRIAL_DIGITAL_IN_4_V2_CHANNEL_LED_CONFIG_ON = 1

• BRICKLET_INDUSTRIAL_DIGITAL_IN_4_V2_CHANNEL_LED_CONFIG_SHOW_HEARTBEAT = 2

• BRICKLET_INDUSTRIAL_DIGITAL_IN_4_V2_CHANNEL_LED_CONFIG_SHOW_CHANNEL_STATUS = 3

function TBrickletIndustrialDigitalIn4V2.GetChannelLEDConfig(const channel: byte): byte¶

Parameter:	channel – Typ: byte, Wertebereich: Siehe Konstanten
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 channel:

• BRICKLET_INDUSTRIAL_DIGITAL_IN_4_V2_CHANNEL_0 = 0

• BRICKLET_INDUSTRIAL_DIGITAL_IN_4_V2_CHANNEL_1 = 1

• BRICKLET_INDUSTRIAL_DIGITAL_IN_4_V2_CHANNEL_2 = 2

• BRICKLET_INDUSTRIAL_DIGITAL_IN_4_V2_CHANNEL_3 = 3

Für config:

• BRICKLET_INDUSTRIAL_DIGITAL_IN_4_V2_CHANNEL_LED_CONFIG_OFF = 0

• BRICKLET_INDUSTRIAL_DIGITAL_IN_4_V2_CHANNEL_LED_CONFIG_ON = 1

• BRICKLET_INDUSTRIAL_DIGITAL_IN_4_V2_CHANNEL_LED_CONFIG_SHOW_HEARTBEAT = 2

• BRICKLET_INDUSTRIAL_DIGITAL_IN_4_V2_CHANNEL_LED_CONFIG_SHOW_CHANNEL_STATUS = 3

Fortgeschrittene Funktionen¶

function TBrickletIndustrialDigitalIn4V2.GetEdgeCount(const channel: byte; const resetCounter: boolean): longword¶

Parameter:	channel – Typ: byte, Wertebereich: Siehe Konstanten resetCounter – Typ: boolean
Rückgabe:	count – Typ: longword, Wertebereich: [0 bis 232 - 1]

Gibt den aktuellen Wert des Flankenzählers für den ausgewählten Kanal zurück. Die zu zählenden Flanken können mit SetEdgeCountConfiguration konfiguriert werden.

Wenn reset counter auf true gesetzt wird, wird der Zählerstand direkt nach dem auslesen auf 0 zurückgesetzt.

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

Für channel:

• BRICKLET_INDUSTRIAL_DIGITAL_IN_4_V2_CHANNEL_0 = 0

• BRICKLET_INDUSTRIAL_DIGITAL_IN_4_V2_CHANNEL_1 = 1

• BRICKLET_INDUSTRIAL_DIGITAL_IN_4_V2_CHANNEL_2 = 2

• BRICKLET_INDUSTRIAL_DIGITAL_IN_4_V2_CHANNEL_3 = 3

procedure TBrickletIndustrialDigitalIn4V2.SetEdgeCountConfiguration(const channel: byte; const edgeType: byte; const debounce: byte)¶

Parameter:	channel – Typ: byte, Wertebereich: Siehe Konstanten edgeType – Typ: byte, Wertebereich: Siehe Konstanten, Standardwert: 0 debounce – Typ: byte, Einheit: 1 ms, Wertebereich: [0 bis 255], Standardwert: 100

Konfiguriert den Flankenzähler für einen bestimmten Kanal.

Der edge type Parameter konfiguriert den zu zählenden Flankentyp. Es können steigende, fallende oder beide Flanken gezählt werden. Mögliche Flankentypen sind:

• 0 = steigend

• 1 = fallend

• 2 = beide

Durch das Konfigurieren wird der Wert des Flankenzählers auf 0 zurückgesetzt.

Falls unklar ist was dies alles bedeutet, kann diese Funktion einfach ignoriert werden. Die Standardwerte sind in fast allen Situationen OK.

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

Für channel:

• BRICKLET_INDUSTRIAL_DIGITAL_IN_4_V2_CHANNEL_0 = 0

• BRICKLET_INDUSTRIAL_DIGITAL_IN_4_V2_CHANNEL_1 = 1

• BRICKLET_INDUSTRIAL_DIGITAL_IN_4_V2_CHANNEL_2 = 2

• BRICKLET_INDUSTRIAL_DIGITAL_IN_4_V2_CHANNEL_3 = 3

Für edgeType:

• BRICKLET_INDUSTRIAL_DIGITAL_IN_4_V2_EDGE_TYPE_RISING = 0

• BRICKLET_INDUSTRIAL_DIGITAL_IN_4_V2_EDGE_TYPE_FALLING = 1

• BRICKLET_INDUSTRIAL_DIGITAL_IN_4_V2_EDGE_TYPE_BOTH = 2

procedure TBrickletIndustrialDigitalIn4V2.GetEdgeCountConfiguration(const channel: byte; out edgeType: byte; out debounce: byte)¶

Parameter:	channel – Typ: byte, Wertebereich: Siehe Konstanten
Ausgabeparameter:	edgeType – Typ: byte, Wertebereich: Siehe Konstanten, Standardwert: 0 debounce – Typ: byte, Einheit: 1 ms, Wertebereich: [0 bis 255], Standardwert: 100

Gibt den Flankentyp sowie die Entprellzeit für den ausgewählten Kanals zurück, wie von SetEdgeCountConfiguration gesetzt.

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

Für channel:

• BRICKLET_INDUSTRIAL_DIGITAL_IN_4_V2_CHANNEL_0 = 0

• BRICKLET_INDUSTRIAL_DIGITAL_IN_4_V2_CHANNEL_1 = 1

• BRICKLET_INDUSTRIAL_DIGITAL_IN_4_V2_CHANNEL_2 = 2

• BRICKLET_INDUSTRIAL_DIGITAL_IN_4_V2_CHANNEL_3 = 3

Für edgeType:

• BRICKLET_INDUSTRIAL_DIGITAL_IN_4_V2_EDGE_TYPE_RISING = 0

• BRICKLET_INDUSTRIAL_DIGITAL_IN_4_V2_EDGE_TYPE_FALLING = 1

• BRICKLET_INDUSTRIAL_DIGITAL_IN_4_V2_EDGE_TYPE_BOTH = 2

procedure TBrickletIndustrialDigitalIn4V2.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 TBrickletIndustrialDigitalIn4V2.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_DIGITAL_IN_4_V2_STATUS_LED_CONFIG_OFF = 0

• BRICKLET_INDUSTRIAL_DIGITAL_IN_4_V2_STATUS_LED_CONFIG_ON = 1

• BRICKLET_INDUSTRIAL_DIGITAL_IN_4_V2_STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2

• BRICKLET_INDUSTRIAL_DIGITAL_IN_4_V2_STATUS_LED_CONFIG_SHOW_STATUS = 3

function TBrickletIndustrialDigitalIn4V2.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_DIGITAL_IN_4_V2_STATUS_LED_CONFIG_OFF = 0

• BRICKLET_INDUSTRIAL_DIGITAL_IN_4_V2_STATUS_LED_CONFIG_ON = 1

• BRICKLET_INDUSTRIAL_DIGITAL_IN_4_V2_STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2

• BRICKLET_INDUSTRIAL_DIGITAL_IN_4_V2_STATUS_LED_CONFIG_SHOW_STATUS = 3

function TBrickletIndustrialDigitalIn4V2.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 TBrickletIndustrialDigitalIn4V2.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 TBrickletIndustrialDigitalIn4V2.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 TBrickletIndustrialDigitalIn4V2.SetValueCallbackConfiguration(const channel: byte; const period: longword; const valueHasToChange: boolean)¶

Parameter:	channel – Typ: byte, Wertebereich: Siehe Konstanten period – Typ: longword, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0 valueHasToChange – Typ: boolean, Standardwert: false

Dieser Callback kann pro Kanal konfiguriert werden.

Die Periode ist die Periode mit der der OnValue 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.

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

Für channel:

• BRICKLET_INDUSTRIAL_DIGITAL_IN_4_V2_CHANNEL_0 = 0

• BRICKLET_INDUSTRIAL_DIGITAL_IN_4_V2_CHANNEL_1 = 1

• BRICKLET_INDUSTRIAL_DIGITAL_IN_4_V2_CHANNEL_2 = 2

• BRICKLET_INDUSTRIAL_DIGITAL_IN_4_V2_CHANNEL_3 = 3

procedure TBrickletIndustrialDigitalIn4V2.GetValueCallbackConfiguration(const channel: byte; out period: longword; out valueHasToChange: boolean)¶

Parameter:	channel – Typ: byte, Wertebereich: Siehe Konstanten
Ausgabeparameter:	period – Typ: longword, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0 valueHasToChange – Typ: boolean, Standardwert: false

Gibt die Callback-Konfiguration für den gegebenen Kanal zurück, wie mittels SetValueCallbackConfiguration gesetzt.

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

Für channel:

• BRICKLET_INDUSTRIAL_DIGITAL_IN_4_V2_CHANNEL_0 = 0

• BRICKLET_INDUSTRIAL_DIGITAL_IN_4_V2_CHANNEL_1 = 1

• BRICKLET_INDUSTRIAL_DIGITAL_IN_4_V2_CHANNEL_2 = 2

• BRICKLET_INDUSTRIAL_DIGITAL_IN_4_V2_CHANNEL_3 = 3

procedure TBrickletIndustrialDigitalIn4V2.SetAllValueCallbackConfiguration(const period: longword; const valueHasToChange: boolean)¶

Parameter:	period – Typ: longword, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0 valueHasToChange – Typ: boolean, Standardwert: false

Die Periode ist die Periode mit der der OnAllValue 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.

procedure TBrickletIndustrialDigitalIn4V2.GetAllValueCallbackConfiguration(out period: longword; out valueHasToChange: boolean)¶

Ausgabeparameter:	period – Typ: longword, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0 valueHasToChange – Typ: boolean, Standardwert: false

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

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

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

property TBrickletIndustrialDigitalIn4V2.OnValue¶

procedure(sender: TBrickletIndustrialDigitalIn4V2; const channel: byte; const changed: boolean; const value: boolean) of object;

Callback-Parameter:	sender – Typ: TBrickletIndustrialDigitalIn4V2 channel – Typ: byte, Wertebereich: Siehe Konstanten changed – Typ: boolean value – Typ: boolean

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

Die Parameter sind der Kanal, Changed und der Wert. Der changed-Parameter ist True wenn sich der Wert seit dem letzten Callback geändert hat.

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

Für channel:

• BRICKLET_INDUSTRIAL_DIGITAL_IN_4_V2_CHANNEL_0 = 0

• BRICKLET_INDUSTRIAL_DIGITAL_IN_4_V2_CHANNEL_1 = 1

• BRICKLET_INDUSTRIAL_DIGITAL_IN_4_V2_CHANNEL_2 = 2

• BRICKLET_INDUSTRIAL_DIGITAL_IN_4_V2_CHANNEL_3 = 3

property TBrickletIndustrialDigitalIn4V2.OnAllValue¶

procedure(sender: TBrickletIndustrialDigitalIn4V2; const changed: array [0..3] of boolean; const value: array [0..3] of boolean) of object;

Callback-Parameter:	sender – Typ: TBrickletIndustrialDigitalIn4V2 changed – Typ: array [0..3] of boolean value – Typ: array [0..3] of boolean

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

Die Parameter sind der gleiche wie GetValue. Zusätzlich ist der changed-Parameter True wenn sich der Wert seit dem letzten Callback geändert hat.

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 TBrickletIndustrialDigitalIn4V2.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 TBrickletIndustrialDigitalIn4V2.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_DIGITAL_IN_4_V2_FUNCTION_SET_VALUE_CALLBACK_CONFIGURATION = 2

• BRICKLET_INDUSTRIAL_DIGITAL_IN_4_V2_FUNCTION_SET_ALL_VALUE_CALLBACK_CONFIGURATION = 4

• BRICKLET_INDUSTRIAL_DIGITAL_IN_4_V2_FUNCTION_SET_EDGE_COUNT_CONFIGURATION = 7

• BRICKLET_INDUSTRIAL_DIGITAL_IN_4_V2_FUNCTION_SET_CHANNEL_LED_CONFIG = 9

• BRICKLET_INDUSTRIAL_DIGITAL_IN_4_V2_FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237

• BRICKLET_INDUSTRIAL_DIGITAL_IN_4_V2_FUNCTION_SET_STATUS_LED_CONFIG = 239

• BRICKLET_INDUSTRIAL_DIGITAL_IN_4_V2_FUNCTION_RESET = 243

• BRICKLET_INDUSTRIAL_DIGITAL_IN_4_V2_FUNCTION_WRITE_UID = 248

procedure TBrickletIndustrialDigitalIn4V2.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_DIGITAL_IN_4_V2_FUNCTION_SET_VALUE_CALLBACK_CONFIGURATION = 2

• BRICKLET_INDUSTRIAL_DIGITAL_IN_4_V2_FUNCTION_SET_ALL_VALUE_CALLBACK_CONFIGURATION = 4

• BRICKLET_INDUSTRIAL_DIGITAL_IN_4_V2_FUNCTION_SET_EDGE_COUNT_CONFIGURATION = 7

• BRICKLET_INDUSTRIAL_DIGITAL_IN_4_V2_FUNCTION_SET_CHANNEL_LED_CONFIG = 9

• BRICKLET_INDUSTRIAL_DIGITAL_IN_4_V2_FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237

• BRICKLET_INDUSTRIAL_DIGITAL_IN_4_V2_FUNCTION_SET_STATUS_LED_CONFIG = 239

• BRICKLET_INDUSTRIAL_DIGITAL_IN_4_V2_FUNCTION_RESET = 243

• BRICKLET_INDUSTRIAL_DIGITAL_IN_4_V2_FUNCTION_WRITE_UID = 248

procedure TBrickletIndustrialDigitalIn4V2.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 TBrickletIndustrialDigitalIn4V2.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_DIGITAL_IN_4_V2_BOOTLOADER_MODE_BOOTLOADER = 0

• BRICKLET_INDUSTRIAL_DIGITAL_IN_4_V2_BOOTLOADER_MODE_FIRMWARE = 1

• BRICKLET_INDUSTRIAL_DIGITAL_IN_4_V2_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2

• BRICKLET_INDUSTRIAL_DIGITAL_IN_4_V2_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3

• BRICKLET_INDUSTRIAL_DIGITAL_IN_4_V2_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4

Für status:

• BRICKLET_INDUSTRIAL_DIGITAL_IN_4_V2_BOOTLOADER_STATUS_OK = 0

• BRICKLET_INDUSTRIAL_DIGITAL_IN_4_V2_BOOTLOADER_STATUS_INVALID_MODE = 1

• BRICKLET_INDUSTRIAL_DIGITAL_IN_4_V2_BOOTLOADER_STATUS_NO_CHANGE = 2

• BRICKLET_INDUSTRIAL_DIGITAL_IN_4_V2_BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT = 3

• BRICKLET_INDUSTRIAL_DIGITAL_IN_4_V2_BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT = 4

• BRICKLET_INDUSTRIAL_DIGITAL_IN_4_V2_BOOTLOADER_STATUS_CRC_MISMATCH = 5

function TBrickletIndustrialDigitalIn4V2.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_DIGITAL_IN_4_V2_BOOTLOADER_MODE_BOOTLOADER = 0

• BRICKLET_INDUSTRIAL_DIGITAL_IN_4_V2_BOOTLOADER_MODE_FIRMWARE = 1

• BRICKLET_INDUSTRIAL_DIGITAL_IN_4_V2_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2

• BRICKLET_INDUSTRIAL_DIGITAL_IN_4_V2_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3

• BRICKLET_INDUSTRIAL_DIGITAL_IN_4_V2_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4

procedure TBrickletIndustrialDigitalIn4V2.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 TBrickletIndustrialDigitalIn4V2.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 TBrickletIndustrialDigitalIn4V2.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 TBrickletIndustrialDigitalIn4V2.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_DIGITAL_IN_4_V2_DEVICE_IDENTIFIER¶

Diese Konstante wird verwendet um ein Industrial Digital In 4 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_DIGITAL_IN_4_V2_DEVICE_DISPLAY_NAME¶

Diese Konstante stellt den Anzeigenamen eines Industrial Digital In 4 Bricklet 2.0 dar.