Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/stephane/libmodbus
A Modbus library for Linux, Mac OS, FreeBSD and Windows
https://github.com/stephane/libmodbus
automation c libmodbus modbus
Last synced: 14 days ago
JSON representation
A Modbus library for Linux, Mac OS, FreeBSD and Windows
- Host: GitHub
- URL: https://github.com/stephane/libmodbus
- Owner: stephane
- License: lgpl-2.1
- Created: 2010-01-21T10:42:06.000Z (almost 15 years ago)
- Default Branch: master
- Last Pushed: 2024-04-02T04:42:51.000Z (7 months ago)
- Last Synced: 2024-05-01T19:31:50.054Z (6 months ago)
- Topics: automation, c, libmodbus, modbus
- Language: C
- Homepage: http://libmodbus.org
- Size: 1.71 MB
- Stars: 3,196
- Watchers: 212
- Forks: 1,680
- Open Issues: 208
-
Metadata Files:
- Readme: README.md
- Changelog: NEWS
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: COPYING.LESSER
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md
- Authors: AUTHORS
Awesome Lists containing this project
- awesome-smartgrid - Modbus
README
# A groovy modbus library
## Overview
libmodbus is a free software library to send/receive data with a device which
respects the Modbus protocol. This library can use a serial port or an Ethernet
connection.
The functions included in the library have been derived from the Modicon Modbus
Protocol Reference Guide which can be obtained from [www.modbus.org](http://www.modbus.org).
The license of libmodbus is *LGPL v2.1 or later*.
The official website is [www.libmodbus.org](http://www.libmodbus.org). The
website contains the latest version of the documentation.
The library is written in C and designed to run on Linux, Mac OS X, FreeBSD, Embox,
QNX and Windows.
You can use the library on MCUs with Embox RTOS.
## Installation
You will only need to install automake, autoconf, libtool and a C compiler (gcc
or clang) to compile the library and asciidoc and xmlto to generate the
documentation (optional).
To install, just run the usual dance, `./configure && make install`. Run
`./autogen.sh` first to generate the `configure` script if required.
You can change installation directory with prefix option, eg. `./configure
--prefix=/usr/local/`. You have to check that the installation library path is
properly set up on your system (*/etc/ld.so.conf.d*) and library cache is up to
date (run `ldconfig` as root if required).
The library provides a *libmodbus.pc* file to use with `pkg-config` to ease your
program compilation and linking.
If you want to compile with Microsoft Visual Studio, you should follow the
instructions in `./src/win32/README.md`.
To compile under Windows, install [MinGW](http://www.mingw.org/) and MSYS then
select the common packages (gcc, automake, libtool, etc). The directory
*./src/win32/* contains a Visual C project.
To compile under OS X with [homebrew](http://mxcl.github.com/homebrew/), you
will need to install the following dependencies first: `brew install autoconf
automake libtool`.
To build under Embox, you have to use its build system.
## Testing
Some tests are provided in *tests* directory, you can freely edit the source
code to fit your needs (it's Free Software :).
See *tests/README* for a description of each program.
For a quick test of libmodbus, you can run the following programs in two shells:
1. ./unit-test-server
2. ./unit-test-client
By default, all TCP unit tests will be executed (see --help for options).
It's also possible to run the unit tests with `make check`.
## To report a bug or to contribute
See [CONTRIBUTING](CONTRIBUTING.md) document.
## Documentation
You can serve the local documentation with:
```shell
pip install mkdocs-material
mkdocs serve
```