MATLAB/Octave - Analog Out Bricklet

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.

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

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

    ipcon = IPConnection(); % Create IP connection
    ao = handle(BrickletAnalogOut(UID, ipcon), 'CallbackProperties'); % 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 key to exit\n', 's');
    ipcon.disconnect();
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
function octave_example_simple()
    more off;

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

    ipcon = javaObject("com.tinkerforge.IPConnection"); % Create IP connection
    ao = javaObject("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 key to exit\n", "s");
    ipcon.disconnect();
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 BrickletAnalogOut(String uid, IPConnection ipcon)
Parameters:
  • uid – Type: String
  • ipcon – Type: IPConnection
Returns:
  • analogOut – Type: BrickletAnalogOut

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).

void BrickletAnalogOut.setVoltage(int voltage)
Parameters:
  • voltage – Type: int, Range: [0 to 216 - 1]

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).

int BrickletAnalogOut.getVoltage()
Returns:
  • voltage – Type: int, Range: [0 to 216 - 1]

Returns the voltage as set by setVoltage().

void BrickletAnalogOut.setMode(short mode)
Parameters:
  • mode – Type: short, Range: See constants

Sets the mode of the analog value. Possible modes:

  • 0: Normal Mode (Analog value as set by setVoltage() is applied)
  • 1: 1k Ohm resistor to ground
  • 2: 100k Ohm resistor to ground
  • 3: 500k Ohm resistor to ground

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:

For mode:

  • BrickletAnalogOut.MODE_ANALOG_VALUE = 0
  • BrickletAnalogOut.MODE_1K_TO_GROUND = 1
  • BrickletAnalogOut.MODE_100K_TO_GROUND = 2
  • BrickletAnalogOut.MODE_500K_TO_GROUND = 3
short BrickletAnalogOut.getMode()
Returns:
  • mode – Type: short, Range: See constants

Returns the mode as set by setMode().

The following constants are available for this function:

For mode:

  • BrickletAnalogOut.MODE_ANALOG_VALUE = 0
  • BrickletAnalogOut.MODE_1K_TO_GROUND = 1
  • BrickletAnalogOut.MODE_100K_TO_GROUND = 2
  • BrickletAnalogOut.MODE_500K_TO_GROUND = 3

Advanced Functions

short[] BrickletAnalogOut.getAPIVersion()
Returns:
  • apiVersion – Type: short[], Length: 3, Range: [0 to 255]

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.

boolean BrickletAnalogOut.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:

  • BrickletAnalogOut.FUNCTION_SET_VOLTAGE = 1
  • BrickletAnalogOut.FUNCTION_SET_MODE = 3
void BrickletAnalogOut.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:

  • BrickletAnalogOut.FUNCTION_SET_VOLTAGE = 1
  • BrickletAnalogOut.FUNCTION_SET_MODE = 3
void BrickletAnalogOut.setResponseExpectedAll(boolean responseExpected)
Parameters:
  • responseExpected – Type: boolean

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

BrickletAnalogOut.Identity BrickletAnalogOut.getIdentity()
Return Object:
  • uid – Type: String, Length: up to 8
  • connectedUid – Type: String, Length: up to 8
  • position – Type: char
  • hardwareVersion – Type: short[], Length: 3, Range: [0 to 255]
  • firmwareVersion – Type: short[], Length: 3, 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' or 'd'.

The device identifier numbers can be found here. There is also a constant for the device identifier of this Bricklet.

Constants

int BrickletAnalogOut.DEVICE_IDENTIFIER

This constant is used to identify a Analog Out 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 BrickletAnalogOut.DEVICE_DISPLAY_NAME

This constant represents the human readable name of a Analog Out Bricklet.