PHP - LCD 16x2 Bricklet¶

Dies ist die Beschreibung der PHP API Bindings für das LCD 16x2 Bricklet. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des LCD 16x2 Bricklet sind in dessen Hardware Beschreibung zusammengefasst.

Eine Installationanleitung für die PHP API Bindings ist Teil deren allgemeine Beschreibung.

Beispiele¶

Der folgende Beispielcode ist Public Domain (CC0 1.0).

Hello World¶

Download (ExampleHelloWorld.php)

<?php

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

use Tinkerforge\IPConnection;
use Tinkerforge\BrickletLCD16x2;

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

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

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

// Turn backlight on
$lcd->backlightOn();

// Write "Hello World"
$lcd->writeLine(0, 0, 'Hello World');

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

?>

Button Callback¶

Download (ExampleButtonCallback.php)

<?php

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

use Tinkerforge\IPConnection;
use Tinkerforge\BrickletLCD16x2;

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

// Callback function for button pressed callback
function cb_buttonPressed($button)
{
    echo "Button Pressed: $button\n";
}

// Callback function for button released callback
function cb_buttonReleased($button)
{
    echo "Button Released: $button\n";
}

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

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

// Register button pressed callback to function cb_buttonPressed
$lcd->registerCallback(BrickletLCD16x2::CALLBACK_BUTTON_PRESSED, 'cb_buttonPressed');

// Register button released callback to function cb_buttonReleased
$lcd->registerCallback(BrickletLCD16x2::CALLBACK_BUTTON_RELEASED, 'cb_buttonReleased');

echo "Press ctrl+c to exit\n";
$ipcon->dispatchCallbacks(-1); // Dispatch callbacks forever

?>

Unicode¶

Download (ExampleUnicode.php)

<?php

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

use Tinkerforge\IPConnection;
use Tinkerforge\BrickletLCD16x2;

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

// Maps a string to the LCD charset
function autoToKS0066U($string)
{
    $ks0066u = '';
    $utf32le = mb_convert_encoding($string, 'UTF-32LE', 'auto');
    $c = '';

    for ($i = 0; $i < strlen($utf32le); $i += 4) {
        // Combine 4 bytes into 1 code point
        $codePoint = ord($utf32le[$i]) + ord($utf32le[$i + 1]) * 256 + 
                     ord($utf32le[$i + 2]) * 65536 + ord($utf32le[$i + 3]) * 16777216;

        // ASCII subset from JIS X 0201
        if ($codePoint >= 0x0020 && $codePoint <= 0x007e) {
            // The LCD charset doesn't include '\' and '~', use similar characters instead
            switch ($codePoint) {
            case 0x005c: $c = chr(0xa4); break; // REVERSE SOLIDUS maps to IDEOGRAPHIC COMMA
            case 0x007e: $c = chr(0x2d); break; // TILDE maps to HYPHEN-MINUS
            default: $c = chr($codePoint); break;
            }
        }
        // Katakana subset from JIS X 0201
        else if ($codePoint >= 0xff61 && $codePoint <= 0xff9f) {
            $c = chr($codePoint - 0xfec0);
        }
        // Special characters
        else {
            switch ($codePoint) {
            case 0x00a5: $c = chr(0x5c); break; // YEN SIGN
            case 0x2192: $c = chr(0x7e); break; // RIGHTWARDS ARROW
            case 0x2190: $c = chr(0x7f); break; // LEFTWARDS ARROW
            case 0x00b0: $c = chr(0xdf); break; // DEGREE SIGN maps to KATAKANA SEMI-VOICED SOUND MARK
            case 0x03b1: $c = chr(0xe0); break; // GREEK SMALL LETTER ALPHA
            case 0x00c4: $c = chr(0xe1); break; // LATIN CAPITAL LETTER A WITH DIAERESIS
            case 0x00e4: $c = chr(0xe1); break; // LATIN SMALL LETTER A WITH DIAERESIS
            case 0x00df: $c = chr(0xe2); break; // LATIN SMALL LETTER SHARP S
            case 0x03b5: $c = chr(0xe3); break; // GREEK SMALL LETTER EPSILON
            case 0x00b5: $c = chr(0xe4); break; // MICRO SIGN
            case 0x03bc: $c = chr(0xe4); break; // GREEK SMALL LETTER MU
            case 0x03c2: $c = chr(0xe5); break; // GREEK SMALL LETTER FINAL SIGMA
            case 0x03c1: $c = chr(0xe6); break; // GREEK SMALL LETTER RHO
            case 0x221a: $c = chr(0xe8); break; // SQUARE ROOT
            case 0x00b9: $c = chr(0xe9); break; // SUPERSCRIPT ONE maps to SUPERSCRIPT (minus) ONE
            case 0x00a4: $c = chr(0xeb); break; // CURRENCY SIGN
            case 0x00a2: $c = chr(0xec); break; // CENT SIGN
            case 0x2c60: $c = chr(0xed); break; // LATIN CAPITAL LETTER L WITH DOUBLE BAR
            case 0x00f1: $c = chr(0xee); break; // LATIN SMALL LETTER N WITH TILDE
            case 0x00d6: $c = chr(0xef); break; // LATIN CAPITAL LETTER O WITH DIAERESIS
            case 0x00f6: $c = chr(0xef); break; // LATIN SMALL LETTER O WITH DIAERESIS
            case 0x03f4: $c = chr(0xf2); break; // GREEK CAPITAL THETA SYMBOL
            case 0x221e: $c = chr(0xf3); break; // INFINITY
            case 0x03a9: $c = chr(0xf4); break; // GREEK CAPITAL LETTER OMEGA
            case 0x00dc: $c = chr(0xf5); break; // LATIN CAPITAL LETTER U WITH DIAERESIS
            case 0x00fc: $c = chr(0xf5); break; // LATIN SMALL LETTER U WITH DIAERESIS
            case 0x03a3: $c = chr(0xf6); break; // GREEK CAPITAL LETTER SIGMA
            case 0x03c0: $c = chr(0xf7); break; // GREEK SMALL LETTER PI
            case 0x0304: $c = chr(0xf8); break; // COMBINING MACRON
            case 0x00f7: $c = chr(0xfd); break; // DIVISION SIGN

            default:
            case 0x25a0: $c = chr(0xff); break; // BLACK SQUARE
            }
        }

        // Special handling for 'x' followed by COMBINING MACRON
        if ($c == chr(0xf8)) {
            if (strlen($ks0066u) == 0 || substr($ks0066u, strlen($ks0066u) - 1, 1) != 'x') {
                $c = chr(0xff); // BLACK SQUARE
            }

            if (strlen($ks0066u) > 0) {
                $ks0066u = substr($ks0066u, 0, strlen($ks0066u) - 1);
            }
        }

        $ks0066u .= $c;
    }

    return $ks0066u;
}

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

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

// Turn backlight on
$lcd->backlightOn();

// Write a string using the autoToKS0066U function to map to the LCD charset
$lcd->writeLine(0, 0, autoToKS0066U("Stromstärke: 5µA"));

// Write a string directly including characters from the LCD charset
$lcd->writeLine(1, 0, "Drehzahl: 1000s\xe9");

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

?>

API¶

Funktion die mehrere Werte zurückgeben geben diese in einem assoziativen Array zurück.

Grundfunktionen¶

class BrickletLCD16x2(string $uid, IPConnection $ipcon)¶

Parameter:	$uid – Typ: string $ipcon – Typ: IPConnection
Rückgabe:	$lcd_16x2 – Typ: BrickletLCD16x2

Erzeugt ein Objekt mit der eindeutigen Geräte ID $uid:

<?php   $lcd_16x2 = new BrickletLCD16x2('YOUR_DEVICE_UID', $ipcon);   ?>

Dieses Objekt kann benutzt werden, nachdem die IP Connection verbunden ist.

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

Parameter:	$line – Typ: int, Wertebereich: [0 bis 1] $position – Typ: int, Wertebereich: [0 bis 15] $text – Typ: string, Länge: bis zu 16

Schreibt einen Text in die angegebene Zeile mit einer vorgegebenen Position. Der Text kann maximal 16 Zeichen lang sein.

Beispiel: (0, 5, "Hallo") schreibt Hallo in die Mitte der ersten Zeile des Display.

Das Display nutzt einen speziellen Zeichensatz der alle ASCII Zeichen beinhaltet außer Backslash und Tilde. Der Zeichensatz des LCD beinhaltet weiterhin einige Nicht-ASCII Zeichen, siehe die Zeichensatzspezifikation für Details. Das gezeigte Unicode Beispiel verdeutlicht die Verwendung von Nicht-ASCII Zeichen und wie die Wandlung von Unicode in den LCD Zeichensatz möglich ist.

void BrickletLCD16x2::clearDisplay()¶: Löscht alle Zeichen auf dem Display.

void BrickletLCD16x2::backlightOn()¶: Aktiviert die Hintergrundbeleuchtung.

void BrickletLCD16x2::backlightOff()¶: Deaktiviert die Hintergrundbeleuchtung.

bool BrickletLCD16x2::isBacklightOn()¶

Rückgabe:	$backlight – Typ: bool

Gibt true zurück wenn die Hintergrundbeleuchtung aktiv ist, sonst false.

Fortgeschrittene Funktionen¶

void BrickletLCD16x2::setConfig(bool $cursor, bool $blinking)¶

Parameter:	$cursor – Typ: bool, Standardwert: FALSE $blinking – Typ: bool, Standardwert: FALSE

Konfiguriert ob der Cursor (angezeigt als "_") sichtbar ist und ob er blinkt (angezeigt als blinkender Block). Die Cursor Position ist ein Zeichen hinter dem zuletzt mit writeLine() geschriebenen Text.

array BrickletLCD16x2::getConfig()¶

Rückgabe-Array:	'cursor' – Typ: bool, Standardwert: FALSE 'blinking' – Typ: bool, Standardwert: FALSE

Gibt die Konfiguration zurück, wie von setConfig() gesetzt.

bool BrickletLCD16x2::isButtonPressed(int $button)¶

Parameter:	$button – Typ: int, Wertebereich: [0 bis 2]
Rückgabe:	$pressed – Typ: bool

Gibt true zurück wenn die Taste gedrückt ist.

Wenn auf Tastendrücken und -loslassen reagiert werden soll, wird empfohlen die CALLBACK_BUTTON_PRESSED und CALLBACK_BUTTON_RELEASED Callbacks zu nutzen.

void BrickletLCD16x2::setCustomCharacter(int $index, array $character)¶

Parameter:	$index – Typ: int, Wertebereich: [0 bis 7] $character – Typ: array(int, ...), Länge: 8, Wertebereich: [0 bis 31]

Das LCD 16x2 Bricklet kann bis zu 8 benutzerdefinierte Buchstaben speichern. Die Buchstaben bestehen aus 5x8 Pixel und sie können über den Index 0-7 adressiert werden. Um die Pixel zu beschreiben, werden die ersten 5 Bit von 8 Bytes verwenden. Zum Beispiel, um den Buchstaben "H" zu erzeugen, sollte das folgende Array gesendet werden:

character[0] = 0b00010001 (Dezimalwert 17)
character[1] = 0b00010001 (Dezimalwert 17)
character[2] = 0b00010001 (Dezimalwert 17)
character[3] = 0b00011111 (Dezimalwert 31)
character[4] = 0b00010001 (Dezimalwert 17)
character[5] = 0b00010001 (Dezimalwert 17)
character[6] = 0b00010001 (Dezimalwert 17)
character[7] = 0b00000000 (Dezimalwert 0)

Die Buchstaben können später mit writeLine() mit den chars mit den Byterepräsentationen 8 ("\x08" oder "\u0008") bis 15 ("\x0F" oder "\u000F") geschrieben werden.

Es ist möglich die benutzerdefinierten Buchstaben im Brick Viewer ab Version 2.0.1 einzustellen.

Benutzerdefinierte Buchstaben werden vom LCD im RAM gespeichert, daher müssen sie nach jedem Start des LCD 16x2 Bricklets gesetzt werden.

Added in version 2.0.1$nbsp;(Plugin).

array BrickletLCD16x2::getCustomCharacter(int $index)¶

Parameter:	$index – Typ: int, Wertebereich: [0 bis 7]
Rückgabe:	$character – Typ: array(int, ...), Länge: 8, Wertebereich: [0 bis 31]

Gibt den benutzerdefinierten Buchstaben für den gegebenen Index zurück, wie von getCustomCharacter() gesetzt.

Added in version 2.0.1$nbsp;(Plugin).

array BrickletLCD16x2::getIdentity()¶

Rückgabe-Array:

Rückgabe-Array:	'uid' – Typ: string, Länge: bis zu 8 'connected_uid' – Typ: string, Länge: bis zu 8 'position' – Typ: string, Wertebereich: ['a' bis 'h', 'z'] 'hardware_version' – Typ: array(int, ...), Länge: 3 0: $major – Typ: int, Wertebereich: [0 bis 255] 1: $minor – Typ: int, Wertebereich: [0 bis 255] 2: $revision – Typ: int, Wertebereich: [0 bis 255] 'firmware_version' – Typ: array(int, ...), Länge: 3 0: $major – Typ: int, Wertebereich: [0 bis 255] 1: $minor – Typ: int, Wertebereich: [0 bis 255] 2: $revision – Typ: int, Wertebereich: [0 bis 255] 'device_identifier' – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1]

'uid' – Typ: string, Länge: bis zu 8
'connected_uid' – Typ: string, Länge: bis zu 8
'position' – Typ: string, Wertebereich: ['a' bis 'h', 'z']
'hardware_version' – Typ: array(int, ...), Länge: 3

0: $major – Typ: int, Wertebereich: [0 bis 255]
1: $minor – Typ: int, Wertebereich: [0 bis 255]
2: $revision – Typ: int, Wertebereich: [0 bis 255]

'firmware_version' – Typ: array(int, ...), Länge: 3

0: $major – Typ: int, Wertebereich: [0 bis 255]
1: $minor – Typ: int, Wertebereich: [0 bis 255]
2: $revision – Typ: int, Wertebereich: [0 bis 255]

'device_identifier' – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1]

Gibt die UID, die UID zu der das Bricklet verbunden ist, die Position, die Hard- und Firmware Version sowie den Device Identifier zurück.

Die Position ist 'a', 'b', 'c', 'd', 'e', 'f', 'g' oder 'h' (Bricklet Anschluss). Ein Bricklet hinter einem Isolator Bricklet ist immer an Position 'z'.

Eine Liste der Device Identifier Werte ist hier zu finden. Es gibt auch eine Konstante für den Device Identifier dieses Bricklets.

Konfigurationsfunktionen für Callbacks¶

void BrickletLCD16x2::registerCallback(int $callback_id, callable $callback, mixed $user_data=NULL)¶

Parameter:	$callback_id – Typ: int $callback – Typ: callable $user_data – Typ: mixed

Registriert die $function für die gegebene $callback_id. Die optionalen $user_data werden der Funktion als letztes Parameter mit übergeben.

Die verfügbaren Callback IDs mit den zugehörigen Funktionssignaturen sind unten zu finden.

Callbacks¶

Callbacks können registriert werden um zeitkritische oder wiederkehrende Daten vom Gerät zu erhalten. Die Registrierung kann mit der Funktion registerCallback() des Geräte Objektes durchgeführt werden. Der erste Parameter ist der Callback ID und der zweite die Callback-Funktion:

<?php

function myCallback($param)
{
    echo $param . "\n";
}

$lcd_16x2->registerCallback(BrickletLCD16x2::CALLBACK_EXAMPLE, 'myCallback');

?>

Die verfügbaren IDs mit den dazugehörigen Funktionssignaturen werden weiter unten beschrieben.

Bemerkung

Callbacks für wiederkehrende Ereignisse zu verwenden ist immer zu bevorzugen gegenüber der Verwendung von Abfragen. Es wird weniger USB-Bandbreite benutzt und die Latenz ist erheblich geringer, da es keine Paketumlaufzeit gibt.

int BrickletLCD16x2::CALLBACK_BUTTON_PRESSED¶

<?php   void callback(int $button [, mixed $user_data])   ?>

Callback-Parameter:	$button – Typ: int, Wertebereich: [0 bis 2] $user_data – Typ: mixed

Dieser Callback wird ausgelöst, wenn eine Taste gedrückt wird. Der Parameter ist die Nummer der Taste.

int BrickletLCD16x2::CALLBACK_BUTTON_RELEASED¶

<?php   void callback(int $button [, mixed $user_data])   ?>

Callback-Parameter:	$button – Typ: int, Wertebereich: [0 bis 2] $user_data – Typ: mixed

Dieser Callback wird ausgelöst, wenn eine Taste losgelassen wird. Der Parameter ist die Nummer der Taste.

Virtuelle Funktionen¶

Virtuelle Funktionen kommunizieren nicht mit dem Gerät selbst, sie arbeiten nur auf dem API Bindings Objekt. Dadurch können sie auch aufgerufen werden, ohne das das dazugehörige IP Connection Objekt verbunden ist.

array BrickletLCD16x2::getAPIVersion()¶

Rückgabe-Array:	$api_version – Typ: array(int, ...), Länge: 3 0: $major – Typ: int, Wertebereich: [0 bis 255] 1: $minor – Typ: int, Wertebereich: [0 bis 255] 2: $revision – Typ: int, Wertebereich: [0 bis 255]

Gibt die Version der API Definition zurück, die diese API Bindings implementieren. Dies ist weder die Release-Version dieser API Bindings noch gibt es in irgendeiner Weise Auskunft über den oder das repräsentierte(n) Brick oder Bricklet.

bool BrickletLCD16x2::getResponseExpected(int $function_id)¶

Parameter:	$function_id – Typ: int, Wertebereich: Siehe Konstanten
Rückgabe:	$response_expected – Typ: bool

Gibt das Response-Expected-Flag für die Funktion mit der angegebenen Funktions IDs zurück. Es ist true falls für die Funktion beim Aufruf eine Antwort erwartet wird, false andernfalls.

Für Getter-Funktionen ist diese Flag immer gesetzt und kann nicht entfernt werden, da diese Funktionen immer eine Antwort senden. Für Konfigurationsfunktionen für Callbacks ist es standardmäßig gesetzt, kann aber entfernt werden mittels setResponseExpected(). Für Setter-Funktionen ist es standardmäßig nicht gesetzt, kann aber gesetzt werden.

Wenn das Response-Expected-Flag für eine Setter-Funktion gesetzt ist, können Timeouts und andere Fehlerfälle auch für Aufrufe dieser Setter-Funktion detektiert werden. Das Gerät sendet dann eine Antwort extra für diesen Zweck. Wenn das Flag für eine Setter-Funktion nicht gesetzt ist, dann wird keine Antwort vom Gerät gesendet und Fehler werden stillschweigend ignoriert, da sie nicht detektiert werden können.

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für $function_id:

BrickletLCD16x2::FUNCTION_WRITE_LINE = 1
BrickletLCD16x2::FUNCTION_CLEAR_DISPLAY = 2
BrickletLCD16x2::FUNCTION_BACKLIGHT_ON = 3
BrickletLCD16x2::FUNCTION_BACKLIGHT_OFF = 4
BrickletLCD16x2::FUNCTION_SET_CONFIG = 6
BrickletLCD16x2::FUNCTION_SET_CUSTOM_CHARACTER = 11

void BrickletLCD16x2::setResponseExpected(int $function_id, bool $response_expected)¶

Parameter:	$function_id – Typ: int, Wertebereich: Siehe Konstanten $response_expected – Typ: bool

Ändert das Response-Expected-Flag für die Funktion mit der angegebenen Funktion IDs. Diese Flag kann nur für Setter-Funktionen (Standardwert: false) und Konfigurationsfunktionen für Callbacks (Standardwert: true) geändert werden. Für Getter-Funktionen ist das Flag immer gesetzt.

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für $function_id:

BrickletLCD16x2::FUNCTION_WRITE_LINE = 1
BrickletLCD16x2::FUNCTION_CLEAR_DISPLAY = 2
BrickletLCD16x2::FUNCTION_BACKLIGHT_ON = 3
BrickletLCD16x2::FUNCTION_BACKLIGHT_OFF = 4
BrickletLCD16x2::FUNCTION_SET_CONFIG = 6
BrickletLCD16x2::FUNCTION_SET_CUSTOM_CHARACTER = 11

void BrickletLCD16x2::setResponseExpectedAll(bool $response_expected)¶

Parameter:	$response_expected – Typ: bool

Ändert das Response-Expected-Flag für alle Setter-Funktionen und Konfigurationsfunktionen für Callbacks diese Gerätes.

Konstanten¶

int BrickletLCD16x2::DEVICE_IDENTIFIER¶

Diese Konstante wird verwendet um ein LCD 16x2 Bricklet zu identifizieren.

Die getIdentity() Funktion und der IPConnection::CALLBACK_ENUMERATE Callback der IP Connection haben ein deviceIdentifier Parameter um den Typ des Bricks oder Bricklets anzugeben.

string BrickletLCD16x2::DEVICE_DISPLAY_NAME¶: Diese Konstante stellt den Anzeigenamen eines LCD 16x2 Bricklet dar.