MATLAB/Octave - Analog Out Bricklet – Tinkerforge

- Getting Started
  - Primer
  - Tutorials
  - FAQ
- Hardware
  - Bricks
  - Bricklets
  - Master Extensions
  - Power Supplies
  - Accessories
  - Timeline
- Software
  - Brick Daemon (brickd)
  - Brick Viewer (brickv)
  - API Bindings
    - C/C++
    - C/C++ (iOS)
    - C#
    - C# (Windows Phone)
    - Delphi/Lazarus
    - Java
    - Java (Android)
    - JavaScript
    - LabVIEW
    - Mathematica
    - MATLAB/Octave
      - Requirements
      - Installation
      - Testing an Example
      - Known Problems
      - API Reference and Examples
        - IP Connection
        - Bricks
        - Bricklets
          - Ambient Light Bricklet
          - Analog In Bricklet
          - Analog Out Bricklet
            - Examples
              - Simple (MATLAB)
              - Simple (Octave)
            - API
              - Basic Functions
              - Advanced Functions
              - Constants
          - Barometer Bricklet
          - Color Bricklet
          - Current12 Bricklet
          - Current25 Bricklet
          - Distance IR Bricklet
          - Distance US Bricklet
          - Dual Button Bricklet
          - Dual Relay Bricklet
          - GPS Bricklet
          - Hall Effect Bricklet
          - Humidity Bricklet
          - Industrial Digital In 4 Bricklet
          - Industrial Digital Out 4 Bricklet
          - Industrial Dual 0-20mA Bricklet
          - Industrial Quad Relay Bricklet
          - IO-16 Bricklet
          - IO-4 Bricklet
          - Joystick Bricklet
          - LCD 16x2 Bricklet
          - LCD 20x4 Bricklet
          - LED Strip Bricklet
          - Line Bricklet
          - Linear Poti Bricklet
          - Moisture Bricklet
          - Motion Detector Bricklet
          - Multi Touch Bricklet
          - NFC/RFID Bricklet
          - Piezo Buzzer Bricklet
          - Piezo Speaker Bricklet
          - PTC Bricklet
          - Remote Switch Bricklet
          - Rotary Encoder Bricklet
          - Rotary Poti Bricklet
          - Segment Display 4x7 Bricklet
          - Solid State Relay Bricklet
          - Sound Intensity Bricklet
          - Temperature Bricklet
          - Temperature IR Bricklet
          - Tilt Bricklet
          - Voltage Bricklet
          - Voltage/Current Bricklet
    - Perl
    - PHP
    - Python
    - Ruby
    - Shell
    - Visual Basic .NET
  - Firmwares and Plugins
  - Device Identifier
  - Source Code and Bug Tracking
  - Programming Interface
- Starter Kits
  - Weather Station
  - Hardware Hacking
  - Server Room Monitoring
  - Blinkenlights
  - Internet of Things
  - Camera Slider
- Embedded Boards
  - Raspberry Pi
- Specifications
  - Technical Data
  - TCP/IP Protocol
  - Modbus Protocol
  - Wireshark Dissector

# 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 = '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

### 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 = "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

## 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

public class `BrickletAnalogOut`(String uid, IPConnection ipcon)

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

public void `setVoltage`(int voltage)

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

public int `getVoltage`()

  Returns the voltage as set by `setVoltage()`.

public void `setMode`(short mode)

  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:

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

public short `getMode`()

  Returns the mode as set by `setMode()`.

  The following constants are available for this function:

  - 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

public short[] `getAPIVersion`()

  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.

public boolean `getResponseExpected`(short functionId)

  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.

public void `setResponseExpected`(short functionId, boolean responseExpected)

  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:

  - BrickletAnalogOut.FUNCTION_SET_VOLTAGE = 1
  - BrickletAnalogOut.FUNCTION_SET_MODE = 3

public void `setResponseExpectedAll`(boolean responseExpected)

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

public BrickletAnalogOut.Identity `getIdentity`()

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

### Constants

public static final int `BrickletAnalogOut.DEVICE_IDENTIFIER`

  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.

The content of this page is licensed under Creative Commons Attribution 3.0 Unported License.