PHP - Air Quality Bricklet

This is the description of the PHP API bindings for the Air Quality Bricklet. General information and technical specifications for the Air Quality Bricklet are summarized in its hardware description.

An installation guide for the PHP API bindings is part of their general description.

Examples

The example code below is 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
32
33
34
35
36
37
38
39
40
41
42
<?php

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

use Tinkerforge\IPConnection;
use Tinkerforge\BrickletAirQuality;

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

$ipcon = new IPConnection(); // Create IP connection
$aq = new BrickletAirQuality(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 = $aq->getAllValues();

echo "IAQ Index: " . $all_values['iaq_index'] . "\n";

if ($all_values['iaq_index_accuracy'] == BrickletAirQuality::ACCURACY_UNRELIABLE) {
    echo "IAQ Index Accuracy: Unreliable\n";
} elseif ($all_values['iaq_index_accuracy'] == BrickletAirQuality::ACCURACY_LOW) {
    echo "IAQ Index Accuracy: Low\n";
} elseif ($all_values['iaq_index_accuracy'] == BrickletAirQuality::ACCURACY_MEDIUM) {
    echo "IAQ Index Accuracy: Medium\n";
} elseif ($all_values['iaq_index_accuracy'] == BrickletAirQuality::ACCURACY_HIGH) {
    echo "IAQ Index Accuracy: High\n";
}

echo "Temperature: " . $all_values['temperature']/100.0 . " °C\n";
echo "Humidity: " . $all_values['humidity']/100.0 . " %RH\n";
echo "Air Pressure: " . $all_values['air_pressure']/100.0 . " mbar\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
38
39
40
41
42
43
44
45
46
47
48
49
50
<?php

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

use Tinkerforge\IPConnection;
use Tinkerforge\BrickletAirQuality;

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

// Callback function for all values callback
function cb_allValues($iaq_index, $iaq_index_accuracy, $temperature, $humidity,
                      $air_pressure)
{
    echo "IAQ Index: $iaq_index\n";

    if ($iaq_index_accuracy == BrickletAirQuality::ACCURACY_UNRELIABLE) {
        echo "IAQ Index Accuracy: Unreliable\n";
    } elseif ($iaq_index_accuracy == BrickletAirQuality::ACCURACY_LOW) {
        echo "IAQ Index Accuracy: Low\n";
    } elseif ($iaq_index_accuracy == BrickletAirQuality::ACCURACY_MEDIUM) {
        echo "IAQ Index Accuracy: Medium\n";
    } elseif ($iaq_index_accuracy == BrickletAirQuality::ACCURACY_HIGH) {
        echo "IAQ Index Accuracy: High\n";
    }

    echo "Temperature: " . $temperature/100.0 . " °C\n";
    echo "Humidity: " . $humidity/100.0 . " %RH\n";
    echo "Air Pressure: " . $air_pressure/100.0 . " mbar\n";
    echo "\n";
}

$ipcon = new IPConnection(); // Create IP connection
$aq = new BrickletAirQuality(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
$aq->registerCallback(BrickletAirQuality::CALLBACK_ALL_VALUES, 'cb_allValues');

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

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

?>

API

Functions that return multiple values return them in an associative array.

Basic Functions

class BrickletAirQuality(string $uid, IPConnection $ipcon)

Creates an object with the unique device ID $uid:

<?php   $air_quality = new BrickletAirQuality('YOUR_DEVICE_UID', $ipcon);   ?>

This object can then be used after the IP Connection is connected (see examples above).

array BrickletAirQuality::getAllValues()

Returns all values measured by the Air Quality Bricklet. The values are IAQ (Indoor Air Quality) Index, IAQ Index Accuracy, Temperature, Humidity and Air Pressure.

Air Quality Index description

The values have these ranges and units:

  • IAQ Index: 0 to 500, higher value means greater level of air pollution
  • IAQ Index Accuracy: 0 = unreliable to 3 = high
  • Temperature: in steps of 0.01 °C
  • Humidity: in steps of 0.01 %RH
  • Air Pressure: in steps of 0.01 mbar

The following constants are available for this function:

  • BrickletAirQuality::ACCURACY_UNRELIABLE = 0
  • BrickletAirQuality::ACCURACY_LOW = 1
  • BrickletAirQuality::ACCURACY_MEDIUM = 2
  • BrickletAirQuality::ACCURACY_HIGH = 3

The returned array has the keys iaq_index, iaq_index_accuracy, temperature, humidity and air_pressure.

void BrickletAirQuality::setTemperatureOffset(int $offset)

Sets a temperature offset in 1/100°C. A offset of 10 will decrease the measured temperature by 0.1°C.

If you install this Bricklet into an enclosure and you want to measure the ambient temperature, you may have to decrease the measured temperature by some value to compensate for the error because of the heating inside of the enclosure.

We recommend that you leave the parts in the enclosure running for at least 24 hours such that a temperature equilibrium can be reached. After that you can measure the temperature directly outside of enclosure and set the difference as offset.

This temperature offset is used to calculate the relative humidity and IAQ index measurements. In case the Bricklet is installed in an enclosure, we recommend to measure and set the temperature offset to imporve the accuracy of the measurements.

int BrickletAirQuality::getTemperatureOffset()

Returns the temperature offset as set by setTemperatureOffset().

array BrickletAirQuality::getIAQIndex()

Returns the IAQ index and accuracy. The IAQ index goes from 0 to 500. The higher the IAQ index, the greater the level of air pollution.

IAQ index description

If you want to get the value periodically, it is recommended to use the CALLBACK_IAQ_INDEX callback. You can set the callback configuration with setIAQIndexCallbackConfiguration().

The following constants are available for this function:

  • BrickletAirQuality::ACCURACY_UNRELIABLE = 0
  • BrickletAirQuality::ACCURACY_LOW = 1
  • BrickletAirQuality::ACCURACY_MEDIUM = 2
  • BrickletAirQuality::ACCURACY_HIGH = 3

The returned array has the keys iaq_index and iaq_index_accuracy.

int BrickletAirQuality::getTemperature()

Returns temperature in steps of 0.01 °C.

If you want to get the value periodically, it is recommended to use the CALLBACK_TEMPERATURE callback. You can set the callback configuration with setTemperatureCallbackConfiguration().

int BrickletAirQuality::getHumidity()

Returns relative humidity in steps of 0.01 %RH.

If you want to get the value periodically, it is recommended to use the CALLBACK_HUMIDITY callback. You can set the callback configuration with setHumidityCallbackConfiguration().

int BrickletAirQuality::getAirPressure()

Returns air pressure in steps of 0.01 mbar.

If you want to get the value periodically, it is recommended to use the CALLBACK_AIR_PRESSURE callback. You can set the callback configuration with setAirPressureCallbackConfiguration().

Advanced Functions

array BrickletAirQuality::getAPIVersion()

Returns the version of the API definition (major, minor, revision) implemented by this API bindings. This is neither the release version of this API bindings nor does it tell you anything about the represented Brick or Bricklet.

bool BrickletAirQuality::getResponseExpected(int $function_id)

Returns the response expected flag for the function specified by the function ID parameter. It is true if the function is expected to send a response, false otherwise.

For getter functions this is enabled by default and cannot be disabled, because those functions will always send a response. For callback configuration functions it is enabled by default too, but can be disabled by setResponseExpected(). For setter functions it is disabled by default and can be enabled.

Enabling the response expected flag for a setter function allows to detect timeouts and other error conditions calls of this setter as well. The device will then send a response for this purpose. If this flag is disabled for a setter function then no response is send and errors are silently ignored, because they cannot be detected.

See setResponseExpected() for the list of function ID constants available for this function.

void BrickletAirQuality::setResponseExpected(int $function_id, bool $response_expected)

Changes the response expected flag of the function specified by the function ID parameter. This flag can only be changed for setter (default value: false) and callback configuration functions (default value: true). For getter functions it is always enabled.

Enabling the response expected flag for a setter function allows to detect timeouts and other error conditions calls of this setter as well. The device will then send a response for this purpose. If this flag is disabled for a setter function then no response is send and errors are silently ignored, because they cannot be detected.

The following function ID constants are available for this function:

  • BrickletAirQuality::FUNCTION_SET_TEMPERATURE_OFFSET = 2
  • BrickletAirQuality::FUNCTION_SET_ALL_VALUES_CALLBACK_CONFIGURATION = 4
  • BrickletAirQuality::FUNCTION_SET_IAQ_INDEX_CALLBACK_CONFIGURATION = 8
  • BrickletAirQuality::FUNCTION_SET_TEMPERATURE_CALLBACK_CONFIGURATION = 12
  • BrickletAirQuality::FUNCTION_SET_HUMIDITY_CALLBACK_CONFIGURATION = 16
  • BrickletAirQuality::FUNCTION_SET_AIR_PRESSURE_CALLBACK_CONFIGURATION = 20
  • BrickletAirQuality::FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
  • BrickletAirQuality::FUNCTION_SET_STATUS_LED_CONFIG = 239
  • BrickletAirQuality::FUNCTION_RESET = 243
  • BrickletAirQuality::FUNCTION_WRITE_UID = 248
void BrickletAirQuality::setResponseExpectedAll(bool $response_expected)

Changes the response expected flag for all setter and callback configuration functions of this device at once.

array BrickletAirQuality::getSPITFPErrorCount()

Returns the error count for the communication between Brick and Bricklet.

The errors are divided into

  • ACK checksum errors,
  • message checksum errors,
  • framing errors and
  • overflow errors.

The errors counts are for errors that occur on the Bricklet side. All Bricks have a similar function that returns the errors on the Brick side.

The returned array has the keys error_count_ack_checksum, error_count_message_checksum, error_count_frame and error_count_overflow.

int BrickletAirQuality::setBootloaderMode(int $mode)

Sets the bootloader mode and returns the status after the requested mode change was instigated.

You can change from bootloader mode to firmware mode and vice versa. A change from bootloader mode to firmware mode will only take place if the entry function, device identifier and CRC are present and correct.

This function is used by Brick Viewer during flashing. It should not be necessary to call it in a normal user program.

The following constants are available for this function:

  • BrickletAirQuality::BOOTLOADER_MODE_BOOTLOADER = 0
  • BrickletAirQuality::BOOTLOADER_MODE_FIRMWARE = 1
  • BrickletAirQuality::BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
  • BrickletAirQuality::BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
  • BrickletAirQuality::BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4
  • BrickletAirQuality::BOOTLOADER_STATUS_OK = 0
  • BrickletAirQuality::BOOTLOADER_STATUS_INVALID_MODE = 1
  • BrickletAirQuality::BOOTLOADER_STATUS_NO_CHANGE = 2
  • BrickletAirQuality::BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT = 3
  • BrickletAirQuality::BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT = 4
  • BrickletAirQuality::BOOTLOADER_STATUS_CRC_MISMATCH = 5
int BrickletAirQuality::getBootloaderMode()

Returns the current bootloader mode, see setBootloaderMode().

The following constants are available for this function:

  • BrickletAirQuality::BOOTLOADER_MODE_BOOTLOADER = 0
  • BrickletAirQuality::BOOTLOADER_MODE_FIRMWARE = 1
  • BrickletAirQuality::BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
  • BrickletAirQuality::BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
  • BrickletAirQuality::BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4
void BrickletAirQuality::setWriteFirmwarePointer(int $pointer)

Sets the firmware pointer for writeFirmware(). The pointer has to be increased by chunks of size 64. The data is written to flash every 4 chunks (which equals to one page of size 256).

This function is used by Brick Viewer during flashing. It should not be necessary to call it in a normal user program.

int BrickletAirQuality::writeFirmware(array $data)

Writes 64 Bytes of firmware at the position as written by setWriteFirmwarePointer() before. The firmware is written to flash every 4 chunks.

You can only write firmware in bootloader mode.

This function is used by Brick Viewer during flashing. It should not be necessary to call it in a normal user program.

void BrickletAirQuality::setStatusLEDConfig(int $config)

Sets the status LED configuration. By default the LED shows communication traffic between Brick and Bricklet, it flickers once for every 10 received data packets.

You can also turn the LED permanently on/off or show a heartbeat.

If the Bricklet is in bootloader mode, the LED is will show heartbeat by default.

The following constants are available for this function:

  • BrickletAirQuality::STATUS_LED_CONFIG_OFF = 0
  • BrickletAirQuality::STATUS_LED_CONFIG_ON = 1
  • BrickletAirQuality::STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • BrickletAirQuality::STATUS_LED_CONFIG_SHOW_STATUS = 3
int BrickletAirQuality::getStatusLEDConfig()

Returns the configuration as set by setStatusLEDConfig()

The following constants are available for this function:

  • BrickletAirQuality::STATUS_LED_CONFIG_OFF = 0
  • BrickletAirQuality::STATUS_LED_CONFIG_ON = 1
  • BrickletAirQuality::STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • BrickletAirQuality::STATUS_LED_CONFIG_SHOW_STATUS = 3
int BrickletAirQuality::getChipTemperature()

Returns the temperature in °C as measured inside the microcontroller. The value returned is not the ambient temperature!

The temperature is only proportional to the real temperature and it has bad accuracy. Practically it is only useful as an indicator for temperature changes.

void BrickletAirQuality::reset()

Calling this function will reset the Bricklet. All configurations will be lost.

After a reset you have to create new device objects, calling functions on the existing ones will result in undefined behavior!

void BrickletAirQuality::writeUID(int $uid)

Writes a new UID into flash. If you want to set a new UID you have to decode the Base58 encoded UID string into an integer first.

We recommend that you use Brick Viewer to change the UID.

int BrickletAirQuality::readUID()

Returns the current UID as an integer. Encode as Base58 to get the usual string version.

array BrickletAirQuality::getIdentity()

Returns the UID, the UID where the Bricklet is connected to, the position, the hardware and firmware version as well as the device identifier.

The position can be 'a', 'b', 'c' or 'd'.

The device identifier numbers can be found here. There is also a constant for the device identifier of this Bricklet.

The returned array has the keys uid, connected_uid, position, hardware_version, firmware_version and device_identifier.

Callback Configuration Functions

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

Registers the given $function with the given $callback_id. The optional $user_data will be passed as the last parameter to the function.

The available callback IDs with corresponding function signatures are listed below.

void BrickletAirQuality::setAllValuesCallbackConfiguration(int $period, bool $value_has_to_change)

The period in ms is the period with which the CALLBACK_ALL_VALUES callback is triggered periodically. A value of 0 turns the callback off.

If the value has to change-parameter is set to true, the callback is only triggered after at least one of the values has changed. If the values didn't change within the period, the callback is triggered immediately on change.

If it is set to false, the callback is continuously triggered with the period, independent of the value.

The default value is (0, false).

array BrickletAirQuality::getAllValuesCallbackConfiguration()

Returns the callback configuration as set by setAllValuesCallbackConfiguration().

The returned array has the keys period and value_has_to_change.

void BrickletAirQuality::setIAQIndexCallbackConfiguration(int $period, bool $value_has_to_change)

The period in ms is the period with which the CALLBACK_IAQ_INDEX callback is triggered periodically. A value of 0 turns the callback off.

If the value has to change-parameter is set to true, the callback is only triggered after at least one of the values has changed. If the values didn't change within the period, the callback is triggered immediately on change.

If it is set to false, the callback is continuously triggered with the period, independent of the value.

The default value is (0, false).

array BrickletAirQuality::getIAQIndexCallbackConfiguration()

Returns the callback configuration as set by setIAQIndexCallbackConfiguration().

The returned array has the keys period and value_has_to_change.

void BrickletAirQuality::setTemperatureCallbackConfiguration(int $period, bool $value_has_to_change, string $option, int $min, int $max)

The period in ms is the period with which the CALLBACK_TEMPERATURE callback is triggered periodically. A value of 0 turns the callback off.

If the value has to change-parameter is set to true, the callback is only triggered after the value has changed. If the value didn't change within the period, the callback is triggered immediately on change.

If it is set to false, the callback is continuously triggered with the period, independent of the value.

It is furthermore possible to constrain the callback with thresholds.

The option-parameter together with min/max sets a threshold for the CALLBACK_TEMPERATURE callback.

The following options are possible:

Option Description
'x' Threshold is turned off
'o' Threshold is triggered when the value is outside the min and max values
'i' Threshold is triggered when the value is inside or equal to the min and max values
'<' Threshold is triggered when the value is smaller than the min value (max is ignored)
'>' Threshold is triggered when the value is greater than the min value (max is ignored)

If the option is set to 'x' (threshold turned off) the callback is triggered with the fixed period.

The default value is (0, false, 'x', 0, 0).

The following constants are available for this function:

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

Returns the callback configuration as set by setTemperatureCallbackConfiguration().

The following constants are available for this function:

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

The returned array has the keys period, value_has_to_change, option, min and max.

void BrickletAirQuality::setHumidityCallbackConfiguration(int $period, bool $value_has_to_change, string $option, int $min, int $max)

The period in ms is the period with which the CALLBACK_HUMIDITY callback is triggered periodically. A value of 0 turns the callback off.

If the value has to change-parameter is set to true, the callback is only triggered after the value has changed. If the value didn't change within the period, the callback is triggered immediately on change.

If it is set to false, the callback is continuously triggered with the period, independent of the value.

It is furthermore possible to constrain the callback with thresholds.

The option-parameter together with min/max sets a threshold for the CALLBACK_HUMIDITY callback.

The following options are possible:

Option Description
'x' Threshold is turned off
'o' Threshold is triggered when the value is outside the min and max values
'i' Threshold is triggered when the value is inside or equal to the min and max values
'<' Threshold is triggered when the value is smaller than the min value (max is ignored)
'>' Threshold is triggered when the value is greater than the min value (max is ignored)

If the option is set to 'x' (threshold turned off) the callback is triggered with the fixed period.

The default value is (0, false, 'x', 0, 0).

The following constants are available for this function:

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

Returns the callback configuration as set by setHumidityCallbackConfiguration().

The following constants are available for this function:

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

The returned array has the keys period, value_has_to_change, option, min and max.

void BrickletAirQuality::setAirPressureCallbackConfiguration(int $period, bool $value_has_to_change, string $option, int $min, int $max)

The period in ms is the period with which the CALLBACK_AIR_PRESSURE callback is triggered periodically. A value of 0 turns the callback off.

If the value has to change-parameter is set to true, the callback is only triggered after the value has changed. If the value didn't change within the period, the callback is triggered immediately on change.

If it is set to false, the callback is continuously triggered with the period, independent of the value.

It is furthermore possible to constrain the callback with thresholds.

The option-parameter together with min/max sets a threshold for the CALLBACK_AIR_PRESSURE callback.

The following options are possible:

Option Description
'x' Threshold is turned off
'o' Threshold is triggered when the value is outside the min and max values
'i' Threshold is triggered when the value is inside or equal to the min and max values
'<' Threshold is triggered when the value is smaller than the min value (max is ignored)
'>' Threshold is triggered when the value is greater than the min value (max is ignored)

If the option is set to 'x' (threshold turned off) the callback is triggered with the fixed period.

The default value is (0, false, 'x', 0, 0).

The following constants are available for this function:

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

Returns the callback configuration as set by setAirPressureCallbackConfiguration().

The following constants are available for this function:

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

The returned array has the keys period, value_has_to_change, option, min and max.

Callbacks

Callbacks can be registered to receive time critical or recurring data from the device. The registration is done with the registerCallback() function of the device object. The first parameter is the callback ID and the second parameter the callback function:

<?php

function myCallback($param)
{
    echo $param . "\n";
}

$air_quality->registerCallback(BrickletAirQuality::CALLBACK_EXAMPLE, 'myCallback');

?>

The available constants with corresponding function signatures are described below.

Note

Using callbacks for recurring events is always preferred compared to using getters. It will use less USB bandwidth and the latency will be a lot better, since there is no round trip time.

int BrickletAirQuality::CALLBACK_ALL_VALUES
<?php   void callback(int $iaq_index, int $iaq_index_accuracy, int $temperature, int $humidity, int $air_pressure [, mixed $user_data])   ?>

This callback is triggered periodically according to the configuration set by setAllValuesCallbackConfiguration().

The parameters are the same as getAllValues().

The following constants are available for this function:

  • BrickletAirQuality::ACCURACY_UNRELIABLE = 0
  • BrickletAirQuality::ACCURACY_LOW = 1
  • BrickletAirQuality::ACCURACY_MEDIUM = 2
  • BrickletAirQuality::ACCURACY_HIGH = 3
int BrickletAirQuality::CALLBACK_IAQ_INDEX
<?php   void callback(int $iaq_index, int $iaq_index_accuracy [, mixed $user_data])   ?>

This callback is triggered periodically according to the configuration set by setIAQIndexCallbackConfiguration().

The parameters are the same as getIAQIndex().

The following constants are available for this function:

  • BrickletAirQuality::ACCURACY_UNRELIABLE = 0
  • BrickletAirQuality::ACCURACY_LOW = 1
  • BrickletAirQuality::ACCURACY_MEDIUM = 2
  • BrickletAirQuality::ACCURACY_HIGH = 3
int BrickletAirQuality::CALLBACK_TEMPERATURE
<?php   void callback(int $temperature [, mixed $user_data])   ?>

This callback is triggered periodically according to the configuration set by setTemperatureCallbackConfiguration().

The parameter is the same as getTemperature().

int BrickletAirQuality::CALLBACK_HUMIDITY
<?php   void callback(int $humidity [, mixed $user_data])   ?>

This callback is triggered periodically according to the configuration set by setHumidityCallbackConfiguration().

The parameter is the same as getHumidity().

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

This callback is triggered periodically according to the configuration set by setAirPressureCallbackConfiguration().

The parameter is the same as getAirPressure().

Constants

int BrickletAirQuality::DEVICE_IDENTIFIER

This constant is used to identify a Air Quality Bricklet.

The getIdentity() function and the CALLBACK_ENUMERATE callback of the IP Connection have a deviceIdentifier parameter to specify the Brick's or Bricklet's type.

string BrickletAirQuality::DEVICE_DISPLAY_NAME

This constant represents the human readable name of a Air Quality Bricklet.