Perl - PTC Bricklet 2.0

This is the description of the Perl 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 Perl API bindings is part of their general description.

Examples

The example code below is Public Domain (CC0 1.0).

Simple

Download (example_simple.pl)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
#!/usr/bin/perl

use strict;
use Tinkerforge::IPConnection;
use Tinkerforge::BrickletPTCV2;

use constant HOST => 'localhost';
use constant PORT => 4223;
use constant UID => 'XYZ'; # Change XYZ to the UID of your PTC Bricklet 2.0

my $ipcon = Tinkerforge::IPConnection->new(); # Create IP connection
my $ptc = Tinkerforge::BrickletPTCV2->new(&UID, $ipcon); # Create device object

$ipcon->connect(&HOST, &PORT); # Connect to brickd
# Don't use device before ipcon is connected

# Get current temperature
my $temperature = $ptc->get_temperature();
print "Temperature: " . $temperature/100.0 . " °C\n";

print "Press key to exit\n";
<STDIN>;
$ipcon->disconnect();

Callback

Download (example_callback.pl)

 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
#!/usr/bin/perl

use strict;
use Tinkerforge::IPConnection;
use Tinkerforge::BrickletPTCV2;

use constant HOST => 'localhost';
use constant PORT => 4223;
use constant UID => 'XYZ'; # Change XYZ to the UID of your PTC Bricklet 2.0

# Callback subroutine for temperature callback
sub cb_temperature
{
    my ($temperature) = @_;

    print "Temperature: " . $temperature/100.0 . " °C\n";
}

my $ipcon = Tinkerforge::IPConnection->new(); # Create IP connection
my $ptc = Tinkerforge::BrickletPTCV2->new(&UID, $ipcon); # Create device object

$ipcon->connect(&HOST, &PORT); # Connect to brickd
# Don't use device before ipcon is connected

# Register temperature callback to subroutine cb_temperature
$ptc->register_callback($ptc->CALLBACK_TEMPERATURE, 'cb_temperature');

# Set period for temperature callback to 1s (1000ms) without a threshold
$ptc->set_temperature_callback_configuration(1000, 0, 'x', 0, 0);

print "Press key to exit\n";
<STDIN>;
$ipcon->disconnect();

Threshold

Download (example_threshold.pl)

 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
#!/usr/bin/perl

use strict;
use Tinkerforge::IPConnection;
use Tinkerforge::BrickletPTCV2;

use constant HOST => 'localhost';
use constant PORT => 4223;
use constant UID => 'XYZ'; # Change XYZ to the UID of your PTC Bricklet 2.0

# Callback subroutine for temperature callback
sub cb_temperature
{
    my ($temperature) = @_;

    print "Temperature: " . $temperature/100.0 . " °C\n";
}

my $ipcon = Tinkerforge::IPConnection->new(); # Create IP connection
my $ptc = Tinkerforge::BrickletPTCV2->new(&UID, $ipcon); # Create device object

$ipcon->connect(&HOST, &PORT); # Connect to brickd
# Don't use device before ipcon is connected

# Register temperature callback to subroutine cb_temperature
$ptc->register_callback($ptc->CALLBACK_TEMPERATURE, 'cb_temperature');

# Configure threshold for temperature "greater than 30 °C"
# with a debounce period of 1s (1000ms)
$ptc->set_temperature_callback_configuration(1000, 0, '>', 30*100, 0);

print "Press key to exit\n";
<STDIN>;
$ipcon->disconnect();

API

Generally, every subroutine of the Perl bindings can report an error as Tinkerforge::Error object via croak(). The object has a get_code() and a get_message() subroutine. There are different error code:

  • Error->ALREADY_CONNECTED = 11
  • Error->NOT_CONNECTED = 12
  • Error->CONNECT_FAILED = 13
  • Error->INVALID_FUNCTION_ID = 21
  • Error->TIMEOUT = 31
  • Error->INVALID_PARAMETER = 41
  • Error->FUNCTION_NOT_SUPPORTED = 42
  • Error->UNKNOWN_ERROR = 43
  • Error->STREAM_OUT_OF_SYNC = 51
  • Error->INVALID_UID = 61
  • Error->NON_ASCII_CHAR_IN_SECRET = 71

All functions listed below are thread-safe.

Basic Functions

BrickletPTCV2->new($uid, $ipcon)
Parameters:
  • $uid – Type: string
  • $ipcon – Type: IPConnection
Returns:
  • $ptc_v2 – Type: BrickletPTCV2

Creates an object with the unique device ID $uid:

$ptc_v2 = BrickletPTCV2->new("YOUR_DEVICE_UID", $ipcon);

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

BrickletPTCV2->get_temperature()
Returns:
  • $temperature – Type: int, 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 CALLBACK_TEMPERATURE callback. You can set the callback configuration with set_temperature_callback_configuration().

BrickletPTCV2->get_resistance()
Returns:
  • $resistance – Type: int, Unit: ? Ω, Range: [-231 to 231 - 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 CALLBACK_RESISTANCE callback. You can set the callback configuration with set_resistance_callback_configuration().

BrickletPTCV2->is_sensor_connected()
Returns:
  • $connected – Type: bool

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 CALLBACK_SENSOR_CONNECTED callback. You can set the callback configuration with set_sensor_connected_callback_configuration().

BrickletPTCV2->set_wire_mode($mode)
Parameters:
  • $mode – Type: int, Range: See constants, Default: 2
Returns:
  • undef

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:

  • BrickletPTCV2->WIRE_MODE_2 = 2
  • BrickletPTCV2->WIRE_MODE_3 = 3
  • BrickletPTCV2->WIRE_MODE_4 = 4
BrickletPTCV2->get_wire_mode()
Returns:
  • $mode – Type: int, Range: See constants, Default: 2

Returns the wire mode as set by set_wire_mode()

The following constants are available for this function:

For $mode:

  • BrickletPTCV2->WIRE_MODE_2 = 2
  • BrickletPTCV2->WIRE_MODE_3 = 3
  • BrickletPTCV2->WIRE_MODE_4 = 4
BrickletPTCV2->set_moving_average_configuration($moving_average_length_resistance, $moving_average_length_temperature)
Parameters:
  • $moving_average_length_resistance – Type: int, Range: [1 to 1000], Default: 1
  • $moving_average_length_temperature – Type: int, Range: [1 to 1000], Default: 40
Returns:
  • undef

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

BrickletPTCV2->get_moving_average_configuration()
Return Array:
  • 0: $moving_average_length_resistance – Type: int, Range: [1 to 1000], Default: 1
  • 1: $moving_average_length_temperature – Type: int, Range: [1 to 1000], Default: 40

Returns the moving average configuration as set by set_moving_average_configuration().

Advanced Functions

BrickletPTCV2->set_noise_rejection_filter($filter)
Parameters:
  • $filter – Type: int, Range: See constants, Default: 0
Returns:
  • undef

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:

  • BrickletPTCV2->FILTER_OPTION_50HZ = 0
  • BrickletPTCV2->FILTER_OPTION_60HZ = 1
BrickletPTCV2->get_noise_rejection_filter()
Returns:
  • $filter – Type: int, Range: See constants, Default: 0

Returns the noise rejection filter option as set by set_noise_rejection_filter()

The following constants are available for this function:

For $filter:

  • BrickletPTCV2->FILTER_OPTION_50HZ = 0
  • BrickletPTCV2->FILTER_OPTION_60HZ = 1
BrickletPTCV2->get_spitfp_error_count()
Return Array:
  • 0: $error_count_ack_checksum – Type: int, Range: [0 to 232 - 1]
  • 1: $error_count_message_checksum – Type: int, Range: [0 to 232 - 1]
  • 2: $error_count_frame – Type: int, Range: [0 to 232 - 1]
  • 3: $error_count_overflow – Type: int, 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.

BrickletPTCV2->set_bootloader_mode($mode)
Parameters:
  • $mode – Type: int, Range: See constants
Returns:
  • $status – Type: int, 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:

  • BrickletPTCV2->BOOTLOADER_MODE_BOOTLOADER = 0
  • BrickletPTCV2->BOOTLOADER_MODE_FIRMWARE = 1
  • BrickletPTCV2->BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
  • BrickletPTCV2->BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
  • BrickletPTCV2->BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4

For $status:

  • BrickletPTCV2->BOOTLOADER_STATUS_OK = 0
  • BrickletPTCV2->BOOTLOADER_STATUS_INVALID_MODE = 1
  • BrickletPTCV2->BOOTLOADER_STATUS_NO_CHANGE = 2
  • BrickletPTCV2->BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT = 3
  • BrickletPTCV2->BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT = 4
  • BrickletPTCV2->BOOTLOADER_STATUS_CRC_MISMATCH = 5
BrickletPTCV2->get_bootloader_mode()
Returns:
  • $mode – Type: int, Range: See constants

Returns the current bootloader mode, see set_bootloader_mode().

The following constants are available for this function:

For $mode:

  • BrickletPTCV2->BOOTLOADER_MODE_BOOTLOADER = 0
  • BrickletPTCV2->BOOTLOADER_MODE_FIRMWARE = 1
  • BrickletPTCV2->BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
  • BrickletPTCV2->BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
  • BrickletPTCV2->BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4
BrickletPTCV2->set_write_firmware_pointer($pointer)
Parameters:
  • $pointer – Type: int, Unit: 1 B, Range: [0 to 232 - 1]
Returns:
  • undef

Sets the firmware pointer for write_firmware(). 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.

BrickletPTCV2->write_firmware(@data)
Parameters:
  • @data – Type: [int, ...], Length: 64, Range: [0 to 255]
Returns:
  • $status – Type: int, Range: [0 to 255]

Writes 64 Bytes of firmware at the position as written by set_write_firmware_pointer() 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.

BrickletPTCV2->set_status_led_config($config)
Parameters:
  • $config – Type: int, Range: See constants, Default: 3
Returns:
  • undef

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:

  • BrickletPTCV2->STATUS_LED_CONFIG_OFF = 0
  • BrickletPTCV2->STATUS_LED_CONFIG_ON = 1
  • BrickletPTCV2->STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • BrickletPTCV2->STATUS_LED_CONFIG_SHOW_STATUS = 3
BrickletPTCV2->get_status_led_config()
Returns:
  • $config – Type: int, Range: See constants, Default: 3

Returns the configuration as set by set_status_led_config()

The following constants are available for this function:

For $config:

  • BrickletPTCV2->STATUS_LED_CONFIG_OFF = 0
  • BrickletPTCV2->STATUS_LED_CONFIG_ON = 1
  • BrickletPTCV2->STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • BrickletPTCV2->STATUS_LED_CONFIG_SHOW_STATUS = 3
BrickletPTCV2->get_chip_temperature()
Returns:
  • $temperature – Type: int, 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.

BrickletPTCV2->reset()
Returns:
  • undef

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!

BrickletPTCV2->write_uid($uid)
Parameters:
  • $uid – Type: int, Range: [0 to 232 - 1]
Returns:
  • undef

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.

BrickletPTCV2->read_uid()
Returns:
  • $uid – Type: int, Range: [0 to 232 - 1]

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

BrickletPTCV2->get_identity()
Return Array:
  • 0: $uid – Type: string, Length: up to 8
  • 1: $connected_uid – Type: string, Length: up to 8
  • 2: $position – Type: char, Range: ['a' to 'h', 'i', 'z']
  • 3: @hardware_version – Type: [int, ...], Length: 3
    • 0: $major – Type: int, Range: [0 to 255]
    • 1: $minor – Type: int, Range: [0 to 255]
    • 2: $revision – Type: int, Range: [0 to 255]
  • 4: @firmware_version – Type: [int, ...], Length: 3
    • 0: $major – Type: int, Range: [0 to 255]
    • 1: $minor – Type: int, Range: [0 to 255]
    • 2: $revision – Type: int, Range: [0 to 255]
  • 5: $device_identifier – Type: int, 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). The Raspberry Pi HAT (Zero) Brick is always at position 'i' and the Bricklet connected to an Isolator Bricklet is always as 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

BrickletPTCV2->register_callback($callback_id, $function)
Parameters:
  • $callback_id – Type: int
  • $function – Type: string
Returns:
  • undef

Registers the given $function name with the given $callback_id.

The available callback IDs with corresponding function signatures are listed below.

BrickletPTCV2->set_temperature_callback_configuration($period, $value_has_to_change, $option, $min, $max)
Parameters:
  • $period – Type: int, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0
  • $value_has_to_change – Type: bool, Default: 0
  • $option – Type: char, Range: See constants, Default: 'x'
  • $min – Type: int, Unit: 1/100 °C, Range: [-231 to 231 - 1], Default: 0
  • $max – Type: int, Unit: 1/100 °C, Range: [-231 to 231 - 1], Default: 0
Returns:
  • undef

The period is the period with which the CALLBACK_TEMPERATURE 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 CALLBACK_TEMPERATURE 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:

  • BrickletPTCV2->THRESHOLD_OPTION_OFF = 'x'
  • BrickletPTCV2->THRESHOLD_OPTION_OUTSIDE = 'o'
  • BrickletPTCV2->THRESHOLD_OPTION_INSIDE = 'i'
  • BrickletPTCV2->THRESHOLD_OPTION_SMALLER = '<'
  • BrickletPTCV2->THRESHOLD_OPTION_GREATER = '>'
BrickletPTCV2->get_temperature_callback_configuration()
Return Array:
  • 0: $period – Type: int, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0
  • 1: $value_has_to_change – Type: bool, Default: 0
  • 2: $option – Type: char, Range: See constants, Default: 'x'
  • 3: $min – Type: int, Unit: 1/100 °C, Range: [-231 to 231 - 1], Default: 0
  • 4: $max – Type: int, Unit: 1/100 °C, Range: [-231 to 231 - 1], Default: 0

Returns the callback configuration as set by set_temperature_callback_configuration().

The following constants are available for this function:

For $option:

  • BrickletPTCV2->THRESHOLD_OPTION_OFF = 'x'
  • BrickletPTCV2->THRESHOLD_OPTION_OUTSIDE = 'o'
  • BrickletPTCV2->THRESHOLD_OPTION_INSIDE = 'i'
  • BrickletPTCV2->THRESHOLD_OPTION_SMALLER = '<'
  • BrickletPTCV2->THRESHOLD_OPTION_GREATER = '>'
BrickletPTCV2->set_resistance_callback_configuration($period, $value_has_to_change, $option, $min, $max)
Parameters:
  • $period – Type: int, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0
  • $value_has_to_change – Type: bool, Default: 0
  • $option – Type: char, Range: See constants, Default: 'x'
  • $min – Type: int, Unit: ? Ω, Range: [-231 to 231 - 1], Default: 0
  • $max – Type: int, Unit: ? Ω, Range: [-231 to 231 - 1], Default: 0
Returns:
  • undef

The period is the period with which the CALLBACK_RESISTANCE 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 CALLBACK_RESISTANCE 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:

  • BrickletPTCV2->THRESHOLD_OPTION_OFF = 'x'
  • BrickletPTCV2->THRESHOLD_OPTION_OUTSIDE = 'o'
  • BrickletPTCV2->THRESHOLD_OPTION_INSIDE = 'i'
  • BrickletPTCV2->THRESHOLD_OPTION_SMALLER = '<'
  • BrickletPTCV2->THRESHOLD_OPTION_GREATER = '>'
BrickletPTCV2->get_resistance_callback_configuration()
Return Array:
  • 0: $period – Type: int, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0
  • 1: $value_has_to_change – Type: bool, Default: 0
  • 2: $option – Type: char, Range: See constants, Default: 'x'
  • 3: $min – Type: int, Unit: ? Ω, Range: [-231 to 231 - 1], Default: 0
  • 4: $max – Type: int, Unit: ? Ω, Range: [-231 to 231 - 1], Default: 0

Returns the callback configuration as set by set_resistance_callback_configuration().

The following constants are available for this function:

For $option:

  • BrickletPTCV2->THRESHOLD_OPTION_OFF = 'x'
  • BrickletPTCV2->THRESHOLD_OPTION_OUTSIDE = 'o'
  • BrickletPTCV2->THRESHOLD_OPTION_INSIDE = 'i'
  • BrickletPTCV2->THRESHOLD_OPTION_SMALLER = '<'
  • BrickletPTCV2->THRESHOLD_OPTION_GREATER = '>'
BrickletPTCV2->set_sensor_connected_callback_configuration($enabled)
Parameters:
  • $enabled – Type: bool, Default: 0
Returns:
  • undef

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

BrickletPTCV2->get_sensor_connected_callback_configuration()
Returns:
  • $enabled – Type: bool, Default: 0

Returns the configuration as set by set_sensor_connected_callback_configuration().

Callbacks

Callbacks can be registered to receive time critical or recurring data from the device. The registration is done with the register_callback() function of the device object. The first parameter is the callback ID and the second parameter the callback function name:

sub my_callback
{
    print "@_[0]";
}

$ptc_v2->register_callback(BrickletPTCV2->CALLBACK_EXAMPLE, 'my_callback')

The callback function will be called from an internal thread of the IP Connection. In contrast to many other programming languages, variables are not automatically shared between threads in Perl. If you want to share a global variable between a callback function and the rest for your program it has to be marked as :shared. See the documentation of the threads::shared Perl module for more details.

The available constants with inherent number and type of parameters are described below.

Note

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

BrickletPTCV2->CALLBACK_TEMPERATURE
Callback Parameters:
  • $temperature – Type: int, Unit: 1/100 °C, Range: [-24600 to 84900]

This callback is triggered periodically according to the configuration set by set_temperature_callback_configuration().

The parameter is the same as get_temperature().

BrickletPTCV2->CALLBACK_RESISTANCE
Callback Parameters:
  • $resistance – Type: int, Unit: ? Ω, Range: [-231 to 231 - 1]

This callback is triggered periodically according to the configuration set by set_resistance_callback_configuration().

The parameter is the same as get_resistance().

BrickletPTCV2->CALLBACK_SENSOR_CONNECTED
Callback Parameters:
  • $connected – Type: bool

This callback is triggered periodically according to the configuration set by set_sensor_connected_callback_configuration().

The parameter is the same as is_sensor_connected().

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.

BrickletPTCV2->get_api_version()
Return Array:
  • 0: @api_version – Type: [int, ...], Length: 3
    • 0: $major – Type: int, Range: [0 to 255]
    • 1: $minor – Type: int, Range: [0 to 255]
    • 2: $revision – Type: int, 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.

BrickletPTCV2->get_response_expected($function_id)
Parameters:
  • $function_id – Type: int, Range: See constants
Returns:
  • $response_expected – Type: bool

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 set_response_expected(). For setter functions it is disabled by default and can be enabled.

Enabling the response expected flag for a setter function allows to detect timeouts and other error conditions calls of this setter as well. The device will then send a response for this purpose. If this flag is disabled for a setter function then no response is send and errors are silently ignored, because they cannot be detected.

The following constants are available for this function:

For $function_id:

  • BrickletPTCV2->FUNCTION_SET_TEMPERATURE_CALLBACK_CONFIGURATION = 2
  • BrickletPTCV2->FUNCTION_SET_RESISTANCE_CALLBACK_CONFIGURATION = 6
  • BrickletPTCV2->FUNCTION_SET_NOISE_REJECTION_FILTER = 9
  • BrickletPTCV2->FUNCTION_SET_WIRE_MODE = 12
  • BrickletPTCV2->FUNCTION_SET_MOVING_AVERAGE_CONFIGURATION = 14
  • BrickletPTCV2->FUNCTION_SET_SENSOR_CONNECTED_CALLBACK_CONFIGURATION = 16
  • BrickletPTCV2->FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
  • BrickletPTCV2->FUNCTION_SET_STATUS_LED_CONFIG = 239
  • BrickletPTCV2->FUNCTION_RESET = 243
  • BrickletPTCV2->FUNCTION_WRITE_UID = 248
BrickletPTCV2->set_response_expected($function_id, $response_expected)
Parameters:
  • $function_id – Type: int, Range: See constants
  • $response_expected – Type: bool
Returns:
  • undef

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 send and errors are silently ignored, because they cannot be detected.

The following constants are available for this function:

For $function_id:

  • BrickletPTCV2->FUNCTION_SET_TEMPERATURE_CALLBACK_CONFIGURATION = 2
  • BrickletPTCV2->FUNCTION_SET_RESISTANCE_CALLBACK_CONFIGURATION = 6
  • BrickletPTCV2->FUNCTION_SET_NOISE_REJECTION_FILTER = 9
  • BrickletPTCV2->FUNCTION_SET_WIRE_MODE = 12
  • BrickletPTCV2->FUNCTION_SET_MOVING_AVERAGE_CONFIGURATION = 14
  • BrickletPTCV2->FUNCTION_SET_SENSOR_CONNECTED_CALLBACK_CONFIGURATION = 16
  • BrickletPTCV2->FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
  • BrickletPTCV2->FUNCTION_SET_STATUS_LED_CONFIG = 239
  • BrickletPTCV2->FUNCTION_RESET = 243
  • BrickletPTCV2->FUNCTION_WRITE_UID = 248
BrickletPTCV2->set_response_expected_all($response_expected)
Parameters:
  • $response_expected – Type: bool
Returns:
  • undef

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

Constants

BrickletPTCV2->DEVICE_IDENTIFIER

This constant is used to identify a PTC Bricklet 2.0.

The get_identity() function and the IPConnection->CALLBACK_ENUMERATE callback of the IP Connection have a device_identifier parameter to specify the Brick's or Bricklet's type.

BrickletPTCV2->DEVICE_DISPLAY_NAME

This constant represents the human readable name of a PTC Bricklet 2.0.