Java - Temperature IR Bricklet

This is the description of the Java API bindings for the Temperature IR Bricklet. General information and technical specifications for the Temperature IR 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
27
28
29
30
31
import com.tinkerforge.IPConnection;
import com.tinkerforge.BrickletTemperatureIR;

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

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

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

        // Get current ambient temperature
        short ambientTemperature = tir.getAmbientTemperature(); // Can throw com.tinkerforge.TimeoutException
        System.out.println("Ambient Temperature: " + ambientTemperature/10.0 + " °C");

        // Get current object temperature
        short objectTemperature = tir.getObjectTemperature(); // Can throw com.tinkerforge.TimeoutException
        System.out.println("Object Temperature: " + objectTemperature/10.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.BrickletTemperatureIR;

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

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

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

        // Add object temperature listener
        tir.addObjectTemperatureListener(new BrickletTemperatureIR.ObjectTemperatureListener() {
            public void objectTemperature(short temperature) {
                System.out.println("Object Temperature: " + temperature/10.0 + " °C");
            }
        });

        // Set period for object temperature callback to 1s (1000ms)
        // Note: The object temperature callback is only called every second
        //       if the object temperature has changed since the last call!
        tir.setObjectTemperatureCallbackPeriod(1000);

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

Water Boiling

Download (ExampleWaterBoiling.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
38
39
40
import com.tinkerforge.IPConnection;
import com.tinkerforge.BrickletTemperatureIR;

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

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

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

        // Set emissivity to 0.98 (emissivity of water, 65535 * 0.98 = 64224.299)
        tir.setEmissivity(64224);

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

        // Add object temperature reached listener
        tir.addObjectTemperatureReachedListener(new BrickletTemperatureIR.ObjectTemperatureReachedListener() {
            public void objectTemperatureReached(short temperature) {
                System.out.println("Object Temperature: " + temperature/10.0 + " °C");
                System.out.println("The water is boiling!");
            }
        });

        // Configure threshold for object temperature "greater than 100 °C"
        tir.setObjectTemperatureCallbackThreshold('>', (short)(100*10), (short)0);

        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 BrickletTemperatureIR(String uid, IPConnection ipcon)

Creates an object with the unique device ID uid:

BrickletTemperatureIR temperatureIR = new BrickletTemperatureIR("YOUR_DEVICE_UID", ipcon);

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

public short getAmbientTemperature()

Returns the ambient temperature of the sensor. The value has a range of -400 to 1250 and is given in °C/10, e.g. a value of 423 means that an ambient temperature of 42.3 °C is measured.

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

public short getObjectTemperature()

Returns the object temperature of the sensor, i.e. the temperature of the surface of the object the sensor is aimed at. The value has a range of -700 to 3800 and is given in °C/10, e.g. a value of 3001 means that a temperature of 300.1 °C is measured on the surface of the object.

The temperature of different materials is dependent on their emissivity. The emissivity of the material can be set with setEmissivity().

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

Advanced Functions

public void setEmissivity(int emissivity)

Sets the emissivity that is used to calculate the surface temperature as returned by getObjectTemperature().

The emissivity is usually given as a value between 0.0 and 1.0. A list of emissivities of different materials can be found here.

The parameter of setEmissivity() has to be given with a factor of 65535 (16-bit). For example: An emissivity of 0.1 can be set with the value 6553, an emissivity of 0.5 with the value 32767 and so on.

Note

If you need a precise measurement for the object temperature, it is absolutely crucial that you also provide a precise emissivity.

The default emissivity is 1.0 (value of 65535) and the minimum emissivity the sensor can handle is 0.1 (value of 6553).

The emissivity is stored in non-volatile memory and will still be used after a restart or power cycle of the Bricklet.

public int getEmissivity()

Returns the emissivity as set by setEmissivity().

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.

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:

  • BrickletTemperatureIR.FUNCTION_SET_EMISSIVITY = 3
  • BrickletTemperatureIR.FUNCTION_SET_AMBIENT_TEMPERATURE_CALLBACK_PERIOD = 5
  • BrickletTemperatureIR.FUNCTION_SET_OBJECT_TEMPERATURE_CALLBACK_PERIOD = 7
  • BrickletTemperatureIR.FUNCTION_SET_AMBIENT_TEMPERATURE_CALLBACK_THRESHOLD = 9
  • BrickletTemperatureIR.FUNCTION_SET_OBJECT_TEMPERATURE_CALLBACK_THRESHOLD = 11
  • BrickletTemperatureIR.FUNCTION_SET_DEBOUNCE_PERIOD = 13
public void setResponseExpectedAll(boolean responseExpected)

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

public BrickletTemperatureIR.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 setAmbientTemperatureCallbackPeriod(long period)

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

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

The default value is 0.

public long getAmbientTemperatureCallbackPeriod()

Returns the period as set by setAmbientTemperatureCallbackPeriod().

public void setObjectTemperatureCallbackPeriod(long period)

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

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

The default value is 0.

public long getObjectTemperatureCallbackPeriod()

Returns the period as set by setObjectTemperatureCallbackPeriod().

public void setAmbientTemperatureCallbackThreshold(char option, short min, short max)

Sets the thresholds for the AmbientTemperatureReachedListener listener.

The following options are possible:

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

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

The following constants are available for this function:

  • BrickletTemperatureIR.THRESHOLD_OPTION_OFF = 'x'
  • BrickletTemperatureIR.THRESHOLD_OPTION_OUTSIDE = 'o'
  • BrickletTemperatureIR.THRESHOLD_OPTION_INSIDE = 'i'
  • BrickletTemperatureIR.THRESHOLD_OPTION_SMALLER = '<'
  • BrickletTemperatureIR.THRESHOLD_OPTION_GREATER = '>'
public BrickletTemperatureIR.AmbientTemperatureCallbackThreshold getAmbientTemperatureCallbackThreshold()

Returns the threshold as set by setAmbientTemperatureCallbackThreshold().

The following constants are available for this function:

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

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

public void setObjectTemperatureCallbackThreshold(char option, short min, short max)

Sets the thresholds for the ObjectTemperatureReachedListener listener.

The following options are possible:

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

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

The following constants are available for this function:

  • BrickletTemperatureIR.THRESHOLD_OPTION_OFF = 'x'
  • BrickletTemperatureIR.THRESHOLD_OPTION_OUTSIDE = 'o'
  • BrickletTemperatureIR.THRESHOLD_OPTION_INSIDE = 'i'
  • BrickletTemperatureIR.THRESHOLD_OPTION_SMALLER = '<'
  • BrickletTemperatureIR.THRESHOLD_OPTION_GREATER = '>'
public BrickletTemperatureIR.ObjectTemperatureCallbackThreshold getObjectTemperatureCallbackThreshold()

Returns the threshold as set by setObjectTemperatureCallbackThreshold().

The following constants are available for this function:

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

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

public void setDebouncePeriod(long debounce)

Sets the period in ms with which the threshold listeners

  • AmbientTemperatureReachedListener,
  • ObjectTemperatureReachedListener

are triggered, if the thresholds

keep 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 BrickletTemperatureIR.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 BrickletTemperatureIR.AmbientTemperatureListener()

This listener can be added with the addAmbientTemperatureListener() function. An added listener can be removed with the removeAmbientTemperatureListener() function.

public void ambientTemperature(short temperature)

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

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

public class BrickletTemperatureIR.ObjectTemperatureListener()

This listener can be added with the addObjectTemperatureListener() function. An added listener can be removed with the removeObjectTemperatureListener() function.

public void objectTemperature(short temperature)

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

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

public class BrickletTemperatureIR.AmbientTemperatureReachedListener()

This listener can be added with the addAmbientTemperatureReachedListener() function. An added listener can be removed with the removeAmbientTemperatureReachedListener() function.

public void ambientTemperatureReached(short temperature)

This listener is triggered when the threshold as set by setAmbientTemperatureCallbackThreshold() is reached. The parameter is the ambient temperature of the sensor.

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

public class BrickletTemperatureIR.ObjectTemperatureReachedListener()

This listener can be added with the addObjectTemperatureReachedListener() function. An added listener can be removed with the removeObjectTemperatureReachedListener() function.

public void objectTemperatureReached(short temperature)

This listener is triggered when the threshold as set by setObjectTemperatureCallbackThreshold() is reached. The parameter is the object temperature 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 BrickletTemperatureIR.DEVICE_IDENTIFIER

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

public static final String BrickletTemperatureIR.DEVICE_DISPLAY_NAME

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