PHP - CO2 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

<?php

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

use Tinkerforge\IPConnection;
use Tinkerforge\BrickletCO2V2;

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

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

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

// Get current all values
$all_values = $co2->getAllValues();

echo "CO2 Concentration: " . $all_values['co2_concentration'] . " ppm\n";
echo "Temperature: " . $all_values['temperature']/100.0 . " °C\n";
echo "Humidity: " . $all_values['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
35
36
37

<?php

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

use Tinkerforge\IPConnection;
use Tinkerforge\BrickletCO2V2;

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

// Callback function for all values callback
function cb_allValues($co2_concentration, $temperature, $humidity)
{
    echo "CO2 Concentration: $co2_concentration ppm\n";
    echo "Temperature: " . $temperature/100.0 . " °C\n";
    echo "Humidity: " . $humidity/100.0 . " %RH\n";
    echo "\n";
}

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

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

// Register all values callback to function cb_allValues
$co2->registerCallback(BrickletCO2V2::CALLBACK_ALL_VALUES, 'cb_allValues');

// Set period for all values callback to 1s (1000ms)
$co2->setAllValuesCallbackConfiguration(1000, FALSE);

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

?>

Grundfunktionen¶

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

Parameter:	$uid – Typ: string $ipcon – Typ: IPConnection
Rückgabe:	$co2_v2 – Typ: BrickletCO2V2

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

<?php   $co2_v2 = new BrickletCO2V2('YOUR_DEVICE_UID', $ipcon);   ?>

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

array BrickletCO2V2::getAllValues()¶

Rückgabe-Array:	'co2_concentration' – Typ: int, Einheit: 1 ppm, Wertebereich: [0 bis 40000] 'temperature' – Typ: int, Einheit: 1/100 °C, Wertebereich: [-4000 bis 12000] 'humidity' – Typ: int, Einheit: 1/100 %, Wertebereich: [0 bis 10000]

Gibt alle Werte zurück, die das CO2 Bricklet 2.0 misst.

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

Bemerkung

Der Sensor kann bis zu 120 °C messen, ist aber nur bis 70 °C spezifiziert. Das Bricklet kann permanent beschädigt werden, falls es höheren Temperaturen ausgesetzt wird.

void BrickletCO2V2::setAirPressure(int $air_pressure)¶

Parameter:	$air_pressure – Typ: int, Einheit: 1 hPa, Wertebereich: [0, 700 bis 1200], Standardwert: 0

Die CO2-Konzentration hängt (unter anderem) vom Umgebungs-Luftdruck ab.

Um die Genauigkeit des CO2 Bricklet 2.0 zu verbessern ist es möglich den aktuellen Luftdruck zu setzen. Dazu kann das Barometer Bricklet 2.0 oder auch das Air Quality Bricklet genutzt werden.

Standardmäßig ist die Luftdruck-Kompensation deaktiviert. Sobald ein Wert gesetzt wird, wird dieser zur Kompensation verwendet. Die Kompensation kann wieder ausgestellt werden in dem der Wert zurück auf 0 gesetzt wird.

Es ist hinreichend den Wert alle paar Minuten zu aktualisieren.

int BrickletCO2V2::getAirPressure()¶

Rückgabe:	$air_pressure – Typ: int, Einheit: 1 hPa, Wertebereich: [0, 700 bis 1200], Standardwert: 0

Gibt den Umgebungs-Luftdruch zurück, wie von setAirPressure() gesetzt.

void BrickletCO2V2::setTemperatureOffset(int $offset)¶

Parameter:	$offset – Typ: int, Einheit: 1/100 °C, Wertebereich: [0 bis 216 - 1]

Setzt ein Temperatur-Offset. Ein Offset von 10 verringert die gemessene Temperatur um 0,1 °C.

Wenn das Bricklet in einem Gehäuse verbaut wird, aber die Umgebungstemperatur außerhalb des Gehäuses gemessen werden soll, dann muss vom gemessenen Temperatur ein bestimmter Wert abgezogen werden, um den Messfehler durch das Aufheizen des Gehäuses zu kompensieren.

Wir empfehlen den Messaufbau im Gehäuse mindestens 24 Stunden laufen zu lassen, damit sich ein Temperaturgleichgewicht einstellt. Danach muss die Temperatur außerhalb des Gehäuses gemessen werden und die Differenz zur Temperatur innerhalb des Gehäuses als Offset eingestellt werden.

Dieses Temperatur-Offset geht in die Berechnung der Luftfeuchte und der CO2-Konzentration mit ein. Um die Genauigkeit der Messwerte innerhalb eines Gehäuses zu verbessern sollte der Temperatur-Offset bestimmt und eingestellt werden.

Es ist hinreichend den Temperatur-Offset einmal zu setzen. Der Offset wird in einem nicht-flüchtigen Speicher gespeichert und auch nach einem Neustart wieder angewendet.

int BrickletCO2V2::getTemperatureOffset()¶

Rückgabe:	$offset – Typ: int, Einheit: 1/100 °C, Wertebereich: [0 bis 216 - 1]

Gibt das Temperatur-Offset zurück, wie mittels setTemperatureOffset() gesetzt.

int BrickletCO2V2::getCO2Concentration()¶

Rückgabe:	$co2_concentration – Typ: int, Einheit: 1 ppm, Wertebereich: [0 bis 40000]

Gibt die CO2-Konzentration zurück.

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

int BrickletCO2V2::getTemperature()¶

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

Gibt die Temperatur zurück.

Bemerkung

Der Sensor kann bis zu 120 °C messen, ist aber nur bis 70 °C spezifiziert. Das Bricklet kann permanent beschädigt werden, falls es höheren Temperaturen ausgesetzt wird.

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

int BrickletCO2V2::getHumidity()¶

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

Gibt die relative Luftfeuchtigkeit 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.

Fortgeschrittene Funktionen¶

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

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

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

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

int BrickletCO2V2::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 BrickletCO2V2::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 BrickletCO2V2::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 BrickletCO2V2::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 BrickletCO2V2::setAllValuesCallbackConfiguration(int $period, bool $value_has_to_change)¶

Parameter:	$period – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0 $value_has_to_change – Typ: bool, Standardwert: FALSE

Die Periode ist die Periode mit der der CALLBACK_ALL_VALUES 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 sich mindestens ein Wert im Vergleich zum letzten mal geändert hat. Ändert sich kein Wert innerhalb der Periode, so wird der Callback sofort ausgelöst, wenn ein 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 der Werte.

array BrickletCO2V2::getAllValuesCallbackConfiguration()¶

Rückgabe-Array:	'period' – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0 'value_has_to_change' – Typ: bool, Standardwert: FALSE

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

void BrickletCO2V2::setCO2ConcentrationCallbackConfiguration(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 ppm, Wertebereich: [0 bis 216 - 1], Standardwert: 0 $max – Typ: int, Einheit: 1 ppm, Wertebereich: [0 bis 216 - 1], Standardwert: 0

Die Periode ist die Periode mit der der CALLBACK_CO2_CONCENTRATION 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_CO2_CONCENTRATION 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:

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

array BrickletCO2V2::getCO2ConcentrationCallbackConfiguration()¶

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

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

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

Für $option:

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

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

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

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

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

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

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

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

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

$co2_v2->registerCallback(BrickletCO2V2::CALLBACK_EXAMPLE, 'myCallback');

?>

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

int BrickletCO2V2::CALLBACK_ALL_VALUES¶

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

Callback-Parameter:	$co2_concentration – Typ: int, Einheit: 1 ppm, Wertebereich: [0 bis 40000] $temperature – Typ: int, Einheit: 1/100 °C, Wertebereich: [-4000 bis 12000] $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 setAllValuesCallbackConfiguration() gesetzten Konfiguration

Die Parameter sind die gleichen wie getAllValues().

Bemerkung

Der Sensor kann bis zu 120 °C messen, ist aber nur bis 70 °C spezifiziert. Das Bricklet kann permanent beschädigt werden, falls es höheren Temperaturen ausgesetzt wird.

int BrickletCO2V2::CALLBACK_CO2_CONCENTRATION¶

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

Callback-Parameter:	$co2_concentration – Typ: int, Einheit: 1 ppm, Wertebereich: [0 bis 40000] $user_data – Typ: mixed

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

Der Parameter ist der gleiche wie getCO2Concentration().

int BrickletCO2V2::CALLBACK_TEMPERATURE¶

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

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

int BrickletCO2V2::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().

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

• BrickletCO2V2::FUNCTION_SET_AIR_PRESSURE = 2
• BrickletCO2V2::FUNCTION_SET_TEMPERATURE_OFFSET = 4
• BrickletCO2V2::FUNCTION_SET_ALL_VALUES_CALLBACK_CONFIGURATION = 6
• BrickletCO2V2::FUNCTION_SET_CO2_CONCENTRATION_CALLBACK_CONFIGURATION = 10
• BrickletCO2V2::FUNCTION_SET_TEMPERATURE_CALLBACK_CONFIGURATION = 14
• BrickletCO2V2::FUNCTION_SET_HUMIDITY_CALLBACK_CONFIGURATION = 18
• BrickletCO2V2::FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
• BrickletCO2V2::FUNCTION_SET_STATUS_LED_CONFIG = 239
• BrickletCO2V2::FUNCTION_RESET = 243
• BrickletCO2V2::FUNCTION_WRITE_UID = 248

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

• BrickletCO2V2::FUNCTION_SET_AIR_PRESSURE = 2
• BrickletCO2V2::FUNCTION_SET_TEMPERATURE_OFFSET = 4
• BrickletCO2V2::FUNCTION_SET_ALL_VALUES_CALLBACK_CONFIGURATION = 6
• BrickletCO2V2::FUNCTION_SET_CO2_CONCENTRATION_CALLBACK_CONFIGURATION = 10
• BrickletCO2V2::FUNCTION_SET_TEMPERATURE_CALLBACK_CONFIGURATION = 14
• BrickletCO2V2::FUNCTION_SET_HUMIDITY_CALLBACK_CONFIGURATION = 18
• BrickletCO2V2::FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
• BrickletCO2V2::FUNCTION_SET_STATUS_LED_CONFIG = 239
• BrickletCO2V2::FUNCTION_RESET = 243
• BrickletCO2V2::FUNCTION_WRITE_UID = 248

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

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

Für $status:

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

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

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

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

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

Diese Konstante stellt den Anzeigenamen eines CO2 Bricklet 2.0 dar.