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

:orphan:
:breadcrumbs: <a href="../../index.html">Home</a> / <a href="../../index.html#software-vbnet">Software</a> / Visual Basic .NET - Analog Out Bricklet 2.0

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

.. _analog_out_v2_bricklet_vbnet:

Visual Basic .NET - Analog Out Bricklet 2.0
===========================================

.. note::
 This Bricklet is currently in the prototype stage and the software/hardware
 as well as the documentation is in an incomplete state.


This is the description of the :ref:`Visual Basic .NET API bindings <api_bindings_vbnet>` for the :ref:`Analog Out Bricklet 2.0 <analog_out_v2_bricklet>`. General information and technical
specifications for the Analog Out Bricklet 2.0 are summarized in its :ref:`hardware description
<analog_out_v2_bricklet_description>`.

An :ref:`installation guide <api_bindings_vbnet_install>` for the Visual Basic .NET API
bindings is part of their general description.

.. _analog_out_v2_bricklet_vbnet_examples:


Examples
--------

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

Simple
^^^^^^

`Download (ExampleSimple.vb) <https://github.com/Tinkerforge/analog-out-v2-bricklet/raw/master/software/examples/vbnet/ExampleSimple.vb>`__

.. literalinclude:: AnalogOutV2_Bricklet_VBNET_ExampleSimple.vb
 :language: vbnet
 :linenos:
 :tab-width: 4

.. _analog_out_v2_bricklet_vbnet_api:

API
---

Since Visual Basic .NET does not support multiple return values directly, we
use the ``ByRef`` keyword to return multiple values from a function.

All functions and procedures listed below are thread-safe.




Basic Functions
^^^^^^^^^^^^^^^


.. vbnet:function:: Class BrickletAnalogOutV2(ByVal uid As String, ByVal ipcon As IPConnection)

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

 .. code-block:: vbnet

    Dim analogOutV2 As New BrickletAnalogOutV2("YOUR_DEVICE_UID", ipcon)

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


.. vbnet:function:: Sub BrickletAnalogOutV2.SetOutputVoltage(ByVal voltage As Integer)

 Sets the voltage in mV. The possible range is 0V to 12V (0-12000).
 
.. vbnet:function:: Function BrickletAnalogOutV2.GetOutputVoltage() As Integer

 Returns the voltage as set by :vbnet:func:`SetOutputVoltage() <BrickletAnalogOutV2.SetOutputVoltage>`.
 


Advanced Functions
^^^^^^^^^^^^^^^^^^

.. vbnet:function:: Function BrickletAnalogOutV2.GetInputVoltage() As Integer

 Returns the input voltage in mV.
 
.. vbnet:function:: Function BrickletAnalogOutV2.GetAPIVersion() As Byte[]

 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.
 
.. vbnet:function:: Function BrickletAnalogOutV2.GetResponseExpected(ByVal functionId As Byte) As 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
 :vbnet:func:`SetResponseExpected() <BrickletAnalogOutV2.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 :vbnet:func:`SetResponseExpected() <BrickletAnalogOutV2.SetResponseExpected>`
 for the list of function ID constants available for this function.
 
.. vbnet:function:: Sub BrickletAnalogOutV2.SetResponseExpected(ByVal functionId As Byte, ByVal responseExpected As 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 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:
 
 * BrickletAnalogOutV2.FUNCTION_SET_OUTPUT_VOLTAGE = 1
 
.. vbnet:function:: Sub BrickletAnalogOutV2.SetResponseExpectedAll(ByVal responseExpected As Boolean)

 Changes the response expected flag for all setter and callback configuration
 functions of this device at once.
 
.. vbnet:function:: Sub BrickletAnalogOutV2.GetIdentity(ByRef uid As String, ByRef connectedUid As String, ByRef position As Char, ByRef hardwareVersion[] As Byte, ByRef firmwareVersion[] As Byte, ByRef deviceIdentifier As Integer)

 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|
 


.. _analog_out_v2_bricklet_vbnet_constants:

Constants
^^^^^^^^^

.. vbnet:attribute:: Const BrickletAnalogOutV2.DEVICE_IDENTIFIER

 This constant is used to identify a Analog Out Bricklet 2.0.

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

