Delphi/Lazarus - Industrial Analog Out Bricklet – Tinkerforge

- Getting Started
- Hardware
- Software
- Starter Kits
- Embedded Boards
- Specifications

# Delphi/Lazarus - Industrial Analog Out Bricklet

Note

This Bricklet is currently in the prototype stage and the software/hardware as well as the documentation is in an incomplete state.

This is the description of the Delphi/Lazarus API bindings for the Industrial Analog Out Bricklet. General information and technical specifications for the Industrial 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 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

    program ExampleSimple;

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

    uses
      SysUtils, IPConnection, BrickletIndustrialAnalogOut;

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

    const
      HOST = 'localhost';
      PORT = 4223;
      UID = 'XYZ'; { Change to your UID }

    var
      e: TExample;

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

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

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

      { Set a current of 4.5mA }
      ao.SetCurrent(4500);
      ao.Enable();

      WriteLn('Press key to exit');
      ReadLn;
      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

    program ExampleSimple;

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

    uses
      SysUtils, IPConnection, BrickletIndustrialAnalogOut;

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

    const
      HOST = 'localhost';
      PORT = 4223;
      UID = 'XYZ'; { Change to your UID }

    var
      e: TExample;

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

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

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

      { Set a voltage of 3.3V }
      ao.SetVoltage(3300);
      ao.Enable();

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

  Creates an object with the unique device ID `uid`:

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

  This object can then be used after the IP Connection is connected (see examples above).

procedure `TBrickletIndustrialAnalogOut.``Enable`

  Enables the output of voltage and current.

  The default is disabled.

procedure `TBrickletIndustrialAnalogOut.``Disable`

  Disables the output of voltage and current.

  The default is disabled.

function `TBrickletIndustrialAnalogOut.``IsEnabled`: boolean

  Returns true if output of voltage and current is enabled, false otherwise.

procedure `TBrickletIndustrialAnalogOut.``SetVoltage`(const voltage: word)

  Sets the output voltage in mV.

function `TBrickletIndustrialAnalogOut.``GetVoltage`: word

  Returns the voltage as set by `SetVoltage`.

procedure `TBrickletIndustrialAnalogOut.``SetCurrent`(const current: word)

  Sets the output current in µA.

function `TBrickletIndustrialAnalogOut.``GetCurrent`: word

  Returns the current as set by `SetCurrent`.

### Advanced Functions

procedure `TBrickletIndustrialAnalogOut.``SetConfiguration`(const voltageRange: byte; const currentRange: byte)

  Configures the voltage and current range.

  Possible voltage ranges are:

  - 0V to 5V
  - 0V to 10V

  Possible current ranges are:

  - 4mA to 20mA
  - 0mA to 20mA
  - 0mA to 24mA

  The resolution will always be 12 bit. This means, that the precision is higher with a smaller range.

  The following constants are available for this function:

  - BRICKLET_INDUSTRIAL_ANALOG_OUT_VOLTAGE_RANGE_0_TO_5V = 0
  - BRICKLET_INDUSTRIAL_ANALOG_OUT_VOLTAGE_RANGE_0_TO_10V = 1
  - 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)

  Returns the configuration as set by `SetConfiguration`.

  The following constants are available for this function:

  - BRICKLET_INDUSTRIAL_ANALOG_OUT_VOLTAGE_RANGE_0_TO_5V = 0
  - BRICKLET_INDUSTRIAL_ANALOG_OUT_VOLTAGE_RANGE_0_TO_10V = 1
  - 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

  Returns the version of the API definition (major, minor, revision) 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 `TBrickletIndustrialAnalogOut.``GetResponseExpected`(const functionId: byte): 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 send and errors are silently ignored, because they cannot be detected.

  See `SetResponseExpected` for the list of function ID constants available for this function.

procedure `TBrickletIndustrialAnalogOut.``SetResponseExpected`(const functionId: byte; const responseExpected: 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 and callbacks it is always disabled.

  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 send and errors are silently ignored, because they cannot be detected.

  The following function ID constants are available for this function:

  - 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)

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

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)

  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' or 'd'.

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

### Constants

const `BRICKLET_INDUSTRIAL_ANALOG_OUT_DEVICE_IDENTIFIER`

  This constant is used to identify a Industrial Analog Out Bricklet.

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

The content of this page is licensed under Creative Commons Attribution 3.0 Unported License.