..
 #############################################################
 # 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-labview">Software</a> / LabVIEW - Rotary Encoder Bricklet

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

.. _rotary_encoder_bricklet_labview:

LabVIEW - Rotary Encoder Bricklet
=================================

This is the description of the :ref:`LabVIEW API bindings <api_bindings_labview>` for the :ref:`Rotary Encoder Bricklet <rotary_encoder_bricklet>`. General information and technical
specifications for the Rotary Encoder Bricklet are summarized in its :ref:`hardware description
<rotary_encoder_bricklet_description>`.

An :ref:`installation guide <api_bindings_labview_install>` for the LabVIEW API
bindings is part of their general description.

.. _rotary_encoder_bricklet_labview_examples:


Examples
--------

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

Simple
^^^^^^

`Download (Example Simple.vi) <https://github.com/Tinkerforge/rotary-encoder-bricklet/raw/master/software/examples/labview/Example%20Simple.vi>`__

.. image:: /Images/Screenshots/LabVIEW/RotaryEncoder_Bricklet_LabVIEW_Example_Simple.vi.png
 :scale: 100 %
 :alt: LabVIEW Simple Example
 :align: center

Callback
^^^^^^^^

`Download (Example Callback.vi) <https://github.com/Tinkerforge/rotary-encoder-bricklet/raw/master/software/examples/labview/Example%20Callback.vi>`__, `Download (Example Callback - Count Callback.vi) <https://github.com/Tinkerforge/rotary-encoder-bricklet/raw/master/software/examples/labview/Example%20Callback%20-%20Count%20Callback.vi>`__

.. raw:: html

   <div class="horizontal-image-scroll">

.. image:: /Images/Screenshots/LabVIEW/RotaryEncoder_Bricklet_LabVIEW_Example_Callback.vi.png
 :scale: 100 %
 :alt: LabVIEW Callback Example
 :align: center

.. raw:: html

   </div>

Graph
^^^^^

`Download (Example Graph.vi) <https://github.com/Tinkerforge/rotary-encoder-bricklet/raw/master/software/examples/labview/Example%20Graph.vi>`__, `Download (Example Graph - Count Callback.vi) <https://github.com/Tinkerforge/rotary-encoder-bricklet/raw/master/software/examples/labview/Example%20Graph%20-%20Count%20Callback.vi>`__

.. raw:: html

   <div class="horizontal-image-scroll">

.. image:: /Images/Screenshots/LabVIEW/RotaryEncoder_Bricklet_LabVIEW_Example_Graph.vi.png
 :scale: 100 %
 :alt: LabVIEW Graph Example
 :align: center

.. raw:: html

   </div>

.. _rotary_encoder_bricklet_labview_api:

API
---

Generally, every method of the LabVIEW bindings that outputs a value can
report a ``Tinkerforge.TimeoutException``. This error gets reported if the
device did not respond. If a cable based connection is used, it is
unlikely that this exception gets thrown (assuming nobody plugs the
device out). However, if a wireless connection is used, timeouts will occur
if the distance to the device gets too big.

The namespace for all Brick/Bricklet bindings and the IPConnection is
``Tinkerforge.*``.




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


.. labview:function:: BrickletRotaryEncoder(uid, ipcon) -> rotaryEncoder

 :input uid: String
 :input ipcon: .NET Refnum (IPConnection)
 :output rotaryEncoder: .NET Refnum (BrickletRotaryEncoder)

 Creates an object with the unique device ID ``uid``.
 This object can then be used after the IP Connection is connected
 (see examples :ref:`above <rotary_encoder_bricklet_labview_examples>`).


.. labview:function:: BrickletRotaryEncoder.GetCount(reset) -> count

 :input reset: Boolean

 :output count: Int32

 Returns the current count of the encoder. If you set reset
 to true, the count is set back to 0 directly after the
 current count is read.
 
 The encoder has 24 steps per rotation
 
 Turning the encoder to the left decrements the counter,
 so a negative count is possible.
 
.. labview:function:: BrickletRotaryEncoder.IsPressed() -> pressed


 :output pressed: Boolean

 Returns *true* if the button is pressed and *false* otherwise.
 
 It is recommended to use the :labview:func:`Pressed <BrickletRotaryEncoder.Pressed>` and :labview:func:`Released <BrickletRotaryEncoder.Released>` callbacks
 to handle the button.
 


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

.. labview:function:: BrickletRotaryEncoder.GetAPIVersion() -> apiVersion


 :output apiVersion: Byte[3]

 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.
 
.. labview:function:: BrickletRotaryEncoder.GetResponseExpected(functionId) -> responseExpected

 :input functionId: Byte

 :output responseExpected: 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
 :labview:func:`SetResponseExpected() <BrickletRotaryEncoder.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 :labview:func:`SetResponseExpected() <BrickletRotaryEncoder.SetResponseExpected>`
 for the list of function ID constants available for this function.
 
.. labview:function:: BrickletRotaryEncoder.SetResponseExpected(functionId, responseExpected)

 :input functionId: Byte
 :input responseExpected: 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:
 
 * BrickletRotaryEncoder.FUNCTION_SET_COUNT_CALLBACK_PERIOD = 2
 * BrickletRotaryEncoder.FUNCTION_SET_COUNT_CALLBACK_THRESHOLD = 4
 * BrickletRotaryEncoder.FUNCTION_SET_DEBOUNCE_PERIOD = 6
 
.. labview:function:: BrickletRotaryEncoder.SetResponseExpectedAll(responseExpected)

 :input responseExpected: Boolean

 Changes the response expected flag for all setter and callback configuration
 functions of this device at once.
 
.. labview:function:: BrickletRotaryEncoder.GetIdentity() -> uid, connectedUid, position, hardwareVersion, firmwareVersion, deviceIdentifier


 :output uid: String
 :output connectedUid: String
 :output position: Char
 :output hardwareVersion: Byte[3]
 :output firmwareVersion: Byte[3]
 :output deviceIdentifier: Int32

 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|
 


Callback Configuration Functions
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^



.. labview:function:: BrickletRotaryEncoder.SetCountCallbackPeriod(period)

 :input period: Int64

 Sets the period in ms with which the :labview:func:`Count <BrickletRotaryEncoder.Count>` callback is triggered
 periodically. A value of 0 turns the callback off.
 
 :labview:func:`Count <BrickletRotaryEncoder.Count>` is only triggered if the count has changed since the
 last triggering.
 
 The default value is 0.
 
.. labview:function:: BrickletRotaryEncoder.GetCountCallbackPeriod() -> period


 :output period: Int64

 Returns the period as set by :labview:func:`SetCountCallbackPeriod() <BrickletRotaryEncoder.SetCountCallbackPeriod>`.
 
.. labview:function:: BrickletRotaryEncoder.SetCountCallbackThreshold(option, min, max)

 :input option: Char
 :input min: Int32
 :input max: Int32

 Sets the thresholds for the :labview:func:`CountReached <BrickletRotaryEncoder.CountReached>` callback. 
 
 The following options are possible:
 
 .. csv-table::
  :header: "Option", "Description"
  :widths: 10, 100
 
  "'x'",    "Callback is turned off"
  "'o'",    "Callback is triggered when the count is *outside* the min and max values"
  "'i'",    "Callback is triggered when the count is *inside* the min and max values"
  "'<'",    "Callback is triggered when the count is smaller than the min value (max is ignored)"
  "'>'",    "Callback is triggered when the count is greater than the min value (max is ignored)"
 
 The default value is ('x', 0, 0).
 
 The following constants are available for this function:
 
 * BrickletRotaryEncoder.THRESHOLD_OPTION_OFF = 'x'
 * BrickletRotaryEncoder.THRESHOLD_OPTION_OUTSIDE = 'o'
 * BrickletRotaryEncoder.THRESHOLD_OPTION_INSIDE = 'i'
 * BrickletRotaryEncoder.THRESHOLD_OPTION_SMALLER = '<'
 * BrickletRotaryEncoder.THRESHOLD_OPTION_GREATER = '>'
 
.. labview:function:: BrickletRotaryEncoder.GetCountCallbackThreshold() -> option, min, max


 :output option: Char
 :output min: Int32
 :output max: Int32

 Returns the threshold as set by :labview:func:`SetCountCallbackThreshold() <BrickletRotaryEncoder.SetCountCallbackThreshold>`.
 
 The following constants are available for this function:
 
 * BrickletRotaryEncoder.THRESHOLD_OPTION_OFF = 'x'
 * BrickletRotaryEncoder.THRESHOLD_OPTION_OUTSIDE = 'o'
 * BrickletRotaryEncoder.THRESHOLD_OPTION_INSIDE = 'i'
 * BrickletRotaryEncoder.THRESHOLD_OPTION_SMALLER = '<'
 * BrickletRotaryEncoder.THRESHOLD_OPTION_GREATER = '>'
 
.. labview:function:: BrickletRotaryEncoder.SetDebouncePeriod(debounce)

 :input debounce: Int64

 Sets the period in ms with which the threshold callback
 
 * :labview:func:`CountReached <BrickletRotaryEncoder.CountReached>`
 
 is triggered, if the thresholds
 
 * :labview:func:`SetCountCallbackThreshold() <BrickletRotaryEncoder.SetCountCallbackThreshold>`
 
 keeps being reached.
 
 The default value is 100.
 
.. labview:function:: BrickletRotaryEncoder.GetDebouncePeriod() -> debounce


 :output debounce: Int64

 Returns the debounce period as set by :labview:func:`SetDebouncePeriod() <BrickletRotaryEncoder.SetDebouncePeriod>`.
 


.. _rotary_encoder_bricklet_labview_callbacks:

Callbacks
^^^^^^^^^

Callbacks can be registered to receive time critical or recurring data from
the device. The registration is done by assigning a function to a callback
property of the device object. The available callback property and their type
of parameters are described below.

.. note::
 Using callbacks for recurring events is *always* preferred
 compared to using getters. It will use less USB bandwidth and the latency
 will be a lot better, since there is no round trip time.


.. labview:function:: event BrickletRotaryEncoder.Count(sender, count)

 :input sender: .NET Refnum (BrickletRotaryEncoder)
 :input count: Int32

 This callback is triggered periodically with the period that is set by
 :labview:func:`SetCountCallbackPeriod() <BrickletRotaryEncoder.SetCountCallbackPeriod>`. The parameter is the count of
 the encoder.
 
 :labview:func:`Count <BrickletRotaryEncoder.Count>` is only triggered if the count has changed since the
 last triggering.
 

.. labview:function:: event BrickletRotaryEncoder.CountReached(sender, count)

 :input sender: .NET Refnum (BrickletRotaryEncoder)
 :input count: Int32

 This callback is triggered when the threshold as set by
 :labview:func:`SetCountCallbackThreshold() <BrickletRotaryEncoder.SetCountCallbackThreshold>` is reached.
 The parameter is the count of the encoder.
 
 If the threshold keeps being reached, the callback is triggered periodically
 with the period as set by :labview:func:`SetDebouncePeriod() <BrickletRotaryEncoder.SetDebouncePeriod>`.
 

.. labview:function:: event BrickletRotaryEncoder.Pressed(sender)

 :input sender: .NET Refnum (BrickletRotaryEncoder)

 This callback is triggered when the button is pressed.
 

.. labview:function:: event BrickletRotaryEncoder.Released(sender)

 :input sender: .NET Refnum (BrickletRotaryEncoder)

 This callback is triggered when the button is released.
 


.. _rotary_encoder_bricklet_labview_constants:

Constants
^^^^^^^^^

.. labview:symbol:: BrickletRotaryEncoder.DEVICE_IDENTIFIER

 This constant is used to identify a Rotary Encoder Bricklet.

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

