This is the description of the Delphi/Lazarus API bindings for the PTC Bricklet 2.0. General information and technical specifications for the PTC Bricklet 2.0 are summarized in its hardware description.
An installation guide for the Delphi/Lazarus API bindings is part of their general description.
The example code below is Public Domain (CC0 1.0).
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 | program ExampleSimple;
{$ifdef MSWINDOWS}{$apptype CONSOLE}{$endif}
{$ifdef FPC}{$mode OBJFPC}{$H+}{$endif}
uses
SysUtils, IPConnection, BrickletPTCV2;
type
TExample = class
private
ipcon: TIPConnection;
ptc: TBrickletPTCV2;
public
procedure Execute;
end;
const
HOST = 'localhost';
PORT = 4223;
UID = 'XYZ'; { Change XYZ to the UID of your PTC Bricklet 2.0 }
var
e: TExample;
procedure TExample.Execute;
var temperature: longint;
begin
{ Create IP connection }
ipcon := TIPConnection.Create;
{ Create device object }
ptc := TBrickletPTCV2.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.
|
Download (ExampleCallback.pas)
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 | program ExampleCallback;
{$ifdef MSWINDOWS}{$apptype CONSOLE}{$endif}
{$ifdef FPC}{$mode OBJFPC}{$H+}{$endif}
uses
SysUtils, IPConnection, BrickletPTCV2;
type
TExample = class
private
ipcon: TIPConnection;
ptc: TBrickletPTCV2;
public
procedure TemperatureCB(sender: TBrickletPTCV2; const temperature: longint);
procedure Execute;
end;
const
HOST = 'localhost';
PORT = 4223;
UID = 'XYZ'; { Change XYZ to the UID of your PTC Bricklet 2.0 }
var
e: TExample;
{ Callback procedure for temperature callback }
procedure TExample.TemperatureCB(sender: TBrickletPTCV2; 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 := TBrickletPTCV2.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.
|
Download (ExampleThreshold.pas)
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 | program ExampleThreshold;
{$ifdef MSWINDOWS}{$apptype CONSOLE}{$endif}
{$ifdef FPC}{$mode OBJFPC}{$H+}{$endif}
uses
SysUtils, IPConnection, BrickletPTCV2;
type
TExample = class
private
ipcon: TIPConnection;
ptc: TBrickletPTCV2;
public
procedure TemperatureCB(sender: TBrickletPTCV2; const temperature: longint);
procedure Execute;
end;
const
HOST = 'localhost';
PORT = 4223;
UID = 'XYZ'; { Change XYZ to the UID of your PTC Bricklet 2.0 }
var
e: TExample;
{ Callback procedure for temperature callback }
procedure TExample.TemperatureCB(sender: TBrickletPTCV2; 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 := TBrickletPTCV2.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.
|
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.
TBrickletPTCV2.
Create
(const uid: string; ipcon: TIPConnection)¶Parameters: |
|
---|---|
Returns: |
|
Creates an object with the unique device ID uid
:
ptcV2 := TBrickletPTCV2.Create('YOUR_DEVICE_UID', ipcon);
This object can then be used after the IP Connection is connected.
TBrickletPTCV2.
GetTemperature
: longint¶Returns: |
|
---|
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
.
TBrickletPTCV2.
GetResistance
: longint¶Returns: |
|
---|
Returns the value as measured by the MAX31865 precision delta-sigma ADC.
The value can be converted with the following formulas:
If you want to get the value periodically, it is recommended to use the
OnResistance
callback. You can set the callback configuration
with SetResistanceCallbackConfiguration
.
TBrickletPTCV2.
IsSensorConnected
: boolean¶Returns: |
|
---|
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
.
TBrickletPTCV2.
SetWireMode
(const mode: byte)¶Parameters: |
|
---|
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:
TBrickletPTCV2.
GetWireMode
: byte¶Returns: |
|
---|
Returns the wire mode as set by SetWireMode
The following constants are available for this function:
For mode:
TBrickletPTCV2.
SetMovingAverageConfiguration
(const movingAverageLengthResistance: word; const movingAverageLengthTemperature: word)¶Parameters: |
|
---|
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
TBrickletPTCV2.
GetMovingAverageConfiguration
(out movingAverageLengthResistance: word; out movingAverageLengthTemperature: word)¶Output Parameters: |
|
---|
Returns the moving average configuration as set by SetMovingAverageConfiguration
.
TBrickletPTCV2.
SetNoiseRejectionFilter
(const filter: byte)¶Parameters: |
|
---|
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:
TBrickletPTCV2.
GetNoiseRejectionFilter
: byte¶Returns: |
|
---|
Returns the noise rejection filter option as set by
SetNoiseRejectionFilter
The following constants are available for this function:
For filter:
TBrickletPTCV2.
GetSPITFPErrorCount
(out errorCountAckChecksum: longword; out errorCountMessageChecksum: longword; out errorCountFrame: longword; out errorCountOverflow: longword)¶Output Parameters: |
|
---|
Returns the error count for the communication between Brick and Bricklet.
The errors are divided into
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.
TBrickletPTCV2.
SetStatusLEDConfig
(const config: byte)¶Parameters: |
|
---|
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:
TBrickletPTCV2.
GetStatusLEDConfig
: byte¶Returns: |
|
---|
Returns the configuration as set by SetStatusLEDConfig
The following constants are available for this function:
For config:
TBrickletPTCV2.
GetChipTemperature
: smallint¶Returns: |
|
---|
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.
TBrickletPTCV2.
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!
TBrickletPTCV2.
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: |
|
---|
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.
TBrickletPTCV2.
SetTemperatureCallbackConfiguration
(const period: longword; const valueHasToChange: boolean; const option: char; const min: longint; const max: longint)¶Parameters: |
|
---|
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:
TBrickletPTCV2.
GetTemperatureCallbackConfiguration
(out period: longword; out valueHasToChange: boolean; out option: char; out min: longint; out max: longint)¶Output Parameters: |
|
---|
Returns the callback configuration as set by SetTemperatureCallbackConfiguration
.
The following constants are available for this function:
For option:
TBrickletPTCV2.
SetResistanceCallbackConfiguration
(const period: longword; const valueHasToChange: boolean; const option: char; const min: longint; const max: longint)¶Parameters: |
|
---|
The period is the period with which the OnResistance
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 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:
TBrickletPTCV2.
GetResistanceCallbackConfiguration
(out period: longword; out valueHasToChange: boolean; out option: char; out min: longint; out max: longint)¶Output Parameters: |
|
---|
Returns the callback configuration as set by SetResistanceCallbackConfiguration
.
The following constants are available for this function:
For option:
TBrickletPTCV2.
SetSensorConnectedCallbackConfiguration
(const enabled: boolean)¶Parameters: |
|
---|
If you enable this callback, the OnSensorConnected
callback is triggered
every time a Pt sensor is connected/disconnected.
TBrickletPTCV2.
GetSensorConnectedCallbackConfiguration
: boolean¶Returns: |
|
---|
Returns the configuration as set by SetSensorConnectedCallbackConfiguration
.
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: TBrickletPTCV2; const value: longint); begin WriteLn(Format('Value: %d', [value])); end; ptcV2.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.
TBrickletPTCV2.
OnTemperature
¶procedure(sender: TBrickletPTCV2; const temperature: longint) of object;
Callback Parameters: |
|
---|
This callback is triggered periodically according to the configuration set by
SetTemperatureCallbackConfiguration
.
The parameter is the same as GetTemperature
.
TBrickletPTCV2.
OnResistance
¶procedure(sender: TBrickletPTCV2; const resistance: longint) of object;
Callback Parameters: |
|
---|
This callback is triggered periodically according to the configuration set by
SetResistanceCallbackConfiguration
.
The parameter is the same as GetResistance
.
TBrickletPTCV2.
OnSensorConnected
¶procedure(sender: TBrickletPTCV2; const connected: boolean) of object;
Callback Parameters: |
|
---|
This callback is triggered periodically according to the configuration set by
SetSensorConnectedCallbackConfiguration
.
The parameter is the same as IsSensorConnected
.
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.
TBrickletPTCV2.
GetAPIVersion
: array [0..2] of byte¶Output Parameters: |
|
---|
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.
TBrickletPTCV2.
GetResponseExpected
(const functionId: byte): boolean¶Parameters: |
|
---|---|
Returns: |
|
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:
TBrickletPTCV2.
SetResponseExpected
(const functionId: byte; const responseExpected: boolean)¶Parameters: |
|
---|
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:
TBrickletPTCV2.
SetResponseExpectedAll
(const responseExpected: boolean)¶Parameters: |
|
---|
Changes the response expected flag for all setter and callback configuration functions of this device at once.
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.
TBrickletPTCV2.
SetBootloaderMode
(const mode: byte): byte¶Parameters: |
|
---|---|
Returns: |
|
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:
For status:
TBrickletPTCV2.
GetBootloaderMode
: byte¶Returns: |
|
---|
Returns the current bootloader mode, see SetBootloaderMode
.
The following constants are available for this function:
For mode:
TBrickletPTCV2.
SetWriteFirmwarePointer
(const pointer: longword)¶Parameters: |
|
---|
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.
TBrickletPTCV2.
WriteFirmware
(const data: array [0..63] of byte): byte¶Parameters: |
|
---|---|
Returns: |
|
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.
TBrickletPTCV2.
WriteUID
(const uid: longword)¶Parameters: |
|
---|
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.
TBrickletPTCV2.
ReadUID
: longword¶Returns: |
|
---|
Returns the current UID as an integer. Encode as Base58 to get the usual string version.
BRICKLET_PTC_V2_DEVICE_IDENTIFIER
¶This constant is used to identify a PTC Bricklet 2.0.
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.
BRICKLET_PTC_V2_DEVICE_DISPLAY_NAME
¶This constant represents the human readable name of a PTC Bricklet 2.0.