PHP - Isolator Bricklet

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

use Tinkerforge\IPConnection;
use Tinkerforge\BrickletIsolator;

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

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

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

// Get current statistics
$statistics = $i->getStatistics();

echo "Messages From Brick: " . $statistics['messages_from_brick'] . "\n";
echo "Messages From Bricklet: " . $statistics['messages_from_bricklet'] . "\n";
echo "Connected Bricklet Device Identifier: " . $statistics['connected_bricklet_device_identifier'] . "\n";
echo "Connected Bricklet UID: " . $statistics['connected_bricklet_uid'] . "\n";

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

?>

API

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

Basic Functions

class BrickletIsolator(string $uid, IPConnection $ipcon)

Creates an object with the unique device ID $uid:

<?php   $isolator = new BrickletIsolator('YOUR_DEVICE_UID', $ipcon);   ?>

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

array BrickletIsolator::getStatistics()

Returns statistics for the Isolator Bricklet.

The returned array has the keys messages_from_brick, messages_from_bricklet, connected_bricklet_device_identifier and connected_bricklet_uid.

Advanced Functions

void BrickletIsolator::setSPITFPBaudrateConfig(bool $enable_dynamic_baudrate, int $minimum_dynamic_baudrate)

The SPITF protocol can be used with a dynamic baudrate. If the dynamic baudrate is enabled, the Isolator Bricklet will try to adapt the baudrate for the communication between Bricks and Bricklets according to the amount of data that is transferred.

The baudrate for communication config between Brick and Isolator Bricklet can be set through the API of the Brick.

The baudrate will be increased exponentially if lots of data is send/received and decreased linearly if little data is send/received.

This lowers the baudrate in applications where little data is transferred (e.g. a weather station) and increases the robustness. If there is lots of data to transfer (e.g. Thermal Imaging Bricklet) it automatically increases the baudrate as needed.

In cases where some data has to transferred as fast as possible every few seconds (e.g. RS485 Bricklet with a high baudrate but small payload) you may want to turn the dynamic baudrate off to get the highest possible performance.

The maximum value of the baudrate can be set per port with the function setSPITFPBaudrate(). If the dynamic baudrate is disabled, the baudrate as set by setSPITFPBaudrate() will be used statically.

The minimum dynamic baudrate has a value range of 400000 to 2000000 baud.

By default dynamic baudrate is enabled and the minimum dynamic baudrate is 400000.

array BrickletIsolator::getSPITFPBaudrateConfig()

Returns the baudrate config, see setSPITFPBaudrateConfig().

The returned array has the keys enable_dynamic_baudrate and minimum_dynamic_baudrate.

void BrickletIsolator::setSPITFPBaudrate(int $baudrate)

Sets the baudrate for a the communication between Isolator Bricklet and the connected Bricklet. The baudrate for communication between Brick and Isolator Bricklet can be set through the API of the Brick.

The baudrate can be in the range 400000 to 2000000.

If you want to increase the throughput of Bricklets you can increase the baudrate. If you get a high error count because of high interference (see getSPITFPErrorCount()) you can decrease the baudrate.

If the dynamic baudrate feature is enabled, the baudrate set by this function corresponds to the maximum baudrate (see setSPITFPBaudrateConfig()).

Regulatory testing is done with the default baudrate. If CE compatibility or similar is necessary in you applications we recommend to not change the baudrate.

The default baudrate for all ports is 1400000.

int BrickletIsolator::getSPITFPBaudrate()

Returns the baudrate, see setSPITFPBaudrate().

array BrickletIsolator::getIsolatorSPITFPErrorCount()

Returns the error count for the communication between Isolator Bricklet and the connected Bricklet. Call getSPITFPErrorCount() to get the error count between Isolator Bricklet and Brick.

The errors are divided into

  • ACK checksum errors,
  • message checksum errors,
  • framing errors and
  • overflow errors.

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

array BrickletIsolator::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 BrickletIsolator::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 BrickletIsolator::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:

  • BrickletIsolator::FUNCTION_SET_SPITFP_BAUDRATE_CONFIG = 2
  • BrickletIsolator::FUNCTION_SET_SPITFP_BAUDRATE = 4
  • BrickletIsolator::FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
  • BrickletIsolator::FUNCTION_SET_STATUS_LED_CONFIG = 239
  • BrickletIsolator::FUNCTION_RESET = 243
  • BrickletIsolator::FUNCTION_WRITE_UID = 248
void BrickletIsolator::setResponseExpectedAll(bool $response_expected)

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

array BrickletIsolator::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 BrickletIsolator::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:

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

Returns the current bootloader mode, see setBootloaderMode().

The following constants are available for this function:

  • BrickletIsolator::BOOTLOADER_MODE_BOOTLOADER = 0
  • BrickletIsolator::BOOTLOADER_MODE_FIRMWARE = 1
  • BrickletIsolator::BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
  • BrickletIsolator::BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
  • BrickletIsolator::BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4
void BrickletIsolator::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 BrickletIsolator::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 BrickletIsolator::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:

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

Returns the configuration as set by setStatusLEDConfig()

The following constants are available for this function:

  • BrickletIsolator::STATUS_LED_CONFIG_OFF = 0
  • BrickletIsolator::STATUS_LED_CONFIG_ON = 1
  • BrickletIsolator::STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • BrickletIsolator::STATUS_LED_CONFIG_SHOW_STATUS = 3
int BrickletIsolator::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 BrickletIsolator::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 BrickletIsolator::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 BrickletIsolator::readUID()

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

array BrickletIsolator::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.

Constants

int BrickletIsolator::DEVICE_IDENTIFIER

This constant is used to identify a Isolator Bricklet.

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 BrickletIsolator::DEVICE_DISPLAY_NAME

This constant represents the human readable name of a Isolator Bricklet.