Delphi/Lazarus - Industrial Analog Out Bricklet

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

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

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

uses
  SysUtils, IPConnection, BrickletIndustrialAnalogOut;

type
  TExample = class
  private
    ipcon: TIPConnection;
    iao: TBrickletIndustrialAnalogOut;
  public
    procedure Execute;
  end;

const
  HOST = 'localhost';
  PORT = 4223;
  UID = 'XYZ'; { Change XYZ to the UID of your Industrial Analog Out Bricklet }

var
  e: TExample;

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

  { Create device object }
  iao := TBrickletIndustrialAnalogOut.Create(UID, ipcon);

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

  { Set output current to 4.5mA }
  iao.SetCurrent(4500);
  iao.Enable;

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

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

Simple Voltage

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

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

uses
  SysUtils, IPConnection, BrickletIndustrialAnalogOut;

type
  TExample = class
  private
    ipcon: TIPConnection;
    iao: TBrickletIndustrialAnalogOut;
  public
    procedure Execute;
  end;

const
  HOST = 'localhost';
  PORT = 4223;
  UID = 'XYZ'; { Change XYZ to the UID of your Industrial Analog Out Bricklet }

var
  e: TExample;

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

  { Create device object }
  iao := TBrickletIndustrialAnalogOut.Create(UID, ipcon);

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

  { Set output voltage to 3.3V }
  iao.SetVoltage(3300);
  iao.Enable;

  WriteLn('Press key to exit');
  ReadLn;
  iao.Disable;
  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 TBrickletIndustrialAnalogOut.Create(const uid: string; ipcon: TIPConnection)
Parameter:
  • uid – Typ: string
  • ipcon – Typ: TIPConnection
Rückgabe:
  • industrialAnalogOut – Typ: TBrickletIndustrialAnalogOut

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

industrialAnalogOut := TBrickletIndustrialAnalogOut.Create('YOUR_DEVICE_UID', ipcon);

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

procedure TBrickletIndustrialAnalogOut.Enable

Aktiviert die Ausgabe von Spannung und Strom.

Der Standardwert ist deaktiviert.

procedure TBrickletIndustrialAnalogOut.Disable

Deaktiviert die Ausgabe von Spannung und Strom.

Der Standardwert ist deaktiviert.

function TBrickletIndustrialAnalogOut.IsEnabled: boolean
Rückgabe:
  • enabled – Typ: boolean, Standardwert: false

Gibt true zurück falls die Ausgabe von Spannung und Strom aktiviert ist, false sonst.

procedure TBrickletIndustrialAnalogOut.SetVoltage(const voltage: word)
Parameter:
  • voltage – Typ: word, Einheit: 1 mV, Wertebereich: [0 bis 10000]

Setzt die Ausgangsspannung.

Die Ausgangsspannung und der Ausgangsstrom sind gekoppelt. Eine Änderung der Ausgangsspannung führt auch zu einer Änderung des Ausgangsstroms.

function TBrickletIndustrialAnalogOut.GetVoltage: word
Rückgabe:
  • voltage – Typ: word, Einheit: 1 mV, Wertebereich: [0 bis 10000]

Gibt die Spannung zurück, wie von SetVoltage gesetzt.

procedure TBrickletIndustrialAnalogOut.SetCurrent(const current: word)
Parameter:
  • current – Typ: word, Einheit: 1 µA, Wertebereich: [0 bis 24000]

Setzt den Ausgangsstrom.

Der Ausgangsstrom und die Ausgangsspannung sind gekoppelt. Eine Änderung des Ausgangsstroms führt auch zu einer Änderung der Ausgangsspannung.

function TBrickletIndustrialAnalogOut.GetCurrent: word
Rückgabe:
  • current – Typ: word, Einheit: 1 µA, Wertebereich: [0 bis 24000]

Gibt die Spannung zurück, wie von SetCurrent gesetzt.

Fortgeschrittene Funktionen

procedure TBrickletIndustrialAnalogOut.SetConfiguration(const voltageRange: byte; const currentRange: byte)
Parameter:
  • voltageRange – Typ: byte, Wertebereich: Siehe Konstanten, Standardwert: 1
  • currentRange – Typ: byte, Wertebereich: Siehe Konstanten, Standardwert: 0

Konfiguriert die Spannungs- und Stromwertebereiche.

Einstellbare Spannungswertebereiche sind:

  • 0V bis 5V
  • 0V bis 10V

Einstellbare Stromwertebereiche sind:

  • 4mA bis 20mA
  • 0mA bis 20mA
  • 0mA bis 24mA

Die Auflösung ist immer 12 Bit. Dass heißt, die Genauigkeit erhöht sich bei kleineren Wertebereichen.

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

Für voltageRange:

  • BRICKLET_INDUSTRIAL_ANALOG_OUT_VOLTAGE_RANGE_0_TO_5V = 0
  • BRICKLET_INDUSTRIAL_ANALOG_OUT_VOLTAGE_RANGE_0_TO_10V = 1

Für currentRange:

  • BRICKLET_INDUSTRIAL_ANALOG_OUT_CURRENT_RANGE_4_TO_20MA = 0
  • BRICKLET_INDUSTRIAL_ANALOG_OUT_CURRENT_RANGE_0_TO_20MA = 1
  • BRICKLET_INDUSTRIAL_ANALOG_OUT_CURRENT_RANGE_0_TO_24MA = 2
procedure TBrickletIndustrialAnalogOut.GetConfiguration(out voltageRange: byte; out currentRange: byte)
Ausgabeparameter:
  • voltageRange – Typ: byte, Wertebereich: Siehe Konstanten, Standardwert: 1
  • currentRange – Typ: byte, Wertebereich: Siehe Konstanten, Standardwert: 0

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

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

Für voltageRange:

  • BRICKLET_INDUSTRIAL_ANALOG_OUT_VOLTAGE_RANGE_0_TO_5V = 0
  • BRICKLET_INDUSTRIAL_ANALOG_OUT_VOLTAGE_RANGE_0_TO_10V = 1

Für currentRange:

  • BRICKLET_INDUSTRIAL_ANALOG_OUT_CURRENT_RANGE_4_TO_20MA = 0
  • BRICKLET_INDUSTRIAL_ANALOG_OUT_CURRENT_RANGE_0_TO_20MA = 1
  • BRICKLET_INDUSTRIAL_ANALOG_OUT_CURRENT_RANGE_0_TO_24MA = 2
function TBrickletIndustrialAnalogOut.GetAPIVersion: array [0..2] of byte
Rückgabe:
  • apiVersion – Typ: array [0..2] of byte, Wertebereich: [0 bis 255]

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 TBrickletIndustrialAnalogOut.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_ANALOG_OUT_FUNCTION_ENABLE = 1
  • BRICKLET_INDUSTRIAL_ANALOG_OUT_FUNCTION_DISABLE = 2
  • BRICKLET_INDUSTRIAL_ANALOG_OUT_FUNCTION_SET_VOLTAGE = 4
  • BRICKLET_INDUSTRIAL_ANALOG_OUT_FUNCTION_SET_CURRENT = 6
  • BRICKLET_INDUSTRIAL_ANALOG_OUT_FUNCTION_SET_CONFIGURATION = 8
procedure TBrickletIndustrialAnalogOut.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_ANALOG_OUT_FUNCTION_ENABLE = 1
  • BRICKLET_INDUSTRIAL_ANALOG_OUT_FUNCTION_DISABLE = 2
  • BRICKLET_INDUSTRIAL_ANALOG_OUT_FUNCTION_SET_VOLTAGE = 4
  • BRICKLET_INDUSTRIAL_ANALOG_OUT_FUNCTION_SET_CURRENT = 6
  • BRICKLET_INDUSTRIAL_ANALOG_OUT_FUNCTION_SET_CONFIGURATION = 8
procedure TBrickletIndustrialAnalogOut.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.

procedure TBrickletIndustrialAnalogOut.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
  • hardwareVersion – Typ: array [0..2] of byte, Wertebereich: [0 bis 255]
  • firmwareVersion – Typ: array [0..2] of 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 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 Bricklets.

Konstanten

const BRICKLET_INDUSTRIAL_ANALOG_OUT_DEVICE_IDENTIFIER

Diese Konstante wird verwendet um ein Industrial Analog Out Bricklet zu identifizieren.

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

const BRICKLET_INDUSTRIAL_ANALOG_OUT_DEVICE_DISPLAY_NAME

Diese Konstante stellt den Anzeigenamen eines Industrial Analog Out Bricklet dar.