PHP - OLED 128x64 Bricklet 2.0

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

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

use Tinkerforge\IPConnection;
use Tinkerforge\BrickletOLED128x64V2;

const HOST = 'localhost';
const PORT = 4223;
const UID = 'XYZ'; // Change XYZ to the UID of your OLED 128x64 Bricklet 2.0

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

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

// Clear display
$oled->clearDisplay();

// Write "Hello World" starting from upper left corner of the screen
$oled->writeLine(0, 0, 'Hello World');

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

?>

Pixel Matrix

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

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

use Tinkerforge\IPConnection;
use Tinkerforge\BrickletOLED128x64V2;

const HOST = 'localhost';
const PORT = 4223;
const UID = 'XYZ'; // Change XYZ to the UID of your OLED 128x64 Bricklet
const WIDTH = 128; // Columns
const HEIGHT = 64; // Rows

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

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

// Clear display
$oled->clearDisplay();

// Draw checkerboard pattern
$pixels = array();

for ($y = 0; $y < HEIGHT; $y++)
{
    for ($x = 0; $x < WIDTH; $x++)
    {
        $pixels[$y*WIDTH + $x] = ($y / 8) % 2 == ($x / 8) % 2;
    }
}

$oled->writePixels(0, 0, WIDTH-1, HEIGHT-1, $pixels);

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

?>

Scribble

Download (ExampleScribble.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
63
64
65
66
67
68
69
70
71
72
73
<?php

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

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

use Tinkerforge\IPConnection;
use Tinkerforge\BrickletOLED128x64V2;

const HOST = 'localhost';
const PORT = 4223;
const UID = 'XYZ'; // Change to your UID
const WIDTH = 128; // Columns
const HEIGHT = 64; // Rows

function drawImage($oled, $startColumn, $startRow, $columnCount, $rowCount, $image)
{
    $pixels = array();

    // Convert image pixels into 8bit pages
    for ($row = 0; $row < $rowCount; $row++)
    {
        for ($column = 0; $column < $columnCount; $column++)
        {
            $index = imagecolorat($image, $column, $row);
            $color = imagecolorsforindex($image, $index);
            $pixels[$row*$columnCount + $column] = ($color['red'] + $color['green'] + $color['blue'] > 0);
        }
    }
        
    $oled->writePixels(0, 0, WIDTH-1, HEIGHT-1, $pixels);
}

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

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

// Clear display
$oled->clearDisplay();

// Draw rotating line
$image = imagecreate(WIDTH, HEIGHT);
$black = imagecolorallocate($image, 0, 0, 0);
$white = imagecolorallocate($image, 255, 255, 255);
$originX = WIDTH / 2;
$originY = HEIGHT / 2;
$length = HEIGHT / 2 - 2;
$angle = 0;

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

while (true)
{
    $radians = M_PI * $angle / 180.0;
    $x = (int)($originX + $length * cos($radians));
    $y = (int)($originY + $length * sin($radians));

    imagefilledrectangle($image, 0, 0, WIDTH, HEIGHT, $black);
    imageline($image, $originX, $originY, $x, $y, $white);

    drawImage($oled, 0, 0, WIDTH, HEIGHT, $image);
    usleep(25*1000);

    $angle++;
}

?>

API

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

Basic Functions

class BrickletOLED128x64V2(string $uid, IPConnection $ipcon)

Creates an object with the unique device ID $uid:

<?php   $oled_128x64_v2 = new BrickletOLED128x64V2('YOUR_DEVICE_UID', $ipcon);   ?>

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

void BrickletOLED128x64V2::writePixels(int $x_start, int $y_start, int $x_end, int $y_end, array $pixels)

Writes pixels to the specified window.

The x-axis goes from 0 to 127 and the y-axis from 0 to 63. The pixels are written into the window line by line top to bottom and each line is written from left to right.

If automatic draw is enabled (default) the pixels are directly written to the screen. Only pixels that have actually changed are updated on the screen, the rest stays the same.

If automatic draw is disabled the pixels are written to an internal buffer and the buffer is transferred to the display only after drawBufferedFrame() is called. This can be used to avoid flicker when drawing a complex frame in multiple steps.

Automatic draw can be configured with the setDisplayConfiguration() function.

array BrickletOLED128x64V2::readPixels(int $x_start, int $y_start, int $x_end, int $y_end)

Reads pixels from the specified window.

The x-axis goes from 0 to 127 and the y-axis from 0 to 63. The pixels are read from the window line by line top to bottom and each line is read from left to right.

If automatic draw is enabled (default) the pixels that are read are always the same that are shown on the display.

If automatic draw is disabled the pixels are read from the internal buffer (see drawBufferedFrame()).

Automatic draw can be configured with the setDisplayConfiguration() function.

void BrickletOLED128x64V2::clearDisplay()

Clears the complete content of the display.

void BrickletOLED128x64V2::writeLine(int $line, int $position, string $text)

Writes text to a specific line (0 to 7) with a specific position (0 to 21). The text can have a maximum of 22 characters.

For example: (1, 10, "Hello") will write Hello in the middle of the second line of the display.

The display uses a special 5x7 pixel charset. You can view the characters of the charset in Brick Viewer.

void BrickletOLED128x64V2::drawBufferedFrame(bool $force_complete_redraw)

Draws the currently buffered frame. Normally each call of writePixels() and writeLine() draws directly onto the display. If you turn automatic draw off (setDisplayConfiguration()), the data is written in an internal buffer and only transferred to the display by calling this function. This can be used to avoid flicker when drawing a complex frame in multiple steps.

Set the force complete redraw to true to redraw the whole display instead of only the changed parts. Normally it should not be necessary to set this to true. It may only become necessary in case of stuck pixels because of errors.

Advanced Functions

void BrickletOLED128x64V2::setDisplayConfiguration(int $contrast, bool $invert, bool $automatic_draw)

Sets the configuration of the display.

You can set a contrast value from 0 to 255 and you can invert the color (white/black) of the display.

If automatic draw is set to true, the display is automatically updated with every call of writePixels() or writeLine(). If it is set to false, the changes are written into an internal buffer and only shown on the display after a call of drawBufferedFrame().

The default values are contrast 143, inverting off and automatic draw on.

array BrickletOLED128x64V2::getDisplayConfiguration()

Returns the configuration as set by setDisplayConfiguration().

The returned array has the keys contrast, invert and automatic_draw.

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

  • BrickletOLED128x64V2::FUNCTION_WRITE_PIXELS = 1
  • BrickletOLED128x64V2::FUNCTION_CLEAR_DISPLAY = 3
  • BrickletOLED128x64V2::FUNCTION_SET_DISPLAY_CONFIGURATION = 4
  • BrickletOLED128x64V2::FUNCTION_WRITE_LINE = 6
  • BrickletOLED128x64V2::FUNCTION_DRAW_BUFFERED_FRAME = 7
  • BrickletOLED128x64V2::FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
  • BrickletOLED128x64V2::FUNCTION_SET_STATUS_LED_CONFIG = 239
  • BrickletOLED128x64V2::FUNCTION_RESET = 243
  • BrickletOLED128x64V2::FUNCTION_WRITE_UID = 248
void BrickletOLED128x64V2::setResponseExpectedAll(bool $response_expected)

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

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

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

Returns the current bootloader mode, see setBootloaderMode().

The following constants are available for this function:

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

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

Returns the configuration as set by setStatusLEDConfig()

The following constants are available for this function:

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

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

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

Constants

int BrickletOLED128x64V2::DEVICE_IDENTIFIER

This constant is used to identify a OLED 128x64 Bricklet 2.0.

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

This constant represents the human readable name of a OLED 128x64 Bricklet 2.0.