Mathematica - Particulate Matter Bricklet

This is the description of the Mathematica API bindings for the Particulate Matter Bricklet. General information and technical specifications for the Particulate Matter 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
Needs["NETLink`"]
LoadNETAssembly["Tinkerforge",NotebookDirectory[]<>"../../.."]

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

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

(*Get current PM concentration*)
pm10=0;pm25=0;pm100=0
pm@GetPMConcentration[pm10,pm25,pm100]

Print["PM 1.0: "<>ToString[N[Quantity[pm10,"µg/m³"]]]]
Print["PM 2.5: "<>ToString[N[Quantity[pm25,"µg/m³"]]]]
Print["PM 10.0: "<>ToString[N[Quantity[pm100,"µg/m³"]]]]

(*Clean up*)
ipcon@Disconnect[]
ReleaseNETObject[pm]
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
Needs["NETLink`"]
LoadNETAssembly["Tinkerforge",NotebookDirectory[]<>"../../.."]

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

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

(*Callback function for PM concentration callback*)
PMConcentrationCB[sender_,pm10_,pm25_,pm100_]:=
 Module[{},
  Print["PM 1.0: "<>ToString[N[Quantity[pm10,"µg/m³"]]]];
  Print["PM 2.5: "<>ToString[N[Quantity[pm25,"µg/m³"]]]];
  Print["PM 10.0: "<>ToString[N[Quantity[pm100,"µg/m³"]]]]
 ]

AddEventHandler[pm@PMConcentrationCallback,PMConcentrationCB]

(*Set period for PM concentration callback to 1s (1000ms)*)
pm@SetPMConcentrationCallbackConfiguration[1000,False]

Input["Click OK to exit"]

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

API

Generally, every method 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 method. 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

BrickletParticulateMatter[uid, ipcon] → particulateMatter
Parameters:
  • uid -- String
  • ipcon -- NETObject[IPConnection]
Returns:
  • particulateMatter -- NETObject[BrickletParticulateMatter]

Creates an object with the unique device ID uid:

particulateMatter=NETNew["Tinkerforge.BrickletParticulateMatter","YOUR_DEVICE_UID",ipcon]

This object can then be used after the IP Connection is connected (see examples above).

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.

BrickletParticulateMatter@GetPMConcentration[out pm10, out pm25, out pm100] → Null
Parameters:
  • pm10 -- Integer
  • pm25 -- Integer
  • pm100 -- Integer

Returns the particulate matter concentration in µg/m³, broken down as:

  • PM1.0,
  • PM2.5 and
  • PM10.0.

If the sensor is disabled (see SetEnable[]) then the last known good values from the sensor are returned.

BrickletParticulateMatter@GetPMCount[out greater03um, out greater05um, out greater10um, out greater25um, out greater50um, out greater100um] → Null
Parameters:
  • greater03um -- Integer
  • greater05um -- Integer
  • greater10um -- Integer
  • greater25um -- Integer
  • greater50um -- Integer
  • greater100um -- Integer

Returns the number of particulates in 100 ml of air, broken down by their diameter:

  • greater 0.3µm,
  • greater 0.5µm,
  • greater 1.0µm,
  • greater 2.5µm,
  • greater 5.0µm and
  • greater 10.0µm.

If the sensor is disabled (see SetEnable[]) then the last known good value from the sensor is returned.

Advanced Functions

BrickletParticulateMatter@SetEnable[enable] → Null
Parameters:
  • enable -- True/False

Enables/Disables the fan and the laser diode of the sensors. The sensor is enabled by default.

The sensor takes about 30 seconds after it is enabled to settle and produce stable values.

The laser diode has a lifetime of about 8000 hours. If you want to measure in an interval with a long idle time (e.g. hourly) you should turn the laser diode off between the measurements.

BrickletParticulateMatter@GetEnable[] → enable
Returns:
  • enable -- True/False

Returns the state of the sensor as set by SetEnable[].

BrickletParticulateMatter@GetSensorInfo[out sensorVersion, out lastErrorCode, out framingErrorCount, out checksumErrorCount] → Null
Parameters:
  • sensorVersion -- Integer
  • lastErrorCode -- Integer
  • framingErrorCount -- Integer
  • checksumErrorCount -- Integer

Returns information about the sensor:

  • the sensor version number,
  • the last error code reported by the sensor (0 means no error) and
  • the number of framing and checksum errors that occurred in the communication with the sensor.
BrickletParticulateMatter@GetAPIVersion[] → {apiVersion1, apiVersion2, apiVersion3}
Returns:
  • apiVersioni -- Integer

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

BrickletParticulateMatter@GetResponseExpected[functionId] → responseExpected
Parameters:
  • functionId -- Integer
Returns:
  • responseExpected -- 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 send and errors are silently ignored, because they cannot be detected.

See SetResponseExpected[] for the list of function ID constants available for this function.

BrickletParticulateMatter@SetResponseExpected[functionId, responseExpected] → Null
Parameters:
  • functionId -- Integer
  • responseExpected -- 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 send and errors are silently ignored, because they cannot be detected.

The following function ID constants are available for this function:

  • BrickletParticulateMatter`FUNCTIONUSETUENABLE = 3
  • BrickletParticulateMatter`FUNCTIONUSETUPMUCONCENTRATIONUCALLBACKUCONFIGURATION = 6
  • BrickletParticulateMatter`FUNCTIONUSETUPMUCOUNTUCALLBACKUCONFIGURATION = 8
  • BrickletParticulateMatter`FUNCTIONUSETUWRITEUFIRMWAREUPOINTER = 237
  • BrickletParticulateMatter`FUNCTIONUSETUSTATUSULEDUCONFIG = 239
  • BrickletParticulateMatter`FUNCTIONURESET = 243
  • BrickletParticulateMatter`FUNCTIONUWRITEUUID = 248
BrickletParticulateMatter@SetResponseExpectedAll[responseExpected] → Null
Parameters:
  • responseExpected -- True/False

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

BrickletParticulateMatter@GetSPITFPErrorCount[out errorCountAckChecksum, out errorCountMessageChecksum, out errorCountFrame, out errorCountOverflow] → Null
Parameters:
  • errorCountAckChecksum -- Integer
  • errorCountMessageChecksum -- Integer
  • errorCountFrame -- Integer
  • errorCountOverflow -- Integer

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.

BrickletParticulateMatter@SetBootloaderMode[mode] → status
Parameters:
  • mode -- Integer
Returns:
  • status -- Integer

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:

  • BrickletParticulateMatter`BOOTLOADERUMODEUBOOTLOADER = 0
  • BrickletParticulateMatter`BOOTLOADERUMODEUFIRMWARE = 1
  • BrickletParticulateMatter`BOOTLOADERUMODEUBOOTLOADERUWAITUFORUREBOOT = 2
  • BrickletParticulateMatter`BOOTLOADERUMODEUFIRMWAREUWAITUFORUREBOOT = 3
  • BrickletParticulateMatter`BOOTLOADERUMODEUFIRMWAREUWAITUFORUERASEUANDUREBOOT = 4
  • BrickletParticulateMatter`BOOTLOADERUSTATUSUOK = 0
  • BrickletParticulateMatter`BOOTLOADERUSTATUSUINVALIDUMODE = 1
  • BrickletParticulateMatter`BOOTLOADERUSTATUSUNOUCHANGE = 2
  • BrickletParticulateMatter`BOOTLOADERUSTATUSUENTRYUFUNCTIONUNOTUPRESENT = 3
  • BrickletParticulateMatter`BOOTLOADERUSTATUSUDEVICEUIDENTIFIERUINCORRECT = 4
  • BrickletParticulateMatter`BOOTLOADERUSTATUSUCRCUMISMATCH = 5
BrickletParticulateMatter@GetBootloaderMode[] → mode
Returns:
  • mode -- Integer

Returns the current bootloader mode, see SetBootloaderMode[].

The following constants are available for this function:

  • BrickletParticulateMatter`BOOTLOADERUMODEUBOOTLOADER = 0
  • BrickletParticulateMatter`BOOTLOADERUMODEUFIRMWARE = 1
  • BrickletParticulateMatter`BOOTLOADERUMODEUBOOTLOADERUWAITUFORUREBOOT = 2
  • BrickletParticulateMatter`BOOTLOADERUMODEUFIRMWAREUWAITUFORUREBOOT = 3
  • BrickletParticulateMatter`BOOTLOADERUMODEUFIRMWAREUWAITUFORUERASEUANDUREBOOT = 4
BrickletParticulateMatter@SetWriteFirmwarePointer[pointer] → Null
Parameters:
  • pointer -- Integer

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.

BrickletParticulateMatter@WriteFirmware[{data1, data2, ..., data64}] → status
Parameters:
  • datai -- Integer
Returns:
  • status -- Integer

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.

BrickletParticulateMatter@SetStatusLEDConfig[config] → Null
Parameters:
  • config -- Integer

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:

  • BrickletParticulateMatter`STATUSULEDUCONFIGUOFF = 0
  • BrickletParticulateMatter`STATUSULEDUCONFIGUON = 1
  • BrickletParticulateMatter`STATUSULEDUCONFIGUSHOWUHEARTBEAT = 2
  • BrickletParticulateMatter`STATUSULEDUCONFIGUSHOWUSTATUS = 3
BrickletParticulateMatter@GetStatusLEDConfig[] → config
Returns:
  • config -- Integer

Returns the configuration as set by SetStatusLEDConfig[]

The following constants are available for this function:

  • BrickletParticulateMatter`STATUSULEDUCONFIGUOFF = 0
  • BrickletParticulateMatter`STATUSULEDUCONFIGUON = 1
  • BrickletParticulateMatter`STATUSULEDUCONFIGUSHOWUHEARTBEAT = 2
  • BrickletParticulateMatter`STATUSULEDUCONFIGUSHOWUSTATUS = 3
BrickletParticulateMatter@GetChipTemperature[] → temperature
Returns:
  • temperature -- Integer

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.

BrickletParticulateMatter@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!

BrickletParticulateMatter@WriteUID[uid] → Null
Parameters:
  • uid -- Integer

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.

BrickletParticulateMatter@ReadUID[] → uid
Returns:
  • uid -- Integer

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

BrickletParticulateMatter@GetIdentity[out uid, out connectedUid, out position, out {hardwareVersion1, hardwareVersion2, hardwareVersion3}, out {firmwareVersion1, firmwareVersion2, firmwareVersion3}, out deviceIdentifier] → Null
Parameters:
  • uid -- String
  • connectedUid -- String
  • position -- Integer
  • hardwareVersioni -- Integer
  • firmwareVersioni -- Integer
  • deviceIdentifier -- Integer

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

The position can be 'a', 'b', 'c' or 'd'.

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

Callback Configuration Functions

BrickletParticulateMatter@SetPMConcentrationCallbackConfiguration[period, valueHasToChange] → Null
Parameters:
  • period -- Integer
  • valueHasToChange -- True/False

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

The default value is (0, false).

BrickletParticulateMatter@GetPMConcentrationCallbackConfiguration[out period, out valueHasToChange] → Null
Parameters:
  • period -- Integer
  • valueHasToChange -- True/False

Returns the callback configuration as set by SetPMConcentrationCallbackConfiguration[].

BrickletParticulateMatter@SetPMCountCallbackConfiguration[period, valueHasToChange] → Null
Parameters:
  • period -- Integer
  • valueHasToChange -- True/False

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

The default value is (0, false).

BrickletParticulateMatter@GetPMCountCallbackConfiguration[out period, out valueHasToChange] → Null
Parameters:
  • period -- Integer
  • valueHasToChange -- True/False

Returns the callback configuration as set by SetPMCountCallbackConfiguration[].

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[particulateMatter@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 BrickletParticulateMatter@PMConcentrationCallback[sender, pm10, pm25, pm100]
Parameters:
  • sender -- NETObject[BrickletParticulateMatter]
  • pm10 -- Integer
  • pm25 -- Integer
  • pm100 -- Integer

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

The parameters are the same as GetPMConcentration[].

event BrickletParticulateMatter@PMCountCallback[sender, greater03um, greater05um, greater10um, greater25um, greater50um, greater100um]
Parameters:
  • sender -- NETObject[BrickletParticulateMatter]
  • greater03um -- Integer
  • greater05um -- Integer
  • greater10um -- Integer
  • greater25um -- Integer
  • greater50um -- Integer
  • greater100um -- Integer

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

The parameters are the same as GetPMCount[].

Constants

BrickletParticulateMatter`DEVICEUIDENTIFIER

This constant is used to identify a Particulate Matter Bricklet.

The GetIdentity[] function and the EnumerateCallback callback of the IP Connection have a deviceIdentifier parameter to specify the Brick's or Bricklet's type.

BrickletParticulateMatter`DEVICEDISPLAYNAME

This constant represents the human readable name of a Particulate Matter Bricklet.