PHP - HAT Brick

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

Sleep

Download (ExampleSleep.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
<?php

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

use Tinkerforge\IPConnection;
use Tinkerforge\BrickHAT;

const HOST = 'localhost';
const PORT = 4223;
const UID = 'XXYYZZ'; // Change XXYYZZ to the UID of your HAT Brick

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

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

// Turn Raspberry Pi and Bricklets off in 2 seconds for 30 minutes with sleep indicator enabled
$hat->setSleepMode(2, 1800, TRUE, TRUE, TRUE);

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 BrickHAT(string $uid, IPConnection $ipcon)
Parameters:
  • $uid – Type: string
  • $ipcon – Type: IPConnection
Returns:
  • $hat – Type: BrickHAT

Creates an object with the unique device ID $uid:

<?php   $hat = new BrickHAT('YOUR_DEVICE_UID', $ipcon);   ?>

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

void BrickHAT::setSleepMode(int $power_off_delay, int $power_off_duration, bool $raspberry_pi_off, bool $bricklets_off, bool $enable_sleep_indicator)
Parameters:
  • $power_off_delay – Type: int, Range: [0 to 232 - 1]
  • $power_off_duration – Type: int, Range: [0 to 232 - 1]
  • $raspberry_pi_off – Type: bool
  • $bricklets_off – Type: bool
  • $enable_sleep_indicator – Type: bool

Sets the sleep mode.

Note

Calling this function will cut the Raspberry Pi's power after Power Off Delay seconds. You have to shut down the operating system yourself, e.g. by calling 'sudo shutdown -h now'.

Parameters:

  • Power Off Delay: Time in seconds before the RPi/Bricklets are powered off.
  • Power Off Duration: Duration in seconds that the RPi/Bricklets stay powered off.
  • Raspberry Pi Off: RPi is powered off if set to true.
  • Bricklets Off: Bricklets are powered off if set to true.
  • Enable Sleep Indicator: If set to true, the status LED will blink in a 1s interval during the whole power off duration. This will draw additional 0.3mA.

Example: To turn RPi and Bricklets off in 5 seconds for 10 minutes with sleep indicator enabled, call (5, 60*10, true, true, true).

This function can also be used to implement a watchdog. To do this you can write a program that calls this function once per second in a loop with (10, 2, true, false, false). If the RPi crashes or gets stuck the HAT will reset the RPi after 10 seconds.

array BrickHAT::getSleepMode()
Return Array:
  • 'power_off_delay' – Type: int, Range: [0 to 232 - 1]
  • 'power_off_duration' – Type: int, Range: [0 to 232 - 1]
  • 'raspberry_pi_off' – Type: bool
  • 'bricklets_off' – Type: bool
  • 'enable_sleep_indicator' – Type: bool

Returns the sleep mode settings as set by setSleepMode().

void BrickHAT::setBrickletPower(bool $bricklet_power)
Parameters:
  • $bricklet_power – Type: bool

Set to true/false to turn the power supply of the connected Bricklets on/off.

By default the Bricklets are on.

bool BrickHAT::getBrickletPower()
Returns:
  • $bricklet_power – Type: bool

Returns the power status of the connected Bricklets as set by setBrickletPower().

array BrickHAT::getVoltages()
Return Array:
  • 'voltage_usb' – Type: int, Range: [0 to 216 - 1]
  • 'voltage_dc' – Type: int, Range: [0 to 216 - 1]

Returns the USB supply voltage and the DC input supply voltage in mV.

There are three possible combinations:

  • Only USB connected: The USB supply voltage will be fed back to the DC input connector. You will read the USB voltage and a slightly lower voltage on the DC input.
  • Only DC input connected: The DC voltage will not be fed back to the USB connector. You will read the DC input voltage and the USB voltage will be 0.
  • USB and DC input connected: You will read both voltages. In this case the USB supply will be without load, but it will work as backup if you disconnect the DC input (or if the DC input voltage falls below the USB voltage).

Advanced Functions

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

  • BrickHAT::FUNCTION_SET_SLEEP_MODE = 1
  • BrickHAT::FUNCTION_SET_BRICKLET_POWER = 3
  • BrickHAT::FUNCTION_SET_VOLTAGES_CALLBACK_CONFIGURATION = 6
  • BrickHAT::FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
  • BrickHAT::FUNCTION_SET_STATUS_LED_CONFIG = 239
  • BrickHAT::FUNCTION_RESET = 243
  • BrickHAT::FUNCTION_WRITE_UID = 248
void BrickHAT::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:

  • BrickHAT::FUNCTION_SET_SLEEP_MODE = 1
  • BrickHAT::FUNCTION_SET_BRICKLET_POWER = 3
  • BrickHAT::FUNCTION_SET_VOLTAGES_CALLBACK_CONFIGURATION = 6
  • BrickHAT::FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
  • BrickHAT::FUNCTION_SET_STATUS_LED_CONFIG = 239
  • BrickHAT::FUNCTION_RESET = 243
  • BrickHAT::FUNCTION_WRITE_UID = 248
void BrickHAT::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 BrickHAT::getSPITFPErrorCount()
Return Array:
  • 'error_count_ack_checksum' – Type: int, Range: [0 to 232 - 1]
  • 'error_count_message_checksum' – Type: int, Range: [0 to 232 - 1]
  • 'error_count_frame' – Type: int, Range: [0 to 232 - 1]
  • 'error_count_overflow' – Type: int, Range: [0 to 232 - 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.

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

  • BrickHAT::BOOTLOADER_MODE_BOOTLOADER = 0
  • BrickHAT::BOOTLOADER_MODE_FIRMWARE = 1
  • BrickHAT::BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
  • BrickHAT::BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
  • BrickHAT::BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4

For $status:

  • BrickHAT::BOOTLOADER_STATUS_OK = 0
  • BrickHAT::BOOTLOADER_STATUS_INVALID_MODE = 1
  • BrickHAT::BOOTLOADER_STATUS_NO_CHANGE = 2
  • BrickHAT::BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT = 3
  • BrickHAT::BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT = 4
  • BrickHAT::BOOTLOADER_STATUS_CRC_MISMATCH = 5
int BrickHAT::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:

  • BrickHAT::BOOTLOADER_MODE_BOOTLOADER = 0
  • BrickHAT::BOOTLOADER_MODE_FIRMWARE = 1
  • BrickHAT::BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
  • BrickHAT::BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
  • BrickHAT::BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4
void BrickHAT::setWriteFirmwarePointer(int $pointer)
Parameters:
  • $pointer – Type: int, Range: [0 to 232 - 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 BrickHAT::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 BrickHAT::setStatusLEDConfig(int $config)
Parameters:
  • $config – Type: int, Range: See constants

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:

  • BrickHAT::STATUS_LED_CONFIG_OFF = 0
  • BrickHAT::STATUS_LED_CONFIG_ON = 1
  • BrickHAT::STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • BrickHAT::STATUS_LED_CONFIG_SHOW_STATUS = 3
int BrickHAT::getStatusLEDConfig()
Returns:
  • $config – Type: int, Range: See constants

Returns the configuration as set by setStatusLEDConfig()

The following constants are available for this function:

For $config:

  • BrickHAT::STATUS_LED_CONFIG_OFF = 0
  • BrickHAT::STATUS_LED_CONFIG_ON = 1
  • BrickHAT::STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • BrickHAT::STATUS_LED_CONFIG_SHOW_STATUS = 3
int BrickHAT::getChipTemperature()
Returns:
  • $temperature – Type: int, Range: [-215 to 215 - 1]

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 BrickHAT::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 BrickHAT::writeUID(int $uid)
Parameters:
  • $uid – Type: int, Range: [0 to 232 - 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 BrickHAT::readUID()
Returns:
  • $uid – Type: int, Range: [0 to 232 - 1]

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

array BrickHAT::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 Brick.

Callback Configuration Functions

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

The period is the period with which the CALLBACK_VOLTAGES 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.

New in version 2.0.1 (Firmware).

array BrickHAT::getVoltagesCallbackConfiguration()
Return Array:
  • 'period' – Type: int, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0
  • 'value_has_to_change' – Type: bool, Default: FALSE

Returns the callback configuration as set by setVoltagesCallbackConfiguration().

New in version 2.0.1 (Firmware).

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

$hat->registerCallback(BrickHAT::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 BrickHAT::CALLBACK_VOLTAGES
<?php   void callback(int $voltage_usb, int $voltage_dc [, mixed $user_data])   ?>
Callback Parameters:
  • $voltage_usb – Type: int, Range: [0 to 216 - 1]
  • $voltage_dc – Type: int, Range: [0 to 216 - 1]
  • $user_data – Type: mixed

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

The parameters are the same as getVoltages().

New in version 2.0.1 (Firmware).

Constants

int BrickHAT::DEVICE_IDENTIFIER

This constant is used to identify a HAT Brick.

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

This constant represents the human readable name of a HAT Brick.