Java - CO2 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.BrickletCO2;

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

    // Change XYZ to the UID of your CO2 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
        BrickletCO2 co2 = new BrickletCO2(UID, ipcon); // Create device object

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

        // Get current CO2 concentration
        int co2Concentration = co2.getCO2Concentration(); // Can throw com.tinkerforge.TimeoutException
        System.out.println("CO2 Concentration: " + co2Concentration + " ppm");

        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.BrickletCO2;

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

    // Change XYZ to the UID of your CO2 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
        BrickletCO2 co2 = new BrickletCO2(UID, ipcon); // Create device object

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

        // Add CO2 concentration listener
        co2.addCO2ConcentrationListener(new BrickletCO2.CO2ConcentrationListener() {
            public void co2Concentration(int co2Concentration) {
                System.out.println("CO2 Concentration: " + co2Concentration + " ppm");
            }
        });

        // Set period for CO2 concentration callback to 1s (1000ms)
        // Note: The CO2 concentration callback is only called every second
        //       if the CO2 concentration has changed since the last call!
        co2.setCO2ConcentrationCallbackPeriod(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.BrickletCO2;

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

    // Change XYZ to the UID of your CO2 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
        BrickletCO2 co2 = new BrickletCO2(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)
        co2.setDebouncePeriod(10000);

        // Add CO2 concentration reached listener
        co2.addCO2ConcentrationReachedListener(new BrickletCO2.CO2ConcentrationReachedListener() {
            public void co2ConcentrationReached(int co2Concentration) {
                System.out.println("CO2 Concentration: " + co2Concentration + " ppm");
            }
        });

        // Configure threshold for CO2 concentration "greater than 750 ppm"
        co2.setCO2ConcentrationCallbackThreshold('>', 750, 0);

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

Basic Functions¶

class BrickletCO2(String uid, IPConnection ipcon)¶

Parameters:	uid – Type: String ipcon – Type: IPConnection
Returns:	co2 – Type: BrickletCO2

Creates an object with the unique device ID uid:

BrickletCO2 co2 = new BrickletCO2("YOUR_DEVICE_UID", ipcon);

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

int BrickletCO2.getCO2Concentration()¶

Returns:	co2Concentration – Type: int, Unit: 1 ppm, Range: [0 to 10000]

Returns the measured CO2 concentration.

If you want to get the CO2 concentration periodically, it is recommended to use the CO2ConcentrationListener listener and set the period with setCO2ConcentrationCallbackPeriod().

Advanced Functions¶

BrickletCO2.Identity BrickletCO2.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 BrickletCO2.setCO2ConcentrationCallbackPeriod(long period)¶

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

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

The CO2ConcentrationListener listener is only triggered if the CO2 concentration has changed since the last triggering.

long BrickletCO2.getCO2ConcentrationCallbackPeriod()¶

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

Returns the period as set by setCO2ConcentrationCallbackPeriod().

void BrickletCO2.setCO2ConcentrationCallbackThreshold(char option, int min, int max)¶

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

Sets the thresholds for the CO2ConcentrationReachedListener listener.

The following options are possible:

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

The following constants are available for this function:

For option:

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

BrickletCO2.CO2ConcentrationCallbackThreshold BrickletCO2.getCO2ConcentrationCallbackThreshold()¶

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

Returns the threshold as set by setCO2ConcentrationCallbackThreshold().

The following constants are available for this function:

For option:

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

void BrickletCO2.setDebouncePeriod(long debounce)¶

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

Sets the period with which the threshold listeners

• CO2ConcentrationReachedListener,

are triggered, if the thresholds

• setCO2ConcentrationCallbackThreshold(),

keep being reached.

long BrickletCO2.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 BrickletCO2.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 BrickletCO2.CO2ConcentrationListener()¶

This listener can be added with the addCO2ConcentrationListener() function. An added listener can be removed with the removeCO2ConcentrationListener() function.

void co2Concentration(int co2Concentration)

Parameters:	co2Concentration – Type: int, Unit: 1 ppm, Range: [0 to 10000]

This listener is triggered periodically with the period that is set by setCO2ConcentrationCallbackPeriod(). The parameter is the CO2 concentration of the sensor.

The CO2ConcentrationListener listener is only triggered if the CO2 concentration has changed since the last triggering.

class BrickletCO2.CO2ConcentrationReachedListener()¶

This listener can be added with the addCO2ConcentrationReachedListener() function. An added listener can be removed with the removeCO2ConcentrationReachedListener() function.

void co2ConcentrationReached(int co2Concentration)

Parameters:	co2Concentration – Type: int, Unit: 1 ppm, Range: [0 to 10000]

This listener is triggered when the threshold as set by setCO2ConcentrationCallbackThreshold() is reached. The parameter is the CO2 concentration.

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

• BrickletCO2.FUNCTION_SET_CO2_CONCENTRATION_CALLBACK_PERIOD = 2
• BrickletCO2.FUNCTION_SET_CO2_CONCENTRATION_CALLBACK_THRESHOLD = 4
• BrickletCO2.FUNCTION_SET_DEBOUNCE_PERIOD = 6

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

• BrickletCO2.FUNCTION_SET_CO2_CONCENTRATION_CALLBACK_PERIOD = 2
• BrickletCO2.FUNCTION_SET_CO2_CONCENTRATION_CALLBACK_THRESHOLD = 4
• BrickletCO2.FUNCTION_SET_DEBOUNCE_PERIOD = 6

void BrickletCO2.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 BrickletCO2.DEVICE_IDENTIFIER¶

This constant is used to identify a CO2 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 BrickletCO2.DEVICE_DISPLAY_NAME¶

This constant represents the human readable name of a CO2 Bricklet.