.. _user/protocols/profinet:

********
Profinet
********

.. warning::
  The Profinet protocol may require root permissions in some constellations.
  If you experience problems with running this protocol, please make sure to
  install your service on an agent with root permissions as described in
  :ref:`agent orchestration<user/agents/orchestration/docker-compose>`.

Overview
========

Profinet  (usually styled as **PROFINET**, as a portmanteau for Process Field Net) is an industry technical standard for data communication over Industrial Ethernet, designed for collecting data
from, and controlling equipment in industrial systems, with a particular strength in delivering data under tight time constraints.

This protocol is optional and subject to license. It should be installed on demand.

.. _user/protocols/profinet_connection:
.. include:: ../protocolSchemas/ProfinetConnection.rst

.. _user/protocols/profinet_endpoint:
.. include:: ../protocolSchemas/ProfinetEndpoint.rst

Sample commissioning file
=========================

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

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


Output Format
=============

The data will be written as a JSON object with a *timestamp* and a data member called *value*.

For example for the endpoint *endpoint1*, the output will be:

.. code:: json

  {
    "timestamp": 1581932492902,
    "value": [0, 1, 0, 0]
  }