Software / API Bindings / MATLAB/Octave / API Reference and Examples / Bricklets / Air Quality Bricklet

MATLAB/Octave - Air Quality Bricklet¶

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

Examples¶

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

Simple (MATLAB)¶

Download (matlab_example_simple.m)

function matlab_example_simple()
    import com.tinkerforge.IPConnection;
    import com.tinkerforge.BrickletAirQuality;

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

    ipcon = IPConnection(); % Create IP connection
    aq = handle(BrickletAirQuality(UID, ipcon), 'CallbackProperties'); % Create device object

    ipcon.connect(HOST, PORT); % Connect to brickd
    % Don't use device before ipcon is connected

    % Get current all values
    allValues = aq.getAllValues();

    fprintf('IAQ Index: %i\n', allValues.iaqIndex);

    if allValues.iaqIndexAccuracy == BrickletAirQuality.ACCURACY_UNRELIABLE
        fprintf('IAQ Index Accuracy: Unreliable\n');
    elseif allValues.iaqIndexAccuracy == BrickletAirQuality.ACCURACY_LOW
        fprintf('IAQ Index Accuracy: Low\n');
    elseif allValues.iaqIndexAccuracy == BrickletAirQuality.ACCURACY_MEDIUM
        fprintf('IAQ Index Accuracy: Medium\n');
    elseif allValues.iaqIndexAccuracy == BrickletAirQuality.ACCURACY_HIGH
        fprintf('IAQ Index Accuracy: High\n');
    end

    fprintf('Temperature: %g °C\n', allValues.temperature/100.0);
    fprintf('Humidity: %g %%RH\n', allValues.humidity/100.0);
    fprintf('Air Pressure: %g hPa\n', allValues.airPressure/100.0);

    input('Press key to exit\n', 's');
    ipcon.disconnect();
end

Callback (MATLAB)¶

Download (matlab_example_callback.m)

function matlab_example_callback()
    import com.tinkerforge.IPConnection;
    import com.tinkerforge.BrickletAirQuality;

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

    ipcon = IPConnection(); % Create IP connection
    aq = handle(BrickletAirQuality(UID, ipcon), 'CallbackProperties'); % Create device object

    ipcon.connect(HOST, PORT); % Connect to brickd
    % Don't use device before ipcon is connected

    % Register all values callback to function cb_all_values
    set(aq, 'AllValuesCallback', @(h, e) cb_all_values(e));

    % Set period for all values callback to 1s (1000ms)
    aq.setAllValuesCallbackConfiguration(1000, false);

    input('Press key to exit\n', 's');
    ipcon.disconnect();
end

% Callback function for all values callback
function cb_all_values(e)
    fprintf('IAQ Index: %i\n', e.iaqIndex);

    if e.iaqIndexAccuracy == com.tinkerforge.BrickletAirQuality.ACCURACY_UNRELIABLE
        fprintf('IAQ Index Accuracy: Unreliable\n');
    elseif e.iaqIndexAccuracy == com.tinkerforge.BrickletAirQuality.ACCURACY_LOW
        fprintf('IAQ Index Accuracy: Low\n');
    elseif e.iaqIndexAccuracy == com.tinkerforge.BrickletAirQuality.ACCURACY_MEDIUM
        fprintf('IAQ Index Accuracy: Medium\n');
    elseif e.iaqIndexAccuracy == com.tinkerforge.BrickletAirQuality.ACCURACY_HIGH
        fprintf('IAQ Index Accuracy: High\n');
    end

    fprintf('Temperature: %g °C\n', e.temperature/100.0);
    fprintf('Humidity: %g %%RH\n', e.humidity/100.0);
    fprintf('Air Pressure: %g hPa\n', e.airPressure/100.0);
    fprintf('\n');
end

Simple (Octave)¶

Download (octave_example_simple.m)

function octave_example_simple()
    more off;

    HOST = "localhost";
    PORT = 4223;
    UID = "XYZ"; % Change XYZ to the UID of your Air Quality Bricklet

    ipcon = javaObject("com.tinkerforge.IPConnection"); % Create IP connection
    aq = javaObject("com.tinkerforge.BrickletAirQuality", UID, ipcon); % Create device object

    ipcon.connect(HOST, PORT); % Connect to brickd
    % Don't use device before ipcon is connected

    % Get current all values
    allValues = aq.getAllValues();

    fprintf("IAQ Index: %d\n", allValues.iaqIndex);

    if allValues.iaqIndexAccuracy == 0
        fprintf("IAQ Index Accuracy: Unreliable\n");
    elseif allValues.iaqIndexAccuracy == 1
        fprintf("IAQ Index Accuracy: Low\n");
    elseif allValues.iaqIndexAccuracy == 2
        fprintf("IAQ Index Accuracy: Medium\n");
    elseif allValues.iaqIndexAccuracy == 3
        fprintf("IAQ Index Accuracy: High\n");
    end

    fprintf("Temperature: %g °C\n", allValues.temperature/100.0);
    fprintf("Humidity: %g %%RH\n", allValues.humidity/100.0);
    fprintf("Air Pressure: %g hPa\n", allValues.airPressure/100.0);

    input("Press key to exit\n", "s");
    ipcon.disconnect();
end

Callback (Octave)¶

Download (octave_example_callback.m)

function octave_example_callback()
    more off;

    HOST = "localhost";
    PORT = 4223;
    UID = "XYZ"; % Change XYZ to the UID of your Air Quality Bricklet

    ipcon = javaObject("com.tinkerforge.IPConnection"); % Create IP connection
    aq = javaObject("com.tinkerforge.BrickletAirQuality", UID, ipcon); % Create device object

    ipcon.connect(HOST, PORT); % Connect to brickd
    % Don't use device before ipcon is connected

    % Register all values callback to function cb_all_values
    aq.addAllValuesCallback(@cb_all_values);

    % Set period for all values callback to 1s (1000ms)
    aq.setAllValuesCallbackConfiguration(1000, false);

    input("Press key to exit\n", "s");
    ipcon.disconnect();
end

% Callback function for all values callback
function cb_all_values(e)
    fprintf("IAQ Index: %d\n", e.iaqIndex);

    if e.iaqIndexAccuracy == 0
        fprintf("IAQ Index Accuracy: Unreliable\n");
    elseif e.iaqIndexAccuracy == 1
        fprintf("IAQ Index Accuracy: Low\n");
    elseif e.iaqIndexAccuracy == 2
        fprintf("IAQ Index Accuracy: Medium\n");
    elseif e.iaqIndexAccuracy == 3
        fprintf("IAQ Index Accuracy: High\n");
    end

    fprintf("Temperature: %g °C\n", e.temperature/100.0);
    fprintf("Humidity: %g %%RH\n", e.humidity/100.0);
    fprintf("Air Pressure: %g hPa\n", e.airPressure/100.0);
    fprintf("\n");
end

API¶

Generally, every method of the MATLAB bindings that returns a value can throw a TimeoutException. This exception gets thrown if the device did not respond. If a cable based connection is used, it is unlikely that this exception gets thrown (assuming nobody unplugs the device). However, if a wireless connection is used, timeouts will occur if the distance to the device gets too big.

Beside the TimeoutException there is also a NotConnectedException that is thrown if a method needs to communicate with the device while the IP Connection is not connected.

Since the MATLAB bindings are based on Java and Java does not support multiple return values and return by reference is not possible for primitive types, we use small classes that only consist of member variables. The member variables of the returned objects are described in the corresponding method descriptions.

The package for all Brick/Bricklet bindings and the IP Connection is com.tinkerforge.*

All methods listed below are thread-safe.

Basic Functions¶

class BrickletAirQuality(String uid, IPConnection ipcon)¶

Parameters:	uid – Type: String ipcon – Type: IPConnection
Returns:	airQuality – Type: BrickletAirQuality

Creates an object with the unique device ID uid.

In MATLAB:

import com.tinkerforge.BrickletAirQuality;

airQuality = BrickletAirQuality('YOUR_DEVICE_UID', ipcon);

In Octave:

airQuality = java_new("com.tinkerforge.BrickletAirQuality", "YOUR_DEVICE_UID", ipcon);

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

BrickletAirQuality.AllValues BrickletAirQuality.getAllValues()¶

Return Object:	iaqIndex – Type: int, Range: [0 to 500] iaqIndexAccuracy – 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] airPressure – 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 iaqIndexAccuracy:

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

void BrickletAirQuality.setTemperatureOffset(int offset)¶

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.

int BrickletAirQuality.getTemperatureOffset()¶

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

Returns the temperature offset as set by setTemperatureOffset().

BrickletAirQuality.IAQIndex BrickletAirQuality.getIAQIndex()¶

Return Object:	iaqIndex – Type: int, Range: [0 to 500] iaqIndexAccuracy – 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 IAQIndexCallback callback. You can set the callback configuration with setIAQIndexCallbackConfiguration().

The following constants are available for this function:

For iaqIndexAccuracy:

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

int BrickletAirQuality.getTemperature()¶

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 TemperatureCallback callback. You can set the callback configuration with setTemperatureCallbackConfiguration().

int BrickletAirQuality.getHumidity()¶

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 HumidityCallback callback. You can set the callback configuration with setHumidityCallbackConfiguration().

int BrickletAirQuality.getAirPressure()¶

Returns:	airPressure – 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 AirPressureCallback callback. You can set the callback configuration with setAirPressureCallbackConfiguration().

Advanced Functions¶

void BrickletAirQuality.removeCalibration()¶

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

void BrickletAirQuality.setBackgroundCalibrationDuration(int duration)¶

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

int BrickletAirQuality.getBackgroundCalibrationDuration()¶

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

Returns the background calibration duration as set by setBackgroundCalibrationDuration().

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.SPITFPErrorCount BrickletAirQuality.getSPITFPErrorCount()¶

Return Object:	errorCountAckChecksum – Type: long, Range: [0 to 2³² - 1] errorCountMessageChecksum – Type: long, Range: [0 to 2³² - 1] errorCountFrame – Type: long, Range: [0 to 2³² - 1] errorCountOverflow – Type: long, 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.

void BrickletAirQuality.setStatusLEDConfig(int config)¶

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

int BrickletAirQuality.getStatusLEDConfig()¶

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

Returns the configuration as set by setStatusLEDConfig()

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

int BrickletAirQuality.getChipTemperature()¶

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.

void BrickletAirQuality.reset()¶

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.Identity BrickletAirQuality.getIdentity()¶

Return Object:

Return Object:	uid – Type: String, Length: up to 8 connectedUid – Type: String, Length: up to 8 position – Type: char, Range: ['a' to 'h', 'z'] hardwareVersion – Type: short[], Length: 3 1: major – Type: short, Range: [0 to 255] 2: minor – Type: short, Range: [0 to 255] 3: revision – Type: short, Range: [0 to 255] firmwareVersion – Type: short[], Length: 3 1: major – Type: short, Range: [0 to 255] 2: minor – Type: short, Range: [0 to 255] 3: revision – Type: short, Range: [0 to 255] deviceIdentifier – Type: int, Range: [0 to 2¹⁶ - 1]

uid – Type: String, Length: up to 8
connectedUid – Type: String, Length: up to 8
position – Type: char, Range: ['a' to 'h', 'z']
hardwareVersion – Type: short[], Length: 3

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

firmwareVersion – Type: short[], Length: 3

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

deviceIdentifier – 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¶

void BrickletAirQuality.setAllValuesCallbackConfiguration(long period, boolean valueHasToChange)¶

Parameters:	period – Type: long, Unit: 1 ms, Range: [0 to 2³² - 1], Default: 0 valueHasToChange – Type: boolean, Default: false

The period is the period with which the AllValuesCallback 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.AllValuesCallbackConfiguration BrickletAirQuality.getAllValuesCallbackConfiguration()¶

Return Object:	period – Type: long, Unit: 1 ms, Range: [0 to 2³² - 1], Default: 0 valueHasToChange – Type: boolean, Default: false

Returns the callback configuration as set by setAllValuesCallbackConfiguration().

void BrickletAirQuality.setIAQIndexCallbackConfiguration(long period, boolean valueHasToChange)¶

Parameters:	period – Type: long, Unit: 1 ms, Range: [0 to 2³² - 1], Default: 0 valueHasToChange – Type: boolean, Default: false

The period is the period with which the IAQIndexCallback 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.IAQIndexCallbackConfiguration BrickletAirQuality.getIAQIndexCallbackConfiguration()¶

Return Object:	period – Type: long, Unit: 1 ms, Range: [0 to 2³² - 1], Default: 0 valueHasToChange – Type: boolean, Default: false

Returns the callback configuration as set by setIAQIndexCallbackConfiguration().

void BrickletAirQuality.setTemperatureCallbackConfiguration(long period, boolean valueHasToChange, char option, int min, int max)¶

Parameters:	period – Type: long, Unit: 1 ms, Range: [0 to 2³² - 1], Default: 0 valueHasToChange – Type: boolean, Default: false option – Type: char, 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 TemperatureCallback 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 TemperatureCallback 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.TemperatureCallbackConfiguration BrickletAirQuality.getTemperatureCallbackConfiguration()¶

Return Object:	period – Type: long, Unit: 1 ms, Range: [0 to 2³² - 1], Default: 0 valueHasToChange – Type: boolean, Default: false option – Type: char, 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

Returns the callback configuration as set by setTemperatureCallbackConfiguration().

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 = '>'

void BrickletAirQuality.setHumidityCallbackConfiguration(long period, boolean valueHasToChange, char option, int min, int max)¶

Parameters:	period – Type: long, Unit: 1 ms, Range: [0 to 2³² - 1], Default: 0 valueHasToChange – Type: boolean, Default: false option – Type: char, 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 HumidityCallback 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 HumidityCallback 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.HumidityCallbackConfiguration BrickletAirQuality.getHumidityCallbackConfiguration()¶

Return Object:	period – Type: long, Unit: 1 ms, Range: [0 to 2³² - 1], Default: 0 valueHasToChange – Type: boolean, Default: false option – Type: char, 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

Returns the callback configuration as set by setHumidityCallbackConfiguration().

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 = '>'

void BrickletAirQuality.setAirPressureCallbackConfiguration(long period, boolean valueHasToChange, char option, int min, int max)¶

Parameters:	period – Type: long, Unit: 1 ms, Range: [0 to 2³² - 1], Default: 0 valueHasToChange – Type: boolean, Default: false option – Type: char, 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 AirPressureCallback 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 AirPressureCallback 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.AirPressureCallbackConfiguration BrickletAirQuality.getAirPressureCallbackConfiguration()¶

Return Object:	period – Type: long, Unit: 1 ms, Range: [0 to 2³² - 1], Default: 0 valueHasToChange – Type: boolean, Default: false option – Type: char, 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

Returns the callback configuration as set by setAirPressureCallbackConfiguration().

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 "set" function of MATLAB. The parameters consist of the IP Connection object, the callback name and the callback function. For example, it looks like this in MATLAB:

function my_callback(e)
    fprintf('Parameter: %s\n', e.param);
end

set(device, 'ExampleCallback', @(h, e) my_callback(e));

Due to a difference in the Octave Java support the "set" function cannot be used in Octave. The registration is done with "add*Callback" functions of the device object. It looks like this in Octave:

function my_callback(e)
    fprintf("Parameter: %s\n", e.param);
end

device.addExampleCallback(@my_callback);

It is possible to add several callbacks and to remove them with the corresponding "remove*Callback" function.

The parameters of the callback are passed to the callback function as fields of the structure e, which is derived from the java.util.EventObject class. The available callback names with corresponding structure fields 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.

callback BrickletAirQuality.AllValuesCallback¶

Event Object:	iaqIndex – Type: int, Range: [0 to 500] iaqIndexAccuracy – 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] airPressure – Type: int, Unit: 1/100 hPa, Range: [-2³¹ to 2³¹ - 1]

This callback is triggered periodically according to the configuration set by setAllValuesCallbackConfiguration().

The parameters are the same as getAllValues().

The following constants are available for this function:

For iaqIndexAccuracy:

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

In MATLAB the set() function can be used to register a callback function to this callback.

In Octave a callback function can be added to this callback using the addAllValuesCallback() function. An added callback function can be removed with the removeAllValuesCallback() function.

callback BrickletAirQuality.IAQIndexCallback¶

Event Object:	iaqIndex – Type: int, Range: [0 to 500] iaqIndexAccuracy – Type: int, Range: See constants

This callback is triggered periodically according to the configuration set by setIAQIndexCallbackConfiguration().

The parameters are the same as getIAQIndex().

The following constants are available for this function:

For iaqIndexAccuracy:

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

In MATLAB the set() function can be used to register a callback function to this callback.

In Octave a callback function can be added to this callback using the addIAQIndexCallback() function. An added callback function can be removed with the removeIAQIndexCallback() function.

callback BrickletAirQuality.TemperatureCallback¶

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

This callback is triggered periodically according to the configuration set by setTemperatureCallbackConfiguration().

The parameter is the same as getTemperature().

In MATLAB the set() function can be used to register a callback function to this callback.

In Octave a callback function can be added to this callback using the addTemperatureCallback() function. An added callback function can be removed with the removeTemperatureCallback() function.

callback BrickletAirQuality.HumidityCallback¶

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

This callback is triggered periodically according to the configuration set by setHumidityCallbackConfiguration().

The parameter is the same as getHumidity().

In MATLAB the set() function can be used to register a callback function to this callback.

In Octave a callback function can be added to this callback using the addHumidityCallback() function. An added callback function can be removed with the removeHumidityCallback() function.

callback BrickletAirQuality.AirPressureCallback¶

Event Object:	airPressure – Type: int, Unit: 1/100 hPa, Range: [-2³¹ to 2³¹ - 1]

This callback is triggered periodically according to the configuration set by setAirPressureCallbackConfiguration().

The parameter is the same as getAirPressure().

In MATLAB the set() function can be used to register a callback function to this callback.

In Octave a callback function can be added to this callback using the addAirPressureCallback() function. An added callback function can be removed with the removeAirPressureCallback() function.

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.

short[] BrickletAirQuality.getAPIVersion()¶

Return Object:	apiVersion – Type: short[], Length: 3 1: major – Type: short, Range: [0 to 255] 2: minor – Type: short, Range: [0 to 255] 3: revision – Type: short, 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.

boolean BrickletAirQuality.getResponseExpected(byte functionId)¶

Parameters:	functionId – Type: byte, Range: See constants
Returns:	responseExpected – Type: boolean

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 setResponseExpected(). 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 functionId:

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

void BrickletAirQuality.setResponseExpected(byte functionId, boolean responseExpected)¶

Parameters:	functionId – Type: byte, Range: See constants responseExpected – Type: boolean

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 functionId:

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

void BrickletAirQuality.setResponseExpectedAll(boolean responseExpected)¶

Parameters:	responseExpected – Type: boolean

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.

int BrickletAirQuality.setBootloaderMode(int mode)¶

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

int BrickletAirQuality.getBootloaderMode()¶

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

Returns the current bootloader mode, see setBootloaderMode().

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

void BrickletAirQuality.setWriteFirmwarePointer(long pointer)¶

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

Sets the firmware pointer for writeFirmware(). 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.

int BrickletAirQuality.writeFirmware(int[] data)¶

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

void BrickletAirQuality.writeUID(long uid)¶

Parameters:	uid – Type: long, 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.

long BrickletAirQuality.readUID()¶

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

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

Constants¶

int BrickletAirQuality.DEVICE_IDENTIFIER¶

This constant is used to identify a Air Quality Bricklet.

The getIdentity() function and the IPConnection.EnumerateCallback callback of the IP Connection have a deviceIdentifier parameter to specify the Brick's or Bricklet's type.

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