PHP - E-Paper 296x128 Bricklet

This is the description of the PHP API bindings for the E-Paper 296x128 Bricklet. General information and technical specifications for the E-Paper 296x128 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).

Hello World

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

use Tinkerforge\IPConnection;
use Tinkerforge\BrickletEPaper296x128;

const HOST = 'localhost';
const PORT = 4223;
const UID = 'XYZ'; // Change XYZ to the UID of your E-Paper 296x128 Bricklet

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

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

// Use black background
$ep->fillDisplay(BrickletEPaper296x128::COLOR_BLACK);

// Write big white "Hello World" in the middle of the screen
$ep->drawText(16, 48, BrickletEPaper296x128::FONT_24X32,
              BrickletEPaper296x128::COLOR_WHITE,
              BrickletEPaper296x128::ORIENTATION_HORIZONTAL, 'Hello World');
$ep->draw();

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

?>

Load Image

Download (ExampleLoadImage.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
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
<?php

if (!extension_loaded('gd')) {
    echo "Required gd extension is not available\n";
    exit;
}

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

use Tinkerforge\IPConnection;
use Tinkerforge\BrickletEPaper296x128;

const HOST = 'localhost';
const PORT = 4223;
const UID = 'XYZ'; // Change XYZ to the UID of your E-Paper 296x128 Bricklet
const WIDTH = 296; // Columns
const HEIGHT = 128; // Rows

// Convert GD Image to matching color bool array
function boolArrayFromImage($image, $r, $g, $b)
{
    $pixels = array();

    // Convert image pixels into 8bit pages
    for ($row = 0; $row < HEIGHT; $row++)
    {
        for ($column = 0; $column < WIDTH; $column++)
        {
            $index = imagecolorat($image, $column, $row);
            $color = imagecolorsforindex($image, $index);
            $pixels[$row*WIDTH + $column] = (($color['red'] == $r) && ($color['green'] == $g) && ($color['blue'] == $b));
        }
    }
    
    return $pixels;
}

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

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

// Download example image here:
// https://raw.githubusercontent.com/Tinkerforge/e-paper-296x128-bricklet/master/software/examples/tf_red.png
$image = imagecreatefrompng('tf_red.png');

// Get black/white pixels from image and write them to the Bricklet buffer
$pixelsBW = boolArrayFromImage($image, 0xFF, 0xFF, 0xFF);
$epaper->writeBlackWhite(0, 0, WIDTH-1, HEIGHT-1, $pixelsBW);

// Get red pixels from image and write them to the Bricklet buffer
$pixelsRed = boolArrayFromImage($image, 0xFF, 0, 0);
$epaper->writeColor(0, 0, WIDTH-1, HEIGHT-1, $pixelsRed);

// Draw buffered values to the display
$epaper->draw();

echo "Press ctrl+c to exit\n";

?>

API

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

Basic Functions

class BrickletEPaper296x128(string $uid, IPConnection $ipcon)
Parameters:
  • $uid – Type: string
  • $ipcon – Type: IPConnection
Returns:
  • $e_paper_296x128 – Type: BrickletEPaper296x128

Creates an object with the unique device ID $uid:

<?php   $e_paper_296x128 = new BrickletEPaper296x128('YOUR_DEVICE_UID', $ipcon);   ?>

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

void BrickletEPaper296x128::draw()

Draws the current black/white and red or gray buffer to the e-paper display.

The Bricklet does not have any double-buffering. You should not call this function while writing to the buffer. See getDrawStatus().

int BrickletEPaper296x128::getDrawStatus()
Returns:
  • $draw_status – Type: int, Range: See constants

Returns one of three draw statuses:

  • Idle
  • Copying: Data is being copied from the buffer of the Bricklet to the buffer of the display.
  • Drawing: The display is updating its content (during this phase the flickering etc happens).

You can write to the buffer (through one of the write or draw functions) when the status is either idle or drawing. You should not write to the buffer while it is being copied to the display. There is no double-buffering.

The following constants are available for this function:

For $draw_status:

  • BrickletEPaper296x128::DRAW_STATUS_IDLE = 0
  • BrickletEPaper296x128::DRAW_STATUS_COPYING = 1
  • BrickletEPaper296x128::DRAW_STATUS_DRAWING = 2
void BrickletEPaper296x128::writeBlackWhite(int $x_start, int $y_start, int $x_end, int $y_end, array $pixels)
Parameters:
  • $x_start – Type: int, Range: [0 to 295]
  • $y_start – Type: int, Range: [0 to 127]
  • $x_end – Type: int, Range: [0 to 295]
  • $y_end – Type: int, Range: [0 to 127]
  • $pixels – Type: array(bool, ...), Length: variable

Writes black/white pixels to the specified window into the buffer.

The pixels are written into the window line by line top to bottom and each line is written from left to right.

The value 0 (false) corresponds to a black pixel and the value 1 (true) to a white pixel.

This function writes the pixels into the black/white pixel buffer, to draw the buffer to the display use draw().

Use writeColor() to write red or gray pixels.

array BrickletEPaper296x128::readBlackWhite(int $x_start, int $y_start, int $x_end, int $y_end)
Parameters:
  • $x_start – Type: int, Range: [0 to 295]
  • $y_start – Type: int, Range: [0 to 127]
  • $x_end – Type: int, Range: [0 to 295]
  • $y_end – Type: int, Range: [0 to 127]
Returns:
  • $pixels – Type: array(bool, ...), Length: variable

Returns the current content of the black/white pixel buffer for the specified window.

The pixels are read into the window line by line top to bottom and each line is read from left to right.

The current content of the buffer does not have to be the current content of the display. It is possible that the data was not drawn to the display yet and after a restart of the Bricklet the buffer will be reset to black, while the display retains its content.

void BrickletEPaper296x128::writeColor(int $x_start, int $y_start, int $x_end, int $y_end, array $pixels)
Parameters:
  • $x_start – Type: int, Range: [0 to 295]
  • $y_start – Type: int, Range: [0 to 127]
  • $x_end – Type: int, Range: [0 to 295]
  • $y_end – Type: int, Range: [0 to 127]
  • $pixels – Type: array(bool, ...), Length: variable

The E-Paper 296x128 Bricklet is available with the colors black/white/red and black/white/gray. Depending on the model this function writes either red or gray pixels to the specified window into the buffer.

The pixels are written into the window line by line top to bottom and each line is written from left to right.

The value 0 (false) means that this pixel does not have color. It will be either black or white (see writeBlackWhite()). The value 1 (true) corresponds to a red or gray pixel, depending on the Bricklet model.

This function writes the pixels into the red or gray pixel buffer, to draw the buffer to the display use draw().

Use writeBlackWhite() to write black/white pixels.

array BrickletEPaper296x128::readColor(int $x_start, int $y_start, int $x_end, int $y_end)
Parameters:
  • $x_start – Type: int, Range: [0 to 295]
  • $y_start – Type: int, Range: [0 to 127]
  • $x_end – Type: int, Range: [0 to 295]
  • $y_end – Type: int, Range: [0 to 127]
Returns:
  • $pixels – Type: array(bool, ...), Length: variable

Returns the current content of the red or gray pixel buffer for the specified window.

The pixels are written into the window line by line top to bottom and each line is written from left to right.

The current content of the buffer does not have to be the current content of the display. It is possible that the data was not drawn to the display yet and after a restart of the Bricklet the buffer will be reset to black, while the display retains its content.

void BrickletEPaper296x128::fillDisplay(int $color)
Parameters:
  • $color – Type: int, Range: See constants

Fills the complete content of the display with the given color.

This function writes the pixels into the black/white/red|gray pixel buffer, to draw the buffer to the display use draw().

The following constants are available for this function:

For $color:

  • BrickletEPaper296x128::COLOR_BLACK = 0
  • BrickletEPaper296x128::COLOR_WHITE = 1
  • BrickletEPaper296x128::COLOR_RED = 2
  • BrickletEPaper296x128::COLOR_GRAY = 2
void BrickletEPaper296x128::drawText(int $position_x, int $position_y, int $font, int $color, int $orientation, string $text)
Parameters:
  • $position_x – Type: int, Range: [0 to 295]
  • $position_y – Type: int, Range: [0 to 127]
  • $font – Type: int, Range: See constants
  • $color – Type: int, Range: See constants
  • $orientation – Type: int, Range: See constants
  • $text – Type: string, Length: up to 50

Draws a text with up to 50 characters at the pixel position (x, y).

You can use one of 9 different font sizes and draw the text in black/white/red|gray. The text can be drawn horizontal or vertical.

This function writes the pixels into the black/white/red|gray pixel buffer, to draw the buffer to the display use draw().

The following constants are available for this function:

For $font:

  • BrickletEPaper296x128::FONT_6X8 = 0
  • BrickletEPaper296x128::FONT_6X16 = 1
  • BrickletEPaper296x128::FONT_6X24 = 2
  • BrickletEPaper296x128::FONT_6X32 = 3
  • BrickletEPaper296x128::FONT_12X16 = 4
  • BrickletEPaper296x128::FONT_12X24 = 5
  • BrickletEPaper296x128::FONT_12X32 = 6
  • BrickletEPaper296x128::FONT_18X24 = 7
  • BrickletEPaper296x128::FONT_18X32 = 8
  • BrickletEPaper296x128::FONT_24X32 = 9

For $color:

  • BrickletEPaper296x128::COLOR_BLACK = 0
  • BrickletEPaper296x128::COLOR_WHITE = 1
  • BrickletEPaper296x128::COLOR_RED = 2
  • BrickletEPaper296x128::COLOR_GRAY = 2

For $orientation:

  • BrickletEPaper296x128::ORIENTATION_HORIZONTAL = 0
  • BrickletEPaper296x128::ORIENTATION_VERTICAL = 1
void BrickletEPaper296x128::drawLine(int $position_x_start, int $position_y_start, int $position_x_end, int $position_y_end, int $color)
Parameters:
  • $position_x_start – Type: int, Range: [0 to 295]
  • $position_y_start – Type: int, Range: [0 to 127]
  • $position_x_end – Type: int, Range: [0 to 295]
  • $position_y_end – Type: int, Range: [0 to 127]
  • $color – Type: int, Range: See constants

Draws a line from (x, y)-start to (x, y)-end in the given color.

This function writes the pixels into the black/white/red|gray pixel buffer, to draw the buffer to the display use draw().

The following constants are available for this function:

For $color:

  • BrickletEPaper296x128::COLOR_BLACK = 0
  • BrickletEPaper296x128::COLOR_WHITE = 1
  • BrickletEPaper296x128::COLOR_RED = 2
  • BrickletEPaper296x128::COLOR_GRAY = 2
void BrickletEPaper296x128::drawBox(int $position_x_start, int $position_y_start, int $position_x_end, int $position_y_end, bool $fill, int $color)
Parameters:
  • $position_x_start – Type: int, Range: [0 to 295]
  • $position_y_start – Type: int, Range: [0 to 127]
  • $position_x_end – Type: int, Range: [0 to 295]
  • $position_y_end – Type: int, Range: [0 to 127]
  • $fill – Type: bool
  • $color – Type: int, Range: See constants

Draws a box from (x, y)-start to (x, y)-end in the given color.

If you set fill to true, the box will be filled with the color. Otherwise only the outline will be drawn.

This function writes the pixels into the black/white/red|gray pixel buffer, to draw the buffer to the display use draw().

The following constants are available for this function:

For $color:

  • BrickletEPaper296x128::COLOR_BLACK = 0
  • BrickletEPaper296x128::COLOR_WHITE = 1
  • BrickletEPaper296x128::COLOR_RED = 2
  • BrickletEPaper296x128::COLOR_GRAY = 2

Advanced Functions

void BrickletEPaper296x128::setUpdateMode(int $update_mode)
Parameters:
  • $update_mode – Type: int, Range: See constants, Default: 0

Note

The default update mode corresponds to the default e-paper display manufacturer settings. All of the other modes are experimental and will result in increased ghosting and possibly other long-term side effects.

If you want to know more about the inner workings of an e-paper display take a look at this excellent video from Ben Krasnow: https://www.youtube.com/watch?v=MsbiO8EAsGw.

If you are not sure about this option, leave the update mode at default.

Currently there are three update modes available:

  • Default: Settings as given by the manufacturer. An update will take about 7.5 seconds and during the update the screen will flicker several times.
  • Black/White: This will only update the black/white pixel. It uses the manufacturer settings for black/white and ignores the red or gray pixel buffer. With this mode the display will flicker once and it takes about 2.5 seconds. Compared to the default settings there is more ghosting.
  • Delta: This will only update the black/white pixel. It uses an aggressive method where the changes are not applied for a whole buffer but only for the delta between the last and the next buffer. With this mode the display will not flicker during an update and it takes about 900-950ms. Compared to the other two settings there is more ghosting. This mode can be used for something like a flicker-free live update of a text.

With the black/white/red display if you use either the black/white or the delta mode, after a while of going back and forth between black and white the white color will start to appear red-ish or pink-ish.

If you use the aggressive delta mode and rapidly change the content, we recommend that you change back to the default mode every few hours and in the default mode cycle between the three available colors a few times. This will get rid of the ghosting and after that you can go back to the delta mode with flicker-free updates.

The following constants are available for this function:

For $update_mode:

  • BrickletEPaper296x128::UPDATE_MODE_DEFAULT = 0
  • BrickletEPaper296x128::UPDATE_MODE_BLACK_WHITE = 1
  • BrickletEPaper296x128::UPDATE_MODE_DELTA = 2
int BrickletEPaper296x128::getUpdateMode()
Returns:
  • $update_mode – Type: int, Range: See constants, Default: 0

Returns the update mode as set by setUpdateMode().

The following constants are available for this function:

For $update_mode:

  • BrickletEPaper296x128::UPDATE_MODE_DEFAULT = 0
  • BrickletEPaper296x128::UPDATE_MODE_BLACK_WHITE = 1
  • BrickletEPaper296x128::UPDATE_MODE_DELTA = 2
void BrickletEPaper296x128::setDisplayType(int $display_type)
Parameters:
  • $display_type – Type: int, Range: See constants

Sets the type of the display. The e-paper display is available in black/white/red and black/white/gray. This will be factory set during the flashing and testing phase. The value is saved in non-volatile memory and will stay after a power cycle.

The following constants are available for this function:

For $display_type:

  • BrickletEPaper296x128::DISPLAY_TYPE_BLACK_WHITE_RED = 0
  • BrickletEPaper296x128::DISPLAY_TYPE_BLACK_WHITE_GRAY = 1
int BrickletEPaper296x128::getDisplayType()
Returns:
  • $display_type – Type: int, Range: See constants

Returns the type of the e-paper display. It can either be black/white/red or black/white/gray.

The following constants are available for this function:

For $display_type:

  • BrickletEPaper296x128::DISPLAY_TYPE_BLACK_WHITE_RED = 0
  • BrickletEPaper296x128::DISPLAY_TYPE_BLACK_WHITE_GRAY = 1
array BrickletEPaper296x128::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 BrickletEPaper296x128::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:

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

For $status:

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

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

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:

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

Returns the configuration as set by setStatusLEDConfig()

The following constants are available for this function:

For $config:

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

Returns the temperature 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 BrickletEPaper296x128::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 BrickletEPaper296x128::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 BrickletEPaper296x128::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 BrickletEPaper296x128::getIdentity()
Return Array:
  • 'uid' – Type: string, Length: up to 8
  • 'connected_uid' – Type: string, Length: up to 8
  • 'position' – Type: string, Range: ['a' to 'h', 'i', 'z']
  • 'hardware_version' – Type: array(int, ...), Length: 3
    • 0: $major – Type: int, Range: [0 to 255]
    • 1: $minor – Type: int, Range: [0 to 255]
    • 2: $revision – Type: int, Range: [0 to 255]
  • 'firmware_version' – Type: array(int, ...), Length: 3
    • 0: $major – Type: int, Range: [0 to 255]
    • 1: $minor – Type: int, Range: [0 to 255]
    • 2: $revision – Type: int, 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', 'd', 'e', 'f', 'g' or 'h' (Bricklet Port). The Raspberry Pi HAT (Zero) Brick is always at position 'i' and the Bricklet connected to an Isolator Bricklet is always as position 'z'.

The device identifier numbers can be found here. There is also a constant for the device identifier of this Bricklet.

Callback Configuration Functions

void BrickletEPaper296x128::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";
}

$e_paper_296x128->registerCallback(BrickletEPaper296x128::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 BrickletEPaper296x128::CALLBACK_DRAW_STATUS
<?php   void callback(int $draw_status [, mixed $user_data])   ?>
Callback Parameters:
  • $draw_status – Type: int, Range: See constants
  • $user_data – Type: mixed

Callback for the current draw status. Will be called every time the draw status changes (see getDrawStatus()).

The following constants are available for this function:

For $draw_status:

  • BrickletEPaper296x128::DRAW_STATUS_IDLE = 0
  • BrickletEPaper296x128::DRAW_STATUS_COPYING = 1
  • BrickletEPaper296x128::DRAW_STATUS_DRAWING = 2

Virtual Functions

Virtual functions don't communicate with the device itself, but operate only on the API bindings device object. They can be called without the corresponding IP Connection object being connected.

array BrickletEPaper296x128::getAPIVersion()
Return Array:
  • $api_version – Type: array(int, ...), Length: 3
    • 0: $major – Type: int, Range: [0 to 255]
    • 1: $minor – Type: int, Range: [0 to 255]
    • 2: $revision – Type: int, Range: [0 to 255]

Returns the version of the API definition 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 BrickletEPaper296x128::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:

  • BrickletEPaper296x128::FUNCTION_DRAW = 1
  • BrickletEPaper296x128::FUNCTION_WRITE_BLACK_WHITE = 3
  • BrickletEPaper296x128::FUNCTION_WRITE_COLOR = 5
  • BrickletEPaper296x128::FUNCTION_FILL_DISPLAY = 7
  • BrickletEPaper296x128::FUNCTION_DRAW_TEXT = 8
  • BrickletEPaper296x128::FUNCTION_DRAW_LINE = 9
  • BrickletEPaper296x128::FUNCTION_DRAW_BOX = 10
  • BrickletEPaper296x128::FUNCTION_SET_UPDATE_MODE = 12
  • BrickletEPaper296x128::FUNCTION_SET_DISPLAY_TYPE = 14
  • BrickletEPaper296x128::FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
  • BrickletEPaper296x128::FUNCTION_SET_STATUS_LED_CONFIG = 239
  • BrickletEPaper296x128::FUNCTION_RESET = 243
  • BrickletEPaper296x128::FUNCTION_WRITE_UID = 248
void BrickletEPaper296x128::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:

  • BrickletEPaper296x128::FUNCTION_DRAW = 1
  • BrickletEPaper296x128::FUNCTION_WRITE_BLACK_WHITE = 3
  • BrickletEPaper296x128::FUNCTION_WRITE_COLOR = 5
  • BrickletEPaper296x128::FUNCTION_FILL_DISPLAY = 7
  • BrickletEPaper296x128::FUNCTION_DRAW_TEXT = 8
  • BrickletEPaper296x128::FUNCTION_DRAW_LINE = 9
  • BrickletEPaper296x128::FUNCTION_DRAW_BOX = 10
  • BrickletEPaper296x128::FUNCTION_SET_UPDATE_MODE = 12
  • BrickletEPaper296x128::FUNCTION_SET_DISPLAY_TYPE = 14
  • BrickletEPaper296x128::FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
  • BrickletEPaper296x128::FUNCTION_SET_STATUS_LED_CONFIG = 239
  • BrickletEPaper296x128::FUNCTION_RESET = 243
  • BrickletEPaper296x128::FUNCTION_WRITE_UID = 248
void BrickletEPaper296x128::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.

Constants

int BrickletEPaper296x128::DEVICE_IDENTIFIER

This constant is used to identify a E-Paper 296x128 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 BrickletEPaper296x128::DEVICE_DISPLAY_NAME

This constant represents the human readable name of a E-Paper 296x128 Bricklet.