..
 #############################################################
 # 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-tcpip">Software</a> / TCP/IP - Dual Relay Bricklet

.. |device_identifier_constant| unicode:: 0xA0
   :trim:

.. _dual_relay_bricklet_tcpip:

TCP/IP - Dual Relay Bricklet
============================

This is the description of the :ref:`TCP/IP protocol <llproto_tcpip>` 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>`.

.. _dual_relay_bricklet_tcpip_api:

API
---

A general description of the TCP/IP protocol structure can be found
:ref:`here <llproto_tcpip>`.




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



.. tcpip:function:: BrickletDualRelay.set_state

 :functionid: 1
 :request relay1: bool
 :request relay2: bool

 :noresponse: no response

 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 :tcpip:func:`get_state <BrickletDualRelay.get_state>` or you
 can use :tcpip:func:`set_selected_state <BrickletDualRelay.set_selected_state>`.
 
 Running monoflop timers will be overwritten if this function is called.
 
 The default value is (*false*, *false*).
 
.. tcpip:function:: BrickletDualRelay.get_state

 :functionid: 2
 :emptyrequest: empty payload

 :response relay1: bool
 :response relay2: bool

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


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

.. tcpip:function:: BrickletDualRelay.set_monoflop

 :functionid: 3
 :request relay: uint8
 :request state: bool
 :request time: uint32

 :noresponse: no response

 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.
 
.. tcpip:function:: BrickletDualRelay.get_monoflop

 :functionid: 4
 :request relay: uint8

 :response state: bool
 :response time: uint32
 :response time_remaining: uint32

 Returns (for the given relay) the current state and the time as set by 
 :tcpip:func:`set_monoflop <BrickletDualRelay.set_monoflop>` 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.
 
.. tcpip:function:: BrickletDualRelay.set_selected_state

 :functionid: 6
 :request relay: uint8
 :request state: bool

 :noresponse: no response

 Sets the state of the selected relay (1 or 2), *true* means on and *false* means off. 
 
 The other relay remains untouched.
 
.. tcpip:function:: BrickletDualRelay.get_identity

 :functionid: 255
 :emptyrequest: empty payload

 :response uid: char[8]
 :response connected_uid: char[8]
 :response position: char
 :response hardware_version: uint8[3]
 :response firmware_version: uint8[3]
 :response device_identifier: uint16

 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_tcpip_callbacks:

Callbacks
^^^^^^^^^

.. tcpip:function:: BrickletDualRelay.CALLBACK_MONOFLOP_DONE

 :functionid: 5

 :response relay: uint8
 :response state: bool


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


