..
 #############################################################
 # 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 - Segment Display 4x7 Bricklet

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

.. _segment_display_4x7_bricklet_labview:

LabVIEW - Segment Display 4x7 Bricklet
======================================

This is the description of the :ref:`LabVIEW API bindings <api_bindings_labview>` for the :ref:`Segment Display 4x7 Bricklet <segment_display_4x7_bricklet>`. General information and technical
specifications for the Segment Display 4x7 Bricklet are summarized in its :ref:`hardware description
<segment_display_4x7_bricklet_description>`.

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

.. _segment_display_4x7_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/segment-display-4x7-bricklet/raw/master/software/examples/labview/Example%20Simple.vi>`__, `Download (Example Simple - Bits.vi) <https://github.com/Tinkerforge/segment-display-4x7-bricklet/raw/master/software/examples/labview/Example%20Simple%20-%20Bits.vi>`__

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

.. _segment_display_4x7_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:: BrickletSegmentDisplay4x7(uid, ipcon) -> segmentDisplay4x7

 :input uid: String
 :input ipcon: .NET Refnum (IPConnection)
 :output segmentDisplay4x7: .NET Refnum (BrickletSegmentDisplay4x7)

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


.. labview:function:: BrickletSegmentDisplay4x7.SetSegments(segments, brightness, colon)

 :input segments: Byte[4]
 :input brightness: Byte
 :input colon: Boolean

 The 7-segment display can be set with bitmaps. Every bit controls one
 segment:
 
 .. image:: /Images/Bricklets/bricklet_segment_display_4x7_bit_order.png
    :scale: 100 %
    :alt: Bit order of one segment
    :align: center
 
 For example to set a "5" you would want to activate segments 0, 2, 3, 5 and 6.
 This is represented by the number 0b01101101 = 0x6d = 109.
 
 The brightness can be set between 0 (dark) and 7 (bright). The colon
 parameter turns the colon of the display on or off.
 
.. labview:function:: BrickletSegmentDisplay4x7.GetSegments() -> segments, brightness, colon


 :output segments: Byte[4]
 :output brightness: Byte
 :output colon: Boolean

 Returns the segment, brightness and color data as set by 
 :labview:func:`SetSegments() <BrickletSegmentDisplay4x7.SetSegments>`.
 


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

.. labview:function:: BrickletSegmentDisplay4x7.StartCounter(valueFrom, valueTo, increment, length)

 :input valueFrom: Int16
 :input valueTo: Int16
 :input increment: Int16
 :input length: Int64

 Starts a counter with the *from* value that counts to the *to*
 value with the each step incremented by *increment*.
 The *length* of the increment is given in ms.
 
 Example: If you set *from* to 0, *to* to 100, *increment* to 1 and
 *length* to 1000, a counter that goes from 0 to 100 with one second
 pause between each increment will be started.
 
 The maximum values for *from*, *to* and *increment* is 9999, 
 the minimum value is -999.
 
 Using a negative increment allows to count backwards.
 
 You can stop the counter at every time by calling :labview:func:`SetSegments() <BrickletSegmentDisplay4x7.SetSegments>`.
 
.. labview:function:: BrickletSegmentDisplay4x7.GetCounterValue() -> value


 :output value: Int32

 Returns the counter value that is currently shown on the display.
 
 If there is no counter running a 0 will be returned.
 
.. labview:function:: BrickletSegmentDisplay4x7.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:: BrickletSegmentDisplay4x7.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() <BrickletSegmentDisplay4x7.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() <BrickletSegmentDisplay4x7.SetResponseExpected>`
 for the list of function ID constants available for this function.
 
.. labview:function:: BrickletSegmentDisplay4x7.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:
 
 * BrickletSegmentDisplay4x7.FUNCTION_SET_SEGMENTS = 1
 * BrickletSegmentDisplay4x7.FUNCTION_START_COUNTER = 3
 
.. labview:function:: BrickletSegmentDisplay4x7.SetResponseExpectedAll(responseExpected)

 :input responseExpected: Boolean

 Changes the response expected flag for all setter and callback configuration
 functions of this device at once.
 
.. labview:function:: BrickletSegmentDisplay4x7.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|
 


.. _segment_display_4x7_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 BrickletSegmentDisplay4x7.CounterFinished(sender)

 :input sender: .NET Refnum (BrickletSegmentDisplay4x7)

 This callback is triggered when the counter (see :labview:func:`StartCounter() <BrickletSegmentDisplay4x7.StartCounter>`) is
 finished.
 


.. _segment_display_4x7_bricklet_labview_constants:

Constants
^^^^^^^^^

.. labview:symbol:: BrickletSegmentDisplay4x7.DEVICE_IDENTIFIER

 This constant is used to identify a Segment Display 4x7 Bricklet.

 The :labview:func:`GetIdentity() <BrickletSegmentDisplay4x7.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.

