class Tinkerforge::BrickletAirQuality
Measures IAQ index, temperature, humidity and air pressure
Constants
- CALLBACK_AIR_PRESSURE
This callback is triggered periodically according to the configuration set by
BrickletAirQuality#set_air_pressure_callback_configuration
.The parameter is the same as
BrickletAirQuality#get_air_pressure
.- CALLBACK_ALL_VALUES
This callback is triggered periodically according to the configuration set by
BrickletAirQuality#set_all_values_callback_configuration
.The parameters are the same as
BrickletAirQuality#get_all_values
.- CALLBACK_HUMIDITY
This callback is triggered periodically according to the configuration set by
BrickletAirQuality#set_humidity_callback_configuration
.The parameter is the same as
BrickletAirQuality#get_humidity
.- CALLBACK_IAQ_INDEX
This callback is triggered periodically according to the configuration set by
BrickletAirQuality#set_iaq_index_callback_configuration
.The parameters are the same as
BrickletAirQuality#get_iaq_index
.- CALLBACK_TEMPERATURE
This callback is triggered periodically according to the configuration set by
BrickletAirQuality#set_temperature_callback_configuration
.The parameter is the same as
BrickletAirQuality#get_temperature
.
Public Class Methods
Creates an object with the unique device ID uid
and adds it to the IP Connection ipcon
.
# File lib/tinkerforge/bricklet_air_quality.rb, line 111 def initialize(uid, ipcon) super uid, ipcon, DEVICE_IDENTIFIER, DEVICE_DISPLAY_NAME @api_version = [2, 0, 1] @response_expected[FUNCTION_GET_ALL_VALUES] = RESPONSE_EXPECTED_ALWAYS_TRUE @response_expected[FUNCTION_SET_TEMPERATURE_OFFSET] = RESPONSE_EXPECTED_FALSE @response_expected[FUNCTION_GET_TEMPERATURE_OFFSET] = RESPONSE_EXPECTED_ALWAYS_TRUE @response_expected[FUNCTION_SET_ALL_VALUES_CALLBACK_CONFIGURATION] = RESPONSE_EXPECTED_TRUE @response_expected[FUNCTION_GET_ALL_VALUES_CALLBACK_CONFIGURATION] = RESPONSE_EXPECTED_ALWAYS_TRUE @response_expected[FUNCTION_GET_IAQ_INDEX] = RESPONSE_EXPECTED_ALWAYS_TRUE @response_expected[FUNCTION_SET_IAQ_INDEX_CALLBACK_CONFIGURATION] = RESPONSE_EXPECTED_TRUE @response_expected[FUNCTION_GET_IAQ_INDEX_CALLBACK_CONFIGURATION] = RESPONSE_EXPECTED_ALWAYS_TRUE @response_expected[FUNCTION_GET_TEMPERATURE] = RESPONSE_EXPECTED_ALWAYS_TRUE @response_expected[FUNCTION_SET_TEMPERATURE_CALLBACK_CONFIGURATION] = RESPONSE_EXPECTED_TRUE @response_expected[FUNCTION_GET_TEMPERATURE_CALLBACK_CONFIGURATION] = RESPONSE_EXPECTED_ALWAYS_TRUE @response_expected[FUNCTION_GET_HUMIDITY] = RESPONSE_EXPECTED_ALWAYS_TRUE @response_expected[FUNCTION_SET_HUMIDITY_CALLBACK_CONFIGURATION] = RESPONSE_EXPECTED_TRUE @response_expected[FUNCTION_GET_HUMIDITY_CALLBACK_CONFIGURATION] = RESPONSE_EXPECTED_ALWAYS_TRUE @response_expected[FUNCTION_GET_AIR_PRESSURE] = RESPONSE_EXPECTED_ALWAYS_TRUE @response_expected[FUNCTION_SET_AIR_PRESSURE_CALLBACK_CONFIGURATION] = RESPONSE_EXPECTED_TRUE @response_expected[FUNCTION_GET_AIR_PRESSURE_CALLBACK_CONFIGURATION] = RESPONSE_EXPECTED_ALWAYS_TRUE @response_expected[FUNCTION_REMOVE_CALIBRATION] = RESPONSE_EXPECTED_FALSE @response_expected[FUNCTION_SET_BACKGROUND_CALIBRATION_DURATION] = RESPONSE_EXPECTED_FALSE @response_expected[FUNCTION_GET_BACKGROUND_CALIBRATION_DURATION] = RESPONSE_EXPECTED_ALWAYS_TRUE @response_expected[FUNCTION_GET_SPITFP_ERROR_COUNT] = RESPONSE_EXPECTED_ALWAYS_TRUE @response_expected[FUNCTION_SET_BOOTLOADER_MODE] = RESPONSE_EXPECTED_ALWAYS_TRUE @response_expected[FUNCTION_GET_BOOTLOADER_MODE] = RESPONSE_EXPECTED_ALWAYS_TRUE @response_expected[FUNCTION_SET_WRITE_FIRMWARE_POINTER] = RESPONSE_EXPECTED_FALSE @response_expected[FUNCTION_WRITE_FIRMWARE] = RESPONSE_EXPECTED_ALWAYS_TRUE @response_expected[FUNCTION_SET_STATUS_LED_CONFIG] = RESPONSE_EXPECTED_FALSE @response_expected[FUNCTION_GET_STATUS_LED_CONFIG] = RESPONSE_EXPECTED_ALWAYS_TRUE @response_expected[FUNCTION_GET_CHIP_TEMPERATURE] = RESPONSE_EXPECTED_ALWAYS_TRUE @response_expected[FUNCTION_RESET] = RESPONSE_EXPECTED_FALSE @response_expected[FUNCTION_WRITE_UID] = RESPONSE_EXPECTED_FALSE @response_expected[FUNCTION_READ_UID] = RESPONSE_EXPECTED_ALWAYS_TRUE @response_expected[FUNCTION_GET_IDENTITY] = RESPONSE_EXPECTED_ALWAYS_TRUE @callback_formats[CALLBACK_ALL_VALUES] = [25, 'l C l l l'] @callback_formats[CALLBACK_IAQ_INDEX] = [13, 'l C'] @callback_formats[CALLBACK_TEMPERATURE] = [12, 'l'] @callback_formats[CALLBACK_HUMIDITY] = [12, 'l'] @callback_formats[CALLBACK_AIR_PRESSURE] = [12, 'l'] @ipcon.add_device self end
Public Instance Methods
Returns air pressure.
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 BrickletAirQuality#set_air_pressure_callback_configuration
.
# File lib/tinkerforge/bricklet_air_quality.rb, line 370 def get_air_pressure check_validity send_request FUNCTION_GET_AIR_PRESSURE, [], '', 12, 'l' end
Returns the callback configuration as set by BrickletAirQuality#set_air_pressure_callback_configuration
.
# File lib/tinkerforge/bricklet_air_quality.rb, line 408 def get_air_pressure_callback_configuration check_validity send_request FUNCTION_GET_AIR_PRESSURE_CALLBACK_CONFIGURATION, [], '', 22, 'L ? k l l' end
Returns all values measured by the Air Quality Bricklet. The values are IAQ (Indoor Air Quality) Index (higher value means greater level of air pollution), 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
# File lib/tinkerforge/bricklet_air_quality.rb, line 167 def get_all_values check_validity send_request FUNCTION_GET_ALL_VALUES, [], '', 25, 'l C l l l' end
Returns the callback configuration as set by BrickletAirQuality#set_all_values_callback_configuration
.
# File lib/tinkerforge/bricklet_air_quality.rb, line 218 def get_all_values_callback_configuration check_validity send_request FUNCTION_GET_ALL_VALUES_CALLBACK_CONFIGURATION, [], '', 13, 'L ?' end
Returns the background calibration duration as set by BrickletAirQuality#set_background_calibration_duration
.
- .. versionadded
-
2.0.3$nbsp;(Plugin)
# File lib/tinkerforge/bricklet_air_quality.rb, line 462 def get_background_calibration_duration check_validity send_request FUNCTION_GET_BACKGROUND_CALIBRATION_DURATION, [], '', 9, 'C' end
Returns the current bootloader mode, see BrickletAirQuality#set_bootloader_mode
.
# File lib/tinkerforge/bricklet_air_quality.rb, line 501 def get_bootloader_mode check_validity send_request FUNCTION_GET_BOOTLOADER_MODE, [], '', 9, 'C' end
Returns the temperature 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.
# File lib/tinkerforge/bricklet_air_quality.rb, line 559 def get_chip_temperature check_validity send_request FUNCTION_GET_CHIP_TEMPERATURE, [], '', 10, 's' end
Returns relative humidity.
If you want to get the value periodically, it is recommended to use the CALLBACK_HUMIDITY
callback. You can set the callback configuration with BrickletAirQuality#set_humidity_callback_configuration
.
# File lib/tinkerforge/bricklet_air_quality.rb, line 320 def get_humidity check_validity send_request FUNCTION_GET_HUMIDITY, [], '', 12, 'l' end
Returns the callback configuration as set by BrickletAirQuality#set_humidity_callback_configuration
.
# File lib/tinkerforge/bricklet_air_quality.rb, line 358 def get_humidity_callback_configuration check_validity send_request FUNCTION_GET_HUMIDITY_CALLBACK_CONFIGURATION, [], '', 22, 'L ? k l l' end
Returns the IAQ index and accuracy. 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 CALLBACK_IAQ_INDEX
callback. You can set the callback configuration with BrickletAirQuality#set_iaq_index_callback_configuration
.
# File lib/tinkerforge/bricklet_air_quality.rb, line 235 def get_iaq_index check_validity send_request FUNCTION_GET_IAQ_INDEX, [], '', 13, 'l C' end
Returns the callback configuration as set by BrickletAirQuality#set_iaq_index_callback_configuration
.
# File lib/tinkerforge/bricklet_air_quality.rb, line 258 def get_iaq_index_callback_configuration check_validity send_request FUNCTION_GET_IAQ_INDEX_CALLBACK_CONFIGURATION, [], '', 13, 'L ?' end
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', 'd', 'e', 'f', 'g' or 'h' (Bricklet Port). A Bricklet connected to an :ref:`Isolator Bricklet <isolator_bricklet>` is always at position 'z'.
The device identifier numbers can be found :ref:`here <device_identifier>`. |device_identifier_constant|
# File lib/tinkerforge/bricklet_air_quality.rb, line 606 def get_identity send_request FUNCTION_GET_IDENTITY, [], '', 33, 'Z8 Z8 k C3 C3 S' end
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.
# File lib/tinkerforge/bricklet_air_quality.rb, line 479 def get_spitfp_error_count check_validity send_request FUNCTION_GET_SPITFP_ERROR_COUNT, [], '', 24, 'L L L L' end
Returns the configuration as set by BrickletAirQuality#set_status_led_config
# File lib/tinkerforge/bricklet_air_quality.rb, line 547 def get_status_led_config check_validity send_request FUNCTION_GET_STATUS_LED_CONFIG, [], '', 9, 'C' end
Returns temperature.
If you want to get the value periodically, it is recommended to use the CALLBACK_TEMPERATURE
callback. You can set the callback configuration with BrickletAirQuality#set_temperature_callback_configuration
.
# File lib/tinkerforge/bricklet_air_quality.rb, line 270 def get_temperature check_validity send_request FUNCTION_GET_TEMPERATURE, [], '', 12, 'l' end
Returns the callback configuration as set by BrickletAirQuality#set_temperature_callback_configuration
.
# File lib/tinkerforge/bricklet_air_quality.rb, line 308 def get_temperature_callback_configuration check_validity send_request FUNCTION_GET_TEMPERATURE_CALLBACK_CONFIGURATION, [], '', 22, 'L ? k l l' end
Returns the temperature offset as set by BrickletAirQuality#set_temperature_offset
.
# File lib/tinkerforge/bricklet_air_quality.rb, line 195 def get_temperature_offset check_validity send_request FUNCTION_GET_TEMPERATURE_OFFSET, [], '', 12, 'l' end
Returns the current UID as an integer. Encode as Base58
to get the usual string version.
# File lib/tinkerforge/bricklet_air_quality.rb, line 590 def read_uid check_validity send_request FUNCTION_READ_UID, [], '', 12, 'L' end
Registers a callback with ID id
to the block block
.
# File lib/tinkerforge/bricklet_air_quality.rb, line 611 def register_callback(id, &block) callback = block @registered_callbacks[id] = callback end
Deletes the calibration from flash. After you call this function, you need to power cycle the Air Quality Bricklet.
On the next power up the Bricklet will start a new calibration, as if it was started for the very first time.
The calibration is based on the data of the last four days, so it takes four days until a full calibration is re-established.
- .. versionadded
-
2.0.3$nbsp;(Plugin)
# File lib/tinkerforge/bricklet_air_quality.rb, line 424 def remove_calibration check_validity send_request FUNCTION_REMOVE_CALIBRATION, [], '', 8, '' end
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!
# File lib/tinkerforge/bricklet_air_quality.rb, line 571 def reset check_validity send_request FUNCTION_RESET, [], '', 8, '' end
The period 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.
# File lib/tinkerforge/bricklet_air_quality.rb, line 401 def set_air_pressure_callback_configuration(period, value_has_to_change, option, min, max) check_validity send_request FUNCTION_SET_AIR_PRESSURE_CALLBACK_CONFIGURATION, [period, value_has_to_change, option, min, max], 'L ? k l l', 8, '' end
The period 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.
# File lib/tinkerforge/bricklet_air_quality.rb, line 210 def set_all_values_callback_configuration(period, value_has_to_change) check_validity send_request FUNCTION_SET_ALL_VALUES_CALLBACK_CONFIGURATION, [period, value_has_to_change], 'L ?', 8, '' end
The Air Quality Bricklet uses an automatic background calibration mechanism to calculate the IAQ Index. This calibration mechanism considers a history of measured data. The duration of this history can be configured to either be 4 days or 28 days.
If you keep the Bricklet mostly at one place and it does not get moved around to different environments, we recommend that you use a duration of 28 days.
If you change the duration, the current calibration will be discarded and the calibration will start from beginning again. The configuration of the duration is saved in flash, so you should only have to call this function once in the lifetime of the Bricklet.
The Bricklet has to be power cycled after this function is called for a duration change to take effect.
Before firmware version 2.0.3 this was not configurable and the duration was 4 days.
The default value (since firmware version 2.0.3) is 28 days.
- .. versionadded
-
2.0.3$nbsp;(Plugin)
# File lib/tinkerforge/bricklet_air_quality.rb, line 452 def set_background_calibration_duration(duration) check_validity send_request FUNCTION_SET_BACKGROUND_CALIBRATION_DURATION, [duration], 'C', 8, '' end
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.
# File lib/tinkerforge/bricklet_air_quality.rb, line 494 def set_bootloader_mode(mode) check_validity send_request FUNCTION_SET_BOOTLOADER_MODE, [mode], 'C', 9, 'C' end
The period 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.
# File lib/tinkerforge/bricklet_air_quality.rb, line 351 def set_humidity_callback_configuration(period, value_has_to_change, option, min, max) check_validity send_request FUNCTION_SET_HUMIDITY_CALLBACK_CONFIGURATION, [period, value_has_to_change, option, min, max], 'L ? k l l', 8, '' end
The period 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.
# File lib/tinkerforge/bricklet_air_quality.rb, line 250 def set_iaq_index_callback_configuration(period, value_has_to_change) check_validity send_request FUNCTION_SET_IAQ_INDEX_CALLBACK_CONFIGURATION, [period, value_has_to_change], 'L ?', 8, '' end
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.
# File lib/tinkerforge/bricklet_air_quality.rb, line 540 def set_status_led_config(config) check_validity send_request FUNCTION_SET_STATUS_LED_CONFIG, [config], 'C', 8, '' end
The period 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.
# File lib/tinkerforge/bricklet_air_quality.rb, line 301 def set_temperature_callback_configuration(period, value_has_to_change, option, min, max) check_validity send_request FUNCTION_SET_TEMPERATURE_CALLBACK_CONFIGURATION, [period, value_has_to_change, option, min, max], 'L ? k l l', 8, '' end
Sets a temperature offset. 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 improve the accuracy of the measurements.
# File lib/tinkerforge/bricklet_air_quality.rb, line 187 def set_temperature_offset(offset) check_validity send_request FUNCTION_SET_TEMPERATURE_OFFSET, [offset], 'l', 8, '' end
Sets the firmware pointer for BrickletAirQuality#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).
This function is used by Brick Viewer during flashing. It should not be necessary to call it in a normal user program.
# File lib/tinkerforge/bricklet_air_quality.rb, line 513 def set_write_firmware_pointer(pointer) check_validity send_request FUNCTION_SET_WRITE_FIRMWARE_POINTER, [pointer], 'L', 8, '' end
Writes 64 Bytes of firmware at the position as written by BrickletAirQuality#set_write_firmware_pointer
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.
# File lib/tinkerforge/bricklet_air_quality.rb, line 527 def write_firmware(data) check_validity send_request FUNCTION_WRITE_FIRMWARE, [data], 'C64', 9, 'C' end
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.
# File lib/tinkerforge/bricklet_air_quality.rb, line 582 def write_uid(uid) check_validity send_request FUNCTION_WRITE_UID, [uid], 'L', 8, '' end