Tinkerforge::BrickletAirQuality - Measures IAQ index, temperature, humidity and air pressure
This constant is used to identify a Air Quality Bricklet.
The get_identity() subroutine and the CALLBACK_ENUMERATE callback of the IP Connection have a device_identifier parameter to specify the Brick's or Bricklet's type.
This constant represents the display name of a Air Quality Bricklet.
This constant is used with the register_callback() subroutine to specify the CALLBACK_ALL_VALUES callback.
This constant is used with the register_callback() subroutine to specify the CALLBACK_IAQ_INDEX callback.
This constant is used with the register_callback() subroutine to specify the CALLBACK_TEMPERATURE callback.
This constant is used with the register_callback() subroutine to specify the CALLBACK_HUMIDITY callback.
This constant is used with the register_callback() subroutine to specify the CALLBACK_AIR_PRESSURE callback.
This constant is used with the get_response_expected(), set_response_expected() and set_response_expected_all() subroutines.
Creates an object with the unique device ID *uid* and adds it to the IP Connection *ipcon*.
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.
.. image:: /Images/Misc/bricklet_air_quality_iaq_index.png :scale: 100 % :alt: Air Quality Index description :align: center :target: ../../_images/Misc/bricklet_air_quality_iaq_index.png
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
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.
Returns the temperature offset as set by :func:`Set Temperature Offset`.
The period in ms is the period with which the :cb:`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).
Returns the callback configuration as set by :func:`Set All Values Callback Configuration`.
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.
.. image:: /Images/Misc/bricklet_air_quality_iaq_index.png :scale: 100 % :alt: IAQ index description :align: center :target: ../../_images/Misc/bricklet_air_quality_iaq_index.png
If you want to get the value periodically, it is recommended to use the :cb:`IAQ Index` callback. You can set the callback configuration with :func:`Set IAQ Index Callback Configuration`.
The period in ms is the period with which the :cb:`IAQ Index` callback is triggered periodically. A value of 0 turns the callback off.
Returns the callback configuration as set by :func:`Set IAQ Index Callback Configuration`.
Returns temperature in steps of 0.01 °C.
If you want to get the value periodically, it is recommended to use the :cb:`Temperature` callback. You can set the callback configuration with :func:`Set Temperature Callback Configuration`.
The period in ms is the period with which the :cb:`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.
It is furthermore possible to constrain the callback with thresholds.
The `option`-parameter together with min/max sets a threshold for the :cb:`Temperature` callback.
The following options are possible:
.. csv-table:: :header: "Option", "Description" :widths: 10, 100
"'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).
Returns the callback configuration as set by :func:`Set Temperature Callback Configuration`.
Returns relative humidity in steps of 0.01 %RH.
If you want to get the value periodically, it is recommended to use the :cb:`Humidity` callback. You can set the callback configuration with :func:`Set Humidity Callback Configuration`.
The period in ms is the period with which the :cb:`Humidity` callback is triggered periodically. A value of 0 turns the callback off.
The `option`-parameter together with min/max sets a threshold for the :cb:`Humidity` callback.
Returns the callback configuration as set by :func:`Set Humidity Callback Configuration`.
Returns air pressure in steps of 0.01 mbar.
If you want to get the value periodically, it is recommended to use the :cb:`Air Pressure` callback. You can set the callback configuration with :func:`Set Air Pressure Callback Configuration`.
The period in ms is the period with which the :cb:`Air Pressure` callback is triggered periodically. A value of 0 turns the callback off.
The `option`-parameter together with min/max sets a threshold for the :cb:`Air Pressure` callback.
Returns the callback configuration as set by :func:`Set Air Pressure Callback Configuration`.
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.
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.
Returns the current bootloader mode, see :func:`Set Bootloader Mode`.
Sets the firmware pointer for :func:`Write Firmware`. 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).
Writes 64 Bytes of firmware at the position as written by :func:`Set Write Firmware Pointer` before. The firmware is written to flash every 4 chunks.
You can only write firmware in bootloader mode.
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.
Returns the configuration as set by :func:`Set Status LED Config`
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.
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!
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.
Returns the current UID as an integer. Encode as Base58 to get the usual string version.
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 :ref:`here <device_identifier>`. |device_identifier_constant|
To install Tinkerforge, copy and paste the appropriate command in to your terminal.
cpanm
cpanm Tinkerforge
CPAN shell
perl -MCPAN -e shell install Tinkerforge
For more information on module installation, please visit the detailed CPAN module installation guide.