Delphi/Lazarus - IO-4 Bricklet 2.0

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

Output

Download (ExampleOutput.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
program ExampleOutput;

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

uses
  SysUtils, IPConnection, BrickletIO4V2;

type
  TExample = class
  private
    ipcon: TIPConnection;
    io: TBrickletIO4V2;
  public
    procedure Execute;
  end;

const
  HOST = 'localhost';
  PORT = 4223;
  UID = 'XYZ'; { Change XYZ to the UID of your IO-4 Bricklet 2.0 }

var
  e: TExample;

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

  { Create device object }
  io := TBrickletIO4V2.Create(UID, ipcon);

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

  { Configure channel 3 as output low }
  io.SetConfiguration(3, 'o', false);

  { Set channel 3 alternating high/low 10 times with 100 ms delay }
  for i := 0 to 9 do begin
    Sleep(100);
    io.SetSelectedValue(3, true);
    Sleep(100);
    io.SetSelectedValue(3, false);
  end;

  WriteLn('Press key to exit');
  ReadLn;
  ipcon.Destroy; { Calls ipcon.Disconnect internally }
end;

begin
  e := TExample.Create;
  e.Execute;
  e.Destroy;
end.

Interrupt

Download (ExampleInterrupt.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 ExampleInterrupt;

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

uses
  SysUtils, IPConnection, BrickletIO4V2;

type
  TExample = class
  private
    ipcon: TIPConnection;
    io: TBrickletIO4V2;
  public
    procedure InputValueCB(sender: TBrickletIO4V2; const channel: byte;
                           const changed: boolean; const value: boolean);
    procedure Execute;
  end;

const
  HOST = 'localhost';
  PORT = 4223;
  UID = 'XYZ'; { Change XYZ to the UID of your IO-4 Bricklet 2.0 }

var
  e: TExample;

{ Callback procedure for input value callback }
procedure TExample.InputValueCB(sender: TBrickletIO4V2; const channel: byte;
                                const changed: boolean; const value: boolean);
begin
  WriteLn(Format('Channel: %d', [channel]));
  WriteLn(Format('Changed: %d', [changed]));
  WriteLn(Format('Value: %d', [value]));
  WriteLn('');
end;

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

  { Create device object }
  io := TBrickletIO4V2.Create(UID, ipcon);

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

  { Register input value callback to procedure InputValueCB }
  io.OnInputValue := {$ifdef FPC}@{$endif}InputValueCB;

  { Set period for input value (channel 1) callback to 0.5s (500ms) }
  io.SetInputValueCallbackConfiguration(1, 500, false);

  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 TBrickletIO4V2.Create(const uid: string; ipcon: TIPConnection)

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

io4V2 := TBrickletIO4V2.Create('YOUR_DEVICE_UID', ipcon);

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

procedure TBrickletIO4V2.SetValue(const value: array [0..3] of boolean)

Setzt den Zustand aller vier Kanäle. Der Wert true bzw. false erzeugen logisch 1 bzw. logisch 0 auf dem entsprechenden Kanal.

Mit der Funktionen SetSelectedValue können einzelnen Kanäle gesetzt werden.

Beispiel: (True, True, False, False) setzt die Kanäle 0-1 auf logisch 1 und die Kanäle 2-3 auf logisch 0.

Alle laufenden Monoflop Timer und PWMs werden abgebrochen, wenn diese Funktion aufgerufen wird.

Bemerkung

Diese Funktion bewirkt keine Änderung an Kanälen die als Eingang konfiguriert sind. Pull-Up Widerstände können mit SetConfiguration zugeschaltet werden.

function TBrickletIO4V2.GetValue: array [0..3] of boolean

Gibt die aktuell gemessenen Zustände zurück. Diese Funktion gibt die Zustände aller Kanäle zurück, unabhängig ob diese als Ein- oder Ausgang konfiguriert sind.

procedure TBrickletIO4V2.SetSelectedValue(const channel: byte; const value: boolean)

Setzt den Ausgabewert des ausgewählte Kanals ohne die anderen Kanäle zu beeinflussen.

Ein laufender Monoflop Timer oder PWM für den ausgewählten Kanal wird abgebrochen, wenn diese Funktion aufgerufen wird.

Bemerkung

Diese Funktion bewirkt keine Änderung an Kanälen die als Eingang konfiguriert sind. Pull-Up Widerstände können mit SetConfiguration zugeschaltet werden.

procedure TBrickletIO4V2.SetConfiguration(const channel: byte; const direction: char; const value: boolean)

Konfiguriert den Zustand und die Richtung eines angegebenen Kanals. Mögliche Richtungen sind 'i' und 'o' für Ein- und Ausgang.

Wenn die Richtung als Ausgang konfiguriert ist, ist der Zustand entweder logisch 1 oder logisch 0 (gesetzt als true oder false).

Wenn die Richtung als Eingang konfiguriert ist, ist der Zustand entweder Pull-Up oder Standard (gesetzt als true oder false).

Beispiele:

  • (0, 'i', true) setzt Kanal 0 als Eingang mit Pull-Up.
  • (1, 'i', false) setzt Kanal 1 als Standard Eingang (potentialfrei wenn nicht verbunden).
  • (2, 'o', true) setzt Kanal 2 als Ausgang im Zustand logisch 1.
  • (3, 'o', false) setzt Kanal 3 als Ausgang im Zustand logisch 0.

Ein laufender Monoflop Timer oder PWM für den angegebenen Kanal wird abgebrochen, wenn diese Funktion aufgerufen wird.

Die Standardkonfiguration ist Eingang mit Pull-Up.

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

  • BRICKLET_IO4_V2_DIRECTION_IN = 'i'
  • BRICKLET_IO4_V2_DIRECTION_OUT = 'o'
procedure TBrickletIO4V2.GetConfiguration(const channel: byte; out direction: char; out value: boolean)

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

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

  • BRICKLET_IO4_V2_DIRECTION_IN = 'i'
  • BRICKLET_IO4_V2_DIRECTION_OUT = 'o'

Fortgeschrittene Funktionen

procedure TBrickletIO4V2.SetMonoflop(const channel: byte; const value: boolean; const time: longword)

Der erste Parameter ist der gewünschte Zustand des Kanals (true bedeutet high und false low). Der zweite Parameter stellt die Zeit (in ms) dar, in welcher der Kanal den Zustand halten soll.

Wenn diese Funktion mit den Parametern (true, 1500) aufgerufen wird: Der Kanal wird angeschaltet und nach 1,5s wieder ausgeschaltet.

Ein PWM für den ausgewählten Kanal wird abgebrochen, wenn diese Funktion aufgerufen wird.

Ein Monoflop kann als Ausfallsicherung verwendet werden. Beispiel: Angenommen ein RS485 Bus und ein IO-4 Bricklet 2.0 ist an ein Slave Stapel verbunden. Jetzt kann diese Funktion sekündlich, mit einem Zeitparameter von 2 Sekunden, aufgerufen werden. Der Kanal wird die gesamte Zeit eingeschaltet sein. Wenn jetzt die RS485 Verbindung getrennt wird, wird der Kanal nach spätestens zwei Sekunden ausschalten.

procedure TBrickletIO4V2.GetMonoflop(const channel: byte; out value: boolean; out time: longword; out timeRemaining: longword)

Gibt (für den angegebenen Kanal) den aktuellen Zustand und die Zeit, wie von SetMonoflop gesetzt, sowie die noch verbleibende Zeit bis zum Zustandswechsel, zurück.

Wenn der Timer aktuell nicht läuft, ist die noch verbleibende Zeit 0.

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

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.

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

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 für Kanäle die als Eingang konfiguriert sind. Mögliche Flankentypen sind:

  • 0 = steigend (Standard)
  • 1 = fallend
  • 2 = beide

Die Entprellzeit (debounce) wird in ms angegeben.

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.

Standardwerte: 0 (edge type) und 100ms (debounce).

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

  • BRICKLET_IO4_V2_EDGE_TYPE_RISING = 0
  • BRICKLET_IO4_V2_EDGE_TYPE_FALLING = 1
  • BRICKLET_IO4_V2_EDGE_TYPE_BOTH = 2
procedure TBrickletIO4V2.GetEdgeCountConfiguration(const channel: byte; out edgeType: byte; out debounce: byte)

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

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

  • BRICKLET_IO4_V2_EDGE_TYPE_RISING = 0
  • BRICKLET_IO4_V2_EDGE_TYPE_FALLING = 1
  • BRICKLET_IO4_V2_EDGE_TYPE_BOTH = 2
procedure TBrickletIO4V2.SetPWMConfiguration(const channel: byte; const frequency: longword; const dutyCycle: word)

Aktiviert ein PWM auf dem angegebenen Kanal. Die Frequenz wird in 1/10Hz angegeben und die Duty Cycle in 1/100%.

Bevor diese Funktion aufgerufen wird, muss der Kanal als Ausgabe konfiguriert werden, ansonsten wird der Aufruf ignoriert. Um die PWM wieder auszustellen, kann die Frequenz auf 0 gesetzt werden oder eine andere Funktion aufgerufen werden die Einstellungen am Kanal verändert (z.B. SetSelectedValue).

Der maximale Frequenzwert beträgt 320000000 (32MHz). Der Maximale Duty Cycle-Wert beträgt 10000 (100%).

Ein laufender Monoflop Timer für den angegebenen Kanal wird abgebrochen, wenn diese Funktion aufgerufen wird.

Die Standardwerte sind 0, 0.

procedure TBrickletIO4V2.GetPWMConfiguration(const channel: byte; out frequency: longword; out dutyCycle: word)

Gibt die PWM Konfiguration zurück, wie von SetPWMConfiguration gesetzt.

function TBrickletIO4V2.GetAPIVersion: array [0..2] of byte

Gibt die Version der API Definition (Major, Minor, Revision) zurück, die diese API Bindings implementieren. Dies ist weder die Release-Version dieser API Bindings noch gibt es in irgendeiner Weise Auskunft über den oder das repräsentierte(n) Brick oder Bricklet.

function TBrickletIO4V2.GetResponseExpected(const functionId: byte): boolean

Gibt das Response-Expected-Flag für die Funktion mit der angegebenen Funktions IDs zurück. Es ist true falls für die Funktion beim Aufruf eine Antwort erwartet wird, false andernfalls.

Für Getter-Funktionen ist diese Flag immer gesetzt und kann nicht entfernt werden, da diese Funktionen immer eine Antwort senden. Für Konfigurationsfunktionen für Callbacks ist es standardmäßig gesetzt, kann aber entfernt werden mittels SetResponseExpected. Für Setter-Funktionen ist es standardmäßig nicht gesetzt, kann aber gesetzt werden.

Wenn das Response-Expected-Flag für eine Setter-Funktion gesetzt ist, können Timeouts und andere Fehlerfälle auch für Aufrufe dieser Setter-Funktion detektiert werden. Das Gerät sendet dann eine Antwort extra für diesen Zweck. Wenn das Flag für eine Setter-Funktion nicht gesetzt ist, dann wird keine Antwort vom Gerät gesendet und Fehler werden stillschweigend ignoriert, da sie nicht detektiert werden können.

Siehe SetResponseExpected für die Liste der verfügbaren Funktions ID Konstanten für diese Funktion.

procedure TBrickletIO4V2.SetResponseExpected(const functionId: byte; const responseExpected: boolean)

Ändert das Response-Expected-Flag für die Funktion mit der angegebenen Funktion IDs. Diese Flag kann nur für Setter-Funktionen (Standardwert: false) und Konfigurationsfunktionen für Callbacks (Standardwert: true) geändert werden. Für Getter-Funktionen ist das Flag immer gesetzt.

Wenn das Response-Expected-Flag für eine Setter-Funktion gesetzt ist, können Timeouts und andere Fehlerfälle auch für Aufrufe dieser Setter-Funktion detektiert werden. Das Gerät sendet dann eine Antwort extra für diesen Zweck. Wenn das Flag für eine Setter-Funktion nicht gesetzt ist, dann wird keine Antwort vom Gerät gesendet und Fehler werden stillschweigend ignoriert, da sie nicht detektiert werden können.

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

  • BRICKLET_IO4_V2_FUNCTION_SET_VALUE = 1
  • BRICKLET_IO4_V2_FUNCTION_SET_SELECTED_VALUE = 3
  • BRICKLET_IO4_V2_FUNCTION_SET_CONFIGURATION = 4
  • BRICKLET_IO4_V2_FUNCTION_SET_INPUT_VALUE_CALLBACK_CONFIGURATION = 6
  • BRICKLET_IO4_V2_FUNCTION_SET_ALL_INPUT_VALUE_CALLBACK_CONFIGURATION = 8
  • BRICKLET_IO4_V2_FUNCTION_SET_MONOFLOP = 10
  • BRICKLET_IO4_V2_FUNCTION_SET_EDGE_COUNT_CONFIGURATION = 13
  • BRICKLET_IO4_V2_FUNCTION_SET_PWM_CONFIGURATION = 15
  • BRICKLET_IO4_V2_FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
  • BRICKLET_IO4_V2_FUNCTION_SET_STATUS_LED_CONFIG = 239
  • BRICKLET_IO4_V2_FUNCTION_RESET = 243
  • BRICKLET_IO4_V2_FUNCTION_WRITE_UID = 248
procedure TBrickletIO4V2.SetResponseExpectedAll(const responseExpected: boolean)

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

procedure TBrickletIO4V2.GetSPITFPErrorCount(out errorCountAckChecksum: longword; out errorCountMessageChecksum: longword; out errorCountFrame: longword; out errorCountOverflow: longword)

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.

function TBrickletIO4V2.SetBootloaderMode(const mode: byte): byte

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 Bootlodaer- 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:

  • BRICKLET_IO4_V2_BOOTLOADER_MODE_BOOTLOADER = 0
  • BRICKLET_IO4_V2_BOOTLOADER_MODE_FIRMWARE = 1
  • BRICKLET_IO4_V2_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
  • BRICKLET_IO4_V2_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
  • BRICKLET_IO4_V2_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4
  • BRICKLET_IO4_V2_BOOTLOADER_STATUS_OK = 0
  • BRICKLET_IO4_V2_BOOTLOADER_STATUS_INVALID_MODE = 1
  • BRICKLET_IO4_V2_BOOTLOADER_STATUS_NO_CHANGE = 2
  • BRICKLET_IO4_V2_BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT = 3
  • BRICKLET_IO4_V2_BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT = 4
  • BRICKLET_IO4_V2_BOOTLOADER_STATUS_CRC_MISMATCH = 5
function TBrickletIO4V2.GetBootloaderMode: byte

Gibt den aktuellen Bootloader-Modus zurück, siehe SetBootloaderMode.

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

  • BRICKLET_IO4_V2_BOOTLOADER_MODE_BOOTLOADER = 0
  • BRICKLET_IO4_V2_BOOTLOADER_MODE_FIRMWARE = 1
  • BRICKLET_IO4_V2_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
  • BRICKLET_IO4_V2_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
  • BRICKLET_IO4_V2_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4
procedure TBrickletIO4V2.SetWriteFirmwarePointer(const pointer: longword)

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 TBrickletIO4V2.WriteFirmware(const data: array [0..63] of byte): byte

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 TBrickletIO4V2.SetStatusLEDConfig(const config: byte)

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:

  • BRICKLET_IO4_V2_STATUS_LED_CONFIG_OFF = 0
  • BRICKLET_IO4_V2_STATUS_LED_CONFIG_ON = 1
  • BRICKLET_IO4_V2_STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • BRICKLET_IO4_V2_STATUS_LED_CONFIG_SHOW_STATUS = 3
function TBrickletIO4V2.GetStatusLEDConfig: byte

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

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

  • BRICKLET_IO4_V2_STATUS_LED_CONFIG_OFF = 0
  • BRICKLET_IO4_V2_STATUS_LED_CONFIG_ON = 1
  • BRICKLET_IO4_V2_STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • BRICKLET_IO4_V2_STATUS_LED_CONFIG_SHOW_STATUS = 3
function TBrickletIO4V2.GetChipTemperature: smallint

Gibt die Temperatur in °C, 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 TBrickletIO4V2.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 TBrickletIO4V2.WriteUID(const uid: longword)

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 TBrickletIO4V2.ReadUID: longword

Gibt die aktuelle UID als Integer zurück. Dieser Integer kann als Base58 encodiert werden um an den üblichen UID-String zu gelangen.

procedure TBrickletIO4V2.GetIdentity(out uid: string; out connectedUid: string; out position: char; out hardwareVersion: array [0..2] of byte; out firmwareVersion: array [0..2] of byte; out deviceIdentifier: word)

Gibt die UID, die UID zu der das Bricklet verbunden ist, die Position, die Hard- und Firmware Version sowie den Device Identifier zurück.

Die Position kann 'a', 'b', 'c' oder 'd' sein.

Eine Liste der Device Identifier Werte ist hier zu finden. Es gibt auch eine Konstante für den Device Identifier dieses Bricklet.

Konfigurationsfunktionen für Callbacks

procedure TBrickletIO4V2.SetInputValueCallbackConfiguration(const channel: byte; const period: longword; const valueHasToChange: boolean)

Dieser Callback kann pro Kanal konfiguriert werden.

Die Periode in ms ist die Periode mit der der OnInputValue 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.

Der Standardwert ist (0, false).

procedure TBrickletIO4V2.GetInputValueCallbackConfiguration(const channel: byte; out period: longword; out valueHasToChange: boolean)

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

procedure TBrickletIO4V2.SetAllInputValueCallbackConfiguration(const period: longword; const valueHasToChange: boolean)

Die Periode in ms ist die Periode mit der der OnAllInputValue 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.

Der Standardwert ist (0, false).

procedure TBrickletIO4V2.GetAllInputValueCallbackConfiguration(out period: longword; out valueHasToChange: boolean)

Gibt die Callback-Konfiguration zurück, wie mittels SetAllInputValueCallbackConfiguration 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: TBrickletIO4V2; const param: word);
begin
  WriteLn(param);
end;

io4V2.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 TBrickletIO4V2.OnInputValue
procedure(sender: TBrickletIO4V2; const channel: byte; const changed: boolean; const value: boolean) of object;

Dieser Callback wird periodisch ausgelöst abhängig von der mittels SetInputValueCallbackConfiguration 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.

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

Dieser Callback wird periodisch ausgelöst abhängig von der mittels SetAllInputValueCallbackConfiguration 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.

property TBrickletIO4V2.OnMonoflopDone
procedure(sender: TBrickletIO4V2; const channel: byte; const value: boolean) of object;

Dieser Callback wird ausgelöst wenn ein Monoflop Timer abläuft (0 erreicht). Parameter enthalten den Kanal und den aktuellen Zustand des Kanals (der Zustand nach dem Monoflop).

Konstanten

const BRICKLET_IO4_V2_DEVICE_IDENTIFIER

Diese Konstante wird verwendet um ein IO-4 Bricklet 2.0 zu identifizieren.

Die GetIdentity Funktion und der OnEnumerate Callback der IP Connection haben ein deviceIdentifier Parameter um den Typ des Bricks oder Bricklets anzugeben.

const BRICKLET_IO4_V2_DEVICE_DISPLAY_NAME

Diese Konstante stellt den Anzeigenamen eines IO-4 Bricklet 2.0 dar.