PHP - Humidity Bricklet 2.0

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

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

use Tinkerforge\IPConnection;
use Tinkerforge\BrickletHumidityV2;

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

$ipcon = new IPConnection(); // Create IP connection
$h = new BrickletHumidityV2(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/100.0 . " %RH\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
<?php

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

use Tinkerforge\IPConnection;
use Tinkerforge\BrickletHumidityV2;

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

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

$ipcon = new IPConnection(); // Create IP connection
$h = new BrickletHumidityV2(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(BrickletHumidityV2::CALLBACK_HUMIDITY, 'cb_humidity');

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

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

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

use Tinkerforge\IPConnection;
use Tinkerforge\BrickletHumidityV2;

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

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

$ipcon = new IPConnection(); // Create IP connection
$h = new BrickletHumidityV2(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(BrickletHumidityV2::CALLBACK_HUMIDITY, 'cb_humidity');

// Configure threshold for humidity "outside of 30 to 60 %RH"
// with a debounce period of 10s (10000ms)
$h->setHumidityCallbackConfiguration(10000, FALSE, 'o', 30*100, 60*100);

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

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

<?php   $humidity_v2 = new BrickletHumidityV2('YOUR_DEVICE_UID', $ipcon);   ?>

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

int BrickletHumidityV2::getHumidity()
Rückgabe:
  • $humidity – Typ: int, Einheit: 1/100 %, Wertebereich: [0 bis 10000]

Gibt die gemessene Luftfeuchtigkeit des Sensors zurück.

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

int BrickletHumidityV2::getTemperature()
Rückgabe:
  • $temperature – Typ: int, Einheit: 1/100 °C, Wertebereich: [-4000 bis 16500]

Gibt die gemessene Temperatur des Sensors zurück.

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

void BrickletHumidityV2::setHeaterConfiguration(int $heater_config)
Parameter:
  • $heater_config – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: False

Aktiviert/deaktiviert das Heizelement. Das Heizelement kann genutzt werden um den Sensor bei extremer Feuchtigkeit zu trocknen.

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

Für $heater_config:

  • BrickletHumidityV2::HEATER_CONFIG_DISABLED = 0
  • BrickletHumidityV2::HEATER_CONFIG_ENABLED = 1
int BrickletHumidityV2::getHeaterConfiguration()
Rückgabe:
  • $heater_config – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: False

Gibt die Heizelement-Konfiguration zurück, wie von setHeaterConfiguration() gesetzt.

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

Für $heater_config:

  • BrickletHumidityV2::HEATER_CONFIG_DISABLED = 0
  • BrickletHumidityV2::HEATER_CONFIG_ENABLED = 1
void BrickletHumidityV2::setMovingAverageConfiguration(int $moving_average_length_humidity, int $moving_average_length_temperature)
Parameter:
  • $moving_average_length_humidity – Typ: int, Wertebereich: [1 bis 1000], Standardwert: 5
  • $moving_average_length_temperature – Typ: int, Wertebereich: [1 bis 1000], Standardwert: 5

Setzt die Länge eines gleitenden Mittelwerts für die Luftfeuchtigkeit und Temperatur.

Wenn die Länge auf 1 gesetzt wird, ist die Mittelwertbildung deaktiviert. Je kürzer die Länge des Mittelwerts ist, desto mehr Rauschen ist auf den Daten.

Einer neue Wert wird alle 50ms* gemessen. Mit einer Mittelwerts-Länge von 1000 hat das resultierende gleitende Fenster eine Zeitspanne von 50s. Bei Langzeitmessungen gibt ein langer Mittelwert die saubersten Resultate.

* In Firmware Version 2.0.3 haben wir die Funktion setSamplesPerSecond() hinzugefügt. Diese konfiguriert die Messfrequenz. Da eine hohe Messfrequenz zu Selbsterhitzung führen kann haben wir die Standardeinstellung von 20 SPS auf 1 SPS geändert. Mit einer Messung pro Sekunde entspricht eine Mittelwert-Länge von 1000 einem Zeitfenster von 1000 Sekunden!

array BrickletHumidityV2::getMovingAverageConfiguration()
Rückgabe-Array:
  • 'moving_average_length_humidity' – Typ: int, Wertebereich: [1 bis 1000], Standardwert: 5
  • 'moving_average_length_temperature' – Typ: int, Wertebereich: [1 bis 1000], Standardwert: 5

Gibt die Moving Average-Konfiguration zurück, wie von setMovingAverageConfiguration() gesetzt.

void BrickletHumidityV2::setSamplesPerSecond(int $sps)
Parameter:
  • $sps – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 3

Setzt die Messungen pro Sekunde mit denen neue Luftfeuchte/Temperatur-Werte vom HDC1080 Sensor gelesen werden.

Wir haben diese Funktion hinzugefügt, da eine hohe Messfrequenz zu einer Selbsterhitzung des Sensors führen kann. Diese kann die Temperaturmessung verfälschen.

Wenn wenig Messwerte benötigt werden kann die Frequenz auf bis zu 0,1 Messungen pro Sekunde verringert werden um einen Fehler durch Selbsterhitzung möglichst weit zu minimieren.

Vor Version 2.0.3 wurden 20 Messungen pro Sekunde gemacht. Der neue Standardwert seit 2.0.3 ist 1 Messung pro Sekunde.

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

Für $sps:

  • BrickletHumidityV2::SPS_20 = 0
  • BrickletHumidityV2::SPS_10 = 1
  • BrickletHumidityV2::SPS_5 = 2
  • BrickletHumidityV2::SPS_1 = 3
  • BrickletHumidityV2::SPS_02 = 4
  • BrickletHumidityV2::SPS_01 = 5

Neu in Version 2.0.3 (Plugin).

int BrickletHumidityV2::getSamplesPerSecond()
Rückgabe:
  • $sps – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 3

Gibt die Messwerte pro Sekunde zurück, wie von setSamplesPerSecond() gesetzt.

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

Für $sps:

  • BrickletHumidityV2::SPS_20 = 0
  • BrickletHumidityV2::SPS_10 = 1
  • BrickletHumidityV2::SPS_5 = 2
  • BrickletHumidityV2::SPS_1 = 3
  • BrickletHumidityV2::SPS_02 = 4
  • BrickletHumidityV2::SPS_01 = 5

Neu in Version 2.0.3 (Plugin).

Fortgeschrittene Funktionen

array BrickletHumidityV2::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 BrickletHumidityV2::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 Bootloader- 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:

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

Für $status:

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

  • BrickletHumidityV2::BOOTLOADER_MODE_BOOTLOADER = 0
  • BrickletHumidityV2::BOOTLOADER_MODE_FIRMWARE = 1
  • BrickletHumidityV2::BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
  • BrickletHumidityV2::BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
  • BrickletHumidityV2::BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4
void BrickletHumidityV2::setWriteFirmwarePointer(int $pointer)
Parameter:
  • $pointer – Typ: int, Einheit: 1 B, 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 BrickletHumidityV2::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 BrickletHumidityV2::setStatusLEDConfig(int $config)
Parameter:
  • $config – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 3

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:

  • BrickletHumidityV2::STATUS_LED_CONFIG_OFF = 0
  • BrickletHumidityV2::STATUS_LED_CONFIG_ON = 1
  • BrickletHumidityV2::STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • BrickletHumidityV2::STATUS_LED_CONFIG_SHOW_STATUS = 3
int BrickletHumidityV2::getStatusLEDConfig()
Rückgabe:
  • $config – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 3

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

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

Für $config:

  • BrickletHumidityV2::STATUS_LED_CONFIG_OFF = 0
  • BrickletHumidityV2::STATUS_LED_CONFIG_ON = 1
  • BrickletHumidityV2::STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • BrickletHumidityV2::STATUS_LED_CONFIG_SHOW_STATUS = 3
int BrickletHumidityV2::getChipTemperature()
Rückgabe:
  • $temperature – Typ: int, Einheit: 1 °C, Wertebereich: [-215 bis 215 - 1]

Gibt die Temperatur, 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 BrickletHumidityV2::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 BrickletHumidityV2::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 BrickletHumidityV2::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 BrickletHumidityV2::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 'h', '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 BrickletHumidityV2::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 BrickletHumidityV2::setHumidityCallbackConfiguration(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, Einheit: 1/100 %, Wertebereich: [0 bis 216 - 1], Standardwert: 0
  • $max – Typ: int, Einheit: 1/100 %, Wertebereich: [0 bis 216 - 1], Standardwert: 0

Die Periode ist die Periode mit der der CALLBACK_HUMIDITY 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_HUMIDITY 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.

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

Für $option:

  • BrickletHumidityV2::THRESHOLD_OPTION_OFF = 'x'
  • BrickletHumidityV2::THRESHOLD_OPTION_OUTSIDE = 'o'
  • BrickletHumidityV2::THRESHOLD_OPTION_INSIDE = 'i'
  • BrickletHumidityV2::THRESHOLD_OPTION_SMALLER = '<'
  • BrickletHumidityV2::THRESHOLD_OPTION_GREATER = '>'
array BrickletHumidityV2::getHumidityCallbackConfiguration()
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, Einheit: 1/100 %, Wertebereich: [0 bis 216 - 1], Standardwert: 0
  • 'max' – Typ: int, Einheit: 1/100 %, Wertebereich: [0 bis 216 - 1], Standardwert: 0

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

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

Für $option:

  • BrickletHumidityV2::THRESHOLD_OPTION_OFF = 'x'
  • BrickletHumidityV2::THRESHOLD_OPTION_OUTSIDE = 'o'
  • BrickletHumidityV2::THRESHOLD_OPTION_INSIDE = 'i'
  • BrickletHumidityV2::THRESHOLD_OPTION_SMALLER = '<'
  • BrickletHumidityV2::THRESHOLD_OPTION_GREATER = '>'
void BrickletHumidityV2::setTemperatureCallbackConfiguration(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, Einheit: 1/100 °C, Wertebereich: [-215 bis 215 - 1], Standardwert: 0
  • $max – Typ: int, Einheit: 1/100 °C, Wertebereich: [-215 bis 215 - 1], Standardwert: 0

Die Periode ist die Periode mit der der CALLBACK_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_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.

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

Für $option:

  • BrickletHumidityV2::THRESHOLD_OPTION_OFF = 'x'
  • BrickletHumidityV2::THRESHOLD_OPTION_OUTSIDE = 'o'
  • BrickletHumidityV2::THRESHOLD_OPTION_INSIDE = 'i'
  • BrickletHumidityV2::THRESHOLD_OPTION_SMALLER = '<'
  • BrickletHumidityV2::THRESHOLD_OPTION_GREATER = '>'
array BrickletHumidityV2::getTemperatureCallbackConfiguration()
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, Einheit: 1/100 °C, Wertebereich: [-215 bis 215 - 1], Standardwert: 0
  • 'max' – Typ: int, Einheit: 1/100 °C, Wertebereich: [-215 bis 215 - 1], Standardwert: 0

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

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

Für $option:

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

$humidity_v2->registerCallback(BrickletHumidityV2::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 BrickletHumidityV2::CALLBACK_HUMIDITY
<?php   void callback(int $humidity [, mixed $user_data])   ?>
Callback-Parameter:
  • $humidity – Typ: int, Einheit: 1/100 %, Wertebereich: [0 bis 10000]
  • $user_data – Typ: mixed

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

Der Parameter ist der gleiche wie getHumidity().

int BrickletHumidityV2::CALLBACK_TEMPERATURE
<?php   void callback(int $temperature [, mixed $user_data])   ?>
Callback-Parameter:
  • $temperature – Typ: int, Einheit: 1/100 °C, Wertebereich: [-4000 bis 16500]
  • $user_data – Typ: mixed

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

Der Parameter ist der gleiche wie getTemperature().

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

  • BrickletHumidityV2::FUNCTION_SET_HUMIDITY_CALLBACK_CONFIGURATION = 2
  • BrickletHumidityV2::FUNCTION_SET_TEMPERATURE_CALLBACK_CONFIGURATION = 6
  • BrickletHumidityV2::FUNCTION_SET_HEATER_CONFIGURATION = 9
  • BrickletHumidityV2::FUNCTION_SET_MOVING_AVERAGE_CONFIGURATION = 11
  • BrickletHumidityV2::FUNCTION_SET_SAMPLES_PER_SECOND = 13
  • BrickletHumidityV2::FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
  • BrickletHumidityV2::FUNCTION_SET_STATUS_LED_CONFIG = 239
  • BrickletHumidityV2::FUNCTION_RESET = 243
  • BrickletHumidityV2::FUNCTION_WRITE_UID = 248
void BrickletHumidityV2::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:

  • BrickletHumidityV2::FUNCTION_SET_HUMIDITY_CALLBACK_CONFIGURATION = 2
  • BrickletHumidityV2::FUNCTION_SET_TEMPERATURE_CALLBACK_CONFIGURATION = 6
  • BrickletHumidityV2::FUNCTION_SET_HEATER_CONFIGURATION = 9
  • BrickletHumidityV2::FUNCTION_SET_MOVING_AVERAGE_CONFIGURATION = 11
  • BrickletHumidityV2::FUNCTION_SET_SAMPLES_PER_SECOND = 13
  • BrickletHumidityV2::FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
  • BrickletHumidityV2::FUNCTION_SET_STATUS_LED_CONFIG = 239
  • BrickletHumidityV2::FUNCTION_RESET = 243
  • BrickletHumidityV2::FUNCTION_WRITE_UID = 248
void BrickletHumidityV2::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 BrickletHumidityV2::DEVICE_IDENTIFIER

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

Diese Konstante stellt den Anzeigenamen eines Humidity Bricklet 2.0 dar.