README.rst 2.0 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162
  1. pyprofibus - PROFIBUS-DP stack
  2. ==============================
  3. `https://bues.ch/a/profibus <https://bues.ch/a/profibus>`_
  4. pyprofibus is an Open Source `PROFIBUS-DP <https://en.wikipedia.org/wiki/Profibus>`_ stack written in Python.
  5. Hardware
  6. ========
  7. pyprofibus is able to run on any machine that supports Python. It also runs on embedded machines such as the `Raspberry Pi <https://en.wikipedia.org/wiki/Raspberry_Pi>`_ or even tiny microcontrollers such as the `ESP32 <https://en.wikipedia.org/wiki/ESP32>`_ (Micropython).
  8. Please read the hardware documentation for more information:
  9. `pyprofibus hardware documentation <doc/hardware.rst>`_
  10. Speed / Baud rate
  11. =================
  12. The achievable Profibus-DP speed depends on the hardware that it runs on and what kind of serial transceiver is used. There is no software side artificial limit.
  13. Please see the `pyprofibus hardware documentation <doc/hardware.rst>`_
  14. Examples
  15. ========
  16. pyprofibus comes with a couple of examples that can teach you how to use pyprofibus in your project.
  17. * Example that runs pyprofibus without any hardware. This example can be used to play around with pyprofibus.
  18. * examples/example_dummy_oneslave.py
  19. * examples/example_dummy_oneslave.conf
  20. * examples/example_dummy_twoslaves.py
  21. * examples/example_dummy_twoslaves.conf
  22. * examples/example_dummy_inputonly.py
  23. * examples/example_dummy_inputonly.conf
  24. * Example that runs pyprofibus as master connected to an ET200S as slave.
  25. * examples/example_et200s.py
  26. * examples/example_et200s.conf
  27. * Example that runs pyprofibus as master connected to an S7-315-2DP as *slave*.
  28. * examples/example_s7-315-2dp.py
  29. * examples/example_s7-315-2dp.conf
  30. Dependencies
  31. ============
  32. * `Python <https://www.python.org/>`_ 3.5 or later.
  33. * Or alternatively `Micropython <https://micropython.org/>`_. Please see the `pyprofibus Micropython help <micropython/README.rst>`_ for more information.
  34. License
  35. =======
  36. Copyright (c) 2013-2023 Michael Buesch <m@bues.ch>
  37. Licensed under the terms of the GNU General Public License version 2, or (at your option) any later version.