PHP - UV Light Bricklet 2.0

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

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

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

use Tinkerforge\IPConnection;
use Tinkerforge\BrickletUVLightV2;

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

// Callback function for UV index callback
function cb_uvi($uvi)
{
    echo "UV Index: " . $uvi/10.0 . "\n";
}

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

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

// Register UV index callback to function cb_uvi
$uvl->registerCallback(BrickletUVLightV2::CALLBACK_UVI, 'cb_uvi');

// Set period for UVI callback to 1s (1000ms) without a threshold
$uvl->setUVICallbackConfiguration(1000, FALSE, 'x', 0, 0);

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

?>

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
32
33
34
35
<?php

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

use Tinkerforge\IPConnection;
use Tinkerforge\BrickletUVLightV2;

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

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

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

// Get current UV-A
$uva = $uvl->getUVA();
echo "UV-A: " . $uva/10.0 . " mW/m²\n";

// Get current UV-B
$uvb = $uvl->getUVB();
echo "UV-B: " . $uvb/10.0 . " mW/m²\n";

// Get current UV index
$uvi = $uvl->getUVI();
echo "UV Index: " . $uvi/10.0 . "\n";

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

?>

Threshold

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

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

use Tinkerforge\IPConnection;
use Tinkerforge\BrickletUVLightV2;

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

// Callback function for UV index callback
function cb_uvi($uvi)
{
    echo "UV Index: " . $uvi/10.0 . "\n";
    echo "UV index > 3. Use sunscreen!\n";
}

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

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

// Register UV index callback to function cb_uvi
$uvl->registerCallback(BrickletUVLightV2::CALLBACK_UVI, 'cb_uvi');

// Configure threshold for UV index "greater than 3"
// with a debounce period of 1s (1000ms)
$uvl->setUVICallbackConfiguration(1000, FALSE, '>', 3*10, 0);

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

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

<?php   $uv_light_v2 = new BrickletUVLightV2('YOUR_DEVICE_UID', $ipcon);   ?>

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

int BrickletUVLightV2::getUVA()
Rückgabe:
  • $uva – Typ: int, Wertebereich: [-231 bis 231 - 1]

Gibt die UVA Intensität des Sensors zurück. Die Intensität wird in der Einheit 1/10 mW/m² gegeben. Der Sensor hat die Intensität nicht mit dem Erythem-Wirkungsspektrum gewichtet, daher handelt es sich nicht um die hautbeeinflussende Bestrahlungsstärke. Der Wert kann nicht einfach durch 250 geteilt werden, um den UVA Index zu bestimmen. Um den UV Index zu bestimmen kann getUVI() verwendet werden.

Falls der Sensor gesättigt (saturated) ist, dann wird -1 zurückgegeben, siehe setConfiguration().

Wenn die Intensität periodisch abgefragt werden soll, wird empfohlen den CALLBACK_UVA Callback zu nutzen und die Periode mit setUVACallbackConfiguration() vorzugeben.

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

int BrickletUVLightV2::getUVB()
Rückgabe:
  • $uvb – Typ: int, Wertebereich: [-231 bis 231 - 1]

Gibt die UVB Intensität des Sensors zurück. Die Intensität wird in der Einheit 1/10 mW/m² gegeben. Der Sensor hat die Intensität nicht mit dem Erythem-Wirkungsspektrum gewichtet, daher handelt es sich nicht um die hautbeeinflussende Bestrahlungsstärke. Der Wert kann nicht einfach durch 250 geteilt werde, um den UVB Index zu bestimmen. Um den UV Index zu bestimmen kann getUVI() verwendet werden.

Falls der Sensor gesättigt (saturated) ist, dann wird -1 zurückgegeben, siehe setConfiguration().

Wenn die Intensität periodisch abgefragt werden soll, wird empfohlen den CALLBACK_UVB Callback zu nutzen und die Periode mit setUVBCallbackConfiguration() vorzugeben.

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

int BrickletUVLightV2::getUVI()
Rückgabe:
  • $uvi – Typ: int, Wertebereich: [-231 bis 231 - 1]

Gibt den UV Index des Sensors in 1/10 zurück.

Falls der Sensor gesättigt (saturated) ist, dann wird -1 zurückgegeben, siehe setConfiguration().

Wenn die Intensität periodisch abgefragt werden soll, wird empfohlen den CALLBACK_UVI Callback zu nutzen und die Periode mit setUVICallbackConfiguration() vorzugeben.

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

Fortgeschrittene Funktionen

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

Setzt die Konfiguration des Sensors. Die Integrationszeit kann zwischen 50 und 800 ms eingestellt werden. Mit einer kürzeren Integrationszeit wird der Sensorwert öfter aktualisiert, beinhaltet aber mehr Rauschen. Mit einer längeren Integrationszeit wird das Rauschen verringert aber der Sensorwert wird nicht so oft aktualisiert.

Mit einer längeren Integrationszeit (ins besondere 800 ms) und einer höheren UV Intensität kann der Sensor gesättigt (saturated) sein. Falls dies auftritt dann sind die UVA/UVB/UVI Messwerte alle -1. In diesem Fall muss eine kürzere Integrationszeit gewählt werden.

Standardwert: 400 ms.

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

Für $integration_time:

  • BrickletUVLightV2::INTEGRATION_TIME_50MS = 0
  • BrickletUVLightV2::INTEGRATION_TIME_100MS = 1
  • BrickletUVLightV2::INTEGRATION_TIME_200MS = 2
  • BrickletUVLightV2::INTEGRATION_TIME_400MS = 3
  • BrickletUVLightV2::INTEGRATION_TIME_800MS = 4
int BrickletUVLightV2::getConfiguration()
Rückgabe:
  • $integration_time – Typ: int, Wertebereich: Siehe Konstanten

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

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

Für $integration_time:

  • BrickletUVLightV2::INTEGRATION_TIME_50MS = 0
  • BrickletUVLightV2::INTEGRATION_TIME_100MS = 1
  • BrickletUVLightV2::INTEGRATION_TIME_200MS = 2
  • BrickletUVLightV2::INTEGRATION_TIME_400MS = 3
  • BrickletUVLightV2::INTEGRATION_TIME_800MS = 4
array BrickletUVLightV2::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 BrickletUVLightV2::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:

  • BrickletUVLightV2::FUNCTION_SET_UVA_CALLBACK_CONFIGURATION = 2
  • BrickletUVLightV2::FUNCTION_SET_UVB_CALLBACK_CONFIGURATION = 6
  • BrickletUVLightV2::FUNCTION_SET_UVI_CALLBACK_CONFIGURATION = 10
  • BrickletUVLightV2::FUNCTION_SET_CONFIGURATION = 13
  • BrickletUVLightV2::FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
  • BrickletUVLightV2::FUNCTION_SET_STATUS_LED_CONFIG = 239
  • BrickletUVLightV2::FUNCTION_RESET = 243
  • BrickletUVLightV2::FUNCTION_WRITE_UID = 248
void BrickletUVLightV2::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:

  • BrickletUVLightV2::FUNCTION_SET_UVA_CALLBACK_CONFIGURATION = 2
  • BrickletUVLightV2::FUNCTION_SET_UVB_CALLBACK_CONFIGURATION = 6
  • BrickletUVLightV2::FUNCTION_SET_UVI_CALLBACK_CONFIGURATION = 10
  • BrickletUVLightV2::FUNCTION_SET_CONFIGURATION = 13
  • BrickletUVLightV2::FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
  • BrickletUVLightV2::FUNCTION_SET_STATUS_LED_CONFIG = 239
  • BrickletUVLightV2::FUNCTION_RESET = 243
  • BrickletUVLightV2::FUNCTION_WRITE_UID = 248
void BrickletUVLightV2::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 BrickletUVLightV2::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 BrickletUVLightV2::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:

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

Für $status:

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

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

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

  • BrickletUVLightV2::STATUS_LED_CONFIG_OFF = 0
  • BrickletUVLightV2::STATUS_LED_CONFIG_ON = 1
  • BrickletUVLightV2::STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • BrickletUVLightV2::STATUS_LED_CONFIG_SHOW_STATUS = 3
int BrickletUVLightV2::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 BrickletUVLightV2::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 BrickletUVLightV2::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 BrickletUVLightV2::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 BrickletUVLightV2::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 BrickletUVLightV2::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 BrickletUVLightV2::setUVACallbackConfiguration(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: [-231 bis 231 - 1]
  • $max – Typ: int, Wertebereich: [-231 bis 231 - 1]

Die Periode ist die Periode mit der der CALLBACK_UVA 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_UVA 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:

  • BrickletUVLightV2::THRESHOLD_OPTION_OFF = 'x'
  • BrickletUVLightV2::THRESHOLD_OPTION_OUTSIDE = 'o'
  • BrickletUVLightV2::THRESHOLD_OPTION_INSIDE = 'i'
  • BrickletUVLightV2::THRESHOLD_OPTION_SMALLER = '<'
  • BrickletUVLightV2::THRESHOLD_OPTION_GREATER = '>'
array BrickletUVLightV2::getUVACallbackConfiguration()
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: [-231 bis 231 - 1]
  • 'max' – Typ: int, Wertebereich: [-231 bis 231 - 1]

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

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

Für $option:

  • BrickletUVLightV2::THRESHOLD_OPTION_OFF = 'x'
  • BrickletUVLightV2::THRESHOLD_OPTION_OUTSIDE = 'o'
  • BrickletUVLightV2::THRESHOLD_OPTION_INSIDE = 'i'
  • BrickletUVLightV2::THRESHOLD_OPTION_SMALLER = '<'
  • BrickletUVLightV2::THRESHOLD_OPTION_GREATER = '>'
void BrickletUVLightV2::setUVBCallbackConfiguration(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: [-231 bis 231 - 1]
  • $max – Typ: int, Wertebereich: [-231 bis 231 - 1]

Die Periode ist die Periode mit der der CALLBACK_UVB 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_UVB 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:

  • BrickletUVLightV2::THRESHOLD_OPTION_OFF = 'x'
  • BrickletUVLightV2::THRESHOLD_OPTION_OUTSIDE = 'o'
  • BrickletUVLightV2::THRESHOLD_OPTION_INSIDE = 'i'
  • BrickletUVLightV2::THRESHOLD_OPTION_SMALLER = '<'
  • BrickletUVLightV2::THRESHOLD_OPTION_GREATER = '>'
array BrickletUVLightV2::getUVBCallbackConfiguration()
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: [-231 bis 231 - 1]
  • 'max' – Typ: int, Wertebereich: [-231 bis 231 - 1]

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

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

Für $option:

  • BrickletUVLightV2::THRESHOLD_OPTION_OFF = 'x'
  • BrickletUVLightV2::THRESHOLD_OPTION_OUTSIDE = 'o'
  • BrickletUVLightV2::THRESHOLD_OPTION_INSIDE = 'i'
  • BrickletUVLightV2::THRESHOLD_OPTION_SMALLER = '<'
  • BrickletUVLightV2::THRESHOLD_OPTION_GREATER = '>'
void BrickletUVLightV2::setUVICallbackConfiguration(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: [-231 bis 231 - 1]
  • $max – Typ: int, Wertebereich: [-231 bis 231 - 1]

Die Periode ist die Periode mit der der CALLBACK_UVI 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_UVI 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:

  • BrickletUVLightV2::THRESHOLD_OPTION_OFF = 'x'
  • BrickletUVLightV2::THRESHOLD_OPTION_OUTSIDE = 'o'
  • BrickletUVLightV2::THRESHOLD_OPTION_INSIDE = 'i'
  • BrickletUVLightV2::THRESHOLD_OPTION_SMALLER = '<'
  • BrickletUVLightV2::THRESHOLD_OPTION_GREATER = '>'
array BrickletUVLightV2::getUVICallbackConfiguration()
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: [-231 bis 231 - 1]
  • 'max' – Typ: int, Wertebereich: [-231 bis 231 - 1]

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

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

Für $option:

  • BrickletUVLightV2::THRESHOLD_OPTION_OFF = 'x'
  • BrickletUVLightV2::THRESHOLD_OPTION_OUTSIDE = 'o'
  • BrickletUVLightV2::THRESHOLD_OPTION_INSIDE = 'i'
  • BrickletUVLightV2::THRESHOLD_OPTION_SMALLER = '<'
  • BrickletUVLightV2::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";
}

$uv_light_v2->registerCallback(BrickletUVLightV2::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 BrickletUVLightV2::CALLBACK_UVA
<?php   void callback(int $uva [, mixed $user_data])   ?>
Callback-Parameter:
  • $uva – Typ: int, Wertebereich: [-231 bis 231 - 1]
  • $user_data – Typ: mixed

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

Der Parameter ist der gleiche wie getUVA().

int BrickletUVLightV2::CALLBACK_UVB
<?php   void callback(int $uvb [, mixed $user_data])   ?>
Callback-Parameter:
  • $uvb – Typ: int, Wertebereich: [-231 bis 231 - 1]
  • $user_data – Typ: mixed

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

Der Parameter ist der gleiche wie getUVB().

int BrickletUVLightV2::CALLBACK_UVI
<?php   void callback(int $uvi [, mixed $user_data])   ?>
Callback-Parameter:
  • $uvi – Typ: int, Wertebereich: [-231 bis 231 - 1]
  • $user_data – Typ: mixed

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

Der Parameter ist der gleiche wie getUVI().

Konstanten

int BrickletUVLightV2::DEVICE_IDENTIFIER

Diese Konstante wird verwendet um ein UV Light 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 BrickletUVLightV2::DEVICE_DISPLAY_NAME

Diese Konstante stellt den Anzeigenamen eines UV Light Bricklet 2.0 dar.