README.rst

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