Software / API Bindings / Ruby / API Reference and Examples / Bricklets / Air Quality Bricklet

Ruby - Air Quality Bricklet¶

This is the description of the Ruby 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 Ruby API bindings is part of their general description.

Examples¶

The example code below is Public Domain (CC0 1.0).

Simple¶

Download (example_simple.rb)

#!/usr/bin/env ruby
# -*- ruby encoding: utf-8 -*-

require 'tinkerforge/ip_connection'
require 'tinkerforge/bricklet_air_quality'

include Tinkerforge

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

ipcon = IPConnection.new # Create IP connection
aq = BrickletAirQuality.new UID, ipcon # Create device object

ipcon.connect HOST, PORT # Connect to brickd
# Don't use device before ipcon is connected

# Get current all values as [iaq_index, iaq_index_accuracy, temperature, humidity,
#                            air_pressure]
all_values = aq.get_all_values

puts "IAQ Index: #{all_values[0]}"

if all_values[1] == BrickletAirQuality::ACCURACY_UNRELIABLE
  puts "IAQ Index Accuracy: Unreliable"
elsif all_values[1] == BrickletAirQuality::ACCURACY_LOW
  puts "IAQ Index Accuracy: Low"
elsif all_values[1] == BrickletAirQuality::ACCURACY_MEDIUM
  puts "IAQ Index Accuracy: Medium"
elsif all_values[1] == BrickletAirQuality::ACCURACY_HIGH
  puts "IAQ Index Accuracy: High"
end

puts "Temperature: #{all_values[2]/100.0} °C"
puts "Humidity: #{all_values[3]/100.0} %RH"
puts "Air Pressure: #{all_values[4]/100.0} hPa"

puts 'Press key to exit'
$stdin.gets
ipcon.disconnect

Callback¶

Download (example_callback.rb)

#!/usr/bin/env ruby
# -*- ruby encoding: utf-8 -*-

require 'tinkerforge/ip_connection'
require 'tinkerforge/bricklet_air_quality'

include Tinkerforge

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

ipcon = IPConnection.new # Create IP connection
aq = BrickletAirQuality.new UID, ipcon # Create device object

ipcon.connect HOST, PORT # Connect to brickd
# Don't use device before ipcon is connected

# Register all values callback
aq.register_callback(BrickletAirQuality::CALLBACK_ALL_VALUES) do |iaq_index,
                                                                  iaq_index_accuracy,
                                                                  temperature, humidity,
                                                                  air_pressure|
  puts "IAQ Index: #{iaq_index}"

  if iaq_index_accuracy == BrickletAirQuality::ACCURACY_UNRELIABLE
    puts "IAQ Index Accuracy: Unreliable"
  elsif iaq_index_accuracy == BrickletAirQuality::ACCURACY_LOW
    puts "IAQ Index Accuracy: Low"
  elsif iaq_index_accuracy == BrickletAirQuality::ACCURACY_MEDIUM
    puts "IAQ Index Accuracy: Medium"
  elsif iaq_index_accuracy == BrickletAirQuality::ACCURACY_HIGH
    puts "IAQ Index Accuracy: High"
  end

  puts "Temperature: #{temperature/100.0} °C"
  puts "Humidity: #{humidity/100.0} %RH"
  puts "Air Pressure: #{air_pressure/100.0} hPa"
  puts ''
end

# Set period for all values callback to 1s (1000ms)
aq.set_all_values_callback_configuration 1000, false

puts 'Press key to exit'
$stdin.gets
ipcon.disconnect

API¶

All functions listed below are thread-safe.

Basic Functions¶

BrickletAirQuality::new(uid, ipcon) → air_quality¶

Parameters:	uid – Type: str ipcon – Type: IPConnection
Returns:	air_quality – Type: BrickletAirQuality

Creates an object with the unique device ID uid:

air_quality = BrickletAirQuality.new 'YOUR_DEVICE_UID', ipcon

This object can then be used after the IP Connection is connected.

BrickletAirQuality#get_all_values → [int, int, int, int, int]¶

Return Array:	0: iaq_index – Type: int, Range: [0 to 500] 1: iaq_index_accuracy – Type: int, Range: See constants 2: temperature – Type: int, Unit: 1/100 °C, Range: [-2³¹ to 2³¹ - 1] 3: humidity – Type: int, Unit: 1/100 %, Range: [-2³¹ to 2³¹ - 1] 4: air_pressure – Type: int, Unit: 1/100 hPa, Range: [-2³¹ to 2³¹ - 1]

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.

The following constants are available for this function:

For iaq_index_accuracy:

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

BrickletAirQuality#set_temperature_offset(offset) → nil¶

Parameters:	offset – Type: int, Unit: 1/100 °C, Range: [-2³¹ to 2³¹ - 1]

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.

BrickletAirQuality#get_temperature_offset → int¶

Returns:	offset – Type: int, Unit: 1/100 °C, Range: [-2³¹ to 2³¹ - 1]

Returns the temperature offset as set by #set_temperature_offset.

BrickletAirQuality#get_iaq_index → [int, int]¶

Return Array:	0: iaq_index – Type: int, Range: [0 to 500] 1: iaq_index_accuracy – Type: int, Range: See constants

Returns the IAQ index and accuracy. The higher the IAQ index, the greater the level of air pollution.

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 #set_iaq_index_callback_configuration.

The following constants are available for this function:

For iaq_index_accuracy:

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

BrickletAirQuality#get_temperature → int¶

Returns:	temperature – Type: int, Unit: 1/100 °C, Range: [-2³¹ to 2³¹ - 1]

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 #set_temperature_callback_configuration.

BrickletAirQuality#get_humidity → int¶

Returns:	humidity – Type: int, Unit: 1/100 %, Range: [-2³¹ to 2³¹ - 1]

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 #set_humidity_callback_configuration.

BrickletAirQuality#get_air_pressure → int¶

Returns:	air_pressure – Type: int, Unit: 1/100 hPa, Range: [-2³¹ to 2³¹ - 1]

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 #set_air_pressure_callback_configuration.

Advanced Functions¶

BrickletAirQuality#remove_calibration → nil¶

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.

New in version 2.0.3 (Plugin).

BrickletAirQuality#set_background_calibration_duration(duration) → nil¶

Parameters:	duration – Type: int, Range: See constants, Default: 1

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.

The following constants are available for this function:

For duration:

BrickletAirQuality::DURATION_4_DAYS = 0
BrickletAirQuality::DURATION_28_DAYS = 1

New in version 2.0.3 (Plugin).

BrickletAirQuality#get_background_calibration_duration → int¶

Returns:	duration – Type: int, Range: See constants, Default: 1

Returns the background calibration duration as set by #set_background_calibration_duration.

The following constants are available for this function:

For duration:

BrickletAirQuality::DURATION_4_DAYS = 0
BrickletAirQuality::DURATION_28_DAYS = 1

New in version 2.0.3 (Plugin).

BrickletAirQuality#get_spitfp_error_count → [int, int, int, int]¶

Return Array:	0: error_count_ack_checksum – Type: int, Range: [0 to 2³² - 1] 1: error_count_message_checksum – Type: int, Range: [0 to 2³² - 1] 2: error_count_frame – Type: int, Range: [0 to 2³² - 1] 3: error_count_overflow – Type: int, Range: [0 to 2³² - 1]

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.

BrickletAirQuality#set_status_led_config(config) → nil¶

Parameters:	config – Type: int, Range: See constants, Default: 3

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:

For config:

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

BrickletAirQuality#get_status_led_config → int¶

Returns:	config – Type: int, Range: See constants, Default: 3

Returns the configuration as set by #set_status_led_config

The following constants are available for this function:

For config:

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

BrickletAirQuality#get_chip_temperature → int¶

Returns:	temperature – Type: int, Unit: 1 °C, Range: [-2¹⁵ to 2¹⁵ - 1]

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.

BrickletAirQuality#reset → nil¶

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!

BrickletAirQuality#get_identity → [str, str, chr, [int, ...], [int, ...], int]¶

Return Array:

Return Array:	0: uid – Type: str, Length: up to 8 1: connected_uid – Type: str, Length: up to 8 2: position – Type: chr, Range: ['a' to 'h', 'z'] 3: hardware_version – Type: [int, ...], Length: 3 0: major – Type: int, Range: [0 to 255] 1: minor – Type: int, Range: [0 to 255] 2: revision – Type: int, Range: [0 to 255] 4: firmware_version – Type: [int, ...], Length: 3 0: major – Type: int, Range: [0 to 255] 1: minor – Type: int, Range: [0 to 255] 2: revision – Type: int, Range: [0 to 255] 5: device_identifier – Type: int, Range: [0 to 2¹⁶ - 1]

0: uid – Type: str, Length: up to 8
1: connected_uid – Type: str, Length: up to 8
2: position – Type: chr, Range: ['a' to 'h', 'z']
3: hardware_version – Type: [int, ...], Length: 3

0: major – Type: int, Range: [0 to 255]
1: minor – Type: int, Range: [0 to 255]
2: revision – Type: int, Range: [0 to 255]

4: firmware_version – Type: [int, ...], Length: 3

0: major – Type: int, Range: [0 to 255]
1: minor – Type: int, Range: [0 to 255]
2: revision – Type: int, Range: [0 to 255]

5: device_identifier – Type: int, Range: [0 to 2¹⁶ - 1]

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 Isolator Bricklet is always at position 'z'.

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

Callback Configuration Functions¶

BrickletAirQuality#register_callback(callback_id) { |param [, ...]| block } → nil¶

Parameters:	callback_id – Type: int

Registers the given block with the given callback_id.

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

BrickletAirQuality#set_all_values_callback_configuration(period, value_has_to_change) → nil¶

Parameters:	period – Type: int, Unit: 1 ms, Range: [0 to 2³² - 1], Default: 0 value_has_to_change – Type: bool, Default: false

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.

BrickletAirQuality#get_all_values_callback_configuration → [int, bool]¶

Return Array:	0: period – Type: int, Unit: 1 ms, Range: [0 to 2³² - 1], Default: 0 1: value_has_to_change – Type: bool, Default: false

Returns the callback configuration as set by #set_all_values_callback_configuration.

BrickletAirQuality#set_iaq_index_callback_configuration(period, value_has_to_change) → nil¶

Parameters:	period – Type: int, Unit: 1 ms, Range: [0 to 2³² - 1], Default: 0 value_has_to_change – Type: bool, Default: false

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

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

BrickletAirQuality#get_iaq_index_callback_configuration → [int, bool]¶

Return Array:	0: period – Type: int, Unit: 1 ms, Range: [0 to 2³² - 1], Default: 0 1: value_has_to_change – Type: bool, Default: false

Returns the callback configuration as set by #set_iaq_index_callback_configuration.

BrickletAirQuality#set_temperature_callback_configuration(period, value_has_to_change, option, min, max) → nil¶

Parameters:	period – Type: int, Unit: 1 ms, Range: [0 to 2³² - 1], Default: 0 value_has_to_change – Type: bool, Default: false option – Type: chr, Range: See constants, Default: 'x' min – Type: int, Unit: 1/100 °C, Range: [-2³¹ to 2³¹ - 1], Default: 0 max – Type: int, Unit: 1/100 °C, Range: [-2³¹ to 2³¹ - 1], Default: 0

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.

The following constants are available for this function:

For option:

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

BrickletAirQuality#get_temperature_callback_configuration → [int, bool, chr, int, int]¶

Return Array:	0: period – Type: int, Unit: 1 ms, Range: [0 to 2³² - 1], Default: 0 1: value_has_to_change – Type: bool, Default: false 2: option – Type: chr, Range: See constants, Default: 'x' 3: min – Type: int, Unit: 1/100 °C, Range: [-2³¹ to 2³¹ - 1], Default: 0 4: max – Type: int, Unit: 1/100 °C, Range: [-2³¹ to 2³¹ - 1], Default: 0

Returns the callback configuration as set by #set_temperature_callback_configuration.

The following constants are available for this function:

For option:

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

BrickletAirQuality#set_humidity_callback_configuration(period, value_has_to_change, option, min, max) → nil¶

Parameters:	period – Type: int, Unit: 1 ms, Range: [0 to 2³² - 1], Default: 0 value_has_to_change – Type: bool, Default: false option – Type: chr, Range: See constants, Default: 'x' min – Type: int, Unit: 1/100 %, Range: [-2³¹ to 2³¹ - 1], Default: 0 max – Type: int, Unit: 1/100 %, Range: [-2³¹ to 2³¹ - 1], Default: 0

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

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 following constants are available for this function:

For option:

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

BrickletAirQuality#get_humidity_callback_configuration → [int, bool, chr, int, int]¶

Return Array:	0: period – Type: int, Unit: 1 ms, Range: [0 to 2³² - 1], Default: 0 1: value_has_to_change – Type: bool, Default: false 2: option – Type: chr, Range: See constants, Default: 'x' 3: min – Type: int, Unit: 1/100 %, Range: [-2³¹ to 2³¹ - 1], Default: 0 4: max – Type: int, Unit: 1/100 %, Range: [-2³¹ to 2³¹ - 1], Default: 0

Returns the callback configuration as set by #set_humidity_callback_configuration.

The following constants are available for this function:

For option:

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

BrickletAirQuality#set_air_pressure_callback_configuration(period, value_has_to_change, option, min, max) → nil¶

Parameters:	period – Type: int, Unit: 1 ms, Range: [0 to 2³² - 1], Default: 0 value_has_to_change – Type: bool, Default: false option – Type: chr, Range: See constants, Default: 'x' min – Type: int, Unit: 1/100 hPa, Range: [-2³¹ to 2³¹ - 1], Default: 0 max – Type: int, Unit: 1/100 hPa, Range: [-2³¹ to 2³¹ - 1], Default: 0

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

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 following constants are available for this function:

For option:

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

BrickletAirQuality#get_air_pressure_callback_configuration → [int, bool, chr, int, int]¶

Return Array:	0: period – Type: int, Unit: 1 ms, Range: [0 to 2³² - 1], Default: 0 1: value_has_to_change – Type: bool, Default: false 2: option – Type: chr, Range: See constants, Default: 'x' 3: min – Type: int, Unit: 1/100 hPa, Range: [-2³¹ to 2³¹ - 1], Default: 0 4: max – Type: int, Unit: 1/100 hPa, Range: [-2³¹ to 2³¹ - 1], Default: 0

Returns the callback configuration as set by #set_air_pressure_callback_configuration.

The following constants are available for this function:

For option:

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

Callbacks¶

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

air_quality.register_callback BrickletAirQuality::CALLBACK_EXAMPLE, do |param|
  puts "#{param}"
end

The available constants with inherent number and type of parameters 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.

BrickletAirQuality::CALLBACK_ALL_VALUES¶

Callback Parameters:	iaq_index – Type: int, Range: [0 to 500] iaq_index_accuracy – Type: int, Range: See constants temperature – Type: int, Unit: 1/100 °C, Range: [-2³¹ to 2³¹ - 1] humidity – Type: int, Unit: 1/100 %, Range: [-2³¹ to 2³¹ - 1] air_pressure – Type: int, Unit: 1/100 hPa, Range: [-2³¹ to 2³¹ - 1]

This callback is triggered periodically according to the configuration set by #set_all_values_callback_configuration.

The parameters are the same as #get_all_values.

The following constants are available for this function:

For iaq_index_accuracy:

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

BrickletAirQuality::CALLBACK_IAQ_INDEX¶

Callback Parameters:	iaq_index – Type: int, Range: [0 to 500] iaq_index_accuracy – Type: int, Range: See constants

This callback is triggered periodically according to the configuration set by #set_iaq_index_callback_configuration.

The parameters are the same as #get_iaq_index.

The following constants are available for this function:

For iaq_index_accuracy:

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

BrickletAirQuality::CALLBACK_TEMPERATURE¶

Callback Parameters:	temperature – Type: int, Unit: 1/100 °C, Range: [-2³¹ to 2³¹ - 1]

This callback is triggered periodically according to the configuration set by #set_temperature_callback_configuration.

The parameter is the same as #get_temperature.

BrickletAirQuality::CALLBACK_HUMIDITY¶

Callback Parameters:	humidity – Type: int, Unit: 1/100 %, Range: [-2³¹ to 2³¹ - 1]

This callback is triggered periodically according to the configuration set by #set_humidity_callback_configuration.

The parameter is the same as #get_humidity.

BrickletAirQuality::CALLBACK_AIR_PRESSURE¶

Callback Parameters:	air_pressure – Type: int, Unit: 1/100 hPa, Range: [-2³¹ to 2³¹ - 1]

This callback is triggered periodically according to the configuration set by #set_air_pressure_callback_configuration.

The parameter is the same as #get_air_pressure.

Virtual Functions¶

Virtual functions don't communicate with the device itself, but operate only on the API bindings device object. They can be called without the corresponding IP Connection object being connected.

BrickletAirQuality#get_api_version → [int, ...]¶

Return Array:	0: api_version – Type: [int, ...], Length: 3 0: major – Type: int, Range: [0 to 255] 1: minor – Type: int, Range: [0 to 255] 2: revision – Type: int, Range: [0 to 255]

Returns the version of the API definition 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.

BrickletAirQuality#get_response_expected(function_id) → bool¶

Parameters:	function_id – Type: int, Range: See constants
Returns:	response_expected – Type: bool

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 #set_response_expected. 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 sent and errors are silently ignored, because they cannot be detected.

The following constants are available for this function:

For function_id:

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_REMOVE_CALIBRATION = 23
BrickletAirQuality::FUNCTION_SET_BACKGROUND_CALIBRATION_DURATION = 24
BrickletAirQuality::FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
BrickletAirQuality::FUNCTION_SET_STATUS_LED_CONFIG = 239
BrickletAirQuality::FUNCTION_RESET = 243
BrickletAirQuality::FUNCTION_WRITE_UID = 248

BrickletAirQuality#set_response_expected(function_id, response_expected) → nil¶

Parameters:	function_id – Type: int, Range: See constants response_expected – Type: bool

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.

The following constants are available for this function:

For function_id:

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_REMOVE_CALIBRATION = 23
BrickletAirQuality::FUNCTION_SET_BACKGROUND_CALIBRATION_DURATION = 24
BrickletAirQuality::FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
BrickletAirQuality::FUNCTION_SET_STATUS_LED_CONFIG = 239
BrickletAirQuality::FUNCTION_RESET = 243
BrickletAirQuality::FUNCTION_WRITE_UID = 248

BrickletAirQuality#set_response_expected_all(response_expected) → nil¶

Parameters:	response_expected – Type: bool

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

Internal Functions¶

Internal functions are used for maintenance tasks such as flashing a new firmware of changing the UID of a Bricklet. These task should be performed using Brick Viewer instead of using the internal functions directly.

BrickletAirQuality#set_bootloader_mode(mode) → int¶

Parameters:	mode – Type: int, Range: See constants
Returns:	status – Type: int, Range: See constants

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:

For mode:

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

For status:

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

BrickletAirQuality#get_bootloader_mode → int¶

Returns:	mode – Type: int, Range: See constants

Returns the current bootloader mode, see #set_bootloader_mode.

The following constants are available for this function:

For mode:

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#set_write_firmware_pointer(pointer) → nil¶

Parameters:	pointer – Type: int, Unit: 1 B, Range: [0 to 2³² - 1]

Sets the firmware pointer for #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.

BrickletAirQuality#write_firmware(data) → int¶

Parameters:	data – Type: [int, ...], Length: 64, Range: [0 to 255]
Returns:	status – Type: int, Range: [0 to 255]

Writes 64 Bytes of firmware at the position as written by #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.

BrickletAirQuality#write_uid(uid) → nil¶

Parameters:	uid – Type: int, Range: [0 to 2³² - 1]

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.

BrickletAirQuality#read_uid → int¶

Returns:	uid – Type: int, Range: [0 to 2³² - 1]

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

Constants¶

BrickletAirQuality::DEVICE_IDENTIFIER¶

This constant is used to identify a Air Quality Bricklet.

The #get_identity() function and the IPConnection::CALLBACK_ENUMERATE callback of the IP Connection have a device_identifier parameter to specify the Brick's or Bricklet's type.

BrickletAirQuality::DEVICE_DISPLAY_NAME¶: This constant represents the human readable name of a Air Quality Bricklet.