Deutsch
English
Menu
Software / API Bindings / Mathematica / API Reference and Examples / Bricklets / Air Quality Bricklet

Mathematica - Air Quality Bricklet

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

Examples

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

Simple

Download (ExampleSimple.nb)

 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
Needs["NETLink`"]
LoadNETAssembly["Tinkerforge",NotebookDirectory[]<>"../../.."]

host="localhost"
port=4223
uid="XYZ"(*Change XYZ to the UID of your Air Quality Bricklet*)

(*Create IPConnection and device object*)
ipcon=NETNew["Tinkerforge.IPConnection"]
aq=NETNew["Tinkerforge.BrickletAirQuality",uid,ipcon]
ipcon@Connect[host,port]

(*Get current all values*)
iaqIndex=0;iaqIndexAccuracy=0;temperature=0;humidity=0;airPressure=0
aq@GetAllValues[iaqIndex,iaqIndexAccuracy,temperature,humidity,airPressure]

Print["IAQ Index: "<>ToString[iaqIndex]]
If[iaqIndexAccuracy==Tinkerforge`BrickletAirQuality`ACCURACYUUNRELIABLE,Print["IAQ Index Accuracy: Unreliable"]]
If[iaqIndexAccuracy==Tinkerforge`BrickletAirQuality`ACCURACYULOW,Print["IAQ Index Accuracy: Low"]]
If[iaqIndexAccuracy==Tinkerforge`BrickletAirQuality`ACCURACYUMEDIUM,Print["IAQ Index Accuracy: Medium"]]
If[iaqIndexAccuracy==Tinkerforge`BrickletAirQuality`ACCURACYUHIGH,Print["IAQ Index Accuracy: High"]]
Print["Temperature: "<>ToString[N[Quantity[temperature,"°C/100"]]]]
Print["Humidity: "<>ToString[N[Quantity[humidity,"%RH/100"]]]]
Print["Air Pressure: "<>ToString[N[Quantity[airPressure,"hPa/100"]]]]

(*Clean up*)
ipcon@Disconnect[]
ReleaseNETObject[aq]
ReleaseNETObject[ipcon]

Callback

Download (ExampleCallback.nb)

 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
Needs["NETLink`"]
LoadNETAssembly["Tinkerforge",NotebookDirectory[]<>"../../.."]

host="localhost"
port=4223
uid="XYZ"(*Change XYZ to the UID of your Air Quality Bricklet*)

(*Create IPConnection and device object*)
ipcon=NETNew["Tinkerforge.IPConnection"]
aq=NETNew["Tinkerforge.BrickletAirQuality",uid,ipcon]
ipcon@Connect[host,port]

(*Callback function for all values callback*)
AllValuesCB[sender_,iaqIndex_,iaqIndexAccuracy_,temperature_,humidity_,airPressure_]:=
 Module[{},
  Print["IAQ Index: "<>ToString[iaqIndex]];
  If[iaqIndexAccuracy==Tinkerforge`BrickletAirQuality`ACCURACYUUNRELIABLE,Print["IAQ Index Accuracy: Unreliable"]];
  If[iaqIndexAccuracy==Tinkerforge`BrickletAirQuality`ACCURACYULOW,Print["IAQ Index Accuracy: Low"]];
  If[iaqIndexAccuracy==Tinkerforge`BrickletAirQuality`ACCURACYUMEDIUM,Print["IAQ Index Accuracy: Medium"]];
  If[iaqIndexAccuracy==Tinkerforge`BrickletAirQuality`ACCURACYUHIGH,Print["IAQ Index Accuracy: High"]];
  Print["Temperature: "<>ToString[N[Quantity[temperature,"°C/100"]]]];
  Print["Humidity: "<>ToString[N[Quantity[humidity,"%RH/100"]]]];
  Print["Air Pressure: "<>ToString[N[Quantity[airPressure,"hPa/100"]]]]
 ]

AddEventHandler[aq@AllValuesCallback,AllValuesCB]

(*Set period for all values callback to 1s (1000ms)*)
aq@SetAllValuesCallbackConfiguration[1000,False]

Input["Click OK to exit"]

(*Clean up*)
ipcon@Disconnect[]
ReleaseNETObject[aq]
ReleaseNETObject[ipcon]

API

Generally, every function of the Mathematica bindings that returns a value can throw a Tinkerforge.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 plugs the device out). However, if a wireless connection is used, timeouts will occur if the distance to the device gets too big.

Since .NET/Link does not support multiple return values directly, we use the out keyword to return multiple values from a function. For further information about the out keyword in .NET/Link see the corresponding Mathematica .NET/Link documentation.

The namespace for all Brick/Bricklet bindings and the IPConnection is Tinkerforge.*.

Basic Functions

BrickletAirQuality[uid, ipcon] → airQuality
Parameters:
  • uid – Type: String
  • ipcon – Type: NETObject[IPConnection]
Returns:
  • airQuality – Type: NETObject[BrickletAirQuality]

Creates an object with the unique device ID uid:

airQuality=NETNew["Tinkerforge.BrickletAirQuality","YOUR_DEVICE_UID",ipcon]

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

The .NET runtime has built-in garbage collection that frees objects that are no longer in use by a program. But because Mathematica can not automatically tell when a Mathematica "program" doesn't use a .NET object anymore, this has to be done by the program. For this the ReleaseNETObject[] function is used in the examples.

For further information about object management in .NET/Link see the corresponding Mathematica .NET/Link documentation.

BrickletAirQuality@GetAllValues[out iaqIndex, out iaqIndexAccuracy, out temperature, out humidity, out airPressure] → Null
Output Parameters:
  • iaqIndex – Type: Integer, Range: [0 to 500]
  • iaqIndexAccuracy – Type: Integer, Range: See constants
  • temperature – Type: Integer, Unit: 1/100 °C, Range: [-231 to 231 - 1]
  • humidity – Type: Integer, Unit: 1/100 %, Range: [-231 to 231 - 1]
  • airPressure – Type: Integer, Unit: 1/100 hPa, Range: [-231 to 231 - 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.

Air Quality Index description

The following constants are available for this function:

For iaqIndexAccuracy:

  • BrickletAirQuality`ACCURACYUUNRELIABLE = 0
  • BrickletAirQuality`ACCURACYULOW = 1
  • BrickletAirQuality`ACCURACYUMEDIUM = 2
  • BrickletAirQuality`ACCURACYUHIGH = 3
BrickletAirQuality@SetTemperatureOffset[offset] → Null
Parameters:
  • offset – Type: Integer, Unit: 1/100 °C, Range: [-231 to 231 - 1]

Sets a temperature offset. A offset of 10 will decrease the measured temperature by 0.1 °C.

If you install this Bricklet into an enclosure and you want to measure the ambient temperature, you may have to decrease the measured temperature by some value to compensate for the error because of the heating inside of the enclosure.

We recommend that you leave the parts in the enclosure running for at least 24 hours such that a temperature equilibrium can be reached. After that you can measure the temperature directly outside of enclosure and set the difference as offset.

This temperature offset is used to calculate the relative humidity and IAQ index measurements. In case the Bricklet is installed in an enclosure, we recommend to measure and set the temperature offset to improve the accuracy of the measurements.

BrickletAirQuality@GetTemperatureOffset[] → offset
Returns:
  • offset – Type: Integer, Unit: 1/100 °C, Range: [-231 to 231 - 1]

Returns the temperature offset as set by SetTemperatureOffset[].

BrickletAirQuality@GetIAQIndex[out iaqIndex, out iaqIndexAccuracy] → Null
Output Parameters:
  • iaqIndex – Type: Integer, Range: [0 to 500]
  • iaqIndexAccuracy – Type: Integer, Range: See constants

Returns the IAQ index and accuracy. 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 IAQIndexCallback callback. You can set the callback configuration with SetIAQIndexCallbackConfiguration[].

The following constants are available for this function:

For iaqIndexAccuracy:

  • BrickletAirQuality`ACCURACYUUNRELIABLE = 0
  • BrickletAirQuality`ACCURACYULOW = 1
  • BrickletAirQuality`ACCURACYUMEDIUM = 2
  • BrickletAirQuality`ACCURACYUHIGH = 3
BrickletAirQuality@GetTemperature[] → temperature
Returns:
  • temperature – Type: Integer, Unit: 1/100 °C, Range: [-231 to 231 - 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[].

BrickletAirQuality@GetHumidity[] → humidity
Returns:
  • humidity – Type: Integer, Unit: 1/100 %, Range: [-231 to 231 - 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[].

BrickletAirQuality@GetAirPressure[] → airPressure
Returns:
  • airPressure – Type: Integer, Unit: 1/100 hPa, Range: [-231 to 231 - 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

BrickletAirQuality@RemoveCalibration[] → Null

Deletes the calibration from flash. After you call this function, you need to power cycle the Air Quality Bricklet.

On the next power up the Bricklet will start a new calibration, as if it was started for the very first time.

The calibration is based on the data of the last four days, so it takes four days until a full calibration is re-established.

New in version 2.0.3 (Plugin).

BrickletAirQuality@SetBackgroundCalibrationDuration[duration] → Null
Parameters:
  • duration – Type: Integer, 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`DURATIONU4UDAYS = 0
  • BrickletAirQuality`DURATIONU28UDAYS = 1

New in version 2.0.3 (Plugin).

BrickletAirQuality@GetBackgroundCalibrationDuration[] → duration
Returns:
  • duration – Type: Integer, 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`DURATIONU4UDAYS = 0
  • BrickletAirQuality`DURATIONU28UDAYS = 1

New in version 2.0.3 (Plugin).

BrickletAirQuality@GetSPITFPErrorCount[out errorCountAckChecksum, out errorCountMessageChecksum, out errorCountFrame, out errorCountOverflow] → Null
Output Parameters:
  • errorCountAckChecksum – Type: Integer, Range: [0 to 232 - 1]
  • errorCountMessageChecksum – Type: Integer, Range: [0 to 232 - 1]
  • errorCountFrame – Type: Integer, Range: [0 to 232 - 1]
  • errorCountOverflow – Type: Integer, Range: [0 to 232 - 1]

Returns the error count for the communication between Brick and Bricklet.

The errors are divided into

  • ACK checksum errors,
  • message checksum errors,
  • framing errors and
  • overflow errors.

The errors counts are for errors that occur on the Bricklet side. All Bricks have a similar function that returns the errors on the Brick side.

BrickletAirQuality@SetStatusLEDConfig[config] → Null
Parameters:
  • config – Type: Integer, 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`STATUSULEDUCONFIGUOFF = 0
  • BrickletAirQuality`STATUSULEDUCONFIGUON = 1
  • BrickletAirQuality`STATUSULEDUCONFIGUSHOWUHEARTBEAT = 2
  • BrickletAirQuality`STATUSULEDUCONFIGUSHOWUSTATUS = 3
BrickletAirQuality@GetStatusLEDConfig[] → config
Returns:
  • config – Type: Integer, Range: See constants, Default: 3

Returns the configuration as set by SetStatusLEDConfig[]

The following constants are available for this function:

For config:

  • BrickletAirQuality`STATUSULEDUCONFIGUOFF = 0
  • BrickletAirQuality`STATUSULEDUCONFIGUON = 1
  • BrickletAirQuality`STATUSULEDUCONFIGUSHOWUHEARTBEAT = 2
  • BrickletAirQuality`STATUSULEDUCONFIGUSHOWUSTATUS = 3
BrickletAirQuality@GetChipTemperature[] → temperature
Returns:
  • temperature – Type: Integer, Unit: 1 °C, Range: [-215 to 215 - 1]

Returns the temperature as measured inside the microcontroller. The value returned is not the ambient temperature!

The temperature is only proportional to the real temperature and it has bad accuracy. Practically it is only useful as an indicator for temperature changes.

BrickletAirQuality@Reset[] → Null

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@GetIdentity[out uid, out connectedUid, out position, out {hardwareVersion1, hardwareVersion2, hardwareVersion3}, out {firmwareVersion1, firmwareVersion2, firmwareVersion3}, out deviceIdentifier] → Null
Output Parameters:
  • uid – Type: String, Length: up to 8
  • connectedUid – Type: String, Length: up to 8
  • position – Type: Integer, Range: [ToCharacterCode["a"][[0]] to ToCharacterCode["h"][[0]], ToCharacterCode["z"][[0]]]
  • hardwareVersioni – Type: Integer
    • 1: major – Type: Integer, Range: [0 to 255]
    • 2: minor – Type: Integer, Range: [0 to 255]
    • 3: revision – Type: Integer, Range: [0 to 255]
  • firmwareVersioni – Type: Integer
    • 1: major – Type: Integer, Range: [0 to 255]
    • 2: minor – Type: Integer, Range: [0 to 255]
    • 3: revision – Type: Integer, Range: [0 to 255]
  • deviceIdentifier – Type: Integer, Range: [0 to 216 - 1]

Returns the UID, the UID where the Bricklet is connected to, the position, the hardware and firmware version as well as the device identifier.

The position can be 'a', 'b', 'c', 'd', 'e', 'f', 'g' or 'h' (Bricklet Port). A Bricklet connected to an Isolator Bricklet is always at position 'z'.

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

Callback Configuration Functions

BrickletAirQuality@SetAllValuesCallbackConfiguration[period, valueHasToChange] → Null
Parameters:
  • period – Type: Integer, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0
  • valueHasToChange – Type: True/False, 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@GetAllValuesCallbackConfiguration[out period, out valueHasToChange] → Null
Output Parameters:
  • period – Type: Integer, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0
  • valueHasToChange – Type: True/False, Default: False

Returns the callback configuration as set by SetAllValuesCallbackConfiguration[].

BrickletAirQuality@SetIAQIndexCallbackConfiguration[period, valueHasToChange] → Null
Parameters:
  • period – Type: Integer, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0
  • valueHasToChange – Type: True/False, Default: False

The period is the period with which the IAQIndexCallback 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@GetIAQIndexCallbackConfiguration[out period, out valueHasToChange] → Null
Output Parameters:
  • period – Type: Integer, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0
  • valueHasToChange – Type: True/False, Default: False

Returns the callback configuration as set by SetIAQIndexCallbackConfiguration[].

BrickletAirQuality@SetTemperatureCallbackConfiguration[period, valueHasToChange, option, min, max] → Null
Parameters:
  • period – Type: Integer, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0
  • valueHasToChange – Type: True/False, Default: False
  • option – Type: Integer, Range: See constants, Default: ToCharacterCode["x"][[0]]
  • min – Type: Integer, Unit: 1/100 °C, Range: [-231 to 231 - 1], Default: 0
  • max – Type: Integer, Unit: 1/100 °C, Range: [-231 to 231 - 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`THRESHOLDUOPTIONUOFF = ToCharacterCode["x"][[0]]
  • BrickletAirQuality`THRESHOLDUOPTIONUOUTSIDE = ToCharacterCode["o"][[0]]
  • BrickletAirQuality`THRESHOLDUOPTIONUINSIDE = ToCharacterCode["i"][[0]]
  • BrickletAirQuality`THRESHOLDUOPTIONUSMALLER = ToCharacterCode["<"][[0]]
  • BrickletAirQuality`THRESHOLDUOPTIONUGREATER = ToCharacterCode[">"][[0]]
BrickletAirQuality@GetTemperatureCallbackConfiguration[out period, out valueHasToChange, out option, out min, out max] → Null
Output Parameters:
  • period – Type: Integer, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0
  • valueHasToChange – Type: True/False, Default: False
  • option – Type: Integer, Range: See constants, Default: ToCharacterCode["x"][[0]]
  • min – Type: Integer, Unit: 1/100 °C, Range: [-231 to 231 - 1], Default: 0
  • max – Type: Integer, Unit: 1/100 °C, Range: [-231 to 231 - 1], Default: 0

Returns the callback configuration as set by SetTemperatureCallbackConfiguration[].

The following constants are available for this function:

For option:

  • BrickletAirQuality`THRESHOLDUOPTIONUOFF = ToCharacterCode["x"][[0]]
  • BrickletAirQuality`THRESHOLDUOPTIONUOUTSIDE = ToCharacterCode["o"][[0]]
  • BrickletAirQuality`THRESHOLDUOPTIONUINSIDE = ToCharacterCode["i"][[0]]
  • BrickletAirQuality`THRESHOLDUOPTIONUSMALLER = ToCharacterCode["<"][[0]]
  • BrickletAirQuality`THRESHOLDUOPTIONUGREATER = ToCharacterCode[">"][[0]]
BrickletAirQuality@SetHumidityCallbackConfiguration[period, valueHasToChange, option, min, max] → Null
Parameters:
  • period – Type: Integer, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0
  • valueHasToChange – Type: True/False, Default: False
  • option – Type: Integer, Range: See constants, Default: ToCharacterCode["x"][[0]]
  • min – Type: Integer, Unit: 1/100 %, Range: [-231 to 231 - 1], Default: 0
  • max – Type: Integer, Unit: 1/100 %, Range: [-231 to 231 - 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 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 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`THRESHOLDUOPTIONUOFF = ToCharacterCode["x"][[0]]
  • BrickletAirQuality`THRESHOLDUOPTIONUOUTSIDE = ToCharacterCode["o"][[0]]
  • BrickletAirQuality`THRESHOLDUOPTIONUINSIDE = ToCharacterCode["i"][[0]]
  • BrickletAirQuality`THRESHOLDUOPTIONUSMALLER = ToCharacterCode["<"][[0]]
  • BrickletAirQuality`THRESHOLDUOPTIONUGREATER = ToCharacterCode[">"][[0]]
BrickletAirQuality@GetHumidityCallbackConfiguration[out period, out valueHasToChange, out option, out min, out max] → Null
Output Parameters:
  • period – Type: Integer, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0
  • valueHasToChange – Type: True/False, Default: False
  • option – Type: Integer, Range: See constants, Default: ToCharacterCode["x"][[0]]
  • min – Type: Integer, Unit: 1/100 %, Range: [-231 to 231 - 1], Default: 0
  • max – Type: Integer, Unit: 1/100 %, Range: [-231 to 231 - 1], Default: 0

Returns the callback configuration as set by SetHumidityCallbackConfiguration[].

The following constants are available for this function:

For option:

  • BrickletAirQuality`THRESHOLDUOPTIONUOFF = ToCharacterCode["x"][[0]]
  • BrickletAirQuality`THRESHOLDUOPTIONUOUTSIDE = ToCharacterCode["o"][[0]]
  • BrickletAirQuality`THRESHOLDUOPTIONUINSIDE = ToCharacterCode["i"][[0]]
  • BrickletAirQuality`THRESHOLDUOPTIONUSMALLER = ToCharacterCode["<"][[0]]
  • BrickletAirQuality`THRESHOLDUOPTIONUGREATER = ToCharacterCode[">"][[0]]
BrickletAirQuality@SetAirPressureCallbackConfiguration[period, valueHasToChange, option, min, max] → Null
Parameters:
  • period – Type: Integer, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0
  • valueHasToChange – Type: True/False, Default: False
  • option – Type: Integer, Range: See constants, Default: ToCharacterCode["x"][[0]]
  • min – Type: Integer, Unit: 1/100 hPa, Range: [-231 to 231 - 1], Default: 0
  • max – Type: Integer, Unit: 1/100 hPa, Range: [-231 to 231 - 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 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 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`THRESHOLDUOPTIONUOFF = ToCharacterCode["x"][[0]]
  • BrickletAirQuality`THRESHOLDUOPTIONUOUTSIDE = ToCharacterCode["o"][[0]]
  • BrickletAirQuality`THRESHOLDUOPTIONUINSIDE = ToCharacterCode["i"][[0]]
  • BrickletAirQuality`THRESHOLDUOPTIONUSMALLER = ToCharacterCode["<"][[0]]
  • BrickletAirQuality`THRESHOLDUOPTIONUGREATER = ToCharacterCode[">"][[0]]
BrickletAirQuality@GetAirPressureCallbackConfiguration[out period, out valueHasToChange, out option, out min, out max] → Null
Output Parameters:
  • period – Type: Integer, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0
  • valueHasToChange – Type: True/False, Default: False
  • option – Type: Integer, Range: See constants, Default: ToCharacterCode["x"][[0]]
  • min – Type: Integer, Unit: 1/100 hPa, Range: [-231 to 231 - 1], Default: 0
  • max – Type: Integer, Unit: 1/100 hPa, Range: [-231 to 231 - 1], Default: 0

Returns the callback configuration as set by SetAirPressureCallbackConfiguration[].

The following constants are available for this function:

For option:

  • BrickletAirQuality`THRESHOLDUOPTIONUOFF = ToCharacterCode["x"][[0]]
  • BrickletAirQuality`THRESHOLDUOPTIONUOUTSIDE = ToCharacterCode["o"][[0]]
  • BrickletAirQuality`THRESHOLDUOPTIONUINSIDE = ToCharacterCode["i"][[0]]
  • BrickletAirQuality`THRESHOLDUOPTIONUSMALLER = ToCharacterCode["<"][[0]]
  • BrickletAirQuality`THRESHOLDUOPTIONUGREATER = ToCharacterCode[">"][[0]]

Callbacks

Callbacks can be registered to receive time critical or recurring data from the device. The registration is done by assigning a function to a callback property of the device object:

MyCallback[sender_,value_]:=Print["Value: "<>ToString[value]]

AddEventHandler[airQuality@ExampleCallback,MyCallback]

For further information about event handling using .NET/Link see the corresponding Mathematica .NET/Link documentation.

The available callback property and their 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.

event BrickletAirQuality@AllValuesCallback[sender, iaqIndex, iaqIndexAccuracy, temperature, humidity, airPressure]
Callback Parameters:
  • sender – Type: NETObject[BrickletAirQuality]
  • iaqIndex – Type: Integer, Range: [0 to 500]
  • iaqIndexAccuracy – Type: Integer, Range: See constants
  • temperature – Type: Integer, Unit: 1/100 °C, Range: [-231 to 231 - 1]
  • humidity – Type: Integer, Unit: 1/100 %, Range: [-231 to 231 - 1]
  • airPressure – Type: Integer, Unit: 1/100 hPa, Range: [-231 to 231 - 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`ACCURACYUUNRELIABLE = 0
  • BrickletAirQuality`ACCURACYULOW = 1
  • BrickletAirQuality`ACCURACYUMEDIUM = 2
  • BrickletAirQuality`ACCURACYUHIGH = 3
event BrickletAirQuality@IAQIndexCallback[sender, iaqIndex, iaqIndexAccuracy]
Callback Parameters:
  • sender – Type: NETObject[BrickletAirQuality]
  • iaqIndex – Type: Integer, Range: [0 to 500]
  • iaqIndexAccuracy – Type: Integer, 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`ACCURACYUUNRELIABLE = 0
  • BrickletAirQuality`ACCURACYULOW = 1
  • BrickletAirQuality`ACCURACYUMEDIUM = 2
  • BrickletAirQuality`ACCURACYUHIGH = 3
event BrickletAirQuality@TemperatureCallback[sender, temperature]
Callback Parameters:
  • sender – Type: NETObject[BrickletAirQuality]
  • temperature – Type: Integer, Unit: 1/100 °C, Range: [-231 to 231 - 1]

This callback is triggered periodically according to the configuration set by SetTemperatureCallbackConfiguration[].

The parameter is the same as GetTemperature[].

event BrickletAirQuality@HumidityCallback[sender, humidity]
Callback Parameters:
  • sender – Type: NETObject[BrickletAirQuality]
  • humidity – Type: Integer, Unit: 1/100 %, Range: [-231 to 231 - 1]

This callback is triggered periodically according to the configuration set by SetHumidityCallbackConfiguration[].

The parameter is the same as GetHumidity[].

event BrickletAirQuality@AirPressureCallback[sender, airPressure]
Callback Parameters:
  • sender – Type: NETObject[BrickletAirQuality]
  • airPressure – Type: Integer, Unit: 1/100 hPa, Range: [-231 to 231 - 1]

This callback is triggered periodically according to the configuration set by SetAirPressureCallbackConfiguration[].

The parameter is the same as GetAirPressure[].

Virtual Functions

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

BrickletAirQuality@GetAPIVersion[] → {apiVersion1, apiVersion2, apiVersion3}
Output Parameters:
  • apiVersioni – Type: Integer
    • 1: major – Type: Integer, Range: [0 to 255]
    • 2: minor – Type: Integer, Range: [0 to 255]
    • 3: revision – Type: Integer, Range: [0 to 255]

Returns the version of the API definition implemented by this API bindings. This is neither the release version of this API bindings nor does it tell you anything about the represented Brick or Bricklet.

BrickletAirQuality@GetResponseExpected[functionId] → responseExpected
Parameters:
  • functionId – Type: Integer, Range: See constants
Returns:
  • responseExpected – Type: True/False

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`FUNCTIONUSETUTEMPERATUREUOFFSET = 2
  • BrickletAirQuality`FUNCTIONUSETUALLUVALUESUCALLBACKUCONFIGURATION = 4
  • BrickletAirQuality`FUNCTIONUSETUIAQUINDEXUCALLBACKUCONFIGURATION = 8
  • BrickletAirQuality`FUNCTIONUSETUTEMPERATUREUCALLBACKUCONFIGURATION = 12
  • BrickletAirQuality`FUNCTIONUSETUHUMIDITYUCALLBACKUCONFIGURATION = 16
  • BrickletAirQuality`FUNCTIONUSETUAIRUPRESSUREUCALLBACKUCONFIGURATION = 20
  • BrickletAirQuality`FUNCTIONUREMOVEUCALIBRATION = 23
  • BrickletAirQuality`FUNCTIONUSETUBACKGROUNDUCALIBRATIONUDURATION = 24
  • BrickletAirQuality`FUNCTIONUSETUWRITEUFIRMWAREUPOINTER = 237
  • BrickletAirQuality`FUNCTIONUSETUSTATUSULEDUCONFIG = 239
  • BrickletAirQuality`FUNCTIONURESET = 243
  • BrickletAirQuality`FUNCTIONUWRITEUUID = 248
BrickletAirQuality@SetResponseExpected[functionId, responseExpected] → Null
Parameters:
  • functionId – Type: Integer, Range: See constants
  • responseExpected – Type: True/False

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

The following constants are available for this function:

For functionId:

  • BrickletAirQuality`FUNCTIONUSETUTEMPERATUREUOFFSET = 2
  • BrickletAirQuality`FUNCTIONUSETUALLUVALUESUCALLBACKUCONFIGURATION = 4
  • BrickletAirQuality`FUNCTIONUSETUIAQUINDEXUCALLBACKUCONFIGURATION = 8
  • BrickletAirQuality`FUNCTIONUSETUTEMPERATUREUCALLBACKUCONFIGURATION = 12
  • BrickletAirQuality`FUNCTIONUSETUHUMIDITYUCALLBACKUCONFIGURATION = 16
  • BrickletAirQuality`FUNCTIONUSETUAIRUPRESSUREUCALLBACKUCONFIGURATION = 20
  • BrickletAirQuality`FUNCTIONUREMOVEUCALIBRATION = 23
  • BrickletAirQuality`FUNCTIONUSETUBACKGROUNDUCALIBRATIONUDURATION = 24
  • BrickletAirQuality`FUNCTIONUSETUWRITEUFIRMWAREUPOINTER = 237
  • BrickletAirQuality`FUNCTIONUSETUSTATUSULEDUCONFIG = 239
  • BrickletAirQuality`FUNCTIONURESET = 243
  • BrickletAirQuality`FUNCTIONUWRITEUUID = 248
BrickletAirQuality@SetResponseExpectedAll[responseExpected] → Null
Parameters:
  • responseExpected – Type: True/False

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

Internal Functions

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

BrickletAirQuality@SetBootloaderMode[mode] → status
Parameters:
  • mode – Type: Integer, Range: See constants
Returns:
  • status – Type: Integer, 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`BOOTLOADERUMODEUBOOTLOADER = 0
  • BrickletAirQuality`BOOTLOADERUMODEUFIRMWARE = 1
  • BrickletAirQuality`BOOTLOADERUMODEUBOOTLOADERUWAITUFORUREBOOT = 2
  • BrickletAirQuality`BOOTLOADERUMODEUFIRMWAREUWAITUFORUREBOOT = 3
  • BrickletAirQuality`BOOTLOADERUMODEUFIRMWAREUWAITUFORUERASEUANDUREBOOT = 4

For status:

  • BrickletAirQuality`BOOTLOADERUSTATUSUOK = 0
  • BrickletAirQuality`BOOTLOADERUSTATUSUINVALIDUMODE = 1
  • BrickletAirQuality`BOOTLOADERUSTATUSUNOUCHANGE = 2
  • BrickletAirQuality`BOOTLOADERUSTATUSUENTRYUFUNCTIONUNOTUPRESENT = 3
  • BrickletAirQuality`BOOTLOADERUSTATUSUDEVICEUIDENTIFIERUINCORRECT = 4
  • BrickletAirQuality`BOOTLOADERUSTATUSUCRCUMISMATCH = 5
BrickletAirQuality@GetBootloaderMode[] → mode
Returns:
  • mode – Type: Integer, Range: See constants

Returns the current bootloader mode, see SetBootloaderMode[].

The following constants are available for this function:

For mode:

  • BrickletAirQuality`BOOTLOADERUMODEUBOOTLOADER = 0
  • BrickletAirQuality`BOOTLOADERUMODEUFIRMWARE = 1
  • BrickletAirQuality`BOOTLOADERUMODEUBOOTLOADERUWAITUFORUREBOOT = 2
  • BrickletAirQuality`BOOTLOADERUMODEUFIRMWAREUWAITUFORUREBOOT = 3
  • BrickletAirQuality`BOOTLOADERUMODEUFIRMWAREUWAITUFORUERASEUANDUREBOOT = 4
BrickletAirQuality@SetWriteFirmwarePointer[pointer] → Null
Parameters:
  • pointer – Type: Integer, Unit: 1 B, Range: [0 to 232 - 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.

BrickletAirQuality@WriteFirmware[{data1, data2, ..., data64}] → status
Parameters:
  • datai – Type: Integer, Range: [0 to 255]
Returns:
  • status – Type: Integer, 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.

BrickletAirQuality@WriteUID[uid] → Null
Parameters:
  • uid – Type: Integer, Range: [0 to 232 - 1]

Writes a new UID into flash. If you want to set a new UID you have to decode the Base58 encoded UID string into an integer first.

We recommend that you use Brick Viewer to change the UID.

BrickletAirQuality@ReadUID[] → uid
Returns:
  • uid – Type: Integer, Range: [0 to 232 - 1]

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

Constants

BrickletAirQuality`DEVICEUIDENTIFIER

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.

BrickletAirQuality`DEVICEDISPLAYNAME

This constant represents the human readable name of a Air Quality Bricklet.