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

Delphi/Lazarus - Industrial PTC Bricklet¶

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

type
  TExample = class
  private
    ipcon: TIPConnection;
    ptc: TBrickletIndustrialPTC;
  public
    procedure Execute;
  end;

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

var
  e: TExample;

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

  { Create device object }
  ptc := TBrickletIndustrialPTC.Create(UID, ipcon);

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

  { Get current temperature }
  temperature := ptc.GetTemperature;
  WriteLn(Format('Temperature: %f °C', [temperature/100.0]));

  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, BrickletIndustrialPTC;

type
  TExample = class
  private
    ipcon: TIPConnection;
    ptc: TBrickletIndustrialPTC;
  public
    procedure TemperatureCB(sender: TBrickletIndustrialPTC; const temperature: longint);
    procedure Execute;
  end;

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

var
  e: TExample;

{ Callback procedure for temperature callback }
procedure TExample.TemperatureCB(sender: TBrickletIndustrialPTC;
                                 const temperature: longint);
begin
  WriteLn(Format('Temperature: %f °C', [temperature/100.0]));
end;

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

  { Create device object }
  ptc := TBrickletIndustrialPTC.Create(UID, ipcon);

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

  { Register temperature callback to procedure TemperatureCB }
  ptc.OnTemperature := {$ifdef FPC}@{$endif}TemperatureCB;

  { Set period for temperature callback to 1s (1000ms) without a threshold }
  ptc.SetTemperatureCallbackConfiguration(1000, false, 'x', 0, 0);

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

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

Threshold¶

Download (ExampleThreshold.pas)

program ExampleThreshold;

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

uses
  SysUtils, IPConnection, BrickletIndustrialPTC;

type
  TExample = class
  private
    ipcon: TIPConnection;
    ptc: TBrickletIndustrialPTC;
  public
    procedure TemperatureCB(sender: TBrickletIndustrialPTC; const temperature: longint);
    procedure Execute;
  end;

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

var
  e: TExample;

{ Callback procedure for temperature callback }
procedure TExample.TemperatureCB(sender: TBrickletIndustrialPTC;
                                 const temperature: longint);
begin
  WriteLn(Format('Temperature: %f °C', [temperature/100.0]));
end;

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

  { Create device object }
  ptc := TBrickletIndustrialPTC.Create(UID, ipcon);

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

  { Register temperature callback to procedure TemperatureCB }
  ptc.OnTemperature := {$ifdef FPC}@{$endif}TemperatureCB;

  { Configure threshold for temperature "greater than 30 °C"
    with a debounce period of 1s (1000ms) }
  ptc.SetTemperatureCallbackConfiguration(1000, false, '>', 30*100, 0);

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

Parameters:	uid – Type: string ipcon – Type: TIPConnection
Returns:	industrialPTC – Type: TBrickletIndustrialPTC

Creates an object with the unique device ID uid:

industrialPTC := TBrickletIndustrialPTC.Create('YOUR_DEVICE_UID', ipcon);

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

function TBrickletIndustrialPTC.GetTemperature: longint¶

Returns:	temperature – Type: longint, Unit: 1/100 °C, Range: [-24600 to 84900]

Returns the temperature of the connected sensor.

If you want to get the value periodically, it is recommended to use the OnTemperature callback. You can set the callback configuration with SetTemperatureCallbackConfiguration.

function TBrickletIndustrialPTC.GetResistance: longint¶

Returns:	resistance – Type: longint, Unit: ? Ω, Range: [-2³¹ to 2³¹ - 1]

Returns the value as measured by the MAX31865 precision delta-sigma ADC.

The value can be converted with the following formulas:

Pt100: resistance = (value * 390) / 32768
Pt1000: resistance = (value * 3900) / 32768

If you want to get the value periodically, it is recommended to use the OnResistance callback. You can set the callback configuration with SetResistanceCallbackConfiguration.

function TBrickletIndustrialPTC.IsSensorConnected: boolean¶

Returns:	connected – Type: boolean

Returns true if the sensor is connected correctly.

If this function returns false, there is either no Pt100 or Pt1000 sensor connected, the sensor is connected incorrectly or the sensor itself is faulty.

If you want to get the status automatically, it is recommended to use the OnSensorConnected callback. You can set the callback configuration with SetSensorConnectedCallbackConfiguration.

procedure TBrickletIndustrialPTC.SetWireMode(const mode: byte)¶

Parameters:	mode – Type: byte, Range: See constants, Default: 2

Sets the wire mode of the sensor. Possible values are 2, 3 and 4 which correspond to 2-, 3- and 4-wire sensors. The value has to match the jumper configuration on the Bricklet.

The following constants are available for this function:

For mode:

BRICKLET_INDUSTRIAL_PTC_WIRE_MODE_2 = 2
BRICKLET_INDUSTRIAL_PTC_WIRE_MODE_3 = 3
BRICKLET_INDUSTRIAL_PTC_WIRE_MODE_4 = 4

function TBrickletIndustrialPTC.GetWireMode: byte¶

Returns:	mode – Type: byte, Range: See constants, Default: 2

Returns the wire mode as set by SetWireMode

The following constants are available for this function:

For mode:

BRICKLET_INDUSTRIAL_PTC_WIRE_MODE_2 = 2
BRICKLET_INDUSTRIAL_PTC_WIRE_MODE_3 = 3
BRICKLET_INDUSTRIAL_PTC_WIRE_MODE_4 = 4

procedure TBrickletIndustrialPTC.SetMovingAverageConfiguration(const movingAverageLengthResistance: word; const movingAverageLengthTemperature: word)¶

Parameters:	movingAverageLengthResistance – Type: word, Range: [1 to 1000], Default: 1 movingAverageLengthTemperature – Type: word, Range: [1 to 1000], Default: 40

Sets the length of a moving averaging for the resistance and temperature.

Setting the length to 1 will turn the averaging off. With less averaging, there is more noise on the data.

New data is gathered every 20ms. With a moving average of length 1000 the resulting averaging window has a length of 20s. If you want to do long term measurements the longest moving average will give the cleanest results.

The default values match the non-changeable averaging settings of the old PTC Bricklet 1.0

procedure TBrickletIndustrialPTC.GetMovingAverageConfiguration(out movingAverageLengthResistance: word; out movingAverageLengthTemperature: word)¶

Output Parameters:	movingAverageLengthResistance – Type: word, Range: [1 to 1000], Default: 1 movingAverageLengthTemperature – Type: word, Range: [1 to 1000], Default: 40

Returns the moving average configuration as set by SetMovingAverageConfiguration.

Advanced Functions¶

procedure TBrickletIndustrialPTC.SetNoiseRejectionFilter(const filter: byte)¶

Parameters:	filter – Type: byte, Range: See constants, Default: 0

Sets the noise rejection filter to either 50Hz (0) or 60Hz (1). Noise from 50Hz or 60Hz power sources (including harmonics of the AC power's fundamental frequency) is attenuated by 82dB.

The following constants are available for this function:

For filter:

BRICKLET_INDUSTRIAL_PTC_FILTER_OPTION_50HZ = 0
BRICKLET_INDUSTRIAL_PTC_FILTER_OPTION_60HZ = 1

function TBrickletIndustrialPTC.GetNoiseRejectionFilter: byte¶

Returns:	filter – Type: byte, Range: See constants, Default: 0

Returns the noise rejection filter option as set by SetNoiseRejectionFilter

The following constants are available for this function:

For filter:

BRICKLET_INDUSTRIAL_PTC_FILTER_OPTION_50HZ = 0
BRICKLET_INDUSTRIAL_PTC_FILTER_OPTION_60HZ = 1

procedure TBrickletIndustrialPTC.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 TBrickletIndustrialPTC.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_PTC_STATUS_LED_CONFIG_OFF = 0
BRICKLET_INDUSTRIAL_PTC_STATUS_LED_CONFIG_ON = 1
BRICKLET_INDUSTRIAL_PTC_STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
BRICKLET_INDUSTRIAL_PTC_STATUS_LED_CONFIG_SHOW_STATUS = 3

function TBrickletIndustrialPTC.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_PTC_STATUS_LED_CONFIG_OFF = 0
BRICKLET_INDUSTRIAL_PTC_STATUS_LED_CONFIG_ON = 1
BRICKLET_INDUSTRIAL_PTC_STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
BRICKLET_INDUSTRIAL_PTC_STATUS_LED_CONFIG_SHOW_STATUS = 3

function TBrickletIndustrialPTC.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 TBrickletIndustrialPTC.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 TBrickletIndustrialPTC.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 TBrickletIndustrialPTC.SetTemperatureCallbackConfiguration(const period: longword; const valueHasToChange: boolean; const option: char; const min: longint; const max: longint)¶

Parameters:	period – Type: longword, Unit: 1 ms, Range: [0 to 2³² - 1], Default: 0 valueHasToChange – Type: boolean, Default: false option – Type: char, Range: See constants, Default: 'x' min – Type: longint, Unit: 1/100 °C, Range: [-2³¹ to 2³¹ - 1], Default: 0 max – Type: longint, Unit: 1/100 °C, Range: [-2³¹ to 2³¹ - 1], Default: 0

The period is the period with which the OnTemperature 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.

It is furthermore possible to constrain the callback with thresholds.

The option-parameter together with min/max sets a threshold for the OnTemperature callback.

The following options are possible:

Option	Description
'x'	Threshold is turned off
'o'	Threshold is triggered when the value is outside the min and max values
'i'	Threshold is triggered when the value is inside or equal to the min and max values
'<'	Threshold is triggered when the value is smaller than the min value (max is ignored)
'>'	Threshold is triggered when the value is greater than the min value (max is ignored)

If the option is set to 'x' (threshold turned off) the callback is triggered with the fixed period.

The following constants are available for this function:

For option:

BRICKLET_INDUSTRIAL_PTC_THRESHOLD_OPTION_OFF = 'x'
BRICKLET_INDUSTRIAL_PTC_THRESHOLD_OPTION_OUTSIDE = 'o'
BRICKLET_INDUSTRIAL_PTC_THRESHOLD_OPTION_INSIDE = 'i'
BRICKLET_INDUSTRIAL_PTC_THRESHOLD_OPTION_SMALLER = '<'
BRICKLET_INDUSTRIAL_PTC_THRESHOLD_OPTION_GREATER = '>'

procedure TBrickletIndustrialPTC.GetTemperatureCallbackConfiguration(out period: longword; out valueHasToChange: boolean; out option: char; out min: longint; out max: longint)¶

Output Parameters:	period – Type: longword, Unit: 1 ms, Range: [0 to 2³² - 1], Default: 0 valueHasToChange – Type: boolean, Default: false option – Type: char, Range: See constants, Default: 'x' min – Type: longint, Unit: 1/100 °C, Range: [-2³¹ to 2³¹ - 1], Default: 0 max – Type: longint, Unit: 1/100 °C, Range: [-2³¹ to 2³¹ - 1], Default: 0

Returns the callback configuration as set by SetTemperatureCallbackConfiguration.

The following constants are available for this function:

For option:

BRICKLET_INDUSTRIAL_PTC_THRESHOLD_OPTION_OFF = 'x'
BRICKLET_INDUSTRIAL_PTC_THRESHOLD_OPTION_OUTSIDE = 'o'
BRICKLET_INDUSTRIAL_PTC_THRESHOLD_OPTION_INSIDE = 'i'
BRICKLET_INDUSTRIAL_PTC_THRESHOLD_OPTION_SMALLER = '<'
BRICKLET_INDUSTRIAL_PTC_THRESHOLD_OPTION_GREATER = '>'

procedure TBrickletIndustrialPTC.SetResistanceCallbackConfiguration(const period: longword; const valueHasToChange: boolean; const option: char; const min: longint; const max: longint)¶

Parameters:	period – Type: longword, Unit: 1 ms, Range: [0 to 2³² - 1], Default: 0 valueHasToChange – Type: boolean, Default: false option – Type: char, Range: See constants, Default: 'x' min – Type: longint, Unit: ? Ω, Range: [-2³¹ to 2³¹ - 1], Default: 0 max – Type: longint, Unit: ? Ω, Range: [-2³¹ to 2³¹ - 1], Default: 0

The period is the period with which the OnResistance 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.

It is furthermore possible to constrain the callback with thresholds.

The option-parameter together with min/max sets a threshold for the OnResistance callback.

The following options are possible:

Option	Description
'x'	Threshold is turned off
'o'	Threshold is triggered when the value is outside the min and max values
'i'	Threshold is triggered when the value is inside or equal to the min and max values
'<'	Threshold is triggered when the value is smaller than the min value (max is ignored)
'>'	Threshold is triggered when the value is greater than the min value (max is ignored)

If the option is set to 'x' (threshold turned off) the callback is triggered with the fixed period.

The following constants are available for this function:

For option:

BRICKLET_INDUSTRIAL_PTC_THRESHOLD_OPTION_OFF = 'x'
BRICKLET_INDUSTRIAL_PTC_THRESHOLD_OPTION_OUTSIDE = 'o'
BRICKLET_INDUSTRIAL_PTC_THRESHOLD_OPTION_INSIDE = 'i'
BRICKLET_INDUSTRIAL_PTC_THRESHOLD_OPTION_SMALLER = '<'
BRICKLET_INDUSTRIAL_PTC_THRESHOLD_OPTION_GREATER = '>'

procedure TBrickletIndustrialPTC.GetResistanceCallbackConfiguration(out period: longword; out valueHasToChange: boolean; out option: char; out min: longint; out max: longint)¶

Output Parameters:	period – Type: longword, Unit: 1 ms, Range: [0 to 2³² - 1], Default: 0 valueHasToChange – Type: boolean, Default: false option – Type: char, Range: See constants, Default: 'x' min – Type: longint, Unit: ? Ω, Range: [-2³¹ to 2³¹ - 1], Default: 0 max – Type: longint, Unit: ? Ω, Range: [-2³¹ to 2³¹ - 1], Default: 0

Returns the callback configuration as set by SetResistanceCallbackConfiguration.

The following constants are available for this function:

For option:

BRICKLET_INDUSTRIAL_PTC_THRESHOLD_OPTION_OFF = 'x'
BRICKLET_INDUSTRIAL_PTC_THRESHOLD_OPTION_OUTSIDE = 'o'
BRICKLET_INDUSTRIAL_PTC_THRESHOLD_OPTION_INSIDE = 'i'
BRICKLET_INDUSTRIAL_PTC_THRESHOLD_OPTION_SMALLER = '<'
BRICKLET_INDUSTRIAL_PTC_THRESHOLD_OPTION_GREATER = '>'

procedure TBrickletIndustrialPTC.SetSensorConnectedCallbackConfiguration(const enabled: boolean)¶

Parameters:	enabled – Type: boolean, Default: false

If you enable this callback, the OnSensorConnected callback is triggered every time a Pt sensor is connected/disconnected.

function TBrickletIndustrialPTC.GetSensorConnectedCallbackConfiguration: boolean¶

Returns:	enabled – Type: boolean, Default: false

Returns the configuration as set by SetSensorConnectedCallbackConfiguration.

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

industrialPTC.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 TBrickletIndustrialPTC.OnTemperature¶

procedure(sender: TBrickletIndustrialPTC; const temperature: longint) of object;

Callback Parameters:	sender – Type: TBrickletIndustrialPTC temperature – Type: longint, Unit: 1/100 °C, Range: [-24600 to 84900]

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

The parameter is the same as GetTemperature.

property TBrickletIndustrialPTC.OnResistance¶

procedure(sender: TBrickletIndustrialPTC; const resistance: longint) of object;

Callback Parameters:	sender – Type: TBrickletIndustrialPTC resistance – Type: longint, Unit: ? Ω, Range: [-2³¹ to 2³¹ - 1]

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

The parameter is the same as GetResistance.

property TBrickletIndustrialPTC.OnSensorConnected¶

procedure(sender: TBrickletIndustrialPTC; const connected: boolean) of object;

Callback Parameters:	sender – Type: TBrickletIndustrialPTC connected – Type: boolean

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

The parameter is the same as IsSensorConnected.

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 TBrickletIndustrialPTC.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 TBrickletIndustrialPTC.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_PTC_FUNCTION_SET_TEMPERATURE_CALLBACK_CONFIGURATION = 2
BRICKLET_INDUSTRIAL_PTC_FUNCTION_SET_RESISTANCE_CALLBACK_CONFIGURATION = 6
BRICKLET_INDUSTRIAL_PTC_FUNCTION_SET_NOISE_REJECTION_FILTER = 9
BRICKLET_INDUSTRIAL_PTC_FUNCTION_SET_WIRE_MODE = 12
BRICKLET_INDUSTRIAL_PTC_FUNCTION_SET_MOVING_AVERAGE_CONFIGURATION = 14
BRICKLET_INDUSTRIAL_PTC_FUNCTION_SET_SENSOR_CONNECTED_CALLBACK_CONFIGURATION = 16
BRICKLET_INDUSTRIAL_PTC_FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
BRICKLET_INDUSTRIAL_PTC_FUNCTION_SET_STATUS_LED_CONFIG = 239
BRICKLET_INDUSTRIAL_PTC_FUNCTION_RESET = 243
BRICKLET_INDUSTRIAL_PTC_FUNCTION_WRITE_UID = 248

procedure TBrickletIndustrialPTC.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_PTC_FUNCTION_SET_TEMPERATURE_CALLBACK_CONFIGURATION = 2
BRICKLET_INDUSTRIAL_PTC_FUNCTION_SET_RESISTANCE_CALLBACK_CONFIGURATION = 6
BRICKLET_INDUSTRIAL_PTC_FUNCTION_SET_NOISE_REJECTION_FILTER = 9
BRICKLET_INDUSTRIAL_PTC_FUNCTION_SET_WIRE_MODE = 12
BRICKLET_INDUSTRIAL_PTC_FUNCTION_SET_MOVING_AVERAGE_CONFIGURATION = 14
BRICKLET_INDUSTRIAL_PTC_FUNCTION_SET_SENSOR_CONNECTED_CALLBACK_CONFIGURATION = 16
BRICKLET_INDUSTRIAL_PTC_FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
BRICKLET_INDUSTRIAL_PTC_FUNCTION_SET_STATUS_LED_CONFIG = 239
BRICKLET_INDUSTRIAL_PTC_FUNCTION_RESET = 243
BRICKLET_INDUSTRIAL_PTC_FUNCTION_WRITE_UID = 248

procedure TBrickletIndustrialPTC.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 TBrickletIndustrialPTC.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_PTC_BOOTLOADER_MODE_BOOTLOADER = 0
BRICKLET_INDUSTRIAL_PTC_BOOTLOADER_MODE_FIRMWARE = 1
BRICKLET_INDUSTRIAL_PTC_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
BRICKLET_INDUSTRIAL_PTC_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
BRICKLET_INDUSTRIAL_PTC_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4

For status:

BRICKLET_INDUSTRIAL_PTC_BOOTLOADER_STATUS_OK = 0
BRICKLET_INDUSTRIAL_PTC_BOOTLOADER_STATUS_INVALID_MODE = 1
BRICKLET_INDUSTRIAL_PTC_BOOTLOADER_STATUS_NO_CHANGE = 2
BRICKLET_INDUSTRIAL_PTC_BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT = 3
BRICKLET_INDUSTRIAL_PTC_BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT = 4
BRICKLET_INDUSTRIAL_PTC_BOOTLOADER_STATUS_CRC_MISMATCH = 5

function TBrickletIndustrialPTC.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_PTC_BOOTLOADER_MODE_BOOTLOADER = 0
BRICKLET_INDUSTRIAL_PTC_BOOTLOADER_MODE_FIRMWARE = 1
BRICKLET_INDUSTRIAL_PTC_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
BRICKLET_INDUSTRIAL_PTC_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
BRICKLET_INDUSTRIAL_PTC_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4

procedure TBrickletIndustrialPTC.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 TBrickletIndustrialPTC.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 TBrickletIndustrialPTC.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 TBrickletIndustrialPTC.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_PTC_DEVICE_IDENTIFIER¶

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