Software / API Bindings / PHP / API Reference and Examples / Bricklets (Discontinued) / PTC Bricklet

PHP - PTC Bricklet¶

This is the description of the PHP API bindings for the PTC Bricklet. General information and technical specifications for the PTC Bricklet are summarized in its hardware description.

An installation guide for the PHP API bindings is part of their general description.

Examples¶

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

Simple¶

Download (ExampleSimple.php)

<?php

require_once('Tinkerforge/IPConnection.php');
require_once('Tinkerforge/BrickletPTC.php');

use Tinkerforge\IPConnection;
use Tinkerforge\BrickletPTC;

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

$ipcon = new IPConnection(); // Create IP connection
$ptc = new BrickletPTC(UID, $ipcon); // Create device object

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

// Get current temperature
$temperature = $ptc->getTemperature();
echo "Temperature: " . $temperature/100.0 . " °C\n";

echo "Press key to exit\n";
fgetc(fopen('php://stdin', 'r'));
$ipcon->disconnect();

?>

Callback¶

Download (ExampleCallback.php)

<?php

require_once('Tinkerforge/IPConnection.php');
require_once('Tinkerforge/BrickletPTC.php');

use Tinkerforge\IPConnection;
use Tinkerforge\BrickletPTC;

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

// Callback function for temperature callback
function cb_temperature($temperature)
{
    echo "Temperature: " . $temperature/100.0 . " °C\n";
}

$ipcon = new IPConnection(); // Create IP connection
$ptc = new BrickletPTC(UID, $ipcon); // Create device object

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

// Register temperature callback to function cb_temperature
$ptc->registerCallback(BrickletPTC::CALLBACK_TEMPERATURE, 'cb_temperature');

// Set period for temperature callback to 1s (1000ms)
// Note: The temperature callback is only called every second
//       if the temperature has changed since the last call!
$ptc->setTemperatureCallbackPeriod(1000);

echo "Press ctrl+c to exit\n";
$ipcon->dispatchCallbacks(-1); // Dispatch callbacks forever

?>

Threshold¶

Download (ExampleThreshold.php)

<?php

require_once('Tinkerforge/IPConnection.php');
require_once('Tinkerforge/BrickletPTC.php');

use Tinkerforge\IPConnection;
use Tinkerforge\BrickletPTC;

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

// Callback function for temperature reached callback
function cb_temperatureReached($temperature)
{
    echo "Temperature: " . $temperature/100.0 . " °C\n";
}

$ipcon = new IPConnection(); // Create IP connection
$ptc = new BrickletPTC(UID, $ipcon); // Create device object

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

// Get threshold callbacks with a debounce time of 10 seconds (10000ms)
$ptc->setDebouncePeriod(10000);

// Register temperature reached callback to function cb_temperatureReached
$ptc->registerCallback(BrickletPTC::CALLBACK_TEMPERATURE_REACHED,
                       'cb_temperatureReached');

// Configure threshold for temperature "greater than 30 °C"
$ptc->setTemperatureCallbackThreshold('>', 30*100, 0);

echo "Press ctrl+c to exit\n";
$ipcon->dispatchCallbacks(-1); // Dispatch callbacks forever

?>

API¶

Functions that return multiple values return them in an associative array.

Basic Functions¶

class BrickletPTC(string $uid, IPConnection $ipcon)¶

Parameters:	$uid – Type: string $ipcon – Type: IPConnection
Returns:	$ptc – Type: BrickletPTC

Creates an object with the unique device ID $uid:

<?php   $ptc = new BrickletPTC('YOUR_DEVICE_UID', $ipcon);   ?>

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

int BrickletPTC::getTemperature()¶

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

Returns the temperature of connected sensor.

If you want to get the temperature periodically, it is recommended to use the CALLBACK_TEMPERATURE callback and set the period with setTemperatureCallbackPeriod().

bool BrickletPTC::isSensorConnected()¶

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.

void BrickletPTC::setWireMode(int $mode)¶

Parameters:	$mode – Type: int, 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:

BrickletPTC::WIRE_MODE_2 = 2
BrickletPTC::WIRE_MODE_3 = 3
BrickletPTC::WIRE_MODE_4 = 4

int BrickletPTC::getWireMode()¶

Returns:	$mode – Type: int, Range: See constants, Default: 2

Returns the wire mode as set by setWireMode()

The following constants are available for this function:

For $mode:

BrickletPTC::WIRE_MODE_2 = 2
BrickletPTC::WIRE_MODE_3 = 3
BrickletPTC::WIRE_MODE_4 = 4

Advanced Functions¶

int BrickletPTC::getResistance()¶

Returns:	$resistance – Type: int, 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 resistance periodically, it is recommended to use the CALLBACK_RESISTANCE callback and set the period with setResistanceCallbackPeriod().

void BrickletPTC::setNoiseRejectionFilter(int $filter)¶

Parameters:	$filter – Type: int, 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:

BrickletPTC::FILTER_OPTION_50HZ = 0
BrickletPTC::FILTER_OPTION_60HZ = 1

int BrickletPTC::getNoiseRejectionFilter()¶

Returns:	$filter – Type: int, 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:

BrickletPTC::FILTER_OPTION_50HZ = 0
BrickletPTC::FILTER_OPTION_60HZ = 1

array BrickletPTC::getIdentity()¶

Return Array:

Return Array:	'uid' – Type: string, Length: up to 8 'connected_uid' – Type: string, Length: up to 8 'position' – Type: string, Range: ['a' to 'h', 'z'] 'hardware_version' – Type: array(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] 'firmware_version' – Type: array(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] 'device_identifier' – Type: int, Range: [0 to 2¹⁶ - 1]

'uid' – Type: string, Length: up to 8
'connected_uid' – Type: string, Length: up to 8
'position' – Type: string, Range: ['a' to 'h', 'z']
'hardware_version' – Type: array(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]

'firmware_version' – Type: array(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]

'device_identifier' – Type: int, 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¶

void BrickletPTC::registerCallback(int $callback_id, callable $callback, mixed $user_data=NULL)¶

Parameters:	$callback_id – Type: int $callback – Type: callable $user_data – Type: mixed

Registers the given $function with the given $callback_id. The optional $user_data will be passed as the last parameter to the function.

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

void BrickletPTC::setTemperatureCallbackPeriod(int $period)¶

Parameters:	$period – Type: int, Unit: 1 ms, Range: [0 to 2³² - 1], Default: 0

Sets the period with which the CALLBACK_TEMPERATURE callback is triggered periodically. A value of 0 turns the callback off.

The CALLBACK_TEMPERATURE callback is only triggered if the temperature has changed since the last triggering.

int BrickletPTC::getTemperatureCallbackPeriod()¶

Returns:	$period – Type: int, Unit: 1 ms, Range: [0 to 2³² - 1], Default: 0

Returns the period as set by setTemperatureCallbackPeriod().

void BrickletPTC::setResistanceCallbackPeriod(int $period)¶

Parameters:	$period – Type: int, Unit: 1 ms, Range: [0 to 2³² - 1], Default: 0

Sets the period with which the CALLBACK_RESISTANCE callback is triggered periodically. A value of 0 turns the callback off.

The CALLBACK_RESISTANCE callback is only triggered if the resistance has changed since the last triggering.

int BrickletPTC::getResistanceCallbackPeriod()¶

Returns:	$period – Type: int, Unit: 1 ms, Range: [0 to 2³² - 1], Default: 0

Returns the period as set by setResistanceCallbackPeriod().

void BrickletPTC::setTemperatureCallbackThreshold(string $option, int $min, int $max)¶

Parameters:	$option – Type: string, Range: See constants, Default: 'x' $min – Type: int, Unit: 1/100 °C, Range: [-2³¹ to 2³¹ - 1], Default: 0 $max – Type: int, Unit: 1/100 °C, Range: [-2³¹ to 2³¹ - 1], Default: 0

Sets the thresholds for the CALLBACK_TEMPERATURE_REACHED callback.

The following options are possible:

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

The following constants are available for this function:

For $option:

BrickletPTC::THRESHOLD_OPTION_OFF = 'x'
BrickletPTC::THRESHOLD_OPTION_OUTSIDE = 'o'
BrickletPTC::THRESHOLD_OPTION_INSIDE = 'i'
BrickletPTC::THRESHOLD_OPTION_SMALLER = '<'
BrickletPTC::THRESHOLD_OPTION_GREATER = '>'

array BrickletPTC::getTemperatureCallbackThreshold()¶

Return Array:	'option' – Type: string, Range: See constants, Default: 'x' 'min' – Type: int, Unit: 1/100 °C, Range: [-2³¹ to 2³¹ - 1], Default: 0 'max' – Type: int, Unit: 1/100 °C, Range: [-2³¹ to 2³¹ - 1], Default: 0

Returns the threshold as set by setTemperatureCallbackThreshold().

The following constants are available for this function:

For $option:

BrickletPTC::THRESHOLD_OPTION_OFF = 'x'
BrickletPTC::THRESHOLD_OPTION_OUTSIDE = 'o'
BrickletPTC::THRESHOLD_OPTION_INSIDE = 'i'
BrickletPTC::THRESHOLD_OPTION_SMALLER = '<'
BrickletPTC::THRESHOLD_OPTION_GREATER = '>'

void BrickletPTC::setResistanceCallbackThreshold(string $option, int $min, int $max)¶

Parameters:	$option – Type: string, Range: See constants, Default: 'x' $min – Type: int, Unit: ? Ω, Range: [-2³¹ to 2³¹ - 1], Default: 0 $max – Type: int, Unit: ? Ω, Range: [-2³¹ to 2³¹ - 1], Default: 0

Sets the thresholds for the CALLBACK_RESISTANCE_REACHED callback.

The following options are possible:

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

The following constants are available for this function:

For $option:

BrickletPTC::THRESHOLD_OPTION_OFF = 'x'
BrickletPTC::THRESHOLD_OPTION_OUTSIDE = 'o'
BrickletPTC::THRESHOLD_OPTION_INSIDE = 'i'
BrickletPTC::THRESHOLD_OPTION_SMALLER = '<'
BrickletPTC::THRESHOLD_OPTION_GREATER = '>'

array BrickletPTC::getResistanceCallbackThreshold()¶

Return Array:	'option' – Type: string, Range: See constants, Default: 'x' 'min' – Type: int, Unit: ? Ω, Range: [-2³¹ to 2³¹ - 1], Default: 0 'max' – Type: int, Unit: ? Ω, Range: [-2³¹ to 2³¹ - 1], Default: 0

Returns the threshold as set by setResistanceCallbackThreshold().

The following constants are available for this function:

For $option:

BrickletPTC::THRESHOLD_OPTION_OFF = 'x'
BrickletPTC::THRESHOLD_OPTION_OUTSIDE = 'o'
BrickletPTC::THRESHOLD_OPTION_INSIDE = 'i'
BrickletPTC::THRESHOLD_OPTION_SMALLER = '<'
BrickletPTC::THRESHOLD_OPTION_GREATER = '>'

void BrickletPTC::setDebouncePeriod(int $debounce)¶

Parameters:	$debounce – Type: int, Unit: 1 ms, Range: [0 to 2³² - 1], Default: 100

Sets the period with which the threshold callback

CALLBACK_TEMPERATURE_REACHED,
CALLBACK_RESISTANCE_REACHED

is triggered, if the threshold

setTemperatureCallbackThreshold(),
setResistanceCallbackThreshold()

keeps being reached.

int BrickletPTC::getDebouncePeriod()¶

Returns:	$debounce – Type: int, Unit: 1 ms, Range: [0 to 2³² - 1], Default: 100

Returns the debounce period as set by setDebouncePeriod().

void BrickletPTC::setSensorConnectedCallbackConfiguration(bool $enabled)¶

Parameters:	$enabled – Type: bool, Default: FALSE

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

New in version 2.0.2 (Plugin).

bool BrickletPTC::getSensorConnectedCallbackConfiguration()¶

Returns:	$enabled – Type: bool, Default: FALSE

Returns the configuration as set by setSensorConnectedCallbackConfiguration().

New in version 2.0.2 (Plugin).

Callbacks¶

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

<?php

function myCallback($param)
{
    echo $param . "\n";
}

$ptc->registerCallback(BrickletPTC::CALLBACK_EXAMPLE, 'myCallback');

?>

The available constants with corresponding function signatures 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.

int BrickletPTC::CALLBACK_TEMPERATURE¶

<?php   void callback(int $temperature [, mixed $user_data])   ?>

Callback Parameters:	$temperature – Type: int, Unit: 1/100 °C, Range: [-24600 to 84900] $user_data – Type: mixed

This callback is triggered periodically with the period that is set by setTemperatureCallbackPeriod(). The parameter is the temperature of the connected sensor.

The CALLBACK_TEMPERATURE callback is only triggered if the temperature has changed since the last triggering.

int BrickletPTC::CALLBACK_TEMPERATURE_REACHED¶

<?php   void callback(int $temperature [, mixed $user_data])   ?>

Callback Parameters:	$temperature – Type: int, Unit: 1/100 °C, Range: [-24600 to 84900] $user_data – Type: mixed

This callback is triggered when the threshold as set by setTemperatureCallbackThreshold() is reached. The parameter is the temperature of the connected sensor.

If the threshold keeps being reached, the callback is triggered periodically with the period as set by setDebouncePeriod().

int BrickletPTC::CALLBACK_RESISTANCE¶

<?php   void callback(int $resistance [, mixed $user_data])   ?>

Callback Parameters:	$resistance – Type: int, Unit: ? Ω, Range: [-2³¹ to 2³¹ - 1] $user_data – Type: mixed

This callback is triggered periodically with the period that is set by setResistanceCallbackPeriod(). The parameter is the resistance of the connected sensor.

The CALLBACK_RESISTANCE callback is only triggered if the resistance has changed since the last triggering.

int BrickletPTC::CALLBACK_RESISTANCE_REACHED¶

<?php   void callback(int $resistance [, mixed $user_data])   ?>

Callback Parameters:	$resistance – Type: int, Unit: ? Ω, Range: [-2³¹ to 2³¹ - 1] $user_data – Type: mixed

This callback is triggered when the threshold as set by setResistanceCallbackThreshold() is reached. The parameter is the resistance of the connected sensor.

If the threshold keeps being reached, the callback is triggered periodically with the period as set by setDebouncePeriod().

int BrickletPTC::CALLBACK_SENSOR_CONNECTED¶

<?php   void callback(bool $connected [, mixed $user_data])   ?>

Callback Parameters:	$connected – Type: bool $user_data – Type: mixed

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

The parameter is the same as isSensorConnected().

New in version 2.0.2 (Plugin).

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.

array BrickletPTC::getAPIVersion()¶

Return Array:	$api_version – Type: array(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.

bool BrickletPTC::getResponseExpected(int $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 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 $function_id:

BrickletPTC::FUNCTION_SET_TEMPERATURE_CALLBACK_PERIOD = 3
BrickletPTC::FUNCTION_SET_RESISTANCE_CALLBACK_PERIOD = 5
BrickletPTC::FUNCTION_SET_TEMPERATURE_CALLBACK_THRESHOLD = 7
BrickletPTC::FUNCTION_SET_RESISTANCE_CALLBACK_THRESHOLD = 9
BrickletPTC::FUNCTION_SET_DEBOUNCE_PERIOD = 11
BrickletPTC::FUNCTION_SET_NOISE_REJECTION_FILTER = 17
BrickletPTC::FUNCTION_SET_WIRE_MODE = 20
BrickletPTC::FUNCTION_SET_SENSOR_CONNECTED_CALLBACK_CONFIGURATION = 22

void BrickletPTC::setResponseExpected(int $function_id, bool $response_expected)¶

Parameters:	$function_id – Type: int, Range: See constants $response_expected – Type: bool

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 $function_id:

BrickletPTC::FUNCTION_SET_TEMPERATURE_CALLBACK_PERIOD = 3
BrickletPTC::FUNCTION_SET_RESISTANCE_CALLBACK_PERIOD = 5
BrickletPTC::FUNCTION_SET_TEMPERATURE_CALLBACK_THRESHOLD = 7
BrickletPTC::FUNCTION_SET_RESISTANCE_CALLBACK_THRESHOLD = 9
BrickletPTC::FUNCTION_SET_DEBOUNCE_PERIOD = 11
BrickletPTC::FUNCTION_SET_NOISE_REJECTION_FILTER = 17
BrickletPTC::FUNCTION_SET_WIRE_MODE = 20
BrickletPTC::FUNCTION_SET_SENSOR_CONNECTED_CALLBACK_CONFIGURATION = 22

void BrickletPTC::setResponseExpectedAll(bool $response_expected)¶

Parameters:	$response_expected – Type: bool

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

Constants¶

int BrickletPTC::DEVICE_IDENTIFIER¶

This constant is used to identify a PTC Bricklet.

The getIdentity() function and the IPConnection::CALLBACK_ENUMERATE callback of the IP Connection have a deviceIdentifier parameter to specify the Brick's or Bricklet's type.

string BrickletPTC::DEVICE_DISPLAY_NAME¶: This constant represents the human readable name of a PTC Bricklet.