..
 #############################################################
 # 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 - IO-16 Bricklet

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

.. _io16_bricklet_modbus:

Modbus - IO-16 Bricklet
=======================

This is the description of the :ref:`Modbus protocol <llproto_modbus>` for the :ref:`IO-16 Bricklet <io16_bricklet>`. General information and technical
specifications for the IO-16 Bricklet are summarized in its :ref:`hardware description
<io16_bricklet_description>`.

.. _io16_bricklet_modbus_api:

API
---

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




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



.. modbus:function:: BrickletIO16.set_port

 :functionid: 1
 :request port: char
 :request value_mask: uint8

 :noresponse: no response

 Sets the output value (high or low) for a port ("a" or "b") with a bitmask
 (8bit). A 1 in the bitmask means high and a 0 in the bitmask means low.
 
 For example: The value 15 or 0b00001111 will turn the pins 0-3 high and the
 pins 4-7 low for the specified port.
 
 .. note::
  This function does nothing for pins that are configured as input.
  Pull-up resistors can be switched on with :modbus:func:`set_port_configuration <BrickletIO16.set_port_configuration>`.
 
.. modbus:function:: BrickletIO16.get_port

 :functionid: 2
 :request port: char

 :response value_mask: uint8

 Returns a bitmask of the values that are currently measured on the
 specified port. This function works if the pin is configured to input
 as well as if it is configured to output.
 
.. modbus:function:: BrickletIO16.set_port_configuration

 :functionid: 3
 :request port: char
 :request selection_mask: uint8
 :request direction: char
 :request value: bool

 :noresponse: no response

 Configures the value and direction of a specified port. Possible directions
 are 'i' and 'o' for input and output.
 
 If the direction is configured as output, the value is either high or low
 (set as *true* or *false*).
 
 If the direction is configured as input, the value is either pull-up or
 default (set as *true* or *false*).
 
 For example:
 
 * ('a', 255, 'i', true) or ('a', 0b11111111, 'i', true) will set all pins of port A as input pull-up.
 * ('a', 128, 'i', false) or ('a', 0b10000000, 'i', false) will set pin 7 of port A as input default (floating if nothing is connected).
 * ('b', 3, 'o', false) or ('b', 0b00000011, 'o', false) will set pins 0 and 1 of port B as output low.
 * ('b', 4, 'o', true) or ('b', 0b00000100, 'o', true) will set pin 2 of port B as output high.
 
 The default configuration is input with pull-up.
 
.. modbus:function:: BrickletIO16.get_port_configuration

 :functionid: 4
 :request port: char

 :response direction_mask: uint8
 :response value_mask: uint8

 Returns a direction bitmask and a value bitmask for the specified port. A 1 in
 the direction bitmask means input and a 0 in the bitmask means output.
 
 For example: A return value of (15, 51) or (0b00001111, 0b00110011) for
 direction and value means that:
 
 * pins 0 and 1 are configured as input pull-up,
 * pins 2 and 3 are configured as input default,
 * pins 4 and 5 are configured as output high
 * and pins 6 and 7 are configured as output low.
 
.. modbus:function:: BrickletIO16.get_edge_count

 :functionid: 14
 :request pin: uint8
 :request reset_counter: bool

 :response count: uint32

 Returns the current value of the edge counter for the selected pin on port A.
 You can configure the edges that are counted with :modbus:func:`set_edge_count_config <BrickletIO16.set_edge_count_config>`.
 
 If you set the reset counter to *true*, the count is set back to 0
 directly after it is read.
 
 .. versionadded:: 2.0.3~(Plugin)
 


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

.. modbus:function:: BrickletIO16.set_port_monoflop

 :functionid: 10
 :request port: char
 :request selection_mask: uint8
 :request value_mask: uint8
 :request time: uint32

 :noresponse: no response

 Configures a monoflop of the pins specified by the second parameter as 8 bit
 long bitmask. The specified pins must be configured for output. Non-output
 pins will be ignored.
 
 The third parameter is a bitmask with the desired value of the specified
 output pins. A 1 in the bitmask means high and a 0 in the bitmask means low.
 
 The forth parameter indicates the time (in ms) that the pins should hold
 the value.
 
 If this function is called with the parameters ('a', 9, 1, 1500) or
 ('a', 0b00001001, 0b00000001, 1500): Pin 0 will get high and pin 3 will get
 low on port 'a'. In 1.5s pin 0 will get low and pin 3 will get high again.
 
 A monoflop can be used as a fail-safe mechanism. For example: Lets assume you
 have a RS485 bus and an IO-16 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 set to high. Pin 0 will be high all the time. If now
 the RS485 connection is lost, then pin 0 will get low in at most two seconds.
 
.. modbus:function:: BrickletIO16.get_port_monoflop

 :functionid: 11
 :request port: char
 :request pin: uint8

 :response value: uint8
 :response time: uint32
 :response time_remaining: uint32

 Returns (for the given pin) the current value and the time as set by
 :modbus:func:`set_port_monoflop <BrickletIO16.set_port_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:: BrickletIO16.set_selected_values

 :functionid: 13
 :request port: char
 :request selection_mask: uint8
 :request value_mask: uint8

 :noresponse: no response

 Sets the output value (high or low) for a port ("a" or "b" with a bitmask, 
 according to the selection mask. The bitmask is 8 bit long and a 1 in the
 bitmask means high and a 0 in the bitmask means low.
 
 For example: The parameters ('a', 192, 128) or ('a', 0b11000000, 0b10000000)
 will turn pin 7 high and pin 6 low on port A, pins 0-6 will remain untouched.
 
 .. note::
  This function does nothing for pins that are configured as input.
  Pull-up resistors can be switched on with :func:`SetConfiguration`.
 
.. modbus:function:: BrickletIO16.set_edge_count_config

 :functionid: 15
 :request pin: uint8
 :request edge_type: uint8
 :request debounce: uint8

 :noresponse: no response

 Configures the edge counter for the selected pin of port A. Pins 0 and 1
 are available for edge counting.
 
 The edge type parameter configures if rising edges, falling edges or
 both are counted if the pin is configured for input. Possible edge types are:
 
 * 0 = rising (default)
 * 1 = falling
 * 2 = both
 
 The debounce time is given in ms.
 
 Configuring an edge counter resets its value to 0.
 
 If you don't know what any of this means, just leave it at default. The
 default configuration is very likely OK for you.
 
 Default values: 0 (edge type) and 100ms (debounce time)
 
 .. versionadded:: 2.0.3~(Plugin)
 
.. modbus:function:: BrickletIO16.get_edge_count_config

 :functionid: 16
 :request pin: uint8

 :response edge_type: uint8
 :response debounce: uint8

 Returns the edge type and debounce time for the selected pin of port A as set by
 :modbus:func:`set_edge_count_config <BrickletIO16.set_edge_count_config>`.
 
 .. versionadded:: 2.0.3~(Plugin)
 
.. modbus:function:: BrickletIO16.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|
 


Callback Configuration Functions
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^



.. modbus:function:: BrickletIO16.set_debounce_period

 :functionid: 5
 :request debounce: uint32

 :noresponse: no response

 Sets the debounce period of the :modbus:func:`CALLBACK_INTERRUPT <BrickletIO16.CALLBACK_INTERRUPT>` callback in ms.
 
 For example: If you set this value to 100, you will get the interrupt
 maximal every 100ms. This is necessary if something that bounces is
 connected to the IO-16 Bricklet, such as a button.
 
 The default value is 100.
 
.. modbus:function:: BrickletIO16.get_debounce_period

 :functionid: 6
 :emptyrequest: empty payload

 :response debounce: uint32

 Returns the debounce period as set by :modbus:func:`set_debounce_period <BrickletIO16.set_debounce_period>`.
 
.. modbus:function:: BrickletIO16.set_port_interrupt

 :functionid: 7
 :request port: char
 :request interrupt_mask: uint8

 :noresponse: no response

 Sets the pins on which an interrupt is activated with a bitmask.
 Interrupts are triggered on changes of the voltage level of the pin,
 i.e. changes from high to low and low to high.
 
 For example: ('a', 129) or ('a', 0b10000001) will enable the interrupt for
 pins 0 and 7 of port a.
 
 The interrupt is delivered with the callback :modbus:func:`CALLBACK_INTERRUPT <BrickletIO16.CALLBACK_INTERRUPT>`.
 
.. modbus:function:: BrickletIO16.get_port_interrupt

 :functionid: 8
 :request port: char

 :response interrupt_mask: uint8

 Returns the interrupt bitmask for the specified port as set by
 :modbus:func:`set_port_interrupt <BrickletIO16.set_port_interrupt>`.
 


.. _io16_bricklet_modbus_callbacks:

Callbacks
^^^^^^^^^

.. modbus:function:: BrickletIO16.CALLBACK_INTERRUPT

 :functionid: 9

 :response port: char
 :response interrupt_mask: uint8
 :response value_mask: uint8


 This callback is triggered whenever a change of the voltage level is detected
 on pins where the interrupt was activated with :modbus:func:`set_port_interrupt <BrickletIO16.set_port_interrupt>`.
 
 The values are the port, a bitmask that specifies which interrupts occurred
 and the current value bitmask of the port.
 
 For example:
 
 * ('a', 1, 1) or ('a', 0b00000001, 0b00000001) means that on port A an
   interrupt on pin 0 occurred and currently pin 0 is high and pins 1-7 are low.
 * ('b', 129, 254) or ('b', 0b10000001, 0b11111110) means that on port B
   interrupts on pins 0 and 7 occurred and currently pin 0 is low and pins 1-7
   are high.
 
.. modbus:function:: BrickletIO16.CALLBACK_MONOFLOP_DONE

 :functionid: 12

 :response port: char
 :response selection_mask: uint8
 :response value_mask: uint8


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


