PHP - DMX Bricklet

This is the description of the PHP API bindings for the DMX Bricklet. General information and technical specifications for the DMX 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
<?php

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

use Tinkerforge\IPConnection;
use Tinkerforge\BrickletDMX;

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

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

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

// Configure Bricklet as DMX master
$dmx->setDMXMode(BrickletDMX::DMX_MODE_MASTER);

// Write DMX frame with 3 channels
$dmx->writeFrame(array(255, 128, 0));

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

Creates an object with the unique device ID $uid:

<?php   $dmx = new BrickletDMX('YOUR_DEVICE_UID', $ipcon);   ?>

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

void BrickletDMX::setDMXMode(int $dmx_mode)

Sets the DMX mode to either master or slave.

Calling this function sets frame number to 0.

The default value is 0 (master).

The following constants are available for this function:

  • BrickletDMX::DMX_MODE_MASTER = 0
  • BrickletDMX::DMX_MODE_SLAVE = 1
int BrickletDMX::getDMXMode()

Returns the DMX mode, as set by setDMXMode().

The following constants are available for this function:

  • BrickletDMX::DMX_MODE_MASTER = 0
  • BrickletDMX::DMX_MODE_SLAVE = 1
void BrickletDMX::writeFrame(array $frame)

Writes a DMX frame. The maximum frame size is 512 byte. Each byte represents one channel.

The next frame can be written after the CALLBACK_FRAME_STARTED callback was called. The frame is double buffered, so a new frame can be written as soon as the writing of the prior frame starts.

The data will be transfered when the next frame duration ends, see setFrameDuration().

Generic approach:

  • Set the frame duration to a value that represents the number of frames per second you want to achieve.
  • Set channels for first frame.
  • Wait for the CALLBACK_FRAME_STARTED callback.
  • Set channels for next frame.
  • Wait for the CALLBACK_FRAME_STARTED callback.
  • and so on.

This approach ensures that you can set new DMX data with a fixed frame rate.

This function can only be called in master mode.

array BrickletDMX::readFrame()

Returns the last frame that was written by the DMX master. The size of the array is equivalent to the number of channels in the frame. Each byte represents one channel.

The next frame is available after the CALLBACK_FRAME_AVAILABLE callback was called.

Generic approach:

Instead of polling this function you can also use the CALLBACK_FRAME callback. You can enable it with setFrameCallbackConfig().

The frame number starts at 0 and it is increased by one with each received frame.

This function can only be called in slave mode.

The returned array has the keys frame and frame_number.

void BrickletDMX::setFrameDuration(int $frame_duration)

Sets the duration of a frame in ms.

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

If you always want to send a frame as fast as possible you can set this value to 0.

This setting is only used in master mode.

Default value: 100ms (10 frames per second).

int BrickletDMX::getFrameDuration()

Returns the frame duration as set by setFrameDuration().

Advanced Functions

array BrickletDMX::getFrameErrorCount()

Returns the current number of overrun and framing errors.

The returned array has the keys overrun_error_count and framing_error_count.

void BrickletDMX::setCommunicationLEDConfig(int $config)

Sets the communication LED configuration. By default the LED shows communication traffic, 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 off.

The following constants are available for this function:

  • BrickletDMX::COMMUNICATION_LED_CONFIG_OFF = 0
  • BrickletDMX::COMMUNICATION_LED_CONFIG_ON = 1
  • BrickletDMX::COMMUNICATION_LED_CONFIG_SHOW_HEARTBEAT = 2
  • BrickletDMX::COMMUNICATION_LED_CONFIG_SHOW_COMMUNICATION = 3
int BrickletDMX::getCommunicationLEDConfig()

Returns the configuration as set by setCommunicationLEDConfig()

The following constants are available for this function:

  • BrickletDMX::COMMUNICATION_LED_CONFIG_OFF = 0
  • BrickletDMX::COMMUNICATION_LED_CONFIG_ON = 1
  • BrickletDMX::COMMUNICATION_LED_CONFIG_SHOW_HEARTBEAT = 2
  • BrickletDMX::COMMUNICATION_LED_CONFIG_SHOW_COMMUNICATION = 3
void BrickletDMX::setErrorLEDConfig(int $config)

Sets the error LED configuration.

By default the error LED turns on if there is any error (see CALLBACK_FRAME_ERROR_COUNT callback). If you call this function with the Show-Error option again, the LED will turn off until the next error occurs.

You can also turn the LED permanently on/off or show a heartbeat.

If the Bricklet is in bootloader mode, the LED is off.

The following constants are available for this function:

  • BrickletDMX::ERROR_LED_CONFIG_OFF = 0
  • BrickletDMX::ERROR_LED_CONFIG_ON = 1
  • BrickletDMX::ERROR_LED_CONFIG_SHOW_HEARTBEAT = 2
  • BrickletDMX::ERROR_LED_CONFIG_SHOW_ERROR = 3
int BrickletDMX::getErrorLEDConfig()

Returns the configuration as set by setErrorLEDConfig().

The following constants are available for this function:

  • BrickletDMX::ERROR_LED_CONFIG_OFF = 0
  • BrickletDMX::ERROR_LED_CONFIG_ON = 1
  • BrickletDMX::ERROR_LED_CONFIG_SHOW_HEARTBEAT = 2
  • BrickletDMX::ERROR_LED_CONFIG_SHOW_ERROR = 3
array BrickletDMX::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 BrickletDMX::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 BrickletDMX::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:

  • BrickletDMX::FUNCTION_SET_DMX_MODE = 1
  • BrickletDMX::FUNCTION_WRITE_FRAME = 3
  • BrickletDMX::FUNCTION_SET_FRAME_DURATION = 5
  • BrickletDMX::FUNCTION_SET_COMMUNICATION_LED_CONFIG = 8
  • BrickletDMX::FUNCTION_SET_ERROR_LED_CONFIG = 10
  • BrickletDMX::FUNCTION_SET_FRAME_CALLBACK_CONFIG = 12
  • BrickletDMX::FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
  • BrickletDMX::FUNCTION_SET_STATUS_LED_CONFIG = 239
  • BrickletDMX::FUNCTION_RESET = 243
  • BrickletDMX::FUNCTION_WRITE_UID = 248
void BrickletDMX::setResponseExpectedAll(bool $response_expected)

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

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

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

Returns the current bootloader mode, see setBootloaderMode().

The following constants are available for this function:

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

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

Returns the configuration as set by setStatusLEDConfig()

The following constants are available for this function:

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

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

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

void BrickletDMX::setFrameCallbackConfig(bool $frame_started_callback_enabled, bool $frame_available_callback_enabled, bool $frame_callback_enabled, bool $frame_error_count_callback_enabled)

Enables/Disables the different callbacks. By default the CALLBACK_FRAME_STARTED callback and CALLBACK_FRAME_AVAILABLE callback are enabled while the CALLBACK_FRAME callback and CALLBACK_FRAME_ERROR_COUNT callback are disabled.

If you want to use the CALLBACK_FRAME callback you can enable it and disable the cb:Frame Available callback at the same time. It becomes redundant in this case.

array BrickletDMX::getFrameCallbackConfig()

Returns the frame callback config as set by setFrameCallbackConfig().

The returned array has the keys frame_started_callback_enabled, frame_available_callback_enabled, frame_callback_enabled and frame_error_count_callback_enabled.

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

$dmx->registerCallback(BrickletDMX::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 BrickletDMX::CALLBACK_FRAME_STARTED
<?php   void callback([mixed $user_data])   ?>

This callback is triggered as soon as a new frame write is started. You should send the data for the next frame directly after this callback was triggered.

For an explanation of the general approach see writeFrame().

This callback can be enabled via setFrameCallbackConfig().

This callback can only be triggered in master mode.

int BrickletDMX::CALLBACK_FRAME_AVAILABLE
<?php   void callback(int $frame_number [, mixed $user_data])   ?>

This callback is triggered in slave mode when a new frame was received from the DMX master and it can be read out. You have to read the frame before the master has written the next frame, see readFrame() for more details.

The parameter is the frame number, it is increased by one with each received frame.

This callback can be enabled via setFrameCallbackConfig().

This callback can only be triggered in slave mode.

int BrickletDMX::CALLBACK_FRAME
<?php   void callback(array $frame, int $frame_number [, mixed $user_data])   ?>

This callback is called as soon as a new frame is available (written by the DMX master).

The size of the array is equivalent to the number of channels in the frame. Each byte represents one channel.

This callback can be enabled via setFrameCallbackConfig().

This callback can only be triggered in slave mode.

int BrickletDMX::CALLBACK_FRAME_ERROR_COUNT
<?php   void callback(int $overrun_error_count, int $framing_error_count [, mixed $user_data])   ?>

This callback is called if a new error occurs. It returns the current overrun and framing error count.

Constants

int BrickletDMX::DEVICE_IDENTIFIER

This constant is used to identify a DMX 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 BrickletDMX::DEVICE_DISPLAY_NAME

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