PHP - Barometer Bricklet 2.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/BrickletBarometerV2.php');

use Tinkerforge\IPConnection;
use Tinkerforge\BrickletBarometerV2;

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

$ipcon = new IPConnection(); // Create IP connection
$b = new BrickletBarometerV2(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 . " hPa\n";

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

<?php

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

use Tinkerforge\IPConnection;
use Tinkerforge\BrickletBarometerV2;

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

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

$ipcon = new IPConnection(); // Create IP connection
$b = new BrickletBarometerV2(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(BrickletBarometerV2::CALLBACK_AIR_PRESSURE, 'cb_airPressure');

// Set period for air pressure callback to 1s (1000ms) without a threshold
$b->setAirPressureCallbackConfiguration(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/BrickletBarometerV2.php');

use Tinkerforge\IPConnection;
use Tinkerforge\BrickletBarometerV2;

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

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

$ipcon = new IPConnection(); // Create IP connection
$b = new BrickletBarometerV2(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(BrickletBarometerV2::CALLBACK_AIR_PRESSURE, 'cb_airPressure');

// Configure threshold for air pressure "greater than 1025 hPa"
// with a debounce period of 1s (1000ms)
$b->setAirPressureCallbackConfiguration(1000, FALSE, '>', 1025*1000, 0);

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

?>

Grundfunktionen¶

class BrickletBarometerV2(string $uid, IPConnection $ipcon)¶

Parameter:	$uid – Typ: string $ipcon – Typ: IPConnection
Rückgabe:	$barometer_v2 – Typ: BrickletBarometerV2

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

<?php   $barometer_v2 = new BrickletBarometerV2('YOUR_DEVICE_UID', $ipcon);   ?>

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

int BrickletBarometerV2::getAirPressure()¶

Rückgabe:	$air_pressure – Typ: int, Einheit: 1/1000 hPa, Wertebereich: [260000 bis 1260000]

Gibt den Luftdruck des Luftdrucksensors zurück.

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

int BrickletBarometerV2::getAltitude()¶

Rückgabe:	$altitude – Typ: int, Einheit: 1 mm, Wertebereich: [-231 bis 231 - 1]

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

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

int BrickletBarometerV2::getTemperature()¶

Rückgabe:	$temperature – Typ: int, Einheit: 1/100 °C, Wertebereich: [-4000 bis 8500]

Gibt die Temperatur des Luftdrucksensors zurück.

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

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

void BrickletBarometerV2::setMovingAverageConfiguration(int $moving_average_length_air_pressure, int $moving_average_length_temperature)¶

Parameter:	$moving_average_length_air_pressure – Typ: int, Wertebereich: [1 bis 1000], Standardwert: 100 $moving_average_length_temperature – Typ: int, Wertebereich: [1 bis 1000], Standardwert: 100

Setzt die Länge eines gleitenden Mittelwerts für die Luftdruck- und Temperaturmessung.

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.

Bei Langzeitmessungen gibt ein langer Mittelwert die saubersten Resultate.

array BrickletBarometerV2::getMovingAverageConfiguration()¶

Rückgabe-Array:	'moving_average_length_air_pressure' – Typ: int, Wertebereich: [1 bis 1000], Standardwert: 100 'moving_average_length_temperature' – Typ: int, Wertebereich: [1 bis 1000], Standardwert: 100

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

void BrickletBarometerV2::setReferenceAirPressure(int $air_pressure)¶

Parameter:	$air_pressure – Typ: int, Einheit: 1/1000 hPa, Wertebereich: [0, 260000 bis 1260000], Standardwert: 1013250

Setzt den Referenzluftdruck für die Höhenberechnung. Wenn der aktuelle Luftdruckwert als Referenz übergeben wird dann gibt die Höhenberechnung 0mm 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.

int BrickletBarometerV2::getReferenceAirPressure()¶

Rückgabe:	$air_pressure – Typ: int, Einheit: 1/1000 hPa, Wertebereich: [260000 bis 1260000], Standardwert: 1013250

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

Fortgeschrittene Funktionen¶

void BrickletBarometerV2::setCalibration(int $measured_air_pressure, int $actual_air_pressure)¶

Parameter:	$measured_air_pressure – Typ: int, Einheit: 1/1000 hPa, Wertebereich: [0, 260000 bis 1260000] $actual_air_pressure – Typ: int, Einheit: 1/1000 hPa, Wertebereich: [0, 260000 bis 1260000]

Setzt den One Point Calibration (OPC) Werte für die Luftdruckmessung.

Bevor das Bricklet kalibriert werden kann muss die möglicherweise vorhandene Kalibierung gelöschet werden, dazu muss Measured Air Pressure und Actual Air Pressure auf 0 gesetzt werden.

Dann muss der aktuelle Luftdruck gleichzeitig mit dem Bricklet (Measured Air Pressure) und einem genauen Referenzbarometer (Actual Air Pressure) gemessen und die Werte an diese Funktion übergeben werden.

Nach einer ordentlichen Kalibrierung kann der Luftdruck mit bis zu 0,2 hPa Genauigkeit gemessen werden

Die Kalibrierung wird im EEPROM des Bricklets gespeichert und muss nur einmal gesetzt werden.

array BrickletBarometerV2::getCalibration()¶

Rückgabe-Array:	'measured_air_pressure' – Typ: int, Einheit: 1/1000 hPa, Wertebereich: [0, 260000 bis 1260000] 'actual_air_pressure' – Typ: int, Einheit: 1/1000 hPa, Wertebereich: [0, 260000 bis 1260000]

Gibt die Luftdruck One Point Calibration Werte zurück, wie von setCalibration() gesetzt.

void BrickletBarometerV2::setSensorConfiguration(int $data_rate, int $air_pressure_low_pass_filter)¶

Parameter:	$data_rate – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 4 $air_pressure_low_pass_filter – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 1

Konfiguriert die Datenrate und den Luftdrucktiefpassfilter. Die Grenzfrequenz des Tiefpassfilters (falls aktiviert) kann auf 1/9 oder 1/20 der eingestellten Datenrate gesetzt werden, um das Rauschen auf den Luftdruckdaten zu verringert.

Die Tiefpassfiltereinstellung gilt nur für die Luftdruckmessung. Es gibt keinen Tiefpassfilter für die Temperaturmessung.

Eine Verringerung der Datenrate oder des Wertebereichs verringert auch automatisch das Rauschen auf den Daten. Eine hohe Datenrate erhöht zusätzlich die Selbsterhitzung des Sensors. Wenn eine hohe Temperaturgenauigkeit wichtig ist empfehlen wir eine Datenrate von 1Hz.

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

Für $data_rate:

• BrickletBarometerV2::DATA_RATE_OFF = 0
• BrickletBarometerV2::DATA_RATE_1HZ = 1
• BrickletBarometerV2::DATA_RATE_10HZ = 2
• BrickletBarometerV2::DATA_RATE_25HZ = 3
• BrickletBarometerV2::DATA_RATE_50HZ = 4
• BrickletBarometerV2::DATA_RATE_75HZ = 5

Für $air_pressure_low_pass_filter:

• BrickletBarometerV2::LOW_PASS_FILTER_OFF = 0
• BrickletBarometerV2::LOW_PASS_FILTER_1_9TH = 1
• BrickletBarometerV2::LOW_PASS_FILTER_1_20TH = 2

array BrickletBarometerV2::getSensorConfiguration()¶

Rückgabe-Array:	'data_rate' – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 4 'air_pressure_low_pass_filter' – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 1

Gibt die Sensor-Konfiguration zurück, wie von setSensorConfiguration() gesetzt.

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

Für $data_rate:

• BrickletBarometerV2::DATA_RATE_OFF = 0
• BrickletBarometerV2::DATA_RATE_1HZ = 1
• BrickletBarometerV2::DATA_RATE_10HZ = 2
• BrickletBarometerV2::DATA_RATE_25HZ = 3
• BrickletBarometerV2::DATA_RATE_50HZ = 4
• BrickletBarometerV2::DATA_RATE_75HZ = 5

Für $air_pressure_low_pass_filter:

• BrickletBarometerV2::LOW_PASS_FILTER_OFF = 0
• BrickletBarometerV2::LOW_PASS_FILTER_1_9TH = 1
• BrickletBarometerV2::LOW_PASS_FILTER_1_20TH = 2

array BrickletBarometerV2::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.

void BrickletBarometerV2::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:

• BrickletBarometerV2::STATUS_LED_CONFIG_OFF = 0
• BrickletBarometerV2::STATUS_LED_CONFIG_ON = 1
• BrickletBarometerV2::STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
• BrickletBarometerV2::STATUS_LED_CONFIG_SHOW_STATUS = 3

int BrickletBarometerV2::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:

• BrickletBarometerV2::STATUS_LED_CONFIG_OFF = 0
• BrickletBarometerV2::STATUS_LED_CONFIG_ON = 1
• BrickletBarometerV2::STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
• BrickletBarometerV2::STATUS_LED_CONFIG_SHOW_STATUS = 3

int BrickletBarometerV2::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 BrickletBarometerV2::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.

array BrickletBarometerV2::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', '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 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 BrickletBarometerV2::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 BrickletBarometerV2::setAirPressureCallbackConfiguration(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/1000 hPa, Wertebereich: [-231 bis 231 - 1], Standardwert: 0 $max – Typ: int, Einheit: 1/1000 hPa, Wertebereich: [-231 bis 231 - 1], Standardwert: 0

Die Periode ist die Periode mit der der CALLBACK_AIR_PRESSURE 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_AIR_PRESSURE 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:

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

array BrickletBarometerV2::getAirPressureCallbackConfiguration()¶

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/1000 hPa, Wertebereich: [-231 bis 231 - 1], Standardwert: 0 'max' – Typ: int, Einheit: 1/1000 hPa, Wertebereich: [-231 bis 231 - 1], Standardwert: 0

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

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

Für $option:

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

void BrickletBarometerV2::setAltitudeCallbackConfiguration(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 mm, Wertebereich: [-231 bis 231 - 1], Standardwert: 0 $max – Typ: int, Einheit: 1 mm, Wertebereich: [-231 bis 231 - 1], Standardwert: 0

Die Periode ist die Periode mit der der CALLBACK_ALTITUDE 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_ALTITUDE 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:

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

array BrickletBarometerV2::getAltitudeCallbackConfiguration()¶

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 mm, Wertebereich: [-231 bis 231 - 1], Standardwert: 0 'max' – Typ: int, Einheit: 1 mm, Wertebereich: [-231 bis 231 - 1], Standardwert: 0

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

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

Für $option:

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

void BrickletBarometerV2::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: [-231 bis 231 - 1], Standardwert: 0 $max – Typ: int, Einheit: 1/100 °C, Wertebereich: [-231 bis 231 - 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:

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

array BrickletBarometerV2::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: [-231 bis 231 - 1], Standardwert: 0 'max' – Typ: int, Einheit: 1/100 °C, Wertebereich: [-231 bis 231 - 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:

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

$barometer_v2->registerCallback(BrickletBarometerV2::CALLBACK_EXAMPLE, 'myCallback');

?>

Die verfügbaren IDs mit den dazugehörigen Funktionssignaturen werden weiter unten beschrieben.

int BrickletBarometerV2::CALLBACK_AIR_PRESSURE¶

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

Callback-Parameter:	$air_pressure – Typ: int, Einheit: 1/1000 hPa, Wertebereich: [260000 bis 1260000] $user_data – Typ: mixed

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

Der Parameter ist der gleiche wie getAirPressure().

int BrickletBarometerV2::CALLBACK_ALTITUDE¶

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

Callback-Parameter:	$altitude – Typ: int, Einheit: 1 mm, Wertebereich: [-231 bis 231 - 1] $user_data – Typ: mixed

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

Der Parameter ist der gleiche wie getAltitude().

int BrickletBarometerV2::CALLBACK_TEMPERATURE¶

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

Callback-Parameter:	$temperature – Typ: int, Einheit: 1/100 °C, Wertebereich: [-4000 bis 8500] $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 BrickletBarometerV2::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 BrickletBarometerV2::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:

• BrickletBarometerV2::FUNCTION_SET_AIR_PRESSURE_CALLBACK_CONFIGURATION = 2
• BrickletBarometerV2::FUNCTION_SET_ALTITUDE_CALLBACK_CONFIGURATION = 6
• BrickletBarometerV2::FUNCTION_SET_TEMPERATURE_CALLBACK_CONFIGURATION = 10
• BrickletBarometerV2::FUNCTION_SET_MOVING_AVERAGE_CONFIGURATION = 13
• BrickletBarometerV2::FUNCTION_SET_REFERENCE_AIR_PRESSURE = 15
• BrickletBarometerV2::FUNCTION_SET_CALIBRATION = 17
• BrickletBarometerV2::FUNCTION_SET_SENSOR_CONFIGURATION = 19
• BrickletBarometerV2::FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
• BrickletBarometerV2::FUNCTION_SET_STATUS_LED_CONFIG = 239
• BrickletBarometerV2::FUNCTION_RESET = 243
• BrickletBarometerV2::FUNCTION_WRITE_UID = 248

void BrickletBarometerV2::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:

• BrickletBarometerV2::FUNCTION_SET_AIR_PRESSURE_CALLBACK_CONFIGURATION = 2
• BrickletBarometerV2::FUNCTION_SET_ALTITUDE_CALLBACK_CONFIGURATION = 6
• BrickletBarometerV2::FUNCTION_SET_TEMPERATURE_CALLBACK_CONFIGURATION = 10
• BrickletBarometerV2::FUNCTION_SET_MOVING_AVERAGE_CONFIGURATION = 13
• BrickletBarometerV2::FUNCTION_SET_REFERENCE_AIR_PRESSURE = 15
• BrickletBarometerV2::FUNCTION_SET_CALIBRATION = 17
• BrickletBarometerV2::FUNCTION_SET_SENSOR_CONFIGURATION = 19
• BrickletBarometerV2::FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
• BrickletBarometerV2::FUNCTION_SET_STATUS_LED_CONFIG = 239
• BrickletBarometerV2::FUNCTION_RESET = 243
• BrickletBarometerV2::FUNCTION_WRITE_UID = 248

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

Interne Funktionen¶

Interne Funktionen werden für Wartungsaufgaben, wie zum Beispiel das Flashen einer neuen Firmware oder das Ändern der UID eines Bricklets, verwendet. Diese Aufgaben sollten mit Brick Viewer durchgeführt werden, anstelle die internen Funktionen direkt zu verwenden.

int BrickletBarometerV2::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:

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

Für $status:

• BrickletBarometerV2::BOOTLOADER_STATUS_OK = 0
• BrickletBarometerV2::BOOTLOADER_STATUS_INVALID_MODE = 1
• BrickletBarometerV2::BOOTLOADER_STATUS_NO_CHANGE = 2
• BrickletBarometerV2::BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT = 3
• BrickletBarometerV2::BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT = 4
• BrickletBarometerV2::BOOTLOADER_STATUS_CRC_MISMATCH = 5

int BrickletBarometerV2::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:

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

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

Konstanten¶

int BrickletBarometerV2::DEVICE_IDENTIFIER¶

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

Diese Konstante stellt den Anzeigenamen eines Barometer Bricklet 2.0 dar.