Deutsch
English
Menu
Software / API Bindings / Delphi/Lazarus / API Referenz und Beispiele / Bricks / ESP32 Ethernet Brick

Delphi/Lazarus - ESP32 Ethernet Brick

Dies ist die Beschreibung der Delphi/Lazarus API Bindings für den ESP32 Ethernet Brick. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des ESP32 Ethernet Brick sind in dessen Hardware Beschreibung zusammengefasst.

Eine Installationanleitung für die Delphi/Lazarus API Bindings ist Teil deren allgemeine Beschreibung.

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.

Fortgeschrittene Funktionen

procedure TBrickESP32Ethernet.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: ['0' bis '8']
  • 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 der Brick verbunden ist, die Position, die Hard- und Firmware Version sowie den Device Identifier zurück.

Die Position ist die Position im Stack von '0' (unterster Brick) bis '8' (oberster Brick).

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

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 TBrickESP32Ethernet.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 TBrickESP32Ethernet.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:

procedure TBrickESP32Ethernet.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:

procedure TBrickESP32Ethernet.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 BRICK_ESP32_ETHERNET_DEVICE_IDENTIFIER

Diese Konstante wird verwendet um einen ESP32 Ethernet Brick 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 BRICK_ESP32_ETHERNET_DEVICE_DISPLAY_NAME

Diese Konstante stellt den Anzeigenamen eines ESP32 Ethernet Brick dar.