.. _user/protocols/ethernetIp:

***********
EtherNet/IP
***********

EtherNet/IP is an industrial network protocol that adapts the Common Industrial Protocol to standard Ethernet.
EtherNet/IP is one of the leading industrial protocols in the United States and is widely used in a range of
industries including factory, hybrid and process.

.. _user/protocols/ethernetIp_connection:
.. include:: ../protocolSchemas/EthernetIpConnection.rst


.. _user/protocols/ethernetIp_endpoint:
.. include:: ../protocolSchemas/EthernetIpEndpoint.rst


Input Format on Write
---------------------

When writing data, a JSON object with the following structure should be sent to a write Endpoint (``/set``):

.. code:: json

  {
    "id": "<correlation id>",
    "value": "<value>"
  }

.. code

Output Format on Write
----------------------

When writing data, the result of the operation will be published to a ``/res`` topic with the following structure:

.. code:: json

  {
    "id": "<correlation id>",
    "timestamp": "<msSinceEpoch>",
    "result": "<result>"
  }

.. code

Output Format on Read
---------------------

When data is read from a read Endpoint (``/req``) the following JSON is returned as a response in a ``/res`` topic:

.. code:: json

  {
    "id": "<correlation id>",
    "timestamp": "<msSinceEpoch>",
    "value": "<value>",
  }

.. code

Output Format on Subscribe
--------------------------

When data is read by means of a subscription Endpoint, the following JSON is returned as response:

.. code:: json

  {
    "id": "<correlation id>",
    "timestamp": "<msSinceEpoch>",
    "oldValue": "<old value>",
    "value": "<value>"
  }

.. code

Sample Commissioning file:
==========================

Download: :download:`ethernetIp-example.yml`

.. literalinclude:: ethernetIp-example.yml
  :language: yaml
  :linenos: