Software / API Bindings / Delphi/Lazarus / API Reference and Examples / Bricklets / Industrial Counter Bricklet

Delphi/Lazarus - Industrial Counter Bricklet¶

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

program ExampleSimple;

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

uses
  SysUtils, IPConnection, BrickletIndustrialCounter;

type
  TExample = class
  private
    ipcon: TIPConnection;
    ic: TBrickletIndustrialCounter;
  public
    procedure Execute;
  end;

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

var
  e: TExample;

procedure TExample.Execute;
var counter: int64; dutyCycle: word; period: uint64; frequency: longword; value: boolean;
begin
  { Create IP connection }
  ipcon := TIPConnection.Create;

  { Create device object }
  ic := TBrickletIndustrialCounter.Create(UID, ipcon);

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

  { Get current counter from channel 0 }
  counter := ic.GetCounter(BRICKLET_INDUSTRIAL_COUNTER_CHANNEL_0);
  WriteLn(Format('Counter (Channel 0): %d', [counter]));

  { Get current signal data from channel 0 }
  ic.GetSignalData(BRICKLET_INDUSTRIAL_COUNTER_CHANNEL_0, dutyCycle, period, frequency,
                   value);

  WriteLn(Format('Duty Cycle (Channel 0): %f %%', [dutyCycle/100.0]));
  WriteLn(Format('Period (Channel 0): %d ns', [period]));
  WriteLn(Format('Frequency (Channel 0): %f Hz', [frequency/1000.0]));
  WriteLn(Format('Value (Channel 0): %d', [value]));

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

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

Callback¶

Download (ExampleCallback.pas)

program ExampleCallback;

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

uses
  SysUtils, IPConnection, BrickletIndustrialCounter;

type
  TExample = class
  private
    ipcon: TIPConnection;
    ic: TBrickletIndustrialCounter;
  public
    procedure AllCounterCB(sender: TBrickletIndustrialCounter;
                           const counter: TArray0To3OfInt64);
    procedure Execute;
  end;

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

var
  e: TExample;

{ Callback procedure for all counter callback }
procedure TExample.AllCounterCB(sender: TBrickletIndustrialCounter;
                                const counter: TArray0To3OfInt64);
begin
  WriteLn(Format('Counter (Channel 0): %d', [counter[0]]));
  WriteLn(Format('Counter (Channel 1): %d', [counter[1]]));
  WriteLn(Format('Counter (Channel 2): %d', [counter[2]]));
  WriteLn(Format('Counter (Channel 3): %d', [counter[3]]));
  WriteLn('');
end;

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

  { Create device object }
  ic := TBrickletIndustrialCounter.Create(UID, ipcon);

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

  { Register all counter callback to procedure AllCounterCB }
  ic.OnAllCounter := {$ifdef FPC}@{$endif}AllCounterCB;

  { Set period for all counter callback to 1s (1000ms) }
  ic.SetAllCounterCallbackConfiguration(1000, true);

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

Parameters:	uid – Type: string ipcon – Type: TIPConnection
Returns:	industrialCounter – Type: TBrickletIndustrialCounter

Creates an object with the unique device ID uid:

industrialCounter := TBrickletIndustrialCounter.Create('YOUR_DEVICE_UID', ipcon);

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

function TBrickletIndustrialCounter.GetCounter(const channel: byte): int64¶

Parameters:	channel – Type: byte, Range: See constants
Returns:	counter – Type: int64, Range: [-2⁴⁷ to 2⁴⁷ - 1]

Returns the current counter value for the given channel.

The following constants are available for this function:

For channel:

BRICKLET_INDUSTRIAL_COUNTER_CHANNEL_0 = 0
BRICKLET_INDUSTRIAL_COUNTER_CHANNEL_1 = 1
BRICKLET_INDUSTRIAL_COUNTER_CHANNEL_2 = 2
BRICKLET_INDUSTRIAL_COUNTER_CHANNEL_3 = 3

function TBrickletIndustrialCounter.GetAllCounter: array [0..3] of int64¶

Returns:	counter – Type: array [0..3] of int64, Range: [-2⁴⁷ to 2⁴⁷ - 1]

Returns the current counter values for all four channels.

procedure TBrickletIndustrialCounter.SetCounter(const channel: byte; const counter: int64)¶

Parameters:	channel – Type: byte, Range: See constants counter – Type: int64, Range: [-2⁴⁷ to 2⁴⁷ - 1]

Sets the counter value for the given channel.

The default value for the counters on startup is 0.

The following constants are available for this function:

For channel:

BRICKLET_INDUSTRIAL_COUNTER_CHANNEL_0 = 0
BRICKLET_INDUSTRIAL_COUNTER_CHANNEL_1 = 1
BRICKLET_INDUSTRIAL_COUNTER_CHANNEL_2 = 2
BRICKLET_INDUSTRIAL_COUNTER_CHANNEL_3 = 3

procedure TBrickletIndustrialCounter.SetAllCounter(const counter: array [0..3] of int64)¶

Parameters:	counter – Type: array [0..3] of int64, Range: [-2⁴⁷ to 2⁴⁷ - 1]

Sets the counter values for all four channels.

The default value for the counters on startup is 0.

procedure TBrickletIndustrialCounter.GetSignalData(const channel: byte; out dutyCycle: word; out period: uint64; out frequency: longword; out value: boolean)¶

Parameters:	channel – Type: byte, Range: See constants
Output Parameters:	dutyCycle – Type: word, Unit: 1/100 %, Range: [0 to 10000] period – Type: uint64, Unit: 1 ns, Range: [0 to 2⁶⁴ - 1] frequency – Type: longword, Unit: 1/1000 Hz, Range: [0 to 2³² - 1] value – Type: boolean

Returns the signal data (duty cycle, period, frequency and value) for the given channel.

The following constants are available for this function:

For channel:

BRICKLET_INDUSTRIAL_COUNTER_CHANNEL_0 = 0
BRICKLET_INDUSTRIAL_COUNTER_CHANNEL_1 = 1
BRICKLET_INDUSTRIAL_COUNTER_CHANNEL_2 = 2
BRICKLET_INDUSTRIAL_COUNTER_CHANNEL_3 = 3

procedure TBrickletIndustrialCounter.GetAllSignalData(out dutyCycle: array [0..3] of word; out period: array [0..3] of uint64; out frequency: array [0..3] of longword; out value: array [0..3] of boolean)¶

Output Parameters:	dutyCycle – Type: array [0..3] of word, Unit: 1/100 %, Range: [0 to 10000] period – Type: array [0..3] of uint64, Unit: 1 ns, Range: [0 to 2⁶⁴ - 1] frequency – Type: array [0..3] of longword, Unit: 1/1000 Hz, Range: [0 to 2³² - 1] value – Type: array [0..3] of boolean

Returns the signal data (duty cycle, period, frequency and value) for all four channels.

procedure TBrickletIndustrialCounter.SetCounterActive(const channel: byte; const active: boolean)¶

Parameters:	channel – Type: byte, Range: See constants active – Type: boolean, Default: true

Activates/deactivates the counter of the given channel.

true = activate, false = deactivate.

By default all channels are activated.

The following constants are available for this function:

For channel:

BRICKLET_INDUSTRIAL_COUNTER_CHANNEL_0 = 0
BRICKLET_INDUSTRIAL_COUNTER_CHANNEL_1 = 1
BRICKLET_INDUSTRIAL_COUNTER_CHANNEL_2 = 2
BRICKLET_INDUSTRIAL_COUNTER_CHANNEL_3 = 3

procedure TBrickletIndustrialCounter.SetAllCounterActive(const active: array [0..3] of boolean)¶

Parameters:	active – Type: array [0..3] of boolean, Default: (true, true, true, true)

Activates/deactivates the counter of all four channels.

true = activate, false = deactivate.

By default all channels are activated.

function TBrickletIndustrialCounter.GetCounterActive(const channel: byte): boolean¶

Parameters:	channel – Type: byte, Range: See constants
Returns:	active – Type: boolean, Default: true

Returns the activation state of the given channel.

true = activated, false = deactivated.

The following constants are available for this function:

For channel:

BRICKLET_INDUSTRIAL_COUNTER_CHANNEL_0 = 0
BRICKLET_INDUSTRIAL_COUNTER_CHANNEL_1 = 1
BRICKLET_INDUSTRIAL_COUNTER_CHANNEL_2 = 2
BRICKLET_INDUSTRIAL_COUNTER_CHANNEL_3 = 3

function TBrickletIndustrialCounter.GetAllCounterActive: array [0..3] of boolean¶

Returns:	active – Type: array [0..3] of boolean, Default: (true, true, true, true)

Returns the activation state of all four channels.

true = activated, false = deactivated.

procedure TBrickletIndustrialCounter.SetCounterConfiguration(const channel: byte; const countEdge: byte; const countDirection: byte; const dutyCyclePrescaler: byte; const frequencyIntegrationTime: byte)¶

Parameters:	channel – Type: byte, Range: See constants countEdge – Type: byte, Range: See constants, Default: 0 countDirection – Type: byte, Range: See constants, Default: 0 dutyCyclePrescaler – Type: byte, Range: See constants, Default: 0 frequencyIntegrationTime – Type: byte, Range: See constants, Default: 3

Sets the counter configuration for the given channel.

Count Edge: Counter can count on rising, falling or both edges.
Count Direction: Counter can count up or down. You can also use another channel as direction input, see here for details.
Duty Cycle Prescaler: Sets a divider for the internal clock. See here for details.
Frequency Integration Time: Sets the integration time for the frequency measurement. See here for details.

The following constants are available for this function:

For channel:

BRICKLET_INDUSTRIAL_COUNTER_CHANNEL_0 = 0
BRICKLET_INDUSTRIAL_COUNTER_CHANNEL_1 = 1
BRICKLET_INDUSTRIAL_COUNTER_CHANNEL_2 = 2
BRICKLET_INDUSTRIAL_COUNTER_CHANNEL_3 = 3

For countEdge:

BRICKLET_INDUSTRIAL_COUNTER_COUNT_EDGE_RISING = 0
BRICKLET_INDUSTRIAL_COUNTER_COUNT_EDGE_FALLING = 1
BRICKLET_INDUSTRIAL_COUNTER_COUNT_EDGE_BOTH = 2

For countDirection:

BRICKLET_INDUSTRIAL_COUNTER_COUNT_DIRECTION_UP = 0
BRICKLET_INDUSTRIAL_COUNTER_COUNT_DIRECTION_DOWN = 1
BRICKLET_INDUSTRIAL_COUNTER_COUNT_DIRECTION_EXTERNAL_UP = 2
BRICKLET_INDUSTRIAL_COUNTER_COUNT_DIRECTION_EXTERNAL_DOWN = 3

For dutyCyclePrescaler:

BRICKLET_INDUSTRIAL_COUNTER_DUTY_CYCLE_PRESCALER_1 = 0
BRICKLET_INDUSTRIAL_COUNTER_DUTY_CYCLE_PRESCALER_2 = 1
BRICKLET_INDUSTRIAL_COUNTER_DUTY_CYCLE_PRESCALER_4 = 2
BRICKLET_INDUSTRIAL_COUNTER_DUTY_CYCLE_PRESCALER_8 = 3
BRICKLET_INDUSTRIAL_COUNTER_DUTY_CYCLE_PRESCALER_16 = 4
BRICKLET_INDUSTRIAL_COUNTER_DUTY_CYCLE_PRESCALER_32 = 5
BRICKLET_INDUSTRIAL_COUNTER_DUTY_CYCLE_PRESCALER_64 = 6
BRICKLET_INDUSTRIAL_COUNTER_DUTY_CYCLE_PRESCALER_128 = 7
BRICKLET_INDUSTRIAL_COUNTER_DUTY_CYCLE_PRESCALER_256 = 8
BRICKLET_INDUSTRIAL_COUNTER_DUTY_CYCLE_PRESCALER_512 = 9
BRICKLET_INDUSTRIAL_COUNTER_DUTY_CYCLE_PRESCALER_1024 = 10
BRICKLET_INDUSTRIAL_COUNTER_DUTY_CYCLE_PRESCALER_2048 = 11
BRICKLET_INDUSTRIAL_COUNTER_DUTY_CYCLE_PRESCALER_4096 = 12
BRICKLET_INDUSTRIAL_COUNTER_DUTY_CYCLE_PRESCALER_8192 = 13
BRICKLET_INDUSTRIAL_COUNTER_DUTY_CYCLE_PRESCALER_16384 = 14
BRICKLET_INDUSTRIAL_COUNTER_DUTY_CYCLE_PRESCALER_32768 = 15

For frequencyIntegrationTime:

BRICKLET_INDUSTRIAL_COUNTER_FREQUENCY_INTEGRATION_TIME_128_MS = 0
BRICKLET_INDUSTRIAL_COUNTER_FREQUENCY_INTEGRATION_TIME_256_MS = 1
BRICKLET_INDUSTRIAL_COUNTER_FREQUENCY_INTEGRATION_TIME_512_MS = 2
BRICKLET_INDUSTRIAL_COUNTER_FREQUENCY_INTEGRATION_TIME_1024_MS = 3
BRICKLET_INDUSTRIAL_COUNTER_FREQUENCY_INTEGRATION_TIME_2048_MS = 4
BRICKLET_INDUSTRIAL_COUNTER_FREQUENCY_INTEGRATION_TIME_4096_MS = 5
BRICKLET_INDUSTRIAL_COUNTER_FREQUENCY_INTEGRATION_TIME_8192_MS = 6
BRICKLET_INDUSTRIAL_COUNTER_FREQUENCY_INTEGRATION_TIME_16384_MS = 7
BRICKLET_INDUSTRIAL_COUNTER_FREQUENCY_INTEGRATION_TIME_32768_MS = 8

procedure TBrickletIndustrialCounter.GetCounterConfiguration(const channel: byte; out countEdge: byte; out countDirection: byte; out dutyCyclePrescaler: byte; out frequencyIntegrationTime: byte)¶

Parameters:	channel – Type: byte, Range: See constants
Output Parameters:	countEdge – Type: byte, Range: See constants, Default: 0 countDirection – Type: byte, Range: See constants, Default: 0 dutyCyclePrescaler – Type: byte, Range: See constants, Default: 0 frequencyIntegrationTime – Type: byte, Range: See constants, Default: 3

Returns the counter configuration as set by SetCounterConfiguration.

The following constants are available for this function:

For channel:

BRICKLET_INDUSTRIAL_COUNTER_CHANNEL_0 = 0
BRICKLET_INDUSTRIAL_COUNTER_CHANNEL_1 = 1
BRICKLET_INDUSTRIAL_COUNTER_CHANNEL_2 = 2
BRICKLET_INDUSTRIAL_COUNTER_CHANNEL_3 = 3

For countEdge:

BRICKLET_INDUSTRIAL_COUNTER_COUNT_EDGE_RISING = 0
BRICKLET_INDUSTRIAL_COUNTER_COUNT_EDGE_FALLING = 1
BRICKLET_INDUSTRIAL_COUNTER_COUNT_EDGE_BOTH = 2

For countDirection:

BRICKLET_INDUSTRIAL_COUNTER_COUNT_DIRECTION_UP = 0
BRICKLET_INDUSTRIAL_COUNTER_COUNT_DIRECTION_DOWN = 1
BRICKLET_INDUSTRIAL_COUNTER_COUNT_DIRECTION_EXTERNAL_UP = 2
BRICKLET_INDUSTRIAL_COUNTER_COUNT_DIRECTION_EXTERNAL_DOWN = 3

For dutyCyclePrescaler:

BRICKLET_INDUSTRIAL_COUNTER_DUTY_CYCLE_PRESCALER_1 = 0
BRICKLET_INDUSTRIAL_COUNTER_DUTY_CYCLE_PRESCALER_2 = 1
BRICKLET_INDUSTRIAL_COUNTER_DUTY_CYCLE_PRESCALER_4 = 2
BRICKLET_INDUSTRIAL_COUNTER_DUTY_CYCLE_PRESCALER_8 = 3
BRICKLET_INDUSTRIAL_COUNTER_DUTY_CYCLE_PRESCALER_16 = 4
BRICKLET_INDUSTRIAL_COUNTER_DUTY_CYCLE_PRESCALER_32 = 5
BRICKLET_INDUSTRIAL_COUNTER_DUTY_CYCLE_PRESCALER_64 = 6
BRICKLET_INDUSTRIAL_COUNTER_DUTY_CYCLE_PRESCALER_128 = 7
BRICKLET_INDUSTRIAL_COUNTER_DUTY_CYCLE_PRESCALER_256 = 8
BRICKLET_INDUSTRIAL_COUNTER_DUTY_CYCLE_PRESCALER_512 = 9
BRICKLET_INDUSTRIAL_COUNTER_DUTY_CYCLE_PRESCALER_1024 = 10
BRICKLET_INDUSTRIAL_COUNTER_DUTY_CYCLE_PRESCALER_2048 = 11
BRICKLET_INDUSTRIAL_COUNTER_DUTY_CYCLE_PRESCALER_4096 = 12
BRICKLET_INDUSTRIAL_COUNTER_DUTY_CYCLE_PRESCALER_8192 = 13
BRICKLET_INDUSTRIAL_COUNTER_DUTY_CYCLE_PRESCALER_16384 = 14
BRICKLET_INDUSTRIAL_COUNTER_DUTY_CYCLE_PRESCALER_32768 = 15

For frequencyIntegrationTime:

BRICKLET_INDUSTRIAL_COUNTER_FREQUENCY_INTEGRATION_TIME_128_MS = 0
BRICKLET_INDUSTRIAL_COUNTER_FREQUENCY_INTEGRATION_TIME_256_MS = 1
BRICKLET_INDUSTRIAL_COUNTER_FREQUENCY_INTEGRATION_TIME_512_MS = 2
BRICKLET_INDUSTRIAL_COUNTER_FREQUENCY_INTEGRATION_TIME_1024_MS = 3
BRICKLET_INDUSTRIAL_COUNTER_FREQUENCY_INTEGRATION_TIME_2048_MS = 4
BRICKLET_INDUSTRIAL_COUNTER_FREQUENCY_INTEGRATION_TIME_4096_MS = 5
BRICKLET_INDUSTRIAL_COUNTER_FREQUENCY_INTEGRATION_TIME_8192_MS = 6
BRICKLET_INDUSTRIAL_COUNTER_FREQUENCY_INTEGRATION_TIME_16384_MS = 7
BRICKLET_INDUSTRIAL_COUNTER_FREQUENCY_INTEGRATION_TIME_32768_MS = 8

procedure TBrickletIndustrialCounter.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.

The following constants are available for this function:

For channel:

BRICKLET_INDUSTRIAL_COUNTER_CHANNEL_0 = 0
BRICKLET_INDUSTRIAL_COUNTER_CHANNEL_1 = 1
BRICKLET_INDUSTRIAL_COUNTER_CHANNEL_2 = 2
BRICKLET_INDUSTRIAL_COUNTER_CHANNEL_3 = 3

For config:

BRICKLET_INDUSTRIAL_COUNTER_CHANNEL_LED_CONFIG_OFF = 0
BRICKLET_INDUSTRIAL_COUNTER_CHANNEL_LED_CONFIG_ON = 1
BRICKLET_INDUSTRIAL_COUNTER_CHANNEL_LED_CONFIG_SHOW_HEARTBEAT = 2
BRICKLET_INDUSTRIAL_COUNTER_CHANNEL_LED_CONFIG_SHOW_CHANNEL_STATUS = 3

function TBrickletIndustrialCounter.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_COUNTER_CHANNEL_0 = 0
BRICKLET_INDUSTRIAL_COUNTER_CHANNEL_1 = 1
BRICKLET_INDUSTRIAL_COUNTER_CHANNEL_2 = 2
BRICKLET_INDUSTRIAL_COUNTER_CHANNEL_3 = 3

For config:

BRICKLET_INDUSTRIAL_COUNTER_CHANNEL_LED_CONFIG_OFF = 0
BRICKLET_INDUSTRIAL_COUNTER_CHANNEL_LED_CONFIG_ON = 1
BRICKLET_INDUSTRIAL_COUNTER_CHANNEL_LED_CONFIG_SHOW_HEARTBEAT = 2
BRICKLET_INDUSTRIAL_COUNTER_CHANNEL_LED_CONFIG_SHOW_CHANNEL_STATUS = 3

Advanced Functions¶

procedure TBrickletIndustrialCounter.GetSPITFPErrorCount(out errorCountAckChecksum: longword; out errorCountMessageChecksum: longword; out errorCountFrame: longword; out errorCountOverflow: longword)¶

Output Parameters:	errorCountAckChecksum – Type: longword, Range: [0 to 2³² - 1] errorCountMessageChecksum – Type: longword, Range: [0 to 2³² - 1] errorCountFrame – Type: longword, Range: [0 to 2³² - 1] errorCountOverflow – Type: longword, Range: [0 to 2³² - 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 TBrickletIndustrialCounter.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_COUNTER_STATUS_LED_CONFIG_OFF = 0
BRICKLET_INDUSTRIAL_COUNTER_STATUS_LED_CONFIG_ON = 1
BRICKLET_INDUSTRIAL_COUNTER_STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
BRICKLET_INDUSTRIAL_COUNTER_STATUS_LED_CONFIG_SHOW_STATUS = 3

function TBrickletIndustrialCounter.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_COUNTER_STATUS_LED_CONFIG_OFF = 0
BRICKLET_INDUSTRIAL_COUNTER_STATUS_LED_CONFIG_ON = 1
BRICKLET_INDUSTRIAL_COUNTER_STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
BRICKLET_INDUSTRIAL_COUNTER_STATUS_LED_CONFIG_SHOW_STATUS = 3

function TBrickletIndustrialCounter.GetChipTemperature: smallint¶

Returns:	temperature – Type: smallint, Unit: 1 °C, Range: [-2¹⁵ to 2¹⁵ - 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 TBrickletIndustrialCounter.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 TBrickletIndustrialCounter.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:

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 2¹⁶ - 1]

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 2¹⁶ - 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 TBrickletIndustrialCounter.SetAllCounterCallbackConfiguration(const period: longword; const valueHasToChange: boolean)¶

Parameters:	period – Type: longword, Unit: 1 ms, Range: [0 to 2³² - 1], Default: 0 valueHasToChange – Type: boolean, Default: false

The period is the period with which the OnAllCounter 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 TBrickletIndustrialCounter.GetAllCounterCallbackConfiguration(out period: longword; out valueHasToChange: boolean)¶

Output Parameters:	period – Type: longword, Unit: 1 ms, Range: [0 to 2³² - 1], Default: 0 valueHasToChange – Type: boolean, Default: false

Returns the callback configuration as set by SetAllCounterCallbackConfiguration.

procedure TBrickletIndustrialCounter.SetAllSignalDataCallbackConfiguration(const period: longword; const valueHasToChange: boolean)¶

Parameters:	period – Type: longword, Unit: 1 ms, Range: [0 to 2³² - 1], Default: 0 valueHasToChange – Type: boolean, Default: false

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

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

procedure TBrickletIndustrialCounter.GetAllSignalDataCallbackConfiguration(out period: longword; out valueHasToChange: boolean)¶

Output Parameters:	period – Type: longword, Unit: 1 ms, Range: [0 to 2³² - 1], Default: 0 valueHasToChange – Type: boolean, Default: false

Returns the callback configuration as set by SetAllSignalDataCallbackConfiguration.

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

industrialCounter.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 TBrickletIndustrialCounter.OnAllCounter¶

procedure(sender: TBrickletIndustrialCounter; const counter: array [0..3] of int64) of object;

Callback Parameters:	sender – Type: TBrickletIndustrialCounter counter – Type: array [0..3] of int64, Range: [-2⁴⁷ to 2⁴⁷ - 1]

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

The parameters are the same as GetAllCounter.

property TBrickletIndustrialCounter.OnAllSignalData¶

procedure(sender: TBrickletIndustrialCounter; const dutyCycle: array [0..3] of word; const period: array [0..3] of uint64; const frequency: array [0..3] of longword; const value: array [0..3] of boolean) of object;

Callback Parameters:	sender – Type: TBrickletIndustrialCounter dutyCycle – Type: array [0..3] of word, Unit: 1/100 %, Range: [0 to 10000] period – Type: array [0..3] of uint64, Unit: 1 ns, Range: [0 to 2⁶⁴ - 1] frequency – Type: array [0..3] of longword, Unit: 1/1000 Hz, Range: [0 to 2³² - 1] value – Type: array [0..3] of boolean

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

The parameters are the same as GetAllSignalData.

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 TBrickletIndustrialCounter.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 TBrickletIndustrialCounter.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_COUNTER_FUNCTION_SET_COUNTER = 3
BRICKLET_INDUSTRIAL_COUNTER_FUNCTION_SET_ALL_COUNTER = 4
BRICKLET_INDUSTRIAL_COUNTER_FUNCTION_SET_COUNTER_ACTIVE = 7
BRICKLET_INDUSTRIAL_COUNTER_FUNCTION_SET_ALL_COUNTER_ACTIVE = 8
BRICKLET_INDUSTRIAL_COUNTER_FUNCTION_SET_COUNTER_CONFIGURATION = 11
BRICKLET_INDUSTRIAL_COUNTER_FUNCTION_SET_ALL_COUNTER_CALLBACK_CONFIGURATION = 13
BRICKLET_INDUSTRIAL_COUNTER_FUNCTION_SET_ALL_SIGNAL_DATA_CALLBACK_CONFIGURATION = 15
BRICKLET_INDUSTRIAL_COUNTER_FUNCTION_SET_CHANNEL_LED_CONFIG = 17
BRICKLET_INDUSTRIAL_COUNTER_FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
BRICKLET_INDUSTRIAL_COUNTER_FUNCTION_SET_STATUS_LED_CONFIG = 239
BRICKLET_INDUSTRIAL_COUNTER_FUNCTION_RESET = 243
BRICKLET_INDUSTRIAL_COUNTER_FUNCTION_WRITE_UID = 248

procedure TBrickletIndustrialCounter.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.

The following constants are available for this function:

For functionId:

BRICKLET_INDUSTRIAL_COUNTER_FUNCTION_SET_COUNTER = 3
BRICKLET_INDUSTRIAL_COUNTER_FUNCTION_SET_ALL_COUNTER = 4
BRICKLET_INDUSTRIAL_COUNTER_FUNCTION_SET_COUNTER_ACTIVE = 7
BRICKLET_INDUSTRIAL_COUNTER_FUNCTION_SET_ALL_COUNTER_ACTIVE = 8
BRICKLET_INDUSTRIAL_COUNTER_FUNCTION_SET_COUNTER_CONFIGURATION = 11
BRICKLET_INDUSTRIAL_COUNTER_FUNCTION_SET_ALL_COUNTER_CALLBACK_CONFIGURATION = 13
BRICKLET_INDUSTRIAL_COUNTER_FUNCTION_SET_ALL_SIGNAL_DATA_CALLBACK_CONFIGURATION = 15
BRICKLET_INDUSTRIAL_COUNTER_FUNCTION_SET_CHANNEL_LED_CONFIG = 17
BRICKLET_INDUSTRIAL_COUNTER_FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
BRICKLET_INDUSTRIAL_COUNTER_FUNCTION_SET_STATUS_LED_CONFIG = 239
BRICKLET_INDUSTRIAL_COUNTER_FUNCTION_RESET = 243
BRICKLET_INDUSTRIAL_COUNTER_FUNCTION_WRITE_UID = 248

procedure TBrickletIndustrialCounter.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 TBrickletIndustrialCounter.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_COUNTER_BOOTLOADER_MODE_BOOTLOADER = 0
BRICKLET_INDUSTRIAL_COUNTER_BOOTLOADER_MODE_FIRMWARE = 1
BRICKLET_INDUSTRIAL_COUNTER_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
BRICKLET_INDUSTRIAL_COUNTER_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
BRICKLET_INDUSTRIAL_COUNTER_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4

For status:

BRICKLET_INDUSTRIAL_COUNTER_BOOTLOADER_STATUS_OK = 0
BRICKLET_INDUSTRIAL_COUNTER_BOOTLOADER_STATUS_INVALID_MODE = 1
BRICKLET_INDUSTRIAL_COUNTER_BOOTLOADER_STATUS_NO_CHANGE = 2
BRICKLET_INDUSTRIAL_COUNTER_BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT = 3
BRICKLET_INDUSTRIAL_COUNTER_BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT = 4
BRICKLET_INDUSTRIAL_COUNTER_BOOTLOADER_STATUS_CRC_MISMATCH = 5

function TBrickletIndustrialCounter.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_COUNTER_BOOTLOADER_MODE_BOOTLOADER = 0
BRICKLET_INDUSTRIAL_COUNTER_BOOTLOADER_MODE_FIRMWARE = 1
BRICKLET_INDUSTRIAL_COUNTER_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
BRICKLET_INDUSTRIAL_COUNTER_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
BRICKLET_INDUSTRIAL_COUNTER_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4

procedure TBrickletIndustrialCounter.SetWriteFirmwarePointer(const pointer: longword)¶

Parameters:	pointer – Type: longword, Unit: 1 B, Range: [0 to 2³² - 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 TBrickletIndustrialCounter.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 TBrickletIndustrialCounter.WriteUID(const uid: longword)¶

Parameters:	uid – Type: longword, Range: [0 to 2³² - 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 TBrickletIndustrialCounter.ReadUID: longword¶

Returns:	uid – Type: longword, Range: [0 to 2³² - 1]

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

Constants¶

const BRICKLET_INDUSTRIAL_COUNTER_DEVICE_IDENTIFIER¶

This constant is used to identify a Industrial Counter 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_COUNTER_DEVICE_DISPLAY_NAME¶: This constant represents the human readable name of a Industrial Counter Bricklet.