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)

 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
#!/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} mbar"

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

Callback

Download (example_callback.rb)

 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
#!/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} mbar"
  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 methods listed below are thread-safe.

Basic Functions

BrickletAirQuality::new(uid, ipcon) → air_quality
Parameters:
  • uid -- str
  • ipcon -- IPConnection

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 (see examples above).

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

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 values iaq_index, iaq_index_accuracy, temperature, humidity and air_pressure.

BrickletAirQuality#set_temperature_offset(offset) → nil
Parameters:offset -- int

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.

BrickletAirQuality#get_temperature_offset → int

Returns the temperature offset as set by #set_temperature_offset.

BrickletAirQuality#get_iaq_index → [int, int]

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

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 values iaq_index and iaq_index_accuracy.

BrickletAirQuality#get_temperature → int

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

BrickletAirQuality#get_humidity → int

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

BrickletAirQuality#get_air_pressure → int

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

Advanced Functions

BrickletAirQuality#get_api_version → [int, int, int]

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.

BrickletAirQuality#get_response_expected(function_id) → bool
Parameters:function_id -- int

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

See #set_response_expected for the list of function ID constants available for this function.

BrickletAirQuality#set_response_expected(function_id, response_expected) → nil
Parameters:
  • function_id -- int
  • response_expected -- 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.

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
BrickletAirQuality#set_response_expected_all(response_expected) → nil
Parameters:response_expected -- bool

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

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

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 values error_count_ack_checksum, error_count_message_checksum, error_count_frame and error_count_overflow.

BrickletAirQuality#set_bootloader_mode(mode) → int
Parameters:mode -- int

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
BrickletAirQuality#get_bootloader_mode → int

Returns the current bootloader mode, see #set_bootloader_mode.

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#set_write_firmware_pointer(pointer) → nil
Parameters:pointer -- int

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 -- [int, int, ..61x.., int]

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#set_status_led_config(config) → nil
Parameters:config -- int

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
BrickletAirQuality#get_status_led_config → int

Returns the configuration as set by #set_status_led_config

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
BrickletAirQuality#get_chip_temperature → int

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.

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#write_uid(uid) → nil
Parameters:uid -- int

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 the current UID as an integer. Encode as Base58 to get the usual string version.

BrickletAirQuality#get_identity → [str, str, str, [int, int, int], [int, int, int], int]

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 values uid, connected_uid, position, hardware_version, firmware_version and device_identifier.

Callback Configuration Functions

BrickletAirQuality#register_callback(callback_id) { |param [, ...]| block } → nil
Parameters:callback_id -- 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 -- int
  • value_has_to_change -- bool

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).

BrickletAirQuality#get_all_values_callback_configuration → [int, bool]

Returns the callback configuration as set by #set_all_values_callback_configuration.

The returned array has the values period and value_has_to_change.

BrickletAirQuality#set_iaq_index_callback_configuration(period, value_has_to_change) → nil
Parameters:
  • period -- int
  • value_has_to_change -- bool

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).

BrickletAirQuality#get_iaq_index_callback_configuration → [int, bool]

Returns the callback configuration as set by #set_iaq_index_callback_configuration.

The returned array has the values period and value_has_to_change.

BrickletAirQuality#set_temperature_callback_configuration(period, value_has_to_change, option, min, max) → nil
Parameters:
  • period -- int
  • value_has_to_change -- bool
  • option -- str
  • min -- int
  • max -- int

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 = '>'
BrickletAirQuality#get_temperature_callback_configuration → [int, bool, str, int, int]

Returns the callback configuration as set by #set_temperature_callback_configuration.

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 values period, value_has_to_change, option, min and max.

BrickletAirQuality#set_humidity_callback_configuration(period, value_has_to_change, option, min, max) → nil
Parameters:
  • period -- int
  • value_has_to_change -- bool
  • option -- str
  • min -- int
  • max -- int

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 = '>'
BrickletAirQuality#get_humidity_callback_configuration → [int, bool, str, int, int]

Returns the callback configuration as set by #set_humidity_callback_configuration.

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 values period, value_has_to_change, option, min and max.

BrickletAirQuality#set_air_pressure_callback_configuration(period, value_has_to_change, option, min, max) → nil
Parameters:
  • period -- int
  • value_has_to_change -- bool
  • option -- str
  • min -- int
  • max -- int

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 = '>'
BrickletAirQuality#get_air_pressure_callback_configuration → [int, bool, str, int, int]

Returns the callback configuration as set by #set_air_pressure_callback_configuration.

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 values 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 #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
Parameters:
  • iaq_index -- int
  • iaq_index_accuracy -- int
  • temperature -- int
  • humidity -- int
  • air_pressure -- int

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:

  • BrickletAirQuality::ACCURACY_UNRELIABLE = 0
  • BrickletAirQuality::ACCURACY_LOW = 1
  • BrickletAirQuality::ACCURACY_MEDIUM = 2
  • BrickletAirQuality::ACCURACY_HIGH = 3
BrickletAirQuality::CALLBACK_IAQ_INDEX
Parameters:
  • iaq_index -- int
  • iaq_index_accuracy -- int

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:

  • BrickletAirQuality::ACCURACY_UNRELIABLE = 0
  • BrickletAirQuality::ACCURACY_LOW = 1
  • BrickletAirQuality::ACCURACY_MEDIUM = 2
  • BrickletAirQuality::ACCURACY_HIGH = 3
BrickletAirQuality::CALLBACK_TEMPERATURE
Parameters:temperature -- int

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
Parameters:humidity -- int

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
Parameters:air_pressure -- int

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.

Constants

BrickletAirQuality::DEVICE_IDENTIFIER

This constant is used to identify a Air Quality Bricklet.

The #get_identity() function and the ::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.