Java - Dust Detector Bricklet – Tinkerforge

- Getting Started
- Hardware
- Software
- Starter Kits
- Embedded Boards
- Specifications

# Java - Dust Detector Bricklet

Note

This Bricklet is currently in the prototype stage and the software/hardware as well as the documentation is in an incomplete state.

This is the description of the Java API bindings for the Dust Detector Bricklet. General information and technical specifications for the Dust Detector Bricklet are summarized in its hardware description.

An installation guide for the Java API bindings is part of their general description.

## Examples

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

### 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

    import com.tinkerforge.BrickletDustDetector;
    import com.tinkerforge.IPConnection;

    public class ExampleSimple {
        private static final String HOST = "localhost";
        private static final int PORT = 4223;
        private static final String UID = "ABC"; // Change to your UID

        // 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
            BrickletDustDetector dd = new BrickletDustDetector(UID, ipcon); // Create device object

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

            // Get current dust density (unit is µg/cm^3)
            int dustDensity = dd.getDustDensity(); // Can throw com.tinkerforge.TimeoutException

            System.out.println("Dust Density: " + dustDensity + " µg/cm^3");

            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

    import com.tinkerforge.BrickletDustDetector;
    import com.tinkerforge.IPConnection;

    public class ExampleCallback {
        private static final String HOST = "localhost";
        private static final int PORT = 4223;
        private static final String UID = "ABC"; // Change to your UID

        // 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
            BrickletDustDetector dd = new BrickletDustDetector(UID, ipcon); // Create device object

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

            // Set Period for dust density callback to 1s (1000ms)
            // Note: The dust density callback is only called every second if the
            //       dust density has changed since the last call!
            dd.setDustDensityCallbackPeriod(1000);

            // Add and implement dust density listener (called if dust density changes)
            dd.addDustDensityListener(new BrickletDustDetector.DustDensityListener() {
                public void dustDensity(int dustDensity) {
                    System.out.println("Dust Density: " + dustDensity + " µg/cm^3");
                }
            });

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

### Threshold

Download (ExampleThreshold.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

    import com.tinkerforge.BrickletDustDetector;
    import com.tinkerforge.IPConnection;

    public class ExampleThreshold {
        private static final String HOST = "localhost";
        private static final int PORT = 4223;
        private static final String UID = "ABC"; // Change to your UID

        // 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
            BrickletDustDetector dd = new BrickletDustDetector(UID, ipcon); // Create device object

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

            // Get threshold callbacks with a debounce time of 10 seconds (10000ms)
            dd.setDebouncePeriod(10000);

            // Configure threshold for "greater than 10 µg/cm^3"
            dd.setDustDensityCallbackThreshold('>', (short)10, (short)0);

            // Add and implement dust density reached listener
            // (called if dust density is greater than 10µg/cm^3)
            dd.addDustDensityReachedListener(new BrickletDustDetector.DustDensityReachedListener() {
                public void dustDensityReached(int dustDensity) {
                    System.out.println("Dust Density: " + dustDensity + " µg/cm^3.");
                }
            });

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

## API

Generally, every method of the Java 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 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 `BrickletDustDetector`(String uid, IPConnection ipcon)

  Creates an object with the unique device ID `uid`:

      BrickletDustDetector dustDetector = new BrickletDustDetector("YOUR_DEVICE_UID", ipcon);

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

public int `getDustDensity`()

  Returns the dust density in µg/m³.

  If you want to get the dust density periodically, it is recommended to use the listener `DustDensityListener` and set the period with `setDustDensityCallbackPeriod()`.

### Advanced Functions

public void `setMovingAverage`(short average)

  Sets the length of a moving averaging for the dust_density.

  Setting the length to 0 will turn the averaging completely off. With less averaging, there is more noise on the data.

  The range for the averaging is 0-100.

  The default value is 100.

public short `getMovingAverage`()

  Returns the length moving average as set by `setMovingAverage()`.

public short[] `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`(short 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 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 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`(short 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 listener configuration functions (default value: true). For getter functions it is always enabled and listeners it is always disabled.

  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:

  - BrickletDustDetector.FUNCTION_SET_DUST_DENSITY_CALLBACK_PERIOD = 2
  - BrickletDustDetector.FUNCTION_SET_DUST_DENSITY_CALLBACK_THRESHOLD = 4
  - BrickletDustDetector.FUNCTION_SET_DEBOUNCE_PERIOD = 6
  - BrickletDustDetector.FUNCTION_SET_MOVING_AVERAGE = 10

public void `setResponseExpectedAll`(boolean responseExpected)

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

public BrickletDustDetector.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`, `short[] hardwareVersion`, `short[] firmwareVersion` and `int deviceIdentifier`.

### Listener Configuration Functions

public void `setDustDensityCallbackPeriod`(long period)

  Sets the period in ms with which the `DustDensityListener` listener is triggered periodically. A value of 0 turns the listener off.

  `DustDensityListener` is only triggered if the dust density has changed since the last triggering.

  The default value is 0.

public long `getDustDensityCallbackPeriod`()

  Returns the period as set by `setDustDensityCallbackPeriod()`.

public void `setDustDensityCallbackThreshold`(char option, int min, int max)

  Sets the thresholds for the `DustDensityReachedListener` listener.

  The following options are possible:

  Option | Description
  --- | ---
  'x' | Listener is turned off
  'o' | Listener is triggered when the dust density value is outside the min and max values
  'i' | Listener is triggered when the dust density value is inside the min and max values
  '<' | Listener is triggered when the dust density value is smaller than the min value (max is ignored)
  '>' | Listener is triggered when the dust density value is greater than the min value (max is ignored)

  The default value is ('x', 0, 0).

  The following constants are available for this function:

  - BrickletDustDetector.THRESHOLD_OPTION_OFF = 'x'
  - BrickletDustDetector.THRESHOLD_OPTION_OUTSIDE = 'o'
  - BrickletDustDetector.THRESHOLD_OPTION_INSIDE = 'i'
  - BrickletDustDetector.THRESHOLD_OPTION_SMALLER = '<'
  - BrickletDustDetector.THRESHOLD_OPTION_GREATER = '>'

public BrickletDustDetector.DustDensityCallbackThreshold `getDustDensityCallbackThreshold`()

  Returns the threshold as set by `setDustDensityCallbackThreshold()`.

  The following constants are available for this function:

  - BrickletDustDetector.THRESHOLD_OPTION_OFF = 'x'
  - BrickletDustDetector.THRESHOLD_OPTION_OUTSIDE = 'o'
  - BrickletDustDetector.THRESHOLD_OPTION_INSIDE = 'i'
  - BrickletDustDetector.THRESHOLD_OPTION_SMALLER = '<'
  - BrickletDustDetector.THRESHOLD_OPTION_GREATER = '>'

  The returned object has the public member variables `char option`, `int min` and `int max`.

public void `setDebouncePeriod`(long debounce)

  Sets the period in ms with which the threshold listener

  - `DustDensityReachedListener`

  is triggered, if the threshold

  - `setDustDensityCallbackThreshold()`

  keeps being reached.

  The default value is 100.

public long `getDebouncePeriod`()

  Returns the debounce period as set by `setDebouncePeriod()`.

### 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 BrickletDustDetector.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.

Note

Using listeners 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 class `BrickletDustDetector.DustDensityListener`()

  This listener can be added with the `addDustDensityListener()` function. An added listener can be removed with the `removeDustDensityListener()` function.

  public void `dustDensity`(int dustDensity)

    This listener is triggered periodically with the period that is set by `setDustDensityCallbackPeriod()`. The parameter is the dust density of the sensor.

    `DustDensityListener` is only triggered if the dust density value has changed since the last triggering.

public class `BrickletDustDetector.DustDensityReachedListener`()

  This listener can be added with the `addDustDensityReachedListener()` function. An added listener can be removed with the `removeDustDensityReachedListener()` function.

  public void `dustDensityReached`(int dustDensity)

    This listener is triggered when the threshold as set by `setDustDensityCallbackThreshold()` is reached. The parameter is the dust density of the sensor.

    If the threshold keeps being reached, the listener is triggered periodically with the period as set by `setDebouncePeriod()`.

### Constants

public static final int `BrickletDustDetector.DEVICE_IDENTIFIER`

  This constant is used to identify a Dust Detector Bricklet.

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

The content of this page is licensed under Creative Commons Attribution 3.0 Unported License.