Skip to content

Commit

Permalink
new file: Doxyfile
Browse files Browse the repository at this point in the history
	modified:   LICENSE.md
	renamed:    Modbus.ino -> ModbusRtu.h
	modified:   README.md
	new file:   config
	new file:   documentation/html/_modbus_rtu_8h.html
	new file:   documentation/html/_modbus_rtu_8h_source.html
	new file:   documentation/html/annotated.html
	new file:   documentation/html/bc_s.png
	new file:   documentation/html/bdwn.png
	new file:   documentation/html/class_modbus-members.html
	new file:   documentation/html/class_modbus.html
	new file:   documentation/html/classes.html
	new file:   documentation/html/closed.png
	new file:   documentation/html/doxygen.css
	new file:   documentation/html/doxygen.png
	new file:   documentation/html/dynsections.js
	new file:   documentation/html/files.html
	new file:   documentation/html/ftv2blank.png
	new file:   documentation/html/ftv2cl.png
	new file:   documentation/html/ftv2doc.png
	new file:   documentation/html/ftv2folderclosed.png
	new file:   documentation/html/ftv2folderopen.png
	new file:   documentation/html/ftv2lastnode.png
	new file:   documentation/html/ftv2link.png
	new file:   documentation/html/ftv2mlastnode.png
	new file:   documentation/html/ftv2mnode.png
	new file:   documentation/html/ftv2mo.png
	new file:   documentation/html/ftv2node.png
	new file:   documentation/html/ftv2ns.png
	new file:   documentation/html/ftv2plastnode.png
	new file:   documentation/html/ftv2pnode.png
	new file:   documentation/html/ftv2splitbar.png
	new file:   documentation/html/ftv2vertline.png
	new file:   documentation/html/functions.html
	new file:   documentation/html/functions_func.html
	new file:   documentation/html/functions_vars.html
	new file:   documentation/html/globals.html
	new file:   documentation/html/globals_defs.html
	new file:   documentation/html/globals_enum.html
	new file:   documentation/html/globals_eval.html
	new file:   documentation/html/globals_vars.html
	new file:   documentation/html/group__buffer.html
	new file:   documentation/html/group__discrete.html
	new file:   documentation/html/group__loop.html
	new file:   documentation/html/group__register.html
	new file:   documentation/html/group__setup.html
	new file:   documentation/html/index.hhc
	new file:   documentation/html/index.hhk
	new file:   documentation/html/index.hhp
	new file:   documentation/html/index.html
	new file:   documentation/html/modules.html
	new file:   documentation/html/nav_f.png
	new file:   documentation/html/nav_g.png
	new file:   documentation/html/nav_h.png
	new file:   documentation/html/open.png
	new file:   documentation/html/pages.html
	new file:   documentation/html/structmodbus__t-members.html
	new file:   documentation/html/structmodbus__t.html
	new file:   documentation/html/sync_off.png
	new file:   documentation/html/sync_on.png
	new file:   documentation/html/tab_a.png
	new file:   documentation/html/tab_b.png
	new file:   documentation/html/tab_h.png
	new file:   documentation/html/tab_s.png
	new file:   documentation/html/tabs.css
	new file:   documentation/html/todo.html
	new file:   documentation/latex/Makefile
	new file:   documentation/latex/_modbus_rtu_8h.tex
	new file:   documentation/latex/annotated.tex
	new file:   documentation/latex/class_modbus.tex
	new file:   documentation/latex/doxygen.sty
	new file:   documentation/latex/files.tex
	new file:   documentation/latex/group__buffer.tex
	new file:   documentation/latex/group__discrete.tex
	new file:   documentation/latex/group__loop.tex
	new file:   documentation/latex/group__register.tex
	new file:   documentation/latex/group__setup.tex
	new file:   documentation/latex/modules.tex
	new file:   documentation/latex/refman.tex
	new file:   documentation/latex/structmodbus__t.tex
	new file:   documentation/latex/todo.tex
	new file:   documentation/rtf/refman.rtf
	new file:   examples/RS485_slave/RS485_slave.ino
	new file:   examples/advanced_slave/advanced_slave.ino
	new file:   examples/simple_master/simple_master.ino
	new file:   examples/simple_slave/simple_slave.ino
	new file:   keywords.txt
  • Loading branch information
smarmengol committed Oct 5, 2014
1 parent bee2683 commit 2b058dd
Show file tree
Hide file tree
Showing 88 changed files with 13,691 additions and 400 deletions.
1,921 changes: 1,921 additions & 0 deletions Doxyfile

Large diffs are not rendered by default.

663 changes: 391 additions & 272 deletions LICENSE.md

Large diffs are not rendered by default.

420 changes: 296 additions & 124 deletions Modbus.ino → ModbusRtu.h

Large diffs are not rendered by default.

48 changes: 44 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,46 @@
Modbus-Master-Slave-for-Arduino
===============================
README.txt

Modbus Master-Slave library for Arduino
libmodbus is a library that provides a Serial Modbus implementation for Arduino.

Arduino library for communicating with Modbus devices over RS232/485 (via RTU protocol)
A primary goal was to enable industrial communication for the Arduino in order to link it to industrial devices such as HMIs, CNCs, PLCs, temperature regulators or speed drives.

Library contents:
=================================================================
LICENSE.txt GNU Licence file
keywords.txt Arduino IDE colouring syntax

/documentation
Library documentation generated with Doxygen.

/examples
Sample sketches to implement miscellaneous settings:

/examples/advanced_slave Modbus slave node, which links Arduino pins to the Modbus port.
/examples/RS485_slave Modbus slave adapted to the RS485 port
/examples/simple_master Modbus master node with a single query
/examples/simple_slave Modbus slave node with a link array

INSTALLATION PROCEDURE
=================================================================
Refer to this documentation to Install this library:

http://arduino.cc/en/Guide/Libraries

Starting with version 1.0.5, you can install 3rd party libraries in the IDE.

Do not unzip the downloaded library, leave it as is.

In the Arduino IDE, navigate to Sketch > Import Library. At the top of the drop down list, select the option to "Add Library".

You will be prompted to select this zipped library.

Return to the Sketch > Import Library menu. You should now see the library at the bottom of the drop-down menu. It is ready to be used in your sketch.

The zip file will have been expanded in the libraries folder in your Arduino sketches directory.

NB : the library will be available to use in sketches, but examples for the library will not be exposed in the File > Examples until after the IDE has restarted.


KNOWN ISSUES
=================================================================
It is not compatible with ARDUINO LEONARDO and not tested under ARDUINO DUE and newer boards.
1,890 changes: 1,890 additions & 0 deletions config

Large diffs are not rendered by default.

400 changes: 400 additions & 0 deletions documentation/html/_modbus_rtu_8h.html

Large diffs are not rendered by default.

917 changes: 917 additions & 0 deletions documentation/html/_modbus_rtu_8h_source.html

Large diffs are not rendered by default.

67 changes: 67 additions & 0 deletions documentation/html/annotated.html

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Binary file added documentation/html/bc_s.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added documentation/html/bdwn.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
83 changes: 83 additions & 0 deletions documentation/html/class_modbus-members.html

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading

0 comments on commit 2b058dd

Please sign in to comment.