Java - Temperature 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.BrickletTemperature;

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

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

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

        // Get current temperature
        short temperature = t.getTemperature(); // Can throw com.tinkerforge.TimeoutException
        System.out.println("Temperature: " + temperature/100.0 + " °C");

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

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

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

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

        // Add temperature listener
        t.addTemperatureListener(new BrickletTemperature.TemperatureListener() {
            public void temperature(short temperature) {
                System.out.println("Temperature: " + temperature/100.0 + " °C");
            }
        });

        // Set period for temperature callback to 1s (1000ms)
        // Note: The temperature callback is only called every second
        //       if the temperature has changed since the last call!
        t.setTemperatureCallbackPeriod(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
37

import com.tinkerforge.IPConnection;
import com.tinkerforge.BrickletTemperature;

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

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

        // Add temperature reached listener
        t.addTemperatureReachedListener(new BrickletTemperature.TemperatureReachedListener() {
            public void temperatureReached(short temperature) {
                System.out.println("Temperature: " + temperature/100.0 + " °C");
                System.out.println("It is too hot, we need air conditioning!");
            }
        });

        // Configure threshold for temperature "greater than 30 °C"
        t.setTemperatureCallbackThreshold('>', (short)(30*100), (short)0);

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

Basic Functions¶

class BrickletTemperature(String uid, IPConnection ipcon)¶

Parameters:	uid – Type: String ipcon – Type: IPConnection
Returns:	temperature – Type: BrickletTemperature

Creates an object with the unique device ID uid:

BrickletTemperature temperature = new BrickletTemperature("YOUR_DEVICE_UID", ipcon);

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

short BrickletTemperature.getTemperature()¶

Returns:	temperature – Type: short, Unit: 1/100 °C, Range: [-2500 to 8500]

Returns the temperature of the sensor.

If you want to get the temperature periodically, it is recommended to use the TemperatureListener listener and set the period with setTemperatureCallbackPeriod().

Advanced Functions¶

void BrickletTemperature.setI2CMode(short mode)¶

Parameters:	mode – Type: short, Range: See constants, Default: 0

Sets the I2C mode. Possible modes are:

• 0: Fast (400kHz)
• 1: Slow (100kHz)

If you have problems with obvious outliers in the Temperature Bricklet measurements, they may be caused by EMI issues. In this case it may be helpful to lower the I2C speed.

It is however not recommended to lower the I2C speed in applications where a high throughput needs to be achieved.

The following constants are available for this function:

For mode:

• BrickletTemperature.I2C_MODE_FAST = 0
• BrickletTemperature.I2C_MODE_SLOW = 1

New in version 2.0.1 (Plugin).

short BrickletTemperature.getI2CMode()¶

Returns:	mode – Type: short, Range: See constants, Default: 0

Returns the I2C mode as set by setI2CMode().

The following constants are available for this function:

For mode:

• BrickletTemperature.I2C_MODE_FAST = 0
• BrickletTemperature.I2C_MODE_SLOW = 1

New in version 2.0.1 (Plugin).

BrickletTemperature.Identity BrickletTemperature.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 BrickletTemperature.setTemperatureCallbackPeriod(long period)¶

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

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

The TemperatureListener listener is only triggered if the temperature has changed since the last triggering.

long BrickletTemperature.getTemperatureCallbackPeriod()¶

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

Returns the period as set by setTemperatureCallbackPeriod().

void BrickletTemperature.setTemperatureCallbackThreshold(char option, short min, short max)¶

Parameters:	option – Type: char, Range: See constants, Default: 'x' min – Type: short, Unit: 1/100 °C, Range: [-215 to 215 - 1], Default: 0 max – Type: short, Unit: 1/100 °C, Range: [-215 to 215 - 1], Default: 0

Sets the thresholds for the TemperatureReachedListener listener.

The following options are possible:

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

The following constants are available for this function:

For option:

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

BrickletTemperature.TemperatureCallbackThreshold BrickletTemperature.getTemperatureCallbackThreshold()¶

Return Object:	option – Type: char, Range: See constants, Default: 'x' min – Type: short, Unit: 1/100 °C, Range: [-215 to 215 - 1], Default: 0 max – Type: short, Unit: 1/100 °C, Range: [-215 to 215 - 1], Default: 0

Returns the threshold as set by setTemperatureCallbackThreshold().

The following constants are available for this function:

For option:

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

void BrickletTemperature.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

• TemperatureReachedListener

is triggered, if the threshold

• setTemperatureCallbackThreshold()

keeps being reached.

long BrickletTemperature.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 BrickletTemperature.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 BrickletTemperature.TemperatureListener()¶

This listener can be added with the addTemperatureListener() function. An added listener can be removed with the removeTemperatureListener() function.

void temperature(short temperature)

Parameters:	temperature – Type: short, Unit: 1/100 °C, Range: [-2500 to 8500]

This listener is triggered periodically with the period that is set by setTemperatureCallbackPeriod(). The parameter is the temperature of the sensor.

The TemperatureListener listener is only triggered if the temperature has changed since the last triggering.

class BrickletTemperature.TemperatureReachedListener()¶

This listener can be added with the addTemperatureReachedListener() function. An added listener can be removed with the removeTemperatureReachedListener() function.

void temperatureReached(short temperature)

Parameters:	temperature – Type: short, Unit: 1/100 °C, Range: [-2500 to 8500]

This listener is triggered when the threshold as set by setTemperatureCallbackThreshold() is reached. The parameter is the temperature 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[] BrickletTemperature.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 BrickletTemperature.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:

• BrickletTemperature.FUNCTION_SET_TEMPERATURE_CALLBACK_PERIOD = 2
• BrickletTemperature.FUNCTION_SET_TEMPERATURE_CALLBACK_THRESHOLD = 4
• BrickletTemperature.FUNCTION_SET_DEBOUNCE_PERIOD = 6
• BrickletTemperature.FUNCTION_SET_I2C_MODE = 10

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

• BrickletTemperature.FUNCTION_SET_TEMPERATURE_CALLBACK_PERIOD = 2
• BrickletTemperature.FUNCTION_SET_TEMPERATURE_CALLBACK_THRESHOLD = 4
• BrickletTemperature.FUNCTION_SET_DEBOUNCE_PERIOD = 6
• BrickletTemperature.FUNCTION_SET_I2C_MODE = 10

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

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

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