MATLAB/Octave - PTC Bricklet

This is the description of the MATLAB/Octave API bindings for the PTC Bricklet. General information and technical specifications for the PTC 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)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
function matlab_example_simple()
    import com.tinkerforge.IPConnection;
    import com.tinkerforge.BrickletPTC;

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

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

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

    % Get current temperature
    temperature = ptc.getTemperature();
    fprintf('Temperature: %g °C\n', temperature/100.0);

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

Callback (MATLAB)

Download (matlab_example_callback.m)

 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
function matlab_example_callback()
    import com.tinkerforge.IPConnection;
    import com.tinkerforge.BrickletPTC;

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

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

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

    % Register temperature callback to function cb_temperature
    set(ptc, 'TemperatureCallback', @(h, e) cb_temperature(e));

    % 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!
    ptc.setTemperatureCallbackPeriod(1000);

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

% Callback function for temperature callback
function cb_temperature(e)
    fprintf('Temperature: %g °C\n', e.temperature/100.0);
end

Threshold (MATLAB)

Download (matlab_example_threshold.m)

 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
function matlab_example_threshold()
    import com.tinkerforge.IPConnection;
    import com.tinkerforge.BrickletPTC;

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

    ipcon = IPConnection(); % Create IP connection
    ptc = handle(BrickletPTC(UID, ipcon), 'CallbackProperties'); % 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)
    ptc.setDebouncePeriod(10000);

    % Register temperature reached callback to function cb_temperature_reached
    set(ptc, 'TemperatureReachedCallback', @(h, e) cb_temperature_reached(e));

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

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

% Callback function for temperature reached callback
function cb_temperature_reached(e)
    fprintf('Temperature: %g °C\n', e.temperature/100.0);
end

Simple (Octave)

Download (octave_example_simple.m)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
function octave_example_simple()
    more off;

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

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

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

    % Get current temperature
    temperature = ptc.getTemperature();
    fprintf("Temperature: %g °C\n", temperature/100.0);

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

Callback (Octave)

Download (octave_example_callback.m)

 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
function octave_example_callback()
    more off;

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

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

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

    % Register temperature callback to function cb_temperature
    ptc.addTemperatureCallback(@cb_temperature);

    % 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!
    ptc.setTemperatureCallbackPeriod(1000);

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

% Callback function for temperature callback
function cb_temperature(e)
    fprintf("Temperature: %g °C\n", e.temperature/100.0);
end

Threshold (Octave)

Download (octave_example_threshold.m)

 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
function octave_example_threshold()
    more off;

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

    ipcon = javaObject("com.tinkerforge.IPConnection"); % Create IP connection
    ptc = javaObject("com.tinkerforge.BrickletPTC", 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)
    ptc.setDebouncePeriod(10000);

    % Register temperature reached callback to function cb_temperature_reached
    ptc.addTemperatureReachedCallback(@cb_temperature_reached);

    % Configure threshold for temperature "greater than 30 °C"
    ptc.setTemperatureCallbackThreshold(">", 30*100, 0);

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

% Callback function for temperature reached callback
function cb_temperature_reached(e)
    fprintf("Temperature: %g °C\n", e.temperature/100.0);
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 BrickletPTC(String uid, IPConnection ipcon)
Parameters:
  • uid – Type: String
  • ipcon – Type: IPConnection
Returns:
  • ptc – Type: BrickletPTC

Creates an object with the unique device ID uid.

In MATLAB:

import com.tinkerforge.BrickletPTC;

ptc = BrickletPTC('YOUR_DEVICE_UID', ipcon);

In Octave:

ptc = java_new("com.tinkerforge.BrickletPTC", "YOUR_DEVICE_UID", ipcon);

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

int BrickletPTC.getTemperature()
Returns:
  • temperature – Type: int, Unit: 1/100 °C, Range: [-24600 to 84900]

Returns the temperature of connected sensor.

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

boolean BrickletPTC.isSensorConnected()
Returns:
  • connected – Type: boolean

Returns true if the sensor is connected correctly.

If this function returns false, there is either no Pt100 or Pt1000 sensor connected, the sensor is connected incorrectly or the sensor itself is faulty.

void BrickletPTC.setWireMode(short mode)
Parameters:
  • mode – Type: short, Range: See constants, Default: 2

Sets the wire mode of the sensor. Possible values are 2, 3 and 4 which correspond to 2-, 3- and 4-wire sensors. The value has to match the jumper configuration on the Bricklet.

The following constants are available for this function:

For mode:

  • BrickletPTC.WIRE_MODE_2 = 2
  • BrickletPTC.WIRE_MODE_3 = 3
  • BrickletPTC.WIRE_MODE_4 = 4
short BrickletPTC.getWireMode()
Returns:
  • mode – Type: short, Range: See constants, Default: 2

Returns the wire mode as set by setWireMode()

The following constants are available for this function:

For mode:

  • BrickletPTC.WIRE_MODE_2 = 2
  • BrickletPTC.WIRE_MODE_3 = 3
  • BrickletPTC.WIRE_MODE_4 = 4

Advanced Functions

int BrickletPTC.getResistance()
Returns:
  • resistance – Type: int, Unit: ? Ω, Range: [-231 to 231 - 1]

Returns the value as measured by the MAX31865 precision delta-sigma ADC.

The value can be converted with the following formulas:

  • Pt100: resistance = (value * 390) / 32768
  • Pt1000: resistance = (value * 3900) / 32768

If you want to get the resistance periodically, it is recommended to use the ResistanceCallback callback and set the period with setResistanceCallbackPeriod().

void BrickletPTC.setNoiseRejectionFilter(short filter)
Parameters:
  • filter – Type: short, Range: See constants, Default: 0

Sets the noise rejection filter to either 50Hz (0) or 60Hz (1). Noise from 50Hz or 60Hz power sources (including harmonics of the AC power's fundamental frequency) is attenuated by 82dB.

The following constants are available for this function:

For filter:

  • BrickletPTC.FILTER_OPTION_50HZ = 0
  • BrickletPTC.FILTER_OPTION_60HZ = 1
short BrickletPTC.getNoiseRejectionFilter()
Returns:
  • filter – Type: short, Range: See constants, Default: 0

Returns the noise rejection filter option as set by setNoiseRejectionFilter()

The following constants are available for this function:

For filter:

  • BrickletPTC.FILTER_OPTION_50HZ = 0
  • BrickletPTC.FILTER_OPTION_60HZ = 1
BrickletPTC.Identity BrickletPTC.getIdentity()
Return Object:
  • uid – Type: String, Length: up to 8
  • connectedUid – Type: String, Length: up to 8
  • position – Type: char, Range: ['a' to 'h', 'i', '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 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). The Raspberry Pi HAT (Zero) Brick is always at position 'i' and the Bricklet connected to an Isolator Bricklet is always as 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 BrickletPTC.setTemperatureCallbackPeriod(long period)
Parameters:
  • period – Type: long, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0

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

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

long BrickletPTC.getTemperatureCallbackPeriod()
Returns:
  • period – Type: long, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0

Returns the period as set by setTemperatureCallbackPeriod().

void BrickletPTC.setResistanceCallbackPeriod(long period)
Parameters:
  • period – Type: long, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0

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

The ResistanceCallback callback is only triggered if the resistance has changed since the last triggering.

long BrickletPTC.getResistanceCallbackPeriod()
Returns:
  • period – Type: long, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0

Returns the period as set by setResistanceCallbackPeriod().

void BrickletPTC.setTemperatureCallbackThreshold(char option, int min, int max)
Parameters:
  • option – Type: char, Range: See constants, Default: 'x'
  • min – Type: int, Unit: 1/100 °C, Range: [-231 to 231 - 1], Default: 0
  • max – Type: int, Unit: 1/100 °C, Range: [-231 to 231 - 1], Default: 0

Sets the thresholds for the TemperatureReachedCallback callback.

The following options are possible:

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

The following constants are available for this function:

For option:

  • BrickletPTC.THRESHOLD_OPTION_OFF = 'x'
  • BrickletPTC.THRESHOLD_OPTION_OUTSIDE = 'o'
  • BrickletPTC.THRESHOLD_OPTION_INSIDE = 'i'
  • BrickletPTC.THRESHOLD_OPTION_SMALLER = '<'
  • BrickletPTC.THRESHOLD_OPTION_GREATER = '>'
BrickletPTC.TemperatureCallbackThreshold BrickletPTC.getTemperatureCallbackThreshold()
Return Object:
  • option – Type: char, Range: See constants, Default: 'x'
  • min – Type: int, Unit: 1/100 °C, Range: [-231 to 231 - 1], Default: 0
  • max – Type: int, Unit: 1/100 °C, Range: [-231 to 231 - 1], Default: 0

Returns the threshold as set by setTemperatureCallbackThreshold().

The following constants are available for this function:

For option:

  • BrickletPTC.THRESHOLD_OPTION_OFF = 'x'
  • BrickletPTC.THRESHOLD_OPTION_OUTSIDE = 'o'
  • BrickletPTC.THRESHOLD_OPTION_INSIDE = 'i'
  • BrickletPTC.THRESHOLD_OPTION_SMALLER = '<'
  • BrickletPTC.THRESHOLD_OPTION_GREATER = '>'
void BrickletPTC.setResistanceCallbackThreshold(char option, int min, int max)
Parameters:
  • option – Type: char, Range: See constants, Default: 'x'
  • min – Type: int, Unit: ? Ω, Range: [-231 to 231 - 1], Default: 0
  • max – Type: int, Unit: ? Ω, Range: [-231 to 231 - 1], Default: 0

Sets the thresholds for the ResistanceReachedCallback callback.

The following options are possible:

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

The following constants are available for this function:

For option:

  • BrickletPTC.THRESHOLD_OPTION_OFF = 'x'
  • BrickletPTC.THRESHOLD_OPTION_OUTSIDE = 'o'
  • BrickletPTC.THRESHOLD_OPTION_INSIDE = 'i'
  • BrickletPTC.THRESHOLD_OPTION_SMALLER = '<'
  • BrickletPTC.THRESHOLD_OPTION_GREATER = '>'
BrickletPTC.ResistanceCallbackThreshold BrickletPTC.getResistanceCallbackThreshold()
Return Object:
  • option – Type: char, Range: See constants, Default: 'x'
  • min – Type: int, Unit: ? Ω, Range: [-231 to 231 - 1], Default: 0
  • max – Type: int, Unit: ? Ω, Range: [-231 to 231 - 1], Default: 0

Returns the threshold as set by setResistanceCallbackThreshold().

The following constants are available for this function:

For option:

  • BrickletPTC.THRESHOLD_OPTION_OFF = 'x'
  • BrickletPTC.THRESHOLD_OPTION_OUTSIDE = 'o'
  • BrickletPTC.THRESHOLD_OPTION_INSIDE = 'i'
  • BrickletPTC.THRESHOLD_OPTION_SMALLER = '<'
  • BrickletPTC.THRESHOLD_OPTION_GREATER = '>'
void BrickletPTC.setDebouncePeriod(long debounce)
Parameters:
  • debounce – Type: long, Unit: 1 ms, Range: [0 to 232 - 1], Default: 100

Sets the period with which the threshold callback

is triggered, if the threshold

keeps being reached.

long BrickletPTC.getDebouncePeriod()
Returns:
  • debounce – Type: long, Unit: 1 ms, Range: [0 to 232 - 1], Default: 100

Returns the debounce period as set by setDebouncePeriod().

void BrickletPTC.setSensorConnectedCallbackConfiguration(boolean enabled)
Parameters:
  • enabled – Type: boolean, Default: false

If you enable this callback, the SensorConnectedCallback callback is triggered every time a Pt sensor is connected/disconnected.

New in version 2.0.2 (Plugin).

boolean BrickletPTC.getSensorConnectedCallbackConfiguration()
Returns:
  • enabled – Type: boolean, Default: false

Returns the configuration as set by setSensorConnectedCallbackConfiguration().

New in version 2.0.2 (Plugin).

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 BrickletPTC.TemperatureCallback
Event Object:
  • temperature – Type: int, Unit: 1/100 °C, Range: [-24600 to 84900]

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

The TemperatureCallback callback is only triggered if the 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 addTemperatureCallback() function. An added callback function can be removed with the removeTemperatureCallback() function.

callback BrickletPTC.TemperatureReachedCallback
Event Object:
  • temperature – Type: int, Unit: 1/100 °C, Range: [-24600 to 84900]

This callback is triggered when the threshold as set by setTemperatureCallbackThreshold() is reached. The parameter is the temperature of the connected 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 addTemperatureReachedCallback() function. An added callback function can be removed with the removeTemperatureReachedCallback() function.

callback BrickletPTC.ResistanceCallback
Event Object:
  • resistance – Type: int, Unit: ? Ω, Range: [-231 to 231 - 1]

This callback is triggered periodically with the period that is set by setResistanceCallbackPeriod(). The parameter is the resistance of the connected sensor.

The ResistanceCallback callback is only triggered if the resistance 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 addResistanceCallback() function. An added callback function can be removed with the removeResistanceCallback() function.

callback BrickletPTC.ResistanceReachedCallback
Event Object:
  • resistance – Type: int, Unit: ? Ω, Range: [-231 to 231 - 1]

This callback is triggered when the threshold as set by setResistanceCallbackThreshold() is reached. The parameter is the resistance of the connected 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 addResistanceReachedCallback() function. An added callback function can be removed with the removeResistanceReachedCallback() function.

callback BrickletPTC.SensorConnectedCallback
Event Object:
  • connected – Type: boolean

This callback is triggered periodically according to the configuration set by setSensorConnectedCallbackConfiguration().

The parameter is the same as isSensorConnected().

New in version 2.0.2 (Plugin).

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 addSensorConnectedCallback() function. An added callback function can be removed with the removeSensorConnectedCallback() 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[] BrickletPTC.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 BrickletPTC.getResponseExpected(short functionId)
Parameters:
  • functionId – Type: short, 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 send and errors are silently ignored, because they cannot be detected.

The following constants are available for this function:

For functionId:

  • BrickletPTC.FUNCTION_SET_TEMPERATURE_CALLBACK_PERIOD = 3
  • BrickletPTC.FUNCTION_SET_RESISTANCE_CALLBACK_PERIOD = 5
  • BrickletPTC.FUNCTION_SET_TEMPERATURE_CALLBACK_THRESHOLD = 7
  • BrickletPTC.FUNCTION_SET_RESISTANCE_CALLBACK_THRESHOLD = 9
  • BrickletPTC.FUNCTION_SET_DEBOUNCE_PERIOD = 11
  • BrickletPTC.FUNCTION_SET_NOISE_REJECTION_FILTER = 17
  • BrickletPTC.FUNCTION_SET_WIRE_MODE = 20
  • BrickletPTC.FUNCTION_SET_SENSOR_CONNECTED_CALLBACK_CONFIGURATION = 22
void BrickletPTC.setResponseExpected(short functionId, boolean responseExpected)
Parameters:
  • functionId – Type: short, 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.

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

For functionId:

  • BrickletPTC.FUNCTION_SET_TEMPERATURE_CALLBACK_PERIOD = 3
  • BrickletPTC.FUNCTION_SET_RESISTANCE_CALLBACK_PERIOD = 5
  • BrickletPTC.FUNCTION_SET_TEMPERATURE_CALLBACK_THRESHOLD = 7
  • BrickletPTC.FUNCTION_SET_RESISTANCE_CALLBACK_THRESHOLD = 9
  • BrickletPTC.FUNCTION_SET_DEBOUNCE_PERIOD = 11
  • BrickletPTC.FUNCTION_SET_NOISE_REJECTION_FILTER = 17
  • BrickletPTC.FUNCTION_SET_WIRE_MODE = 20
  • BrickletPTC.FUNCTION_SET_SENSOR_CONNECTED_CALLBACK_CONFIGURATION = 22
void BrickletPTC.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 BrickletPTC.DEVICE_IDENTIFIER

This constant is used to identify a PTC 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 BrickletPTC.DEVICE_DISPLAY_NAME

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