Software / API Bindings / MATLAB/Octave / API Reference and Examples / Bricklets (Discontinued) / Temperature IR Bricklet

MATLAB/Octave - Temperature IR Bricklet¶

This is the description of the MATLAB/Octave 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 MATLAB/Octave API bindings is part of their general description.

Examples¶

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

Simple (MATLAB)¶

Download (matlab_example_simple.m)

function matlab_example_simple()
    import com.tinkerforge.IPConnection;
    import com.tinkerforge.BrickletTemperatureIR;

    HOST = 'localhost';
    PORT = 4223;
    UID = 'XYZ'; % Change XYZ to the UID of your Temperature IR Bricklet

    ipcon = IPConnection(); % Create IP connection
    tir = handle(BrickletTemperatureIR(UID, ipcon), 'CallbackProperties'); % Create device object

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

    % Get current ambient temperature
    ambientTemperature = tir.getAmbientTemperature();
    fprintf('Ambient Temperature: %g °C\n', ambientTemperature/10.0);

    % Get current object temperature
    objectTemperature = tir.getObjectTemperature();
    fprintf('Object Temperature: %g °C\n', objectTemperature/10.0);

    input('Press key to exit\n', 's');
    ipcon.disconnect();
end

Callback (MATLAB)¶

Download (matlab_example_callback.m)

function matlab_example_callback()
    import com.tinkerforge.IPConnection;
    import com.tinkerforge.BrickletTemperatureIR;

    HOST = 'localhost';
    PORT = 4223;
    UID = 'XYZ'; % Change XYZ to the UID of your Temperature IR Bricklet

    ipcon = IPConnection(); % Create IP connection
    tir = handle(BrickletTemperatureIR(UID, ipcon), 'CallbackProperties'); % Create device object

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

    % Register object temperature callback to function cb_object_temperature
    set(tir, 'ObjectTemperatureCallback', @(h, e) cb_object_temperature(e));

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

    input('Press key to exit\n', 's');
    ipcon.disconnect();
end

% Callback function for object temperature callback
function cb_object_temperature(e)
    fprintf('Object Temperature: %g °C\n', e.temperature/10.0);
end

Water Boiling (MATLAB)¶

Download (matlab_example_water_boiling.m)

function matlab_example_water_boiling()
    import com.tinkerforge.IPConnection;
    import com.tinkerforge.BrickletTemperatureIR;

    HOST = 'localhost';
    PORT = 4223;
    UID = 'XYZ'; % Change XYZ to the UID of your Temperature IR Bricklet

    ipcon = IPConnection(); % Create IP connection
    tir = handle(BrickletTemperatureIR(UID, ipcon), 'CallbackProperties'); % 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);

    % Register object temperature reached callback to function
    % cb_object_temperature_reached
    set(tir, 'ObjectTemperatureReachedCallback',
        @(h, e) cb_object_temperature_reached(e));

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

    input('Press key to exit\n', 's');
    ipcon.disconnect();
end

% Callback function for object temperature reached callback
function cb_object_temperature_reached(e)
    fprintf('Object Temperature: %g °C\n', e.temperature/10.0);
    fprintf('The water is boiling!\n');
end

Simple (Octave)¶

Download (octave_example_simple.m)

function octave_example_simple()
    more off;

    HOST = "localhost";
    PORT = 4223;
    UID = "XYZ"; % Change XYZ to the UID of your Temperature IR Bricklet

    ipcon = javaObject("com.tinkerforge.IPConnection"); % Create IP connection
    tir = javaObject("com.tinkerforge.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
    ambientTemperature = tir.getAmbientTemperature();
    fprintf("Ambient Temperature: %g °C\n", java2int(ambientTemperature)/10.0);

    % Get current object temperature
    objectTemperature = tir.getObjectTemperature();
    fprintf("Object Temperature: %g °C\n", java2int(objectTemperature)/10.0);

    input("Press key to exit\n", "s");
    ipcon.disconnect();
end

function int = java2int(value)
    if compare_versions(version(), "3.8", "<=")
        int = value.intValue();
    else
        int = value;
    end
end

Callback (Octave)¶

Download (octave_example_callback.m)

function octave_example_callback()
    more off;

    HOST = "localhost";
    PORT = 4223;
    UID = "XYZ"; % Change XYZ to the UID of your Temperature IR Bricklet

    ipcon = javaObject("com.tinkerforge.IPConnection"); % Create IP connection
    tir = javaObject("com.tinkerforge.BrickletTemperatureIR", UID, ipcon); % Create device object

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

    % Register object temperature callback to function cb_object_temperature
    tir.addObjectTemperatureCallback(@cb_object_temperature);

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

    input("Press key to exit\n", "s");
    ipcon.disconnect();
end

% Callback function for object temperature callback
function cb_object_temperature(e)
    fprintf("Object Temperature: %g °C\n", java2int(e.temperature)/10.0);
end

function int = java2int(value)
    if compare_versions(version(), "3.8", "<=")
        int = value.intValue();
    else
        int = value;
    end
end

Water Boiling (Octave)¶

Download (octave_example_water_boiling.m)

function octave_example_water_boiling()
    more off;

    HOST = "localhost";
    PORT = 4223;
    UID = "XYZ"; % Change XYZ to the UID of your Temperature IR Bricklet

    ipcon = javaObject("com.tinkerforge.IPConnection"); % Create IP connection
    tir = javaObject("com.tinkerforge.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);

    % Register object temperature reached callback to function
    % cb_object_temperature_reached
    tir.addObjectTemperatureReachedCallback(@cb_object_temperature_reached);

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

    input("Press key to exit\n", "s");
    ipcon.disconnect();
end

% Callback function for object temperature reached callback
function cb_object_temperature_reached(e)
    fprintf("Object Temperature: %g °C\n", java2int(e.temperature)/10.0);
    fprintf("The water is boiling!\n");
end

function int = java2int(value)
    if compare_versions(version(), "3.8", "<=")
        int = value.intValue();
    else
        int = value;
    end
end

API¶

Generally, every method of the MATLAB 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 the MATLAB bindings are based on Java and 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¶

class BrickletTemperatureIR(String uid, IPConnection ipcon)¶

Parameters:	uid – Type: String ipcon – Type: IPConnection
Returns:	temperatureIR – Type: BrickletTemperatureIR

Creates an object with the unique device ID uid.

In MATLAB:

import com.tinkerforge.BrickletTemperatureIR;

temperatureIR = BrickletTemperatureIR('YOUR_DEVICE_UID', ipcon);

In Octave:

temperatureIR = java_new("com.tinkerforge.BrickletTemperatureIR", "YOUR_DEVICE_UID", ipcon);

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

short BrickletTemperatureIR.getAmbientTemperature()¶

Returns:	temperature – Type: short, Unit: 1/10 °C, Range: [-400 to 1250]

Returns the ambient temperature of the sensor.

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

short BrickletTemperatureIR.getObjectTemperature()¶

Returns:	temperature – Type: short, Unit: 1/10 °C, Range: [-700 to 3800]

Returns the object temperature of the sensor, i.e. the temperature of the surface of the object the sensor is aimed at.

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 ObjectTemperatureCallback callback and set the period with setObjectTemperatureCallbackPeriod().

Advanced Functions¶

void BrickletTemperatureIR.setEmissivity(int emissivity)¶

Parameters:	emissivity – Type: int, Unit: 1/65535, Range: [6553 to 2¹⁶ - 1], Default: 2¹⁶ - 1

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 emissivity is stored in non-volatile memory and will still be used after a restart or power cycle of the Bricklet.

int BrickletTemperatureIR.getEmissivity()¶

Returns:	emissivity – Type: int, Unit: 1/65535, Range: [6553 to 2¹⁶ - 1], Default: 2¹⁶ - 1

Returns the emissivity as set by setEmissivity().

BrickletTemperatureIR.Identity BrickletTemperatureIR.getIdentity()¶

Return Object:

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 1: major – Type: short, Range: [0 to 255] 2: minor – Type: short, Range: [0 to 255] 3: revision – Type: short, Range: [0 to 255] firmwareVersion – Type: short[], Length: 3 1: major – Type: short, Range: [0 to 255] 2: minor – Type: short, Range: [0 to 255] 3: revision – Type: short, Range: [0 to 255] deviceIdentifier – Type: int, Range: [0 to 2¹⁶ - 1]

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

1: major – Type: short, Range: [0 to 255]
2: minor – Type: short, Range: [0 to 255]
3: revision – Type: short, Range: [0 to 255]

firmwareVersion – Type: short[], Length: 3

1: major – Type: short, Range: [0 to 255]
2: minor – Type: short, Range: [0 to 255]
3: revision – Type: short, Range: [0 to 255]

deviceIdentifier – Type: int, Range: [0 to 2¹⁶ - 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.

Callback Configuration Functions¶

void BrickletTemperatureIR.setAmbientTemperatureCallbackPeriod(long period)¶

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

Sets the period with which the AmbientTemperatureCallback callback is triggered periodically. A value of 0 turns the callback off.

The AmbientTemperatureCallback callback is only triggered if the temperature has changed since the last triggering.

long BrickletTemperatureIR.getAmbientTemperatureCallbackPeriod()¶

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

Returns the period as set by setAmbientTemperatureCallbackPeriod().

void BrickletTemperatureIR.setObjectTemperatureCallbackPeriod(long period)¶

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

Sets the period with which the ObjectTemperatureCallback callback is triggered periodically. A value of 0 turns the callback off.

The ObjectTemperatureCallback callback is only triggered if the temperature has changed since the last triggering.

long BrickletTemperatureIR.getObjectTemperatureCallbackPeriod()¶

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

Returns the period as set by setObjectTemperatureCallbackPeriod().

void BrickletTemperatureIR.setAmbientTemperatureCallbackThreshold(char option, short min, short max)¶

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

Sets the thresholds for the AmbientTemperatureReachedCallback callback.

The following options are possible:

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

The following constants are available for this function:

For option:

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

BrickletTemperatureIR.AmbientTemperatureCallbackThreshold BrickletTemperatureIR.getAmbientTemperatureCallbackThreshold()¶

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

Returns the threshold as set by setAmbientTemperatureCallbackThreshold().

The following constants are available for this function:

For option:

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

void BrickletTemperatureIR.setObjectTemperatureCallbackThreshold(char option, short min, short max)¶

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

Sets the thresholds for the ObjectTemperatureReachedCallback callback.

The following options are possible:

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

The following constants are available for this function:

For option:

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

BrickletTemperatureIR.ObjectTemperatureCallbackThreshold BrickletTemperatureIR.getObjectTemperatureCallbackThreshold()¶

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

Returns the threshold as set by setObjectTemperatureCallbackThreshold().

The following constants are available for this function:

For option:

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

void BrickletTemperatureIR.setDebouncePeriod(long debounce)¶

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

Sets the period with which the threshold callbacks

AmbientTemperatureReachedCallback,
ObjectTemperatureReachedCallback

are triggered, if the thresholds

setAmbientTemperatureCallbackThreshold(),
setObjectTemperatureCallbackThreshold()

keep being reached.

long BrickletTemperatureIR.getDebouncePeriod()¶

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

Returns the debounce period as set by setDebouncePeriod().

Callbacks¶

Callbacks can be registered to receive time critical or recurring data from the device. The registration is done with "set" function of MATLAB. The parameters consist of the IP Connection object, the callback name and the callback function. For example, it looks like this in MATLAB:

function my_callback(e)
    fprintf('Parameter: %s\n', e.param);
end

set(device, 'ExampleCallback', @(h, e) my_callback(e));

Due to a difference in the Octave Java support the "set" function cannot be used in Octave. The registration is done with "add*Callback" functions of the device object. It looks like this in Octave:

function my_callback(e)
    fprintf("Parameter: %s\n", e.param);
end

device.addExampleCallback(@my_callback);

It is possible to add several callbacks and to remove them with the corresponding "remove*Callback" function.

The parameters of the callback are passed to the callback function as fields of the structure e, which is derived from the java.util.EventObject class. The available callback names with corresponding structure fields are described below.

Note

Using callbacks 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.

callback BrickletTemperatureIR.AmbientTemperatureCallback¶

Event Object:	temperature – Type: short, Unit: 1/10 °C, Range: [-400 to 1250]

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

The AmbientTemperatureCallback callback is only triggered if the ambient temperature has changed since the last triggering.

In MATLAB the set() function can be used to register a callback function to this callback.

In Octave a callback function can be added to this callback using the addAmbientTemperatureCallback() function. An added callback function can be removed with the removeAmbientTemperatureCallback() function.

callback BrickletTemperatureIR.ObjectTemperatureCallback¶

Event Object:	temperature – Type: short, Unit: 1/10 °C, Range: [-700 to 3800]

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

The ObjectTemperatureCallback callback is only triggered if the object temperature has changed since the last triggering.

In MATLAB the set() function can be used to register a callback function to this callback.

In Octave a callback function can be added to this callback using the addObjectTemperatureCallback() function. An added callback function can be removed with the removeObjectTemperatureCallback() function.

callback BrickletTemperatureIR.AmbientTemperatureReachedCallback¶

Event Object:	temperature – Type: short, Unit: 1/10 °C, Range: [-400 to 1250]

This callback 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 callback is triggered periodically with the period as set by setDebouncePeriod().

In MATLAB the set() function can be used to register a callback function to this callback.

In Octave a callback function can be added to this callback using the addAmbientTemperatureReachedCallback() function. An added callback function can be removed with the removeAmbientTemperatureReachedCallback() function.

callback BrickletTemperatureIR.ObjectTemperatureReachedCallback¶

Event Object:	temperature – Type: short, Unit: 1/10 °C, Range: [-700 to 3800]

This callback 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 callback is triggered periodically with the period as set by setDebouncePeriod().

In MATLAB the set() function can be used to register a callback function to this callback.

In Octave a callback function can be added to this callback using the addObjectTemperatureReachedCallback() function. An added callback function can be removed with the removeObjectTemperatureReachedCallback() function.

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[] BrickletTemperatureIR.getAPIVersion()¶

Return Object:	apiVersion – Type: short[], Length: 3 1: major – Type: short, Range: [0 to 255] 2: minor – Type: short, Range: [0 to 255] 3: 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 BrickletTemperatureIR.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 callback 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:

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

void BrickletTemperatureIR.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 callback configuration functions (default value: true). For getter functions it is always enabled.

The following constants are available for this function:

For functionId:

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

void BrickletTemperatureIR.setResponseExpectedAll(boolean responseExpected)¶

Parameters:	responseExpected – Type: boolean

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

Constants¶

int BrickletTemperatureIR.DEVICE_IDENTIFIER¶

This constant is used to identify a Temperature IR Bricklet.

The getIdentity() function and the IPConnection.EnumerateCallback callback of the IP Connection have a deviceIdentifier parameter to specify the Brick's or Bricklet's type.

String BrickletTemperatureIR.DEVICE_DISPLAY_NAME¶: This constant represents the human readable name of a Temperature IR Bricklet.