MATLAB/Octave - Rotary Poti Bricklet¶

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

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

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

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

    % Get current position
    position = rp.getPosition();
    fprintf('Position: %i\n', position); % Range: -150 to 150

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

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

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

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

    % Register position callback to function cb_position
    set(rp, 'PositionCallback', @(h, e) cb_position(e));

    % Set period for position callback to 0.05s (50ms)
    % Note: The position callback is only called every 0.05 seconds
    %       if the position has changed since the last call!
    rp.setPositionCallbackPeriod(50);

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

% Callback function for position callback
function cb_position(e)
    fprintf('Position: %i\n', e.position); % Range: -150 to 150
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
21
22
23
24
25
26
27
28

function octave_example_simple()
    more off;

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

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

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

    % Get current position
    position = rp.getPosition();
    fprintf("Position: %d\n", java2int(position)); % Range: -150 to 150

    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)

 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

function octave_example_callback()
    more off;

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

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

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

    % Register position callback to function cb_position
    rp.addPositionCallback(@cb_position);

    % Set period for position callback to 0.05s (50ms)
    % Note: The position callback is only called every 0.05 seconds
    %       if the position has changed since the last call!
    rp.setPositionCallbackPeriod(50);

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

% Callback function for position callback
function cb_position(e)
    fprintf("Position: %d\n", java2int(e.position)); % Range: -150 to 150
end

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

Basic Functions¶

class BrickletRotaryPoti(String uid, IPConnection ipcon)¶

Parameters:	uid – Type: String ipcon – Type: IPConnection
Returns:	rotaryPoti – Type: BrickletRotaryPoti

Creates an object with the unique device ID uid.

In MATLAB:

import com.tinkerforge.BrickletRotaryPoti;

rotaryPoti = BrickletRotaryPoti('YOUR_DEVICE_UID', ipcon);

In Octave:

rotaryPoti = java_new("com.tinkerforge.BrickletRotaryPoti", "YOUR_DEVICE_UID", ipcon);

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

short BrickletRotaryPoti.getPosition()¶

Returns:	position – Type: short, Unit: 1 °, Range: [-150 to 150]

Returns the position of the rotary potentiometer. The value is between -150° (turned left) and 150° (turned right).

If you want to get the position periodically, it is recommended to use the PositionCallback callback and set the period with setPositionCallbackPeriod().

Advanced Functions¶

int BrickletRotaryPoti.getAnalogValue()¶

Returns:	value – Type: int, Range: [0 to 212]

Returns the value as read by a 12-bit analog-to-digital converter.

Note

The value returned by getPosition() is averaged over several samples to yield less noise, while getAnalogValue() gives back raw unfiltered analog values. The only reason to use getAnalogValue() is, if you need the full resolution of the analog-to-digital converter.

If you want the analog value periodically, it is recommended to use the AnalogValueCallback callback and set the period with setAnalogValueCallbackPeriod().

BrickletRotaryPoti.Identity BrickletRotaryPoti.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 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). 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 BrickletRotaryPoti.setPositionCallbackPeriod(long period)¶

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

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

The PositionCallback callback is only triggered if the position has changed since the last triggering.

long BrickletRotaryPoti.getPositionCallbackPeriod()¶

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

Returns the period as set by setPositionCallbackPeriod().

void BrickletRotaryPoti.setAnalogValueCallbackPeriod(long period)¶

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

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

The AnalogValueCallback callback is only triggered if the analog value has changed since the last triggering.

long BrickletRotaryPoti.getAnalogValueCallbackPeriod()¶

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

Returns the period as set by setAnalogValueCallbackPeriod().

void BrickletRotaryPoti.setPositionCallbackThreshold(char option, short min, short max)¶

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

Sets the thresholds for the PositionReachedCallback callback.

The following options are possible:

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

The following constants are available for this function:

For option:

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

BrickletRotaryPoti.PositionCallbackThreshold BrickletRotaryPoti.getPositionCallbackThreshold()¶

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

Returns the threshold as set by setPositionCallbackThreshold().

The following constants are available for this function:

For option:

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

void BrickletRotaryPoti.setAnalogValueCallbackThreshold(char option, int min, int max)¶

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

Sets the thresholds for the AnalogValueReachedCallback callback.

The following options are possible:

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

The following constants are available for this function:

For option:

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

BrickletRotaryPoti.AnalogValueCallbackThreshold BrickletRotaryPoti.getAnalogValueCallbackThreshold()¶

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

Returns the threshold as set by setAnalogValueCallbackThreshold().

The following constants are available for this function:

For option:

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

void BrickletRotaryPoti.setDebouncePeriod(long debounce)¶

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

Sets the period with which the threshold callbacks

• PositionReachedCallback,
• AnalogValueReachedCallback

are triggered, if the thresholds

• setPositionCallbackThreshold(),
• setAnalogValueCallbackThreshold()

keep being reached.

long BrickletRotaryPoti.getDebouncePeriod()¶

Returns:	debounce – Type: long, Unit: 1 ms, Range: [0 to 232 - 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.

callback BrickletRotaryPoti.PositionCallback¶

Event Object:	position – Type: short, Unit: 1 °, Range: [-150 to 150]

This callback is triggered periodically with the period that is set by setPositionCallbackPeriod(). The parameter is the position of the rotary potentiometer.

The PositionCallback callback is only triggered if the position 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 addPositionCallback() function. An added callback function can be removed with the removePositionCallback() function.

callback BrickletRotaryPoti.AnalogValueCallback¶

Event Object:	value – Type: int, Range: [0 to 212]

This callback is triggered periodically with the period that is set by setAnalogValueCallbackPeriod(). The parameter is the analog value of the rotary potentiometer.

The AnalogValueCallback callback is only triggered if the position 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 addAnalogValueCallback() function. An added callback function can be removed with the removeAnalogValueCallback() function.

callback BrickletRotaryPoti.PositionReachedCallback¶

Event Object:	position – Type: short, Unit: 1 °, Range: [-150 to 150]

This callback is triggered when the threshold as set by setPositionCallbackThreshold() is reached. The parameter is the position of the rotary potentiometer.

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 addPositionReachedCallback() function. An added callback function can be removed with the removePositionReachedCallback() function.

callback BrickletRotaryPoti.AnalogValueReachedCallback¶

Event Object:	value – Type: int, Range: [0 to 212]

This callback is triggered when the threshold as set by setAnalogValueCallbackThreshold() is reached. The parameter is the analog value of the rotary potentiometer.

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 addAnalogValueReachedCallback() function. An added callback function can be removed with the removeAnalogValueReachedCallback() 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[] BrickletRotaryPoti.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 BrickletRotaryPoti.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:

• BrickletRotaryPoti.FUNCTION_SET_POSITION_CALLBACK_PERIOD = 3
• BrickletRotaryPoti.FUNCTION_SET_ANALOG_VALUE_CALLBACK_PERIOD = 5
• BrickletRotaryPoti.FUNCTION_SET_POSITION_CALLBACK_THRESHOLD = 7
• BrickletRotaryPoti.FUNCTION_SET_ANALOG_VALUE_CALLBACK_THRESHOLD = 9
• BrickletRotaryPoti.FUNCTION_SET_DEBOUNCE_PERIOD = 11

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

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:

• BrickletRotaryPoti.FUNCTION_SET_POSITION_CALLBACK_PERIOD = 3
• BrickletRotaryPoti.FUNCTION_SET_ANALOG_VALUE_CALLBACK_PERIOD = 5
• BrickletRotaryPoti.FUNCTION_SET_POSITION_CALLBACK_THRESHOLD = 7
• BrickletRotaryPoti.FUNCTION_SET_ANALOG_VALUE_CALLBACK_THRESHOLD = 9
• BrickletRotaryPoti.FUNCTION_SET_DEBOUNCE_PERIOD = 11

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

This constant is used to identify a Rotary Poti 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 BrickletRotaryPoti.DEVICE_DISPLAY_NAME¶

This constant represents the human readable name of a Rotary Poti Bricklet.