C# - Particulate Matter Bricklet¶

Simple¶

Download (ExampleSimple.cs)

 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

using System;
using Tinkerforge;

class Example
{
    private static string HOST = "localhost";
    private static int PORT = 4223;
    private static string UID = "XYZ"; // Change XYZ to the UID of your Particulate Matter Bricklet

    static void Main()
    {
        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
        int pm10, pm25, pm100;
        pm.GetPMConcentration(out pm10, out pm25, out pm100);

        Console.WriteLine("PM 1.0: " + pm10 + " µg/m³");
        Console.WriteLine("PM 2.5: " + pm25 + " µg/m³");
        Console.WriteLine("PM 10.0: " + pm100 + " µg/m³");

        Console.WriteLine("Press enter to exit");
        Console.ReadLine();
        ipcon.Disconnect();
    }
}

Callback¶

Download (ExampleCallback.cs)

 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
38
39

using System;
using Tinkerforge;

class Example
{
    private static string HOST = "localhost";
    private static int PORT = 4223;
    private static string UID = "XYZ"; // Change XYZ to the UID of your Particulate Matter Bricklet

    // Callback function for PM concentration callback
    static void PMConcentrationCB(BrickletParticulateMatter sender, int pm10, int pm25,
                                  int pm100)
    {
        Console.WriteLine("PM 1.0: " + pm10 + " µg/m³");
        Console.WriteLine("PM 2.5: " + pm25 + " µg/m³");
        Console.WriteLine("PM 10.0: " + pm100 + " µg/m³");
        Console.WriteLine("");
    }

    static void Main()
    {
        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

        // Register PM concentration callback to function PMConcentrationCB
        pm.PMConcentrationCallback += PMConcentrationCB;

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

        Console.WriteLine("Press enter to exit");
        Console.ReadLine();
        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.

void BrickletParticulateMatter.GetPMConcentration(out int pm10, out int pm25, out int pm100)¶

Output 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]

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

void BrickletParticulateMatter.GetPMCount(out int greater03um, out int greater05um, out int greater10um, out int greater25um, out int greater50um, out int greater100um)¶

Output 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]

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

Advanced Functions¶

void BrickletParticulateMatter.SetEnable(bool enable)¶

Parameters:	enable – Type: bool, 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.

bool BrickletParticulateMatter.GetEnable()¶

Returns:	enable – Type: bool, Default: true

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

void BrickletParticulateMatter.GetSensorInfo(out byte sensorVersion, out byte lastErrorCode, out byte framingErrorCount, out byte checksumErrorCount)¶

Output Parameters:	sensorVersion – Type: byte, Range: [0 to 255] lastErrorCode – Type: byte, Range: [0 to 255] framingErrorCount – Type: byte, Range: [0 to 255] checksumErrorCount – Type: byte, 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.

void BrickletParticulateMatter.GetSPITFPErrorCount(out long errorCountAckChecksum, out long errorCountMessageChecksum, out long errorCountFrame, out long errorCountOverflow)¶

Output Parameters:	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(byte config)¶

Parameters:	config – Type: byte, 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

byte BrickletParticulateMatter.GetStatusLEDConfig()¶

Returns:	config – Type: byte, 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

short BrickletParticulateMatter.GetChipTemperature()¶

Returns:	temperature – Type: short, 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!

void BrickletParticulateMatter.GetIdentity(out string uid, out string connectedUid, out char position, out byte[] hardwareVersion, out byte[] firmwareVersion, out int deviceIdentifier)¶

Output Parameters:

uid – Type: string, Length: up to 8 connectedUid – Type: string, Length: up to 8 position – Type: char, Range: ['a' to 'h', 'z'] hardwareVersion – Type: byte[], Length: 3 0: major – Type: byte, Range: [0 to 255] 1: minor – Type: byte, Range: [0 to 255] 2: revision – Type: byte, Range: [0 to 255] firmwareVersion – Type: byte[], Length: 3 0: major – Type: byte, Range: [0 to 255] 1: minor – Type: byte, Range: [0 to 255] 2: revision – Type: byte, 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.

Callback Configuration Functions¶

void BrickletParticulateMatter.SetPMConcentrationCallbackConfiguration(long period, bool valueHasToChange)¶

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

The period 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.

void BrickletParticulateMatter.GetPMConcentrationCallbackConfiguration(out long period, out bool valueHasToChange)¶

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

Returns the callback configuration as set by SetPMConcentrationCallbackConfiguration().

void BrickletParticulateMatter.SetPMCountCallbackConfiguration(long period, bool valueHasToChange)¶

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

The period 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.

void BrickletParticulateMatter.GetPMCountCallbackConfiguration(out long period, out bool valueHasToChange)¶

Output Parameters:	period – Type: long, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0 valueHasToChange – Type: bool, Default: 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 appending your callback handler to the corresponding event:

void MyCallback(BrickletParticulateMatter sender, int value)
{
    System.Console.WriteLine("Value: " + value);
}

particulateMatter.ExampleCallback += MyCallback;

The available events are described below.

event BrickletParticulateMatter.PMConcentrationCallback(BrickletParticulateMatter sender, int pm10, int pm25, int pm100)¶

Callback Parameters:	sender – Type: BrickletParticulateMatter 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 callback is triggered periodically according to the configuration set by SetPMConcentrationCallbackConfiguration().

The parameters are the same as GetPMConcentration().

event BrickletParticulateMatter.PMCountCallback(BrickletParticulateMatter sender, int greater03um, int greater05um, int greater10um, int greater25um, int greater50um, int greater100um)¶

Callback Parameters:

sender – Type: BrickletParticulateMatter 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 callback 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.

byte[] BrickletParticulateMatter.GetAPIVersion()¶

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

bool BrickletParticulateMatter.GetResponseExpected(byte functionId)¶

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

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:

• 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, bool responseExpected)¶

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

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:

• 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(bool responseExpected)¶

Parameters:	responseExpected – Type: bool

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.

byte BrickletParticulateMatter.SetBootloaderMode(byte mode)¶

Parameters:	mode – Type: byte, Range: See constants
Returns:	status – Type: byte, 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

byte BrickletParticulateMatter.GetBootloaderMode()¶

Returns:	mode – Type: byte, 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.

byte BrickletParticulateMatter.WriteFirmware(byte[] data)¶

Parameters:	data – Type: byte[], Length: 64, Range: [0 to 255]
Returns:	status – Type: byte, 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.EnumerateCallback callback 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.