..
 #############################################################
 # 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 - LCD 16x2 Bricklet

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

.. _lcd_16x2_bricklet_labview:

LabVIEW - LCD 16x2 Bricklet
===========================

This is the description of the :ref:`LabVIEW API bindings <api_bindings_labview>` for the :ref:`LCD 16x2 Bricklet <lcd_16x2_bricklet>`. General information and technical
specifications for the LCD 16x2 Bricklet are summarized in its :ref:`hardware description
<lcd_16x2_bricklet_description>`.

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

.. _lcd_16x2_bricklet_labview_examples:


Examples
--------

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

Hello World
^^^^^^^^^^^

`Download (Example Hello World.vi) <https://github.com/Tinkerforge/lcd-16x2-bricklet/raw/master/software/examples/labview/Example%20Hello%20World.vi>`__

.. image:: /Images/Screenshots/LabVIEW/LCD16x2_Bricklet_LabVIEW_Example_Hello_World.vi.png
 :scale: 100 %
 :alt: LabVIEW Hello World Example
 :align: center

Button Callback
^^^^^^^^^^^^^^^

`Download (Example Button Callback.vi) <https://github.com/Tinkerforge/lcd-16x2-bricklet/raw/master/software/examples/labview/Example%20Button%20Callback.vi>`__, `Download (Example Button Callback - ButtonReleased Callback.vi) <https://github.com/Tinkerforge/lcd-16x2-bricklet/raw/master/software/examples/labview/Example%20Button%20Callback%20-%20ButtonReleased%20Callback.vi>`__, `Download (Example Button Callback - ButtonPressed Callback.vi) <https://github.com/Tinkerforge/lcd-16x2-bricklet/raw/master/software/examples/labview/Example%20Button%20Callback%20-%20ButtonPressed%20Callback.vi>`__

.. raw:: html

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

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

.. raw:: html

   </div>

.. _lcd_16x2_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:: BrickletLCD16x2(uid, ipcon) -> lcd16x2

 :input uid: String
 :input ipcon: .NET Refnum (IPConnection)
 :output lcd16x2: .NET Refnum (BrickletLCD16x2)

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


.. labview:function:: BrickletLCD16x2.WriteLine(line, position, text)

 :input line: Byte
 :input position: Byte
 :input text: String

 Writes text to a specific line (0 to 1) with a specific position 
 (0 to 15). The text can have a maximum of 16 characters.
 
 For example: (0, 5, "Hello") will write *Hello* in the middle of the
 first line of the display.
 
 The display uses a special charset that includes all ASCII characters except
 backslash and tilde. The LCD charset also includes several other non-ASCII characters, see
 the `charset specification <https://github.com/Tinkerforge/lcd-16x2-bricklet/raw/master/datasheets/standard_charset.pdf>`__
 for details. The Unicode example above shows how to specify non-ASCII characters
 and how to translate from Unicode to the LCD charset.
 
.. labview:function:: BrickletLCD16x2.ClearDisplay()


 Deletes all characters from the display.
 
.. labview:function:: BrickletLCD16x2.BacklightOn()


 Turns the backlight on.
 
.. labview:function:: BrickletLCD16x2.BacklightOff()


 Turns the backlight off.
 
.. labview:function:: BrickletLCD16x2.IsBacklightOn() -> backlight


 :output backlight: Boolean

 Returns *true* if the backlight is on and *false* otherwise.
 


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

.. labview:function:: BrickletLCD16x2.SetConfig(cursor, blinking)

 :input cursor: Boolean
 :input blinking: Boolean

 Configures if the cursor (shown as "_") should be visible and if it
 should be blinking (shown as a blinking block). The cursor position
 is one character behind the the last text written with 
 :labview:func:`WriteLine() <BrickletLCD16x2.WriteLine>`.
 
 The default is (false, false).
 
.. labview:function:: BrickletLCD16x2.GetConfig() -> cursor, blinking


 :output cursor: Boolean
 :output blinking: Boolean

 Returns the configuration as set by :labview:func:`SetConfig() <BrickletLCD16x2.SetConfig>`.
 
.. labview:function:: BrickletLCD16x2.IsButtonPressed(button) -> pressed

 :input button: Byte

 :output pressed: Boolean

 Returns *true* if the button (0 to 2) is pressed. If you want to react
 on button presses and releases it is recommended to use the
 :labview:func:`ButtonPressed <BrickletLCD16x2.ButtonPressed>` and :labview:func:`ButtonReleased <BrickletLCD16x2.ButtonReleased>` callbacks.
 
.. labview:function:: BrickletLCD16x2.SetCustomCharacter(index, character)

 :input index: Byte
 :input character: Byte[8]

 The LCD 16x2 Bricklet can store up to 8 custom characters. The characters
 consist of 5x8 pixels and can be addressed with the index 0-7. To describe
 the pixels, the first 5 bits of 8 bytes are used. For example, to make
 a custom character "H", you should transfer the following:
 
 * ``character[0] = 0b00010001`` (decimal value 17)
 * ``character[1] = 0b00010001`` (decimal value 17)
 * ``character[2] = 0b00010001`` (decimal value 17)
 * ``character[3] = 0b00011111`` (decimal value 31)
 * ``character[4] = 0b00010001`` (decimal value 17)
 * ``character[5] = 0b00010001`` (decimal value 17)
 * ``character[6] = 0b00010001`` (decimal value 17)
 * ``character[7] = 0b00000000`` (decimal value 0)
 
 The characters can later be written with :labview:func:`WriteLine() <BrickletLCD16x2.WriteLine>` by using the
 characters with the byte representation 8 to 15.
 
 You can play around with the custom characters in Brick Viewer since
 version 2.0.1.
 
 Custom characters are stored by the LCD in RAM, so they have to be set
 after each startup.
 
 .. versionadded:: 2.0.1~(Plugin)
 
.. labview:function:: BrickletLCD16x2.GetCustomCharacter(index) -> character

 :input index: Byte

 :output character: Byte[8]

 Returns the custom character for a given index, as set with
 :labview:func:`SetCustomCharacter() <BrickletLCD16x2.SetCustomCharacter>`.
 
 .. versionadded:: 2.0.1~(Plugin)
 
.. labview:function:: BrickletLCD16x2.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:: BrickletLCD16x2.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() <BrickletLCD16x2.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() <BrickletLCD16x2.SetResponseExpected>`
 for the list of function ID constants available for this function.
 
.. labview:function:: BrickletLCD16x2.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:
 
 * BrickletLCD16x2.FUNCTION_WRITE_LINE = 1
 * BrickletLCD16x2.FUNCTION_CLEAR_DISPLAY = 2
 * BrickletLCD16x2.FUNCTION_BACKLIGHT_ON = 3
 * BrickletLCD16x2.FUNCTION_BACKLIGHT_OFF = 4
 * BrickletLCD16x2.FUNCTION_SET_CONFIG = 6
 * BrickletLCD16x2.FUNCTION_SET_CUSTOM_CHARACTER = 11
 
.. labview:function:: BrickletLCD16x2.SetResponseExpectedAll(responseExpected)

 :input responseExpected: Boolean

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


.. _lcd_16x2_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 BrickletLCD16x2.ButtonPressed(sender, button)

 :input sender: .NET Refnum (BrickletLCD16x2)
 :input button: Byte

 This callback is triggered when a button is pressed. The parameter is
 the number of the button (0 to 2).
 

.. labview:function:: event BrickletLCD16x2.ButtonReleased(sender, button)

 :input sender: .NET Refnum (BrickletLCD16x2)
 :input button: Byte

 This callback is triggered when a button is released. The parameter is
 the number of the button (0 to 2).
 


.. _lcd_16x2_bricklet_labview_constants:

Constants
^^^^^^^^^

.. labview:symbol:: BrickletLCD16x2.DEVICE_IDENTIFIER

 This constant is used to identify a LCD 16x2 Bricklet.

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

