PHP - UV Light Bricklet

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

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

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

use Tinkerforge\IPConnection;
use Tinkerforge\BrickletUVLight;

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

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

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

// Get current UV light
$uv_light = $uvl->getUVLight();
echo "UV Light: " . $uv_light/10.0 . " mW/m²\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
<?php

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

use Tinkerforge\IPConnection;
use Tinkerforge\BrickletUVLight;

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

// Callback function for UV light callback
function cb_uvLight($uv_light)
{
    echo "UV Light: " . $uv_light/10.0 . " mW/m²\n";
}

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

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

// Register UV light callback to function cb_uvLight
$uvl->registerCallback(BrickletUVLight::CALLBACK_UV_LIGHT, 'cb_uvLight');

// Set period for UV light callback to 1s (1000ms)
// Note: The UV light callback is only called every second
//       if the UV light has changed since the last call!
$uvl->setUVLightCallbackPeriod(1000);

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

?>

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

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

use Tinkerforge\IPConnection;
use Tinkerforge\BrickletUVLight;

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

// Callback function for UV light reached callback
function cb_uvLightReached($uv_light)
{
    echo "UV Light: " . $uv_light/10.0 . " mW/m²\n";
    echo "UV Index > 3. Use sunscreen!\n";
}

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

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

// Get threshold callbacks with a debounce time of 10 seconds (10000ms)
$uvl->setDebouncePeriod(10000);

// Register UV light reached callback to function cb_uvLightReached
$uvl->registerCallback(BrickletUVLight::CALLBACK_UV_LIGHT_REACHED, 'cb_uvLightReached');

// Configure threshold for UV light "greater than 75 mW/m²"
$uvl->setUVLightCallbackThreshold('>', 75*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 BrickletUVLight(string $uid, IPConnection $ipcon)
Parameter:
  • $uid – Typ: string
  • $ipcon – Typ: IPConnection
Rückgabe:
  • $uv_light – Typ: BrickletUVLight

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

<?php   $uv_light = new BrickletUVLight('YOUR_DEVICE_UID', $ipcon);   ?>

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

int BrickletUVLight::getUVLight()
Rückgabe:
  • $uv_light – Typ: int, Einheit: 1/10 mW/m², Wertebereich: [0 bis 32800000]

Gibt die UV-Licht-Intensität des Sensors zurück. Der Sensor hat die Intensität bereits mit dem Erythem-Wirkungsspektrum gewichtet, um die hautbeeinflussende Bestrahlungsstärke zu bestimmen.

Die Intensität kann dann einfach durch 250 geteilt werden um den UV Index zu bestimmen. Beispiel: Eine UV-Licht-Intensität von 500 entspricht einem UV Index von 2.

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

Fortgeschrittene Funktionen

array BrickletUVLight::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 '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 BrickletUVLight::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 BrickletUVLight::setUVLightCallbackPeriod(int $period)
Parameter:
  • $period – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0

Setzt die Periode mit welcher der CALLBACK_UV_LIGHT Callback ausgelöst wird. Ein Wert von 0 deaktiviert den Callback.

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

int BrickletUVLight::getUVLightCallbackPeriod()
Rückgabe:
  • $period – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0

Gibt die Periode zurück, wie von setUVLightCallbackPeriod() gesetzt.

void BrickletUVLight::setUVLightCallbackThreshold(string $option, int $min, int $max)
Parameter:
  • $option – Typ: string, Wertebereich: Siehe Konstanten, Standardwert: 'x'
  • $min – Typ: int, Einheit: 1/10 mW/m², Wertebereich: [0 bis 232 - 1], Standardwert: 0
  • $max – Typ: int, Einheit: 1/10 mW/m², Wertebereich: [0 bis 232 - 1], Standardwert: 0

Setzt den Schwellwert für den CALLBACK_UV_LIGHT_REACHED Callback.

Die folgenden Optionen sind möglich:

Option Beschreibung
'x' Callback ist inaktiv
'o' Callback wird ausgelöst, wenn die Intensität außerhalb des min und max Wertes ist
'i' Callback wird ausgelöst, wenn die Intensität innerhalb des min und max Wertes ist
'<' Callback wird ausgelöst, wenn die Intensität kleiner als der min Wert ist (max wird ignoriert)
'>' Callback wird ausgelöst, wenn die Intensität größer als der min Wert ist (max wird ignoriert)

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

Für $option:

  • BrickletUVLight::THRESHOLD_OPTION_OFF = 'x'
  • BrickletUVLight::THRESHOLD_OPTION_OUTSIDE = 'o'
  • BrickletUVLight::THRESHOLD_OPTION_INSIDE = 'i'
  • BrickletUVLight::THRESHOLD_OPTION_SMALLER = '<'
  • BrickletUVLight::THRESHOLD_OPTION_GREATER = '>'
array BrickletUVLight::getUVLightCallbackThreshold()
Rückgabe-Array:
  • 'option' – Typ: string, Wertebereich: Siehe Konstanten, Standardwert: 'x'
  • 'min' – Typ: int, Einheit: 1/10 mW/m², Wertebereich: [0 bis 232 - 1], Standardwert: 0
  • 'max' – Typ: int, Einheit: 1/10 mW/m², Wertebereich: [0 bis 232 - 1], Standardwert: 0

Gibt den Schwellwert zurück, wie von setUVLightCallbackThreshold() gesetzt.

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

Für $option:

  • BrickletUVLight::THRESHOLD_OPTION_OFF = 'x'
  • BrickletUVLight::THRESHOLD_OPTION_OUTSIDE = 'o'
  • BrickletUVLight::THRESHOLD_OPTION_INSIDE = 'i'
  • BrickletUVLight::THRESHOLD_OPTION_SMALLER = '<'
  • BrickletUVLight::THRESHOLD_OPTION_GREATER = '>'
void BrickletUVLight::setDebouncePeriod(int $debounce)
Parameter:
  • $debounce – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 100

Setzt die Periode mit welcher die Schwellwert Callbacks

ausgelöst werden, wenn die Schwellwerte

weiterhin erreicht bleiben.

int BrickletUVLight::getDebouncePeriod()
Rückgabe:
  • $debounce – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 100

Gibt die Entprellperiode zurück, wie von setDebouncePeriod() gesetzt.

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->registerCallback(BrickletUVLight::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 BrickletUVLight::CALLBACK_UV_LIGHT
<?php   void callback(int $uv_light [, mixed $user_data])   ?>
Callback-Parameter:
  • $uv_light – Typ: int, Einheit: 1/10 mW/m², Wertebereich: [0 bis 32800000]
  • $user_data – Typ: mixed

Dieser Callback wird mit der Periode, wie gesetzt mit setUVLightCallbackPeriod(), ausgelöst. Der Parameter ist die UV-Licht-Intensität des Sensors.

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

int BrickletUVLight::CALLBACK_UV_LIGHT_REACHED
<?php   void callback(int $uv_light [, mixed $user_data])   ?>
Callback-Parameter:
  • $uv_light – Typ: int, Einheit: 1/10 mW/m², Wertebereich: [0 bis 32800000]
  • $user_data – Typ: mixed

Dieser Callback wird ausgelöst, wenn der Schwellwert, wie von setUVLightCallbackThreshold() gesetzt, erreicht wird. Der Parameter ist die UV-Licht-Intensität des Sensors.

Wenn der Schwellwert erreicht bleibt, wird der Callback mit der Periode, wie mit setDebouncePeriod() gesetzt, ausgelöst.

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

  • BrickletUVLight::FUNCTION_SET_UV_LIGHT_CALLBACK_PERIOD = 2
  • BrickletUVLight::FUNCTION_SET_UV_LIGHT_CALLBACK_THRESHOLD = 4
  • BrickletUVLight::FUNCTION_SET_DEBOUNCE_PERIOD = 6
void BrickletUVLight::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:

  • BrickletUVLight::FUNCTION_SET_UV_LIGHT_CALLBACK_PERIOD = 2
  • BrickletUVLight::FUNCTION_SET_UV_LIGHT_CALLBACK_THRESHOLD = 4
  • BrickletUVLight::FUNCTION_SET_DEBOUNCE_PERIOD = 6
void BrickletUVLight::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 BrickletUVLight::DEVICE_IDENTIFIER

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

Diese Konstante stellt den Anzeigenamen eines UV Light Bricklet dar.