PHP - RGB LED Matrix Bricklet

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

API

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

Basic Functions

class BrickletRGBLEDMatrix(string $uid, IPConnection $ipcon)
Parameters:
  • $uid – Type: string
  • $ipcon – Type: IPConnection
Returns:
  • $rgb_led_matrix – Type: BrickletRGBLEDMatrix

Creates an object with the unique device ID $uid:

<?php   $rgb_led_matrix = new BrickletRGBLEDMatrix('YOUR_DEVICE_UID', $ipcon);   ?>

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

void BrickletRGBLEDMatrix::setRed(array $red)
Parameters:
  • $red – Type: array(int, ...), Length: 64, Range: [0 to 255]

Sets the 64 red LED values of the matrix.

array BrickletRGBLEDMatrix::getRed()
Returns:
  • $red – Type: array(int, ...), Length: 64, Range: [0 to 255]

Returns the red LED values as set by setRed().

void BrickletRGBLEDMatrix::setGreen(array $green)
Parameters:
  • $green – Type: array(int, ...), Length: 64, Range: [0 to 255]

Sets the 64 green LED values of the matrix.

array BrickletRGBLEDMatrix::getGreen()
Returns:
  • $green – Type: array(int, ...), Length: 64, Range: [0 to 255]

Returns the green LED values as set by setGreen().

void BrickletRGBLEDMatrix::setBlue(array $blue)
Parameters:
  • $blue – Type: array(int, ...), Length: 64, Range: [0 to 255]

Sets the 64 blue LED values of the matrix.

array BrickletRGBLEDMatrix::getBlue()
Returns:
  • $blue – Type: array(int, ...), Length: 64, Range: [0 to 255]

Returns the blue LED values as set by setBlue().

void BrickletRGBLEDMatrix::setFrameDuration(int $frame_duration)
Parameters:
  • $frame_duration – Type: int, Range: [0 to 216 - 1]

Sets the frame duration in ms.

Example: If you want to achieve 20 frames per second, you should set the frame duration to 50ms (50ms * 20 = 1 second).

Set this value to 0 to turn the automatic frame write mechanism off.

Approach:

For frame duration of 0 see drawFrame().

Default value: 0 = off.

int BrickletRGBLEDMatrix::getFrameDuration()
Returns:
  • $frame_duration – Type: int, Range: [0 to 216 - 1]

Returns the frame duration in ms as set by setFrameDuration().

void BrickletRGBLEDMatrix::drawFrame()

If you set the frame duration to 0 (see setFrameDuration()), you can use this function to transfer the frame to the matrix.

Approach:

Advanced Functions

int BrickletRGBLEDMatrix::getSupplyVoltage()
Returns:
  • $voltage – Type: int, Range: [0 to 216 - 1]

Returns the current supply voltage of the Bricklet. The voltage is given in mV.

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

  • BrickletRGBLEDMatrix::FUNCTION_SET_RED = 1
  • BrickletRGBLEDMatrix::FUNCTION_SET_GREEN = 3
  • BrickletRGBLEDMatrix::FUNCTION_SET_BLUE = 5
  • BrickletRGBLEDMatrix::FUNCTION_SET_FRAME_DURATION = 7
  • BrickletRGBLEDMatrix::FUNCTION_DRAW_FRAME = 9
  • BrickletRGBLEDMatrix::FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
  • BrickletRGBLEDMatrix::FUNCTION_SET_STATUS_LED_CONFIG = 239
  • BrickletRGBLEDMatrix::FUNCTION_RESET = 243
  • BrickletRGBLEDMatrix::FUNCTION_WRITE_UID = 248
void BrickletRGBLEDMatrix::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:

  • BrickletRGBLEDMatrix::FUNCTION_SET_RED = 1
  • BrickletRGBLEDMatrix::FUNCTION_SET_GREEN = 3
  • BrickletRGBLEDMatrix::FUNCTION_SET_BLUE = 5
  • BrickletRGBLEDMatrix::FUNCTION_SET_FRAME_DURATION = 7
  • BrickletRGBLEDMatrix::FUNCTION_DRAW_FRAME = 9
  • BrickletRGBLEDMatrix::FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
  • BrickletRGBLEDMatrix::FUNCTION_SET_STATUS_LED_CONFIG = 239
  • BrickletRGBLEDMatrix::FUNCTION_RESET = 243
  • BrickletRGBLEDMatrix::FUNCTION_WRITE_UID = 248
void BrickletRGBLEDMatrix::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 BrickletRGBLEDMatrix::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 BrickletRGBLEDMatrix::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:

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

For $status:

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

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

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

  • BrickletRGBLEDMatrix::STATUS_LED_CONFIG_OFF = 0
  • BrickletRGBLEDMatrix::STATUS_LED_CONFIG_ON = 1
  • BrickletRGBLEDMatrix::STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • BrickletRGBLEDMatrix::STATUS_LED_CONFIG_SHOW_STATUS = 3
int BrickletRGBLEDMatrix::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 BrickletRGBLEDMatrix::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 BrickletRGBLEDMatrix::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 BrickletRGBLEDMatrix::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 BrickletRGBLEDMatrix::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 Bricklet.

Callback Configuration Functions

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

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_matrix->registerCallback(BrickletRGBLEDMatrix::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 BrickletRGBLEDMatrix::CALLBACK_FRAME_STARTED
<?php   void callback(int $frame_number [, mixed $user_data])   ?>
Callback Parameters:
  • $frame_number – Type: int, Range: [0 to 232 - 1]
  • $user_data – Type: mixed

This callback is triggered as soon as a new frame write is started. The LED values are double buffered, so you can send the LED values for the next frame directly after this callback is triggered.

Constants

int BrickletRGBLEDMatrix::DEVICE_IDENTIFIER

This constant is used to identify a RGB LED Matrix Bricklet.

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

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