..
 #############################################################
 # This file was automatically generated on 2015-05-08.      #
 #                                                           #
 # If you have a bugfix for this file and want to commit it, #
 # please fix the bug in the generator. You can find a link  #
 # to the generators git repository on tinkerforge.com       #
 #############################################################


:breadcrumbs: <a href="../../index.html">Home</a> / <a href="../../index.html#software-matlab">Software</a> / MATLAB/Octave - Analog Out Bricklet

.. |device_identifier_constant| replace:: There is also a :ref:`constant <analog_out_bricklet_matlab_constants>` for the device identifier of this Bricklet.

.. _analog_out_bricklet_matlab:

MATLAB/Octave - Analog Out Bricklet
===================================

This is the description of the :ref:`MATLAB/Octave API bindings <api_bindings_matlab>` for the :ref:`Analog Out Bricklet <analog_out_bricklet>`. General information and technical
specifications for the Analog Out Bricklet are summarized in its :ref:`hardware description
<analog_out_bricklet_description>`.

An :ref:`installation guide <api_bindings_matlab_install>` for the MATLAB/Octave API
bindings is part of their general description.

.. _analog_out_bricklet_matlab_examples:


Examples
--------

The example code below is `Public Domain (CC0 1.0)
<http://creativecommons.org/publicdomain/zero/1.0/>`__.

Simple (MATLAB)
^^^^^^^^^^^^^^^

`Download (matlab_example_simple.m) <https://github.com/Tinkerforge/analog-out-bricklet/raw/master/software/examples/matlab/matlab_example_simple.m>`__

.. literalinclude:: AnalogOut_Bricklet_MATLAB_matlab_example_simple.m
 :language: matlab
 :linenos:
 :tab-width: 4

Simple (Octave)
^^^^^^^^^^^^^^^

`Download (octave_example_simple.m) <https://github.com/Tinkerforge/analog-out-bricklet/raw/master/software/examples/matlab/octave_example_simple.m>`__

.. literalinclude:: AnalogOut_Bricklet_MATLAB_octave_example_simple.m
 :language: octave_fixed
 :linenos:
 :tab-width: 4

.. _analog_out_bricklet_matlab_api:

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


.. matlab:function:: class BrickletAnalogOut(String uid, IPConnection ipcon)

 Creates an object with the unique device ID ``uid``.

 In MATLAB:

 .. code-block:: matlab

  import com.tinkerforge.BrickletAnalogOut;

  analogOut = BrickletAnalogOut('YOUR_DEVICE_UID', ipcon);

 In Octave:

 .. code-block:: octave_fixed

  analogOut = java_new("com.tinkerforge.BrickletAnalogOut", "YOUR_DEVICE_UID", ipcon);

 This object can then be used after the IP Connection is connected
 (see examples :ref:`above <analog_out_bricklet_matlab_examples>`).


.. matlab:function:: public void BrickletAnalogOut::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 :matlab:func:`setMode() <BrickletAnalogOut::setMode>`).
 
 The default value is 0 (with mode 1).
 
.. matlab:function:: public int BrickletAnalogOut::getVoltage()

 Returns the voltage as set by :matlab:func:`setVoltage() <BrickletAnalogOut::setVoltage>`.
 
.. matlab:function:: public void BrickletAnalogOut::setMode(short mode)

 Sets the mode of the analog value. Possible modes:
 
 * 0: Normal Mode (Analog value as set by :matlab:func:`setVoltage() <BrickletAnalogOut::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 :matlab:func:`setVoltage() <BrickletAnalogOut::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
 
.. matlab:function:: public short BrickletAnalogOut::getMode()

 Returns the mode as set by :matlab:func:`setMode() <BrickletAnalogOut::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
^^^^^^^^^^^^^^^^^^

.. matlab:function:: public short[] BrickletAnalogOut::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.
 
.. matlab:function:: public boolean BrickletAnalogOut::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
 :matlab:func:`setResponseExpected() <BrickletAnalogOut::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 :matlab:func:`setResponseExpected() <BrickletAnalogOut::setResponseExpected>`
 for the list of function ID constants available for this function.
 
.. matlab:function:: public void BrickletAnalogOut::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
 
.. matlab:function:: public void BrickletAnalogOut::setResponseExpectedAll(boolean responseExpected)

 Changes the response expected flag for all setter and callback configuration
 functions of this device at once.
 
.. matlab:function:: public BrickletAnalogOut.Identity BrickletAnalogOut::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 :ref:`here <device_identifier>`.
 |device_identifier_constant|
 
 The returned object has the public member variables ``String uid``, ``String connectedUid``, ``char position``, ``short[] hardwareVersion``, ``short[] firmwareVersion`` and ``int deviceIdentifier``.



.. _analog_out_bricklet_matlab_constants:

Constants
^^^^^^^^^

.. matlab:member:: public static final int BrickletAnalogOut.DEVICE_IDENTIFIER

 This constant is used to identify a Analog Out Bricklet.

 The :matlab:func:`getIdentity() <BrickletAnalogOut::getIdentity>` function and the
 :matlab:member:`EnumerateCallback <IPConnection.EnumerateCallback>`
 callback of the IP Connection have a ``deviceIdentifier`` parameter to specify
 the Brick's or Bricklet's type.

