PHP - Dust Detector Bricklet

Dies ist die Beschreibung der PHP API Bindings für das Dust Detector Bricklet. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des Dust Detector 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/BrickletDustDetector.php');

use Tinkerforge\IPConnection;
use Tinkerforge\BrickletDustDetector;

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

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

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

// Get current dust density
$dust_density = $dd->getDustDensity();
echo "Dust Density: $dust_density µg/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/BrickletDustDetector.php');

use Tinkerforge\IPConnection;
use Tinkerforge\BrickletDustDetector;

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

// Callback function for dust density callback
function cb_dustDensity($dust_density)
{
    echo "Dust Density: $dust_density µg/m³\n";
}

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

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

// Register dust density callback to function cb_dustDensity
$dd->registerCallback(BrickletDustDetector::CALLBACK_DUST_DENSITY, 'cb_dustDensity');

// Set period for dust density callback to 1s (1000ms)
// Note: The dust density callback is only called every second
//       if the dust density has changed since the last call!
$dd->setDustDensityCallbackPeriod(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/BrickletDustDetector.php');

use Tinkerforge\IPConnection;
use Tinkerforge\BrickletDustDetector;

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

// Callback function for dust density reached callback
function cb_dustDensityReached($dust_density)
{
    echo "Dust Density: $dust_density µg/m³\n";
}

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

// Register dust density reached callback to function cb_dustDensityReached
$dd->registerCallback(BrickletDustDetector::CALLBACK_DUST_DENSITY_REACHED,
                      'cb_dustDensityReached');

// Configure threshold for dust density "greater than 10 µg/m³"
$dd->setDustDensityCallbackThreshold('>', 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 BrickletDustDetector(string $uid, IPConnection $ipcon)
Parameter:
  • $uid – Typ: string
  • $ipcon – Typ: IPConnection
Rückgabe:
  • $dust_detector – Typ: BrickletDustDetector

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

<?php   $dust_detector = new BrickletDustDetector('YOUR_DEVICE_UID', $ipcon);   ?>

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

int BrickletDustDetector::getDustDensity()
Rückgabe:
  • $dust_density – Typ: int, Wertebereich: [0 bis 216 - 1]

Gibt die Staubdichte in µg/m³ zurück.

Wenn die Staubdichte periodisch abgefragt werden soll, wird empfohlen den CALLBACK_DUST_DENSITY Callback zu nutzen und die Periode mit setDustDensityCallbackPeriod() vorzugeben.

Fortgeschrittene Funktionen

void BrickletDustDetector::setMovingAverage(int $average)
Parameter:
  • $average – Typ: int, Wertebereich: [0 bis 255]

Setzt die Länge eines gleitenden Mittelwerts für die Staubdichte.

Wenn die Länge auf 0 gesetzt wird, ist das Averaging komplett aus. Desto kleiner die Länge des Mittelwerts ist, desto mehr Rauschen ist auf den Daten.

Der Wertebereich liegt bei 0-100.

Der Standardwert ist 100.

int BrickletDustDetector::getMovingAverage()
Rückgabe:
  • $average – Typ: int, Wertebereich: [0 bis 255]

Gibt die Länge des gleitenden Mittelwerts zurück, wie von setMovingAverage() gesetzt.

array BrickletDustDetector::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 BrickletDustDetector::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:

  • BrickletDustDetector::FUNCTION_SET_DUST_DENSITY_CALLBACK_PERIOD = 2
  • BrickletDustDetector::FUNCTION_SET_DUST_DENSITY_CALLBACK_THRESHOLD = 4
  • BrickletDustDetector::FUNCTION_SET_DEBOUNCE_PERIOD = 6
  • BrickletDustDetector::FUNCTION_SET_MOVING_AVERAGE = 10
void BrickletDustDetector::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:

  • BrickletDustDetector::FUNCTION_SET_DUST_DENSITY_CALLBACK_PERIOD = 2
  • BrickletDustDetector::FUNCTION_SET_DUST_DENSITY_CALLBACK_THRESHOLD = 4
  • BrickletDustDetector::FUNCTION_SET_DEBOUNCE_PERIOD = 6
  • BrickletDustDetector::FUNCTION_SET_MOVING_AVERAGE = 10
void BrickletDustDetector::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 BrickletDustDetector::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 BrickletDustDetector::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 BrickletDustDetector::setDustDensityCallbackPeriod(int $period)
Parameter:
  • $period – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0

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

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

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

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

void BrickletDustDetector::setDustDensityCallbackThreshold(string $option, int $min, int $max)
Parameter:
  • $option – Typ: string, Wertebereich: Siehe Konstanten, Standardwert: 'x'
  • $min – Typ: int, Wertebereich: [0 bis 216 - 1]
  • $max – Typ: int, Wertebereich: [0 bis 216 - 1]

Setzt den Schwellwert für den CALLBACK_DUST_DENSITY_REACHED Callback.

Die folgenden Optionen sind möglich:

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

Der Standardwert ist ('x', 0, 0).

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

Für $option:

  • BrickletDustDetector::THRESHOLD_OPTION_OFF = 'x'
  • BrickletDustDetector::THRESHOLD_OPTION_OUTSIDE = 'o'
  • BrickletDustDetector::THRESHOLD_OPTION_INSIDE = 'i'
  • BrickletDustDetector::THRESHOLD_OPTION_SMALLER = '<'
  • BrickletDustDetector::THRESHOLD_OPTION_GREATER = '>'
array BrickletDustDetector::getDustDensityCallbackThreshold()
Rückgabe-Array:
  • 'option' – Typ: string, Wertebereich: Siehe Konstanten, Standardwert: 'x'
  • 'min' – Typ: int, Wertebereich: [0 bis 216 - 1]
  • 'max' – Typ: int, Wertebereich: [0 bis 216 - 1]

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

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

Für $option:

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

Setzt die Periode mit welcher die Schwellwert Callback

ausgelöst wird, wenn der Schwellwert

weiterhin erreicht bleibt.

int BrickletDustDetector::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";
}

$dust_detector->registerCallback(BrickletDustDetector::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 BrickletDustDetector::CALLBACK_DUST_DENSITY
<?php   void callback(int $dust_density [, mixed $user_data])   ?>
Callback-Parameter:
  • $dust_density – Typ: int, Wertebereich: [0 bis 216 - 1]
  • $user_data – Typ: mixed

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

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

int BrickletDustDetector::CALLBACK_DUST_DENSITY_REACHED
<?php   void callback(int $dust_density [, mixed $user_data])   ?>
Callback-Parameter:
  • $dust_density – Typ: int, Wertebereich: [0 bis 216 - 1]
  • $user_data – Typ: mixed

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

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

Konstanten

int BrickletDustDetector::DEVICE_IDENTIFIER

Diese Konstante wird verwendet um ein Dust Detector 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 BrickletDustDetector::DEVICE_DISPLAY_NAME

Diese Konstante stellt den Anzeigenamen eines Dust Detector Bricklet dar.