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

PHP - PTC Bricklet 2.0¶

This is the description of the PHP 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 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/BrickletPTCV2.php');

use Tinkerforge\IPConnection;
use Tinkerforge\BrickletPTCV2;

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

$ipcon = new IPConnection(); // Create IP connection
$ptc = new BrickletPTCV2(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/BrickletPTCV2.php');

use Tinkerforge\IPConnection;
use Tinkerforge\BrickletPTCV2;

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

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

$ipcon = new IPConnection(); // Create IP connection
$ptc = new BrickletPTCV2(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(BrickletPTCV2::CALLBACK_TEMPERATURE, 'cb_temperature');

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

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/BrickletPTCV2.php');

use Tinkerforge\IPConnection;
use Tinkerforge\BrickletPTCV2;

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

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

$ipcon = new IPConnection(); // Create IP connection
$ptc = new BrickletPTCV2(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(BrickletPTCV2::CALLBACK_TEMPERATURE, 'cb_temperature');

// Configure threshold for temperature "greater than 30 °C"
// with a debounce period of 1s (1000ms)
$ptc->setTemperatureCallbackConfiguration(1000, FALSE, '>', 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 BrickletPTCV2(string $uid, IPConnection $ipcon)¶

Parameters:	$uid – Type: string $ipcon – Type: IPConnection
Returns:	$ptc_v2 – Type: BrickletPTCV2

Creates an object with the unique device ID $uid:

<?php   $ptc_v2 = new BrickletPTCV2('YOUR_DEVICE_UID', $ipcon);   ?>

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

int BrickletPTCV2::getTemperature()¶

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

int BrickletPTCV2::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 value periodically, it is recommended to use the CALLBACK_RESISTANCE callback. You can set the callback configuration with setResistanceCallbackConfiguration().

bool BrickletPTCV2::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.

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

void BrickletPTCV2::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:

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

int BrickletPTCV2::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:

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

void BrickletPTCV2::setMovingAverageConfiguration(int $moving_average_length_resistance, int $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

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

array BrickletPTCV2::getMovingAverageConfiguration()¶

Return Array:	'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 the moving average configuration as set by setMovingAverageConfiguration().

Advanced Functions¶

void BrickletPTCV2::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:

BrickletPTCV2::FILTER_OPTION_50HZ = 0
BrickletPTCV2::FILTER_OPTION_60HZ = 1

int BrickletPTCV2::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:

BrickletPTCV2::FILTER_OPTION_50HZ = 0
BrickletPTCV2::FILTER_OPTION_60HZ = 1

array BrickletPTCV2::getSPITFPErrorCount()¶

Return Array:	'error_count_ack_checksum' – Type: int, Range: [0 to 2³² - 1] 'error_count_message_checksum' – Type: int, Range: [0 to 2³² - 1] 'error_count_frame' – Type: int, Range: [0 to 2³² - 1] 'error_count_overflow' – Type: int, Range: [0 to 2³² - 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.

void BrickletPTCV2::setStatusLEDConfig(int $config)¶

Parameters:	$config – Type: int, Range: See constants, Default: 3

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

int BrickletPTCV2::getStatusLEDConfig()¶

Returns:	$config – Type: int, Range: See constants, Default: 3

Returns the configuration as set by setStatusLEDConfig()

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

int BrickletPTCV2::getChipTemperature()¶

Returns:	$temperature – Type: int, Unit: 1 °C, Range: [-2¹⁵ to 2¹⁵ - 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.

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

array BrickletPTCV2::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 BrickletPTCV2::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 BrickletPTCV2::setTemperatureCallbackConfiguration(int $period, bool $value_has_to_change, string $option, int $min, int $max)¶

Parameters:	$period – Type: int, Unit: 1 ms, Range: [0 to 2³² - 1], Default: 0 $value_has_to_change – Type: bool, Default: FALSE $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

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 = '>'

array BrickletPTCV2::getTemperatureCallbackConfiguration()¶

Return Array:	'period' – Type: int, Unit: 1 ms, Range: [0 to 2³² - 1], Default: 0 'value_has_to_change' – Type: bool, Default: FALSE '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 callback configuration as set by setTemperatureCallbackConfiguration().

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 = '>'

void BrickletPTCV2::setResistanceCallbackConfiguration(int $period, bool $value_has_to_change, string $option, int $min, int $max)¶

Parameters:	$period – Type: int, Unit: 1 ms, Range: [0 to 2³² - 1], Default: 0 $value_has_to_change – Type: bool, Default: FALSE $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

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

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 = '>'

array BrickletPTCV2::getResistanceCallbackConfiguration()¶

Return Array:	'period' – Type: int, Unit: 1 ms, Range: [0 to 2³² - 1], Default: 0 'value_has_to_change' – Type: bool, Default: FALSE '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 callback configuration as set by setResistanceCallbackConfiguration().

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 = '>'

void BrickletPTCV2::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.

bool BrickletPTCV2::getSensorConnectedCallbackConfiguration()¶

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

Returns the configuration as set by setSensorConnectedCallbackConfiguration().

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_v2->registerCallback(BrickletPTCV2::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 BrickletPTCV2::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 according to the configuration set by setTemperatureCallbackConfiguration().

The parameter is the same as getTemperature().

int BrickletPTCV2::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 according to the configuration set by setResistanceCallbackConfiguration().

The parameter is the same as getResistance().

int BrickletPTCV2::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().

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 BrickletPTCV2::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 BrickletPTCV2::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:

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

void BrickletPTCV2::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:

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

void BrickletPTCV2::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.

Internal Functions¶

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.

int BrickletPTCV2::setBootloaderMode(int $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

int BrickletPTCV2::getBootloaderMode()¶

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

Returns the current bootloader mode, see setBootloaderMode().

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

void BrickletPTCV2::setWriteFirmwarePointer(int $pointer)¶

Parameters:	$pointer – Type: int, Unit: 1 B, Range: [0 to 2³² - 1]

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 BrickletPTCV2::writeFirmware(array $data)¶

Parameters:	$data – Type: array(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 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 BrickletPTCV2::writeUID(int $uid)¶

Parameters:	$uid – Type: int, Range: [0 to 2³² - 1]

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 BrickletPTCV2::readUID()¶

Returns:	$uid – Type: int, Range: [0 to 2³² - 1]

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

Constants¶

int BrickletPTCV2::DEVICE_IDENTIFIER¶

This constant is used to identify a PTC Bricklet 2.0.

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 BrickletPTCV2::DEVICE_DISPLAY_NAME¶: This constant represents the human readable name of a PTC Bricklet 2.0.