Deutsch
English
Menu
Software / API Bindings / Delphi/Lazarus / API Reference and Examples / Bricklets / Industrial Dual AC In Bricklet

Delphi/Lazarus - Industrial Dual AC In Bricklet

This is the description of the Delphi/Lazarus API bindings for the Industrial Dual AC In Bricklet. General information and technical specifications for the Industrial Dual AC In Bricklet are summarized in its hardware description.

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

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 TBrickletIndustrialDualACIn.Create(const uid: string; ipcon: TIPConnection)
Parameters:
  • uid – Type: string
  • ipcon – Type: TIPConnection
Returns:
  • industrialDualACIn – Type: TBrickletIndustrialDualACIn

Creates an object with the unique device ID uid:

industrialDualACIn := TBrickletIndustrialDualACIn.Create('YOUR_DEVICE_UID', ipcon);

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

function TBrickletIndustrialDualACIn.GetValue: array [0..1] of boolean
Returns:
  • value – Type: array [0..1] of boolean

Returns the input values as bools, true refers to "AC voltage detected" and false refers to no "AC voltage detected".

procedure TBrickletIndustrialDualACIn.SetChannelLEDConfig(const channel: byte; const config: byte)
Parameters:
  • channel – Type: byte, Range: See constants
  • config – Type: byte, Range: See constants, Default: 3

Each channel has a corresponding LED. You can turn the LED off, on or show a heartbeat. You can also set the LED to "Channel Status". In this mode the LED is on if the channel is high and off otherwise.

By default all channel LEDs are configured as "Channel Status".

The following constants are available for this function:

For channel:

  • BRICKLET_INDUSTRIAL_DUAL_AC_IN_CHANNEL_0 = 0
  • BRICKLET_INDUSTRIAL_DUAL_AC_IN_CHANNEL_1 = 1

For config:

  • BRICKLET_INDUSTRIAL_DUAL_AC_IN_CHANNEL_LED_CONFIG_OFF = 0
  • BRICKLET_INDUSTRIAL_DUAL_AC_IN_CHANNEL_LED_CONFIG_ON = 1
  • BRICKLET_INDUSTRIAL_DUAL_AC_IN_CHANNEL_LED_CONFIG_SHOW_HEARTBEAT = 2
  • BRICKLET_INDUSTRIAL_DUAL_AC_IN_CHANNEL_LED_CONFIG_SHOW_CHANNEL_STATUS = 3
function TBrickletIndustrialDualACIn.GetChannelLEDConfig(const channel: byte): byte
Parameters:
  • channel – Type: byte, Range: See constants
Returns:
  • config – Type: byte, Range: See constants, Default: 3

Returns the channel LED configuration as set by SetChannelLEDConfig

The following constants are available for this function:

For channel:

  • BRICKLET_INDUSTRIAL_DUAL_AC_IN_CHANNEL_0 = 0
  • BRICKLET_INDUSTRIAL_DUAL_AC_IN_CHANNEL_1 = 1

For config:

  • BRICKLET_INDUSTRIAL_DUAL_AC_IN_CHANNEL_LED_CONFIG_OFF = 0
  • BRICKLET_INDUSTRIAL_DUAL_AC_IN_CHANNEL_LED_CONFIG_ON = 1
  • BRICKLET_INDUSTRIAL_DUAL_AC_IN_CHANNEL_LED_CONFIG_SHOW_HEARTBEAT = 2
  • BRICKLET_INDUSTRIAL_DUAL_AC_IN_CHANNEL_LED_CONFIG_SHOW_CHANNEL_STATUS = 3

Advanced Functions

procedure TBrickletIndustrialDualACIn.GetSPITFPErrorCount(out errorCountAckChecksum: longword; out errorCountMessageChecksum: longword; out errorCountFrame: longword; out errorCountOverflow: longword)
Output Parameters:
  • errorCountAckChecksum – Type: longword, Range: [0 to 232 - 1]
  • errorCountMessageChecksum – Type: longword, Range: [0 to 232 - 1]
  • errorCountFrame – Type: longword, Range: [0 to 232 - 1]
  • errorCountOverflow – Type: longword, Range: [0 to 232 - 1]

Returns the error count for the communication between Brick and Bricklet.

The errors are divided into

  • ACK checksum errors,
  • message checksum errors,
  • framing errors and
  • overflow errors.

The errors counts are for errors that occur on the Bricklet side. All Bricks have a similar function that returns the errors on the Brick side.

procedure TBrickletIndustrialDualACIn.SetStatusLEDConfig(const config: byte)
Parameters:
  • config – Type: byte, Range: See constants, Default: 3

Sets the status LED configuration. By default the LED shows communication traffic between Brick and Bricklet, it flickers once for every 10 received data packets.

You can also turn the LED permanently on/off or show a heartbeat.

If the Bricklet is in bootloader mode, the LED is will show heartbeat by default.

The following constants are available for this function:

For config:

  • BRICKLET_INDUSTRIAL_DUAL_AC_IN_STATUS_LED_CONFIG_OFF = 0
  • BRICKLET_INDUSTRIAL_DUAL_AC_IN_STATUS_LED_CONFIG_ON = 1
  • BRICKLET_INDUSTRIAL_DUAL_AC_IN_STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • BRICKLET_INDUSTRIAL_DUAL_AC_IN_STATUS_LED_CONFIG_SHOW_STATUS = 3
function TBrickletIndustrialDualACIn.GetStatusLEDConfig: byte
Returns:
  • config – Type: byte, Range: See constants, Default: 3

Returns the configuration as set by SetStatusLEDConfig

The following constants are available for this function:

For config:

  • BRICKLET_INDUSTRIAL_DUAL_AC_IN_STATUS_LED_CONFIG_OFF = 0
  • BRICKLET_INDUSTRIAL_DUAL_AC_IN_STATUS_LED_CONFIG_ON = 1
  • BRICKLET_INDUSTRIAL_DUAL_AC_IN_STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • BRICKLET_INDUSTRIAL_DUAL_AC_IN_STATUS_LED_CONFIG_SHOW_STATUS = 3
function TBrickletIndustrialDualACIn.GetChipTemperature: smallint
Returns:
  • temperature – Type: smallint, Unit: 1 °C, Range: [-215 to 215 - 1]

Returns the temperature as measured inside the microcontroller. The value returned is not the ambient temperature!

The temperature is only proportional to the real temperature and it has bad accuracy. Practically it is only useful as an indicator for temperature changes.

procedure TBrickletIndustrialDualACIn.Reset

Calling this function will reset the Bricklet. All configurations will be lost.

After a reset you have to create new device objects, calling functions on the existing ones will result in undefined behavior!

procedure TBrickletIndustrialDualACIn.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 at position 'z'.

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

Callback Configuration Functions

procedure TBrickletIndustrialDualACIn.SetValueCallbackConfiguration(const channel: byte; const period: longword; const valueHasToChange: boolean)
Parameters:
  • channel – Type: byte, Range: See constants
  • period – Type: longword, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0
  • valueHasToChange – Type: boolean, Default: false

This callback can be configured per channel.

The period is the period with which the OnValue callback is triggered periodically. A value of 0 turns the callback off.

If the value has to change-parameter is set to true, the callback is only triggered after the value has changed. If the value didn't change within the period, the callback is triggered immediately on change.

If it is set to false, the callback is continuously triggered with the period, independent of the value.

The following constants are available for this function:

For channel:

  • BRICKLET_INDUSTRIAL_DUAL_AC_IN_CHANNEL_0 = 0
  • BRICKLET_INDUSTRIAL_DUAL_AC_IN_CHANNEL_1 = 1
procedure TBrickletIndustrialDualACIn.GetValueCallbackConfiguration(const channel: byte; out period: longword; out valueHasToChange: boolean)
Parameters:
  • channel – Type: byte, Range: See constants
Output Parameters:
  • period – Type: longword, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0
  • valueHasToChange – Type: boolean, Default: false

Returns the callback configuration for the given channel as set by SetValueCallbackConfiguration.

The following constants are available for this function:

For channel:

  • BRICKLET_INDUSTRIAL_DUAL_AC_IN_CHANNEL_0 = 0
  • BRICKLET_INDUSTRIAL_DUAL_AC_IN_CHANNEL_1 = 1
procedure TBrickletIndustrialDualACIn.SetAllValueCallbackConfiguration(const period: longword; const valueHasToChange: boolean)
Parameters:
  • period – Type: longword, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0
  • valueHasToChange – Type: boolean, Default: false

The period is the period with which the OnAllValue callback is triggered periodically. A value of 0 turns the callback off.

If the value has to change-parameter is set to true, the callback is only triggered after the value has changed. If the value didn't change within the period, the callback is triggered immediately on change.

If it is set to false, the callback is continuously triggered with the period, independent of the value.

procedure TBrickletIndustrialDualACIn.GetAllValueCallbackConfiguration(out period: longword; out valueHasToChange: boolean)
Output Parameters:
  • period – Type: longword, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0
  • valueHasToChange – Type: boolean, Default: false

Returns the callback configuration as set by SetAllValueCallbackConfiguration.

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: TBrickletIndustrialDualACIn; const value: longint);
begin
  WriteLn(Format('Value: %d', [value]));
end;

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

The available callback properties and their parameter types 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 TBrickletIndustrialDualACIn.OnValue
procedure(sender: TBrickletIndustrialDualACIn; const channel: byte; const changed: boolean; const value: boolean) of object;
Callback Parameters:
  • sender – Type: TBrickletIndustrialDualACIn
  • channel – Type: byte, Range: See constants
  • changed – Type: boolean
  • value – Type: boolean

This callback is triggered periodically according to the configuration set by SetValueCallbackConfiguration.

The parameters are the channel, a value-changed indicator and the actual value for the channel. The changed parameter is true if the value has changed since the last callback.

The following constants are available for this function:

For channel:

  • BRICKLET_INDUSTRIAL_DUAL_AC_IN_CHANNEL_0 = 0
  • BRICKLET_INDUSTRIAL_DUAL_AC_IN_CHANNEL_1 = 1
property TBrickletIndustrialDualACIn.OnAllValue
procedure(sender: TBrickletIndustrialDualACIn; const changed: array [0..1] of boolean; const value: array [0..1] of boolean) of object;
Callback Parameters:
  • sender – Type: TBrickletIndustrialDualACIn
  • changed – Type: array [0..1] of boolean
  • value – Type: array [0..1] of boolean

This callback is triggered periodically according to the configuration set by SetAllValueCallbackConfiguration.

The parameters are the same as GetValue. Additional the changed parameter is true if the value has changed since the last callback.

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 TBrickletIndustrialDualACIn.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 TBrickletIndustrialDualACIn.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_INDUSTRIAL_DUAL_AC_IN_FUNCTION_SET_VALUE_CALLBACK_CONFIGURATION = 2
  • BRICKLET_INDUSTRIAL_DUAL_AC_IN_FUNCTION_SET_ALL_VALUE_CALLBACK_CONFIGURATION = 4
  • BRICKLET_INDUSTRIAL_DUAL_AC_IN_FUNCTION_SET_CHANNEL_LED_CONFIG = 6
  • BRICKLET_INDUSTRIAL_DUAL_AC_IN_FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
  • BRICKLET_INDUSTRIAL_DUAL_AC_IN_FUNCTION_SET_STATUS_LED_CONFIG = 239
  • BRICKLET_INDUSTRIAL_DUAL_AC_IN_FUNCTION_RESET = 243
  • BRICKLET_INDUSTRIAL_DUAL_AC_IN_FUNCTION_WRITE_UID = 248
procedure TBrickletIndustrialDualACIn.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_INDUSTRIAL_DUAL_AC_IN_FUNCTION_SET_VALUE_CALLBACK_CONFIGURATION = 2
  • BRICKLET_INDUSTRIAL_DUAL_AC_IN_FUNCTION_SET_ALL_VALUE_CALLBACK_CONFIGURATION = 4
  • BRICKLET_INDUSTRIAL_DUAL_AC_IN_FUNCTION_SET_CHANNEL_LED_CONFIG = 6
  • BRICKLET_INDUSTRIAL_DUAL_AC_IN_FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
  • BRICKLET_INDUSTRIAL_DUAL_AC_IN_FUNCTION_SET_STATUS_LED_CONFIG = 239
  • BRICKLET_INDUSTRIAL_DUAL_AC_IN_FUNCTION_RESET = 243
  • BRICKLET_INDUSTRIAL_DUAL_AC_IN_FUNCTION_WRITE_UID = 248
procedure TBrickletIndustrialDualACIn.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.

Internal Functions

Internal functions are used for maintenance tasks such as flashing a new firmware of changing the UID of a Bricklet. These task should be performed using Brick Viewer instead of using the internal functions directly.

function TBrickletIndustrialDualACIn.SetBootloaderMode(const mode: byte): byte
Parameters:
  • mode – Type: byte, Range: See constants
Returns:
  • status – Type: byte, Range: See constants

Sets the bootloader mode and returns the status after the requested mode change was instigated.

You can change from bootloader mode to firmware mode and vice versa. A change from bootloader mode to firmware mode will only take place if the entry function, device identifier and CRC are present and correct.

This function is used by Brick Viewer during flashing. It should not be necessary to call it in a normal user program.

The following constants are available for this function:

For mode:

  • BRICKLET_INDUSTRIAL_DUAL_AC_IN_BOOTLOADER_MODE_BOOTLOADER = 0
  • BRICKLET_INDUSTRIAL_DUAL_AC_IN_BOOTLOADER_MODE_FIRMWARE = 1
  • BRICKLET_INDUSTRIAL_DUAL_AC_IN_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
  • BRICKLET_INDUSTRIAL_DUAL_AC_IN_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
  • BRICKLET_INDUSTRIAL_DUAL_AC_IN_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4

For status:

  • BRICKLET_INDUSTRIAL_DUAL_AC_IN_BOOTLOADER_STATUS_OK = 0
  • BRICKLET_INDUSTRIAL_DUAL_AC_IN_BOOTLOADER_STATUS_INVALID_MODE = 1
  • BRICKLET_INDUSTRIAL_DUAL_AC_IN_BOOTLOADER_STATUS_NO_CHANGE = 2
  • BRICKLET_INDUSTRIAL_DUAL_AC_IN_BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT = 3
  • BRICKLET_INDUSTRIAL_DUAL_AC_IN_BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT = 4
  • BRICKLET_INDUSTRIAL_DUAL_AC_IN_BOOTLOADER_STATUS_CRC_MISMATCH = 5
function TBrickletIndustrialDualACIn.GetBootloaderMode: byte
Returns:
  • mode – Type: byte, Range: See constants

Returns the current bootloader mode, see SetBootloaderMode.

The following constants are available for this function:

For mode:

  • BRICKLET_INDUSTRIAL_DUAL_AC_IN_BOOTLOADER_MODE_BOOTLOADER = 0
  • BRICKLET_INDUSTRIAL_DUAL_AC_IN_BOOTLOADER_MODE_FIRMWARE = 1
  • BRICKLET_INDUSTRIAL_DUAL_AC_IN_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
  • BRICKLET_INDUSTRIAL_DUAL_AC_IN_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
  • BRICKLET_INDUSTRIAL_DUAL_AC_IN_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4
procedure TBrickletIndustrialDualACIn.SetWriteFirmwarePointer(const pointer: longword)
Parameters:
  • pointer – Type: longword, Unit: 1 B, Range: [0 to 232 - 1]

Sets the firmware pointer for WriteFirmware. The pointer has to be increased by chunks of size 64. The data is written to flash every 4 chunks (which equals to one page of size 256).

This function is used by Brick Viewer during flashing. It should not be necessary to call it in a normal user program.

function TBrickletIndustrialDualACIn.WriteFirmware(const data: array [0..63] of byte): byte
Parameters:
  • data – Type: array [0..63] of byte, Range: [0 to 255]
Returns:
  • status – Type: byte, Range: [0 to 255]

Writes 64 Bytes of firmware at the position as written by SetWriteFirmwarePointer before. The firmware is written to flash every 4 chunks.

You can only write firmware in bootloader mode.

This function is used by Brick Viewer during flashing. It should not be necessary to call it in a normal user program.

procedure TBrickletIndustrialDualACIn.WriteUID(const uid: longword)
Parameters:
  • uid – Type: longword, Range: [0 to 232 - 1]

Writes a new UID into flash. If you want to set a new UID you have to decode the Base58 encoded UID string into an integer first.

We recommend that you use Brick Viewer to change the UID.

function TBrickletIndustrialDualACIn.ReadUID: longword
Returns:
  • uid – Type: longword, Range: [0 to 232 - 1]

Returns the current UID as an integer. Encode as Base58 to get the usual string version.

Constants

const BRICKLET_INDUSTRIAL_DUAL_AC_IN_DEVICE_IDENTIFIER

This constant is used to identify a Industrial Dual AC In 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_INDUSTRIAL_DUAL_AC_IN_DEVICE_DISPLAY_NAME

This constant represents the human readable name of a Industrial Dual AC In Bricklet.