Visual Basic .NET - Particulate Matter Bricklet

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

Examples

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

Simple

Download (ExampleSimple.vb)

 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
Imports System
Imports Tinkerforge

Module ExampleSimple
    Const HOST As String = "localhost"
    Const PORT As Integer = 4223
    Const UID As String = "XYZ" ' Change XYZ to the UID of your Particulate Matter Bricklet

    Sub Main()
        Dim ipcon As New IPConnection() ' Create IP connection
        Dim pm As 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
        Dim pm10, pm25, pm100 As Integer

        pm.GetPMConcentration(pm10, pm25, pm100)

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

        Console.WriteLine("Press key to exit")
        Console.ReadLine()
        ipcon.Disconnect()
    End Sub
End Module

Callback

Download (ExampleCallback.vb)

 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
Imports System
Imports Tinkerforge

Module ExampleCallback
    Const HOST As String = "localhost"
    Const PORT As Integer = 4223
    Const UID As String = "XYZ" ' Change XYZ to the UID of your Particulate Matter Bricklet

    ' Callback subroutine for PM concentration callback
    Sub PMConcentrationCB(ByVal sender As BrickletParticulateMatter, _
                          ByVal pm10 As Integer, ByVal pm25 As Integer, _
                          ByVal pm100 As Integer)
        Console.WriteLine("PM 1.0: " + pm10.ToString() + " µg/m³")
        Console.WriteLine("PM 2.5: " + pm25.ToString() + " µg/m³")
        Console.WriteLine("PM 10.0: " + pm100.ToString() + " µg/m³")
        Console.WriteLine("")
    End Sub

    Sub Main()
        Dim ipcon As New IPConnection() ' Create IP connection
        Dim pm As 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 subroutine PMConcentrationCB
        AddHandler pm.PMConcentrationCallback, AddressOf PMConcentrationCB

        ' Set period for PM concentration callback to 1s (1000ms)
        pm.SetPMConcentrationCallbackConfiguration(1000, False)

        Console.WriteLine("Press key to exit")
        Console.ReadLine()
        ipcon.Disconnect()
    End Sub
End Module

API

Since Visual Basic .NET does not support multiple return values directly, we use the ByRef keyword to return multiple values from a function.

All functions and procedures listed below are thread-safe.

Basic Functions

Class BrickletParticulateMatter(ByVal uid As String, ByVal ipcon As IPConnection)

Creates an object with the unique device ID uid:

Dim particulateMatter As New BrickletParticulateMatter("YOUR_DEVICE_UID", ipcon)

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

Sub BrickletParticulateMatter.GetPMConcentration(ByRef pm10 As Integer, ByRef pm25 As Integer, ByRef pm100 As 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.

Sub BrickletParticulateMatter.GetPMCount(ByRef greater03um As Integer, ByRef greater05um As Integer, ByRef greater10um As Integer, ByRef greater25um As Integer, ByRef greater50um As Integer, ByRef greater100um As 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

Sub BrickletParticulateMatter.SetEnable(ByVal enable As Boolean)

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.

Function BrickletParticulateMatter.GetEnable() As Boolean

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

Sub BrickletParticulateMatter.GetSensorInfo(ByRef sensorVersion As Byte, ByRef lastErrorCode As Byte, ByRef framingErrorCount As Byte, ByRef checksumErrorCount As Byte)

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.
Function BrickletParticulateMatter.GetAPIVersion() As Byte()

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.

Function BrickletParticulateMatter.GetResponseExpected(ByVal functionId As Byte) As 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 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.

Sub BrickletParticulateMatter.SetResponseExpected(ByVal functionId As Byte, ByVal responseExpected As 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 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
Sub BrickletParticulateMatter.SetResponseExpectedAll(ByVal responseExpected As Boolean)

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

Sub BrickletParticulateMatter.GetSPITFPErrorCount(ByRef errorCountAckChecksum As Long, ByRef errorCountMessageChecksum As Long, ByRef errorCountFrame As Long, ByRef errorCountOverflow As Long)

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.

Function BrickletParticulateMatter.SetBootloaderMode(ByVal mode As Byte) As Byte

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
Function BrickletParticulateMatter.GetBootloaderMode() As Byte

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
Sub BrickletParticulateMatter.SetWriteFirmwarePointer(ByVal pointer As Long)

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.

Function BrickletParticulateMatter.WriteFirmware(ByVal data() As Byte) As Byte

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.

Sub BrickletParticulateMatter.SetStatusLEDConfig(ByVal config As Byte)

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
Function BrickletParticulateMatter.GetStatusLEDConfig() As Byte

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
Function BrickletParticulateMatter.GetChipTemperature() As Short

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.

Sub 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!

Sub BrickletParticulateMatter.WriteUID(ByVal uid As Long)

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.

Function BrickletParticulateMatter.ReadUID() As Long

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

Sub BrickletParticulateMatter.GetIdentity(ByRef uid As String, ByRef connectedUid As String, ByRef position As Char, ByRef hardwareVersion() As Byte, ByRef firmwareVersion() As Byte, ByRef deviceIdentifier As 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

Sub BrickletParticulateMatter.SetPMConcentrationCallbackConfiguration(ByVal period As Long, ByVal valueHasToChange As Boolean)

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

Sub BrickletParticulateMatter.GetPMConcentrationCallbackConfiguration(ByRef period As Long, ByRef valueHasToChange As Boolean)

Returns the callback configuration as set by SetPMConcentrationCallbackConfiguration().

Sub BrickletParticulateMatter.SetPMCountCallbackConfiguration(ByVal period As Long, ByVal valueHasToChange As Boolean)

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

Sub BrickletParticulateMatter.GetPMCountCallbackConfiguration(ByRef period As Long, ByRef valueHasToChange As Boolean)

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 procedure to an callback property of the device object:

Sub MyCallback(ByVal sender As BrickletParticulateMatter, ByVal value As Short)
    Console.WriteLine("Value: {0}", value)
End Sub

AddHandler particulateMatter.ExampleCallback, AddressOf MyCallback

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(ByVal sender As BrickletParticulateMatter, ByVal pm10 As Integer, ByVal pm25 As Integer, ByVal pm100 As Integer)

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

The parameters are the same as GetPMConcentration().

Event BrickletParticulateMatter.PMCountCallback(ByVal sender As BrickletParticulateMatter, ByVal greater03um As Integer, ByVal greater05um As Integer, ByVal greater10um As Integer, ByVal greater25um As Integer, ByVal greater50um As Integer, ByVal greater100um As Integer)

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

The parameters are the same as GetPMCount().

Constants

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

Const BrickletParticulateMatter.DEVICE_DISPLAY_NAME

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