..
 #############################################################
 # 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 - Solid State Relay Bricklet

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

.. _solid_state_relay_bricklet_labview:

LabVIEW - Solid State Relay Bricklet
====================================

This is the description of the :ref:`LabVIEW API bindings <api_bindings_labview>` for the :ref:`Solid State Relay Bricklet <solid_state_relay_bricklet>`. General information and technical
specifications for the Solid State Relay Bricklet are summarized in its :ref:`hardware description
<solid_state_relay_bricklet_description>`.

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

.. _solid_state_relay_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/solid-state-relay-bricklet/raw/master/software/examples/labview/Example%20Simple.vi>`__

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

.. _solid_state_relay_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:: BrickletSolidStateRelay(uid, ipcon) -> solidStateRelay

 :input uid: String
 :input ipcon: .NET Refnum (IPConnection)
 :output solidStateRelay: .NET Refnum (BrickletSolidStateRelay)

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


.. labview:function:: BrickletSolidStateRelay.SetState(state)

 :input state: Boolean

 Sets the state of the relays *true* means on and *false* means off. 
 
 Running monoflop timers will be overwritten if this function is called.
 
 The default value is *false*.
 
.. labview:function:: BrickletSolidStateRelay.GetState() -> state


 :output state: Boolean

 Returns the state of the relay, *true* means on and *false* means off. 
 


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

.. labview:function:: BrickletSolidStateRelay.SetMonoflop(state, time)

 :input state: Boolean
 :input time: Int64

 The first parameter  is the desired state of the relay (*true* means on 
 and *false* means off). The second parameter indicates the time (in ms) that 
 the relay should hold the state.
 
 If this function is called with the parameters (true, 1500):
 The relay will turn on and in 1.5s it will turn off again.
 
 A monoflop can be used as a failsafe mechanism. For example: Lets assume you 
 have a RS485 bus and a Solid State Relay Bricklet connected to one of the slave 
 stacks. You can now call this function every second, with a time parameter
 of two seconds. The relay will be on all the time. If now the RS485 
 connection is lost, the relay will turn off in at most two seconds.
 
.. labview:function:: BrickletSolidStateRelay.GetMonoflop() -> state, time, timeRemaining


 :output state: Boolean
 :output time: Int64
 :output timeRemaining: Int64

 Returns the current state and the time as set by 
 :labview:func:`SetMonoflop() <BrickletSolidStateRelay.SetMonoflop>` as well as the remaining time until the state flips.
 
 If the timer is not running currently, the remaining time will be returned
 as 0.
 
.. labview:function:: BrickletSolidStateRelay.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:: BrickletSolidStateRelay.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() <BrickletSolidStateRelay.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() <BrickletSolidStateRelay.SetResponseExpected>`
 for the list of function ID constants available for this function.
 
.. labview:function:: BrickletSolidStateRelay.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:
 
 * BrickletSolidStateRelay.FUNCTION_SET_STATE = 1
 * BrickletSolidStateRelay.FUNCTION_SET_MONOFLOP = 3
 
.. labview:function:: BrickletSolidStateRelay.SetResponseExpectedAll(responseExpected)

 :input responseExpected: Boolean

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


.. _solid_state_relay_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 BrickletSolidStateRelay.MonoflopDone(sender, state)

 :input sender: .NET Refnum (BrickletSolidStateRelay)
 :input state: Boolean

 This callback is triggered whenever the monoflop timer reaches 0. 
 The parameter is the current state of the relay 
 (the state after the monoflop).
 


.. _solid_state_relay_bricklet_labview_constants:

Constants
^^^^^^^^^

.. labview:symbol:: BrickletSolidStateRelay.DEVICE_IDENTIFIER

 This constant is used to identify a Solid State Relay Bricklet.

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

