PHP - Temperature IR Bricklet

This is the description of the PHP API bindings for the Temperature IR Bricklet. General information and technical specifications for the Temperature IR 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)

 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
<?php

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

use Tinkerforge\IPConnection;
use Tinkerforge\BrickletTemperatureIR;

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

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

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

// Get current ambient temperature
$ambient_temperature = $tir->getAmbientTemperature();
echo "Ambient Temperature: " . $ambient_temperature/10.0 . " °C\n";

// Get current object temperature
$object_temperature = $tir->getObjectTemperature();
echo "Object Temperature: " . $object_temperature/10.0 . " °C\n";

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

?>

Callback

Download (ExampleCallback.php)

 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
<?php

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

use Tinkerforge\IPConnection;
use Tinkerforge\BrickletTemperatureIR;

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

// Callback function for object temperature callback
function cb_objectTemperature($temperature)
{
    echo "Object Temperature: " . $temperature/10.0 . " °C\n";
}

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

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

// Register object temperature callback to function cb_objectTemperature
$tir->registerCallback(BrickletTemperatureIR::CALLBACK_OBJECT_TEMPERATURE,
                       'cb_objectTemperature');

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

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

?>

Water Boiling

Download (ExampleWaterBoiling.php)

 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
<?php

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

use Tinkerforge\IPConnection;
use Tinkerforge\BrickletTemperatureIR;

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

// Callback function for object temperature reached callback
function cb_objectTemperatureReached($temperature)
{
    echo "Object Temperature: " . $temperature/10.0 . " °C\n";
    echo "The water is boiling!\n";
}

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

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

// Set emissivity to 0.98 (emissivity of water, 65535 * 0.98 = 64224.299)
$tir->setEmissivity(64224);

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

// Register object temperature reached callback to function cb_objectTemperatureReached
$tir->registerCallback(BrickletTemperatureIR::CALLBACK_OBJECT_TEMPERATURE_REACHED,
                       'cb_objectTemperatureReached');

// Configure threshold for object temperature "greater than 100 °C"
$tir->setObjectTemperatureCallbackThreshold('>', 100*10, 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 BrickletTemperatureIR(string $uid, IPConnection $ipcon)
Parameters:
  • $uid – Type: string
  • $ipcon – Type: IPConnection
Returns:
  • $temperature_ir – Type: BrickletTemperatureIR

Creates an object with the unique device ID $uid:

<?php   $temperature_ir = new BrickletTemperatureIR('YOUR_DEVICE_UID', $ipcon);   ?>

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

int BrickletTemperatureIR::getAmbientTemperature()
Returns:
  • $temperature – Type: int, Range: [-215 to 215 - 1]

Returns the ambient temperature of the sensor. The value has a range of -400 to 1250 and is given in °C/10, e.g. a value of 423 means that an ambient temperature of 42.3 °C is measured.

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

int BrickletTemperatureIR::getObjectTemperature()
Returns:
  • $temperature – Type: int, Range: [-215 to 215 - 1]

Returns the object temperature of the sensor, i.e. the temperature of the surface of the object the sensor is aimed at. The value has a range of -700 to 3800 and is given in °C/10, e.g. a value of 3001 means that a temperature of 300.1 °C is measured on the surface of the object.

The temperature of different materials is dependent on their emissivity. The emissivity of the material can be set with setEmissivity().

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

Advanced Functions

void BrickletTemperatureIR::setEmissivity(int $emissivity)
Parameters:
  • $emissivity – Type: int, Range: [0 to 216 - 1]

Sets the emissivity that is used to calculate the surface temperature as returned by getObjectTemperature().

The emissivity is usually given as a value between 0.0 and 1.0. A list of emissivities of different materials can be found here.

The parameter of setEmissivity() has to be given with a factor of 65535 (16-bit). For example: An emissivity of 0.1 can be set with the value 6553, an emissivity of 0.5 with the value 32767 and so on.

Note

If you need a precise measurement for the object temperature, it is absolutely crucial that you also provide a precise emissivity.

The default emissivity is 1.0 (value of 65535) and the minimum emissivity the sensor can handle is 0.1 (value of 6553).

The emissivity is stored in non-volatile memory and will still be used after a restart or power cycle of the Bricklet.

int BrickletTemperatureIR::getEmissivity()
Returns:
  • $emissivity – Type: int, Range: [0 to 216 - 1]

Returns the emissivity as set by setEmissivity().

array BrickletTemperatureIR::getAPIVersion()
Returns:
  • $api_version – Type: array(int, ...), Length: 3, Range: [0 to 255]

Returns the version of the API definition (major, minor, revision) 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 BrickletTemperatureIR::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 send and errors are silently ignored, because they cannot be detected.

The following constants are available for this function:

For $function_id:

  • BrickletTemperatureIR::FUNCTION_SET_EMISSIVITY = 3
  • BrickletTemperatureIR::FUNCTION_SET_AMBIENT_TEMPERATURE_CALLBACK_PERIOD = 5
  • BrickletTemperatureIR::FUNCTION_SET_OBJECT_TEMPERATURE_CALLBACK_PERIOD = 7
  • BrickletTemperatureIR::FUNCTION_SET_AMBIENT_TEMPERATURE_CALLBACK_THRESHOLD = 9
  • BrickletTemperatureIR::FUNCTION_SET_OBJECT_TEMPERATURE_CALLBACK_THRESHOLD = 11
  • BrickletTemperatureIR::FUNCTION_SET_DEBOUNCE_PERIOD = 13
void BrickletTemperatureIR::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.

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:

  • BrickletTemperatureIR::FUNCTION_SET_EMISSIVITY = 3
  • BrickletTemperatureIR::FUNCTION_SET_AMBIENT_TEMPERATURE_CALLBACK_PERIOD = 5
  • BrickletTemperatureIR::FUNCTION_SET_OBJECT_TEMPERATURE_CALLBACK_PERIOD = 7
  • BrickletTemperatureIR::FUNCTION_SET_AMBIENT_TEMPERATURE_CALLBACK_THRESHOLD = 9
  • BrickletTemperatureIR::FUNCTION_SET_OBJECT_TEMPERATURE_CALLBACK_THRESHOLD = 11
  • BrickletTemperatureIR::FUNCTION_SET_DEBOUNCE_PERIOD = 13
void BrickletTemperatureIR::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.

array BrickletTemperatureIR::getIdentity()
Return Array:
  • 'uid' – Type: string, Length: up to 8
  • 'connected_uid' – Type: string, Length: up to 8
  • 'position' – Type: string
  • 'hardware_version' – Type: array(int, ...), Length: 3, Range: [0 to 255]
  • 'firmware_version' – Type: array(int, ...), Length: 3, Range: [0 to 255]
  • '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' or 'd'.

The device identifier numbers can be found here. There is also a constant for the device identifier of this Bricklet.

Callback Configuration Functions

void BrickletTemperatureIR::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 BrickletTemperatureIR::setAmbientTemperatureCallbackPeriod(int $period)
Parameters:
  • $period – Type: int, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0

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

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

int BrickletTemperatureIR::getAmbientTemperatureCallbackPeriod()
Returns:
  • $period – Type: int, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0

Returns the period as set by setAmbientTemperatureCallbackPeriod().

void BrickletTemperatureIR::setObjectTemperatureCallbackPeriod(int $period)
Parameters:
  • $period – Type: int, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0

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

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

int BrickletTemperatureIR::getObjectTemperatureCallbackPeriod()
Returns:
  • $period – Type: int, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0

Returns the period as set by setObjectTemperatureCallbackPeriod().

void BrickletTemperatureIR::setAmbientTemperatureCallbackThreshold(string $option, int $min, int $max)
Parameters:
  • $option – Type: string, Range: See constants, Default: 'x'
  • $min – Type: int, Range: [-215 to 215 - 1]
  • $max – Type: int, Range: [-215 to 215 - 1]

Sets the thresholds for the CALLBACK_AMBIENT_TEMPERATURE_REACHED callback.

The following options are possible:

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

The default value is ('x', 0, 0).

The following constants are available for this function:

For $option:

  • BrickletTemperatureIR::THRESHOLD_OPTION_OFF = 'x'
  • BrickletTemperatureIR::THRESHOLD_OPTION_OUTSIDE = 'o'
  • BrickletTemperatureIR::THRESHOLD_OPTION_INSIDE = 'i'
  • BrickletTemperatureIR::THRESHOLD_OPTION_SMALLER = '<'
  • BrickletTemperatureIR::THRESHOLD_OPTION_GREATER = '>'
array BrickletTemperatureIR::getAmbientTemperatureCallbackThreshold()
Return Array:
  • 'option' – Type: string, Range: See constants, Default: 'x'
  • 'min' – Type: int, Range: [-215 to 215 - 1]
  • 'max' – Type: int, Range: [-215 to 215 - 1]

Returns the threshold as set by setAmbientTemperatureCallbackThreshold().

The following constants are available for this function:

For $option:

  • BrickletTemperatureIR::THRESHOLD_OPTION_OFF = 'x'
  • BrickletTemperatureIR::THRESHOLD_OPTION_OUTSIDE = 'o'
  • BrickletTemperatureIR::THRESHOLD_OPTION_INSIDE = 'i'
  • BrickletTemperatureIR::THRESHOLD_OPTION_SMALLER = '<'
  • BrickletTemperatureIR::THRESHOLD_OPTION_GREATER = '>'
void BrickletTemperatureIR::setObjectTemperatureCallbackThreshold(string $option, int $min, int $max)
Parameters:
  • $option – Type: string, Range: See constants, Default: 'x'
  • $min – Type: int, Range: [-215 to 215 - 1]
  • $max – Type: int, Range: [-215 to 215 - 1]

Sets the thresholds for the CALLBACK_OBJECT_TEMPERATURE_REACHED callback.

The following options are possible:

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

The default value is ('x', 0, 0).

The following constants are available for this function:

For $option:

  • BrickletTemperatureIR::THRESHOLD_OPTION_OFF = 'x'
  • BrickletTemperatureIR::THRESHOLD_OPTION_OUTSIDE = 'o'
  • BrickletTemperatureIR::THRESHOLD_OPTION_INSIDE = 'i'
  • BrickletTemperatureIR::THRESHOLD_OPTION_SMALLER = '<'
  • BrickletTemperatureIR::THRESHOLD_OPTION_GREATER = '>'
array BrickletTemperatureIR::getObjectTemperatureCallbackThreshold()
Return Array:
  • 'option' – Type: string, Range: See constants, Default: 'x'
  • 'min' – Type: int, Range: [-215 to 215 - 1]
  • 'max' – Type: int, Range: [-215 to 215 - 1]

Returns the threshold as set by setObjectTemperatureCallbackThreshold().

The following constants are available for this function:

For $option:

  • BrickletTemperatureIR::THRESHOLD_OPTION_OFF = 'x'
  • BrickletTemperatureIR::THRESHOLD_OPTION_OUTSIDE = 'o'
  • BrickletTemperatureIR::THRESHOLD_OPTION_INSIDE = 'i'
  • BrickletTemperatureIR::THRESHOLD_OPTION_SMALLER = '<'
  • BrickletTemperatureIR::THRESHOLD_OPTION_GREATER = '>'
void BrickletTemperatureIR::setDebouncePeriod(int $debounce)
Parameters:
  • $debounce – Type: int, Unit: 1 ms, Range: [0 to 232 - 1], Default: 100

Sets the period with which the threshold callbacks

are triggered, if the thresholds

keep being reached.

int BrickletTemperatureIR::getDebouncePeriod()
Returns:
  • $debounce – Type: int, Unit: 1 ms, Range: [0 to 232 - 1], Default: 100

Returns the debounce period as set by setDebouncePeriod().

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";
}

$temperature_ir->registerCallback(BrickletTemperatureIR::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 BrickletTemperatureIR::CALLBACK_AMBIENT_TEMPERATURE
<?php   void callback(int $temperature [, mixed $user_data])   ?>
Callback Parameters:
  • $temperature – Type: int, Range: [-215 to 215 - 1]
  • $user_data – Type: mixed

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

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

int BrickletTemperatureIR::CALLBACK_OBJECT_TEMPERATURE
<?php   void callback(int $temperature [, mixed $user_data])   ?>
Callback Parameters:
  • $temperature – Type: int, Range: [-215 to 215 - 1]
  • $user_data – Type: mixed

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

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

int BrickletTemperatureIR::CALLBACK_AMBIENT_TEMPERATURE_REACHED
<?php   void callback(int $temperature [, mixed $user_data])   ?>
Callback Parameters:
  • $temperature – Type: int, Range: [-215 to 215 - 1]
  • $user_data – Type: mixed

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

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

int BrickletTemperatureIR::CALLBACK_OBJECT_TEMPERATURE_REACHED
<?php   void callback(int $temperature [, mixed $user_data])   ?>
Callback Parameters:
  • $temperature – Type: int, Range: [-215 to 215 - 1]
  • $user_data – Type: mixed

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

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

Constants

int BrickletTemperatureIR::DEVICE_IDENTIFIER

This constant is used to identify a Temperature IR 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 BrickletTemperatureIR::DEVICE_DISPLAY_NAME

This constant represents the human readable name of a Temperature IR Bricklet.