Java - Dust Detector 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

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

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

    // Change XYZ to the UID of your Dust Detector 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
        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
        int dustDensity = dd.getDustDensity(); // Can throw com.tinkerforge.TimeoutException
        System.out.println("Dust Density: " + dustDensity + " µ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

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

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

    // Change XYZ to the UID of your Dust Detector 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
        BrickletDustDetector dd = new BrickletDustDetector(UID, ipcon); // Create device object

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

        // Add dust density listener
        dd.addDustDensityListener(new BrickletDustDetector.DustDensityListener() {
            public void dustDensity(int dustDensity) {
                System.out.println("Dust Density: " + dustDensity + " µg/m³");
            }
        });

        // 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);

        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
36

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

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

    // Change XYZ to the UID of your Dust Detector 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
        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);

        // Add dust density reached listener
        dd.addDustDensityReachedListener(new BrickletDustDetector.DustDensityReachedListener() {
            public void dustDensityReached(int dustDensity) {
                System.out.println("Dust Density: " + dustDensity + " µg/m³");
            }
        });

        // Configure threshold for dust density "greater than 10 µg/m³"
        dd.setDustDensityCallbackThreshold('>', 10, 0);

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

Basic Functions¶

class BrickletDustDetector(String uid, IPConnection ipcon)¶

Parameters:	uid – Type: String ipcon – Type: IPConnection
Returns:	dustDetector – Type: BrickletDustDetector

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.

int BrickletDustDetector.getDustDensity()¶

Returns:	dustDensity – Type: int, Unit: 1 µg/m³, Range: [0 to 500]

Returns the dust density.

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

Advanced Functions¶

void BrickletDustDetector.setMovingAverage(short average)¶

Parameters:	average – Type: short, Range: [0 to 100], Default: 100

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.

short BrickletDustDetector.getMovingAverage()¶

Returns:	average – Type: short, Range: [0 to 100], Default: 100

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

BrickletDustDetector.Identity BrickletDustDetector.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 BrickletDustDetector.setDustDensityCallbackPeriod(long period)¶

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

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

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

long BrickletDustDetector.getDustDensityCallbackPeriod()¶

Returns:	period – Type: long, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0

Returns the period as set by setDustDensityCallbackPeriod().

void BrickletDustDetector.setDustDensityCallbackThreshold(char option, int min, int max)¶

Parameters:	option – Type: char, Range: See constants, Default: 'x' min – Type: int, Unit: 1 µg/m³, Range: [0 to 216 - 1], Default: 0 max – Type: int, Unit: 1 µg/m³, Range: [0 to 216 - 1], Default: 0

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 following constants are available for this function:

For option:

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

BrickletDustDetector.DustDensityCallbackThreshold BrickletDustDetector.getDustDensityCallbackThreshold()¶

Return Object:	option – Type: char, Range: See constants, Default: 'x' min – Type: int, Unit: 1 µg/m³, Range: [0 to 216 - 1], Default: 0 max – Type: int, Unit: 1 µg/m³, Range: [0 to 216 - 1], Default: 0

Returns the threshold as set by setDustDensityCallbackThreshold().

The following constants are available for this function:

For option:

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

void BrickletDustDetector.setDebouncePeriod(long debounce)¶

Parameters:	debounce – Type: long, Unit: 1 ms, Range: [0 to 232 - 1], Default: 100

Sets the period with which the threshold listener

• DustDensityReachedListener

is triggered, if the threshold

• setDustDensityCallbackThreshold()

keeps being reached.

long BrickletDustDetector.getDebouncePeriod()¶

Returns:	debounce – Type: long, Unit: 1 ms, Range: [0 to 232 - 1], Default: 100

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.

class BrickletDustDetector.DustDensityListener()¶

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

void dustDensity(int dustDensity)

Parameters:	dustDensity – Type: int, Unit: 1 µg/m³, Range: [0 to 500]

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

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

class BrickletDustDetector.DustDensityReachedListener()¶

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

void dustDensityReached(int dustDensity)

Parameters:	dustDensity – Type: int, Unit: 1 µg/m³, Range: [0 to 500]

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

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[] BrickletDustDetector.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 BrickletDustDetector.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:

• 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

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

• 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

void BrickletDustDetector.setResponseExpectedAll(boolean responseExpected)¶

Parameters:	responseExpected – Type: boolean

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

Constants¶

int BrickletDustDetector.DEVICE_IDENTIFIER¶

This constant is used to identify a Dust Detector 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 BrickletDustDetector.DEVICE_DISPLAY_NAME¶

This constant represents the human readable name of a Dust Detector Bricklet.