MATLAB/Octave - Particulate Matter Bricklet

This is the description of the MATLAB/Octave 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 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)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
function matlab_example_simple()
    import com.tinkerforge.IPConnection;
    import com.tinkerforge.BrickletParticulateMatter;

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

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

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

    % Get current PM concentration
    pmConcentration = pm.getPMConcentration();

    fprintf('PM 1.0: %i µg/m³\n', pmConcentration.pm10);
    fprintf('PM 2.5: %i µg/m³\n', pmConcentration.pm25);
    fprintf('PM 10.0: %i µg/m³\n', pmConcentration.pm100);

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

Callback (MATLAB)

Download (matlab_example_callback.m)

 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
function matlab_example_callback()
    import com.tinkerforge.IPConnection;
    import com.tinkerforge.BrickletParticulateMatter;

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

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

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

    % Register PM concentration callback to function cb_pm_concentration
    set(pm, 'PMConcentrationCallback', @(h, e) cb_pm_concentration(e));

    % Set period for PM concentration callback to 1s (1000ms)
    pm.setPMConcentrationCallbackConfiguration(1000, false);

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

% Callback function for PM concentration callback
function cb_pm_concentration(e)
    fprintf('PM 1.0: %i µg/m³\n', e.pm10);
    fprintf('PM 2.5: %i µg/m³\n', e.pm25);
    fprintf('PM 10.0: %i µg/m³\n', e.pm100);
    fprintf('\n');
end

Simple (Octave)

Download (octave_example_simple.m)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
function octave_example_simple()
    more off;

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

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

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

    % Get current PM concentration
    pmConcentration = pm.getPMConcentration();

    fprintf("PM 1.0: %d µg/m³\n", pmConcentration.pm10);
    fprintf("PM 2.5: %d µg/m³\n", pmConcentration.pm25);
    fprintf("PM 10.0: %d µg/m³\n", pmConcentration.pm100);

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

Callback (Octave)

Download (octave_example_callback.m)

 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
function octave_example_callback()
    more off;

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

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

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

    % Register PM concentration callback to function cb_pm_concentration
    pm.addPMConcentrationCallback(@cb_pm_concentration);

    % Set period for PM concentration callback to 1s (1000ms)
    pm.setPMConcentrationCallbackConfiguration(1000, false);

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

% Callback function for PM concentration callback
function cb_pm_concentration(e)
    fprintf("PM 1.0: %d µg/m³\n", e.pm10);
    fprintf("PM 2.5: %d µg/m³\n", e.pm25);
    fprintf("PM 10.0: %d µg/m³\n", e.pm100);
    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

public class BrickletParticulateMatter(String uid, IPConnection ipcon)

Creates an object with the unique device ID uid.

In MATLAB:

import com.tinkerforge.BrickletParticulateMatter;

particulateMatter = BrickletParticulateMatter('YOUR_DEVICE_UID', ipcon);

In Octave:

particulateMatter = java_new("com.tinkerforge.BrickletParticulateMatter", "YOUR_DEVICE_UID", ipcon);

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

public BrickletParticulateMatter.PMConcentration getPMConcentration()

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.

The returned object has the public member variables int pm10, int pm25 and int pm100.

public BrickletParticulateMatter.PMCount getPMCount()

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.

The returned object has the public member variables int greater03um, int greater05um, int greater10um, int greater25um, int greater50um and int greater100um.

Advanced Functions

public void setEnable(boolean enable)

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.

public boolean getEnable()

Returns the state of the sensor as set by setEnable().

public BrickletParticulateMatter.SensorInfo getSensorInfo()

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.

The returned object has the public member variables int sensorVersion, int lastErrorCode, int framingErrorCount and int checksumErrorCount.

public int[] getAPIVersion()

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.

public boolean getResponseExpected(int functionId)

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.

public void setResponseExpected(int functionId, boolean responseExpected)

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.FUNCTION_SET_ENABLE = 3
  • BrickletParticulateMatter.FUNCTION_SET_PM_CONCENTRATION_CALLBACK_CONFIGURATION = 6
  • BrickletParticulateMatter.FUNCTION_SET_PM_COUNT_CALLBACK_CONFIGURATION = 8
  • BrickletParticulateMatter.FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
  • BrickletParticulateMatter.FUNCTION_SET_STATUS_LED_CONFIG = 239
  • BrickletParticulateMatter.FUNCTION_RESET = 243
  • BrickletParticulateMatter.FUNCTION_WRITE_UID = 248
public void setResponseExpectedAll(boolean responseExpected)

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

public BrickletParticulateMatter.SPITFPErrorCount getSPITFPErrorCount()

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.

The returned object has the public member variables long errorCountAckChecksum, long errorCountMessageChecksum, long errorCountFrame and long errorCountOverflow.

public int setBootloaderMode(int mode)

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.BOOTLOADER_MODE_BOOTLOADER = 0
  • BrickletParticulateMatter.BOOTLOADER_MODE_FIRMWARE = 1
  • BrickletParticulateMatter.BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
  • BrickletParticulateMatter.BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
  • BrickletParticulateMatter.BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4
  • BrickletParticulateMatter.BOOTLOADER_STATUS_OK = 0
  • BrickletParticulateMatter.BOOTLOADER_STATUS_INVALID_MODE = 1
  • BrickletParticulateMatter.BOOTLOADER_STATUS_NO_CHANGE = 2
  • BrickletParticulateMatter.BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT = 3
  • BrickletParticulateMatter.BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT = 4
  • BrickletParticulateMatter.BOOTLOADER_STATUS_CRC_MISMATCH = 5
public int getBootloaderMode()

Returns the current bootloader mode, see setBootloaderMode().

The following constants are available for this function:

  • BrickletParticulateMatter.BOOTLOADER_MODE_BOOTLOADER = 0
  • BrickletParticulateMatter.BOOTLOADER_MODE_FIRMWARE = 1
  • BrickletParticulateMatter.BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
  • BrickletParticulateMatter.BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
  • BrickletParticulateMatter.BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4
public void setWriteFirmwarePointer(long pointer)

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.

public int writeFirmware(int[] data)

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.

public void setStatusLEDConfig(int config)

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.STATUS_LED_CONFIG_OFF = 0
  • BrickletParticulateMatter.STATUS_LED_CONFIG_ON = 1
  • BrickletParticulateMatter.STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • BrickletParticulateMatter.STATUS_LED_CONFIG_SHOW_STATUS = 3
public int getStatusLEDConfig()

Returns the configuration as set by setStatusLEDConfig()

The following constants are available for this function:

  • BrickletParticulateMatter.STATUS_LED_CONFIG_OFF = 0
  • BrickletParticulateMatter.STATUS_LED_CONFIG_ON = 1
  • BrickletParticulateMatter.STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • BrickletParticulateMatter.STATUS_LED_CONFIG_SHOW_STATUS = 3
public int getChipTemperature()

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.

public void 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!

public void writeUID(long uid)

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.

public long readUID()

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

public BrickletParticulateMatter.Identity getIdentity()

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.

The returned object has the public member variables String uid, String connectedUid, char position, int[] hardwareVersion, int[] firmwareVersion and int deviceIdentifier.

Callback Configuration Functions

public void setPMConcentrationCallbackConfiguration(long period, boolean valueHasToChange)

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

public BrickletParticulateMatter.PMConcentrationCallbackConfiguration getPMConcentrationCallbackConfiguration()

Returns the callback configuration as set by setPMConcentrationCallbackConfiguration().

The returned object has the public member variables long period and boolean valueHasToChange.

public void setPMCountCallbackConfiguration(long period, boolean valueHasToChange)

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

public BrickletParticulateMatter.PMCountCallbackConfiguration getPMCountCallbackConfiguration()

Returns the callback configuration as set by setPMCountCallbackConfiguration().

The returned object has the public member variables long period and boolean valueHasToChange.

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.

public callback BrickletParticulateMatter.PMConcentrationCallback
Parameters:
  • pm10 -- int
  • pm25 -- int
  • pm100 -- int

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

The parameters are the same as getPMConcentration().

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 addPMConcentrationCallback() function. An added callback function can be removed with the removePMConcentrationCallback() function.

public callback BrickletParticulateMatter.PMCountCallback
Parameters:
  • greater03um -- int
  • greater05um -- int
  • greater10um -- int
  • greater25um -- int
  • greater50um -- int
  • greater100um -- int

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

The parameters are the same as getPMCount().

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 addPMCountCallback() function. An added callback function can be removed with the removePMCountCallback() function.

Constants

public static final int BrickletParticulateMatter.DEVICE_IDENTIFIER

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.

public static final String BrickletParticulateMatter.DEVICE_DISPLAY_NAME

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