Shell - Air Quality Bricklet

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

Examples

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

Simple

Download (example-simple.sh)

1
2
3
4
5
6
7
#!/bin/sh
# Connects to localhost:4223 by default, use --host and --port to change this

uid=XYZ # Change XYZ to the UID of your Air Quality Bricklet

# Get current all values
tinkerforge call air-quality-bricklet $uid get-all-values

Callback

Download (example-callback.sh)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
#!/bin/sh
# Connects to localhost:4223 by default, use --host and --port to change this

uid=XYZ # Change XYZ to the UID of your Air Quality Bricklet

# Handle incoming all values callbacks
tinkerforge dispatch air-quality-bricklet $uid all-values &

# Set period for all values callback to 1s (1000ms)
tinkerforge call air-quality-bricklet $uid set-all-values-callback-configuration 1000 false

echo "Press key to exit"; read dummy

kill -- -$$ # Stop callback dispatch in background

API

Possible exit codes for all tinkerforge commands are:

  • 1: interrupted (ctrl+c)
  • 2: syntax error
  • 21: Python 2.5 or newer is required
  • 22: Python argparse module is missing
  • 23: socket error
  • 24: other exception
  • 25: invalid placeholder in format string
  • 26: authentication error
  • 201: timeout occurred
  • 209: invalid argument value
  • 210: function is not supported
  • 211: unknown error

Command Structure

The common options of the call and dispatch commands are documented here. The specific command structure is shown below.

tinkerforge call air-quality-bricklet [<option>..] <uid> <function> [<argument>..]
Parameters:
  • <uid> -- string
  • <function> -- string

The call command is used to call a function of the Air Quality Bricklet. It can take several options:

  • --help shows help for the specific call command and exits
  • --list-functions shows a list of known functions of the Air Quality Bricklet and exits
tinkerforge dispatch air-quality-bricklet [<option>..] <uid> <callback>
Parameters:
  • <uid> -- string
  • <callback> -- string

The dispatch command is used to dispatch a callback of the Air Quality Bricklet. It can take several options:

  • --help shows help for the specific dispatch command and exits
  • --list-callbacks shows a list of known callbacks of the Air Quality Bricklet and exits
tinkerforge call air-quality-bricklet <uid> <function> [<option>..] [<argument>..]
Parameters:
  • <uid> -- string
  • <function> -- string

The <function> to be called can take different options depending of its kind. All functions can take the following options:

  • --help shows help for the specific function and exits

Getter functions can take the following options:

  • --execute <command> shell command line to execute for each incoming response (see section about output formatting for details)

Setter functions can take the following options:

  • --expect-response requests response and waits for it

The --expect-response option for setter functions allows to detect timeouts and other error conditions calls of setters as well. The device will then send a response for this purpose. If this option is not given for a setter function then no response is send and errors are silently ignored, because they cannot be detected.

tinkerforge dispatch air-quality-bricklet <uid> <callback> [<option>..]
Parameters:
  • <uid> -- string
  • <callback> -- string

The <callback> to be dispatched can take several options:

  • --help shows help for the specific callback and exits
  • --execute <command> shell command line to execute for each incoming response (see section about output formatting for details)

Basic Functions

tinkerforge call air-quality-bricklet <uid> get-all-values
Output:
  • iaq-index -- int
  • iaq-index-accuracy -- int (has symbols)
  • temperature -- int
  • humidity -- int
  • air-pressure -- 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 symbols are available for this function:

  • accuracy-unreliable = 0, for iaq-index-accuracy
  • accuracy-low = 1, for iaq-index-accuracy
  • accuracy-medium = 2, for iaq-index-accuracy
  • accuracy-high = 3, for iaq-index-accuracy
tinkerforge call air-quality-bricklet <uid> set-temperature-offset <offset>
Parameters:
  • <offset> -- int
Output:

no output

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.

tinkerforge call air-quality-bricklet <uid> get-temperature-offset
Output:
  • offset -- int

Returns the temperature offset as set by set-temperature-offset.

tinkerforge call air-quality-bricklet <uid> get-iaq-index
Output:
  • iaq-index -- int
  • iaq-index-accuracy -- int (has symbols)

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 iaq-index callback. You can set the callback configuration with set-iaq-index-callback-configuration.

The following symbols are available for this function:

  • accuracy-unreliable = 0, for iaq-index-accuracy
  • accuracy-low = 1, for iaq-index-accuracy
  • accuracy-medium = 2, for iaq-index-accuracy
  • accuracy-high = 3, for iaq-index-accuracy
tinkerforge call air-quality-bricklet <uid> get-temperature
Output:
  • temperature -- int

Returns temperature in steps of 0.01 °C.

If you want to get the value periodically, it is recommended to use the temperature callback. You can set the callback configuration with set-temperature-callback-configuration.

tinkerforge call air-quality-bricklet <uid> get-humidity
Output:
  • 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 humidity callback. You can set the callback configuration with set-humidity-callback-configuration.

tinkerforge call air-quality-bricklet <uid> get-air-pressure
Output:
  • 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 air-pressure callback. You can set the callback configuration with set-air-pressure-callback-configuration.

Advanced Functions

tinkerforge call air-quality-bricklet <uid> get-spitfp-error-count
Output:
  • error-count-ack-checksum -- int
  • error-count-message-checksum -- int
  • error-count-frame -- int
  • error-count-overflow -- 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.

tinkerforge call air-quality-bricklet <uid> set-bootloader-mode <mode>
Parameters:
  • <mode> -- int (has symbols)
Output:
  • status -- int (has symbols)

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

  • bootloader-mode-bootloader = 0, for <mode>
  • bootloader-mode-firmware = 1, for <mode>
  • bootloader-mode-bootloader-wait-for-reboot = 2, for <mode>
  • bootloader-mode-firmware-wait-for-reboot = 3, for <mode>
  • bootloader-mode-firmware-wait-for-erase-and-reboot = 4, for <mode>
  • bootloader-status-ok = 0, for status
  • bootloader-status-invalid-mode = 1, for status
  • bootloader-status-no-change = 2, for status
  • bootloader-status-entry-function-not-present = 3, for status
  • bootloader-status-device-identifier-incorrect = 4, for status
  • bootloader-status-crc-mismatch = 5, for status
tinkerforge call air-quality-bricklet <uid> get-bootloader-mode
Output:
  • mode -- int (has symbols)

Returns the current bootloader mode, see set-bootloader-mode.

The following symbols are available for this function:

  • bootloader-mode-bootloader = 0, for mode
  • bootloader-mode-firmware = 1, for mode
  • bootloader-mode-bootloader-wait-for-reboot = 2, for mode
  • bootloader-mode-firmware-wait-for-reboot = 3, for mode
  • bootloader-mode-firmware-wait-for-erase-and-reboot = 4, for mode
tinkerforge call air-quality-bricklet <uid> set-write-firmware-pointer <pointer>
Parameters:
  • <pointer> -- int
Output:

no output

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.

tinkerforge call air-quality-bricklet <uid> write-firmware <data>
Parameters:
  • <data> -- int,int,..61x..,int
Output:
  • status -- 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.

tinkerforge call air-quality-bricklet <uid> set-status-led-config <config>
Parameters:
  • <config> -- int (has symbols)
Output:

no output

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

  • status-led-config-off = 0, for <config>
  • status-led-config-on = 1, for <config>
  • status-led-config-show-heartbeat = 2, for <config>
  • status-led-config-show-status = 3, for <config>
tinkerforge call air-quality-bricklet <uid> get-status-led-config
Output:
  • config -- int (has symbols)

Returns the configuration as set by set-status-led-config

The following symbols are available for this function:

  • status-led-config-off = 0, for config
  • status-led-config-on = 1, for config
  • status-led-config-show-heartbeat = 2, for config
  • status-led-config-show-status = 3, for config
tinkerforge call air-quality-bricklet <uid> get-chip-temperature
Output:
  • 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.

tinkerforge call air-quality-bricklet <uid> reset
Output:no output

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!

tinkerforge call air-quality-bricklet <uid> write-uid <uid>
Parameters:
  • <uid> -- int
Output:

no output

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.

tinkerforge call air-quality-bricklet <uid> read-uid
Output:
  • uid -- int

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

tinkerforge call air-quality-bricklet <uid> get-identity
Output:
  • uid -- string
  • connected-uid -- string
  • position -- char
  • hardware-version -- int,int,int
  • firmware-version -- int,int,int
  • device-identifier -- int (has symbols)

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

tinkerforge call air-quality-bricklet <uid> set-all-values-callback-configuration <period> <value-has-to-change>
Parameters:
  • <period> -- int
  • <value-has-to-change> -- bool
Output:

no output

The period in ms is the period with which the 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).

tinkerforge call air-quality-bricklet <uid> get-all-values-callback-configuration
Output:
  • period -- int
  • value-has-to-change -- bool

Returns the callback configuration as set by set-all-values-callback-configuration.

tinkerforge call air-quality-bricklet <uid> set-iaq-index-callback-configuration <period> <value-has-to-change>
Parameters:
  • <period> -- int
  • <value-has-to-change> -- bool
Output:

no output

The period in ms is the period with which the 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).

tinkerforge call air-quality-bricklet <uid> get-iaq-index-callback-configuration
Output:
  • period -- int
  • value-has-to-change -- bool

Returns the callback configuration as set by set-iaq-index-callback-configuration.

tinkerforge call air-quality-bricklet <uid> set-temperature-callback-configuration <period> <value-has-to-change> <option> <min> <max>
Parameters:
  • <period> -- int
  • <value-has-to-change> -- bool
  • <option> -- char (has symbols)
  • <min> -- int
  • <max> -- int
Output:

no output

The period in ms is the period with which the 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 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 symbols are available for this function:

  • threshold-option-off = x, for <option>
  • threshold-option-outside = o, for <option>
  • threshold-option-inside = i, for <option>
  • threshold-option-smaller = <, for <option>
  • threshold-option-greater = >, for <option>
tinkerforge call air-quality-bricklet <uid> get-temperature-callback-configuration
Output:
  • period -- int
  • value-has-to-change -- bool
  • option -- char (has symbols)
  • min -- int
  • max -- int

Returns the callback configuration as set by set-temperature-callback-configuration.

The following symbols are available for this function:

  • threshold-option-off = x, for option
  • threshold-option-outside = o, for option
  • threshold-option-inside = i, for option
  • threshold-option-smaller = <, for option
  • threshold-option-greater = >, for option
tinkerforge call air-quality-bricklet <uid> set-humidity-callback-configuration <period> <value-has-to-change> <option> <min> <max>
Parameters:
  • <period> -- int
  • <value-has-to-change> -- bool
  • <option> -- char (has symbols)
  • <min> -- int
  • <max> -- int
Output:

no output

The period in ms is the period with which the 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 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 symbols are available for this function:

  • threshold-option-off = x, for <option>
  • threshold-option-outside = o, for <option>
  • threshold-option-inside = i, for <option>
  • threshold-option-smaller = <, for <option>
  • threshold-option-greater = >, for <option>
tinkerforge call air-quality-bricklet <uid> get-humidity-callback-configuration
Output:
  • period -- int
  • value-has-to-change -- bool
  • option -- char (has symbols)
  • min -- int
  • max -- int

Returns the callback configuration as set by set-humidity-callback-configuration.

The following symbols are available for this function:

  • threshold-option-off = x, for option
  • threshold-option-outside = o, for option
  • threshold-option-inside = i, for option
  • threshold-option-smaller = <, for option
  • threshold-option-greater = >, for option
tinkerforge call air-quality-bricklet <uid> set-air-pressure-callback-configuration <period> <value-has-to-change> <option> <min> <max>
Parameters:
  • <period> -- int
  • <value-has-to-change> -- bool
  • <option> -- char (has symbols)
  • <min> -- int
  • <max> -- int
Output:

no output

The period in ms is the period with which the 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 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 symbols are available for this function:

  • threshold-option-off = x, for <option>
  • threshold-option-outside = o, for <option>
  • threshold-option-inside = i, for <option>
  • threshold-option-smaller = <, for <option>
  • threshold-option-greater = >, for <option>
tinkerforge call air-quality-bricklet <uid> get-air-pressure-callback-configuration
Output:
  • period -- int
  • value-has-to-change -- bool
  • option -- char (has symbols)
  • min -- int
  • max -- int

Returns the callback configuration as set by set-air-pressure-callback-configuration.

The following symbols are available for this function:

  • threshold-option-off = x, for option
  • threshold-option-outside = o, for option
  • threshold-option-inside = i, for option
  • threshold-option-smaller = <, for option
  • threshold-option-greater = >, for option

Callbacks

Callbacks can be used to receive time critical or recurring data from the device:

tinkerforge dispatch air-quality-bricklet <uid> example

The available callbacks 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.

tinkerforge dispatch air-quality-bricklet <uid> all-values
Output:
  • iaq-index -- int
  • iaq-index-accuracy -- int (has symbols)
  • 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 symbols are available for this function:

  • accuracy-unreliable = 0, for iaq-index-accuracy
  • accuracy-low = 1, for iaq-index-accuracy
  • accuracy-medium = 2, for iaq-index-accuracy
  • accuracy-high = 3, for iaq-index-accuracy
tinkerforge dispatch air-quality-bricklet <uid> iaq-index
Output:
  • iaq-index -- int
  • iaq-index-accuracy -- int (has symbols)

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

  • accuracy-unreliable = 0, for iaq-index-accuracy
  • accuracy-low = 1, for iaq-index-accuracy
  • accuracy-medium = 2, for iaq-index-accuracy
  • accuracy-high = 3, for iaq-index-accuracy
tinkerforge dispatch air-quality-bricklet <uid> temperature
Output:
  • 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.

tinkerforge dispatch air-quality-bricklet <uid> humidity
Output:
  • 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.

tinkerforge dispatch air-quality-bricklet <uid> air-pressure
Output:
  • 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.