This is the description of the MATLAB/Octave API bindings for the Analog Out Bricklet. General information and technical specifications for the Analog Out 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 | function matlab_example_simple()
import com.tinkerforge.IPConnection;
import com.tinkerforge.BrickletAnalogOut;
HOST = 'localhost';
PORT = 4223;
UID = 'brY'; % Change to your UID
ipcon = IPConnection(); % Create IP connection
ao = BrickletAnalogOut(UID, ipcon); % Create device object
ipcon.connect(HOST, PORT); % Connect to brickd
% Don't use device before ipcon is connected
% Set output voltage to 3.3V
ao.setVoltage(3300);
input('Press any key to exit...\n', 's');
ipcon.disconnect();
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 | function octave_example_simple()
more off;
HOST = "localhost";
PORT = 4223;
UID = "brY"; % Change to your UID
ipcon = java_new("com.tinkerforge.IPConnection"); % Create IP connection
ao = java_new("com.tinkerforge.BrickletAnalogOut", UID, ipcon); % Create device object
ipcon.connect(HOST, PORT); % Connect to brickd
% Don't use device before ipcon is connected
% Set output voltage to 3.3V
ao.setVoltage(3300);
input("Press any key to exit...\n", "s");
ipcon.disconnect();
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.
Creates an object with the unique device ID uid.
In MATLAB:
import com.tinkerforge.BrickletAnalogOut;
analogOut = BrickletAnalogOut('YOUR_DEVICE_UID', ipcon);
In Octave:
analogOut = java_new("com.tinkerforge.BrickletAnalogOut", "YOUR_DEVICE_UID", ipcon);
This object can then be used after the IP Connection is connected (see examples above).
Sets the voltage in mV. The possible range is 0V to 5V (0-5000). Calling this function will set the mode to 0 (see setMode()).
The default value is 0 (with mode 1).
Returns the voltage as set by setVoltage().
Sets the mode of the analog value. Possible modes:
Setting the mode to 0 will result in an output voltage of 0. You can jump to a higher output voltage directly by calling setVoltage().
The default mode is 1.
The following constants are available for this function:
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.
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.
See setResponseExpected() for the list of function ID constants available for this function.
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 and callbacks it is always disabled.
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:
Changes the response expected flag for all setter and callback configuration functions of this device at once.
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.
This constant is used to identify a Analog Out Bricklet.
The getIdentity() function and the EnumerateCallback callback of the IP Connection have a deviceIdentifier parameter to specify the Brick's or Bricklet's type.