README.rst 2.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566
  1. pyprofibus - PROFIBUS-DP stack
  2. ==============================
  3. pyprofibus is an Open Source `PROFIBUS-DP <https://en.wikipedia.org/wiki/Profibus>`_ stack written in Python.
  4. `pyprofibus home <https://bues.ch/a/profibus>`_
  5. `Git repository <https://bues.ch/cgit/pyprofibus.git>`_
  6. `Github repository <https://github.com/mbuesch/pyprofibus>`_
  7. Hardware
  8. ========
  9. 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).
  10. Please read the hardware documentation for more information:
  11. `pyprofibus hardware documentation <doc/hardware.rst>`_
  12. Speed / Baud rate
  13. =================
  14. 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.
  15. Please see the `pyprofibus hardware documentation <doc/hardware.rst>`_
  16. Examples
  17. ========
  18. pyprofibus comes with a couple of examples that can teach you how to use pyprofibus in your project.
  19. * Example that runs pyprofibus without any hardware. This example can be used to play around with pyprofibus.
  20. * examples/example_dummy_oneslave.py
  21. * examples/example_dummy_oneslave.conf
  22. * examples/example_dummy_twoslaves.py
  23. * examples/example_dummy_twoslaves.conf
  24. * examples/example_dummy_inputonly.py
  25. * examples/example_dummy_inputonly.conf
  26. * Example that runs pyprofibus as master connected to an ET200S as slave.
  27. * examples/example_et200s.py
  28. * examples/example_et200s.conf
  29. * Example that runs pyprofibus as master connected to an S7-315-2DP as *slave*.
  30. * examples/example_s7-315-2dp.py
  31. * examples/example_s7-315-2dp.conf
  32. Dependencies
  33. ============
  34. * `Python <https://www.python.org/>`_ 3.5 or later.
  35. * Or alternatively `Micropython <https://micropython.org/>`_. Please see the `pyprofibus Micropython help <micropython/README.rst>`_ for more information.
  36. License
  37. =======
  38. Copyright (c) 2013-2024 Michael Büsch <m@bues.ch>
  39. Licensed under the terms of the GNU General Public License version 2, or (at your option) any later version.