This is the description of the MATLAB/Octave API bindings for the Accelerometer Bricklet. General information and technical specifications for the Accelerometer Bricklet are summarized in its hardware description.
An installation guide for the MATLAB/Octave API bindings is part of their general description.
The example code below is Public Domain (CC0 1.0).
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 22 23 24 | function matlab_example_simple()
import com.tinkerforge.IPConnection;
import com.tinkerforge.BrickletAccelerometer;
HOST = 'localhost';
PORT = 4223;
UID = 'XYZ'; % Change XYZ to the UID of your Accelerometer Bricklet
ipcon = IPConnection(); % Create IP connection
a = handle(BrickletAccelerometer(UID, ipcon), 'CallbackProperties'); % Create device object
ipcon.connect(HOST, PORT); % Connect to brickd
% Don't use device before ipcon is connected
% Get current acceleration
acceleration = a.getAcceleration();
fprintf('Acceleration [X]: %g g\n', acceleration.x/1000.0);
fprintf('Acceleration [Y]: %g g\n', acceleration.y/1000.0);
fprintf('Acceleration [Z]: %g g\n', acceleration.z/1000.0);
input('Press key to exit\n', 's');
ipcon.disconnect();
end
|
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 31 32 33 | function matlab_example_callback()
import com.tinkerforge.IPConnection;
import com.tinkerforge.BrickletAccelerometer;
HOST = 'localhost';
PORT = 4223;
UID = 'XYZ'; % Change XYZ to the UID of your Accelerometer Bricklet
ipcon = IPConnection(); % Create IP connection
a = handle(BrickletAccelerometer(UID, ipcon), 'CallbackProperties'); % Create device object
ipcon.connect(HOST, PORT); % Connect to brickd
% Don't use device before ipcon is connected
% Register acceleration callback to function cb_acceleration
set(a, 'AccelerationCallback', @(h, e) cb_acceleration(e));
% Set period for acceleration callback to 1s (1000ms)
% Note: The acceleration callback is only called every second
% if the acceleration has changed since the last call!
a.setAccelerationCallbackPeriod(1000);
input('Press key to exit\n', 's');
ipcon.disconnect();
end
% Callback function for acceleration callback
function cb_acceleration(e)
fprintf('Acceleration [X]: %g g\n', e.x/1000.0);
fprintf('Acceleration [Y]: %g g\n', e.y/1000.0);
fprintf('Acceleration [Z]: %g g\n', e.z/1000.0);
fprintf('\n');
end
|
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 32 33 34 | function matlab_example_threshold()
import com.tinkerforge.IPConnection;
import com.tinkerforge.BrickletAccelerometer;
HOST = 'localhost';
PORT = 4223;
UID = 'XYZ'; % Change XYZ to the UID of your Accelerometer Bricklet
ipcon = IPConnection(); % Create IP connection
a = handle(BrickletAccelerometer(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)
a.setDebouncePeriod(10000);
% Register acceleration reached callback to function cb_acceleration_reached
set(a, 'AccelerationReachedCallback', @(h, e) cb_acceleration_reached(e));
% Configure threshold for acceleration "greater than 2 g, 2 g, 2 g"
a.setAccelerationCallbackThreshold('>', 2*1000, 0, 2*1000, 0, 2*1000, 0);
input('Press key to exit\n', 's');
ipcon.disconnect();
end
% Callback function for acceleration reached callback
function cb_acceleration_reached(e)
fprintf('Acceleration [X]: %g g\n', e.x/1000.0);
fprintf('Acceleration [Y]: %g g\n', e.y/1000.0);
fprintf('Acceleration [Z]: %g g\n', e.z/1000.0);
fprintf('\n');
end
|
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 29 30 31 | function octave_example_simple()
more off;
HOST = "localhost";
PORT = 4223;
UID = "XYZ"; % Change XYZ to the UID of your Accelerometer Bricklet
ipcon = javaObject("com.tinkerforge.IPConnection"); % Create IP connection
a = javaObject("com.tinkerforge.BrickletAccelerometer", UID, ipcon); % Create device object
ipcon.connect(HOST, PORT); % Connect to brickd
% Don't use device before ipcon is connected
% Get current acceleration
acceleration = a.getAcceleration();
fprintf("Acceleration [X]: %g g\n", java2int(acceleration.x)/1000.0);
fprintf("Acceleration [Y]: %g g\n", java2int(acceleration.y)/1000.0);
fprintf("Acceleration [Z]: %g g\n", java2int(acceleration.z)/1000.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
|
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 38 39 40 | function octave_example_callback()
more off;
HOST = "localhost";
PORT = 4223;
UID = "XYZ"; % Change XYZ to the UID of your Accelerometer Bricklet
ipcon = javaObject("com.tinkerforge.IPConnection"); % Create IP connection
a = javaObject("com.tinkerforge.BrickletAccelerometer", UID, ipcon); % Create device object
ipcon.connect(HOST, PORT); % Connect to brickd
% Don't use device before ipcon is connected
% Register acceleration callback to function cb_acceleration
a.addAccelerationCallback(@cb_acceleration);
% Set period for acceleration callback to 1s (1000ms)
% Note: The acceleration callback is only called every second
% if the acceleration has changed since the last call!
a.setAccelerationCallbackPeriod(1000);
input("Press key to exit\n", "s");
ipcon.disconnect();
end
% Callback function for acceleration callback
function cb_acceleration(e)
fprintf("Acceleration [X]: %g g\n", java2int(e.x)/1000.0);
fprintf("Acceleration [Y]: %g g\n", java2int(e.y)/1000.0);
fprintf("Acceleration [Z]: %g g\n", java2int(e.z)/1000.0);
fprintf("\n");
end
function int = java2int(value)
if compare_versions(version(), "3.8", "<=")
int = value.intValue();
else
int = value;
end
end
|
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 31 32 33 34 35 36 37 38 39 40 41 | function octave_example_threshold()
more off;
HOST = "localhost";
PORT = 4223;
UID = "XYZ"; % Change XYZ to the UID of your Accelerometer Bricklet
ipcon = javaObject("com.tinkerforge.IPConnection"); % Create IP connection
a = javaObject("com.tinkerforge.BrickletAccelerometer", 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)
a.setDebouncePeriod(10000);
% Register acceleration reached callback to function cb_acceleration_reached
a.addAccelerationReachedCallback(@cb_acceleration_reached);
% Configure threshold for acceleration "greater than 2 g, 2 g, 2 g"
a.setAccelerationCallbackThreshold(">", 2*1000, 0, 2*1000, 0, 2*1000, 0);
input("Press key to exit\n", "s");
ipcon.disconnect();
end
% Callback function for acceleration reached callback
function cb_acceleration_reached(e)
fprintf("Acceleration [X]: %g g\n", java2int(e.x)/1000.0);
fprintf("Acceleration [Y]: %g g\n", java2int(e.y)/1000.0);
fprintf("Acceleration [Z]: %g g\n", java2int(e.z)/1000.0);
fprintf("\n");
end
function int = java2int(value)
if compare_versions(version(), "3.8", "<=")
int = value.intValue();
else
int = value;
end
end
|
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.
BrickletAccelerometer
(String uid, IPConnection ipcon)¶Parameters: |
|
---|---|
Returns: |
|
Creates an object with the unique device ID uid
.
In MATLAB:
import com.tinkerforge.BrickletAccelerometer;
accelerometer = BrickletAccelerometer('YOUR_DEVICE_UID', ipcon);
In Octave:
accelerometer = java_new("com.tinkerforge.BrickletAccelerometer", "YOUR_DEVICE_UID", ipcon);
This object can then be used after the IP Connection is connected.
BrickletAccelerometer.
getAcceleration
()¶Return Object: |
|
---|
Returns the acceleration in x, y and z direction. The values
are given in gₙ/1000 (1gₙ = 9.80665m/s²). The range is
configured with setConfiguration()
.
If you want to get the acceleration periodically, it is recommended
to use the AccelerationCallback
callback and set the period with
setAccelerationCallbackPeriod()
.
BrickletAccelerometer.
getTemperature
()¶Returns: |
|
---|
Returns the temperature of the accelerometer.
BrickletAccelerometer.
ledOn
()¶Enables the LED on the Bricklet.
BrickletAccelerometer.
ledOff
()¶Disables the LED on the Bricklet.
BrickletAccelerometer.
isLEDOn
()¶Returns: |
|
---|
Returns true if the LED is enabled, false otherwise.
BrickletAccelerometer.
setConfiguration
(short dataRate, short fullScale, short filterBandwidth)¶Parameters: |
|
---|
Configures the data rate, full scale range and filter bandwidth. Possible values are:
Decreasing data rate or full scale range will also decrease the noise on the data.
The following constants are available for this function:
For dataRate:
For fullScale:
For filterBandwidth:
BrickletAccelerometer.
getConfiguration
()¶Return Object: |
|
---|
Returns the configuration as set by setConfiguration()
.
The following constants are available for this function:
For dataRate:
For fullScale:
For filterBandwidth:
BrickletAccelerometer.
getIdentity
()¶Return Object: |
|
---|
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.
BrickletAccelerometer.
setAccelerationCallbackPeriod
(long period)¶Parameters: |
|
---|
Sets the period with which the AccelerationCallback
callback is triggered
periodically. A value of 0 turns the callback off.
The AccelerationCallback
callback is only triggered if the acceleration has
changed since the last triggering.
BrickletAccelerometer.
getAccelerationCallbackPeriod
()¶Returns: |
|
---|
Returns the period as set by setAccelerationCallbackPeriod()
.
BrickletAccelerometer.
setAccelerationCallbackThreshold
(char option, short minX, short maxX, short minY, short maxY, short minZ, short maxZ)¶Parameters: |
|
---|
Sets the thresholds for the AccelerationReachedCallback
callback.
The following options are possible:
Option | Description |
---|---|
'x' | Callback is turned off |
'o' | Callback is triggered when the acceleration is outside the min and max values |
'i' | Callback is triggered when the acceleration is inside the min and max values |
'<' | Callback is triggered when the acceleration is smaller than the min value (max is ignored) |
'>' | Callback is triggered when the acceleration is greater than the min value (max is ignored) |
The following constants are available for this function:
For option:
BrickletAccelerometer.
getAccelerationCallbackThreshold
()¶Return Object: |
|
---|
Returns the threshold as set by setAccelerationCallbackThreshold()
.
The following constants are available for this function:
For option:
BrickletAccelerometer.
setDebouncePeriod
(long debounce)¶Parameters: |
|
---|
Sets the period with which the threshold callback
is triggered, if the threshold
keeps being reached.
BrickletAccelerometer.
getDebouncePeriod
()¶Returns: |
|
---|
Returns the debounce period as set by setDebouncePeriod()
.
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.
BrickletAccelerometer.
AccelerationCallback
¶Event Object: |
|
---|
This callback is triggered periodically with the period that is set by
setAccelerationCallbackPeriod()
. The parameters are the
X, Y and Z acceleration. The range is
configured with setConfiguration()
.
The AccelerationCallback
callback is only triggered if the acceleration 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
addAccelerationCallback()
function. An added callback function can be removed with
the removeAccelerationCallback()
function.
BrickletAccelerometer.
AccelerationReachedCallback
¶Event Object: |
|
---|
This callback is triggered when the threshold as set by
setAccelerationCallbackThreshold()
is reached.
The parameters are the X, Y and Z acceleration. The range is
configured with setConfiguration()
.
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
addAccelerationReachedCallback()
function. An added callback function can be removed with
the removeAccelerationReachedCallback()
function.
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.
BrickletAccelerometer.
getAPIVersion
()¶Return Object: |
|
---|
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.
BrickletAccelerometer.
getResponseExpected
(byte functionId)¶Parameters: |
|
---|---|
Returns: |
|
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:
BrickletAccelerometer.
setResponseExpected
(byte functionId, boolean responseExpected)¶Parameters: |
|
---|
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:
BrickletAccelerometer.
setResponseExpectedAll
(boolean responseExpected)¶Parameters: |
|
---|
Changes the response expected flag for all setter and callback configuration functions of this device at once.
BrickletAccelerometer.
DEVICE_IDENTIFIER
¶This constant is used to identify a Accelerometer 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.
BrickletAccelerometer.
DEVICE_DISPLAY_NAME
¶This constant represents the human readable name of a Accelerometer Bricklet.