Java - Particulate Matter Bricklet¶

Simple¶

Download (ExampleSimple.java)

 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

import com.tinkerforge.IPConnection;
import com.tinkerforge.BrickletParticulateMatter;
import com.tinkerforge.BrickletParticulateMatter.PMConcentration;

public class ExampleSimple {
    private static final String HOST = "localhost";
    private static final int PORT = 4223;

    // Change XYZ to the UID of your Particulate Matter Bricklet
    private static final String UID = "XYZ";

    // Note: To make the example code cleaner we do not handle exceptions. Exceptions
    //       you might normally want to catch are described in the documentation
    public static void main(String args[]) throws Exception {
        IPConnection ipcon = new IPConnection(); // Create IP connection
        BrickletParticulateMatter pm =
          new 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 pmConcentration = pm.getPMConcentration(); // Can throw com.tinkerforge.TimeoutException

        System.out.println("PM 1.0: " + pmConcentration.pm10 + " µg/m³");
        System.out.println("PM 2.5: " + pmConcentration.pm25 + " µg/m³");
        System.out.println("PM 10.0: " + pmConcentration.pm100 + " µg/m³");

        System.out.println("Press key to exit"); System.in.read();
        ipcon.disconnect();
    }
}

Callback¶

Download (ExampleCallback.java)

 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
37

import com.tinkerforge.IPConnection;
import com.tinkerforge.BrickletParticulateMatter;

public class ExampleCallback {
    private static final String HOST = "localhost";
    private static final int PORT = 4223;

    // Change XYZ to the UID of your Particulate Matter Bricklet
    private static final String UID = "XYZ";

    // Note: To make the example code cleaner we do not handle exceptions. Exceptions
    //       you might normally want to catch are described in the documentation
    public static void main(String args[]) throws Exception {
        IPConnection ipcon = new IPConnection(); // Create IP connection
        BrickletParticulateMatter pm =
          new BrickletParticulateMatter(UID, ipcon); // Create device object

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

        // Add PM concentration listener
        pm.addPMConcentrationListener(new BrickletParticulateMatter.PMConcentrationListener() {
            public void pmConcentration(int pm10, int pm25, int pm100) {
                System.out.println("PM 1.0: " + pm10 + " µg/m³");
                System.out.println("PM 2.5: " + pm25 + " µg/m³");
                System.out.println("PM 10.0: " + pm100 + " µg/m³");
                System.out.println("");
            }
        });

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

        System.out.println("Press key to exit"); System.in.read();
        ipcon.disconnect();
    }
}

Basic Functions¶

class BrickletParticulateMatter(String uid, IPConnection ipcon)¶

Parameters:	uid – Type: String ipcon – Type: IPConnection
Returns:	particulateMatter – Type: BrickletParticulateMatter

Creates an object with the unique device ID uid:

BrickletParticulateMatter particulateMatter = new BrickletParticulateMatter("YOUR_DEVICE_UID", ipcon);

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

BrickletParticulateMatter.PMConcentration BrickletParticulateMatter.getPMConcentration()¶

Return Object:	pm10 – Type: int, Unit: 1 µg/m³, Range: [0 to 216 - 1] pm25 – Type: int, Unit: 1 µg/m³, Range: [0 to 216 - 1] pm100 – Type: int, Unit: 1 µg/m³, Range: [0 to 216 - 1]

Returns the particulate matter concentration, broken down as:

• PM_1.0,
• PM_2.5 and
• PM_10.0.

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

If you want to get the values periodically, it is recommended to use the PMConcentrationListener listener. You can set the listener configuration with setPMConcentrationCallbackConfiguration().

BrickletParticulateMatter.PMCount BrickletParticulateMatter.getPMCount()¶

Return Object:	greater03um – Type: int, Unit: 10000 1/m³, Range: [0 to 216 - 1] greater05um – Type: int, Unit: 10000 1/m³, Range: [0 to 216 - 1] greater10um – Type: int, Unit: 10000 1/m³, Range: [0 to 216 - 1] greater25um – Type: int, Unit: 10000 1/m³, Range: [0 to 216 - 1] greater50um – Type: int, Unit: 10000 1/m³, Range: [0 to 216 - 1] greater100um – Type: int, Unit: 10000 1/m³, Range: [0 to 216 - 1]

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.

If you want to get the values periodically, it is recommended to use the PMCountListener listener. You can set the listener configuration with setPMCountCallbackConfiguration().

Advanced Functions¶

void BrickletParticulateMatter.setEnable(boolean enable)¶

Parameters:	enable – Type: boolean, Default: true

Enables/Disables the fan and the laser diode of the sensors.

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.

boolean BrickletParticulateMatter.getEnable()¶

Returns:	enable – Type: boolean, Default: true

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

BrickletParticulateMatter.SensorInfo BrickletParticulateMatter.getSensorInfo()¶

Return Object:	sensorVersion – Type: int, Range: [0 to 255] lastErrorCode – Type: int, Range: [0 to 255] framingErrorCount – Type: int, Range: [0 to 255] checksumErrorCount – Type: int, Range: [0 to 255]

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

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

void BrickletParticulateMatter.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:

• 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

int BrickletParticulateMatter.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:

• 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

int BrickletParticulateMatter.getChipTemperature()¶

Returns:	temperature – Type: int, 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.

void BrickletParticulateMatter.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!

BrickletParticulateMatter.Identity BrickletParticulateMatter.getIdentity()¶

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

Listener Configuration Functions¶

void BrickletParticulateMatter.setPMConcentrationCallbackConfiguration(long period, boolean valueHasToChange)¶

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

The period is the period with which the PMConcentrationListener listener is triggered periodically. A value of 0 turns the listener off.

If the value has to change-parameter is set to true, the listener is only triggered after the value has changed. If the value didn't change within the period, the listener is triggered immediately on change.

If it is set to false, the listener is continuously triggered with the period, independent of the value.

BrickletParticulateMatter.PMConcentrationCallbackConfiguration BrickletParticulateMatter.getPMConcentrationCallbackConfiguration()¶

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

Returns the listener configuration as set by setPMConcentrationCallbackConfiguration().

void BrickletParticulateMatter.setPMCountCallbackConfiguration(long period, boolean valueHasToChange)¶

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

The period is the period with which the PMCountListener listener is triggered periodically. A value of 0 turns the listener off.

If the value has to change-parameter is set to true, the listener is only triggered after the value has changed. If the value didn't change within the period, the listener is triggered immediately on change.

If it is set to false, the listener is continuously triggered with the period, independent of the value.

BrickletParticulateMatter.PMCountCallbackConfiguration BrickletParticulateMatter.getPMCountCallbackConfiguration()¶

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

Returns the listener configuration as set by setPMCountCallbackConfiguration().

Listeners¶

Listeners can be registered to receive time critical or recurring data from the device. The registration is done with add*Listener() functions of the device object.

The parameter is a listener class object, for example:

device.addExampleListener(new BrickletParticulateMatter.ExampleListener() {
    public void property(int value) {
        System.out.println("Value: " + value);
    }
});

The available listener classes with inherent methods to be overwritten are described below. It is possible to add several listeners and to remove them with the corresponding remove*Listener() function.

class BrickletParticulateMatter.PMConcentrationListener()¶

This listener can be added with the addPMConcentrationListener() function. An added listener can be removed with the removePMConcentrationListener() function.

void pmConcentration(int pm10, int pm25, int pm100)

Parameters:	pm10 – Type: int, Unit: 1 µg/m³, Range: [0 to 216 - 1] pm25 – Type: int, Unit: 1 µg/m³, Range: [0 to 216 - 1] pm100 – Type: int, Unit: 1 µg/m³, Range: [0 to 216 - 1]

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

The parameters are the same as getPMConcentration().

class BrickletParticulateMatter.PMCountListener()¶

This listener can be added with the addPMCountListener() function. An added listener can be removed with the removePMCountListener() function.

void pmCount(int greater03um, int greater05um, int greater10um, int greater25um, int greater50um, int greater100um)

Parameters:	greater03um – Type: int, Unit: 10000 1/m³, Range: [0 to 216 - 1] greater05um – Type: int, Unit: 10000 1/m³, Range: [0 to 216 - 1] greater10um – Type: int, Unit: 10000 1/m³, Range: [0 to 216 - 1] greater25um – Type: int, Unit: 10000 1/m³, Range: [0 to 216 - 1] greater50um – Type: int, Unit: 10000 1/m³, Range: [0 to 216 - 1] greater100um – Type: int, Unit: 10000 1/m³, Range: [0 to 216 - 1]

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

The parameters are the same as getPMCount().

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[] BrickletParticulateMatter.getAPIVersion()¶

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

• 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

void BrickletParticulateMatter.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 listener 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:

• 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

void BrickletParticulateMatter.setResponseExpectedAll(boolean responseExpected)¶

Parameters:	responseExpected – Type: boolean

Changes the response expected flag for all setter and listener 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 BrickletParticulateMatter.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:

• 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

For status:

• 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

int BrickletParticulateMatter.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:

• 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

void BrickletParticulateMatter.setWriteFirmwarePointer(long pointer)¶

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

int BrickletParticulateMatter.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 BrickletParticulateMatter.writeUID(long uid)¶

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

long BrickletParticulateMatter.readUID()¶

Returns:	uid – Type: long, Range: [0 to 232 - 1]

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

Constants¶

int BrickletParticulateMatter.DEVICE_IDENTIFIER¶

This constant is used to identify a Particulate Matter Bricklet.

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

String BrickletParticulateMatter.DEVICE_DISPLAY_NAME¶

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