PHP - Color Bricklet 2.0

Dies ist die Beschreibung der PHP API Bindings für das Color Bricklet 2.0. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des Color 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
27
28
29
30
31
<?php

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

use Tinkerforge\IPConnection;
use Tinkerforge\BrickletColorV2;

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

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

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

// Get current color
$color = $c->getColor();

echo "Color [R]: " . $color['r'] . "\n";
echo "Color [G]: " . $color['g'] . "\n";
echo "Color [B]: " . $color['b'] . "\n";
echo "Color [C]: " . $color['c'] . "\n";

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

?>

Callback

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

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

use Tinkerforge\IPConnection;
use Tinkerforge\BrickletColorV2;

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

// Callback function for color callback
function cb_color($r, $g, $b, $c)
{
    echo "Color [R]: $r\n";
    echo "Color [G]: $g\n";
    echo "Color [B]: $b\n";
    echo "Color [C]: $c\n";
    echo "\n";
}

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

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

// Register color callback to function cb_color
$c->registerCallback(BrickletColorV2::CALLBACK_COLOR, 'cb_color');

// Set period for color callback to 0.1s (100ms)
$c->setColorCallbackConfiguration(100, FALSE);

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

?>

API

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

Grundfunktionen

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

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

<?php   $color_v2 = new BrickletColorV2('YOUR_DEVICE_UID', $ipcon);   ?>

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

array BrickletColorV2::getColor()
Rückgabe-Array:
  • 'r' – Typ: int, Wertebereich: [0 bis 216 - 1]
  • 'g' – Typ: int, Wertebereich: [0 bis 216 - 1]
  • 'b' – Typ: int, Wertebereich: [0 bis 216 - 1]
  • 'c' – Typ: int, Wertebereich: [0 bis 216 - 1]

Gibt die gemessene Farbe des Sensors zurück. Der Wertebereich ist von 0 bis 65535.

Die rot (r), grün (g), blau (b) und clear (c) Farbanteile werden mit vier unterschiedlichen Fotodioden gemessen. Diese sind Empfindlich in unterschiedlichen Wellenlängen:

Chart Responsivity / Wavelength

Wenn die Farbe periodisch abgefragt werden soll, wird empfohlen den CALLBACK_COLOR Callback zu nutzen und die Periode mit setColorCallbackConfiguration() vorzugeben.

int BrickletColorV2::getIlluminance()
Rückgabe:
  • $illuminance – Typ: int, Wertebereich: [0 bis 232 - 1]

Gibt die Beleuchtungsstärke beeinflusst durch die Verstärkung und die Integrationszeit zurück. Verstärkung und Integrationszeit können mit setConfiguration() eingestellt werden. Um die Beleuchtungsstärke in Lux zu ermitteln, muss folgende Formel angewendet werden:

lux = illuminance * 700 / gain / integration_time

Für eine korrekte Messung der Beleuchtungsstärke muss sichergestellt sein, dass die Farbwerte (R, G oder B) nicht saturiert sind. Ein Farbwert ist saturiert, wenn der Wert 65535 beträgt. In diesem Fall kann die Verstärkung per setConfiguration() reduziert werden.

Wenn der Wert periodisch benötigt wird, kann auch der CALLBACK_ILLUMINANCE Callback verwendet werden. Der Callback wird mit der Funktion setIlluminanceCallbackConfiguration() konfiguriert.

int BrickletColorV2::getColorTemperature()
Rückgabe:
  • $color_temperature – Typ: int, Wertebereich: [0 bis 216 - 1]

Gibt die Farbtemperatur in Kelvin zurück.

Für eine korrekte Messung der Farbtemperatur muss sichergestellt sein, dass die Farbwerte (R, G oder B) nicht saturiert sind. Ein Farbwert ist saturiert, wenn der Wert 65535 beträgt. In diesem Fall kann die Verstärkung per setConfiguration() reduziert werden.

Wenn der Wert periodisch benötigt wird, kann auch der CALLBACK_COLOR_TEMPERATURE Callback verwendet werden. Der Callback wird mit der Funktion setColorTemperatureCallbackConfiguration() konfiguriert.

void BrickletColorV2::setLight(bool $enable)
Parameter:
  • $enable – Typ: bool

Aktiviert/deaktiviert die weiße LED auf dem Bricklet.

bool BrickletColorV2::getLight()
Rückgabe:
  • $enable – Typ: bool

Gibt den Wert zurück, wie von setLight() gesetzt.

void BrickletColorV2::setConfiguration(int $gain, int $integration_time)
Parameter:
  • $gain – Typ: int, Wertebereich: Siehe Konstanten
  • $integration_time – Typ: int, Wertebereich: Siehe Konstanten

Setzt die Konfiguration des Sensors. Verstärkung und Integrationszeit können eingestellt werden.

Für die Konfiguration der Verstärkung:

  • 0: 1x Gain
  • 1: 4x Gain
  • 2: 16x Gain
  • 3: 60x Gain

Für die Konfiguration der Integrationszeit:

  • 0: 2,4ms
  • 1: 24ms
  • 2: 101ms
  • 3: 154ms
  • 4: 700ms

Eine Erhöhung der Verstärkung ermöglicht es dem Sensor, Farben aus größeren Entfernungen zu erkennen.

Die Integrationszeit ist ein Trade-off zwischen Konvertierungszeit und Genauigkeit. Mit einer höheren Integrationszeit werden die Werte genauer, es dauert allerdings länger, bis ein Resultat bereitsteht.

Die Standardwerte sind 60x Verstärkung und 154ms Integrationszeit.

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

Für $gain:

  • BrickletColorV2::GAIN_1X = 0
  • BrickletColorV2::GAIN_4X = 1
  • BrickletColorV2::GAIN_16X = 2
  • BrickletColorV2::GAIN_60X = 3

Für $integration_time:

  • BrickletColorV2::INTEGRATION_TIME_2MS = 0
  • BrickletColorV2::INTEGRATION_TIME_24MS = 1
  • BrickletColorV2::INTEGRATION_TIME_101MS = 2
  • BrickletColorV2::INTEGRATION_TIME_154MS = 3
  • BrickletColorV2::INTEGRATION_TIME_700MS = 4
array BrickletColorV2::getConfiguration()
Rückgabe-Array:
  • 'gain' – Typ: int, Wertebereich: Siehe Konstanten
  • 'integration_time' – Typ: int, Wertebereich: Siehe Konstanten

Gibt die Einstellungen zurück, wie von setConfiguration() gesetzt.

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

Für $gain:

  • BrickletColorV2::GAIN_1X = 0
  • BrickletColorV2::GAIN_4X = 1
  • BrickletColorV2::GAIN_16X = 2
  • BrickletColorV2::GAIN_60X = 3

Für $integration_time:

  • BrickletColorV2::INTEGRATION_TIME_2MS = 0
  • BrickletColorV2::INTEGRATION_TIME_24MS = 1
  • BrickletColorV2::INTEGRATION_TIME_101MS = 2
  • BrickletColorV2::INTEGRATION_TIME_154MS = 3
  • BrickletColorV2::INTEGRATION_TIME_700MS = 4

Fortgeschrittene Funktionen

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

  • BrickletColorV2::FUNCTION_SET_COLOR_CALLBACK_CONFIGURATION = 2
  • BrickletColorV2::FUNCTION_SET_ILLUMINANCE_CALLBACK_CONFIGURATION = 6
  • BrickletColorV2::FUNCTION_SET_COLOR_TEMPERATURE_CALLBACK_CONFIGURATION = 10
  • BrickletColorV2::FUNCTION_SET_LIGHT = 13
  • BrickletColorV2::FUNCTION_SET_CONFIGURATION = 15
  • BrickletColorV2::FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
  • BrickletColorV2::FUNCTION_SET_STATUS_LED_CONFIG = 239
  • BrickletColorV2::FUNCTION_RESET = 243
  • BrickletColorV2::FUNCTION_WRITE_UID = 248
void BrickletColorV2::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:

  • BrickletColorV2::FUNCTION_SET_COLOR_CALLBACK_CONFIGURATION = 2
  • BrickletColorV2::FUNCTION_SET_ILLUMINANCE_CALLBACK_CONFIGURATION = 6
  • BrickletColorV2::FUNCTION_SET_COLOR_TEMPERATURE_CALLBACK_CONFIGURATION = 10
  • BrickletColorV2::FUNCTION_SET_LIGHT = 13
  • BrickletColorV2::FUNCTION_SET_CONFIGURATION = 15
  • BrickletColorV2::FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
  • BrickletColorV2::FUNCTION_SET_STATUS_LED_CONFIG = 239
  • BrickletColorV2::FUNCTION_RESET = 243
  • BrickletColorV2::FUNCTION_WRITE_UID = 248
void BrickletColorV2::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 BrickletColorV2::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 BrickletColorV2::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:

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

Für $status:

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

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

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

  • BrickletColorV2::STATUS_LED_CONFIG_OFF = 0
  • BrickletColorV2::STATUS_LED_CONFIG_ON = 1
  • BrickletColorV2::STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • BrickletColorV2::STATUS_LED_CONFIG_SHOW_STATUS = 3
int BrickletColorV2::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 BrickletColorV2::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 BrickletColorV2::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 BrickletColorV2::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 BrickletColorV2::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.

Konfigurationsfunktionen für Callbacks

void BrickletColorV2::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.

void BrickletColorV2::setColorCallbackConfiguration(int $period, bool $value_has_to_change)
Parameter:
  • $period – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0
  • $value_has_to_change – Typ: bool, Standardwert: FALSE

Die Periode ist die Periode mit der der CALLBACK_COLOR Callback ausgelöst wird. Ein Wert von 0 schaltet den Callback ab.

Wenn der value has to change-Parameter auf True gesetzt wird, wird der Callback nur ausgelöst, wenn der Wert sich im Vergleich zum letzten mal geändert hat. Ändert der Wert sich nicht innerhalb der Periode, so wird der Callback sofort ausgelöst, wenn der Wert sich das nächste mal ändert.

Wird der Parameter auf False gesetzt, so wird der Callback dauerhaft mit der festen Periode ausgelöst unabhängig von den Änderungen des Werts.

array BrickletColorV2::getColorCallbackConfiguration()
Rückgabe-Array:
  • 'period' – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0
  • 'value_has_to_change' – Typ: bool, Standardwert: FALSE

Gibt die Callback-Konfiguration zurück, wie mittels setColorCallbackConfiguration() gesetzt.

void BrickletColorV2::setIlluminanceCallbackConfiguration(int $period, bool $value_has_to_change, string $option, int $min, int $max)
Parameter:
  • $period – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0
  • $value_has_to_change – Typ: bool, Standardwert: FALSE
  • $option – Typ: string, Wertebereich: Siehe Konstanten, Standardwert: 'x'
  • $min – Typ: int, Wertebereich: [0 bis 232 - 1]
  • $max – Typ: int, Wertebereich: [0 bis 232 - 1]

Die Periode ist die Periode mit der der CALLBACK_ILLUMINANCE Callback ausgelöst wird. Ein Wert von 0 schaltet den Callback ab.

Wenn der value has to change-Parameter auf True gesetzt wird, wird der Callback nur ausgelöst, wenn der Wert sich im Vergleich zum letzten mal geändert hat. Ändert der Wert sich nicht innerhalb der Periode, so wird der Callback sofort ausgelöst, wenn der Wert sich das nächste mal ändert.

Wird der Parameter auf False gesetzt, so wird der Callback dauerhaft mit der festen Periode ausgelöst unabhängig von den Änderungen des Werts.

Desweiteren ist es möglich den Callback mittels Thresholds einzuschränken.

Der option-Parameter zusammen mit min/max setzt einen Threshold für den CALLBACK_ILLUMINANCE Callback.

Die folgenden Optionen sind möglich:

Option Beschreibung
'x' Threshold ist abgeschaltet
'o' Threshold wird ausgelöst, wenn der Wert außerhalb der Min und Max Werte sind
'i' Threshold wird ausgelöst, wenn der Wert innerhalb der Min und Max Werte sind
'<' Threshold wird ausgelöst, wenn der Wert kleiner ist wie der Min Wert (Max wird ignoriert)
'>' Threshold wird ausgelöst, wenn der Wert größer ist wie der Max Wert (Min wird ignoriert)

Wird die Option auf 'x' gesetzt (Threshold abgeschaltet), so wird der Callback mit der festen Periode ausgelöst.

Der Standardwert ist (0, false, 'x', 0, 0).

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

Für $option:

  • BrickletColorV2::THRESHOLD_OPTION_OFF = 'x'
  • BrickletColorV2::THRESHOLD_OPTION_OUTSIDE = 'o'
  • BrickletColorV2::THRESHOLD_OPTION_INSIDE = 'i'
  • BrickletColorV2::THRESHOLD_OPTION_SMALLER = '<'
  • BrickletColorV2::THRESHOLD_OPTION_GREATER = '>'
array BrickletColorV2::getIlluminanceCallbackConfiguration()
Rückgabe-Array:
  • 'period' – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0
  • 'value_has_to_change' – Typ: bool, Standardwert: FALSE
  • 'option' – Typ: string, Wertebereich: Siehe Konstanten, Standardwert: 'x'
  • 'min' – Typ: int, Wertebereich: [0 bis 232 - 1]
  • 'max' – Typ: int, Wertebereich: [0 bis 232 - 1]

Gibt die Callback-Konfiguration zurück, wie mittels setIlluminanceCallbackConfiguration() gesetzt.

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

Für $option:

  • BrickletColorV2::THRESHOLD_OPTION_OFF = 'x'
  • BrickletColorV2::THRESHOLD_OPTION_OUTSIDE = 'o'
  • BrickletColorV2::THRESHOLD_OPTION_INSIDE = 'i'
  • BrickletColorV2::THRESHOLD_OPTION_SMALLER = '<'
  • BrickletColorV2::THRESHOLD_OPTION_GREATER = '>'
void BrickletColorV2::setColorTemperatureCallbackConfiguration(int $period, bool $value_has_to_change, string $option, int $min, int $max)
Parameter:
  • $period – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0
  • $value_has_to_change – Typ: bool, Standardwert: FALSE
  • $option – Typ: string, Wertebereich: Siehe Konstanten, Standardwert: 'x'
  • $min – Typ: int, Wertebereich: [0 bis 216 - 1]
  • $max – Typ: int, Wertebereich: [0 bis 216 - 1]

Die Periode ist die Periode mit der der CALLBACK_COLOR_TEMPERATURE Callback ausgelöst wird. Ein Wert von 0 schaltet den Callback ab.

Wenn der value has to change-Parameter auf True gesetzt wird, wird der Callback nur ausgelöst, wenn der Wert sich im Vergleich zum letzten mal geändert hat. Ändert der Wert sich nicht innerhalb der Periode, so wird der Callback sofort ausgelöst, wenn der Wert sich das nächste mal ändert.

Wird der Parameter auf False gesetzt, so wird der Callback dauerhaft mit der festen Periode ausgelöst unabhängig von den Änderungen des Werts.

Desweiteren ist es möglich den Callback mittels Thresholds einzuschränken.

Der option-Parameter zusammen mit min/max setzt einen Threshold für den CALLBACK_COLOR_TEMPERATURE Callback.

Die folgenden Optionen sind möglich:

Option Beschreibung
'x' Threshold ist abgeschaltet
'o' Threshold wird ausgelöst, wenn der Wert außerhalb der Min und Max Werte sind
'i' Threshold wird ausgelöst, wenn der Wert innerhalb der Min und Max Werte sind
'<' Threshold wird ausgelöst, wenn der Wert kleiner ist wie der Min Wert (Max wird ignoriert)
'>' Threshold wird ausgelöst, wenn der Wert größer ist wie der Max Wert (Min wird ignoriert)

Wird die Option auf 'x' gesetzt (Threshold abgeschaltet), so wird der Callback mit der festen Periode ausgelöst.

Der Standardwert ist (0, false, 'x', 0, 0).

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

Für $option:

  • BrickletColorV2::THRESHOLD_OPTION_OFF = 'x'
  • BrickletColorV2::THRESHOLD_OPTION_OUTSIDE = 'o'
  • BrickletColorV2::THRESHOLD_OPTION_INSIDE = 'i'
  • BrickletColorV2::THRESHOLD_OPTION_SMALLER = '<'
  • BrickletColorV2::THRESHOLD_OPTION_GREATER = '>'
array BrickletColorV2::getColorTemperatureCallbackConfiguration()
Rückgabe-Array:
  • 'period' – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0
  • 'value_has_to_change' – Typ: bool, Standardwert: FALSE
  • 'option' – Typ: string, Wertebereich: Siehe Konstanten, Standardwert: 'x'
  • 'min' – Typ: int, Wertebereich: [0 bis 216 - 1]
  • 'max' – Typ: int, Wertebereich: [0 bis 216 - 1]

Gibt die Callback-Konfiguration zurück, wie mittels setColorTemperatureCallbackConfiguration() gesetzt.

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

Für $option:

  • BrickletColorV2::THRESHOLD_OPTION_OFF = 'x'
  • BrickletColorV2::THRESHOLD_OPTION_OUTSIDE = 'o'
  • BrickletColorV2::THRESHOLD_OPTION_INSIDE = 'i'
  • BrickletColorV2::THRESHOLD_OPTION_SMALLER = '<'
  • BrickletColorV2::THRESHOLD_OPTION_GREATER = '>'

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";
}

$color_v2->registerCallback(BrickletColorV2::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 BrickletColorV2::CALLBACK_COLOR
<?php   void callback(int $r, int $g, int $b, int $c [, mixed $user_data])   ?>
Callback-Parameter:
  • $r – Typ: int, Wertebereich: [0 bis 216 - 1]
  • $g – Typ: int, Wertebereich: [0 bis 216 - 1]
  • $b – Typ: int, Wertebereich: [0 bis 216 - 1]
  • $c – Typ: int, Wertebereich: [0 bis 216 - 1]
  • $user_data – Typ: mixed

Dieser Callback wird mit der Periode, wie gesetzt mit setColorCallbackConfiguration(), ausgelöst. Der Parameter ist die Farbe des Sensors als RGBC.

Der CALLBACK_COLOR Callback wird nur ausgelöst, wenn sich die Farbe seit der letzten Auslösung geändert hat.

int BrickletColorV2::CALLBACK_ILLUMINANCE
<?php   void callback(int $illuminance [, mixed $user_data])   ?>
Callback-Parameter:
  • $illuminance – Typ: int, Wertebereich: [0 bis 232 - 1]
  • $user_data – Typ: mixed

Dieser Callback wird periodisch ausgelöst abhängig von der mittels setIlluminanceCallbackConfiguration() gesetzten Konfiguration

Der Parameter ist der gleiche wie getIlluminance().

int BrickletColorV2::CALLBACK_COLOR_TEMPERATURE
<?php   void callback(int $color_temperature [, mixed $user_data])   ?>
Callback-Parameter:
  • $color_temperature – Typ: int, Wertebereich: [0 bis 216 - 1]
  • $user_data – Typ: mixed

Dieser Callback wird periodisch ausgelöst abhängig von der mittels setColorTemperatureCallbackConfiguration() gesetzten Konfiguration

Der Parameter ist der gleiche wie getColorTemperature().

Konstanten

int BrickletColorV2::DEVICE_IDENTIFIER

Diese Konstante wird verwendet um ein Color 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 BrickletColorV2::DEVICE_DISPLAY_NAME

Diese Konstante stellt den Anzeigenamen eines Color Bricklet 2.0 dar.