Software / API Bindings / PHP / API Referenz und Beispiele / Bricklets (Abgekündigt) / Humidity Bricklet

PHP - Humidity Bricklet¶

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

<?php

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

use Tinkerforge\IPConnection;
use Tinkerforge\BrickletHumidity;

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

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

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

// Get current humidity
$humidity = $h->getHumidity();
echo "Humidity: " . $humidity/10.0 . " %RH\n";

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

?>

Callback¶

Download (ExampleCallback.php)

<?php

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

use Tinkerforge\IPConnection;
use Tinkerforge\BrickletHumidity;

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

// Callback function for humidity callback
function cb_humidity($humidity)
{
    echo "Humidity: " . $humidity/10.0 . " %RH\n";
}

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

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

// Register humidity callback to function cb_humidity
$h->registerCallback(BrickletHumidity::CALLBACK_HUMIDITY, 'cb_humidity');

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

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

?>

Threshold¶

Download (ExampleThreshold.php)

<?php

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

use Tinkerforge\IPConnection;
use Tinkerforge\BrickletHumidity;

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

// Callback function for humidity reached callback
function cb_humidityReached($humidity)
{
    echo "Humidity: " . $humidity/10.0 . " %RH\n";
    echo "Recommended humidity for human comfort is 30 to 60 %RH.\n";
}

$ipcon = new IPConnection(); // Create IP connection
$h = new BrickletHumidity(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)
$h->setDebouncePeriod(10000);

// Register humidity reached callback to function cb_humidityReached
$h->registerCallback(BrickletHumidity::CALLBACK_HUMIDITY_REACHED, 'cb_humidityReached');

// Configure threshold for humidity "outside of 30 to 60 %RH"
$h->setHumidityCallbackThreshold('o', 30*10, 60*10);

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 BrickletHumidity(string $uid, IPConnection $ipcon)¶

Parameter:	$uid – Typ: string $ipcon – Typ: IPConnection
Rückgabe:	$humidity – Typ: BrickletHumidity

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

<?php   $humidity = new BrickletHumidity('YOUR_DEVICE_UID', $ipcon);   ?>

Dieses Objekt kann benutzt werden, nachdem die IP Connection verbunden ist.

int BrickletHumidity::getHumidity()¶

Rückgabe:	$humidity – Typ: int, Einheit: 1/10 %, Wertebereich: [0 bis 1000]

Gibt die gemessene Luftfeuchtigkeit des Sensors zurück.

Wenn die Luftfeuchtigkeit periodisch abgefragt werden soll, wird empfohlen den CALLBACK_HUMIDITY Callback zu nutzen und die Periode mit setHumidityCallbackPeriod() vorzugeben.

Fortgeschrittene Funktionen¶

int BrickletHumidity::getAnalogValue()¶

Rückgabe:	$value – Typ: int, Wertebereich: [0 bis 2¹² - 1]

Gibt den Wert, wie vom 12-Bit Analog-Digital-Wandler gelesen, zurück.

Bemerkung

Der von getHumidity() zurückgegebene Wert ist über mehrere Messwerte gemittelt um das Rauschen zu vermindern, während getAnalogValue() unverarbeitete Analogwerte zurück gibt. Der zurückgegebene Luftfeuchtigkeitswert ist auf Raumtemperatur kalibriert, d.h. wenn der Sensor in sehr kalten oder warmen Umgebungen verwendet wird, ist es ratsam den Luftfeuchtigkeitswert direkt aus den Analogwerten zu berechnen. Siehe hierzu das HIH 5030 Datenblatt.

Wenn der Analogwert periodisch abgefragt werden soll, wird empfohlen den CALLBACK_ANALOG_VALUE Callback zu nutzen und die Periode mit setAnalogValueCallbackPeriod() vorzugeben.

array BrickletHumidity::getIdentity()¶

Rückgabe-Array:

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 'h', '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 2¹⁶ - 1]

'uid' – Typ: string, Länge: bis zu 8
'connected_uid' – Typ: string, Länge: bis zu 8
'position' – Typ: string, Wertebereich: ['a' bis 'h', '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 2¹⁶ - 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 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.

Konfigurationsfunktionen für Callbacks¶

void BrickletHumidity::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 BrickletHumidity::setHumidityCallbackPeriod(int $period)¶

Parameter:	$period – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 1], Standardwert: 0

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

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

int BrickletHumidity::getHumidityCallbackPeriod()¶

Rückgabe:	$period – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 1], Standardwert: 0

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

void BrickletHumidity::setAnalogValueCallbackPeriod(int $period)¶

Parameter:	$period – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 1], Standardwert: 0

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

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

int BrickletHumidity::getAnalogValueCallbackPeriod()¶

Rückgabe:	$period – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 1], Standardwert: 0

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

void BrickletHumidity::setHumidityCallbackThreshold(string $option, int $min, int $max)¶

Parameter:	$option – Typ: string, Wertebereich: Siehe Konstanten, Standardwert: 'x' $min – Typ: int, Einheit: 1/10 %, Wertebereich: [0 bis 2¹⁶ - 1], Standardwert: 0 $max – Typ: int, Einheit: 1/10 %, Wertebereich: [0 bis 2¹⁶ - 1], Standardwert: 0

Setzt den Schwellwert für den CALLBACK_HUMIDITY_REACHED Callback.

Die folgenden Optionen sind möglich:

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

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

Für $option:

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

array BrickletHumidity::getHumidityCallbackThreshold()¶

Rückgabe-Array:	'option' – Typ: string, Wertebereich: Siehe Konstanten, Standardwert: 'x' 'min' – Typ: int, Einheit: 1/10 %, Wertebereich: [0 bis 2¹⁶ - 1], Standardwert: 0 'max' – Typ: int, Einheit: 1/10 %, Wertebereich: [0 bis 2¹⁶ - 1], Standardwert: 0

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

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

Für $option:

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

void BrickletHumidity::setAnalogValueCallbackThreshold(string $option, int $min, int $max)¶

Parameter:	$option – Typ: string, Wertebereich: Siehe Konstanten, Standardwert: 'x' $min – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1], Standardwert: 0 $max – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1], Standardwert: 0

Setzt den Schwellwert für den CALLBACK_ANALOG_VALUE_REACHED Callback.

Die folgenden Optionen sind möglich:

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

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

Für $option:

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

array BrickletHumidity::getAnalogValueCallbackThreshold()¶

Rückgabe-Array:	'option' – Typ: string, Wertebereich: Siehe Konstanten, Standardwert: 'x' 'min' – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1], Standardwert: 0 'max' – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1], Standardwert: 0

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

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

Für $option:

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

void BrickletHumidity::setDebouncePeriod(int $debounce)¶

Parameter:	$debounce – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 1], Standardwert: 100

Setzt die Periode mit welcher die Schwellwert Callbacks

CALLBACK_HUMIDITY_REACHED,
CALLBACK_ANALOG_VALUE_REACHED

ausgelöst werden, wenn die Schwellwerte

setHumidityCallbackThreshold(),
setAnalogValueCallbackThreshold()

weiterhin erreicht bleiben.

int BrickletHumidity::getDebouncePeriod()¶

Rückgabe:	$debounce – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 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";
}

$humidity->registerCallback(BrickletHumidity::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 BrickletHumidity::CALLBACK_HUMIDITY¶

<?php   void callback(int $humidity [, mixed $user_data])   ?>

Callback-Parameter:	$humidity – Typ: int, Einheit: 1/10 %, Wertebereich: [0 bis 1000] $user_data – Typ: mixed

Dieser Callback wird mit der Periode, wie gesetzt mit setHumidityCallbackPeriod(), ausgelöst. Der Parameter ist die Luftfeuchtigkeit des Sensors.

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

int BrickletHumidity::CALLBACK_ANALOG_VALUE¶

<?php   void callback(int $value [, mixed $user_data])   ?>

Callback-Parameter:	$value – Typ: int, Wertebereich: [0 bis 2¹² - 1] $user_data – Typ: mixed

Dieser Callback wird mit der Periode, wie gesetzt mit setAnalogValueCallbackPeriod(), ausgelöst. Der Parameter ist der Analogwert des Sensors.

CALLBACK_ANALOG_VALUE Callback wird nur ausgelöst, wenn sich der Analogwert seit der letzten Auslösung geändert hat.

int BrickletHumidity::CALLBACK_HUMIDITY_REACHED¶

<?php   void callback(int $humidity [, mixed $user_data])   ?>

Callback-Parameter:	$humidity – Typ: int, Einheit: 1/10 %, Wertebereich: [0 bis 1000] $user_data – Typ: mixed

Dieser Callback wird ausgelöst, wenn der Schwellwert, wie von setHumidityCallbackThreshold() gesetzt, erreicht wird. Der Parameter ist die Luftfeuchtigkeit des Sensors.

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

int BrickletHumidity::CALLBACK_ANALOG_VALUE_REACHED¶

<?php   void callback(int $value [, mixed $user_data])   ?>

Callback-Parameter:	$value – Typ: int, Wertebereich: [0 bis 2¹² - 1] $user_data – Typ: mixed

Dieser Callback wird ausgelöst, wenn der Schwellwert, wie von setAnalogValueCallbackThreshold() gesetzt, erreicht wird. Der Parameter ist der Analogwert 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 BrickletHumidity::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 BrickletHumidity::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:

BrickletHumidity::FUNCTION_SET_HUMIDITY_CALLBACK_PERIOD = 3
BrickletHumidity::FUNCTION_SET_ANALOG_VALUE_CALLBACK_PERIOD = 5
BrickletHumidity::FUNCTION_SET_HUMIDITY_CALLBACK_THRESHOLD = 7
BrickletHumidity::FUNCTION_SET_ANALOG_VALUE_CALLBACK_THRESHOLD = 9
BrickletHumidity::FUNCTION_SET_DEBOUNCE_PERIOD = 11

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

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

Für $function_id:

BrickletHumidity::FUNCTION_SET_HUMIDITY_CALLBACK_PERIOD = 3
BrickletHumidity::FUNCTION_SET_ANALOG_VALUE_CALLBACK_PERIOD = 5
BrickletHumidity::FUNCTION_SET_HUMIDITY_CALLBACK_THRESHOLD = 7
BrickletHumidity::FUNCTION_SET_ANALOG_VALUE_CALLBACK_THRESHOLD = 9
BrickletHumidity::FUNCTION_SET_DEBOUNCE_PERIOD = 11

void BrickletHumidity::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 BrickletHumidity::DEVICE_IDENTIFIER¶

Diese Konstante wird verwendet um ein Humidity 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 BrickletHumidity::DEVICE_DISPLAY_NAME¶: Diese Konstante stellt den Anzeigenamen eines Humidity Bricklet dar.