..
 #############################################################
 # 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-modbus">Software</a> / Modbus - Solid State Relay Bricklet

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

.. _solid_state_relay_bricklet_modbus:

Modbus - Solid State Relay Bricklet
===================================

This is the description of the :ref:`Modbus protocol <llproto_modbus>` 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>`.

.. _solid_state_relay_bricklet_modbus_api:

API
---

A general description of the Modbus protocol structure can be found
:ref:`here <llproto_modbus>`.




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



.. modbus:function:: BrickletSolidStateRelay.set_state

 :functionid: 1
 :request state: bool

 :noresponse: no response

 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*.
 
.. modbus:function:: BrickletSolidStateRelay.get_state

 :functionid: 2
 :emptyrequest: empty payload

 :response state: bool

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


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

.. modbus:function:: BrickletSolidStateRelay.set_monoflop

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

 :noresponse: no response

 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.
 
.. modbus:function:: BrickletSolidStateRelay.get_monoflop

 :functionid: 4
 :emptyrequest: empty payload

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

 Returns the current state and the time as set by 
 :modbus:func:`set_monoflop <BrickletSolidStateRelay.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.
 
.. modbus:function:: BrickletSolidStateRelay.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|
 


.. _solid_state_relay_bricklet_modbus_callbacks:

Callbacks
^^^^^^^^^

.. modbus:function:: BrickletSolidStateRelay.CALLBACK_MONOFLOP_DONE

 :functionid: 5

 :response state: bool


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


