PHP - RGB LED Bricklet 2.0

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

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
<?php

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

use Tinkerforge\IPConnection;
use Tinkerforge\BrickletRGBLEDV2;

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

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

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

// Set light blue color
$rl->setRGBValue(0, 170, 234);

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 BrickletRGBLEDV2(string $uid, IPConnection $ipcon)
Parameter:
  • $uid – Typ: string
  • $ipcon – Typ: IPConnection
Rückgabe:
  • $rgb_led_v2 – Typ: BrickletRGBLEDV2

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

<?php   $rgb_led_v2 = new BrickletRGBLEDV2('YOUR_DEVICE_UID', $ipcon);   ?>

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

void BrickletRGBLEDV2::setRGBValue(int $r, int $g, int $b)
Parameter:
  • $r – Typ: int, Wertebereich: [0 bis 255]
  • $g – Typ: int, Wertebereich: [0 bis 255]
  • $b – Typ: int, Wertebereich: [0 bis 255]

Setzt die r, g und b Werte für die LED. Jeder Wert kann zwischen 0 und 255 liegen.

array BrickletRGBLEDV2::getRGBValue()
Rückgabe-Array:
  • 'r' – Typ: int, Wertebereich: [0 bis 255]
  • 'g' – Typ: int, Wertebereich: [0 bis 255]
  • 'b' – Typ: int, Wertebereich: [0 bis 255]

Gibt die r, g und b Werte der LED zurück, wie von setRGBValue() gesetzt.

Fortgeschrittene Funktionen

array BrickletRGBLEDV2::getAPIVersion()
Rückgabe:
  • $api_version – Typ: array(int, ...), Länge: 3, Wertebereich: [0 bis 255]

Gibt die Version der API Definition (Major, Minor, Revision) 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 BrickletRGBLEDV2::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:

  • BrickletRGBLEDV2::FUNCTION_SET_RGB_VALUE = 1
  • BrickletRGBLEDV2::FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
  • BrickletRGBLEDV2::FUNCTION_SET_STATUS_LED_CONFIG = 239
  • BrickletRGBLEDV2::FUNCTION_RESET = 243
  • BrickletRGBLEDV2::FUNCTION_WRITE_UID = 248
void BrickletRGBLEDV2::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:

  • BrickletRGBLEDV2::FUNCTION_SET_RGB_VALUE = 1
  • BrickletRGBLEDV2::FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
  • BrickletRGBLEDV2::FUNCTION_SET_STATUS_LED_CONFIG = 239
  • BrickletRGBLEDV2::FUNCTION_RESET = 243
  • BrickletRGBLEDV2::FUNCTION_WRITE_UID = 248
void BrickletRGBLEDV2::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.

array BrickletRGBLEDV2::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 BrickletRGBLEDV2::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 Bootlodaer- 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:

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

Für $status:

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

  • BrickletRGBLEDV2::BOOTLOADER_MODE_BOOTLOADER = 0
  • BrickletRGBLEDV2::BOOTLOADER_MODE_FIRMWARE = 1
  • BrickletRGBLEDV2::BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
  • BrickletRGBLEDV2::BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
  • BrickletRGBLEDV2::BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4
void BrickletRGBLEDV2::setWriteFirmwarePointer(int $pointer)
Parameter:
  • $pointer – Typ: int, 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 BrickletRGBLEDV2::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 BrickletRGBLEDV2::setStatusLEDConfig(int $config)
Parameter:
  • $config – Typ: int, Wertebereich: Siehe Konstanten

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:

  • BrickletRGBLEDV2::STATUS_LED_CONFIG_OFF = 0
  • BrickletRGBLEDV2::STATUS_LED_CONFIG_ON = 1
  • BrickletRGBLEDV2::STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • BrickletRGBLEDV2::STATUS_LED_CONFIG_SHOW_STATUS = 3
int BrickletRGBLEDV2::getStatusLEDConfig()
Rückgabe:
  • $config – Typ: int, Wertebereich: Siehe Konstanten

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

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

Für $config:

  • BrickletRGBLEDV2::STATUS_LED_CONFIG_OFF = 0
  • BrickletRGBLEDV2::STATUS_LED_CONFIG_ON = 1
  • BrickletRGBLEDV2::STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • BrickletRGBLEDV2::STATUS_LED_CONFIG_SHOW_STATUS = 3
int BrickletRGBLEDV2::getChipTemperature()
Rückgabe:
  • $temperature – Typ: int, Wertebereich: [-215 bis 215 - 1]

Gibt die Temperatur in °C, 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 BrickletRGBLEDV2::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 BrickletRGBLEDV2::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 BrickletRGBLEDV2::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 BrickletRGBLEDV2::getIdentity()
Rückgabe-Array:
  • 'uid' – Typ: string, Länge: bis zu 8
  • 'connected_uid' – Typ: string, Länge: bis zu 8
  • 'position' – Typ: string
  • 'hardware_version' – Typ: array(int, ...), Länge: 3, Wertebereich: [0 bis 255]
  • 'firmware_version' – Typ: array(int, ...), Länge: 3, 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 kann 'a', 'b', 'c' oder 'd' sein.

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

Konstanten

int BrickletRGBLEDV2::DEVICE_IDENTIFIER

Diese Konstante wird verwendet um ein RGB LED Bricklet 2.0 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 BrickletRGBLEDV2::DEVICE_DISPLAY_NAME

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