Dies ist die Beschreibung der PHP API Bindings für das Temperature IR Bricklet. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des Temperature IR Bricklet sind in dessen Hardware Beschreibung zusammengefasst.
Eine Installationanleitung für die PHP API Bindings ist Teil deren allgemeine Beschreibung.
Der folgende Beispielcode ist Public Domain (CC0 1.0).
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/BrickletTemperatureIR.php');
use Tinkerforge\IPConnection;
use Tinkerforge\BrickletTemperatureIR;
const HOST = 'localhost';
const PORT = 4223;
const UID = 'XYZ'; // Change XYZ to the UID of your Temperature IR Bricklet
$ipcon = new IPConnection(); // Create IP connection
$tir = new BrickletTemperatureIR(UID, $ipcon); // Create device object
$ipcon->connect(HOST, PORT); // Connect to brickd
// Don't use device before ipcon is connected
// Get current ambient temperature
$ambient_temperature = $tir->getAmbientTemperature();
echo "Ambient Temperature: " . $ambient_temperature/10.0 . " °C\n";
// Get current object temperature
$object_temperature = $tir->getObjectTemperature();
echo "Object Temperature: " . $object_temperature/10.0 . " °C\n";
echo "Press key to exit\n";
fgetc(fopen('php://stdin', 'r'));
$ipcon->disconnect();
?>
|
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 | <?php
require_once('Tinkerforge/IPConnection.php');
require_once('Tinkerforge/BrickletTemperatureIR.php');
use Tinkerforge\IPConnection;
use Tinkerforge\BrickletTemperatureIR;
const HOST = 'localhost';
const PORT = 4223;
const UID = 'XYZ'; // Change XYZ to the UID of your Temperature IR Bricklet
// Callback function for object temperature callback
function cb_objectTemperature($temperature)
{
echo "Object Temperature: " . $temperature/10.0 . " °C\n";
}
$ipcon = new IPConnection(); // Create IP connection
$tir = new BrickletTemperatureIR(UID, $ipcon); // Create device object
$ipcon->connect(HOST, PORT); // Connect to brickd
// Don't use device before ipcon is connected
// Register object temperature callback to function cb_objectTemperature
$tir->registerCallback(BrickletTemperatureIR::CALLBACK_OBJECT_TEMPERATURE,
'cb_objectTemperature');
// Set period for object temperature callback to 1s (1000ms)
// Note: The object temperature callback is only called every second
// if the object temperature has changed since the last call!
$tir->setObjectTemperatureCallbackPeriod(1000);
echo "Press ctrl+c to exit\n";
$ipcon->dispatchCallbacks(-1); // Dispatch callbacks forever
?>
|
Download (ExampleWaterBoiling.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 39 40 41 42 | <?php
require_once('Tinkerforge/IPConnection.php');
require_once('Tinkerforge/BrickletTemperatureIR.php');
use Tinkerforge\IPConnection;
use Tinkerforge\BrickletTemperatureIR;
const HOST = 'localhost';
const PORT = 4223;
const UID = 'XYZ'; // Change XYZ to the UID of your Temperature IR Bricklet
// Callback function for object temperature reached callback
function cb_objectTemperatureReached($temperature)
{
echo "Object Temperature: " . $temperature/10.0 . " °C\n";
echo "The water is boiling!\n";
}
$ipcon = new IPConnection(); // Create IP connection
$tir = new BrickletTemperatureIR(UID, $ipcon); // Create device object
$ipcon->connect(HOST, PORT); // Connect to brickd
// Don't use device before ipcon is connected
// Set emissivity to 0.98 (emissivity of water, 65535 * 0.98 = 64224.299)
$tir->setEmissivity(64224);
// Get threshold callbacks with a debounce time of 10 seconds (10000ms)
$tir->setDebouncePeriod(10000);
// Register object temperature reached callback to function cb_objectTemperatureReached
$tir->registerCallback(BrickletTemperatureIR::CALLBACK_OBJECT_TEMPERATURE_REACHED,
'cb_objectTemperatureReached');
// Configure threshold for object temperature "greater than 100 °C"
$tir->setObjectTemperatureCallbackThreshold('>', 100*10, 0);
echo "Press ctrl+c to exit\n";
$ipcon->dispatchCallbacks(-1); // Dispatch callbacks forever
?>
|
Funktion die mehrere Werte zurückgeben geben diese in einem assoziativen Array zurück.
BrickletTemperatureIR
(string $uid, IPConnection $ipcon)¶Parameter: |
|
---|---|
Rückgabe: |
|
Erzeugt ein Objekt mit der eindeutigen Geräte ID $uid
:
<?php $temperature_ir = new BrickletTemperatureIR('YOUR_DEVICE_UID', $ipcon); ?>
Dieses Objekt kann benutzt werden, nachdem die IP Connection verbunden ist.
BrickletTemperatureIR::
getAmbientTemperature
()¶Rückgabe: |
|
---|
Gibt die Umgebungstemperatur des Sensors zurück.
Wenn die Umgebungstemperatur periodisch abgefragt werden soll, wird empfohlen
den CALLBACK_AMBIENT_TEMPERATURE
Callback zu nutzen und die Periode mit
setAmbientTemperatureCallbackPeriod()
vorzugeben.
BrickletTemperatureIR::
getObjectTemperature
()¶Rückgabe: |
|
---|
Gibt die Objekttemperatur des Sensors zurück, z.B. die Temperatur der Oberfläche auf welche der Sensor zielt.
Die Temperatur von unterschiedlichen Materialien ist abhängig von ihrem
Emissionsgrad. Der
Emissionsgrad des Materials kann mit setEmissivity()
gesetzt werden.
Wenn die Objekttemperatur periodisch abgefragt werden soll, wird empfohlen
den CALLBACK_OBJECT_TEMPERATURE
Callback zu nutzen und die Periode mit
setObjectTemperatureCallbackPeriod()
vorzugeben.
BrickletTemperatureIR::
setEmissivity
(int $emissivity)¶Parameter: |
|
---|
Setzt den Emissionsgrad,
welcher zur Berechnung der Oberflächentemperatur benutzt wird, wie von
getObjectTemperature()
zurückgegeben.
Der Emissionsgrad wird normalerweise als Wert zwischen 0,0 und 1,0 angegeben. Eine Liste von Emissionsgraden unterschiedlicher Materialien ist hier zu finden.
Der Parameter von setEmissivity()
muss mit eine Faktor von 65535 (16-Bit)
vorgegeben werden. Beispiel: Ein Emissionsgrad von 0,1 kann mit dem Wert
6553 gesetzt werden, ein Emissionsgrad von 0,5 mit dem Wert 32767 und so weiter.
Bemerkung
Wenn eine exakte Messung der Objekttemperatur notwendig ist, ist es entscheidend eine exakten Emissionsgrad anzugeben.
Der Emissionsgrad wird in nicht-flüchtigem Speicher gespeichert und wird auch noch einem Neustart weiter genutzt.
BrickletTemperatureIR::
getEmissivity
()¶Rückgabe: |
|
---|
Gibt den Emissionsgrad zurück, wie von setEmissivity()
gesetzt.
BrickletTemperatureIR::
getIdentity
()¶Rückgabe-Array: |
|
---|
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 ist 'a', 'b', 'c', 'd', 'e', 'f', 'g' oder 'h' (Bricklet Anschluss). Ein 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.
BrickletTemperatureIR::
registerCallback
(int $callback_id, callable $callback, mixed $user_data=NULL)¶Parameter: |
|
---|
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.
BrickletTemperatureIR::
setAmbientTemperatureCallbackPeriod
(int $period)¶Parameter: |
|
---|
Setzt die Periode mit welcher der CALLBACK_AMBIENT_TEMPERATURE
Callback
ausgelöst wird. Ein Wert von 0 deaktiviert den Callback.
Der CALLBACK_AMBIENT_TEMPERATURE
Callback wird nur ausgelöst, wenn sich die
Temperatur seit der letzten Auslösung geändert hat.
BrickletTemperatureIR::
getAmbientTemperatureCallbackPeriod
()¶Rückgabe: |
|
---|
Gibt die Periode zurück, wie von setAmbientTemperatureCallbackPeriod()
gesetzt.
BrickletTemperatureIR::
setObjectTemperatureCallbackPeriod
(int $period)¶Parameter: |
|
---|
Setzt die Periode mit welcher der CALLBACK_OBJECT_TEMPERATURE
Callback
ausgelöst wird. Ein Wert von 0 deaktiviert den Callback.
Der CALLBACK_OBJECT_TEMPERATURE
Callback wird nur ausgelöst, wenn sich die
Temperatur seit der letzten Auslösung geändert hat.
BrickletTemperatureIR::
getObjectTemperatureCallbackPeriod
()¶Rückgabe: |
|
---|
Gibt die Periode zurück, wie von setObjectTemperatureCallbackPeriod()
gesetzt.
BrickletTemperatureIR::
setAmbientTemperatureCallbackThreshold
(string $option, int $min, int $max)¶Parameter: |
|
---|
Setzt den Schwellwert für den CALLBACK_AMBIENT_TEMPERATURE_REACHED
Callback.
Die folgenden Optionen sind möglich:
Option | Beschreibung |
---|---|
'x' | Callback ist inaktiv |
'o' | Callback wird ausgelöst, wenn die Umgebungstemperatur außerhalb des min und max Wertes ist |
'i' | Callback wird ausgelöst, wenn die Umgebungstemperatur innerhalb des min und max Wertes ist |
'<' | Callback wird ausgelöst, wenn die Umgebungstemperatur kleiner als der min Wert ist (max wird ignoriert) |
'>' | Callback wird ausgelöst, wenn die Umgebungstemperatur größer als der min Wert ist (max wird ignoriert) |
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für $option:
BrickletTemperatureIR::
getAmbientTemperatureCallbackThreshold
()¶Rückgabe-Array: |
|
---|
Gibt den Schwellwert zurück, wie von setAmbientTemperatureCallbackThreshold()
gesetzt.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für $option:
BrickletTemperatureIR::
setObjectTemperatureCallbackThreshold
(string $option, int $min, int $max)¶Parameter: |
|
---|
Setzt den Schwellwert für den CALLBACK_OBJECT_TEMPERATURE_REACHED
Callback.
Die folgenden Optionen sind möglich:
Option | Beschreibung |
---|---|
'x' | Callback ist inaktiv |
'o' | Callback wird ausgelöst, wenn die Objekttemperatur außerhalb des min und max Wertes ist |
'i' | Callback wird ausgelöst, wenn die Objekttemperatur innerhalb des min und max Wertes ist |
'<' | Callback wird ausgelöst, wenn die Objekttemperatur kleiner als der min Wert ist (max wird ignoriert) |
'>' | Callback wird ausgelöst, wenn die Objekttemperatur größer als der min Wert ist (max wird ignoriert) |
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für $option:
BrickletTemperatureIR::
getObjectTemperatureCallbackThreshold
()¶Rückgabe-Array: |
|
---|
Gibt den Schwellwert zurück, wie von setObjectTemperatureCallbackThreshold()
gesetzt.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für $option:
BrickletTemperatureIR::
setDebouncePeriod
(int $debounce)¶Parameter: |
|
---|
Setzt die Periode mit welcher die Schwellwert Callbacks
ausgelöst werden, wenn die Schwellwerte
weiterhin erreicht bleiben.
BrickletTemperatureIR::
getDebouncePeriod
()¶Rückgabe: |
|
---|
Gibt die Entprellperiode zurück, wie von setDebouncePeriod()
gesetzt.
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";
}
$temperature_ir->registerCallback(BrickletTemperatureIR::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.
BrickletTemperatureIR::
CALLBACK_AMBIENT_TEMPERATURE
¶<?php void callback(int $temperature [, mixed $user_data]) ?>
Callback-Parameter: |
|
---|
Dieser Callback wird mit der Periode, wie gesetzt mit setAmbientTemperatureCallbackPeriod()
,
ausgelöst. Der Parameter ist die Temperatur des Sensors.
Der CALLBACK_AMBIENT_TEMPERATURE
Callback wird nur ausgelöst, wenn sich die
Temperatur seit der letzten Auslösung geändert hat.
BrickletTemperatureIR::
CALLBACK_OBJECT_TEMPERATURE
¶<?php void callback(int $temperature [, mixed $user_data]) ?>
Callback-Parameter: |
|
---|
Dieser Callback wird mit der Periode, wie gesetzt mit
setObjectTemperatureCallbackPeriod()
, ausgelöst. Der
Parameter ist die Objekttemperatur des Sensors.
Der CALLBACK_OBJECT_TEMPERATURE
Callback wird nur ausgelöst, wenn sich die
Objekttemperatur seit der letzten Auslösung geändert hat.
BrickletTemperatureIR::
CALLBACK_AMBIENT_TEMPERATURE_REACHED
¶<?php void callback(int $temperature [, mixed $user_data]) ?>
Callback-Parameter: |
|
---|
Dieser Callback wird ausgelöst, wenn der Schwellwert, wie von
setAmbientTemperatureCallbackThreshold()
gesetzt, erreicht wird.
Der Parameter ist die Umgebungstemperatur des Sensors.
Wenn der Schwellwert erreicht bleibt, wird der Callback mit der Periode, wie
mit setDebouncePeriod()
gesetzt, ausgelöst.
BrickletTemperatureIR::
CALLBACK_OBJECT_TEMPERATURE_REACHED
¶<?php void callback(int $temperature [, mixed $user_data]) ?>
Callback-Parameter: |
|
---|
Dieser Callback wird ausgelöst, wenn der Schwellwert, wie von
setObjectTemperatureCallbackThreshold()
gesetzt, erreicht wird.
Der Parameter ist die Objekttemperatur des Sensors.
Wenn der Schwellwert erreicht bleibt, wird der Callback mit der Periode, wie
mit setDebouncePeriod()
gesetzt, ausgelöst.
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.
BrickletTemperatureIR::
getAPIVersion
()¶Rückgabe-Array: |
|
---|
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.
BrickletTemperatureIR::
getResponseExpected
(int $function_id)¶Parameter: |
|
---|---|
Rückgabe: |
|
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:
BrickletTemperatureIR::
setResponseExpected
(int $function_id, bool $response_expected)¶Parameter: |
|
---|
Ä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:
BrickletTemperatureIR::
setResponseExpectedAll
(bool $response_expected)¶Parameter: |
|
---|
Ändert das Response-Expected-Flag für alle Setter-Funktionen und Konfigurationsfunktionen für Callbacks diese Gerätes.
BrickletTemperatureIR::
DEVICE_IDENTIFIER
¶Diese Konstante wird verwendet um ein Temperature IR 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.
BrickletTemperatureIR::
DEVICE_DISPLAY_NAME
¶Diese Konstante stellt den Anzeigenamen eines Temperature IR Bricklet dar.