PHP - Barometer Bricklet

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

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

use Tinkerforge\IPConnection;
use Tinkerforge\BrickletBarometer;

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

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

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

// Get current air pressure
$air_pressure = $b->getAirPressure();
echo "Air Pressure: " . $air_pressure/1000.0 . " mbar\n";

// Get current altitude
$altitude = $b->getAltitude();
echo "Altitude: " . $altitude/100.0 . " 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/BrickletBarometer.php');

use Tinkerforge\IPConnection;
use Tinkerforge\BrickletBarometer;

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

// Callback function for air pressure callback
function cb_airPressure($air_pressure)
{
    echo "Air Pressure: " . $air_pressure/1000.0 . " mbar\n";
}

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

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

// Register air pressure callback to function cb_airPressure
$b->registerCallback(BrickletBarometer::CALLBACK_AIR_PRESSURE, 'cb_airPressure');

// Set period for air pressure callback to 1s (1000ms)
// Note: The air pressure callback is only called every second
//       if the air pressure has changed since the last call!
$b->setAirPressureCallbackPeriod(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
39
<?php

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

use Tinkerforge\IPConnection;
use Tinkerforge\BrickletBarometer;

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

// Callback function for air pressure reached callback
function cb_airPressureReached($air_pressure)
{
    echo "Air Pressure: " . $air_pressure/1000.0 . " mbar\n";
    echo "Enjoy the potentially good weather!\n";
}

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

// Register air pressure reached callback to function cb_airPressureReached
$b->registerCallback(BrickletBarometer::CALLBACK_AIR_PRESSURE_REACHED,
                     'cb_airPressureReached');

// Configure threshold for air pressure "greater than 1025 mbar"
$b->setAirPressureCallbackThreshold('>', 1025*1000, 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 BrickletBarometer(string $uid, IPConnection $ipcon)

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

<?php   $barometer = new BrickletBarometer('YOUR_DEVICE_UID', $ipcon);   ?>

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

int BrickletBarometer::getAirPressure()

Gibt den Luftdruck des Luftdrucksensors zurück. Der Wertbereich geht von 10000 bis 1200000 und ist in mbar/1000 angegeben, d.h. bei einem Wert von 1001092 wurde ein Luftdruck von 1001,092 mbar gemessen.

Wenn der Luftdruck periodisch abgefragt werden soll, wird empfohlen den CALLBACK_AIR_PRESSURE Callback zu nutzen und die Periode mit setAirPressureCallbackPeriod() vorzugeben.

int BrickletBarometer::getAltitude()

Gibt die relative Höhe des Luftdrucksensors zurück. Der Wert ist in cm angegeben und wird auf Basis der Differenz zwischen dem aktuellen Luftdruck und dem Referenzluftdruck berechnet, welcher mit setReferenceAirPressure() gesetzt werden kann.

Wenn die Höhe periodisch abgefragt werden soll, wird empfohlen den CALLBACK_ALTITUDE Callback zu nutzen und die Periode mit setAltitudeCallbackPeriod() vorzugeben.

void BrickletBarometer::setReferenceAirPressure(int $air_pressure)

Setzt den Referenzluftdruck in mbar/1000 für die Höhenberechnung. Gültige Werte liegen zwischen 10000 und 1200000. Wenn der aktuelle Luftdruckwert als Referenz übergeben wird dann gibt die Höhenberechnung 0cm aus. Als Abkürzung kann auch 0 übergeben werden, dadurch wird der Referenzluftdruck intern auf den aktuellen Luftdruckwert gesetzt.

Wohl bekannte Referenzluftdruckwerte, die in der Luftfahrt verwendet werden, sind QNH und QFE aus dem Q-Schlüssel.

Der Standardwert ist 1013,25mbar.

int BrickletBarometer::getReferenceAirPressure()

Gibt den Referenzluftdruckwert zurück, wie von setReferenceAirPressure() gesetzt.

Fortgeschrittene Funktionen

int BrickletBarometer::getChipTemperature()

Gibt die Temperatur des Luftdrucksensors zurück. Der Wertbereich ist von -4000 bis 8500 und ist in °C/100 angegeben, d.h. bei einem Wert von 2007 wurde eine Temperatur von 20,07 °C gemessen.

Diese Temperatur wird intern zur Temperaturkompensation der Luftdruckmessung verwendet. Sie ist nicht so genau wie die Temperatur die vom Temperature Bricklet oder dem Temperature IR Bricklet gemessen wird.

void BrickletBarometer::setAveraging(int $moving_average_pressure, int $average_pressure, int $average_temperature)

Setzt die unterschiedlichen Averaging-Parameter (Mittelwertbildung). Es ist möglich die Länge des Mittelwerts für Temperatur und Luftdruck anzugeben. Zusätzlich gibt kann die Länge für einen gleitenden Mittelwert für den Luftdruck angegeben werden. Der gleitende Mittelwert wird mit den Werten des normalen Mittelwerts berechnet. Es gibt keinen gleitenden Mittelwert für die Temperatur.

Die maximale Länge des Luftdruckmittelwerts ist 10, des Temperaturmittelwerts 255 und des gleitenden Mittelwertes 25.

Wenn alle drei Parameter auf 0 gesetzt werden, ist das Averaging komplett aus. In diesem Fall gibt es viel Rauschen auf den Daten, allerdings sind die Daten dann ohne Verzögerung. Wir empfehlen das Averaging auszustellen wenn die Daten des Barometer Bricklets zusammen mit anderen Sensordaten fusioniert werden sollen.

Der Standardwert ist 10 für die normalen Mittelwerte und 25 für den gleitenden Mittelwert

Neu in Version 2.0.1 (Plugin).

array BrickletBarometer::getAveraging()

Gibt die Averaging-Konfiguration zurück, wie von setAveraging() gesetzt.

Neu in Version 2.0.1 (Plugin).

Das zurückgegebene Array enthält die Keys moving_average_pressure, average_pressure und average_temperature.

array BrickletBarometer::getAPIVersion()

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 BrickletBarometer::getResponseExpected(int $function_id)

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:

  • BrickletBarometer::FUNCTION_SET_AIR_PRESSURE_CALLBACK_PERIOD = 3
  • BrickletBarometer::FUNCTION_SET_ALTITUDE_CALLBACK_PERIOD = 5
  • BrickletBarometer::FUNCTION_SET_AIR_PRESSURE_CALLBACK_THRESHOLD = 7
  • BrickletBarometer::FUNCTION_SET_ALTITUDE_CALLBACK_THRESHOLD = 9
  • BrickletBarometer::FUNCTION_SET_DEBOUNCE_PERIOD = 11
  • BrickletBarometer::FUNCTION_SET_REFERENCE_AIR_PRESSURE = 13
  • BrickletBarometer::FUNCTION_SET_AVERAGING = 20
void BrickletBarometer::setResponseExpected(int $function_id, bool $response_expected)

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

  • BrickletBarometer::FUNCTION_SET_AIR_PRESSURE_CALLBACK_PERIOD = 3
  • BrickletBarometer::FUNCTION_SET_ALTITUDE_CALLBACK_PERIOD = 5
  • BrickletBarometer::FUNCTION_SET_AIR_PRESSURE_CALLBACK_THRESHOLD = 7
  • BrickletBarometer::FUNCTION_SET_ALTITUDE_CALLBACK_THRESHOLD = 9
  • BrickletBarometer::FUNCTION_SET_DEBOUNCE_PERIOD = 11
  • BrickletBarometer::FUNCTION_SET_REFERENCE_AIR_PRESSURE = 13
  • BrickletBarometer::FUNCTION_SET_AVERAGING = 20
void BrickletBarometer::setResponseExpectedAll(bool $response_expected)

Ändert das Response-Expected-Flag für alle Setter-Funktionen und Konfigurationsfunktionen für Callbacks diese Gerätes.

array BrickletBarometer::getIdentity()

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.

Das zurückgegebene Array enthält die Keys uid, connected_uid, position, hardware_version, firmware_version und device_identifier.

Konfigurationsfunktionen für Callbacks

void BrickletBarometer::registerCallback(int $callback_id, callable $callback, mixed $user_data=NULL)

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 BrickletBarometer::setAirPressureCallbackPeriod(int $period)

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

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

Der Standardwert ist 0.

int BrickletBarometer::getAirPressureCallbackPeriod()

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

void BrickletBarometer::setAltitudeCallbackPeriod(int $period)

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

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

Der Standardwert ist 0.

int BrickletBarometer::getAltitudeCallbackPeriod()

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

void BrickletBarometer::setAirPressureCallbackThreshold(string $option, int $min, int $max)

Setzt den Schwellwert für den CALLBACK_AIR_PRESSURE_REACHED Callback.

Die folgenden Optionen sind möglich:

Option Beschreibung
'x' Callback ist inaktiv
'o' Callback wird ausgelöst, wenn der Luftdruck außerhalb des min und max Wertes ist
'i' Callback wird ausgelöst, wenn der Luftdruck innerhalb des min und max Wertes ist
'<' Callback wird ausgelöst, wenn der Luftdruck kleiner als der min Wert ist (max wird ignoriert)
'>' Callback wird ausgelöst, wenn der Luftdruck 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:

  • BrickletBarometer::THRESHOLD_OPTION_OFF = 'x'
  • BrickletBarometer::THRESHOLD_OPTION_OUTSIDE = 'o'
  • BrickletBarometer::THRESHOLD_OPTION_INSIDE = 'i'
  • BrickletBarometer::THRESHOLD_OPTION_SMALLER = '<'
  • BrickletBarometer::THRESHOLD_OPTION_GREATER = '>'
array BrickletBarometer::getAirPressureCallbackThreshold()

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

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

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

Das zurückgegebene Array enthält die Keys option, min und max.

void BrickletBarometer::setAltitudeCallbackThreshold(string $option, int $min, int $max)

Setzt den Schwellwert für den CALLBACK_ALTITUDE_REACHED Callback.

Die folgenden Optionen sind möglich:

Option Beschreibung
'x' Callback ist inaktiv
'o' Callback wird ausgelöst, wenn die Höhe außerhalb des min und max Wertes ist
'i' Callback wird ausgelöst, wenn die Höhe innerhalb des min und max Wertes ist
'<' Callback wird ausgelöst, wenn die Höhe kleiner als der min Wert ist (max wird ignoriert)
'>' Callback wird ausgelöst, wenn die Höhe 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:

  • BrickletBarometer::THRESHOLD_OPTION_OFF = 'x'
  • BrickletBarometer::THRESHOLD_OPTION_OUTSIDE = 'o'
  • BrickletBarometer::THRESHOLD_OPTION_INSIDE = 'i'
  • BrickletBarometer::THRESHOLD_OPTION_SMALLER = '<'
  • BrickletBarometer::THRESHOLD_OPTION_GREATER = '>'
array BrickletBarometer::getAltitudeCallbackThreshold()

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

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

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

Das zurückgegebene Array enthält die Keys option, min und max.

void BrickletBarometer::setDebouncePeriod(int $debounce)

Setzt die Periode in ms mit welcher die Schwellwert Callbacks

ausgelöst werden, wenn die Schwellwerte

weiterhin erreicht bleiben.

Der Standardwert ist 100.

int BrickletBarometer::getDebouncePeriod()

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";
}

$barometer->registerCallback(BrickletBarometer::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 BrickletBarometer::CALLBACK_AIR_PRESSURE
<?php   void callback(int $air_pressure [, mixed $user_data])   ?>

Dieser Callback wird mit der Periode, wie gesetzt mit setAirPressureCallbackPeriod(), ausgelöst. Der Parameter ist der Luftdruck des Luftdrucksensors.

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

int BrickletBarometer::CALLBACK_ALTITUDE
<?php   void callback(int $altitude [, mixed $user_data])   ?>

Dieser Callback wird mit der Periode, wie gesetzt mit setAltitudeCallbackPeriod(), ausgelöst. Der Parameter ist die Höhe des Luftdrucksensors.

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

int BrickletBarometer::CALLBACK_AIR_PRESSURE_REACHED
<?php   void callback(int $air_pressure [, mixed $user_data])   ?>

Dieser Callback wird ausgelöst, wenn der Schwellwert, wie von setAirPressureCallbackThreshold() gesetzt, erreicht wird. Der Parameter ist der Luftdruck des Luftdrucksensors.

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

int BrickletBarometer::CALLBACK_ALTITUDE_REACHED
<?php   void callback(int $altitude [, mixed $user_data])   ?>

Dieser Callback wird ausgelöst, wenn der Schwellwert, wie von setAltitudeCallbackThreshold() gesetzt, erreicht wird. Der Parameter ist die Höhe des Luftdrucksensors.

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

Konstanten

int BrickletBarometer::DEVICE_IDENTIFIER

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

Diese Konstante stellt den Anzeigenamen eines Barometer Bricklet dar.