..
 #############################################################
 # 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 - Industrial Quad Relay Bricklet

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

.. _industrial_quad_relay_bricklet_modbus:

Modbus - Industrial Quad Relay Bricklet
=======================================

This is the description of the :ref:`Modbus protocol <llproto_modbus>` for the :ref:`Industrial Quad Relay Bricklet <industrial_quad_relay_bricklet>`. General information and technical
specifications for the Industrial Quad Relay Bricklet are summarized in its :ref:`hardware description
<industrial_quad_relay_bricklet_description>`.

.. _industrial_quad_relay_bricklet_modbus_api:

API
---

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




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



.. modbus:function:: BrickletIndustrialQuadRelay.set_value

 :functionid: 1
 :request value_mask: uint16

 :noresponse: no response

 Sets the output value with a bitmask (16bit). A 1 in the bitmask means relay
 closed and a 0 means relay open.
 
 For example: The value 3 or 0b0011 will close the relay of pins 0-1 and open
 the other pins.
 
 If no groups are used (see :modbus:func:`set_group <BrickletIndustrialQuadRelay.set_group>`), the pins correspond to the
 markings on the Quad Relay Bricklet.
 
 If groups are used, the pins correspond to the element in the group.
 Element 1 in the group will get pins 0-3, element 2 pins 4-7, element 3
 pins 8-11 and element 4 pins 12-15.
 
.. modbus:function:: BrickletIndustrialQuadRelay.get_value

 :functionid: 2
 :emptyrequest: empty payload

 :response value_mask: uint16

 Returns the bitmask as set by :modbus:func:`set_value <BrickletIndustrialQuadRelay.set_value>`.
 


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

.. modbus:function:: BrickletIndustrialQuadRelay.set_monoflop

 :functionid: 3
 :request selection_mask: uint16
 :request value_mask: uint16
 :request time: uint32

 :noresponse: no response

 Configures a monoflop of the pins specified by the first parameter
 bitmask.
 
 The second parameter is a bitmask with the desired value of the specified
 pins. A 1 in the bitmask means relay closed and a 0 means relay open.
 
 The third parameter indicates the time (in ms) that the pins should hold
 the value.
 
 If this function is called with the parameters (9, 1, 1500) or
 (0b1001, 0b0001, 1500): Pin 0 will close and pin 3 will open. In 1.5s pin 0
 will open and pin 3 will close again.
 
 A monoflop can be used as a fail-safe mechanism. For example: Lets assume you
 have a RS485 bus and a Quad Relay Bricklet connected to one of the slave
 stacks. You can now call this function every second, with a time parameter
 of two seconds and pin 0 closed. Pin 0 will be closed all the time. If now
 the RS485 connection is lost, then pin 0 will be opened in at most two seconds.
 
.. modbus:function:: BrickletIndustrialQuadRelay.get_monoflop

 :functionid: 4
 :request pin: uint8

 :response value: uint16
 :response time: uint32
 :response time_remaining: uint32

 Returns (for the given pin) the current value and the time as set by
 :modbus:func:`set_monoflop <BrickletIndustrialQuadRelay.set_monoflop>` as well as the remaining time until the value flips.
 
 If the timer is not running currently, the remaining time will be returned
 as 0.
 
.. modbus:function:: BrickletIndustrialQuadRelay.set_group

 :functionid: 5
 :request group: char[4]

 :noresponse: no response

 Sets a group of Quad Relay Bricklets that should work together. You can
 find Bricklets that can be grouped together with :modbus:func:`get_available_for_group <BrickletIndustrialQuadRelay.get_available_for_group>`.
 
 The group consists of 4 elements. Element 1 in the group will get pins 0-3,
 element 2 pins 4-7, element 3 pins 8-11 and element 4 pins 12-15.
 
 Each element can either be one of the ports ('a' to 'd') or 'n' if it should
 not be used.
 
 For example: If you have two Quad Relay Bricklets connected to port A and
 port B respectively, you could call with ``['a', 'b', 'n', 'n']``.
 
 Now the pins on the Quad Relay on port A are assigned to 0-3 and the
 pins on the Quad Relay on port B are assigned to 4-7. It is now possible
 to call :modbus:func:`set_value <BrickletIndustrialQuadRelay.set_value>` and control two Bricklets at the same time.
 
.. modbus:function:: BrickletIndustrialQuadRelay.get_group

 :functionid: 6
 :emptyrequest: empty payload

 :response group: char[4]

 Returns the group as set by :modbus:func:`set_group <BrickletIndustrialQuadRelay.set_group>`
 
.. modbus:function:: BrickletIndustrialQuadRelay.get_available_for_group

 :functionid: 7
 :emptyrequest: empty payload

 :response available: uint8

 Returns a bitmask of ports that are available for grouping. For example the
 value 5 or 0b0101 means: Port A and port C are connected to Bricklets that
 can be grouped together.
 
.. modbus:function:: BrickletIndustrialQuadRelay.set_selected_values

 :functionid: 9
 :request selection_mask: uint16
 :request value_mask: uint16

 :noresponse: no response

 Sets the output value with a bitmask, according to the selection mask. 
 The bitmask is 16 bit long, *true* refers to a closed relay and 
 *false* refers to an open relay.
 
 For example: The values (3, 1) or (0b0011, 0b0001) will close the relay of
 pin 0, open the relay of pin 1 and leave the others untouched.
 
 If no groups are used (see :modbus:func:`set_group <BrickletIndustrialQuadRelay.set_group>`), the pins correspond to the
 markings on the Quad Relay Bricklet.
 
 If groups are used, the pins correspond to the element in the group.
 Element 1 in the group will get pins 0-3, element 2 pins 4-7, element 3
 pins 8-11 and element 4 pins 12-15.
 
.. modbus:function:: BrickletIndustrialQuadRelay.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|
 


.. _industrial_quad_relay_bricklet_modbus_callbacks:

Callbacks
^^^^^^^^^

.. modbus:function:: BrickletIndustrialQuadRelay.CALLBACK_MONOFLOP_DONE

 :functionid: 8

 :response selection_mask: uint16
 :response value_mask: uint16


 This callback is triggered whenever a monoflop timer reaches 0. The
 response values contain the involved pins and the current value of the pins
 (the value after the monoflop).
 


