..
 #############################################################
 # 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-csharp">Software</a> / C# - Dual Relay Bricklet

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

.. _dual_relay_bricklet_csharp:

C# - Dual Relay Bricklet
========================

This is the description of the :ref:`C# API bindings <api_bindings_csharp>` for the :ref:`Dual Relay Bricklet <dual_relay_bricklet>`. General information and technical
specifications for the Dual Relay Bricklet are summarized in its :ref:`hardware description
<dual_relay_bricklet_description>`.

An :ref:`installation guide <api_bindings_csharp_install>` for the C# API
bindings is part of their general description.

.. _dual_relay_bricklet_csharp_examples:


Examples
--------

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

Simple
^^^^^^

`Download (ExampleSimple.cs) <https://github.com/Tinkerforge/dual-relay-bricklet/raw/master/software/examples/csharp/ExampleSimple.cs>`__

.. literalinclude:: DualRelay_Bricklet_CSharp_ExampleSimple.cs
 :language: csharp
 :linenos:
 :tab-width: 4

.. _dual_relay_bricklet_csharp_api:

API
---

Generally, every method of the C# bindings that returns a value can
throw a ``Tinkerforge.TimeoutException``. This exception gets thrown 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.

Since C# does not support multiple return values directly, we use the ``out``
keyword to return multiple values from a method.

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

All methods listed below are thread-safe.




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


.. csharp:function:: class BrickletDualRelay(String uid, IPConnection ipcon)

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

 .. code-block:: csharp

  BrickletDualRelay dualRelay = new BrickletDualRelay("YOUR_DEVICE_UID", ipcon);

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


.. csharp:function:: public void BrickletDualRelay::SetState(bool relay1, bool relay2)

 Sets the state of the relays, *true* means on and *false* means off. 
 For example: (true, false) turns relay 1 on and relay 2 off.
 
 If you just want to set one of the relays and don't know the current state
 of the other relay, you can get the state with :csharp:func:`GetState() <BrickletDualRelay::GetState>` or you
 can use :csharp:func:`SetSelectedState() <BrickletDualRelay::SetSelectedState>`.
 
 Running monoflop timers will be overwritten if this function is called.
 
 The default value is (*false*, *false*).
 
.. csharp:function:: public void BrickletDualRelay::GetState(out bool relay1, out bool relay2)

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


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

.. csharp:function:: public void BrickletDualRelay::SetMonoflop(byte relay, bool state, long time)

 The first parameter can be 1 or 2 (relay 1 or relay 2). The second parameter 
 is the desired state of the relay (*true* means on and *false* means off).
 The third parameter indicates the time (in ms) that the relay should hold 
 the state.
 
 If this function is called with the parameters (1, true, 1500):
 Relay 1 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 Dual 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.
 
.. csharp:function:: public void BrickletDualRelay::GetMonoflop(byte relay, out bool state, out long time, out long timeRemaining)

 Returns (for the given relay) the current state and the time as set by 
 :csharp:func:`SetMonoflop() <BrickletDualRelay::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.
 
.. csharp:function:: public void BrickletDualRelay::SetSelectedState(byte relay, bool state)

 Sets the state of the selected relay (1 or 2), *true* means on and *false* means off. 
 
 The other relay remains untouched.
 
.. csharp:function:: public byte[] BrickletDualRelay::GetAPIVersion()

 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.
 
.. csharp:function:: public bool BrickletDualRelay::GetResponseExpected(byte functionId)

 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
 :csharp:func:`SetResponseExpected() <BrickletDualRelay::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 :csharp:func:`SetResponseExpected() <BrickletDualRelay::SetResponseExpected>`
 for the list of function ID constants available for this function.
 
.. csharp:function:: public void BrickletDualRelay::SetResponseExpected(byte functionId, bool responseExpected)

 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:
 
 * BrickletDualRelay.FUNCTION_SET_STATE = 1
 * BrickletDualRelay.FUNCTION_SET_MONOFLOP = 3
 * BrickletDualRelay.FUNCTION_SET_SELECTED_STATE = 6
 
.. csharp:function:: public void BrickletDualRelay::SetResponseExpectedAll(bool responseExpected)

 Changes the response expected flag for all setter and callback configuration
 functions of this device at once.
 
.. csharp:function:: public void BrickletDualRelay::GetIdentity(out string uid, out string connectedUid, out char position, out byte[] hardwareVersion, out byte[] firmwareVersion, out int deviceIdentifier)

 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|
 


.. _dual_relay_bricklet_csharp_callbacks:

Callbacks
^^^^^^^^^

Callbacks can be registered to receive time critical or recurring data from
the device. The registration is done by appending your callback handler to
the corresponding event:

.. code-block:: csharp

    void Callback(BrickletDualRelay sender, int value)
    {
        System.Console.WriteLine("Value: " + value);
    }

    dualRelay.ExampleCallback += Callback;

The available events 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.


.. csharp:function:: public event BrickletDualRelay::MonoflopDone(BrickletDualRelay sender, byte relay, bool state)


  This callback is triggered whenever a monoflop timer reaches 0. The 
  parameter contain the relay (1 or 2) and the current state of the relay 
  (the state after the monoflop).
  


.. _dual_relay_bricklet_csharp_constants:

Constants
^^^^^^^^^

.. csharp:member:: public int BrickletDualRelay::DEVICE_IDENTIFIER

 This constant is used to identify a Dual Relay Bricklet.

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

