TCP/IP - Air Quality Bricklet

This is the description of the TCP/IP protocol for the Air Quality Bricklet. General information and technical specifications for the Air Quality Bricklet are summarized in its hardware description.

API

A general description of the TCP/IP protocol structure can be found here.

Basic Functions

BrickletAirQuality.get_all_values
Function ID:

1

Request:

empty payload

Response:
  • iaq_index -- int32
  • iaq_index_accuracy -- uint8
  • temperature -- int32
  • humidity -- int32
  • air_pressure -- int32

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 meanings are defined for the parameters of this function:

  • 0: unreliable, for iaq_index_accuracy
  • 1: low, for iaq_index_accuracy
  • 2: medium, for iaq_index_accuracy
  • 3: high, for iaq_index_accuracy
BrickletAirQuality.set_temperature_offset
Function ID:

2

Request:
  • offset -- int32
Response:

no response

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
Function ID:

3

Request:

empty payload

Response:
  • offset -- int32

Returns the temperature offset as set by set_temperature_offset.

BrickletAirQuality.get_iaq_index
Function ID:

7

Request:

empty payload

Response:
  • iaq_index -- int32
  • iaq_index_accuracy -- uint8

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 meanings are defined for the parameters of this function:

  • 0: unreliable, for iaq_index_accuracy
  • 1: low, for iaq_index_accuracy
  • 2: medium, for iaq_index_accuracy
  • 3: high, for iaq_index_accuracy
BrickletAirQuality.get_temperature
Function ID:

11

Request:

empty payload

Response:
  • temperature -- int32

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
Function ID:

15

Request:

empty payload

Response:
  • humidity -- int32

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
Function ID:

19

Request:

empty payload

Response:
  • air_pressure -- int32

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_spitfp_error_count
Function ID:

234

Request:

empty payload

Response:
  • error_count_ack_checksum -- uint32
  • error_count_message_checksum -- uint32
  • error_count_frame -- uint32
  • error_count_overflow -- uint32

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_bootloader_mode
Function ID:

235

Request:
  • mode -- uint8
Response:
  • status -- uint8

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 meanings are defined for the parameters of this function:

  • 0: bootloader, for mode
  • 1: firmware, for mode
  • 2: bootloader wait for reboot, for mode
  • 3: firmware wait for reboot, for mode
  • 4: firmware wait for erase and reboot, for mode
  • 0: ok, for status
  • 1: invalid mode, for status
  • 2: no change, for status
  • 3: entry function not present, for status
  • 4: device identifier incorrect, for status
  • 5: crc mismatch, for status
BrickletAirQuality.get_bootloader_mode
Function ID:

236

Request:

empty payload

Response:
  • mode -- uint8

Returns the current bootloader mode, see set_bootloader_mode.

The following meanings are defined for the parameters of this function:

  • 0: bootloader, for mode
  • 1: firmware, for mode
  • 2: bootloader wait for reboot, for mode
  • 3: firmware wait for reboot, for mode
  • 4: firmware wait for erase and reboot, for mode
BrickletAirQuality.set_write_firmware_pointer
Function ID:

237

Request:
  • pointer -- uint32
Response:

no response

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
Function ID:

238

Request:
  • data -- uint8[64]
Response:
  • status -- uint8

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
Function ID:

239

Request:
  • config -- uint8
Response:

no response

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 meanings are defined for the parameters of this function:

  • 0: off, for config
  • 1: on, for config
  • 2: show heartbeat, for config
  • 3: show status, for config
BrickletAirQuality.get_status_led_config
Function ID:

240

Request:

empty payload

Response:
  • config -- uint8

Returns the configuration as set by set_status_led_config

The following meanings are defined for the parameters of this function:

  • 0: off, for config
  • 1: on, for config
  • 2: show heartbeat, for config
  • 3: show status, for config
BrickletAirQuality.get_chip_temperature
Function ID:

242

Request:

empty payload

Response:
  • temperature -- int16

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
Function ID:243
Request:empty payload
Response:no response

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
Function ID:

248

Request:
  • uid -- uint32
Response:

no response

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
Function ID:

249

Request:

empty payload

Response:
  • uid -- uint32

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

BrickletAirQuality.get_identity
Function ID:

255

Request:

empty payload

Response:
  • uid -- char[8]
  • connected_uid -- char[8]
  • position -- char
  • hardware_version -- uint8[3]
  • firmware_version -- uint8[3]
  • device_identifier -- uint16

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

Callback Configuration Functions

BrickletAirQuality.set_all_values_callback_configuration
Function ID:

4

Request:
  • period -- uint32
  • value_has_to_change -- bool
Response:

no response

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
Function ID:

5

Request:

empty payload

Response:
  • period -- uint32
  • value_has_to_change -- bool

Returns the callback configuration as set by set_all_values_callback_configuration.

BrickletAirQuality.set_iaq_index_callback_configuration
Function ID:

8

Request:
  • period -- uint32
  • value_has_to_change -- bool
Response:

no response

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
Function ID:

9

Request:

empty payload

Response:
  • period -- uint32
  • value_has_to_change -- bool

Returns the callback configuration as set by set_iaq_index_callback_configuration.

BrickletAirQuality.set_temperature_callback_configuration
Function ID:

12

Request:
  • period -- uint32
  • value_has_to_change -- bool
  • option -- char
  • min -- int32
  • max -- int32
Response:

no response

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 meanings are defined for the parameters of this function:

  • x: off, for option
  • o: outside, for option
  • i: inside, for option
  • <: smaller, for option
  • >: greater, for option
BrickletAirQuality.get_temperature_callback_configuration
Function ID:

13

Request:

empty payload

Response:
  • period -- uint32
  • value_has_to_change -- bool
  • option -- char
  • min -- int32
  • max -- int32

Returns the callback configuration as set by set_temperature_callback_configuration.

The following meanings are defined for the parameters of this function:

  • x: off, for option
  • o: outside, for option
  • i: inside, for option
  • <: smaller, for option
  • >: greater, for option
BrickletAirQuality.set_humidity_callback_configuration
Function ID:

16

Request:
  • period -- uint32
  • value_has_to_change -- bool
  • option -- char
  • min -- int32
  • max -- int32
Response:

no response

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 meanings are defined for the parameters of this function:

  • x: off, for option
  • o: outside, for option
  • i: inside, for option
  • <: smaller, for option
  • >: greater, for option
BrickletAirQuality.get_humidity_callback_configuration
Function ID:

17

Request:

empty payload

Response:
  • period -- uint32
  • value_has_to_change -- bool
  • option -- char
  • min -- int32
  • max -- int32

Returns the callback configuration as set by set_humidity_callback_configuration.

The following meanings are defined for the parameters of this function:

  • x: off, for option
  • o: outside, for option
  • i: inside, for option
  • <: smaller, for option
  • >: greater, for option
BrickletAirQuality.set_air_pressure_callback_configuration
Function ID:

20

Request:
  • period -- uint32
  • value_has_to_change -- bool
  • option -- char
  • min -- int32
  • max -- int32
Response:

no response

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 meanings are defined for the parameters of this function:

  • x: off, for option
  • o: outside, for option
  • i: inside, for option
  • <: smaller, for option
  • >: greater, for option
BrickletAirQuality.get_air_pressure_callback_configuration
Function ID:

21

Request:

empty payload

Response:
  • period -- uint32
  • value_has_to_change -- bool
  • option -- char
  • min -- int32
  • max -- int32

Returns the callback configuration as set by set_air_pressure_callback_configuration.

The following meanings are defined for the parameters of this function:

  • x: off, for option
  • o: outside, for option
  • i: inside, for option
  • <: smaller, for option
  • >: greater, for option

Callbacks

BrickletAirQuality.CALLBACK_ALL_VALUES
Function ID:

6

Response:
  • iaq_index -- int32
  • iaq_index_accuracy -- uint8
  • temperature -- int32
  • humidity -- int32
  • air_pressure -- int32

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

The response values are the same as get_all_values.

The following meanings are defined for the parameters of this function:

  • 0: unreliable, for iaq_index_accuracy
  • 1: low, for iaq_index_accuracy
  • 2: medium, for iaq_index_accuracy
  • 3: high, for iaq_index_accuracy
BrickletAirQuality.CALLBACK_IAQ_INDEX
Function ID:

10

Response:
  • iaq_index -- int32
  • iaq_index_accuracy -- uint8

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

The response values are the same as get_iaq_index.

The following meanings are defined for the parameters of this function:

  • 0: unreliable, for iaq_index_accuracy
  • 1: low, for iaq_index_accuracy
  • 2: medium, for iaq_index_accuracy
  • 3: high, for iaq_index_accuracy
BrickletAirQuality.CALLBACK_TEMPERATURE
Function ID:

14

Response:
  • temperature -- int32

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

The response value is the same as get_temperature.

BrickletAirQuality.CALLBACK_HUMIDITY
Function ID:

18

Response:
  • humidity -- int32

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

The response value is the same as get_humidity.

BrickletAirQuality.CALLBACK_AIR_PRESSURE
Function ID:

22

Response:
  • air_pressure -- int32

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

The response value is the same as get_air_pressure.