PHP - RGB LED Matrix Bricklet

Dies ist die Beschreibung der PHP API Bindings für das RGB LED Matrix Bricklet. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des RGB LED Matrix 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).

API

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

Grundfunktionen

class BrickletRGBLEDMatrix(string $uid, IPConnection $ipcon)
Parameter:
  • $uid – Typ: string
  • $ipcon – Typ: IPConnection
Rückgabe:
  • $rgb_led_matrix – Typ: BrickletRGBLEDMatrix

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

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

Dieses Objekt kann benutzt werden, nachdem die IP Connection verbunden ist (siehe Beispiele oben).

void BrickletRGBLEDMatrix::setRed(array $red)
Parameter:
  • $red – Typ: array(int, ...), Länge: 64, Wertebereich: [0 bis 255]

Setzt die Werte der 64 roten LEDs der Matrix.

array BrickletRGBLEDMatrix::getRed()
Rückgabe:
  • $red – Typ: array(int, ...), Länge: 64, Wertebereich: [0 bis 255], Standardwert: array(0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0)

Gibt die Werte der roten LED zurück, wie von setRed() gesetzt.

void BrickletRGBLEDMatrix::setGreen(array $green)
Parameter:
  • $green – Typ: array(int, ...), Länge: 64, Wertebereich: [0 bis 255], Standardwert: array(0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0)

Setzt die Werte der 64 grünen LEDs der Matrix.

array BrickletRGBLEDMatrix::getGreen()
Rückgabe:
  • $green – Typ: array(int, ...), Länge: 64, Wertebereich: [0 bis 255], Standardwert: array(0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0)

Gibt die Werte der grünen LED zurück, wie von setGreen() gesetzt.

void BrickletRGBLEDMatrix::setBlue(array $blue)
Parameter:
  • $blue – Typ: array(int, ...), Länge: 64, Wertebereich: [0 bis 255], Standardwert: array(0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0)

Setzt die Werte der 64 blauen LEDs der Matrix.

array BrickletRGBLEDMatrix::getBlue()
Rückgabe:
  • $blue – Typ: array(int, ...), Länge: 64, Wertebereich: [0 bis 255], Standardwert: array(0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0)

Gibt die Werte der blauen LED zurück, wie von setBlue() gesetzt.

void BrickletRGBLEDMatrix::setFrameDuration(int $frame_duration)
Parameter:
  • $frame_duration – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 216 - 1], Standardwert: 0

Setzt die Frame Duration (Dauer des Frames).

Beispiel: Wenn 20 Frames pro Sekunde erreicht werden sollen, muss die Länge des Frames auf 50ms gesetzt werden (50ms * 20 = 1 Sekunde).

Setze diesen Wert auf 0 um das automatische schreiben der Frames auszustellen.

Vorgehensweise:

Für eine Frame Duration von 0 siehe drawFrame().

int BrickletRGBLEDMatrix::getFrameDuration()
Rückgabe:
  • $frame_duration – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 216 - 1], Standardwert: 0

Gibt die Frame Duration (Dauer des Frames) zurück, wie von setFrameDuration() gesetzt.

void BrickletRGBLEDMatrix::drawFrame()

Wenn die Frame Duration (Dauer des Frames) auf 0 gesetzt ist (siehe setFrameDuration()), dann kann diese Funktionen aufgerufen werden um den Frame auf die Matrix zu übertragen.

Vorgehensweise:

Fortgeschrittene Funktionen

int BrickletRGBLEDMatrix::getSupplyVoltage()
Rückgabe:
  • $voltage – Typ: int, Einheit: 1 mV, Wertebereich: [0 bis 216 - 1]

Gibt die aktuelle Versorgungsspannung des Bricklets zurück.

array BrickletRGBLEDMatrix::getSPITFPErrorCount()
Rückgabe-Array:
  • 'error_count_ack_checksum' – Typ: int, Wertebereich: [0 bis 232 - 1]
  • 'error_count_message_checksum' – Typ: int, Wertebereich: [0 bis 232 - 1]
  • 'error_count_frame' – Typ: int, Wertebereich: [0 bis 232 - 1]
  • 'error_count_overflow' – Typ: int, Wertebereich: [0 bis 232 - 1]

Gibt die Anzahl der Fehler die während der Kommunikation zwischen Brick und Bricklet aufgetreten sind zurück.

Die Fehler sind aufgeteilt in

  • ACK-Checksummen Fehler,
  • Message-Checksummen Fehler,
  • Framing Fehler und
  • Overflow Fehler.

Die Fehlerzähler sind für Fehler die auf der Seite des Bricklets auftreten. Jedes Brick hat eine ähnliche Funktion welche die Fehler auf Brickseite ausgibt.

int BrickletRGBLEDMatrix::setBootloaderMode(int $mode)
Parameter:
  • $mode – Typ: int, Wertebereich: Siehe Konstanten
Rückgabe:
  • $status – Typ: int, Wertebereich: Siehe Konstanten

Setzt den Bootloader-Modus und gibt den Status zurück nachdem die Modusänderungsanfrage bearbeitet wurde.

Mit dieser Funktion ist es möglich vom Bootloader- in den Firmware-Modus zu wechseln und umgekehrt. Ein Welchsel vom Bootloader- in der den Firmware-Modus ist nur möglich wenn Entry-Funktion, Device Identifier und CRC vorhanden und korrekt sind.

Diese Funktion wird vom Brick Viewer während des Flashens benutzt. In einem normalem Nutzerprogramm sollte diese Funktion nicht benötigt werden.

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

Für $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

Für $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()
Rückgabe:
  • $mode – Typ: int, Wertebereich: Siehe Konstanten

Gibt den aktuellen Bootloader-Modus zurück, siehe setBootloaderMode().

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

Für $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)
Parameter:
  • $pointer – Typ: int, Einheit: 1 B, Wertebereich: [0 bis 232 - 1]

Setzt den Firmware-Pointer für writeFirmware(). Der Pointer muss um je 64 Byte erhöht werden. Die Daten werden alle 4 Datenblöcke in den Flash geschrieben (4 Datenblöcke entsprechen einer Page mit 256 Byte).

Diese Funktion wird vom Brick Viewer während des flashens benutzt. In einem normalem Nutzerprogramm sollte diese Funktion nicht benötigt werden.

int BrickletRGBLEDMatrix::writeFirmware(array $data)
Parameter:
  • $data – Typ: array(int, ...), Länge: 64, Wertebereich: [0 bis 255]
Rückgabe:
  • $status – Typ: int, Wertebereich: [0 bis 255]

Schreibt 64 Bytes Firmware an die Position die vorher von setWriteFirmwarePointer() gesetzt wurde. Die Firmware wird alle 4 Datenblöcke in den Flash geschrieben.

Eine Firmware kann nur im Bootloader-Mode geschrieben werden.

Diese Funktion wird vom Brick Viewer während des flashens benutzt. In einem normalem Nutzerprogramm sollte diese Funktion nicht benötigt werden.

void BrickletRGBLEDMatrix::setStatusLEDConfig(int $config)
Parameter:
  • $config – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 3

Setzt die Konfiguration der Status-LED. Standardmäßig zeigt die LED die Kommunikationsdatenmenge an. Sie blinkt einmal auf pro 10 empfangenen Datenpaketen zwischen Brick und Bricklet.

Die LED kann auch permanent an/aus gestellt werden oder einen Herzschlag anzeigen.

Wenn das Bricklet sich im Bootlodermodus befindet ist die LED aus.

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

Für $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()
Rückgabe:
  • $config – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 3

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

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

Für $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()
Rückgabe:
  • $temperature – Typ: int, Einheit: 1 °C, Wertebereich: [-215 bis 215 - 1]

Gibt die Temperatur, gemessen im Mikrocontroller, aus. Der Rückgabewert ist nicht die Umgebungstemperatur.

Die Temperatur ist lediglich proportional zur echten Temperatur und hat eine hohe Ungenauigkeit. Daher beschränkt sich der praktische Nutzen auf die Indikation von Temperaturveränderungen.

void BrickletRGBLEDMatrix::reset()

Ein Aufruf dieser Funktion setzt das Bricklet zurück. Nach einem Neustart sind alle Konfiguration verloren.

Nach dem Zurücksetzen ist es notwendig neue Objekte zu erzeugen, Funktionsaufrufe auf bestehenden führen zu undefiniertem Verhalten.

void BrickletRGBLEDMatrix::writeUID(int $uid)
Parameter:
  • $uid – Typ: int, Wertebereich: [0 bis 232 - 1]

Schreibt eine neue UID in den Flash. Die UID muss zuerst vom Base58 encodierten String in einen Integer decodiert werden.

Wir empfehlen die Nutzung des Brick Viewers zum ändern der UID.

int BrickletRGBLEDMatrix::readUID()
Rückgabe:
  • $uid – Typ: int, Wertebereich: [0 bis 232 - 1]

Gibt die aktuelle UID als Integer zurück. Dieser Integer kann als Base58 encodiert werden um an den üblichen UID-String zu gelangen.

array BrickletRGBLEDMatrix::getIdentity()
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', 'i', '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 216 - 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 'a', 'b', 'c', 'd', 'e', 'f', 'g' oder 'h' (Bricklet Anschluss) sein. Der Raspberry Pi HAT (Zero) Brick ist immer an Position 'i' und das 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 BrickletRGBLEDMatrix::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";
}

$rgb_led_matrix->registerCallback(BrickletRGBLEDMatrix::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 BrickletRGBLEDMatrix::CALLBACK_FRAME_STARTED
<?php   void callback(int $frame_number [, mixed $user_data])   ?>
Callback-Parameter:
  • $frame_number – Typ: int, Wertebereich: [0 bis 232 - 1]
  • $user_data – Typ: mixed

Dieser Callback wird aufgerufen sobald die Übertragung des Frames auf die Matrix beginnt. Die LED Werte werden in einem Doublebuffer gespeichert, so dass der nächste Frame an das Bricklet übertragen werden kann sobald dieser Callback ausgelöst wird.

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

  • 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)
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.

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:

  • 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)
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 BrickletRGBLEDMatrix::DEVICE_IDENTIFIER

Diese Konstante wird verwendet um ein RGB LED Matrix 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 BrickletRGBLEDMatrix::DEVICE_DISPLAY_NAME

Diese Konstante stellt den Anzeigenamen eines RGB LED Matrix Bricklet dar.