README.md

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