Delphi/Lazarus - Industrial Quad Relay Bricklet – Tinkerforge

- Getting Started
  - Primer
  - Tutorials
  - FAQ
- Hardware
  - Bricks
  - Bricklets
  - Master Extensions
  - Power Supplies
  - Accessories
  - Timeline
- Software
  - Brick Daemon (brickd)
  - Brick Viewer (brickv)
  - API Bindings
    - C/C++
    - C/C++ (iOS)
    - C#
    - C# (Windows Phone)
    - Delphi/Lazarus
      - Requirements
      - Installation
      - Testing an Example
      - API Reference and Examples
        - IP Connection
        - Bricks
        - Bricklets
          - Ambient Light Bricklet
          - Analog In Bricklet
          - Analog Out Bricklet
          - Barometer Bricklet
          - Color Bricklet
          - Current12 Bricklet
          - Current25 Bricklet
          - Distance IR Bricklet
          - Distance US Bricklet
          - Dual Button Bricklet
          - Dual Relay Bricklet
          - GPS Bricklet
          - Hall Effect Bricklet
          - Humidity Bricklet
          - Industrial Digital In 4 Bricklet
          - Industrial Digital Out 4 Bricklet
          - Industrial Dual 0-20mA Bricklet
          - Industrial Quad Relay Bricklet
            - Examples
              - Simple
            - API
              - Basic Functions
              - Advanced Functions
              - Callback Configuration Functions
              - Callbacks
              - Constants
          - IO-16 Bricklet
          - IO-4 Bricklet
          - Joystick Bricklet
          - LCD 16x2 Bricklet
          - LCD 20x4 Bricklet
          - LED Strip Bricklet
          - Line Bricklet
          - Linear Poti Bricklet
          - Moisture Bricklet
          - Motion Detector Bricklet
          - Multi Touch Bricklet
          - NFC/RFID Bricklet
          - Piezo Buzzer Bricklet
          - Piezo Speaker Bricklet
          - PTC Bricklet
          - Remote Switch Bricklet
          - Rotary Encoder Bricklet
          - Rotary Poti Bricklet
          - Segment Display 4x7 Bricklet
          - Solid State Relay Bricklet
          - Sound Intensity Bricklet
          - Temperature Bricklet
          - Temperature IR Bricklet
          - Tilt Bricklet
          - Voltage Bricklet
          - Voltage/Current Bricklet
    - Java
    - Java (Android)
    - JavaScript
    - LabVIEW
    - Mathematica
    - MATLAB/Octave
    - Perl
    - PHP
    - Python
    - Ruby
    - Shell
    - Visual Basic .NET
  - Firmwares and Plugins
  - Device Identifier
  - Source Code and Bug Tracking
  - Programming Interface
- Starter Kits
  - Weather Station
  - Hardware Hacking
  - Server Room Monitoring
  - Blinkenlights
  - Internet of Things
  - Camera Slider
- Embedded Boards
  - Raspberry Pi
- Specifications
  - Technical Data
  - TCP/IP Protocol
  - Modbus Protocol
  - Wireshark Dissector

# Delphi/Lazarus - Industrial Quad Relay Bricklet

This is the description of the Delphi/Lazarus API bindings for the Industrial Quad Relay Bricklet. General information and technical specifications for the Industrial Quad Relay 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, BrickletIndustrialQuadRelay;

    type
      TExample = class
      private
        ipcon: TIPConnection;
        iqr: TBrickletIndustrialQuadRelay;
      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 }
      iqr := TBrickletIndustrialQuadRelay.Create(UID, ipcon);

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

      { Turn relay 0, 3 on and relay 2, 3 off. }
      iqr.SetValue((1 shl 0) or (1 shl 3));

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

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

      industrialQuadRelay := TBrickletIndustrialQuadRelay.Create('YOUR_DEVICE_UID', ipcon);

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

procedure `TBrickletIndustrialQuadRelay.``SetValue`(const valueMask: word)

  Sets the output value with a bitmask (16bit). A 1 in the bitmask means relay closed and a 0 means relay open.

  For example: The value 3 or 0b0011 will close the relay of pins 0-1 and open the other pins.

  If no groups are used (see `SetGroup`), the pins correspond to the markings on the Quad Relay Bricklet.

  If groups are used, the pins correspond to the element in the group. Element 1 in the group will get pins 0-3, element 2 pins 4-7, element 3 pins 8-11 and element 4 pins 12-15.

function `TBrickletIndustrialQuadRelay.``GetValue`: word

  Returns the bitmask as set by `SetValue`.

### Advanced Functions

procedure `TBrickletIndustrialQuadRelay.``SetMonoflop`(const selectionMask: word; const valueMask: word; const time: longword)

  Configures a monoflop of the pins specified by the first parameter bitmask.

  The second parameter is a bitmask with the desired value of the specified pins. A 1 in the bitmask means relay closed and a 0 means relay open.

  The third parameter indicates the time (in ms) that the pins should hold the value.

  If this function is called with the parameters (9, 1, 1500) or (0b1001, 0b0001, 1500): Pin 0 will close and pin 3 will open. In 1.5s pin 0 will open and pin 3 will close again.

  A monoflop can be used as a fail-safe mechanism. For example: Lets assume you have a RS485 bus and a Quad Relay Bricklet connected to one of the slave stacks. You can now call this function every second, with a time parameter of two seconds and pin 0 closed. Pin 0 will be closed all the time. If now the RS485 connection is lost, then pin 0 will be opened in at most two seconds.

procedure `TBrickletIndustrialQuadRelay.``GetMonoflop`(const pin: byte; out value: word; out time: longword; out timeRemaining: longword)

  Returns (for the given pin) the current value and the time as set by `SetMonoflop` as well as the remaining time until the value flips.

  If the timer is not running currently, the remaining time will be returned as 0.

procedure `TBrickletIndustrialQuadRelay.``SetGroup`(const group: array [0..3] of char)

  Sets a group of Quad Relay Bricklets that should work together. You can find Bricklets that can be grouped together with `GetAvailableForGroup`.

  The group consists of 4 elements. Element 1 in the group will get pins 0-3, element 2 pins 4-7, element 3 pins 8-11 and element 4 pins 12-15.

  Each element can either be one of the ports ('a' to 'd') or 'n' if it should not be used.

  For example: If you have two Quad Relay Bricklets connected to port A and port B respectively, you could call with `['a', 'b', 'n', 'n']`.

  Now the pins on the Quad Relay on port A are assigned to 0-3 and the pins on the Quad Relay on port B are assigned to 4-7. It is now possible to call `SetValue` and control two Bricklets at the same time.

function `TBrickletIndustrialQuadRelay.``GetGroup`: array [0..3] of char

  Returns the group as set by `SetGroup`

function `TBrickletIndustrialQuadRelay.``GetAvailableForGroup`: byte

  Returns a bitmask of ports that are available for grouping. For example the value 5 or 0b0101 means: Port A and port C are connected to Bricklets that can be grouped together.

procedure `TBrickletIndustrialQuadRelay.``SetSelectedValues`(const selectionMask: word; const valueMask: word)

  Sets the output value with a bitmask, according to the selection mask. The bitmask is 16 bit long, true refers to a closed relay and false refers to an open relay.

  For example: The values (3, 1) or (0b0011, 0b0001) will close the relay of pin 0, open the relay of pin 1 and leave the others untouched.

  If no groups are used (see `SetGroup`), the pins correspond to the markings on the Quad Relay Bricklet.

  If groups are used, the pins correspond to the element in the group. Element 1 in the group will get pins 0-3, element 2 pins 4-7, element 3 pins 8-11 and element 4 pins 12-15.

function `TBrickletIndustrialQuadRelay.``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 `TBrickletIndustrialQuadRelay.``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 `TBrickletIndustrialQuadRelay.``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_QUAD_RELAY_FUNCTION_SET_VALUE = 1
  - BRICKLET_INDUSTRIAL_QUAD_RELAY_FUNCTION_SET_MONOFLOP = 3
  - BRICKLET_INDUSTRIAL_QUAD_RELAY_FUNCTION_SET_GROUP = 5
  - BRICKLET_INDUSTRIAL_QUAD_RELAY_FUNCTION_SET_SELECTED_VALUES = 9

procedure `TBrickletIndustrialQuadRelay.``SetResponseExpectedAll`(const responseExpected: boolean)

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

procedure `TBrickletIndustrialQuadRelay.``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.

### Callback Configuration Functions

### Callbacks

Callbacks can be registered to receive time critical or recurring data from the device. The registration is done by assigning a procedure to an callback property of the device object:

>     procedure TExample.MyCallback(sender: TBrickletIndustrialQuadRelay; const param: word);
>     begin
>       WriteLn(param);
>     end;

>     industrialQuadRelay.OnExample := {$ifdef FPC}@{$endif}example.MyCallback;

The available callback property and their type of parameters are described below.

Note

Using callbacks for recurring events is always preferred compared to using getters. It will use less USB bandwidth and the latency will be a lot better, since there is no round trip time.

property `TBrickletIndustrialQuadRelay.``OnMonoflopDone`

      procedure(sender: TBrickletIndustrialQuadRelay; const selectionMask: word; const valueMask: word) of object;

  This callback is triggered whenever a monoflop timer reaches 0. The parameters contain the involved pins and the current value of the pins (the value after the monoflop).

### Constants

const `BRICKLET_INDUSTRIAL_QUAD_RELAY_DEVICE_IDENTIFIER`

  This constant is used to identify a Industrial Quad Relay 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.