README.rst 1.5 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849
  1. =========================
  2. A groovy modbus library
  3. =========================
  4. Overview
  5. --------
  6. libmodbus is a free software library to send/receive data with a
  7. device which respects the Modbus protocol. This library can use a
  8. serial port or an Ethernet connection.
  9. The functions included in the library have been derived from the
  10. Modicon Modbus Protocol Reference Guide which can be obtained from
  11. Schneider at www.schneiderautomation.com.
  12. The license of libmodbus is LGPL v2.1 or later and the licence of programs in
  13. tests directory is GPL v3.
  14. The documentation is available under the Creative Commons Attribution-ShareAlike
  15. License 3.0 (Unported) (http://creativecommons.org/licenses/by-sa/3.0/).
  16. The official website is http://www.libmodbus.org.
  17. The library is written in C and designed to run on Linux, Mac OS X, FreeBSD and
  18. QNX and Windows.
  19. Installation
  20. ------------
  21. The shell commands are ``./autogen.sh; ./configure; make; make install``.
  22. If you want to compile with Microsoft Visual Studio, you need to install
  23. http://code.google.com/p/msinttypes/ to fill the absence of stdint.h.
  24. Testing
  25. -------
  26. Some tests are provided in the ``tests`` directory, you can
  27. freely edit the source code to fit your needs (it's Free Sofware :).
  28. See ``tests/README`` for a description of each program.
  29. Report a Bug
  30. ------------
  31. To report a bug, you can:
  32. * fill a bug report on the issue tracker
  33. http://github.com/stephane/libmodbus/issues
  34. * or send an email to stephane.raimbault@gmail.com