PHP - RGB LED Button Bricklet

This is the description of the PHP API bindings for the RGB LED Button Bricklet. General information and technical specifications for the RGB LED Button 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 Color

Download (ExampleSimpleColor.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/BrickletRGBLEDButton.php');

use Tinkerforge\IPConnection;
use Tinkerforge\BrickletRGBLEDButton;

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

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

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

// Set light blue color
$rlb->setColor(0, 170, 234);

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

?>

Simple Button

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

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

use Tinkerforge\IPConnection;
use Tinkerforge\BrickletRGBLEDButton;

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

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

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

// Get current button state
$state = $rlb->getButtonState();

if ($state == BrickletRGBLEDButton::BUTTON_STATE_PRESSED) {
    echo "State: Pressed\n";
} elseif ($state == BrickletRGBLEDButton::BUTTON_STATE_RELEASED) {
    echo "State: Released\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
<?php

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

use Tinkerforge\IPConnection;
use Tinkerforge\BrickletRGBLEDButton;

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

// Callback function for button state changed callback
function cb_buttonStateChanged($state)
{
    if ($state == BrickletRGBLEDButton::BUTTON_STATE_PRESSED) {
        echo "State: Pressed\n";
    } elseif ($state == BrickletRGBLEDButton::BUTTON_STATE_RELEASED) {
        echo "State: Released\n";
    }
}

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

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

// Register button state changed callback to function cb_buttonStateChanged
$rlb->registerCallback(BrickletRGBLEDButton::CALLBACK_BUTTON_STATE_CHANGED,
                       'cb_buttonStateChanged');

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 BrickletRGBLEDButton(string $uid, IPConnection $ipcon)

Creates an object with the unique device ID $uid:

<?php   $rgb_led_button = new BrickletRGBLEDButton('YOUR_DEVICE_UID', $ipcon);   ?>

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

void BrickletRGBLEDButton::setColor(int $red, int $green, int $blue)

Sets the color of the LED.

By default the LED is off (0, 0, 0).

array BrickletRGBLEDButton::getColor()

Returns the LED color as set by setColor().

The returned array has the keys red, green and blue.

int BrickletRGBLEDButton::getButtonState()

Returns the current state of the button (either pressed or released).

The following constants are available for this function:

  • BrickletRGBLEDButton::BUTTON_STATE_PRESSED = 0
  • BrickletRGBLEDButton::BUTTON_STATE_RELEASED = 1
array BrickletRGBLEDButton::getColorCalibration()

Returns the color calibration as set by setColorCalibration().

The returned array has the keys red, green and blue.

Advanced Functions

void BrickletRGBLEDButton::setColorCalibration(int $red, int $green, int $blue)

Sets a color calibration. Some colors appear brighter then others, so a calibration may be necessary for nice uniform colors.

The values range from 0% to 100%.

The calibration is saved in flash. You don't need to call this function on every startup.

Default value is (100, 100, 55).

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

  • BrickletRGBLEDButton::FUNCTION_SET_COLOR = 1
  • BrickletRGBLEDButton::FUNCTION_SET_COLOR_CALIBRATION = 5
  • BrickletRGBLEDButton::FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
  • BrickletRGBLEDButton::FUNCTION_SET_STATUS_LED_CONFIG = 239
  • BrickletRGBLEDButton::FUNCTION_RESET = 243
  • BrickletRGBLEDButton::FUNCTION_WRITE_UID = 248
void BrickletRGBLEDButton::setResponseExpectedAll(bool $response_expected)

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

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

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

Returns the current bootloader mode, see setBootloaderMode().

The following constants are available for this function:

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

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

Returns the configuration as set by setStatusLEDConfig()

The following constants are available for this function:

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

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

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

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

$rgb_led_button->registerCallback(BrickletRGBLEDButton::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 BrickletRGBLEDButton::CALLBACK_BUTTON_STATE_CHANGED
<?php   void callback(int $state [, mixed $user_data])   ?>

This callback is triggered every time the button state changes from pressed to released or from released to pressed.

The parameter is the current state of the button.

The following constants are available for this function:

  • BrickletRGBLEDButton::BUTTON_STATE_PRESSED = 0
  • BrickletRGBLEDButton::BUTTON_STATE_RELEASED = 1

Constants

int BrickletRGBLEDButton::DEVICE_IDENTIFIER

This constant is used to identify a RGB LED Button 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 BrickletRGBLEDButton::DEVICE_DISPLAY_NAME

This constant represents the human readable name of a RGB LED Button Bricklet.