PHP - Temperature IR Bricklet 2.0

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

use Tinkerforge\IPConnection;
use Tinkerforge\BrickletTemperatureIRV2;

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

$ipcon = new IPConnection(); // Create IP connection
$tir = new BrickletTemperatureIRV2(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
<?php

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

use Tinkerforge\IPConnection;
use Tinkerforge\BrickletTemperatureIRV2;

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

// 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 BrickletTemperatureIRV2(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(BrickletTemperatureIRV2::CALLBACK_OBJECT_TEMPERATURE,
                       'cb_objectTemperature');

// Set period for object temperature callback to 1s (1000ms) without a threshold
$tir->setObjectTemperatureCallbackConfiguration(1000, FALSE, 'x', 0, 0);

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

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

use Tinkerforge\IPConnection;
use Tinkerforge\BrickletTemperatureIRV2;

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

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

$ipcon = new IPConnection(); // Create IP connection
$tir = new BrickletTemperatureIRV2(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);

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

// Configure threshold for object temperature "greater than 100 °C"
// with a debounce period of 10s (10000ms)
$tir->setObjectTemperatureCallbackConfiguration(10000, FALSE, '>', 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 BrickletTemperatureIRV2(string $uid, IPConnection $ipcon)

Creates an object with the unique device ID $uid:

<?php   $temperature_ir_v2 = new BrickletTemperatureIRV2('YOUR_DEVICE_UID', $ipcon);   ?>

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

int BrickletTemperatureIRV2::getAmbientTemperature()

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 setAmbientTemperatureCallbackConfiguration().

If you want to get the value periodically, it is recommended to use the CALLBACK_AMBIENT_TEMPERATURE callback. You can set the callback configuration with setAmbientTemperatureCallbackConfiguration().

int BrickletTemperatureIRV2::getObjectTemperature()

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 setObjectTemperatureCallbackConfiguration().

If you want to get the value periodically, it is recommended to use the CALLBACK_OBJECT_TEMPERATURE callback. You can set the callback configuration with setObjectTemperatureCallbackConfiguration().

Advanced Functions

void BrickletTemperatureIRV2::setEmissivity(int $emissivity)

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).

int BrickletTemperatureIRV2::getEmissivity()

Returns the emissivity as set by setEmissivity().

array BrickletTemperatureIRV2::getAPIVersion()

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 BrickletTemperatureIRV2::getResponseExpected(int $function_id)

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.

See setResponseExpected() for the list of function ID constants available for this function.

void BrickletTemperatureIRV2::setResponseExpected(int $function_id, bool $response_expected)

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 function ID constants are available for this function:

  • BrickletTemperatureIRV2::FUNCTION_SET_AMBIENT_TEMPERATURE_CALLBACK_CONFIGURATION = 2
  • BrickletTemperatureIRV2::FUNCTION_SET_OBJECT_TEMPERATURE_CALLBACK_CONFIGURATION = 6
  • BrickletTemperatureIRV2::FUNCTION_SET_EMISSIVITY = 9
  • BrickletTemperatureIRV2::FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
  • BrickletTemperatureIRV2::FUNCTION_SET_STATUS_LED_CONFIG = 239
  • BrickletTemperatureIRV2::FUNCTION_RESET = 243
  • BrickletTemperatureIRV2::FUNCTION_WRITE_UID = 248
void BrickletTemperatureIRV2::setResponseExpectedAll(bool $response_expected)

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

array BrickletTemperatureIRV2::getSPITFPErrorCount()

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.

The returned array has the keys error_count_ack_checksum, error_count_message_checksum, error_count_frame and error_count_overflow.

int BrickletTemperatureIRV2::setBootloaderMode(int $mode)

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:

  • BrickletTemperatureIRV2::BOOTLOADER_MODE_BOOTLOADER = 0
  • BrickletTemperatureIRV2::BOOTLOADER_MODE_FIRMWARE = 1
  • BrickletTemperatureIRV2::BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
  • BrickletTemperatureIRV2::BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
  • BrickletTemperatureIRV2::BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4
  • BrickletTemperatureIRV2::BOOTLOADER_STATUS_OK = 0
  • BrickletTemperatureIRV2::BOOTLOADER_STATUS_INVALID_MODE = 1
  • BrickletTemperatureIRV2::BOOTLOADER_STATUS_NO_CHANGE = 2
  • BrickletTemperatureIRV2::BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT = 3
  • BrickletTemperatureIRV2::BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT = 4
  • BrickletTemperatureIRV2::BOOTLOADER_STATUS_CRC_MISMATCH = 5
int BrickletTemperatureIRV2::getBootloaderMode()

Returns the current bootloader mode, see setBootloaderMode().

The following constants are available for this function:

  • BrickletTemperatureIRV2::BOOTLOADER_MODE_BOOTLOADER = 0
  • BrickletTemperatureIRV2::BOOTLOADER_MODE_FIRMWARE = 1
  • BrickletTemperatureIRV2::BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
  • BrickletTemperatureIRV2::BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
  • BrickletTemperatureIRV2::BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4
void BrickletTemperatureIRV2::setWriteFirmwarePointer(int $pointer)

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.

int BrickletTemperatureIRV2::writeFirmware(array $data)

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.

void BrickletTemperatureIRV2::setStatusLEDConfig(int $config)

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:

  • BrickletTemperatureIRV2::STATUS_LED_CONFIG_OFF = 0
  • BrickletTemperatureIRV2::STATUS_LED_CONFIG_ON = 1
  • BrickletTemperatureIRV2::STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • BrickletTemperatureIRV2::STATUS_LED_CONFIG_SHOW_STATUS = 3
int BrickletTemperatureIRV2::getStatusLEDConfig()

Returns the configuration as set by setStatusLEDConfig()

The following constants are available for this function:

  • BrickletTemperatureIRV2::STATUS_LED_CONFIG_OFF = 0
  • BrickletTemperatureIRV2::STATUS_LED_CONFIG_ON = 1
  • BrickletTemperatureIRV2::STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • BrickletTemperatureIRV2::STATUS_LED_CONFIG_SHOW_STATUS = 3
int BrickletTemperatureIRV2::getChipTemperature()

Returns the temperature in °C 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.

void BrickletTemperatureIRV2::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!

void BrickletTemperatureIRV2::writeUID(int $uid)

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.

int BrickletTemperatureIRV2::readUID()

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

array BrickletTemperatureIRV2::getIdentity()

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.

The returned array has the keys uid, connected_uid, position, hardware_version, firmware_version and device_identifier.

Callback Configuration Functions

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

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 BrickletTemperatureIRV2::setAmbientTemperatureCallbackConfiguration(int $period, bool $value_has_to_change, string $option, int $min, int $max)

The period in ms is the period with which the CALLBACK_AMBIENT_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_AMBIENT_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 default value is (0, false, 'x', 0, 0).

The following constants are available for this function:

  • BrickletTemperatureIRV2::THRESHOLD_OPTION_OFF = 'x'
  • BrickletTemperatureIRV2::THRESHOLD_OPTION_OUTSIDE = 'o'
  • BrickletTemperatureIRV2::THRESHOLD_OPTION_INSIDE = 'i'
  • BrickletTemperatureIRV2::THRESHOLD_OPTION_SMALLER = '<'
  • BrickletTemperatureIRV2::THRESHOLD_OPTION_GREATER = '>'
array BrickletTemperatureIRV2::getAmbientTemperatureCallbackConfiguration()

Returns the callback configuration as set by setAmbientTemperatureCallbackConfiguration().

The following constants are available for this function:

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

The returned array has the keys period, value_has_to_change, option, min and max.

void BrickletTemperatureIRV2::setObjectTemperatureCallbackConfiguration(int $period, bool $value_has_to_change, string $option, int $min, int $max)

The period in ms is the period with which the CALLBACK_OBJECT_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_OBJECT_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 default value is (0, false, 'x', 0, 0).

The following constants are available for this function:

  • BrickletTemperatureIRV2::THRESHOLD_OPTION_OFF = 'x'
  • BrickletTemperatureIRV2::THRESHOLD_OPTION_OUTSIDE = 'o'
  • BrickletTemperatureIRV2::THRESHOLD_OPTION_INSIDE = 'i'
  • BrickletTemperatureIRV2::THRESHOLD_OPTION_SMALLER = '<'
  • BrickletTemperatureIRV2::THRESHOLD_OPTION_GREATER = '>'
array BrickletTemperatureIRV2::getObjectTemperatureCallbackConfiguration()

Returns the callback configuration as set by setObjectTemperatureCallbackConfiguration().

The following constants are available for this function:

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

The returned array has the keys period, value_has_to_change, option, min and max.

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_v2->registerCallback(BrickletTemperatureIRV2::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 BrickletTemperatureIRV2::CALLBACK_AMBIENT_TEMPERATURE
<?php   void callback(int $temperature [, mixed $user_data])   ?>

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

The parameter is the same as getAmbientTemperature().

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

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

The parameter is the same as getObjectTemperature().

Constants

int BrickletTemperatureIRV2::DEVICE_IDENTIFIER

This constant is used to identify a Temperature IR Bricklet 2.0.

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

string BrickletTemperatureIRV2::DEVICE_DISPLAY_NAME

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