Delphi/Lazarus - Analog Out Bricklet

This is the description of the Delphi/Lazarus API bindings for the Analog Out Bricklet. General information and technical specifications for the Analog Out Bricklet are summarized in its hardware description.

An installation guide for the Delphi/Lazarus API bindings is part of their general description.

Examples

The example code below is 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
program ExampleSimple;

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

uses
  SysUtils, IPConnection, BrickletAnalogOut;

type
  TExample = class
  private
    ipcon: TIPConnection;
    ao: TBrickletAnalogOut;
  public
    procedure Execute;
  end;

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

var
  e: TExample;

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

  { Create device object }
  ao := TBrickletAnalogOut.Create(UID, ipcon);

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

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

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

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

API

Since Delphi does not support multiple return values directly, we use the out keyword to return multiple values from a function.

All functions and procedures listed below are thread-safe.

Basic Functions

constructor TBrickletAnalogOut.Create(const uid: string; ipcon: TIPConnection)
Parameters:
  • uid – Type: string
  • ipcon – Type: TIPConnection
Returns:
  • analogOut – Type: TBrickletAnalogOut

Creates an object with the unique device ID uid:

analogOut := TBrickletAnalogOut.Create('YOUR_DEVICE_UID', ipcon);

This object can then be used after the IP Connection is connected.

procedure TBrickletAnalogOut.SetVoltage(const voltage: word)
Parameters:
  • voltage – Type: word, Unit: 1 mV, Range: [0 to 5000], Default: 0

Sets the voltage. Calling this function will set the mode to 0 (see SetMode).

function TBrickletAnalogOut.GetVoltage: word
Returns:
  • voltage – Type: word, Unit: 1 mV, Range: [0 to 5000], Default: 0

Returns the voltage as set by SetVoltage.

procedure TBrickletAnalogOut.SetMode(const mode: byte)
Parameters:
  • mode – Type: byte, Range: See constants, Default: 1

Sets the mode of the analog value. Possible modes:

  • 0: Normal Mode (Analog value as set by SetVoltage is applied)
  • 1: 1k Ohm resistor to ground
  • 2: 100k Ohm resistor to ground
  • 3: 500k Ohm resistor to ground

Setting the mode to 0 will result in an output voltage of 0 V. You can jump to a higher output voltage directly by calling SetVoltage.

The following constants are available for this function:

For mode:

  • BRICKLET_ANALOG_OUT_MODE_ANALOG_VALUE = 0
  • BRICKLET_ANALOG_OUT_MODE_1K_TO_GROUND = 1
  • BRICKLET_ANALOG_OUT_MODE_100K_TO_GROUND = 2
  • BRICKLET_ANALOG_OUT_MODE_500K_TO_GROUND = 3
function TBrickletAnalogOut.GetMode: byte
Returns:
  • mode – Type: byte, Range: See constants, Default: 1

Returns the mode as set by SetMode.

The following constants are available for this function:

For mode:

  • BRICKLET_ANALOG_OUT_MODE_ANALOG_VALUE = 0
  • BRICKLET_ANALOG_OUT_MODE_1K_TO_GROUND = 1
  • BRICKLET_ANALOG_OUT_MODE_100K_TO_GROUND = 2
  • BRICKLET_ANALOG_OUT_MODE_500K_TO_GROUND = 3

Advanced Functions

procedure TBrickletAnalogOut.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)
Output Parameters:
  • uid – Type: string, Length: up to 8
  • connectedUid – Type: string, Length: up to 8
  • position – Type: char, Range: ['a' to 'h', 'z']
  • hardwareVersion – Type: array [0..2] of byte
    • 0: major – Type: byte, Range: [0 to 255]
    • 1: minor – Type: byte, Range: [0 to 255]
    • 2: revision – Type: byte, Range: [0 to 255]
  • firmwareVersion – Type: array [0..2] of byte
    • 0: major – Type: byte, Range: [0 to 255]
    • 1: minor – Type: byte, Range: [0 to 255]
    • 2: revision – Type: byte, Range: [0 to 255]
  • deviceIdentifier – Type: word, Range: [0 to 216 - 1]

Returns the UID, the UID where the Bricklet is connected to, the position, the hardware and firmware version as well as the device identifier.

The position can be 'a', 'b', 'c', 'd', 'e', 'f', 'g' or 'h' (Bricklet Port). A Bricklet connected to an Isolator Bricklet is always as position 'z'.

The device identifier numbers can be found here. There is also a constant for the device identifier of this Bricklet.

Virtual Functions

Virtual functions don't communicate with the device itself, but operate only on the API bindings device object. They can be called without the corresponding IP Connection object being connected.

function TBrickletAnalogOut.GetAPIVersion: array [0..2] of byte
Output Parameters:
  • apiVersion – Type: array [0..2] of byte
    • 0: major – Type: byte, Range: [0 to 255]
    • 1: minor – Type: byte, Range: [0 to 255]
    • 2: revision – Type: byte, Range: [0 to 255]

Returns the version of the API definition implemented by this API bindings. This is neither the release version of this API bindings nor does it tell you anything about the represented Brick or Bricklet.

function TBrickletAnalogOut.GetResponseExpected(const functionId: byte): boolean
Parameters:
  • functionId – Type: byte, Range: See constants
Returns:
  • responseExpected – Type: boolean

Returns the response expected flag for the function specified by the function ID parameter. It is true if the function is expected to send a response, false otherwise.

For getter functions this is enabled by default and cannot be disabled, because those functions will always send a response. For callback configuration functions it is enabled by default too, but can be disabled by SetResponseExpected. For setter functions it is disabled by default and can be enabled.

Enabling the response expected flag for a setter function allows to detect timeouts and other error conditions calls of this setter as well. The device will then send a response for this purpose. If this flag is disabled for a setter function then no response is sent and errors are silently ignored, because they cannot be detected.

The following constants are available for this function:

For functionId:

  • BRICKLET_ANALOG_OUT_FUNCTION_SET_VOLTAGE = 1
  • BRICKLET_ANALOG_OUT_FUNCTION_SET_MODE = 3
procedure TBrickletAnalogOut.SetResponseExpected(const functionId: byte; const responseExpected: boolean)
Parameters:
  • functionId – Type: byte, Range: See constants
  • responseExpected – Type: boolean

Changes the response expected flag of the function specified by the function ID parameter. This flag can only be changed for setter (default value: false) and callback configuration functions (default value: true). For getter functions it is always enabled.

Enabling the response expected flag for a setter function allows to detect timeouts and other error conditions calls of this setter as well. The device will then send a response for this purpose. If this flag is disabled for a setter function then no response is sent and errors are silently ignored, because they cannot be detected.

The following constants are available for this function:

For functionId:

  • BRICKLET_ANALOG_OUT_FUNCTION_SET_VOLTAGE = 1
  • BRICKLET_ANALOG_OUT_FUNCTION_SET_MODE = 3
procedure TBrickletAnalogOut.SetResponseExpectedAll(const responseExpected: boolean)
Parameters:
  • responseExpected – Type: boolean

Changes the response expected flag for all setter and callback configuration functions of this device at once.

Constants

const BRICKLET_ANALOG_OUT_DEVICE_IDENTIFIER

This constant is used to identify a Analog Out Bricklet.

The GetIdentity function and the TIPConnection.OnEnumerate callback of the IP Connection have a deviceIdentifier parameter to specify the Brick's or Bricklet's type.

const BRICKLET_ANALOG_OUT_DEVICE_DISPLAY_NAME

This constant represents the human readable name of a Analog Out Bricklet.