pax_global_header00006660000000000000000000000064122245740760014523gustar00rootroot0000000000000052 comment=6734c653b754d8c66a645bed97dde5c6c26a7fec libmodbus-3.0.5/000077500000000000000000000000001222457407600135105ustar00rootroot00000000000000libmodbus-3.0.5/.dir-locals.el000066400000000000000000000001401222457407600161340ustar00rootroot00000000000000((nil . ((indent-tabs-mode . nil) (c-basic-offset . 4) (fill-column . 80)))) libmodbus-3.0.5/.gitignore000066400000000000000000000010161222457407600154760ustar00rootroot00000000000000GPATH GRTAGS GSYMS GTAGS INSTALL Makefile Makefile.in aclocal.m4 autom4te.cache/ config.guess config.h config.h.in config.log config.status config.sub configure depcomp install-sh libtool ltmain.sh missing libmodbus.pc libmodbus.spec modbus-version.h .deps .libs *.la *.lo stamp-h1 *.o *~ tests/bandwidth-client tests/bandwidth-server-many-up tests/bandwidth-server-one tests/random-test-client tests/random-test-server tests/unit-test-client tests/unit-test.h tests/unit-test-server tests/version doc/*.html doc/*.3 doc/*.7 libmodbus-3.0.5/AUTHORS000066400000000000000000000001741222457407600145620ustar00rootroot00000000000000Stéphane Raimbault Tobias Doerffel Florian Forster libmodbus-3.0.5/COPYING000066400000000000000000001045131222457407600145470ustar00rootroot00000000000000 GNU GENERAL PUBLIC LICENSE Version 3, 29 June 2007 Copyright (C) 2007 Free Software Foundation, Inc. Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed. Preamble The GNU General Public License is a free, copyleft license for software and other kinds of works. The licenses for most software and other practical works are designed to take away your freedom to share and change the works. By contrast, the GNU General Public License is intended to guarantee your freedom to share and change all versions of a program--to make sure it remains free software for all its users. We, the Free Software Foundation, use the GNU General Public License for most of our software; it applies also to any other work released this way by its authors. You can apply it to your programs, too. When we speak of free software, we are referring to freedom, not price. Our General Public Licenses are designed to make sure that you have the freedom to distribute copies of free software (and charge for them if you wish), that you receive source code or can get it if you want it, that you can change the software or use pieces of it in new free programs, and that you know you can do these things. To protect your rights, we need to prevent others from denying you these rights or asking you to surrender the rights. Therefore, you have certain responsibilities if you distribute copies of the software, or if you modify it: responsibilities to respect the freedom of others. For example, if you distribute copies of such a program, whether gratis or for a fee, you must pass on to the recipients the same freedoms that you received. You must make sure that they, too, receive or can get the source code. And you must show them these terms so they know their rights. Developers that use the GNU GPL protect your rights with two steps: (1) assert copyright on the software, and (2) offer you this License giving you legal permission to copy, distribute and/or modify it. For the developers' and authors' protection, the GPL clearly explains that there is no warranty for this free software. For both users' and authors' sake, the GPL requires that modified versions be marked as changed, so that their problems will not be attributed erroneously to authors of previous versions. Some devices are designed to deny users access to install or run modified versions of the software inside them, although the manufacturer can do so. This is fundamentally incompatible with the aim of protecting users' freedom to change the software. The systematic pattern of such abuse occurs in the area of products for individuals to use, which is precisely where it is most unacceptable. Therefore, we have designed this version of the GPL to prohibit the practice for those products. If such problems arise substantially in other domains, we stand ready to extend this provision to those domains in future versions of the GPL, as needed to protect the freedom of users. Finally, every program is threatened constantly by software patents. States should not allow patents to restrict development and use of software on general-purpose computers, but in those that do, we wish to avoid the special danger that patents applied to a free program could make it effectively proprietary. To prevent this, the GPL assures that patents cannot be used to render the program non-free. The precise terms and conditions for copying, distribution and modification follow. TERMS AND CONDITIONS 0. Definitions. "This License" refers to version 3 of the GNU General Public License. "Copyright" also means copyright-like laws that apply to other kinds of works, such as semiconductor masks. "The Program" refers to any copyrightable work licensed under this License. Each licensee is addressed as "you". "Licensees" and "recipients" may be individuals or organizations. To "modify" a work means to copy from or adapt all or part of the work in a fashion requiring copyright permission, other than the making of an exact copy. The resulting work is called a "modified version" of the earlier work or a work "based on" the earlier work. A "covered work" means either the unmodified Program or a work based on the Program. To "propagate" a work means to do anything with it that, without permission, would make you directly or secondarily liable for infringement under applicable copyright law, except executing it on a computer or modifying a private copy. Propagation includes copying, distribution (with or without modification), making available to the public, and in some countries other activities as well. To "convey" a work means any kind of propagation that enables other parties to make or receive copies. Mere interaction with a user through a computer network, with no transfer of a copy, is not conveying. An interactive user interface displays "Appropriate Legal Notices" to the extent that it includes a convenient and prominently visible feature that (1) displays an appropriate copyright notice, and (2) tells the user that there is no warranty for the work (except to the extent that warranties are provided), that licensees may convey the work under this License, and how to view a copy of this License. If the interface presents a list of user commands or options, such as a menu, a prominent item in the list meets this criterion. 1. Source Code. The "source code" for a work means the preferred form of the work for making modifications to it. "Object code" means any non-source form of a work. A "Standard Interface" means an interface that either is an official standard defined by a recognized standards body, or, in the case of interfaces specified for a particular programming language, one that is widely used among developers working in that language. The "System Libraries" of an executable work include anything, other than the work as a whole, that (a) is included in the normal form of packaging a Major Component, but which is not part of that Major Component, and (b) serves only to enable use of the work with that Major Component, or to implement a Standard Interface for which an implementation is available to the public in source code form. A "Major Component", in this context, means a major essential component (kernel, window system, and so on) of the specific operating system (if any) on which the executable work runs, or a compiler used to produce the work, or an object code interpreter used to run it. The "Corresponding Source" for a work in object code form means all the source code needed to generate, install, and (for an executable work) run the object code and to modify the work, including scripts to control those activities. However, it does not include the work's System Libraries, or general-purpose tools or generally available free programs which are used unmodified in performing those activities but which are not part of the work. For example, Corresponding Source includes interface definition files associated with source files for the work, and the source code for shared libraries and dynamically linked subprograms that the work is specifically designed to require, such as by intimate data communication or control flow between those subprograms and other parts of the work. The Corresponding Source need not include anything that users can regenerate automatically from other parts of the Corresponding Source. The Corresponding Source for a work in source code form is that same work. 2. Basic Permissions. All rights granted under this License are granted for the term of copyright on the Program, and are irrevocable provided the stated conditions are met. This License explicitly affirms your unlimited permission to run the unmodified Program. The output from running a covered work is covered by this License only if the output, given its content, constitutes a covered work. This License acknowledges your rights of fair use or other equivalent, as provided by copyright law. You may make, run and propagate covered works that you do not convey, without conditions so long as your license otherwise remains in force. You may convey covered works to others for the sole purpose of having them make modifications exclusively for you, or provide you with facilities for running those works, provided that you comply with the terms of this License in conveying all material for which you do not control copyright. Those thus making or running the covered works for you must do so exclusively on your behalf, under your direction and control, on terms that prohibit them from making any copies of your copyrighted material outside their relationship with you. Conveying under any other circumstances is permitted solely under the conditions stated below. Sublicensing is not allowed; section 10 makes it unnecessary. 3. Protecting Users' Legal Rights From Anti-Circumvention Law. No covered work shall be deemed part of an effective technological measure under any applicable law fulfilling obligations under article 11 of the WIPO copyright treaty adopted on 20 December 1996, or similar laws prohibiting or restricting circumvention of such measures. When you convey a covered work, you waive any legal power to forbid circumvention of technological measures to the extent such circumvention is effected by exercising rights under this License with respect to the covered work, and you disclaim any intention to limit operation or modification of the work as a means of enforcing, against the work's users, your or third parties' legal rights to forbid circumvention of technological measures. 4. Conveying Verbatim Copies. You may convey verbatim copies of the Program's source code as you receive it, in any medium, provided that you conspicuously and appropriately publish on each copy an appropriate copyright notice; keep intact all notices stating that this License and any non-permissive terms added in accord with section 7 apply to the code; keep intact all notices of the absence of any warranty; and give all recipients a copy of this License along with the Program. You may charge any price or no price for each copy that you convey, and you may offer support or warranty protection for a fee. 5. Conveying Modified Source Versions. You may convey a work based on the Program, or the modifications to produce it from the Program, in the form of source code under the terms of section 4, provided that you also meet all of these conditions: a) The work must carry prominent notices stating that you modified it, and giving a relevant date. b) The work must carry prominent notices stating that it is released under this License and any conditions added under section 7. This requirement modifies the requirement in section 4 to "keep intact all notices". c) You must license the entire work, as a whole, under this License to anyone who comes into possession of a copy. This License will therefore apply, along with any applicable section 7 additional terms, to the whole of the work, and all its parts, regardless of how they are packaged. This License gives no permission to license the work in any other way, but it does not invalidate such permission if you have separately received it. d) If the work has interactive user interfaces, each must display Appropriate Legal Notices; however, if the Program has interactive interfaces that do not display Appropriate Legal Notices, your work need not make them do so. A compilation of a covered work with other separate and independent works, which are not by their nature extensions of the covered work, and which are not combined with it such as to form a larger program, in or on a volume of a storage or distribution medium, is called an "aggregate" if the compilation and its resulting copyright are not used to limit the access or legal rights of the compilation's users beyond what the individual works permit. Inclusion of a covered work in an aggregate does not cause this License to apply to the other parts of the aggregate. 6. Conveying Non-Source Forms. You may convey a covered work in object code form under the terms of sections 4 and 5, provided that you also convey the machine-readable Corresponding Source under the terms of this License, in one of these ways: a) Convey the object code in, or embodied in, a physical product (including a physical distribution medium), accompanied by the Corresponding Source fixed on a durable physical medium customarily used for software interchange. b) Convey the object code in, or embodied in, a physical product (including a physical distribution medium), accompanied by a written offer, valid for at least three years and valid for as long as you offer spare parts or customer support for that product model, to give anyone who possesses the object code either (1) a copy of the Corresponding Source for all the software in the product that is covered by this License, on a durable physical medium customarily used for software interchange, for a price no more than your reasonable cost of physically performing this conveying of source, or (2) access to copy the Corresponding Source from a network server at no charge. c) Convey individual copies of the object code with a copy of the written offer to provide the Corresponding Source. This alternative is allowed only occasionally and noncommercially, and only if you received the object code with such an offer, in accord with subsection 6b. d) Convey the object code by offering access from a designated place (gratis or for a charge), and offer equivalent access to the Corresponding Source in the same way through the same place at no further charge. You need not require recipients to copy the Corresponding Source along with the object code. If the place to copy the object code is a network server, the Corresponding Source may be on a different server (operated by you or a third party) that supports equivalent copying facilities, provided you maintain clear directions next to the object code saying where to find the Corresponding Source. Regardless of what server hosts the Corresponding Source, you remain obligated to ensure that it is available for as long as needed to satisfy these requirements. e) Convey the object code using peer-to-peer transmission, provided you inform other peers where the object code and Corresponding Source of the work are being offered to the general public at no charge under subsection 6d. A separable portion of the object code, whose source code is excluded from the Corresponding Source as a System Library, need not be included in conveying the object code work. A "User Product" is either (1) a "consumer product", which means any tangible personal property which is normally used for personal, family, or household purposes, or (2) anything designed or sold for incorporation into a dwelling. In determining whether a product is a consumer product, doubtful cases shall be resolved in favor of coverage. For a particular product received by a particular user, "normally used" refers to a typical or common use of that class of product, regardless of the status of the particular user or of the way in which the particular user actually uses, or expects or is expected to use, the product. A product is a consumer product regardless of whether the product has substantial commercial, industrial or non-consumer uses, unless such uses represent the only significant mode of use of the product. "Installation Information" for a User Product means any methods, procedures, authorization keys, or other information required to install and execute modified versions of a covered work in that User Product from a modified version of its Corresponding Source. The information must suffice to ensure that the continued functioning of the modified object code is in no case prevented or interfered with solely because modification has been made. If you convey an object code work under this section in, or with, or specifically for use in, a User Product, and the conveying occurs as part of a transaction in which the right of possession and use of the User Product is transferred to the recipient in perpetuity or for a fixed term (regardless of how the transaction is characterized), the Corresponding Source conveyed under this section must be accompanied by the Installation Information. But this requirement does not apply if neither you nor any third party retains the ability to install modified object code on the User Product (for example, the work has been installed in ROM). The requirement to provide Installation Information does not include a requirement to continue to provide support service, warranty, or updates for a work that has been modified or installed by the recipient, or for the User Product in which it has been modified or installed. Access to a network may be denied when the modification itself materially and adversely affects the operation of the network or violates the rules and protocols for communication across the network. Corresponding Source conveyed, and Installation Information provided, in accord with this section must be in a format that is publicly documented (and with an implementation available to the public in source code form), and must require no special password or key for unpacking, reading or copying. 7. Additional Terms. "Additional permissions" are terms that supplement the terms of this License by making exceptions from one or more of its conditions. Additional permissions that are applicable to the entire Program shall be treated as though they were included in this License, to the extent that they are valid under applicable law. If additional permissions apply only to part of the Program, that part may be used separately under those permissions, but the entire Program remains governed by this License without regard to the additional permissions. When you convey a copy of a covered work, you may at your option remove any additional permissions from that copy, or from any part of it. (Additional permissions may be written to require their own removal in certain cases when you modify the work.) You may place additional permissions on material, added by you to a covered work, for which you have or can give appropriate copyright permission. Notwithstanding any other provision of this License, for material you add to a covered work, you may (if authorized by the copyright holders of that material) supplement the terms of this License with terms: a) Disclaiming warranty or limiting liability differently from the terms of sections 15 and 16 of this License; or b) Requiring preservation of specified reasonable legal notices or author attributions in that material or in the Appropriate Legal Notices displayed by works containing it; or c) Prohibiting misrepresentation of the origin of that material, or requiring that modified versions of such material be marked in reasonable ways as different from the original version; or d) Limiting the use for publicity purposes of names of licensors or authors of the material; or e) Declining to grant rights under trademark law for use of some trade names, trademarks, or service marks; or f) Requiring indemnification of licensors and authors of that material by anyone who conveys the material (or modified versions of it) with contractual assumptions of liability to the recipient, for any liability that these contractual assumptions directly impose on those licensors and authors. All other non-permissive additional terms are considered "further restrictions" within the meaning of section 10. If the Program as you received it, or any part of it, contains a notice stating that it is governed by this License along with a term that is a further restriction, you may remove that term. If a license document contains a further restriction but permits relicensing or conveying under this License, you may add to a covered work material governed by the terms of that license document, provided that the further restriction does not survive such relicensing or conveying. If you add terms to a covered work in accord with this section, you must place, in the relevant source files, a statement of the additional terms that apply to those files, or a notice indicating where to find the applicable terms. Additional terms, permissive or non-permissive, may be stated in the form of a separately written license, or stated as exceptions; the above requirements apply either way. 8. Termination. You may not propagate or modify a covered work except as expressly provided under this License. Any attempt otherwise to propagate or modify it is void, and will automatically terminate your rights under this License (including any patent licenses granted under the third paragraph of section 11). However, if you cease all violation of this License, then your license from a particular copyright holder is reinstated (a) provisionally, unless and until the copyright holder explicitly and finally terminates your license, and (b) permanently, if the copyright holder fails to notify you of the violation by some reasonable means prior to 60 days after the cessation. Moreover, your license from a particular copyright holder is reinstated permanently if the copyright holder notifies you of the violation by some reasonable means, this is the first time you have received notice of violation of this License (for any work) from that copyright holder, and you cure the violation prior to 30 days after your receipt of the notice. Termination of your rights under this section does not terminate the licenses of parties who have received copies or rights from you under this License. If your rights have been terminated and not permanently reinstated, you do not qualify to receive new licenses for the same material under section 10. 9. Acceptance Not Required for Having Copies. You are not required to accept this License in order to receive or run a copy of the Program. Ancillary propagation of a covered work occurring solely as a consequence of using peer-to-peer transmission to receive a copy likewise does not require acceptance. However, nothing other than this License grants you permission to propagate or modify any covered work. These actions infringe copyright if you do not accept this License. Therefore, by modifying or propagating a covered work, you indicate your acceptance of this License to do so. 10. Automatic Licensing of Downstream Recipients. Each time you convey a covered work, the recipient automatically receives a license from the original licensors, to run, modify and propagate that work, subject to this License. You are not responsible for enforcing compliance by third parties with this License. An "entity transaction" is a transaction transferring control of an organization, or substantially all assets of one, or subdividing an organization, or merging organizations. If propagation of a covered work results from an entity transaction, each party to that transaction who receives a copy of the work also receives whatever licenses to the work the party's predecessor in interest had or could give under the previous paragraph, plus a right to possession of the Corresponding Source of the work from the predecessor in interest, if the predecessor has it or can get it with reasonable efforts. You may not impose any further restrictions on the exercise of the rights granted or affirmed under this License. For example, you may not impose a license fee, royalty, or other charge for exercise of rights granted under this License, and you may not initiate litigation (including a cross-claim or counterclaim in a lawsuit) alleging that any patent claim is infringed by making, using, selling, offering for sale, or importing the Program or any portion of it. 11. Patents. A "contributor" is a copyright holder who authorizes use under this License of the Program or a work on which the Program is based. The work thus licensed is called the contributor's "contributor version". A contributor's "essential patent claims" are all patent claims owned or controlled by the contributor, whether already acquired or hereafter acquired, that would be infringed by some manner, permitted by this License, of making, using, or selling its contributor version, but do not include claims that would be infringed only as a consequence of further modification of the contributor version. For purposes of this definition, "control" includes the right to grant patent sublicenses in a manner consistent with the requirements of this License. Each contributor grants you a non-exclusive, worldwide, royalty-free patent license under the contributor's essential patent claims, to make, use, sell, offer for sale, import and otherwise run, modify and propagate the contents of its contributor version. In the following three paragraphs, a "patent license" is any express agreement or commitment, however denominated, not to enforce a patent (such as an express permission to practice a patent or covenant not to sue for patent infringement). To "grant" such a patent license to a party means to make such an agreement or commitment not to enforce a patent against the party. If you convey a covered work, knowingly relying on a patent license, and the Corresponding Source of the work is not available for anyone to copy, free of charge and under the terms of this License, through a publicly available network server or other readily accessible means, then you must either (1) cause the Corresponding Source to be so available, or (2) arrange to deprive yourself of the benefit of the patent license for this particular work, or (3) arrange, in a manner consistent with the requirements of this License, to extend the patent license to downstream recipients. "Knowingly relying" means you have actual knowledge that, but for the patent license, your conveying the covered work in a country, or your recipient's use of the covered work in a country, would infringe one or more identifiable patents in that country that you have reason to believe are valid. If, pursuant to or in connection with a single transaction or arrangement, you convey, or propagate by procuring conveyance of, a covered work, and grant a patent license to some of the parties receiving the covered work authorizing them to use, propagate, modify or convey a specific copy of the covered work, then the patent license you grant is automatically extended to all recipients of the covered work and works based on it. A patent license is "discriminatory" if it does not include within the scope of its coverage, prohibits the exercise of, or is conditioned on the non-exercise of one or more of the rights that are specifically granted under this License. You may not convey a covered work if you are a party to an arrangement with a third party that is in the business of distributing software, under which you make payment to the third party based on the extent of your activity of conveying the work, and under which the third party grants, to any of the parties who would receive the covered work from you, a discriminatory patent license (a) in connection with copies of the covered work conveyed by you (or copies made from those copies), or (b) primarily for and in connection with specific products or compilations that contain the covered work, unless you entered into that arrangement, or that patent license was granted, prior to 28 March 2007. Nothing in this License shall be construed as excluding or limiting any implied license or other defenses to infringement that may otherwise be available to you under applicable patent law. 12. No Surrender of Others' Freedom. If conditions are imposed on you (whether by court order, agreement or otherwise) that contradict the conditions of this License, they do not excuse you from the conditions of this License. If you cannot convey a covered work so as to satisfy simultaneously your obligations under this License and any other pertinent obligations, then as a consequence you may not convey it at all. For example, if you agree to terms that obligate you to collect a royalty for further conveying from those to whom you convey the Program, the only way you could satisfy both those terms and this License would be to refrain entirely from conveying the Program. 13. Use with the GNU Affero General Public License. Notwithstanding any other provision of this License, you have permission to link or combine any covered work with a work licensed under version 3 of the GNU Affero General Public License into a single combined work, and to convey the resulting work. The terms of this License will continue to apply to the part which is the covered work, but the special requirements of the GNU Affero General Public License, section 13, concerning interaction through a network will apply to the combination as such. 14. Revised Versions of this License. The Free Software Foundation may publish revised and/or new versions of the GNU General Public License from time to time. Such new versions will be similar in spirit to the present version, but may differ in detail to address new problems or concerns. Each version is given a distinguishing version number. If the Program specifies that a certain numbered version of the GNU General Public License "or any later version" applies to it, you have the option of following the terms and conditions either of that numbered version or of any later version published by the Free Software Foundation. If the Program does not specify a version number of the GNU General Public License, you may choose any version ever published by the Free Software Foundation. If the Program specifies that a proxy can decide which future versions of the GNU General Public License can be used, that proxy's public statement of acceptance of a version permanently authorizes you to choose that version for the Program. Later license versions may give you additional or different permissions. However, no additional obligations are imposed on any author or copyright holder as a result of your choosing to follow a later version. 15. Disclaimer of Warranty. THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 16. Limitation of Liability. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. 17. Interpretation of Sections 15 and 16. If the disclaimer of warranty and limitation of liability provided above cannot be given local legal effect according to their terms, reviewing courts shall apply local law that most closely approximates an absolute waiver of all civil liability in connection with the Program, unless a warranty or assumption of liability accompanies a copy of the Program in return for a fee. END OF TERMS AND CONDITIONS How to Apply These Terms to Your New Programs If you develop a new program, and you want it to be of the greatest possible use to the public, the best way to achieve this is to make it free software which everyone can redistribute and change under these terms. To do so, attach the following notices to the program. It is safest to attach them to the start of each source file to most effectively state the exclusion of warranty; and each file should have at least the "copyright" line and a pointer to where the full notice is found. Copyright (C) This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with this program. If not, see . Also add information on how to contact you by electronic and paper mail. If the program does terminal interaction, make it output a short notice like this when it starts in an interactive mode: Copyright (C) This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. This is free software, and you are welcome to redistribute it under certain conditions; type `show c' for details. The hypothetical commands `show w' and `show c' should show the appropriate parts of the General Public License. Of course, your program's commands might be different; for a GUI interface, you would use an "about box". You should also get your employer (if you work as a programmer) or school, if any, to sign a "copyright disclaimer" for the program, if necessary. For more information on this, and how to apply and follow the GNU GPL, see . The GNU General Public License does not permit incorporating your program into proprietary programs. If your program is a subroutine library, you may consider it more useful to permit linking proprietary applications with the library. If this is what you want to do, use the GNU Lesser General Public License instead of this License. But first, please read . libmodbus-3.0.5/COPYING.LESSER000066400000000000000000000636421222457407600155520ustar00rootroot00000000000000 GNU LESSER GENERAL PUBLIC LICENSE Version 2.1, February 1999 Copyright (C) 1991, 1999 Free Software Foundation, Inc. 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed. [This is the first released version of the Lesser GPL. It also counts as the successor of the GNU Library Public License, version 2, hence the version number 2.1.] Preamble The licenses for most software are designed to take away your freedom to share and change it. By contrast, the GNU General Public Licenses are intended to guarantee your freedom to share and change free software--to make sure the software is free for all its users. This license, the Lesser General Public License, applies to some specially designated software packages--typically libraries--of the Free Software Foundation and other authors who decide to use it. You can use it too, but we suggest you first think carefully about whether this license or the ordinary General Public License is the better strategy to use in any particular case, based on the explanations below. When we speak of free software, we are referring to freedom of use, not price. Our General Public Licenses are designed to make sure that you have the freedom to distribute copies of free software (and charge for this service if you wish); that you receive source code or can get it if you want it; that you can change the software and use pieces of it in new free programs; and that you are informed that you can do these things. To protect your rights, we need to make restrictions that forbid distributors to deny you these rights or to ask you to surrender these rights. These restrictions translate to certain responsibilities for you if you distribute copies of the library or if you modify it. For example, if you distribute copies of the library, whether gratis or for a fee, you must give the recipients all the rights that we gave you. You must make sure that they, too, receive or can get the source code. If you link other code with the library, you must provide complete object files to the recipients, so that they can relink them with the library after making changes to the library and recompiling it. And you must show them these terms so they know their rights. We protect your rights with a two-step method: (1) we copyright the library, and (2) we offer you this license, which gives you legal permission to copy, distribute and/or modify the library. To protect each distributor, we want to make it very clear that there is no warranty for the free library. Also, if the library is modified by someone else and passed on, the recipients should know that what they have is not the original version, so that the original author's reputation will not be affected by problems that might be introduced by others. Finally, software patents pose a constant threat to the existence of any free program. We wish to make sure that a company cannot effectively restrict the users of a free program by obtaining a restrictive license from a patent holder. Therefore, we insist that any patent license obtained for a version of the library must be consistent with the full freedom of use specified in this license. Most GNU software, including some libraries, is covered by the ordinary GNU General Public License. This license, the GNU Lesser General Public License, applies to certain designated libraries, and is quite different from the ordinary General Public License. We use this license for certain libraries in order to permit linking those libraries into non-free programs. When a program is linked with a library, whether statically or using a shared library, the combination of the two is legally speaking a combined work, a derivative of the original library. The ordinary General Public License therefore permits such linking only if the entire combination fits its criteria of freedom. The Lesser General Public License permits more lax criteria for linking other code with the library. We call this license the "Lesser" General Public License because it does Less to protect the user's freedom than the ordinary General Public License. It also provides other free software developers Less of an advantage over competing non-free programs. These disadvantages are the reason we use the ordinary General Public License for many libraries. However, the Lesser license provides advantages in certain special circumstances. For example, on rare occasions, there may be a special need to encourage the widest possible use of a certain library, so that it becomes a de-facto standard. To achieve this, non-free programs must be allowed to use the library. A more frequent case is that a free library does the same job as widely used non-free libraries. In this case, there is little to gain by limiting the free library to free software only, so we use the Lesser General Public License. In other cases, permission to use a particular library in non-free programs enables a greater number of people to use a large body of free software. For example, permission to use the GNU C Library in non-free programs enables many more people to use the whole GNU operating system, as well as its variant, the GNU/Linux operating system. Although the Lesser General Public License is Less protective of the users' freedom, it does ensure that the user of a program that is linked with the Library has the freedom and the wherewithal to run that program using a modified version of the Library. The precise terms and conditions for copying, distribution and modification follow. Pay close attention to the difference between a "work based on the library" and a "work that uses the library". The former contains code derived from the library, whereas the latter must be combined with the library in order to run. GNU LESSER GENERAL PUBLIC LICENSE TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION 0. This License Agreement applies to any software library or other program which contains a notice placed by the copyright holder or other authorized party saying it may be distributed under the terms of this Lesser General Public License (also called "this License"). Each licensee is addressed as "you". A "library" means a collection of software functions and/or data prepared so as to be conveniently linked with application programs (which use some of those functions and data) to form executables. The "Library", below, refers to any such software library or work which has been distributed under these terms. A "work based on the Library" means either the Library or any derivative work under copyright law: that is to say, a work containing the Library or a portion of it, either verbatim or with modifications and/or translated straightforwardly into another language. (Hereinafter, translation is included without limitation in the term "modification".) "Source code" for a work means the preferred form of the work for making modifications to it. For a library, complete source code means all the source code for all modules it contains, plus any associated interface definition files, plus the scripts used to control compilation and installation of the library. Activities other than copying, distribution and modification are not covered by this License; they are outside its scope. The act of running a program using the Library is not restricted, and output from such a program is covered only if its contents constitute a work based on the Library (independent of the use of the Library in a tool for writing it). Whether that is true depends on what the Library does and what the program that uses the Library does. 1. You may copy and distribute verbatim copies of the Library's complete source code as you receive it, in any medium, provided that you conspicuously and appropriately publish on each copy an appropriate copyright notice and disclaimer of warranty; keep intact all the notices that refer to this License and to the absence of any warranty; and distribute a copy of this License along with the Library. You may charge a fee for the physical act of transferring a copy, and you may at your option offer warranty protection in exchange for a fee. 2. You may modify your copy or copies of the Library or any portion of it, thus forming a work based on the Library, and copy and distribute such modifications or work under the terms of Section 1 above, provided that you also meet all of these conditions: a) The modified work must itself be a software library. b) You must cause the files modified to carry prominent notices stating that you changed the files and the date of any change. c) You must cause the whole of the work to be licensed at no charge to all third parties under the terms of this License. d) If a facility in the modified Library refers to a function or a table of data to be supplied by an application program that uses the facility, other than as an argument passed when the facility is invoked, then you must make a good faith effort to ensure that, in the event an application does not supply such function or table, the facility still operates, and performs whatever part of its purpose remains meaningful. (For example, a function in a library to compute square roots has a purpose that is entirely well-defined independent of the application. Therefore, Subsection 2d requires that any application-supplied function or table used by this function must be optional: if the application does not supply it, the square root function must still compute square roots.) These requirements apply to the modified work as a whole. If identifiable sections of that work are not derived from the Library, and can be reasonably considered independent and separate works in themselves, then this License, and its terms, do not apply to those sections when you distribute them as separate works. But when you distribute the same sections as part of a whole which is a work based on the Library, the distribution of the whole must be on the terms of this License, whose permissions for other licensees extend to the entire whole, and thus to each and every part regardless of who wrote it. Thus, it is not the intent of this section to claim rights or contest your rights to work written entirely by you; rather, the intent is to exercise the right to control the distribution of derivative or collective works based on the Library. In addition, mere aggregation of another work not based on the Library with the Library (or with a work based on the Library) on a volume of a storage or distribution medium does not bring the other work under the scope of this License. 3. You may opt to apply the terms of the ordinary GNU General Public License instead of this License to a given copy of the Library. To do this, you must alter all the notices that refer to this License, so that they refer to the ordinary GNU General Public License, version 2, instead of to this License. (If a newer version than version 2 of the ordinary GNU General Public License has appeared, then you can specify that version instead if you wish.) Do not make any other change in these notices. Once this change is made in a given copy, it is irreversible for that copy, so the ordinary GNU General Public License applies to all subsequent copies and derivative works made from that copy. This option is useful when you wish to copy part of the code of the Library into a program that is not a library. 4. You may copy and distribute the Library (or a portion or derivative of it, under Section 2) in object code or executable form under the terms of Sections 1 and 2 above provided that you accompany it with the complete corresponding machine-readable source code, which must be distributed under the terms of Sections 1 and 2 above on a medium customarily used for software interchange. If distribution of object code is made by offering access to copy from a designated place, then offering equivalent access to copy the source code from the same place satisfies the requirement to distribute the source code, even though third parties are not compelled to copy the source along with the object code. 5. A program that contains no derivative of any portion of the Library, but is designed to work with the Library by being compiled or linked with it, is called a "work that uses the Library". Such a work, in isolation, is not a derivative work of the Library, and therefore falls outside the scope of this License. However, linking a "work that uses the Library" with the Library creates an executable that is a derivative of the Library (because it contains portions of the Library), rather than a "work that uses the library". The executable is therefore covered by this License. Section 6 states terms for distribution of such executables. When a "work that uses the Library" uses material from a header file that is part of the Library, the object code for the work may be a derivative work of the Library even though the source code is not. Whether this is true is especially significant if the work can be linked without the Library, or if the work is itself a library. The threshold for this to be true is not precisely defined by law. If such an object file uses only numerical parameters, data structure layouts and accessors, and small macros and small inline functions (ten lines or less in length), then the use of the object file is unrestricted, regardless of whether it is legally a derivative work. (Executables containing this object code plus portions of the Library will still fall under Section 6.) Otherwise, if the work is a derivative of the Library, you may distribute the object code for the work under the terms of Section 6. Any executables containing that work also fall under Section 6, whether or not they are linked directly with the Library itself. 6. As an exception to the Sections above, you may also combine or link a "work that uses the Library" with the Library to produce a work containing portions of the Library, and distribute that work under terms of your choice, provided that the terms permit modification of the work for the customer's own use and reverse engineering for debugging such modifications. You must give prominent notice with each copy of the work that the Library is used in it and that the Library and its use are covered by this License. You must supply a copy of this License. If the work during execution displays copyright notices, you must include the copyright notice for the Library among them, as well as a reference directing the user to the copy of this License. Also, you must do one of these things: a) Accompany the work with the complete corresponding machine-readable source code for the Library including whatever changes were used in the work (which must be distributed under Sections 1 and 2 above); and, if the work is an executable linked with the Library, with the complete machine-readable "work that uses the Library", as object code and/or source code, so that the user can modify the Library and then relink to produce a modified executable containing the modified Library. (It is understood that the user who changes the contents of definitions files in the Library will not necessarily be able to recompile the application to use the modified definitions.) b) Use a suitable shared library mechanism for linking with the Library. A suitable mechanism is one that (1) uses at run time a copy of the library already present on the user's computer system, rather than copying library functions into the executable, and (2) will operate properly with a modified version of the library, if the user installs one, as long as the modified version is interface-compatible with the version that the work was made with. c) Accompany the work with a written offer, valid for at least three years, to give the same user the materials specified in Subsection 6a, above, for a charge no more than the cost of performing this distribution. d) If distribution of the work is made by offering access to copy from a designated place, offer equivalent access to copy the above specified materials from the same place. e) Verify that the user has already received a copy of these materials or that you have already sent this user a copy. For an executable, the required form of the "work that uses the Library" must include any data and utility programs needed for reproducing the executable from it. However, as a special exception, the materials to be distributed need not include anything that is normally distributed (in either source or binary form) with the major components (compiler, kernel, and so on) of the operating system on which the executable runs, unless that component itself accompanies the executable. It may happen that this requirement contradicts the license restrictions of other proprietary libraries that do not normally accompany the operating system. Such a contradiction means you cannot use both them and the Library together in an executable that you distribute. 7. You may place library facilities that are a work based on the Library side-by-side in a single library together with other library facilities not covered by this License, and distribute such a combined library, provided that the separate distribution of the work based on the Library and of the other library facilities is otherwise permitted, and provided that you do these two things: a) Accompany the combined library with a copy of the same work based on the Library, uncombined with any other library facilities. This must be distributed under the terms of the Sections above. b) Give prominent notice with the combined library of the fact that part of it is a work based on the Library, and explaining where to find the accompanying uncombined form of the same work. 8. You may not copy, modify, sublicense, link with, or distribute the Library except as expressly provided under this License. Any attempt otherwise to copy, modify, sublicense, link with, or distribute the Library is void, and will automatically terminate your rights under this License. However, parties who have received copies, or rights, from you under this License will not have their licenses terminated so long as such parties remain in full compliance. 9. You are not required to accept this License, since you have not signed it. However, nothing else grants you permission to modify or distribute the Library or its derivative works. These actions are prohibited by law if you do not accept this License. Therefore, by modifying or distributing the Library (or any work based on the Library), you indicate your acceptance of this License to do so, and all its terms and conditions for copying, distributing or modifying the Library or works based on it. 10. Each time you redistribute the Library (or any work based on the Library), the recipient automatically receives a license from the original licensor to copy, distribute, link with or modify the Library subject to these terms and conditions. You may not impose any further restrictions on the recipients' exercise of the rights granted herein. You are not responsible for enforcing compliance by third parties with this License. 11. If, as a consequence of a court judgment or allegation of patent infringement or for any other reason (not limited to patent issues), conditions are imposed on you (whether by court order, agreement or otherwise) that contradict the conditions of this License, they do not excuse you from the conditions of this License. If you cannot distribute so as to satisfy simultaneously your obligations under this License and any other pertinent obligations, then as a consequence you may not distribute the Library at all. For example, if a patent license would not permit royalty-free redistribution of the Library by all those who receive copies directly or indirectly through you, then the only way you could satisfy both it and this License would be to refrain entirely from distribution of the Library. If any portion of this section is held invalid or unenforceable under any particular circumstance, the balance of the section is intended to apply, and the section as a whole is intended to apply in other circumstances. It is not the purpose of this section to induce you to infringe any patents or other property right claims or to contest validity of any such claims; this section has the sole purpose of protecting the integrity of the free software distribution system which is implemented by public license practices. Many people have made generous contributions to the wide range of software distributed through that system in reliance on consistent application of that system; it is up to the author/donor to decide if he or she is willing to distribute software through any other system and a licensee cannot impose that choice. This section is intended to make thoroughly clear what is believed to be a consequence of the rest of this License. 12. If the distribution and/or use of the Library is restricted in certain countries either by patents or by copyrighted interfaces, the original copyright holder who places the Library under this License may add an explicit geographical distribution limitation excluding those countries, so that distribution is permitted only in or among countries not thus excluded. In such case, this License incorporates the limitation as if written in the body of this License. 13. The Free Software Foundation may publish revised and/or new versions of the Lesser General Public License from time to time. Such new versions will be similar in spirit to the present version, but may differ in detail to address new problems or concerns. Each version is given a distinguishing version number. If the Library specifies a version number of this License which applies to it and "any later version", you have the option of following the terms and conditions either of that version or of any later version published by the Free Software Foundation. If the Library does not specify a license version number, you may choose any version ever published by the Free Software Foundation. 14. If you wish to incorporate parts of the Library into other free programs whose distribution conditions are incompatible with these, write to the author to ask for permission. For software which is copyrighted by the Free Software Foundation, write to the Free Software Foundation; we sometimes make exceptions for this. Our decision will be guided by the two goals of preserving the free status of all derivatives of our free software and of promoting the sharing and reuse of software generally. NO WARRANTY 15. BECAUSE THE LIBRARY IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY FOR THE LIBRARY, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE LIBRARY "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE LIBRARY IS WITH YOU. SHOULD THE LIBRARY PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 16. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR REDISTRIBUTE THE LIBRARY AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE LIBRARY (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE LIBRARY TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. END OF TERMS AND CONDITIONS How to Apply These Terms to Your New Libraries If you develop a new library, and you want it to be of the greatest possible use to the public, we recommend making it free software that everyone can redistribute and change. You can do so by permitting redistribution under these terms (or, alternatively, under the terms of the ordinary General Public License). To apply these terms, attach the following notices to the library. It is safest to attach them to the start of each source file to most effectively convey the exclusion of warranty; and each file should have at least the "copyright" line and a pointer to where the full notice is found. Copyright (C) This library is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation; either version 2.1 of the License, or (at your option) any later version. This library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details. You should have received a copy of the GNU Lesser General Public License along with this library; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA Also add information on how to contact you by electronic and paper mail. You should also get your employer (if you work as a programmer) or your school, if any, to sign a "copyright disclaimer" for the library, if necessary. Here is a sample; alter the names: Yoyodyne, Inc., hereby disclaims all copyright interest in the library `Frob' (a library for tweaking knobs) written by James Random Hacker. , 1 April 1990 Ty Coon, President of Vice That's all there is to it! libmodbus-3.0.5/MIGRATION000066400000000000000000000033641222457407600147720ustar00rootroot00000000000000============================================= Migration notes from the 2.0 series (for 3.0) ============================================= The 3.0 release use a brand new API and this document covers only the general changes: - the structure modbus_param_t is gone and is replaced by a new opaque and dynamically allocated structure modbus_t. - the slave argument is no more an argument of the Modbus functions, you need to call modbus_set_slave first. - the public header file is smaller so some internal defines aren't accessible anymore. - all function and constants are respectively prefixed by modbus_ or MODBUS_. - the POSIX error conventions are used (if an error occured, -1 or NULL is returned and errno is set accordingly). - coil status and discretes inputs are just bits and force/preset actions have been renamed to write actions. We hope you'll enjoy the new API to accept the migration burden! ============================================= Migration notes from the 1.2 series (for 2.0) ============================================= Init ==== modbus_init_tcp requires a third new argument, the port number. modbus_init_tcp(modbus_param_t *mb_param, char *ip_address, int port) Set the port to MODBUS_TCP_DEFAULT_PORT to use the default one (502). It's convenient to use a port number greater than or equal to 1024 because it's not necessary to be root to use this port number. Pointers of data ================ The coil and input status are now stored in an array of type uint8_t (in 1.2.X series, array of type int was used). So now, you need to pass a pointer of type uint8_t to use read_coil_status(), for example. The holding and input registers are now stored in an array of type uint16_t. These changes reduce the memory consumption. libmodbus-3.0.5/Makefile.am000066400000000000000000000002431222457407600155430ustar00rootroot00000000000000ACLOCAL_AMFLAGS = -I m4 EXTRA_DIST = MIGRATION README.rst libmodbus.spec SUBDIRS = src doc tests pkgconfigdir = $(libdir)/pkgconfig pkgconfig_DATA = libmodbus.pc libmodbus-3.0.5/NEWS000066400000000000000000000265151222457407600142200ustar00rootroot00000000000000libmodbus 3.0.5 (2013-10-06) ============================ - Fix remote buffer overflow vulnerability - Fix receiving of incorrect queries in write_single libmodbus 3.0.4 (2012-05-08) ============================ - autogen.sh creates symlinks instead of copies - Add missing m4 directory (closes #103) - Fix alignment problem on ARMv5 platform Thanks to Alexander Dahl - Remove useless test on error_recovery argument Thanks to Carlos Tangerino libmodbus 3.0.3 (2012-05-25) ============================ - Fix another Visual C++ 2008/2010 deficiency (closes #53) - Add -lsocket to compile on QNX - Fix TCP PI init under Windows. Thanks to oldfaber. - Fix a missing free in random-test-client Thanks again to Stefan Finzel. - Fix OMG bug in modbus_mapping_free not freeing memory. Thanks to Stefan Finzel for the bug report. - Fix semicolon typo and unistd.h include under Windows. Thanks to Andrew Kravchuk. libmodbus 3.0.2 (2012-01-16) ============================ - Update Debian package - Documentation fixes and additions - Add missing C++ macros in public headers. Thanks to Bernhard Agthe. - Protects modbus_mapping_free against NULL argument. Thanks to Andrea Mattia - Fix check on file doc/libmodbus.7 in acinclude.m4 (closes #28) - Close file descriptor when the settings don't apply in RTU. Original patch provided by Thomas Stalder. - unit-test.h is now generated to avoid config.h dependency. - Request for Windows Sockets specification version 2.2 instead of 2.0 Thanks to Pavel Mazniker for the report. libmodbus 3.0.1 (2011-07-18) ============================ - Avoid useless serial_mode integer when TIOCSRS485 isn't supported - Fix compilation failure on Windows (RS485 support) by Tobias Doerffel - Properly check TIOCSRS485 define by Matthijs Kool - Rename package to libmodbus5 to fix lintian warning libmodbus 3.0.0 (2011-07-11) ============================ - Revert libmodbus licence from LGPLv3 to LGPLv2.1 to avoid incompatibility with GPLv2 program. This change has been approved by Tobias Doerffel, Florian octo Forster and Hannu Vuolasaho. - Enable RS485 support only when available - Export modbus_set/get_serial_mode functions on all platforms - API change for read/write multiple registers function: * modbus_read_and_write_registers -> modbus_write_and_read_registers The function name was confusing because the write operation is performed before the read. Take care to swap the arguments in the migration process. - Documentation of modbus_write_and_read_registers, modbus_mapping_new/free, report_slave_id. modbus_get_byte_from_bits, modbus_set_bits_from_byte(s), modbus_[gs]et_float, modbus_reply and modbus_reply_exception. - Enhanced report slave ID - New RPM spec file to package documentation and development files libmodbus 2.9.4 (2011-06-05) ============================ - IPv6 support Make the TCP implementation "protocol independent" by Florian Forster and Stéphane Raimbault. - Fix compilation on Windows 7 (x64) with MinGW/MSYS and GCC 4.5 Reported by Patsy Kaye. - Documentation of libmodbus functions with AsciiDoc (man and HTML) by Stéphane Raimbault - Avoid an iteration in flush function - New functions to send and receive raw requests (modbus_send_raw_request, modbus_receive_confirmation) - Fix flush function of TCP backend on Windows - API changes for server/slave: * modbus_receive doesn't take socket/fd argument anymore * new function modbus_set_socket to set socket/fd - API changes for timeout functions: * modbus_get_timeout_begin -> modbus_get_response_timeout * modbus_set_timeout_begin -> modbus_set_response_timeout * modbus_get_timeout_end -> modbus_get_byte_timeout * modbus_set_timeout_end -> modbus_set_byte_timeout - Fix longstanding limitation of server to wait forever - New functions modbus_set/get_serial_mode by Manfred Gruber and Stéphane Raimbault for RS485 communications - Improved recovery mode (see modbus_set_error_recovery documentation) for data link and protocol errors. - Fix compilation issue with Microsoft Visual Studio 2008. Reported by Allan Cornet. libmodbus 2.9.3 (2011-01-14) ============================ - Major rewriting of the message reading (no more timeouts on exception) by Stéphane Raimbault - New function to reply to an indication with an exception message modbus_reply_exception() - New function modbus_get_header_length(modbus_t *ctx) - New functions to manipulate data: * MODBUS_GET_INT32_FROM_INT16 * MODBUS_GET_INT16_FROM_INT8 * MODBUS_SET_INT16_TO_INT8 - Fix GH-2. Read/write were swapped in _FC_READ_AND_WRITE_REGISTERS - Install an ignore handler for SIGPIPE on *BSD Original patch by Jason Oster. - Fix closing of Win32 socket. Reported by Petr Parýzek. - Fix unit identifier not copied by the TCP server. Reported by Antti Manninen. - Fix missing modbus_flush() in unit tests - Fixes for OpenBSD by Barry Grumbine and Jason Oster libmodbus 2.9.2 (2010-12-05) ============================ - Win32 support by Tobias Doerffel - Split source code around RTU and TCP (backends) - Rename modbus_[listen|accept] to modbus_tcp_[listen|accept] - Remove slave argument from modbus_new_rtu() - Check received function code - Fix segfault in bandwidth-server-many-up on inet_ntoa() call - Fix unit test of report slave ID in RTU - Fix GH-3. Remove inclusion of config.h in modbus.h - Correctly detect if we are cross-compiling for win32 by Kirill Smelkov. - Fix setting of the broadcast address libmodbus 2.9.1 (2010-08-16) ============================ - Brand new API (see MIGRATION notes)! - Remove the internal function set_message_length_tcp - Restore slave ID (server ID) argument in functions - Error conventions of POSIX systems and error recover - Parity setting is now a single char ('N', 'E' or 'O') - Report slave ID server side - OpenBSD support by Anibal Limón. - New read and write registers function by Hannu Vuolasaho. - Versioning infrastructure Inspired by the Clutter project and the work done by Florian Forster. - Fix the broadcast constant (255 -> 0) Reported by David Olivari. - Fix #463299 - New functions to define the timeouts of begin and end of trame Original patch by Sisyph (eric-paul). - Fix #591142 - Slave id check should be disabled in TCP connection Reported by aladdinwu. libmodbus 2.1.0 (2010-03-24) ============================ - New API to read and write float values by Stéphane Raimbault and Florian Forster. - New API for slave server (see MIGRATION) - New slave server able to handle multiple connections - Slave only replies to broadcast queries or queries with its slave ID - Improved Modbus protocol conformance - modbus_param_t is smaller (2 int removed) - Better error management and SIGPIPE signal is blocked - Faster - Fix #333455 - Cygwin IPTOS_LOWDELAY not supported on cygwin Reported by Jeff Laughlin and Yishin Li. - Fix #375926 - modbus.c:164: error: `MSG_DONTWAIT' undeclared Reported and tested by Yishin Li. - Fix #378981 - CRC error on RTU response doesn't return negative value Reported by Henrik Munktell. - Fix report slave ID request Patch (bzr) provided by Paul Fertser. - Fix #425604 - Conditional jump or move depends on uninitialised value(s) Occurs on first occurence of slave timeout. Reported by Henrik Munktell. - Fix #457200 - FreeBSD support Patch provided by Norbert Koch. Other changes: - The code is now published and developed on http://github.com/stephane/libmodbus - Waf support has been removed libmodbus 2.0.3 (2009-03-22) ============================ - Fix CRC error when a slave RTU send a response. Thanks to Justin Carroll to have reported and tested my patch. - Remove an assignment in compute_response_length() - Remove duplicate counter in read_io_status() - Fix #274511 reported by 'Kylesch' Invalid error check in modbus_init_listen_tcp libmodbus 2.0.2 (2008-08-10) ============================ - Fix a bug reported by email by Davide Pippa The function modbus_receive must check the number of values indicated in the response accordingly to the query. - Fix #241006 reported by Jesus Hernandez Tapia modbus_check_response() crashes on an invalid exception code - Reduce the number of function calls (read_reg_response and preset_response have been removed) - Add a new unit test for bad response - Catch the timeout even if the length is equal to a exception trame - Test only msg_length_computed on change - Many comments and cleanups libmodbus 2.0.1 (2008-07-02) ============================ - Include libmodbus.spec in the tarball - Fix #241006 reported by Jesus Hernandez Tapia modbus_check_response() crashes on an invalid exception code libmodbus 2.0.0 (2008-05-18) ============================ - Slave API https://blueprints.launchpad.net/libmodbus/+spec/slave-api - No more glib dependency https://blueprints.launchpad.net/libmodbus/+spec/glib-dependency - Unit testing and many test programs - Waf build support https://blueprints.launchpad.net/libmodbus/+spec/waf-support - MacOS X support by Matthew Butch https://blueprints.launchpad.net/libmodbus/+spec/macosx-support - Unit testing (unit-test-slave and unit-test-master) - Port number is now defined at initialisation by Dirk Reusch - Better memory management (uint8_t *data and packing of modbus_param_t) - Better error management - Declare many static functions and const arrays - Enhance an integer division - The GNU licences LGPL and GPL are in version 3 - Debian and RPM packages (#224496) - Many cleanups - Fix #159443 reported by Stefan Bisanz Index of incoming data in force multiple coils function - Fix #161989 reported by Konstantinos Togias Serial device paths more than 10 chars long (eg. /dev/ttyUSB0) don't fit to modbus_param_t -> device char[11] var. - Fix #188189 reported by Chris Hellyar Compute_response_size() no entry for read_input_status() - Fix #191039 reported by Todd Denniston modbus.h is not installed at prefix. - Fix #211460 reported by Todd Denniston With TCP, automatic reconnect on error may not be desired. - Fix #224485 reported by Todd Denniston libmodbus does not link with c++ code. - Fix #224496 reported by Todd Denniston It is easier to install on rpm based systems with a spec file. libmodbus 1.2.5 (2008-05-18) ============================ - Fix #224485 reported by Todd Denniston libmodbus does not link with c++ code. libmodbus 1.2.4 (2008-03-14) ============================ - Fix #191039 reported by Todd Denniston modbus.h is not installed at prefix. libmodbus 1.2.3 (2008-02-03) ============================ - Fix #188189 reported by Chris Hellyar Compute_response_size() no entry for read_input_status() - Fix #181887 reported by Jesus Hernandez Tapia. Slave address in build_request_packet_tcp() is hardcoded as 0xFF. libmodbus 1.2.2 (2007-11-12) ============================ - Fix #161989 reported by Konstantinos Togias Serial device paths more than 10 chars long (eg. /dev/ttyUSB0) don't fit to modbus_param_t -> device char[11] var. - Structure is also bit better 'packed' to conserve memory (see the trunk for a real enhancement). libmodbus 1.2.1 (2007-11-02) ============================ - Fix #159443 reported by Stefan Bisanz Index of incoming data in force multiple coils function - Deleted useless code in check_crc16() - Untabify source code - Changed author's email to Stéphane Raimbault libmodbus 1.2.0 (2007-05-10) ============================ - FIX Compilation GCC-4.0 - Project name in autogen.sh libmodbus-3.0.5/README.rst000066400000000000000000000027311222457407600152020ustar00rootroot00000000000000========================= 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 Schneider at www.schneiderautomation.com. The license of libmodbus is LGPL v2.1 or later and the licence of programs in tests directory is GPL v3. The documentation is available under the Creative Commons Attribution-ShareAlike License 3.0 (Unported) (http://creativecommons.org/licenses/by-sa/3.0/). The official website is http://www.libmodbus.org. The library is written in C and designed to run on Linux, Mac OS X, FreeBSD and QNX and Windows. Installation ------------ The shell commands are ``./autogen.sh; ./configure; make; make install``. If you want to compile with Microsoft Visual Studio, you need to install http://code.google.com/p/msinttypes/ to fill the absence of stdint.h. Testing ------- Some tests are provided in the ``tests`` directory, you can freely edit the source code to fit your needs (it's Free Sofware :). See ``tests/README`` for a description of each program. Report a Bug ------------ To report a bug, you can: * fill a bug report on the issue tracker http://github.com/stephane/libmodbus/issues * or send an email to stephane.raimbault@gmail.com libmodbus-3.0.5/acinclude.m4000066400000000000000000000042051222457407600157020ustar00rootroot00000000000000dnl ############################################################################## dnl # AC_LIBMODBUS_CHECK_DOC_BUILD # dnl # Check whether to build documentation and install man-pages # dnl ############################################################################## AC_DEFUN([AC_LIBMODBUS_CHECK_DOC_BUILD], [{ # Allow user to disable doc build AC_ARG_WITH([documentation], [AS_HELP_STRING([--without-documentation], [disable documentation build even if asciidoc and xmlto are present [default=no]])]) if test "x$with_documentation" = "xno"; then ac_libmodbus_build_doc="no" ac_libmodbus_install_man="no" else # Determine whether or not documentation should be built and installed. ac_libmodbus_build_doc="yes" ac_libmodbus_install_man="yes" # Check for asciidoc and xmlto and don't build the docs if these are not installed. AC_CHECK_PROG(ac_libmodbus_have_asciidoc, asciidoc, yes, no) AC_CHECK_PROG(ac_libmodbus_have_xmlto, xmlto, yes, no) if test "x$ac_libmodbus_have_asciidoc" = "xno" -o "x$ac_libmodbus_have_xmlto" = "xno"; then ac_libmodbus_build_doc="no" # Tarballs built with 'make dist' ship with prebuilt documentation. if ! test -f doc/libmodbus.7; then ac_libmodbus_install_man="no" AC_MSG_WARN([You are building an unreleased version of libmodbus and asciidoc or xmlto are not installed.]) AC_MSG_WARN([Documentation will not be built and manual pages will not be installed.]) fi fi # Do not install man pages if on mingw if test "x$ac_libmodbus_on_mingw32" = "xyes"; then ac_libmodbus_install_man="no" fi fi AC_MSG_CHECKING([whether to build documentation]) AC_MSG_RESULT([$ac_libmodbus_build_doc]) AC_MSG_CHECKING([whether to install manpages]) AC_MSG_RESULT([$ac_libmodbus_install_man]) AM_CONDITIONAL(BUILD_DOC, test "x$ac_libmodbus_build_doc" = "xyes") AM_CONDITIONAL(INSTALL_MAN, test "x$ac_libmodbus_install_man" = "xyes") }]) libmodbus-3.0.5/autogen.sh000077500000000000000000000000621222457407600155070ustar00rootroot00000000000000#! /bin/sh autoreconf --install --symlink --force libmodbus-3.0.5/configure.ac000066400000000000000000000074771222457407600160150ustar00rootroot00000000000000# libmodbus package version number, (as distinct from shared library version) # An odd micro number indicates in-progress development from Git # An even micro number indicates a released version # # Making a point release: # - increase libmodbus_version_micro to the next even number # # After the release: # - increase libmodbus_version_minor to the next odd number # # Take care to update the libtool versioning when required (LIBMODBUS_LD_*). # http://www.gnu.org/software/libtool/manual/html_node/Libtool-versioning.html # m4_define([libmodbus_version_major], [3]) m4_define([libmodbus_version_minor], [0]) m4_define([libmodbus_version_micro], [5]) m4_define([libmodbus_release_status], [m4_if(m4_eval(libmodbus_version_minor % 2), [1], [snapshot], [release])]) m4_define([libmodbus_version], [libmodbus_version_major.libmodbus_version_minor.libmodbus_version_micro]) AC_PREREQ([2.63]) AC_INIT([libmodbus],[libmodbus_version],[https://github.com/stephane/libmodbus/issues]) AC_CONFIG_HEADERS([config.h tests/unit-test.h]) AC_CONFIG_MACRO_DIR([m4]) AM_INIT_AUTOMAKE([foreign]) # enable nice build output on automake1.11 m4_ifdef([AM_SILENT_RULES],[AM_SILENT_RULES([yes])]) LIBMODBUS_VERSION_MAJOR=libmodbus_version_major LIBMODBUS_VERSION_MINOR=libmodbus_version_minor LIBMODBUS_VERSION_MICRO=libmodbus_version_micro LIBMODBUS_VERSION=libmodbus_version AC_SUBST(LIBMODBUS_VERSION_MAJOR) AC_SUBST(LIBMODBUS_VERSION_MINOR) AC_SUBST(LIBMODBUS_VERSION_MICRO) AC_SUBST(LIBMODBUS_VERSION) # ABI version # http://www.gnu.org/software/libtool/manual/html_node/Updating-version-info.html LIBMODBUS_LD_CURRENT=5 LIBMODBUS_LD_REVISION=4 LIBMODBUS_LD_AGE=0 LIBMODBUS_LT_VERSION_INFO=$LIBMODBUS_LD_CURRENT:$LIBMODBUS_LD_REVISION:$LIBMODBUS_LD_AGE AC_SUBST(LIBMODBUS_LT_VERSION_INFO) AC_CANONICAL_HOST # Check whether we are building for Win32 os_win32="false" case "${host_os}" in *mingw32*) os_win32="true" ;; *nto-qnx*) os_qnx="true" ;; esac AM_CONDITIONAL(OS_WIN32, test "$os_win32" = "true") AM_CONDITIONAL(OS_QNX, test "$os_qnx" = "true") # Checks for programs. AC_PROG_CC AC_PROG_CXX AC_PROG_MAKE_SET LT_INIT([disable-static win32-dll]) AC_CHECK_HEADERS([ \ termios.h \ sys/time.h \ time.h \ unistd.h \ errno.h \ limits.h \ fcntl.h \ sys/types.h \ sys/socket.h \ sys/ioctl.h \ netinet/in.h \ netinet/tcp.h \ arpa/inet.h \ netdb.h \ linux/serial.h \ ]) # Check whether to build docs / install man pages AC_LIBMODBUS_CHECK_DOC_BUILD # Checks for header files. AC_HEADER_STDC # Checks for typedefs, structures, and compiler characteristics. AC_C_CONST AC_TYPE_SIZE_T AC_HEADER_TIME # AC_TYPE_UINT*_T: not supported by autoconf-2.59 of CentOS 5.3 # AC_TYPE_UINT16_T # AC_TYPE_UINT32_T # AC_TYPE_UINT8_T # Cygwin defines IPTOS_LOWDELAY but can't handle that flag so it's necessary to # workaround that problem and Cygwin doesn't define MSG_DONTWAIT. AC_CHECK_DECLS([__CYGWIN__]) # Checks for library functions. AC_FUNC_FORK AC_CHECK_FUNCS([gettimeofday inet_ntoa memset select socket strerror strlcpy getaddrinfo]) # Add -Wall -Werror for GCC if not already there if test "x$GCC" = "xyes"; then case " $CFLAGS " in *[[\ \ ]]-Wall[[\ \ ]]*) ;; *) CFLAGS="$CFLAGS -Wall" ;; esac fi if test "x$GCC" = "xyes"; then case " $CFLAGS " in *[[\ \ ]]-Werror[[\ \ ]]*) ;; *) CFLAGS="$CFLAGS -Werror" ;; esac fi # Required for getaddrinfo (TCP PI - IPv6) AC_CHECK_HEADERS([winsock2.h], HAVE_WINSOCK2_H=yes) if test "x$HAVE_WINSOCK2_H" = "xyes"; then LIBS="$LIBS -lws2_32" AC_SUBST(LIBS) fi # Check for RS485 support (Linux kernel version 2.6.28+) AC_CHECK_DECLS([TIOCSRS485], [], [], [[#include ]]) AC_CONFIG_FILES([ Makefile src/Makefile src/modbus-version.h doc/Makefile tests/Makefile libmodbus.pc libmodbus.spec ]) AC_OUTPUT libmodbus-3.0.5/doc/000077500000000000000000000000001222457407600142555ustar00rootroot00000000000000libmodbus-3.0.5/doc/Makefile.am000066400000000000000000000042451222457407600163160ustar00rootroot00000000000000MAN3 = \ modbus_close.3 \ modbus_connect.3 \ modbus_flush.3 \ modbus_free.3 \ modbus_get_byte_from_bits.3 \ modbus_get_byte_timeout.3 \ modbus_get_float.3 \ modbus_get_header_length.3 \ modbus_get_response_timeout.3 \ modbus_get_socket.3 \ modbus_mapping_free.3 \ modbus_mapping_new.3 \ modbus_new_rtu.3 \ modbus_new_tcp_pi.3 \ modbus_new_tcp.3 \ modbus_read_bits.3 \ modbus_read_input_bits.3 \ modbus_read_input_registers.3 \ modbus_read_registers.3 \ modbus_receive_confirmation.3 \ modbus_receive_from.3 \ modbus_receive.3 \ modbus_reply_exception.3 \ modbus_reply.3 \ modbus_report_slave_id.3 \ modbus_rtu_get_serial_mode.3 \ modbus_rtu_set_serial_mode.3 \ modbus_send_raw_request.3 \ modbus_set_bits_from_bytes.3 \ modbus_set_bits_from_byte.3 \ modbus_set_byte_timeout.3 \ modbus_set_debug.3 \ modbus_set_error_recovery.3 \ modbus_set_float.3 \ modbus_set_response_timeout.3 \ modbus_set_slave.3 \ modbus_set_socket.3 \ modbus_strerror.3 \ modbus_tcp_listen.3 \ modbus_write_and_read_registers.3 \ modbus_write_bits.3 \ modbus_write_bit.3 \ modbus_write_registers.3 \ modbus_write_register.3 MAN7 = libmodbus.7 MAN_DOC = $(MAN3) $(MAN7) MAN_TXT = $(MAN3:%.3=%.txt) MAN_TXT += $(MAN7:%.7=%.txt) MAN_HTML = $(MAN_TXT:%.txt=%.html) if INSTALL_MAN dist_man_MANS = $(MAN_DOC) doc: $(MAN_DOC) endif EXTRA_DIST = asciidoc.conf $(MAN_TXT) if BUILD_DOC EXTRA_DIST += $(MAN_HTML) html: $(MAN_HTML) endif MAINTAINERCLEANFILES = $(MAN_DOC) $(MAN_HTML) dist-hook: $(MAN_DOC) $(MAN_HTML) if BUILD_DOC SUFFIXES=.html .txt .xml .1 .3 .7 .txt.html: asciidoc -d manpage -b xhtml11 -f asciidoc.conf \ -alibmodbus_version=@LIBMODBUS_VERSION@ $< .txt.xml: asciidoc -d manpage -b docbook -f asciidoc.conf \ -alibmodbus_version=@LIBMODBUS_VERSION@ $< .xml.1: xmlto man $< .xml.3: xmlto man $< .xml.7: xmlto man $< clean: rm -f *.1 *.3 *.7 rm -f *.html endif libmodbus-3.0.5/doc/asciidoc.conf000066400000000000000000000023201222457407600166770ustar00rootroot00000000000000[paradef-default] literal-style=template="literalparagraph" [macros] (?su)[\\]?(?Plinkmb):(?P\S*?)\[(?P.*?)\]= ifdef::backend-docbook[] [linkmb-inlinemacro] {0%{target}} {0#} {0#{target}{0}} {0#} endif::backend-docbook[] ifdef::backend-xhtml11[] [linkmb-inlinemacro] {target}{0?({0})} endif::backend-xhtml11[] ifdef::doctype-manpage[] ifdef::backend-docbook[] [header] template::[header-declarations] {mantitle} {manvolnum} libmodbus {libmodbus_version} Libmodbus Manual {manname} {manpurpose} endif::backend-docbook[] endif::doctype-manpage[] ifdef::backend-xhtml11[] [footer] {disable-javascript%

} endif::backend-xhtml11[] libmodbus-3.0.5/doc/libmodbus.txt000066400000000000000000000170771222457407600170120ustar00rootroot00000000000000libmodbus(7) ============ NAME ---- libmodbus - a fast and portable Modbus library SYNOPSIS -------- *#include * *cc* \`pkg-config --cflags --libs libmodbus` 'files' DESCRIPTION ----------- libmodbus is a library to send/receive data with a device which respects the Modbus protocol. This library contains various backends to communicate over different networks (eg. serial in RTU mode or Ethernet in TCP/IPv6). The http://www.modbus.org site provides documentation about the protocol at http://www.modbus.org/specs.php. libmodbus provides an abstraction of the lower communication layers and offers the same API on all supported platforms. This documentation presents an overview of libmodbus concepts, describes how libmodbus abstracts Modbus communication with different hardware and platforms and provides a reference manual for the functions provided by the libmodbus library. Contexts ~~~~~~~~ The Modbus protocol contains many variants (eg. serial RTU or Ehternet TCP), to ease the implementation of a variant, the library was designed to use a backend for each variant. The backends are also a convenient way to fulfill other requirements (eg. real-time operations). Each backend offers a specific function to create a new 'modbus_t' context. The 'modbus_t' context is an opaque structure containing all necessary information to establish a connection with others Modbus devices according to the selected variant. You can choose the best context for your needs among: RTU Context ^^^^^^^^^^^ The RTU backend (Remote Terminal Unit) is used in serial communication and makes use of a compact, binary representation of the data for protocol communication. The RTU format follows the commands/data with a cyclic redundancy check checksum as an error check mechanism to ensure the reliability of data. Modbus RTU is the most common implementation available for Modbus. A Modbus RTU message must be transmitted continuously without inter-character hesitations (extract from Wikipedia, Modbus, http://en.wikipedia.org/wiki/Modbus (as of Mar. 13, 2011, 20:51 GMT). The Modbus RTU framing calls a slave, a device/service which handle Modbus requests, and a master, a client which send requests. The communication is always initiated by the master. Many Modbus devices can be connected together on the same physical link so you need to define which slave is concerned by the message with linkmb:modbus_set_slave[3]. If you're running a slave, the slave number is used to filter messages. Create a Modbus RTU context:: linkmb:modbus_new_rtu[3] Set the serial mode:: linkmb:modbus_rtu_get_serial_mode[3] linkmb:modbus_rtu_set_serial_mode[3] TCP (IPv4) Context ^^^^^^^^^^^^^^^^^^ The TCP backend implements a Modbus variant used for communications over TCP/IPv4 networks. It does not require a checksum calculation as lower layer takes care of the same. Create a Modbus TCP context:: linkmb:modbus_new_tcp[3] TCP PI (IPv4 and IPv6) Context ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ The TCP PI (Protocol Indepedent) backend implements a Modbus variant used for communications over TCP IPv4 and IPv6 networks. It does not require a checksum calculation as lower layer takes care of the same. Contrary to the TCP IPv4 only backend, the TCP PI backend offers hostname resolution but it consumes about 1Kb of additional memory. Create a Modbus TCP context:: linkmb:modbus_new_tcp_pi[3] Common ^^^^^^ Before using any libmodbus functions, the caller must allocate and initialize a 'modbus_t' context with functions explained above, then the following functions are provided to modify and free a 'context': Free libmodbus context:: linkmb:modbus_free[3] Context setters and getters:: linkmb:modbus_get_byte_timeout[3] linkmb:modbus_set_byte_timeout[3] linkmb:modbus_set_debug[3] linkmb:modbus_set_error_recovery[3] linkmb:modbus_get_header_length[3] linkmb:modbus_get_response_timeout[3] linkmb:modbus_set_response_timeout[3] linkmb:modbus_set_slave[3] linkmb:modbus_set_socket[3] linkmb:modbus_get_socket[3] A libmodbus 'context' is thread safe and may be shared among as many application threads as necessary, without any additional locking required on the part of the caller. Macros for data manipulation:: MODBUS_GET_HIGH_BYTE(data), extracts the high byte from a byte MODBUS_GET_LOW_BYTE(data), extracts the low byte from a byte MODBUS_GET_INT32_FROM_INT16(tab_int16, index), builds an int32 from the two first int16 starting at tab_int16[index] MODBUS_GET_INT16_FROM_INT8(tab_int8, index), builds an int16 from the two first int8 starting at tab_int8[index] MODBUS_SET_INT16_TO_INT8(tab_int8, index, value), set an int16 value into the two first bytes starting at tab_int8[index] Functions for data manipulation:: linkmb:modbus_set_bits_from_byte[3] linkmb:modbus_set_bits_from_bytes[3] linkmb:modbus_get_byte_from_bits[3] linkmb:modbus_get_float[3] linkmb:modbus_set_float[3] Connection ~~~~~~~~~~ The following functions are provided to establish and close a connection with Modbus devices: Establish a connection:: linkmb:modbus_connect[3] Close a connection:: linkmb:modbus_close[3] Flush a connection:: linkmb:modbus_flush[3] Client ~~~~~~ The Modbus protocol defines different data types and functions to read and write them from/to remote devices. The following functions are used by the clients to send Modbus requests: Read data:: linkmb:modbus_read_bits[3] linkmb:modbus_read_input_bits[3] linkmb:modbus_read_registers[3] linkmb:modbus_read_input_registers[3] linkmb:modbus_report_slave_id[3] Write data:: linkmb:modbus_write_bit[3] linkmb:modbus_write_register[3] linkmb:modbus_write_bits[3] linkmb:modbus_write_registers[3] Write and read data:: linkmb:modbus_write_and_read_registers[3] Raw requests:: linkmb:modbus_send_raw_request[3] linkmb:modbus_receive_confirmation[3] Reply an exception:: linkmb:modbus_reply_exception[3] Server ~~~~~~ The server is waiting for request from clients and must answer when it is concerned by the request. The libmodbus offers the following functions to handle requests: Data mapping: linkmb:modbus_mapping_new[3] linkmb:modbus_mapping_free[3] Receive:: linkmb:modbus_receive[3] Reply:: linkmb:modbus_reply[3] linkmb:modbus_reply_exception[3] ERROR HANDLING -------------- The libmodbus functions handle errors using the standard conventions found on POSIX systems. Generally, this means that upon failure a libmodbus function shall return either a NULL value (if returning a pointer) or a negative value (if returning an integer), and the actual error code shall be stored in the 'errno' variable. The _modbus_strerror()_ function is provided to translate libmodbus-specific error codes into error message strings; for details refer to linkmb:modbus_strerror[3]. MISCELLANEOUS ------------- The _LIBMODBUS_VERSION_STRING_ constant indicates the libmodbus version the program has been compiled against. The variables 'libmodbus_version_major', 'libmodbus_version_minor', 'libmodbus_version_micro' give the version the program is linked against. AUTHORS ------- The libmodbus documentation was written by Stéphane Raimbault RESOURCES --------- Main web site: Report bugs on the issue tracker at . COPYING ------- Free use of this software is granted under the terms of the GNU Lesser General Public License (LGPL v2.1+). For details see the files `COPYING` and `COPYING.LESSER` included with the libmodbus distribution. libmodbus-3.0.5/doc/modbus_close.txt000066400000000000000000000014301222457407600174720ustar00rootroot00000000000000modbus_close(3) =============== NAME ---- modbus_close - close a Modbus connection SYNOPSIS -------- *void modbus_close(modbus_t *'ctx');* DESCRIPTION ----------- The _modbus_close()_ function shall close the connection established with the backend set in the context. RETURN VALUE ------------ There is no return value. EXAMPLE ------- [source,c] ------------------- modbus_t *ctx; ctx = modbus_new_tcp("127.0.0.1", 502); if (modbus_connect(ctx) == -1) { fprintf(stderr, "Connection failed: %s\n", modbus_strerror(errno)); modbus_free(ctx); return -1; } modbus_close(ctx); modbus_free(ctx); ------------------- SEE ALSO -------- linkmb:modbus_connect[3] AUTHORS ------- The libmodbus documentation was written by Stéphane Raimbault libmodbus-3.0.5/doc/modbus_connect.txt000066400000000000000000000017251222457407600200250ustar00rootroot00000000000000modbus_connect(3) ================= NAME ---- modbus_connect - establish a Modbus connection SYNOPSIS -------- *int modbus_connect(modbus_t *'ctx');* DESCRIPTION ----------- The _modbus_connect()_ function shall etablish a connection to a Modbus server, a network or a bus using the context information of libmodbus context given in argument. RETURN VALUE ------------ The modbus_connect() function shall return 0 if successful. Otherwise it shall return -1 and set errno to one of the values defined by the system calls of the underlying platform. EXAMPLE ------- [source,c] ------------------- modbus_t *ctx; ctx = modbus_new_tcp("127.0.0.1", 502); if (modbus_connect(ctx) == -1) { fprintf(stderr, "Connection failed: %s\n", modbus_strerror(errno)); modbus_free(ctx); return -1; } ------------------- SEE ALSO -------- linkmb:modbus_close[3] AUTHORS ------- The libmodbus documentation was written by Stéphane Raimbault libmodbus-3.0.5/doc/modbus_flush.txt000066400000000000000000000011051222457407600175050ustar00rootroot00000000000000modbus_flush(3) =============== NAME ---- modbus_flush - flush non-transmitted data SYNOPSIS -------- *int modbus_flush(modbus_t *'ctx');* DESCRIPTION ----------- The _modbus_flush()_ function shall discard data received but not read to the socket or file descriptor associated to the context 'ctx'. RETURN VALUE ------------ The _modbus_flush()_ function shall return 0 or the number of flushed bytes if successful. Otherwise it shall return -1 and set errno. AUTHORS ------- The libmodbus documentation was written by Stéphane Raimbault libmodbus-3.0.5/doc/modbus_free.txt000066400000000000000000000006741222457407600173170ustar00rootroot00000000000000modbus_free(3) ============== NAME ---- modbus_free - free a libmodbus context SYNOPSIS -------- *void modbus_free(modbus_t *'ctx');* DESCRIPTION ----------- The _modbus_free()_ function shall free an allocated modbus_t structure. RETURN VALUE ------------ There is no return values. SEE ALSO -------- linkmb:libmodbus[3] AUTHORS ------- The libmodbus documentation was written by Stéphane Raimbault libmodbus-3.0.5/doc/modbus_get_byte_from_bits.txt000066400000000000000000000014321222457407600222350ustar00rootroot00000000000000modbus_get_byte_from_bits(3) ============================ NAME ---- modbus_get_byte_from_bits - get the value from many bits SYNOPSIS -------- *uint8_t modbus_get_byte_from_bits(const uint8_t *'src', int 'index', unsigned int 'nb_bits');* DESCRIPTION ----------- The _modbus_get_byte_from_bits()_ function shall extract a value from many bits. All 'nb_bits' bits from 'src' at position 'index' will be read as a single value. To obtain a full byte, set nb_bits to 8. RETURN VALUE ------------ The _modbus_get_byte_from_bits()_ function shall return a byte containing the bits read. SEE ALSO -------- linkmb:modbus_set_bits_from_byte[3] linkmb:modbus_set_bits_from_bytes[3] AUTHORS ------- The libmodbus documentation was written by Stéphane Raimbault libmodbus-3.0.5/doc/modbus_get_byte_timeout.txt000066400000000000000000000015341222457407600217420ustar00rootroot00000000000000modbus_get_byte_timeout(3) ========================== NAME ---- modbus_get_byte_timeout - get timeout between bytes SYNOPSIS -------- *void modbus_get_byte_timeout(modbus_t *'ctx', struct timeval *'timeout');* DESCRIPTION ----------- The _modbus_get_byte_timeout()_ function shall store the timeout interval between two consecutive bytes of the same message in the 'timeout' argument. RETURN VALUE ------------ There is no return values. EXAMPLE ------- [source,c] ------------------- struct timeval byte_timeout; /* Save original timeout */ modbus_get_byte_timeout(ctx, &byte_timeout); ------------------- SEE ALSO -------- linkmb:modbus_get_response_timeout[3] linkmb:modbus_set_response_timeout[3] linkmb:modbus_set_byte_timeout[3] AUTHORS ------- The libmodbus documentation was written by Stéphane Raimbault libmodbus-3.0.5/doc/modbus_get_float.txt000066400000000000000000000012501222457407600203310ustar00rootroot00000000000000modbus_get_float(3) =================== NAME ---- modbus_get_float - get a float value SYNOPSIS -------- *float modbus_get_float(const uint16_t *'src');* DESCRIPTION ----------- The _modbus_get_float()_ function shall get a float from 4 bytes in Modbus format. The 'src' array must be pointer on two 16 bits values, for example, if the first word is set to 0x4465 and the second to 0x229a, the float value read will be 916.540649. RETURN VALUE ------------ The _modbus_get_float()_ function shall return a float. SEE ALSO -------- linkmb:modbus_set_float[3] AUTHORS ------- The libmodbus documentation was written by Stéphane Raimbault libmodbus-3.0.5/doc/modbus_get_header_length.txt000066400000000000000000000011761222457407600220240ustar00rootroot00000000000000modbus_get_header_length(3) =========================== NAME ---- modbus_get_header_length - retrieve the current header length SYNOPSIS -------- *int modbus_get_header_length(modbus_t *'ctx');* DESCRIPTION ----------- The _modbus_get_header_length()_ function shall retrieve the current header length from the backend. This function is convenient to manipulate a message and so its limited to low-level operations. RETURN VALUE ------------ The header length as integer value. SEE ALSO -------- linkmb:libmodbus[7] AUTHORS ------- The libmodbus documentation was written by Stéphane Raimbault libmodbus-3.0.5/doc/modbus_get_response_timeout.txt000066400000000000000000000020451222457407600226330ustar00rootroot00000000000000modbus_get_response_timeout(3) ============================== NAME ---- modbus_get_response_timeout - get timeout for response SYNOPSIS -------- *void modbus_get_response_timeout(modbus_t *'ctx', struct timeval *'timeout');* DESCRIPTION ----------- The _modbus_get_response_timeout()_ function shall store the timeout interval used to wait for a response in the 'timeout' argument. RETURN VALUE ------------ There is no return values. EXAMPLE ------- [source,c] ------------------- struct timeval old_response_timeout; struct timeval response_timeout; /* Save original timeout */ modbus_get_response_timeout(ctx, &old_response_timeout); /* Define a new and too short timeout! */ response_timeout.tv_sec = 0; response_timeout.tv_usec = 0; modbus_set_response_timeout(ctx, &response_timeout); ------------------- SEE ALSO -------- linkmb:modbus_set_response_timeout[3] linkmb:modbus_get_byte_timeout[3] linkmb:modbus_set_byte_timeout[3] AUTHORS ------- The libmodbus documentation was written by Stéphane Raimbault libmodbus-3.0.5/doc/modbus_get_socket.txt000066400000000000000000000010521222457407600205140ustar00rootroot00000000000000modbus_get_socket(3) ==================== NAME ---- modbus_get_socket - get the current socket of the context SYNOPSIS -------- *int modbus_get_socket(modbus_t *'ctx');* DESCRIPTION ----------- The _modbus_get_socket()_ function shall return the current socket or file descriptor of the libmodbus context. RETURN VALUE ------------ The current socket or file descriptor of the context. SEE ALSO -------- linkmb:modbus_set_socket[3] AUTHORS ------- The libmodbus documentation was written by Stéphane Raimbault libmodbus-3.0.5/doc/modbus_mapping_free.txt000066400000000000000000000011061222457407600210210ustar00rootroot00000000000000modbus_mapping_free(3) ===================== NAME ---- modbus_mapping_free - free a modbus_mapping_t structure SYNOPSIS -------- *void modbus_mapping_free(modbus_mapping_t *'mb_mapping');* DESCRIPTION ----------- The _modbus_mapping_free()_ function shall free the four arrays of mb_mapping_t structure and finally the mb_mapping_t referenced by 'mb_mapping'. RETURN VALUE ------------ There is no return values. SEE ALSO -------- linkmb:modbus_mapping_new[3] AUTHORS ------- The libmodbus documentation was written by Stéphane Raimbault libmodbus-3.0.5/doc/modbus_mapping_new.txt000066400000000000000000000032171222457407600206760ustar00rootroot00000000000000modbus_mapping_new(3) ===================== NAME ---- modbus_mapping_new - allocate four arrays of bits and registers SYNOPSIS -------- *modbus_mapping_t* modbus_mapping_new(int 'nb_bits', int 'nb_input_bits', int 'nb_registers', int 'nb_input_registers');* DESCRIPTION ----------- The _modbus_mapping_new()_ function shall allocate four arrays to store bits, input bits, registers and inputs registers. The pointers are stored in modbus_mapping_t structure. All values of the arrays are initialized to zero. If it isn't necessary to allocate an array for a specific type of data, you can pass the zero value in argument, the associated pointer will be NULL. This function is convenient to handle requests in a Modbus server/slave. RETURN VALUE ------------ The _modbus_mapping_new()_ function shall return the new allocated structure if successful. Otherwise it shall return NULL and set errno. ERRORS ------ ENOMEM:: Not enough memory EXAMPLE ------- [source,c] ------------------- /* The fist value of each array is accessible from the 0 address. */ mb_mapping = modbus_mapping_new(BITS_ADDRESS + BITS_NB, INPUT_BITS_ADDRESS + INPUT_BITS_NB, REGISTERS_ADDRESS + REGISTERS_NB, INPUT_REGISTERS_ADDRESS + INPUT_REGISTERS_NB); if (mb_mapping == NULL) { fprintf(stderr, "Failed to allocate the mapping: %s\n", modbus_strerror(errno)); modbus_free(ctx); return -1; } ------------------- SEE ALSO -------- linkmb:modbus_mapping_free[3] AUTHORS ------- The libmodbus documentation was written by Stéphane Raimbault libmodbus-3.0.5/doc/modbus_new_rtu.txt000066400000000000000000000033551222457407600200600ustar00rootroot00000000000000modbus_new_rtu(3) ================= NAME ---- modbus_new_rtu - create a libmodbus context for RTU SYNOPSIS -------- *modbus_t *modbus_new_rtu(const char *'device', int 'baud', char 'parity', int 'data_bit', int 'stop_bit');* DESCRIPTION ----------- The _modbus_new_rtu()_ function shall allocate and initialize a modbus_t structure to communicate in RTU mode on a serial line. The _device_ argument specifies the name of the serial port handled by the OS, eg. '/dev/ttyS0' or '/dev/ttyUSB0'. On Windows, it's necessary to prepend COM name with '\\.\' for COM number greater than 9, eg. '\\\\.\\COM10'. See http://msdn.microsoft.com/en-us/library/aa365247(v=vs.85).aspx for details The _baud_ argument specifies the baud rate of the communication, eg. 9600, 19200, 57600, 115200, etc. The _parity_ argument can have one of the following values::: * _N_ for none * _E_ for even * _O_ for odd The _data_bits_ argument specifies the number of bits of data, the allowed values are 5, 6, 7 and 8. The _stop_bits_ argument specifies the bits of stop, the allowed values are 1 and 2. RETURN VALUE ------------ The _modbus_new_rtu()_ function shall return a pointer to a *modbus_t* structure if successful. Otherwise it shall return NULL and set errno to one of the values defined below. ERRORS ------ *EINVAL*:: An invalid argument was given. EXAMPLE ------- [source,c] ------------------- modbus_t *ctx; ctx = modbus_new_rtu("/dev/ttyUSB0", 115200, 'N', 8, 1); if (ctx == NULL) { fprintf(stderr, "Unable to create the libmodbus context\n"); return -1; } ------------------- SEE ALSO -------- linkmb:modbus_new_tcp[3] linkmb:modbus_free[3] AUTHORS ------- The libmodbus documentation was written by Stéphane Raimbault libmodbus-3.0.5/doc/modbus_new_tcp.txt000066400000000000000000000027431222457407600200340ustar00rootroot00000000000000modbus_new_tcp(3) ================= NAME ---- modbus_new_tcp - create a libmodbus context for TCP/IPv4 SYNOPSIS -------- *modbus_t *modbus_new_tcp(const char *'ip', int 'port');* DESCRIPTION ----------- The _modbus_new_tcp()_ function shall allocate and initialize a modbus_t structure to communicate with a Modbus TCP/IPv4 server. The _ip_ argument specifies the IP address of the server to which the client wants etablish a connection. The _port_ argument is the TCP port to use. Set the port to _MODBUS_TCP_DEFAULT_PORT_ to use the default one (502). It’s convenient to use a port number greater than or equal to 1024 because it’s not necessary to have administrator privileges. RETURN VALUE ------------ The _modbus_new_tcp()_ function shall return a pointer to a *modbus_t* structure if successful. Otherwise it shall return NULL and set errno to one of the values defined below. ERRORS ------ *EINVAL*:: An invalid IP address was given. EXAMPLE ------- [source,c] ------------------- modbus_t *ctx; ctx = modbus_new_tcp("127.0.0.1", 1502); if (ctx == NULL) { fprintf(stderr, "Unable to allocate libmodbus context\n"); return -1; } if (modbus_connect(ctx) == -1) { fprintf(stderr, "Connection failed: %s\n", modbus_strerror(errno)); modbus_free(ctx); return -1; } ------------------- SEE ALSO -------- linkmb:modbus_new_rtu[3] linkmb:modbus_free[3] AUTHORS ------- The libmodbus documentation was written by Stéphane Raimbault libmodbus-3.0.5/doc/modbus_new_tcp_pi.txt000066400000000000000000000032471222457407600205240ustar00rootroot00000000000000modbus_new_tcp_pi(3) ==================== NAME ---- modbus_new_tcp_pi - create a libmodbus context for TCP Protocol Independent SYNOPSIS -------- *modbus_t *modbus_new_tcp_pi(const char *'node', const char *'service');* DESCRIPTION ----------- The _modbus_new_tcp_pi()_ function shall allocate and initialize a modbus_t structure to communicate with a Modbus TCP IPv4 or Ipv6 server. The _node_ argument specifies the host name or IP address of the host to connect to, eg. '192.168.0.5' , '::1' or 'server.com'. The _service_ argument is the service name/port number to connect to. To use the default Modbus port use the string "502". On many Unix systems, it’s convenient to use a port number greater than or equal to 1024 because it’s not necessary to have administrator privileges. RETURN VALUE ------------ The _modbus_new_tcp_pi()_ function shall return a pointer to a *modbus_t* structure if successful. Otherwise it shall return NULL and set errno to one of the values defined below. ERRORS ------ *EINVAL*:: The node string is empty or has been truncated. The service string is empty or has been truncated. EXAMPLE ------- [source,c] ------------------- modbus_t *ctx; ctx = modbus_new_tcp_pi("::1", "1502"); if (ctx == NULL) { fprintf(stderr, "Unable to allocate libmodbus context\n"); return -1; } if (modbus_connect(ctx) == -1) { fprintf(stderr, "Connection failed: %s\n", modbus_strerror(errno)); modbus_free(ctx); return -1; } ------------------- SEE ALSO -------- linkmb:modbus_new_tcp[3] linkmb:modbus_new_rtu[3] linkmb:modbus_free[3] AUTHORS ------- The libmodbus documentation was written by Stéphane Raimbault libmodbus-3.0.5/doc/modbus_read_bits.txt000066400000000000000000000017671222457407600203360ustar00rootroot00000000000000modbus_read_bits(3) =================== NAME ---- modbus_read_bits - read many bits SYNOPSIS -------- *int modbus_read_bits(modbus_t *'ctx', int 'addr', int 'nb', uint8_t *'dest');* DESCRIPTION ----------- The _modbus_read_bits()_ function shall read the status of the 'nb' bits (coils) to the address 'addr' of the remote device. The result of reading is stored in 'dest' array as unsigned bytes (8 bits) set to _TRUE_ or _FALSE_. You must take care to allocate enough memory to store the results in 'dest' (at least 'nb' * sizeof(uint8_t)). The function uses the Modbus function code 0x01 (read coil status). RETURN VALUE ------------ The _modbus_read_bits()_ function shall return the number of read bits if successful. Otherwise it shall return -1 and set errno. ERRORS ------ EMBMDATA:: Too many bits requested SEE ALSO -------- linkmb:modbus_write_bit[3] linkmb:modbus_write_bits[3] AUTHORS ------- The libmodbus documentation was written by Stéphane Raimbault libmodbus-3.0.5/doc/modbus_read_input_bits.txt000066400000000000000000000020461222457407600215440ustar00rootroot00000000000000modbus_read_input_bits(3) ========================= NAME ---- modbus_read_input_bits - read many input bits SYNOPSIS -------- *int modbus_read_input_bits(modbus_t *'ctx', int 'addr', int 'nb', uint8_t *'dest');* DESCRIPTION ----------- The _modbus_read_input_bits()_ function shall read the content of the 'nb' input bits to the address 'addr' of the remote device. The result of reading is stored in 'dest' array as unsigned bytes (8 bits) set to _TRUE_ or _FALSE_. You must take care to allocate enough memory to store the results in 'dest' (at least 'nb' * sizeof(uint8_t)). The function uses the Modbus function code 0x02 (read input status). RETURN VALUE ------------ The _modbus_read_input_status()_ function shall return the number of read input status if successful. Otherwise it shall return -1 and set errno. ERRORS ------ EMBMDATA:: Too many discrete inputs requested SEE ALSO -------- linkmb:modbus_read_input_registers[3] AUTHORS ------- The libmodbus documentation was written by Stéphane Raimbault libmodbus-3.0.5/doc/modbus_read_input_registers.txt000066400000000000000000000023631222457407600226140ustar00rootroot00000000000000modbus_read_input_registers(3) ============================== NAME ---- modbus_read_input_registers - read many input registers SYNOPSIS -------- *int modbus_read_input_registers(modbus_t *'ctx', int 'addr', int 'nb', uint16_t *'dest');* DESCRIPTION ----------- The _modbus_read_input_registers()_ function shall read the content of the 'nb' input registers to address 'addr' of the remote device. The result of the reading is stored in 'dest' array as word values (16 bits). You must take care to allocate enough memory to store the results in 'dest' (at least 'nb' * sizeof(uint16_t)). The function uses the Modbus function code 0x04 (read input registers). The holding registers and input registers have different historical meaning, but nowadays it's more common to use holding registers only. RETURN VALUE ------------ The _modbus_read_input_registers()_ function shall return the number of read input registers if successful. Otherwise it shall return -1 and set errno. ERRORS ------ EMBMDATA:: Too many bits requested SEE ALSO -------- linkmb:modbus_read_input_bits[3] linkmb:modbus_write_register[3] linkmb:modbus_write_registers[3] AUTHORS ------- The libmodbus documentation was written by Stéphane Raimbault libmodbus-3.0.5/doc/modbus_read_registers.txt000066400000000000000000000031341222457407600213720ustar00rootroot00000000000000modbus_read_registers(3) ======================== NAME ---- modbus_read_registers - read many registers SYNOPSIS -------- *int modbus_read_registers(modbus_t *'ctx', int 'addr', int 'nb', uint16_t *'dest');* DESCRIPTION ----------- The _modbus_read_registers()_ function shall read the content of the 'nb' holding registers to the address 'addr' of the remote device. The result of reading is stored in 'dest' array as word values (16 bits). You must take care to allocate enough memory to store the results in 'dest' (at least 'nb' * sizeof(uint16_t)). The function uses the Modbus function code 0x03 (read holding registers). RETURN VALUE ------------ The _modbus_read_registers()_ function shall return the number of read registers if successful. Otherwise it shall return -1 and set errno. ERRORS ------ EMBMDATA:: Too many registers requested EXAMPLE ------- [source,c] ------------------- modbus_t *ctx; uint16_t tab_reg[64]; int rc; int i; ctx = modbus_new_tcp("127.0.0.1", 1502); if (modbus_connect(ctx) == -1) { fprintf(stderr, "Connection failed: %s\n", modbus_strerror(errno)); modbus_free(ctx); return -1; } rc = modbus_read_registers(ctx, 0, 10, tab_reg); if (rc == -1) { fprintf(stderr, "%s\n", modbus_strerror(errno)); return -1; } for (i=0; i < rc; i++) { printf("reg[%d]=%d (0x%X)\n", i, tab_reg[i], tab_reg[i]); } modbus_close(ctx); modbus_free(ctx); ------------------- SEE ALSO -------- linkmb:modbus_write_register[3] linkmb:modbus_write_registers[3] AUTHORS ------- The libmodbus documentation was written by Stéphane Raimbault libmodbus-3.0.5/doc/modbus_receive.txt000066400000000000000000000016471222457407600200210ustar00rootroot00000000000000modbus_receive(3) ================= NAME ---- modbus_receive - receive a indication request SYNOPSIS -------- *int modbus_receive(modbus_t *'ctx', uint8_t *'req');* DESCRIPTION ----------- The _modbus_receive()_ function shall receive an indication request from the socket of the context 'ctx'. This function is used by Modbus slave/server to receive and analyze indication request sent by the masters/clients. If you need to use another socket or file descriptor than the one defined in the context 'ctx', see the function linkmb:modbus_set_socket[3]. RETURN VALUE ------------ The _modbus_receive()_ function shall store the indication request in 'req' and return the request length if sucessful. Otherwise it shall return -1 and set errno. SEE ALSO -------- linkmb:modbus_set_socket[3] linkmb:modbus_reply[3] AUTHORS ------- The libmodbus documentation was written by Stéphane Raimbault libmodbus-3.0.5/doc/modbus_receive_confirmation.txt000066400000000000000000000016351222457407600225660ustar00rootroot00000000000000modbus_receive_confirmation(3) ============================== NAME ---- modbus_receive_confirmation - receive a confirmation request SYNOPSIS -------- *int modbus_receive_confirmation(modbus_t *'ctx', uint8_t *'rsp');* DESCRIPTION ----------- The _modbus_receive_confirmation()_ function shall receive a request via the socket of the context 'ctx'. This function must be used for debugging purposes because the received response isn't checked against the initial request. This function can be used to receive request not handled by the library. RETURN VALUE ------------ The _modbus_receive_confirmation()_ function shall store the confirmation request in 'rsp' and return the response length if sucessful. Otherwise it shall return -1 and set errno. SEE ALSO -------- linkmb:modbus_send_raw_request[3] AUTHORS ------- The libmodbus documentation was written by Stéphane Raimbault libmodbus-3.0.5/doc/modbus_receive_from.txt000066400000000000000000000015131222457407600210340ustar00rootroot00000000000000modbus_receive_from(3) ====================== NAME ---- modbus_receive_from - receive a indication request from a socket SYNOPSIS -------- *int modbus_receive_from(modbus_t *'ctx', int sockfd, uint8_t *'req');* DESCRIPTION ----------- The _modbus_receive_from()_ function shall receive an indication request from the socket/file descriptor given in argument 'sockfd. This function is used by Modbus slave/server to receive and analyze indication request sent by the masters/clients. RETURN VALUE ------------ The _modbus_receive_from()_ function shall store the indication request in 'req' and return the request length if sucessful. Otherwise it shall return -1 and set errno. SEE ALSO -------- linkmb:modbus_receive[3] AUTHORS ------- The libmodbus documentation was written by Stéphane Raimbault libmodbus-3.0.5/doc/modbus_reply.txt000066400000000000000000000022661222457407600175300ustar00rootroot00000000000000modbus_reply(3) =============== NAME ---- modbus_reply - send a reponse to the received request SYNOPSIS -------- *int modbus_reply(modbus_t *'ctx', const uint8_t *'req', int 'req_length', modbus_mapping_t *'mb_mapping'); DESCRIPTION ----------- The _modbus_reply()_ function shall send a response to received request. The request 'req' given in argument is analyzed, a response is then built and sent by using the information of the modbus context 'ctx'. If the request indicates to read or write a value the operation will done in the modbus mapping 'mb_mapping' according to the type of the manipulated data. If an error occurs, an exception response will be sent. This function is designed for Modbus server. RETURN VALUE ------------ The _modbus_reply()_ function shall return the length of the response sent if successful. Otherwise it shall return -1 and set errno. ERRORS ------ EMBMDATA:: Sending has failed See also the errors returned by the syscall used to send the response (eg. send or write). SEE ALSO -------- linkmb:modbus_reply_exception[3] linkmb:libmodbus[7] AUTHORS ------- The libmodbus documentation was written by Stéphane Raimbault libmodbus-3.0.5/doc/modbus_reply_exception.txt000066400000000000000000000025011222457407600215760ustar00rootroot00000000000000modbus_reply_exception(3) ========================= NAME ---- modbus_reply_exception - send an exception reponse SYNOPSIS -------- *int modbus_reply_exception(modbus_t *'ctx', const uint8_t *'req', unsigned int 'exception_code'); DESCRIPTION ----------- The _modbus_reply_exception()_ function shall send an exception response based on the 'exception_code' in argument. The libmodbus provides the following exception codes: * MODBUS_EXCEPTION_ILLEGAL_FUNCTION (1) * MODBUS_EXCEPTION_ILLEGAL_DATA_ADDRESS (2) * MODBUS_EXCEPTION_ILLEGAL_DATA_VALUE (3) * MODBUS_EXCEPTION_SLAVE_OR_SERVER_FAILURE (4) * MODBUS_EXCEPTION_ACKNOWLEDGE (5) * MODBUS_EXCEPTION_SLAVE_OR_SERVER_BUSY (6) * MODBUS_EXCEPTION_NEGATIVE_ACKNOWLEDGE (7) * MODBUS_EXCEPTION_MEMORY_PARITY (8) * MODBUS_EXCEPTION_NOT_DEFINED (9) * MODBUS_EXCEPTION_GATEWAY_PATH (10) * MODBUS_EXCEPTION_GATEWAY_TARGET (11) The initial request 'req' is required to build a valid response. RETURN VALUE ------------ The _modbus_reply_exception()_ function shall return the length of the response sent if successful. Otherwise it shall return -1 and set errno. ERRORS ------ *EINVAL*:: The exception code is invalid SEE ALSO -------- linkmb:modbus_reply[3] linkmb:libmodbus[7] AUTHORS ------- The libmodbus documentation was written by Stéphane Raimbault libmodbus-3.0.5/doc/modbus_report_slave_id.txt000066400000000000000000000023661222457407600215570ustar00rootroot00000000000000modbus_report_slave_id(3) ========================= NAME ---- modbus_report_slave_id - returns a description of the controller SYNOPSIS -------- *int modbus_report_slave_id(modbus_t *'ctx', uint8_t *'dest');* DESCRIPTION ----------- The _modbus_report_slave_id()_ function shall send a request to the controller to obtain a description of the controller. The response stored in 'dest' contains: * the byte count of the response * the slave ID, this unique ID is in reality not unique at all so it's not possible to depend on it to know how the information are packed in the response. * the run indicator status (0x00 = OFF, 0xFF = ON) * additional data specific to each controller. For example, libmodbus returns the version of the library as a string. RETURN VALUE ------------ The _modbus_report_slave_id()_ function shall return the number of read data if successful. Otherwise it shall return -1 and set errno. EXAMPLE ------- [source,c] ------------------- uint8_t *tab_bytes; ... rc = modbus_report_slave_id(ctx, tab_bytes); if (rc > 1) { printf("Run Status Indicator: %s\n", tab_bytes[1] ? "ON" : "OFF"); } ------------------- AUTHORS ------- The libmodbus documentation was written by Stéphane Raimbault libmodbus-3.0.5/doc/modbus_rtu_get_serial_mode.txt000066400000000000000000000031451222457407600224060ustar00rootroot00000000000000modbus_rtu_get_serial_mode(3) ============================= NAME ---- modbus_rtu_get_serial_mode - get the current serial mode SYNOPSIS -------- *int modbus_rtu_get_serial_mode(modbus_t *'ctx');* DESCRIPTION ----------- The _modbus_rtu_get_serial_mode()_ function shall return the serial mode currently used by the libmodbus context: *MODBUS_RTU_RS232*:: the serial line is set for RS232 communication. RS-232 (Recommended Standard 232) is the traditional name for a series of standards for serial binary single-ended data and control signals connecting between a DTE (Data Terminal Equipment) and a DCE (Data Circuit-terminating Equipment). It is commonly used in computer serial ports *MODBUS_RTU_RS485*:: the serial line is set for RS485 communication. EIA-485, also known as TIA/EIA-485 or RS-485, is a standard defining the electrical characteristics of drivers and receivers for use in balanced digital multipoint systems. This standard is widely used for communications in industrial automation because it can be used effectively over long distances and in electrically noisy environments. This function is only available on Linux kernels 2.6.28 onwards and can only be used with a context using a RTU backend. RETURN VALUE ------------ The _modbus_rtu_get_serial_mode()_ function shall return 'MODBUS_RTU_RS232' or 'MODBUS_RTU_RS485' if successful. Otherwise it shall return -1 and set errno to one of the values defined below. ERRORS ------ *EINVAL*:: The current libmodbus backend is not RTU. AUTHORS ------- The libmodbus documentation was written by Stéphane Raimbault libmodbus-3.0.5/doc/modbus_rtu_set_serial_mode.txt000066400000000000000000000031361222457407600224220ustar00rootroot00000000000000modbus_rtu_set_serial_mode(3) ============================= NAME ---- modbus_rtu_set_serial_mode - set the serial mode SYNOPSIS -------- *int modbus_rtu_set_serial_mode(modbus_t *'ctx');* DESCRIPTION ----------- The _modbus_rtu_set_serial_mode()_ function shall set the selected serial mode: *MODBUS_RTU_RS232*:: the serial line is set for RS232 communication. RS-232 (Recommended Standard 232) is the traditional name for a series of standards for serial binary single-ended data and control signals connecting between a DTE (Data Terminal Equipment) and a DCE (Data Circuit-terminating Equipment). It is commonly used in computer serial ports *MODBUS_RTU_RS485*:: the serial line is set for RS485 communication. EIA-485, also known as TIA/EIA-485 or RS-485, is a standard defining the electrical characteristics of drivers and receivers for use in balanced digital multipoint systems. This standard is widely used for communications in industrial automation because it can be used effectively over long distances and in electrically noisy environments. This function is only supported on Linux kernels 2.6.28 onwards. RETURN VALUE ------------ The _modbus_set_serial_mode()_ function shall return 0 if successful. Otherwise it shall return -1 and set errno to one of the values defined below. ERRORS ------ *EINVAL*:: The current libmodbus backend is not RTU. *ENOTSUP*:: The function is not supported on your platform. If the call to ioctl() fails, the error code of ioctl will be returned. AUTHORS ------- The libmodbus documentation was written by Stéphane Raimbault libmodbus-3.0.5/doc/modbus_send_raw_request.txt000066400000000000000000000032021222457407600217360ustar00rootroot00000000000000modbus_send_raw_request(3) ========================== NAME ---- modbus_send_raw_request - send a raw request SYNOPSIS -------- *int modbus_send_raw_request(modbus_t *'ctx', uint8_t *'raw_req, int 'raw_req_length');* DESCRIPTION ----------- The _modbus_send_raw_request()_ function shall send a request via the socket of the context 'ctx'. This function must be used for debugging purposes because you have to take care to make a valid request by hand. The function only adds to the message, the header or CRC of the selected backend, so 'raw_req' must start and contain at least a slave/unit identifier and a function code. This function can be used to send request not handled by the library. RETURN VALUE ------------ The _modbus_send_raw_request()_ function shall return the full message length, counting the extra data relating to the backend, if successful. Otherwise it shall return -1 and set errno. EXAMPLE ------- [source,c] ------------------- modbus_t *ctx; /* Read 5 holding registers from address 1 */ uint8_t raw_req[] = { 0xFF, 0x03, 0x00, 0x01, 0x0, 0x05 }; int req_length; uint8_t rsp[MODBUS_TCP_MAX_ADU_LENGTH]; ctx = modbus_new_tcp("127.0.0.1", 1502); if (modbus_connect(ctx) == -1) { fprintf(stderr, "Connection failed: %s\n", modbus_strerror(errno)); modbus_free(ctx); return -1; } req_length = modbus_send_raw_request(ctx, raw_req, 6 * sizeof(uint8_t)); modbus_receive_confirmation(ctx, rsp); modbus_close(ctx); modbus_free(ctx); ------------------- SEE ALSO -------- linkmb:modbus_receive_confirmation[3] AUTHORS ------- The libmodbus documentation was written by Stéphane Raimbault libmodbus-3.0.5/doc/modbus_set_bits_from_byte.txt000066400000000000000000000013021222457407600222450ustar00rootroot00000000000000modbus_set_bits_from_byte(3) ============================ NAME ---- modbus_set_bits_from_byte - set many bits from a single byte value SYNOPSIS -------- *void modbus_set_bits_from_byte(uint8_t *'dest', int 'index', const uint8_t 'value');* DESCRIPTION ----------- The _modbus_set_bits_from_byte_ function shall set many bits from a single byte. All 8 bits from the byte 'value' will be written to 'dest' array starting at 'index' position. RETURN VALUE ------------ There is no return values. SEE ALSO -------- linkmb:modbus_set_bits_from_byte[3] linkmb:modbus_set_bits_from_bytes[3] AUTHORS ------- The libmodbus documentation was written by Stéphane Raimbault libmodbus-3.0.5/doc/modbus_set_bits_from_bytes.txt000066400000000000000000000014321222457407600224340ustar00rootroot00000000000000modbus_set_bits_from_bytes(3) ============================ NAME ---- modbus_set_bits_from_bytes - set many bits from an array of bytes SYNOPSIS -------- *void modbus_set_bits_from_bytes(uint8_t *'dest', int 'index', unsigned int 'nb_bits', const uint8_t *'tab_byte');* DESCRIPTION ----------- The _modbus_set_bits_from_bytes_ function shall set bits by reading an array of bytes. All the bits of the bytes read from the first position of the array 'tab_byte' are written as bits in the 'dest' array starting at position 'index'. RETURN VALUE ------------ There is no return values. SEE ALSO -------- linkmb:modbus_set_bits_from_byte[3] linkmb:modbus_get_byte_from_bits[3] AUTHORS ------- The libmodbus documentation was written by Stéphane Raimbault libmodbus-3.0.5/doc/modbus_set_byte_timeout.txt000066400000000000000000000016321222457407600217550ustar00rootroot00000000000000modbus_set_byte_timeout(3) ========================== NAME ---- modbus_set_byte_timeout - set timeout between bytes SYNOPSIS -------- *void modbus_set_byte_timeout(modbus_t *'ctx', struct timeval *'timeout');* DESCRIPTION ----------- The _modbus_set_byte_timeout()_ function shall set the timeout interval between two consecutive bytes of the same message. If the delay between is longer than the given timeout, an error will be raised. If the timeout value has a tv_sec of -1 then this timeout will not be used at all. This results in modbus_set_response_timeout governing the entire timeout duration of an operation. RETURN VALUE ------------ There is no return values. SEE ALSO -------- linkmb:modbus_get_byte_timeout[3] linkmb:modbus_get_response_timeout[3] linkmb:modbus_set_response_timeout[3] AUTHORS ------- The libmodbus documentation was written by Stéphane Raimbault libmodbus-3.0.5/doc/modbus_set_debug.txt000066400000000000000000000015301222457407600203270ustar00rootroot00000000000000modbus_set_debug(3) =================== NAME ---- modbus_set_debug - set debug flag of the context SYNOPSIS -------- *void modbus_set_debug(modbus_t *'ctx', int 'boolean');* DESCRIPTION ----------- The _modbus_set_debug()_ function shall set the debug flag of the *modbus_t* context by using the argument 'boolean'. When the 'boolean' value is set to 'TRUE', many verbose messages are displayed on stdout and stderr. For example, this flag is useful to display the bytes of the Modbus messages. [verse] ___________________ [00][14][00][00][00][06][12][03][00][6B][00][03] Waiting for a confirmation... <00><14><00><00><00><09><12><03><06><02><2B><00><00><00><00> ___________________ RETURN VALUE ------------ There is no return values. AUTHORS ------- The libmodbus documentation was written by Stéphane Raimbault libmodbus-3.0.5/doc/modbus_set_error_recovery.txt000066400000000000000000000043551222457407600223200ustar00rootroot00000000000000modbus_set_error_recovery(3) ============================ NAME ---- modbus_set_error_recovery - set the error recovery mode SYNOPSIS -------- *int modbus_set_error_recovery(modbus_t *'ctx', modbus_error_recovery_mode 'error_recovery');* DESCRIPTION ----------- The _modbus_set_error_recovery()_ function shall set the error recovery mode to apply when the connection fails or the byte received is not expected. The argument 'error_recovery' may be bitwise-or'ed with zero or more of the following constants. By default there is no error recovery ('MODBUS_ERROR_RECOVERY_NONE') so the application is responsible for controlling the error values returned by libmodbus functions and for handling them if necessary. When 'MODBUS_ERROR_RECOVERY_LINK' is set, the library will attempt an immediate reconnection (which may hang for several seconds if the network to the remote target unit is down). This mode will try a infinite close/connect loop until success on send call and will just try one time to retablish the connection on select/read calls (if the connecton was down, the values to read are certainly not available anymore after reconnection, except for slave/server). This mode will also run flush requests after a delay based on the current response timeout in some situations (eg. timeout of select call). When 'MODBUS_ERROR_RECOVERY_PROTOCOL' is set, a sleep and flush sequence will be used to cleanup the ongoing communication, this can occurs when the message length is invalid, the TID is wrong or the received function code is not the expected one. The modes are mask values and so they are complementary. It's not recommended to enable error recovery for slave/server. RETURN VALUE ------------ The _modbus_set_error_recovery()_ function shall return 0 if successful. Otherwise it shall return -1 and set errno to one of the values defined below. ERRORS ------ *EINVAL*:: The value of the argument 'error_recovery' is not positive. EXAMPLE ------- [source,c] ------------------- modbus_set_error_recovery(ctx, MODBUS_ERROR_RECOVERY_LINK | MODBUS_ERROR_RECOVERY_PROTOCOL); ------------------- AUTHORS ------- The libmodbus documentation was written by Stéphane Raimbault libmodbus-3.0.5/doc/modbus_set_float.txt000066400000000000000000000011201222457407600203410ustar00rootroot00000000000000modbus_set_float(3) =================== NAME ---- modbus_set_float - set a float value SYNOPSIS -------- *void modbus_set_float(float 'f', uint16_t *'dest');* DESCRIPTION ----------- The _modbus_set_float()_ function shall set a float to 4 bytes in Modbus format. The 'dest' array must be pointer on two 16 bits values to be able to store the full result of the conversion. RETURN VALUE ------------ The is no return values. SEE ALSO -------- linkmb:modbus_set_float[3] AUTHORS ------- The libmodbus documentation was written by Stéphane Raimbault libmodbus-3.0.5/doc/modbus_set_response_timeout.txt000066400000000000000000000021611222457407600226460ustar00rootroot00000000000000modbus_set_response_timeout(3) ============================== NAME ---- modbus_set_response_timeout - set timeout for response SYNOPSIS -------- *void modbus_set_response_timeout(modbus_t *'ctx', struct timeval *'timeout');* DESCRIPTION ----------- The _modbus_set_response_timeout()_ function shall set the timeout interval used to wait for a response. If the waiting before receiving the response is longer than the given timeout, an error will be raised. RETURN VALUE ------------ There is no return values. EXAMPLE ------- [source,c] ------------------- struct timeval old_response_timeout; struct timeval response_timeout; /* Save original timeout */ modbus_get_response_timeout(ctx, &old_response_timeout); /* Define a new and too short timeout! */ response_timeout.tv_sec = 0; response_timeout.tv_usec = 0; modbus_set_response_timeout(ctx, &response_timeout); ------------------- SEE ALSO -------- linkmb:modbus_get_response_timeout[3] linkmb:modbus_get_byte_timeout[3] linkmb:modbus_set_byte_timeout[3] AUTHORS ------- The libmodbus documentation was written by Stéphane Raimbault libmodbus-3.0.5/doc/modbus_set_slave.txt000066400000000000000000000024121222457407600203530ustar00rootroot00000000000000modbus_set_slave(3) =================== NAME ---- modbus_set_slave - set slave number in the context SYNOPSIS -------- *int modbus_set_slave(modbus_t *'ctx', int 'slave');* DESCRIPTION ----------- The _modbus_set_slave()_ function shall set the slave number in the libmodbus context. The behavior depends of network and the role of the device: *RTU*:: Define the slave ID of the remote device to talk in master mode or set the internal slave ID in slave mode. According to the protocol, a Modbus device must only accept message holing its slave number or the special broadcast number. *TCP*:: The slave number is only required in TCP if the message must reach a device on a serial network. The special value 'MODBUS_TCP_SLAVE' (0xFF) can be used in TCP mode to restore the default value. The broadcast address is 'MODBUS_BROADCAST_ADDRESS'. This special value must be use when you want all Modbus devices of the network receive the request. RETURN VALUE ------------ The _modbus_set_slave()_ function shall return 0 if successful. Otherwise it shall return -1 and set errno to one of the values defined below. ERRORS ------ *EINVAL*:: The slave number is invalid. AUTHORS ------- The libmodbus documentation was written by Stéphane Raimbault libmodbus-3.0.5/doc/modbus_set_socket.txt000066400000000000000000000020031222457407600205250ustar00rootroot00000000000000modbus_set_socket(3) ==================== NAME ---- modbus_set_socket - set socket of the context SYNOPSIS -------- *void modbus_set_socket(modbus_t *'ctx', int 'socket');* DESCRIPTION ----------- The _modbus_set_socket()_ function shall set the socket or file descriptor in the libmodbus context. This function is useful for managing multiple client connections to the same server. RETURN VALUE ------------ There is no return values. EXAMPLE ------- [source,c] ------------------- ctx = modbus_new_tcp("127.0.0.1", 1502); server_socket = modbus_tcp_listen(ctx, NB_CONNECTION); FD_ZERO(&rdset); FD_SET(server_socket, &rdset); /* .... */ if (FD_ISSET(master_socket, &rdset)) { modbus_set_socket(ctx, master_socket); rc = modbus_receive(ctx, query); if (rc != -1) { modbus_reply(ctx, query, rc, mb_mapping); } } ------------------- SEE ALSO -------- linkmb:modbus_get_socket[3] AUTHORS ------- The libmodbus documentation was written by Stéphane Raimbault libmodbus-3.0.5/doc/modbus_strerror.txt000066400000000000000000000021131222457407600202460ustar00rootroot00000000000000modbus_strerror(3) ================= NAME ---- modbus_strerror - return the error message SYNOPSIS -------- *const char *modbus_strerror(*int 'errnum');* DESCRIPTION ----------- The _modbus_strerror()_ function shall return a pointer to an error message string corresponding to the error number specified by the 'errnum' argument. As libmodbus defines additional error numbers over and above those defined by the operating system, applications should use _modbus_strerror()_ in preference to the standard _strerror()_ function. RETURN VALUE ------------ The _modbus_strerror()_ function shall return a pointer to an error message string. ERRORS ------ No errors are defined. EXAMPLE ------- .Displaying an error message when a Modbus connection cannot be established [source,c] ------------------- if (modbus_connect(ctx) == -1) { fprintf(stderr, "Connection failed: %s\n", modbus_strerror(errno)); abort(); } ------------------- SEE ALSO -------- linkmb:libmodbus AUTHORS ------- The libmodbus documentation was written by Stéphane Raimbault libmodbus-3.0.5/doc/modbus_tcp_listen.txt000066400000000000000000000025431222457407600205370ustar00rootroot00000000000000modbus_tcp_listen(3) ==================== NAME ---- modbus_tcp_listen - create and listen a TCP Modbus socket SYNOPSIS -------- *int modbus_tcp_listen(modbus_t *'ctx', int 'nb_connection');* DESCRIPTION ----------- The _modbus_tcp_listen()_ function shall create a socket and listen for 'nb_connection' incoming connections. RETURN VALUE ------------ The _modbus_tcp_listen()_ function shall return a new socket if successful. Otherwise it shall return -1 and set errno. EXAMPLE ------- For a detailed example, see source file bandwith-server-many-up.c provided in tests directory. [source,c] ------------------- ... ctx = modbus_new_tcp("127.0.0.1", 502); if (modbus_connect(ctx) == -1) { fprintf(stderr, "Connection failed: %s\n", modbus_strerror(errno)); modbus_free(ctx); return -1; } /* Handle until 10 established connections */ server_socket = modbus_tcp_listen(ctx, 10); /* Clear the reference set of socket */ FD_ZERO(&refset); /* Add the server socket */ FD_SET(server_socket, &refset); if (select(server_socket + 1, &refset, NULL, NULL, NULL) == -1) { } ... close(server_socket); modbus_free(ctx); ------------------- SEE ALSO -------- linkmb:modbus_tcp_accept[3] linkmb:modbus_tcp_pi_accept[3] linkmb:modbus_tcp_pi_listen[3] AUTHORS ------- The libmodbus documentation was written by Stéphane Raimbault libmodbus-3.0.5/doc/modbus_write_and_read_registers.txt000066400000000000000000000026241222457407600234310ustar00rootroot00000000000000modbus_write_and_read_registers(3) ================================== NAME ---- modbus_write_and_read_registers - write and read many registers in a single transaction SYNOPSIS -------- *int modbus_write_and_read_registers(modbus_t *'ctx', int 'write_addr', int 'write_nb', const uint16_t *'src', int 'read_addr', int 'read_nb', const uint16_t *'dest');* DESCRIPTION ----------- The _modbus_write_and_read_registers()_ function shall write the content of the 'write_nb' holding registers from the array 'src' to the address 'write_addr' of the remote device then shall read the content of the 'read_nb' holding registers to the address 'read_addr' of the remote device. The result of reading is stored in 'dest' array as word values (16 bits). You must take care to allocate enough memory to store the results in 'dest' (at least 'nb' * sizeof(uint16_t)). The function uses the Modbus function code 0x17 (write/read registers). RETURN VALUE ------------ The _modbus_write_and_read_registers()_ function shall return the number of read registers if successful. Otherwise it shall return -1 and set errno. ERRORS ------ EMBMDATA:: Too many registers requested, Too many registers to write SEE ALSO -------- linkmb:modbus_read_registers[3] linkmb:modbus_write_register[3] linkmb:modbus_write_registers[3] AUTHORS ------- The libmodbus documentation was written by Stéphane Raimbault libmodbus-3.0.5/doc/modbus_write_bit.txt000066400000000000000000000013611222457407600203600ustar00rootroot00000000000000modbus_write_bit(3) =================== NAME ---- modbus_write_bit - write a single bit SYNOPSIS -------- *int modbus_write_bit(modbus_t *'ctx', int 'addr', int 'status');* DESCRIPTION ----------- The _modbus_write_bit()_ function shall write the status of 'status' at the address 'addr' of the remote device. The value must be set to _TRUE_ or _FALSE_. The function uses the Modbus function code 0x05 (force single coil). RETURN VALUE ------------ The _modbus_write_bit()_ function shall return 1 if successful. Otherwise it shall return -1 and set errno. SEE ALSO -------- linkmb:modbus_read_bits[3] linkmb:modbus_write_bits[3] AUTHORS ------- The libmodbus documentation was written by Stéphane Raimbault libmodbus-3.0.5/doc/modbus_write_bits.txt000066400000000000000000000015741222457407600205510ustar00rootroot00000000000000modbus_write_bits(3) ==================== NAME ---- modbus_write_bits - write many bits SYNOPSIS -------- *int modbus_write_bits(modbus_t *'ctx', int 'addr', int 'nb', const uint8_t *'src');* DESCRIPTION ----------- The _modbus_write_bits()_ function shall write the status of the 'nb' bits (coils) from 'src' at the address 'addr' of the remote device. The 'src' array must contains bytes set to _TRUE_ or _FALSE_. The function uses the Modbus function code 0x0F (force multiple coils). RETURN VALUE ------------ The _modbus_write_bits()_ function shall return the number of written bits if successful. Otherwise it shall return -1 and set errno. ERRORS ------ EMBMDATA:: Writing too many bits SEE ALSO -------- linkmb:modbus_read_bits[3] linkmb:modbus_write_bit[3] AUTHORS ------- The libmodbus documentation was written by Stéphane Raimbault libmodbus-3.0.5/doc/modbus_write_register.txt000066400000000000000000000014061222457407600214260ustar00rootroot00000000000000modbus_write_register(3) ======================== NAME ---- modbus_write_register - write a single register SYNOPSIS -------- *int modbus_write_register(modbus_t *'ctx', int 'addr', int 'value');* DESCRIPTION ----------- The _modbus_write_register()_ function shall write the value of 'value' holding registers at the address 'addr' of the remote device. The function uses the Modbus function code 0x06 (preset single register). RETURN VALUE ------------ The _modbus_write_register()_ function shall return 1 if successful. Otherwise it shall return -1 and set errno. SEE ALSO -------- linkmb:modbus_read_registers[3] linkmb:modbus_write_registers[3] AUTHORS ------- The libmodbus documentation was written by Stéphane Raimbault libmodbus-3.0.5/doc/modbus_write_registers.txt000066400000000000000000000015211222457407600216070ustar00rootroot00000000000000modbus_write_registers(3) ========================= NAME ---- modbus_write_registers - write many registers SYNOPSIS -------- *int modbus_write_registers(modbus_t *'ctx', int 'addr', int 'nb', const uint16_t *'src');* DESCRIPTION ----------- The _modbus_write_registers()_ function shall write the content of the 'nb' holding registers from the array 'src' at address 'addr' of the remote device. The function uses the Modbus function code 0x10 (preset multiple registers). RETURN VALUE ------------ The _modbus_write_registers()_ function shall return the number of written registers if successful. Otherwise it shall return -1 and set errno. SEE ALSO -------- linkmb:modbus_write_register[3] linkmb:modbus_read_registers[3] AUTHORS ------- The libmodbus documentation was written by Stéphane Raimbault libmodbus-3.0.5/libmodbus.pc.in000066400000000000000000000003111222457407600164140ustar00rootroot00000000000000prefix=@prefix@ exec_prefix=@exec_prefix@ libdir=@libdir@ includedir=@includedir@ Name: modbus Description: Modbus library Version: @VERSION@ Libs: -L${libdir} -lmodbus Cflags: -I${includedir}/modbus libmodbus-3.0.5/libmodbus.spec.in000066400000000000000000000070421222457407600167540ustar00rootroot00000000000000Name: libmodbus Version: @PACKAGE_VERSION@ Release: 1%{?dist} Summary: A Modbus library Group: Applications/System License: LGPLv2+ URL: http://www.libmodbus.org/ Source0: https://github.com/downloads/stephane/libmodbus/libmodbus-%{version}.tar.gz BuildRequires: autoconf, automake, libtool, xmlto, asciidoc %description libmodbus is a C library designed to provide a fast and robust implementation of the Modbus protocol. It runs on Linux, Mac OS X, FreeBSD, QNX and Windows. This package contains the libmodbus shared library. %package devel Summary: Development files for libmodbus Group: Development/Libraries Requires: %{name}%{?_isa} = %{version}-%{release} %description devel libmodbus is a C library designed to provide a fast and robust implementation of the Modbus protocol. It runs on Linux, Mac OS X, FreeBSD, QNX and Windows. This package contains libraries, header files and developer documentation needed for developing software which uses the libmodbus library. %prep %setup -q autoreconf %build %configure make %{?_smp_mflags} %install make install DESTDIR=%{buildroot} rm -f %{buildroot}/%{_libdir}/*.la %post -p /sbin/ldconfig %postun -p /sbin/ldconfig %files %defattr(-,root,root) %doc AUTHORS MIGRATION NEWS COPYING* README.rst %{_libdir}/libmodbus.so.* %files devel %defattr(-,root,root) %{_includedir}/modbus/ %{_libdir}/pkgconfig/libmodbus.pc %{_libdir}/libmodbus.so %{_mandir}/man7/*.7.* %{_mandir}/man3/*.3.* %changelog * Sun, 06 Oct 2013 Stéphane Raimbault - 3.0.5-1 - new upstream release * Wed May 08 2013 Stéphane Raimbault - 3.0.4-1 - new upstream release * Fri May 25 2012 Stéphane Raimbault - 3.0.3-1 - new upstream release * Mon Jan 16 2012 Stéphane Raimbault - 3.0.2-1 - new upstream release * Mon Jul 23 2011 Stéphane Raimbault - 3.0.1-2 - package reviewed by Peter Lemenkov and Veeti Paananen of Fedora Quality Assurance team * Mon Jul 18 2011 Stéphane Raimbault - 3.0.1-1 - new upstream release * Thu Jul 11 2011 Stéphane Raimbault - 3.0.0-1 - revert the license to LGPLv2.1+ - new spec file generated by autoconf - add documentation, devel package and various changes * Sun Jun 5 2011 Stéphane Raimbault - 2.9.4-1 - new upstream release * Mon Jan 10 2011 Stéphane Raimbault - 2.9.3-1 - new upstream release * Mon Oct 5 2010 Stéphane Raimbault - 2.9.2-1 - new upstream release * Fri Jul 2 2008 Stéphane Raimbault - 2.0.1-1 - new upstream release * Fri May 2 2008 Stéphane Raimbault - 2.0.0-1 - integrate extern_for_cpp in upstream. - update the license to version LGPL v3. * Tue Apr 30 2008 Todd Denniston - 1.9.0-2 - get the license corrected in the spec file. - add a URL for where to find libmodbus. - tweak the summary and description. * Tue Apr 29 2008 Todd Denniston - 1.9.0-1 - upgrade to latest upstream (pre-release) - port extern_for_cpp patch to 1.9.0 * Tue Apr 29 2008 Todd Denniston - 1.2.4-2_tad - add a patch to allow compiling with c++ code. * Mon Apr 28 2008 Todd Denniston - 1.2.4-1_tad - build spec file. - include patch for controling error-treat. libmodbus-3.0.5/m4/000077500000000000000000000000001222457407600140305ustar00rootroot00000000000000libmodbus-3.0.5/m4/.gitignore000066400000000000000000000001071222457407600160160ustar00rootroot00000000000000# Ignore everything in this directory * # Except this file !.gitignore libmodbus-3.0.5/src/000077500000000000000000000000001222457407600142775ustar00rootroot00000000000000libmodbus-3.0.5/src/Makefile.am000066400000000000000000000013571222457407600163410ustar00rootroot00000000000000lib_LTLIBRARIES = libmodbus.la libmodbus_la_SOURCES = \ modbus.c \ modbus.h \ modbus-data.c \ modbus-private.h \ modbus-rtu.c \ modbus-rtu.h \ modbus-rtu-private.h \ modbus-tcp.c \ modbus-tcp.h \ modbus-tcp-private.h \ modbus-version.h if OS_WIN32 libmodbus_la_LIBADD = -lwsock32 endif if OS_QNX libmodbus_la_LIBADD = -lsocket endif libmodbus_la_LDFLAGS = $(AM_LDFLAGS) -no-undefined -version-info $(LIBMODBUS_LT_VERSION_INFO) # Header files to install libmodbusincludedir = $(includedir)/modbus libmodbusinclude_HEADERS = modbus.h modbus-version.h modbus-rtu.h modbus-tcp.h DISTCLEANFILES = modbus-version.h EXTRA_DIST = modbus-version.h.in CLEANFILES = *~ libmodbus-3.0.5/src/modbus-data.c000066400000000000000000000051141222457407600166440ustar00rootroot00000000000000/* * Copyright © 2010-2011 Stéphane Raimbault * * This library is free software; you can redistribute it and/or * modify it under the terms of the GNU Lesser General Public * License as published by the Free Software Foundation; either * version 2.1 of the License, or (at your option) any later version. * * This library is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU * Lesser General Public License for more details. * * You should have received a copy of the GNU Lesser General Public * License along with this library; if not, write to the Free Software * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA */ #include #ifndef _MSC_VER #include #else #include "stdint.h" #endif #include #include /* Sets many bits from a single byte value (all 8 bits of the byte value are set) */ void modbus_set_bits_from_byte(uint8_t *dest, int index, const uint8_t value) { int i; for (i=0; i<8; i++) { dest[index+i] = (value & (1 << i)) ? 1 : 0; } } /* Sets many bits from a table of bytes (only the bits between index and index + nb_bits are set) */ void modbus_set_bits_from_bytes(uint8_t *dest, int index, unsigned int nb_bits, const uint8_t *tab_byte) { int i; int shift = 0; for (i = index; i < index + nb_bits; i++) { dest[i] = tab_byte[(i - index) / 8] & (1 << shift) ? 1 : 0; /* gcc doesn't like: shift = (++shift) % 8; */ shift++; shift %= 8; } } /* Gets the byte value from many bits. To obtain a full byte, set nb_bits to 8. */ uint8_t modbus_get_byte_from_bits(const uint8_t *src, int index, unsigned int nb_bits) { int i; uint8_t value = 0; if (nb_bits > 8) { /* Assert is ignored if NDEBUG is set */ assert(nb_bits < 8); nb_bits = 8; } for (i=0; i < nb_bits; i++) { value |= (src[index+i] << i); } return value; } /* Get a float from 4 bytes in Modbus format */ float modbus_get_float(const uint16_t *src) { float f = 0.0f; uint32_t i; i = (((uint32_t)src[1]) << 16) + src[0]; memcpy(&f, &i, sizeof(float)); return f; } /* Set a float to 4 bytes in Modbus format */ void modbus_set_float(float f, uint16_t *dest) { uint32_t i = 0; memcpy(&i, &f, sizeof(uint32_t)); dest[0] = (uint16_t)i; dest[1] = (uint16_t)(i >> 16); } libmodbus-3.0.5/src/modbus-private.h000066400000000000000000000101141222457407600174060ustar00rootroot00000000000000/* * Copyright © 2010-2012 Stéphane Raimbault * * This library is free software; you can redistribute it and/or * modify it under the terms of the GNU Lesser General Public * License as published by the Free Software Foundation; either * version 2.1 of the License, or (at your option) any later version. * * This library is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU * Lesser General Public License for more details. * * You should have received a copy of the GNU Lesser General Public * License along with this library; if not, write to the Free Software * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA */ #ifndef _MODBUS_PRIVATE_H_ #define _MODBUS_PRIVATE_H_ #ifndef _MSC_VER # include # include #else # include "stdint.h" # include typedef int ssize_t; #endif #include #include #include "modbus.h" MODBUS_BEGIN_DECLS /* It's not really the minimal length (the real one is report slave ID * in RTU (4 bytes)) but it's a convenient size to use in RTU or TCP * communications to read many values or write a single one. * Maximum between : * - HEADER_LENGTH_TCP (7) + function (1) + address (2) + number (2) * - HEADER_LENGTH_RTU (1) + function (1) + address (2) + number (2) + CRC (2) */ #define _MIN_REQ_LENGTH 12 #define _REPORT_SLAVE_ID 180 #define _MODBUS_EXCEPTION_RSP_LENGTH 5 /* Timeouts in microsecond (0.5 s) */ #define _RESPONSE_TIMEOUT 500000 #define _BYTE_TIMEOUT 500000 /* Function codes */ #define _FC_READ_COILS 0x01 #define _FC_READ_DISCRETE_INPUTS 0x02 #define _FC_READ_HOLDING_REGISTERS 0x03 #define _FC_READ_INPUT_REGISTERS 0x04 #define _FC_WRITE_SINGLE_COIL 0x05 #define _FC_WRITE_SINGLE_REGISTER 0x06 #define _FC_READ_EXCEPTION_STATUS 0x07 #define _FC_WRITE_MULTIPLE_COILS 0x0F #define _FC_WRITE_MULTIPLE_REGISTERS 0x10 #define _FC_REPORT_SLAVE_ID 0x11 #define _FC_WRITE_AND_READ_REGISTERS 0x17 typedef enum { _MODBUS_BACKEND_TYPE_RTU=0, _MODBUS_BACKEND_TYPE_TCP } modbus_bakend_type_t; /* This structure reduces the number of params in functions and so * optimizes the speed of execution (~ 37%). */ typedef struct _sft { int slave; int function; int t_id; } sft_t; typedef struct _modbus_backend { unsigned int backend_type; unsigned int header_length; unsigned int checksum_length; unsigned int max_adu_length; int (*set_slave) (modbus_t *ctx, int slave); int (*build_request_basis) (modbus_t *ctx, int function, int addr, int nb, uint8_t *req); int (*build_response_basis) (sft_t *sft, uint8_t *rsp); int (*prepare_response_tid) (const uint8_t *req, int *req_length); int (*send_msg_pre) (uint8_t *req, int req_length); ssize_t (*send) (modbus_t *ctx, const uint8_t *req, int req_length); ssize_t (*recv) (modbus_t *ctx, uint8_t *rsp, int rsp_length); int (*check_integrity) (modbus_t *ctx, uint8_t *msg, const int msg_length); int (*pre_check_confirmation) (modbus_t *ctx, const uint8_t *req, const uint8_t *rsp, int rsp_length); int (*connect) (modbus_t *ctx); void (*close) (modbus_t *ctx); int (*flush) (modbus_t *ctx); int (*select) (modbus_t *ctx, fd_set *rfds, struct timeval *tv, int msg_length); int (*filter_request) (modbus_t *ctx, int slave); } modbus_backend_t; struct _modbus { /* Slave address */ int slave; /* Socket or file descriptor */ int s; int debug; int error_recovery; struct timeval response_timeout; struct timeval byte_timeout; const modbus_backend_t *backend; void *backend_data; }; void _modbus_init_common(modbus_t *ctx); void _error_print(modbus_t *ctx, const char *context); #ifndef HAVE_STRLCPY size_t strlcpy(char *dest, const char *src, size_t dest_size); #endif MODBUS_END_DECLS #endif /* _MODBUS_PRIVATE_H_ */ libmodbus-3.0.5/src/modbus-rtu-private.h000066400000000000000000000045421222457407600202260ustar00rootroot00000000000000/* * Copyright © 2001-2011 Stéphane Raimbault * * This library is free software; you can redistribute it and/or * modify it under the terms of the GNU Lesser General Public * License as published by the Free Software Foundation; either * version 2.1 of the License, or (at your option) any later version. * * This library is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU * Lesser General Public License for more details. * * You should have received a copy of the GNU Lesser General Public * License along with this library; if not, write to the Free Software * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA */ #ifndef _MODBUS_RTU_PRIVATE_H_ #define _MODBUS_RTU_PRIVATE_H_ #ifndef _MSC_VER #include #else #include "stdint.h" #endif #if defined(_WIN32) #include #else #include #endif #define _MODBUS_RTU_HEADER_LENGTH 1 #define _MODBUS_RTU_PRESET_REQ_LENGTH 6 #define _MODBUS_RTU_PRESET_RSP_LENGTH 2 #define _MODBUS_RTU_CHECKSUM_LENGTH 2 #if defined(_WIN32) #define ENOTSUP WSAEOPNOTSUPP /* WIN32: struct containing serial handle and a receive buffer */ #define PY_BUF_SIZE 512 struct win32_ser { /* File handle */ HANDLE fd; /* Receive buffer */ uint8_t buf[PY_BUF_SIZE]; /* Received chars */ DWORD n_bytes; }; #endif /* _WIN32 */ typedef struct _modbus_rtu { /* Device: "/dev/ttyS0", "/dev/ttyUSB0" or "/dev/tty.USA19*" on Mac OS X for KeySpan USB<->Serial adapters this string had to be made bigger on OS X as the directory+file name was bigger than 19 bytes. Making it 67 bytes for now, but OS X does support 256 byte file names. May become a problem in the future. */ #if defined(__APPLE_CC__) char device[64]; #else char device[16]; #endif /* Bauds: 9600, 19200, 57600, 115200, etc */ int baud; /* Data bit */ uint8_t data_bit; /* Stop bit */ uint8_t stop_bit; /* Parity: 'N', 'O', 'E' */ char parity; #if defined(_WIN32) struct win32_ser w_ser; DCB old_dcb; #else /* Save old termios settings */ struct termios old_tios; #endif #if HAVE_DECL_TIOCSRS485 int serial_mode; #endif } modbus_rtu_t; #endif /* _MODBUS_RTU_PRIVATE_H_ */ libmodbus-3.0.5/src/modbus-rtu.c000066400000000000000000000672211222457407600165540ustar00rootroot00000000000000/* * Copyright © 2001-2011 Stéphane Raimbault * * This library is free software; you can redistribute it and/or * modify it under the terms of the GNU Lesser General Public * License as published by the Free Software Foundation; either * version 2.1 of the License, or (at your option) any later version. * * This library is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU * Lesser General Public License for more details. * * You should have received a copy of the GNU Lesser General Public * License along with this library; if not, write to the Free Software * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA */ #include #include #include #include #include #ifndef _MSC_VER #include #endif #include #include "modbus-private.h" #include "modbus-rtu.h" #include "modbus-rtu-private.h" #if HAVE_DECL_TIOCSRS485 #include #include #endif /* Table of CRC values for high-order byte */ static const uint8_t table_crc_hi[] = { 0x00, 0xC1, 0x81, 0x40, 0x01, 0xC0, 0x80, 0x41, 0x01, 0xC0, 0x80, 0x41, 0x00, 0xC1, 0x81, 0x40, 0x01, 0xC0, 0x80, 0x41, 0x00, 0xC1, 0x81, 0x40, 0x00, 0xC1, 0x81, 0x40, 0x01, 0xC0, 0x80, 0x41, 0x01, 0xC0, 0x80, 0x41, 0x00, 0xC1, 0x81, 0x40, 0x00, 0xC1, 0x81, 0x40, 0x01, 0xC0, 0x80, 0x41, 0x00, 0xC1, 0x81, 0x40, 0x01, 0xC0, 0x80, 0x41, 0x01, 0xC0, 0x80, 0x41, 0x00, 0xC1, 0x81, 0x40, 0x01, 0xC0, 0x80, 0x41, 0x00, 0xC1, 0x81, 0x40, 0x00, 0xC1, 0x81, 0x40, 0x01, 0xC0, 0x80, 0x41, 0x00, 0xC1, 0x81, 0x40, 0x01, 0xC0, 0x80, 0x41, 0x01, 0xC0, 0x80, 0x41, 0x00, 0xC1, 0x81, 0x40, 0x00, 0xC1, 0x81, 0x40, 0x01, 0xC0, 0x80, 0x41, 0x01, 0xC0, 0x80, 0x41, 0x00, 0xC1, 0x81, 0x40, 0x01, 0xC0, 0x80, 0x41, 0x00, 0xC1, 0x81, 0x40, 0x00, 0xC1, 0x81, 0x40, 0x01, 0xC0, 0x80, 0x41, 0x01, 0xC0, 0x80, 0x41, 0x00, 0xC1, 0x81, 0x40, 0x00, 0xC1, 0x81, 0x40, 0x01, 0xC0, 0x80, 0x41, 0x00, 0xC1, 0x81, 0x40, 0x01, 0xC0, 0x80, 0x41, 0x01, 0xC0, 0x80, 0x41, 0x00, 0xC1, 0x81, 0x40, 0x00, 0xC1, 0x81, 0x40, 0x01, 0xC0, 0x80, 0x41, 0x01, 0xC0, 0x80, 0x41, 0x00, 0xC1, 0x81, 0x40, 0x01, 0xC0, 0x80, 0x41, 0x00, 0xC1, 0x81, 0x40, 0x00, 0xC1, 0x81, 0x40, 0x01, 0xC0, 0x80, 0x41, 0x00, 0xC1, 0x81, 0x40, 0x01, 0xC0, 0x80, 0x41, 0x01, 0xC0, 0x80, 0x41, 0x00, 0xC1, 0x81, 0x40, 0x01, 0xC0, 0x80, 0x41, 0x00, 0xC1, 0x81, 0x40, 0x00, 0xC1, 0x81, 0x40, 0x01, 0xC0, 0x80, 0x41, 0x01, 0xC0, 0x80, 0x41, 0x00, 0xC1, 0x81, 0x40, 0x00, 0xC1, 0x81, 0x40, 0x01, 0xC0, 0x80, 0x41, 0x00, 0xC1, 0x81, 0x40, 0x01, 0xC0, 0x80, 0x41, 0x01, 0xC0, 0x80, 0x41, 0x00, 0xC1, 0x81, 0x40 }; /* Table of CRC values for low-order byte */ static const uint8_t table_crc_lo[] = { 0x00, 0xC0, 0xC1, 0x01, 0xC3, 0x03, 0x02, 0xC2, 0xC6, 0x06, 0x07, 0xC7, 0x05, 0xC5, 0xC4, 0x04, 0xCC, 0x0C, 0x0D, 0xCD, 0x0F, 0xCF, 0xCE, 0x0E, 0x0A, 0xCA, 0xCB, 0x0B, 0xC9, 0x09, 0x08, 0xC8, 0xD8, 0x18, 0x19, 0xD9, 0x1B, 0xDB, 0xDA, 0x1A, 0x1E, 0xDE, 0xDF, 0x1F, 0xDD, 0x1D, 0x1C, 0xDC, 0x14, 0xD4, 0xD5, 0x15, 0xD7, 0x17, 0x16, 0xD6, 0xD2, 0x12, 0x13, 0xD3, 0x11, 0xD1, 0xD0, 0x10, 0xF0, 0x30, 0x31, 0xF1, 0x33, 0xF3, 0xF2, 0x32, 0x36, 0xF6, 0xF7, 0x37, 0xF5, 0x35, 0x34, 0xF4, 0x3C, 0xFC, 0xFD, 0x3D, 0xFF, 0x3F, 0x3E, 0xFE, 0xFA, 0x3A, 0x3B, 0xFB, 0x39, 0xF9, 0xF8, 0x38, 0x28, 0xE8, 0xE9, 0x29, 0xEB, 0x2B, 0x2A, 0xEA, 0xEE, 0x2E, 0x2F, 0xEF, 0x2D, 0xED, 0xEC, 0x2C, 0xE4, 0x24, 0x25, 0xE5, 0x27, 0xE7, 0xE6, 0x26, 0x22, 0xE2, 0xE3, 0x23, 0xE1, 0x21, 0x20, 0xE0, 0xA0, 0x60, 0x61, 0xA1, 0x63, 0xA3, 0xA2, 0x62, 0x66, 0xA6, 0xA7, 0x67, 0xA5, 0x65, 0x64, 0xA4, 0x6C, 0xAC, 0xAD, 0x6D, 0xAF, 0x6F, 0x6E, 0xAE, 0xAA, 0x6A, 0x6B, 0xAB, 0x69, 0xA9, 0xA8, 0x68, 0x78, 0xB8, 0xB9, 0x79, 0xBB, 0x7B, 0x7A, 0xBA, 0xBE, 0x7E, 0x7F, 0xBF, 0x7D, 0xBD, 0xBC, 0x7C, 0xB4, 0x74, 0x75, 0xB5, 0x77, 0xB7, 0xB6, 0x76, 0x72, 0xB2, 0xB3, 0x73, 0xB1, 0x71, 0x70, 0xB0, 0x50, 0x90, 0x91, 0x51, 0x93, 0x53, 0x52, 0x92, 0x96, 0x56, 0x57, 0x97, 0x55, 0x95, 0x94, 0x54, 0x9C, 0x5C, 0x5D, 0x9D, 0x5F, 0x9F, 0x9E, 0x5E, 0x5A, 0x9A, 0x9B, 0x5B, 0x99, 0x59, 0x58, 0x98, 0x88, 0x48, 0x49, 0x89, 0x4B, 0x8B, 0x8A, 0x4A, 0x4E, 0x8E, 0x8F, 0x4F, 0x8D, 0x4D, 0x4C, 0x8C, 0x44, 0x84, 0x85, 0x45, 0x87, 0x47, 0x46, 0x86, 0x82, 0x42, 0x43, 0x83, 0x41, 0x81, 0x80, 0x40 }; /* Define the slave ID of the remote device to talk in master mode or set the * internal slave ID in slave mode */ static int _modbus_set_slave(modbus_t *ctx, int slave) { /* Broadcast address is 0 (MODBUS_BROADCAST_ADDRESS) */ if (slave >= 0 && slave <= 247) { ctx->slave = slave; } else { errno = EINVAL; return -1; } return 0; } /* Builds a RTU request header */ static int _modbus_rtu_build_request_basis(modbus_t *ctx, int function, int addr, int nb, uint8_t *req) { assert(ctx->slave != -1); req[0] = ctx->slave; req[1] = function; req[2] = addr >> 8; req[3] = addr & 0x00ff; req[4] = nb >> 8; req[5] = nb & 0x00ff; return _MODBUS_RTU_PRESET_REQ_LENGTH; } /* Builds a RTU response header */ static int _modbus_rtu_build_response_basis(sft_t *sft, uint8_t *rsp) { /* In this case, the slave is certainly valid because a check is already * done in _modbus_rtu_listen */ rsp[0] = sft->slave; rsp[1] = sft->function; return _MODBUS_RTU_PRESET_RSP_LENGTH; } static uint16_t crc16(uint8_t *buffer, uint16_t buffer_length) { uint8_t crc_hi = 0xFF; /* high CRC byte initialized */ uint8_t crc_lo = 0xFF; /* low CRC byte initialized */ unsigned int i; /* will index into CRC lookup */ /* pass through message buffer */ while (buffer_length--) { i = crc_hi ^ *buffer++; /* calculate the CRC */ crc_hi = crc_lo ^ table_crc_hi[i]; crc_lo = table_crc_lo[i]; } return (crc_hi << 8 | crc_lo); } int _modbus_rtu_prepare_response_tid(const uint8_t *req, int *req_length) { (*req_length) -= _MODBUS_RTU_CHECKSUM_LENGTH; /* No TID */ return 0; } int _modbus_rtu_send_msg_pre(uint8_t *req, int req_length) { uint16_t crc = crc16(req, req_length); req[req_length++] = crc >> 8; req[req_length++] = crc & 0x00FF; return req_length; } #if defined(_WIN32) /* This simple implementation is sort of a substitute of the select() call, * working this way: the win32_ser_select() call tries to read some data from * the serial port, setting the timeout as the select() call would. Data read is * stored into the receive buffer, that is then consumed by the win32_ser_read() * call. So win32_ser_select() does both the event waiting and the reading, * while win32_ser_read() only consumes the receive buffer. */ static void win32_ser_init(struct win32_ser *ws) { /* Clear everything */ memset(ws, 0x00, sizeof(struct win32_ser)); /* Set file handle to invalid */ ws->fd = INVALID_HANDLE_VALUE; } /* FIXME Try to remove length_to_read -> max_len argument, only used by win32 */ static int win32_ser_select(struct win32_ser *ws, int max_len, struct timeval *tv) { COMMTIMEOUTS comm_to; unsigned int msec = 0; /* Check if some data still in the buffer to be consumed */ if (ws->n_bytes > 0) { return 1; } /* Setup timeouts like select() would do. FIXME Please someone on Windows can look at this? Does it possible to use WaitCommEvent? When tv is NULL, MAXDWORD isn't infinite! */ if (tv == NULL) { msec = MAXDWORD; } else { msec = tv->tv_sec * 1000 + tv->tv_usec / 1000; if (msec < 1) msec = 1; } comm_to.ReadIntervalTimeout = msec; comm_to.ReadTotalTimeoutMultiplier = 0; comm_to.ReadTotalTimeoutConstant = msec; comm_to.WriteTotalTimeoutMultiplier = 0; comm_to.WriteTotalTimeoutConstant = 1000; SetCommTimeouts(ws->fd, &comm_to); /* Read some bytes */ if ((max_len > PY_BUF_SIZE) || (max_len < 0)) { max_len = PY_BUF_SIZE; } if (ReadFile(ws->fd, &ws->buf, max_len, &ws->n_bytes, NULL)) { /* Check if some bytes available */ if (ws->n_bytes > 0) { /* Some bytes read */ return 1; } else { /* Just timed out */ return 0; } } else { /* Some kind of error */ return -1; } } static int win32_ser_read(struct win32_ser *ws, uint8_t *p_msg, unsigned int max_len) { unsigned int n = ws->n_bytes; if (max_len < n) { n = max_len; } if (n > 0) { memcpy(p_msg, ws->buf, n); } ws->n_bytes -= n; return n; } #endif ssize_t _modbus_rtu_send(modbus_t *ctx, const uint8_t *req, int req_length) { #if defined(_WIN32) modbus_rtu_t *ctx_rtu = ctx->backend_data; DWORD n_bytes = 0; return (WriteFile(ctx_rtu->w_ser.fd, req, req_length, &n_bytes, NULL)) ? n_bytes : -1; #else return write(ctx->s, req, req_length); #endif } ssize_t _modbus_rtu_recv(modbus_t *ctx, uint8_t *rsp, int rsp_length) { #if defined(_WIN32) return win32_ser_read(&((modbus_rtu_t *)ctx->backend_data)->w_ser, rsp, rsp_length); #else return read(ctx->s, rsp, rsp_length); #endif } int _modbus_rtu_flush(modbus_t *); /* The check_crc16 function shall return the message length if the CRC is valid. Otherwise it shall return -1 and set errno to EMBADCRC. */ int _modbus_rtu_check_integrity(modbus_t *ctx, uint8_t *msg, const int msg_length) { uint16_t crc_calculated; uint16_t crc_received; crc_calculated = crc16(msg, msg_length - 2); crc_received = (msg[msg_length - 2] << 8) | msg[msg_length - 1]; /* Check CRC of msg */ if (crc_calculated == crc_received) { return msg_length; } else { if (ctx->debug) { fprintf(stderr, "ERROR CRC received %0X != CRC calculated %0X\n", crc_received, crc_calculated); } if (ctx->error_recovery & MODBUS_ERROR_RECOVERY_PROTOCOL) { _modbus_rtu_flush(ctx); } errno = EMBBADCRC; return -1; } } /* Sets up a serial port for RTU communications */ static int _modbus_rtu_connect(modbus_t *ctx) { #if defined(_WIN32) DCB dcb; #else struct termios tios; speed_t speed; #endif modbus_rtu_t *ctx_rtu = ctx->backend_data; if (ctx->debug) { printf("Opening %s at %d bauds (%c, %d, %d)\n", ctx_rtu->device, ctx_rtu->baud, ctx_rtu->parity, ctx_rtu->data_bit, ctx_rtu->stop_bit); } #if defined(_WIN32) /* Some references here: * http://msdn.microsoft.com/en-us/library/aa450602.aspx */ win32_ser_init(&ctx_rtu->w_ser); /* ctx_rtu->device should contain a string like "COMxx:" xx being a decimal * number */ ctx_rtu->w_ser.fd = CreateFileA(ctx_rtu->device, GENERIC_READ | GENERIC_WRITE, 0, NULL, OPEN_EXISTING, 0, NULL); /* Error checking */ if (ctx_rtu->w_ser.fd == INVALID_HANDLE_VALUE) { fprintf(stderr, "ERROR Can't open the device %s (%s)\n", ctx_rtu->device, strerror(errno)); return -1; } /* Save params */ ctx_rtu->old_dcb.DCBlength = sizeof(DCB); if (!GetCommState(ctx_rtu->w_ser.fd, &ctx_rtu->old_dcb)) { fprintf(stderr, "ERROR Error getting configuration (LastError %d)\n", (int)GetLastError()); CloseHandle(ctx_rtu->w_ser.fd); ctx_rtu->w_ser.fd = INVALID_HANDLE_VALUE; return -1; } /* Build new configuration (starting from current settings) */ dcb = ctx_rtu->old_dcb; /* Speed setting */ switch (ctx_rtu->baud) { case 110: dcb.BaudRate = CBR_110; break; case 300: dcb.BaudRate = CBR_300; break; case 600: dcb.BaudRate = CBR_600; break; case 1200: dcb.BaudRate = CBR_1200; break; case 2400: dcb.BaudRate = CBR_2400; break; case 4800: dcb.BaudRate = CBR_4800; break; case 9600: dcb.BaudRate = CBR_9600; break; case 19200: dcb.BaudRate = CBR_19200; break; case 38400: dcb.BaudRate = CBR_38400; break; case 57600: dcb.BaudRate = CBR_57600; break; case 115200: dcb.BaudRate = CBR_115200; break; default: dcb.BaudRate = CBR_9600; printf("WARNING Unknown baud rate %d for %s (B9600 used)\n", ctx_rtu->baud, ctx_rtu->device); } /* Data bits */ switch (ctx_rtu->data_bit) { case 5: dcb.ByteSize = 5; break; case 6: dcb.ByteSize = 6; break; case 7: dcb.ByteSize = 7; break; case 8: default: dcb.ByteSize = 8; break; } /* Stop bits */ if (ctx_rtu->stop_bit == 1) dcb.StopBits = ONESTOPBIT; else /* 2 */ dcb.StopBits = TWOSTOPBITS; /* Parity */ if (ctx_rtu->parity == 'N') { dcb.Parity = NOPARITY; dcb.fParity = FALSE; } else if (ctx_rtu->parity == 'E') { dcb.Parity = EVENPARITY; dcb.fParity = TRUE; } else { /* odd */ dcb.Parity = ODDPARITY; dcb.fParity = TRUE; } /* Hardware handshaking left as default settings retrieved */ /* No software handshaking */ dcb.fTXContinueOnXoff = TRUE; dcb.fOutX = FALSE; dcb.fInX = FALSE; /* Binary mode (it's the only supported on Windows anyway) */ dcb.fBinary = TRUE; /* Don't want errors to be blocking */ dcb.fAbortOnError = FALSE; /* TODO: any other flags!? */ /* Setup port */ if (!SetCommState(ctx_rtu->w_ser.fd, &dcb)) { fprintf(stderr, "ERROR Error setting new configuration (LastError %d)\n", (int)GetLastError()); CloseHandle(ctx_rtu->w_ser.fd); ctx_rtu->w_ser.fd = INVALID_HANDLE_VALUE; return -1; } #else /* The O_NOCTTY flag tells UNIX that this program doesn't want to be the "controlling terminal" for that port. If you don't specify this then any input (such as keyboard abort signals and so forth) will affect your process Timeouts are ignored in canonical input mode or when the NDELAY option is set on the file via open or fcntl */ ctx->s = open(ctx_rtu->device, O_RDWR | O_NOCTTY | O_NDELAY | O_EXCL); if (ctx->s == -1) { fprintf(stderr, "ERROR Can't open the device %s (%s)\n", ctx_rtu->device, strerror(errno)); return -1; } /* Save */ tcgetattr(ctx->s, &(ctx_rtu->old_tios)); memset(&tios, 0, sizeof(struct termios)); /* C_ISPEED Input baud (new interface) C_OSPEED Output baud (new interface) */ switch (ctx_rtu->baud) { case 110: speed = B110; break; case 300: speed = B300; break; case 600: speed = B600; break; case 1200: speed = B1200; break; case 2400: speed = B2400; break; case 4800: speed = B4800; break; case 9600: speed = B9600; break; case 19200: speed = B19200; break; case 38400: speed = B38400; break; case 57600: speed = B57600; break; case 115200: speed = B115200; break; default: speed = B9600; if (ctx->debug) { fprintf(stderr, "WARNING Unknown baud rate %d for %s (B9600 used)\n", ctx_rtu->baud, ctx_rtu->device); } } /* Set the baud rate */ if ((cfsetispeed(&tios, speed) < 0) || (cfsetospeed(&tios, speed) < 0)) { close(ctx->s); ctx->s = -1; return -1; } /* C_CFLAG Control options CLOCAL Local line - do not change "owner" of port CREAD Enable receiver */ tios.c_cflag |= (CREAD | CLOCAL); /* CSIZE, HUPCL, CRTSCTS (hardware flow control) */ /* Set data bits (5, 6, 7, 8 bits) CSIZE Bit mask for data bits */ tios.c_cflag &= ~CSIZE; switch (ctx_rtu->data_bit) { case 5: tios.c_cflag |= CS5; break; case 6: tios.c_cflag |= CS6; break; case 7: tios.c_cflag |= CS7; break; case 8: default: tios.c_cflag |= CS8; break; } /* Stop bit (1 or 2) */ if (ctx_rtu->stop_bit == 1) tios.c_cflag &=~ CSTOPB; else /* 2 */ tios.c_cflag |= CSTOPB; /* PARENB Enable parity bit PARODD Use odd parity instead of even */ if (ctx_rtu->parity == 'N') { /* None */ tios.c_cflag &=~ PARENB; } else if (ctx_rtu->parity == 'E') { /* Even */ tios.c_cflag |= PARENB; tios.c_cflag &=~ PARODD; } else { /* Odd */ tios.c_cflag |= PARENB; tios.c_cflag |= PARODD; } /* Read the man page of termios if you need more information. */ /* This field isn't used on POSIX systems tios.c_line = 0; */ /* C_LFLAG Line options ISIG Enable SIGINTR, SIGSUSP, SIGDSUSP, and SIGQUIT signals ICANON Enable canonical input (else raw) XCASE Map uppercase \lowercase (obsolete) ECHO Enable echoing of input characters ECHOE Echo erase character as BS-SP-BS ECHOK Echo NL after kill character ECHONL Echo NL NOFLSH Disable flushing of input buffers after interrupt or quit characters IEXTEN Enable extended functions ECHOCTL Echo control characters as ^char and delete as ~? ECHOPRT Echo erased character as character erased ECHOKE BS-SP-BS entire line on line kill FLUSHO Output being flushed PENDIN Retype pending input at next read or input char TOSTOP Send SIGTTOU for background output Canonical input is line-oriented. Input characters are put into a buffer which can be edited interactively by the user until a CR (carriage return) or LF (line feed) character is received. Raw input is unprocessed. Input characters are passed through exactly as they are received, when they are received. Generally you'll deselect the ICANON, ECHO, ECHOE, and ISIG options when using raw input */ /* Raw input */ tios.c_lflag &= ~(ICANON | ECHO | ECHOE | ISIG); /* C_IFLAG Input options Constant Description INPCK Enable parity check IGNPAR Ignore parity errors PARMRK Mark parity errors ISTRIP Strip parity bits IXON Enable software flow control (outgoing) IXOFF Enable software flow control (incoming) IXANY Allow any character to start flow again IGNBRK Ignore break condition BRKINT Send a SIGINT when a break condition is detected INLCR Map NL to CR IGNCR Ignore CR ICRNL Map CR to NL IUCLC Map uppercase to lowercase IMAXBEL Echo BEL on input line too long */ if (ctx_rtu->parity == 'N') { /* None */ tios.c_iflag &= ~INPCK; } else { tios.c_iflag |= INPCK; } /* Software flow control is disabled */ tios.c_iflag &= ~(IXON | IXOFF | IXANY); /* C_OFLAG Output options OPOST Postprocess output (not set = raw output) ONLCR Map NL to CR-NL ONCLR ant others needs OPOST to be enabled */ /* Raw ouput */ tios.c_oflag &=~ OPOST; /* C_CC Control characters VMIN Minimum number of characters to read VTIME Time to wait for data (tenths of seconds) UNIX serial interface drivers provide the ability to specify character and packet timeouts. Two elements of the c_cc array are used for timeouts: VMIN and VTIME. Timeouts are ignored in canonical input mode or when the NDELAY option is set on the file via open or fcntl. VMIN specifies the minimum number of characters to read. If it is set to 0, then the VTIME value specifies the time to wait for every character read. Note that this does not mean that a read call for N bytes will wait for N characters to come in. Rather, the timeout will apply to the first character and the read call will return the number of characters immediately available (up to the number you request). If VMIN is non-zero, VTIME specifies the time to wait for the first character read. If a character is read within the time given, any read will block (wait) until all VMIN characters are read. That is, once the first character is read, the serial interface driver expects to receive an entire packet of characters (VMIN bytes total). If no character is read within the time allowed, then the call to read returns 0. This method allows you to tell the serial driver you need exactly N bytes and any read call will return 0 or N bytes. However, the timeout only applies to the first character read, so if for some reason the driver misses one character inside the N byte packet then the read call could block forever waiting for additional input characters. VTIME specifies the amount of time to wait for incoming characters in tenths of seconds. If VTIME is set to 0 (the default), reads will block (wait) indefinitely unless the NDELAY option is set on the port with open or fcntl. */ /* Unused because we use open with the NDELAY option */ tios.c_cc[VMIN] = 0; tios.c_cc[VTIME] = 0; if (tcsetattr(ctx->s, TCSANOW, &tios) < 0) { close(ctx->s); ctx->s = -1; return -1; } #endif #if HAVE_DECL_TIOCSRS485 /* The RS232 mode has been set by default */ ctx_rtu->serial_mode = MODBUS_RTU_RS232; #endif return 0; } int modbus_rtu_set_serial_mode(modbus_t *ctx, int mode) { if (ctx->backend->backend_type == _MODBUS_BACKEND_TYPE_RTU) { #if HAVE_DECL_TIOCSRS485 modbus_rtu_t *ctx_rtu = ctx->backend_data; struct serial_rs485 rs485conf; memset(&rs485conf, 0x0, sizeof(struct serial_rs485)); if (mode == MODBUS_RTU_RS485) { rs485conf.flags = SER_RS485_ENABLED; if (ioctl(ctx->s, TIOCSRS485, &rs485conf) < 0) { return -1; } ctx_rtu->serial_mode |= MODBUS_RTU_RS485; return 0; } else if (mode == MODBUS_RTU_RS232) { if (ioctl(ctx->s, TIOCSRS485, &rs485conf) < 0) { return -1; } ctx_rtu->serial_mode = MODBUS_RTU_RS232; return 0; } #else if (ctx->debug) { fprintf(stderr, "This function isn't supported on your platform\n"); } errno = ENOTSUP; return -1; #endif } /* Wrong backend and invalid mode specified */ errno = EINVAL; return -1; } int modbus_rtu_get_serial_mode(modbus_t *ctx) { if (ctx->backend->backend_type == _MODBUS_BACKEND_TYPE_RTU) { #if HAVE_DECL_TIOCSRS485 modbus_rtu_t *ctx_rtu = ctx->backend_data; return ctx_rtu->serial_mode; #else if (ctx->debug) { fprintf(stderr, "This function isn't supported on your platform\n"); } errno = ENOTSUP; return -1; #endif } else { errno = EINVAL; return -1; } } void _modbus_rtu_close(modbus_t *ctx) { /* Closes the file descriptor in RTU mode */ modbus_rtu_t *ctx_rtu = ctx->backend_data; #if defined(_WIN32) /* Revert settings */ if (!SetCommState(ctx_rtu->w_ser.fd, &ctx_rtu->old_dcb)) fprintf(stderr, "ERROR Couldn't revert to configuration (LastError %d)\n", (int)GetLastError()); if (!CloseHandle(ctx_rtu->w_ser.fd)) fprintf(stderr, "ERROR Error while closing handle (LastError %d)\n", (int)GetLastError()); #else tcsetattr(ctx->s, TCSANOW, &(ctx_rtu->old_tios)); close(ctx->s); #endif } int _modbus_rtu_flush(modbus_t *ctx) { #if defined(_WIN32) modbus_rtu_t *ctx_rtu = ctx->backend_data; ctx_rtu->w_ser.n_bytes = 0; return (FlushFileBuffers(ctx_rtu->w_ser.fd) == FALSE); #else return tcflush(ctx->s, TCIOFLUSH); #endif } int _modbus_rtu_select(modbus_t *ctx, fd_set *rfds, struct timeval *tv, int length_to_read) { int s_rc; #if defined(_WIN32) s_rc = win32_ser_select(&(((modbus_rtu_t*)ctx->backend_data)->w_ser), length_to_read, tv); if (s_rc == 0) { errno = ETIMEDOUT; return -1; } if (s_rc < 0) { return -1; } #else while ((s_rc = select(ctx->s+1, rfds, NULL, NULL, tv)) == -1) { if (errno == EINTR) { if (ctx->debug) { fprintf(stderr, "A non blocked signal was caught\n"); } /* Necessary after an error */ FD_ZERO(rfds); FD_SET(ctx->s, rfds); } else { return -1; } } if (s_rc == 0) { /* Timeout */ errno = ETIMEDOUT; return -1; } #endif return s_rc; } int _modbus_rtu_filter_request(modbus_t *ctx, int slave) { /* Filter on the Modbus unit identifier (slave) in RTU mode */ if (slave != ctx->slave && slave != MODBUS_BROADCAST_ADDRESS) { /* Ignores the request (not for me) */ if (ctx->debug) { printf("Request for slave %d ignored (not %d)\n", slave, ctx->slave); } return 1; } else { return 0; } } const modbus_backend_t _modbus_rtu_backend = { _MODBUS_BACKEND_TYPE_RTU, _MODBUS_RTU_HEADER_LENGTH, _MODBUS_RTU_CHECKSUM_LENGTH, MODBUS_RTU_MAX_ADU_LENGTH, _modbus_set_slave, _modbus_rtu_build_request_basis, _modbus_rtu_build_response_basis, _modbus_rtu_prepare_response_tid, _modbus_rtu_send_msg_pre, _modbus_rtu_send, _modbus_rtu_recv, _modbus_rtu_check_integrity, NULL, _modbus_rtu_connect, _modbus_rtu_close, _modbus_rtu_flush, _modbus_rtu_select, _modbus_rtu_filter_request }; modbus_t* modbus_new_rtu(const char *device, int baud, char parity, int data_bit, int stop_bit) { modbus_t *ctx; modbus_rtu_t *ctx_rtu; size_t dest_size; size_t ret_size; ctx = (modbus_t *) malloc(sizeof(modbus_t)); _modbus_init_common(ctx); ctx->backend = &_modbus_rtu_backend; ctx->backend_data = (modbus_rtu_t *) malloc(sizeof(modbus_rtu_t)); ctx_rtu = (modbus_rtu_t *)ctx->backend_data; dest_size = sizeof(ctx_rtu->device); ret_size = strlcpy(ctx_rtu->device, device, dest_size); if (ret_size == 0) { fprintf(stderr, "The device string is empty\n"); modbus_free(ctx); errno = EINVAL; return NULL; } if (ret_size >= dest_size) { fprintf(stderr, "The device string has been truncated\n"); modbus_free(ctx); errno = EINVAL; return NULL; } ctx_rtu->baud = baud; if (parity == 'N' || parity == 'E' || parity == 'O') { ctx_rtu->parity = parity; } else { modbus_free(ctx); errno = EINVAL; return NULL; } ctx_rtu->data_bit = data_bit; ctx_rtu->stop_bit = stop_bit; return ctx; } libmodbus-3.0.5/src/modbus-rtu.h000066400000000000000000000026321222457407600165540ustar00rootroot00000000000000/* * Copyright © 2001-2011 Stéphane Raimbault * * This library is free software; you can redistribute it and/or * modify it under the terms of the GNU Lesser General Public * License as published by the Free Software Foundation; either * version 2.1 of the License, or (at your option) any later version. * * This library is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU * Lesser General Public License for more details. * * You should have received a copy of the GNU Lesser General Public * License along with this library; if not, write to the Free Software * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA */ #ifndef _MODBUS_RTU_H_ #define _MODBUS_RTU_H_ #include "modbus.h" MODBUS_BEGIN_DECLS /* Modbus_Application_Protocol_V1_1b.pdf Chapter 4 Section 1 Page 5 * RS232 / RS485 ADU = 253 bytes + slave (1 byte) + CRC (2 bytes) = 256 bytes */ #define MODBUS_RTU_MAX_ADU_LENGTH 256 modbus_t* modbus_new_rtu(const char *device, int baud, char parity, int data_bit, int stop_bit); #define MODBUS_RTU_RS232 0 #define MODBUS_RTU_RS485 1 int modbus_rtu_set_serial_mode(modbus_t *ctx, int mode); int modbus_rtu_get_serial_mode(modbus_t *ctx); MODBUS_END_DECLS #endif /* _MODBUS_RTU_H_ */ libmodbus-3.0.5/src/modbus-tcp-private.h000066400000000000000000000027421222457407600202020ustar00rootroot00000000000000/* * Copyright © 2001-2011 Stéphane Raimbault * * This library is free software; you can redistribute it and/or * modify it under the terms of the GNU Lesser General Public * License as published by the Free Software Foundation; either * version 2.1 of the License, or (at your option) any later version. * * This library is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU * Lesser General Public License for more details. * * You should have received a copy of the GNU Lesser General Public * License along with this library; if not, write to the Free Software * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA */ #ifndef _MODBUS_TCP_PRIVATE_H_ #define _MODBUS_TCP_PRIVATE_H_ #define _MODBUS_TCP_HEADER_LENGTH 7 #define _MODBUS_TCP_PRESET_REQ_LENGTH 12 #define _MODBUS_TCP_PRESET_RSP_LENGTH 8 #define _MODBUS_TCP_CHECKSUM_LENGTH 0 typedef struct _modbus_tcp { /* TCP port */ int port; /* IP address */ char ip[16]; } modbus_tcp_t; #define _MODBUS_TCP_PI_NODE_LENGTH 1025 #define _MODBUS_TCP_PI_SERVICE_LENGTH 32 typedef struct _modbus_tcp_pi { /* TCP port */ int port; /* Node */ char node[_MODBUS_TCP_PI_NODE_LENGTH]; /* Service */ char service[_MODBUS_TCP_PI_SERVICE_LENGTH]; } modbus_tcp_pi_t; #endif /* _MODBUS_TCP_PRIVATE_H_ */ libmodbus-3.0.5/src/modbus-tcp.c000066400000000000000000000441661222457407600165330ustar00rootroot00000000000000/* * Copyright © 2001-2011 Stéphane Raimbault * * This library is free software; you can redistribute it and/or * modify it under the terms of the GNU Lesser General Public * License as published by the Free Software Foundation; either * version 2.1 of the License, or (at your option) any later version. * * This library is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU * Lesser General Public License for more details. * * You should have received a copy of the GNU Lesser General Public * License along with this library; if not, write to the Free Software * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA */ #include #include #include #include #ifndef _MSC_VER #include #endif #include #include #if defined(_WIN32) # define OS_WIN32 /* ws2_32.dll has getaddrinfo and freeaddrinfo on Windows XP and later. * minwg32 headers check WINVER before allowing the use of these */ # ifndef WINVER # define WINVER 0x0501 # endif # include # define SHUT_RDWR 2 # define close closesocket #else # include # include #if defined(__OpenBSD__) || (defined(__FreeBSD__) && __FreeBSD__ < 5) # define OS_BSD # include #endif # include # include # include # include # include # include #endif #if !defined(MSG_NOSIGNAL) #define MSG_NOSIGNAL 0 #endif #include "modbus-private.h" #include "modbus-tcp.h" #include "modbus-tcp-private.h" #ifdef OS_WIN32 static int _modbus_tcp_init_win32(void) { /* Initialise Windows Socket API */ WSADATA wsaData; if (WSAStartup(MAKEWORD(2, 2), &wsaData) != 0) { fprintf(stderr, "WSAStartup() returned error code %d\n", (unsigned int)GetLastError()); errno = EIO; return -1; } return 0; } #endif static int _modbus_set_slave(modbus_t *ctx, int slave) { /* Broadcast address is 0 (MODBUS_BROADCAST_ADDRESS) */ if (slave >= 0 && slave <= 247) { ctx->slave = slave; } else if (slave == MODBUS_TCP_SLAVE) { /* The special value MODBUS_TCP_SLAVE (0xFF) can be used in TCP mode to * restore the default value. */ ctx->slave = slave; } else { errno = EINVAL; return -1; } return 0; } /* Builds a TCP request header */ int _modbus_tcp_build_request_basis(modbus_t *ctx, int function, int addr, int nb, uint8_t *req) { /* Extract from MODBUS Messaging on TCP/IP Implementation Guide V1.0b (page 23/46): The transaction identifier is used to associate the future response with the request. So, at a time, on a TCP connection, this identifier must be unique. */ static uint16_t t_id = 0; /* Transaction ID */ if (t_id < UINT16_MAX) t_id++; else t_id = 0; req[0] = t_id >> 8; req[1] = t_id & 0x00ff; /* Protocol Modbus */ req[2] = 0; req[3] = 0; /* Length will be defined later by set_req_length_tcp at offsets 4 and 5 */ req[6] = ctx->slave; req[7] = function; req[8] = addr >> 8; req[9] = addr & 0x00ff; req[10] = nb >> 8; req[11] = nb & 0x00ff; return _MODBUS_TCP_PRESET_REQ_LENGTH; } /* Builds a TCP response header */ int _modbus_tcp_build_response_basis(sft_t *sft, uint8_t *rsp) { /* Extract from MODBUS Messaging on TCP/IP Implementation Guide V1.0b (page 23/46): The transaction identifier is used to associate the future response with the request. */ rsp[0] = sft->t_id >> 8; rsp[1] = sft->t_id & 0x00ff; /* Protocol Modbus */ rsp[2] = 0; rsp[3] = 0; /* Length will be set later by send_msg (4 and 5) */ /* The slave ID is copied from the indication */ rsp[6] = sft->slave; rsp[7] = sft->function; return _MODBUS_TCP_PRESET_RSP_LENGTH; } int _modbus_tcp_prepare_response_tid(const uint8_t *req, int *req_length) { return (req[0] << 8) + req[1]; } int _modbus_tcp_send_msg_pre(uint8_t *req, int req_length) { /* Substract the header length to the message length */ int mbap_length = req_length - 6; req[4] = mbap_length >> 8; req[5] = mbap_length & 0x00FF; return req_length; } ssize_t _modbus_tcp_send(modbus_t *ctx, const uint8_t *req, int req_length) { /* MSG_NOSIGNAL Requests not to send SIGPIPE on errors on stream oriented sockets when the other end breaks the connection. The EPIPE error is still returned. */ return send(ctx->s, (const char*)req, req_length, MSG_NOSIGNAL); } ssize_t _modbus_tcp_recv(modbus_t *ctx, uint8_t *rsp, int rsp_length) { return recv(ctx->s, (char *)rsp, rsp_length, 0); } int _modbus_tcp_check_integrity(modbus_t *ctx, uint8_t *msg, const int msg_length) { return msg_length; } int _modbus_tcp_pre_check_confirmation(modbus_t *ctx, const uint8_t *req, const uint8_t *rsp, int rsp_length) { /* Check TID */ if (req[0] != rsp[0] || req[1] != rsp[1]) { if (ctx->debug) { fprintf(stderr, "Invalid TID received 0x%X (not 0x%X)\n", (rsp[0] << 8) + rsp[1], (req[0] << 8) + req[1]); } errno = EMBBADDATA; return -1; } else { return 0; } } static int _modbus_tcp_set_ipv4_options(int s) { int rc; int option; /* Set the TCP no delay flag */ /* SOL_TCP = IPPROTO_TCP */ option = 1; rc = setsockopt(s, IPPROTO_TCP, TCP_NODELAY, (const void *)&option, sizeof(int)); if (rc == -1) { return -1; } #ifndef OS_WIN32 /** * Cygwin defines IPTOS_LOWDELAY but can't handle that flag so it's * necessary to workaround that problem. **/ /* Set the IP low delay option */ option = IPTOS_LOWDELAY; rc = setsockopt(s, IPPROTO_IP, IP_TOS, (const void *)&option, sizeof(int)); if (rc == -1) { return -1; } #endif return 0; } /* Establishes a modbus TCP connection with a Modbus server. */ static int _modbus_tcp_connect(modbus_t *ctx) { int rc; struct sockaddr_in addr; modbus_tcp_t *ctx_tcp = ctx->backend_data; #ifdef OS_WIN32 if (_modbus_tcp_init_win32() == -1) { return -1; } #endif ctx->s = socket(PF_INET, SOCK_STREAM, 0); if (ctx->s == -1) { return -1; } rc = _modbus_tcp_set_ipv4_options(ctx->s); if (rc == -1) { close(ctx->s); return -1; } if (ctx->debug) { printf("Connecting to %s\n", ctx_tcp->ip); } addr.sin_family = AF_INET; addr.sin_port = htons(ctx_tcp->port); addr.sin_addr.s_addr = inet_addr(ctx_tcp->ip); rc = connect(ctx->s, (struct sockaddr *)&addr, sizeof(struct sockaddr_in)); if (rc == -1) { close(ctx->s); return -1; } return 0; } /* Establishes a modbus TCP PI connection with a Modbus server. */ static int _modbus_tcp_pi_connect(modbus_t *ctx) { int rc; struct addrinfo *ai_list; struct addrinfo *ai_ptr; struct addrinfo ai_hints; modbus_tcp_pi_t *ctx_tcp_pi = ctx->backend_data; #ifdef OS_WIN32 if (_modbus_tcp_init_win32() == -1) { return -1; } #endif memset(&ai_hints, 0, sizeof(ai_hints)); #ifdef AI_ADDRCONFIG ai_hints.ai_flags |= AI_ADDRCONFIG; #endif ai_hints.ai_family = AF_UNSPEC; ai_hints.ai_socktype = SOCK_STREAM; ai_hints.ai_addr = NULL; ai_hints.ai_canonname = NULL; ai_hints.ai_next = NULL; ai_list = NULL; rc = getaddrinfo(ctx_tcp_pi->node, ctx_tcp_pi->service, &ai_hints, &ai_list); if (rc != 0) return rc; for (ai_ptr = ai_list; ai_ptr != NULL; ai_ptr = ai_ptr->ai_next) { int s; s = socket(ai_ptr->ai_family, ai_ptr->ai_socktype, ai_ptr->ai_protocol); if (s < 0) continue; if (ai_ptr->ai_family == AF_INET) _modbus_tcp_set_ipv4_options(s); rc = connect(s, ai_ptr->ai_addr, ai_ptr->ai_addrlen); if (rc != 0) { close(s); continue; } ctx->s = s; break; } freeaddrinfo(ai_list); if (ctx->s < 0) { return -1; } return 0; } /* Closes the network connection and socket in TCP mode */ void _modbus_tcp_close(modbus_t *ctx) { shutdown(ctx->s, SHUT_RDWR); close(ctx->s); } int _modbus_tcp_flush(modbus_t *ctx) { int rc; int rc_sum = 0; do { /* Extract the garbage from the socket */ char devnull[MODBUS_TCP_MAX_ADU_LENGTH]; #ifndef OS_WIN32 rc = recv(ctx->s, devnull, MODBUS_TCP_MAX_ADU_LENGTH, MSG_DONTWAIT); #else /* On Win32, it's a bit more complicated to not wait */ fd_set rfds; struct timeval tv; tv.tv_sec = 0; tv.tv_usec = 0; FD_ZERO(&rfds); FD_SET(ctx->s, &rfds); rc = select(ctx->s+1, &rfds, NULL, NULL, &tv); if (rc == -1) { return -1; } if (rc == 1) { /* There is data to flush */ rc = recv(ctx->s, devnull, MODBUS_TCP_MAX_ADU_LENGTH, 0); } #endif if (rc > 0) { rc_sum += rc; } } while (rc == MODBUS_TCP_MAX_ADU_LENGTH); return rc_sum; } /* Listens for any request from one or many modbus masters in TCP */ int modbus_tcp_listen(modbus_t *ctx, int nb_connection) { int new_socket; int yes; struct sockaddr_in addr; modbus_tcp_t *ctx_tcp = ctx->backend_data; #ifdef OS_WIN32 if (_modbus_tcp_init_win32() == -1) { return -1; } #endif new_socket = socket(PF_INET, SOCK_STREAM, IPPROTO_TCP); if (new_socket == -1) { return -1; } yes = 1; if (setsockopt(new_socket, SOL_SOCKET, SO_REUSEADDR, (char *) &yes, sizeof(yes)) == -1) { close(new_socket); return -1; } memset(&addr, 0, sizeof(addr)); addr.sin_family = AF_INET; /* If the modbus port is < to 1024, we need the setuid root. */ addr.sin_port = htons(ctx_tcp->port); addr.sin_addr.s_addr = INADDR_ANY; if (bind(new_socket, (struct sockaddr *)&addr, sizeof(addr)) == -1) { close(new_socket); return -1; } if (listen(new_socket, nb_connection) == -1) { close(new_socket); return -1; } return new_socket; } int modbus_tcp_pi_listen(modbus_t *ctx, int nb_connection) { int rc; struct addrinfo *ai_list; struct addrinfo *ai_ptr; struct addrinfo ai_hints; const char *node; const char *service; int new_socket; modbus_tcp_pi_t *ctx_tcp_pi = ctx->backend_data; if (ctx_tcp_pi->node[0] == 0) node = NULL; /* == any */ else node = ctx_tcp_pi->node; if (ctx_tcp_pi->service[0] == 0) service = "502"; else service = ctx_tcp_pi->service; memset(&ai_hints, 0, sizeof (ai_hints)); ai_hints.ai_flags |= AI_PASSIVE; #ifdef AI_ADDRCONFIG ai_hints.ai_flags |= AI_ADDRCONFIG; #endif ai_hints.ai_family = AF_UNSPEC; ai_hints.ai_socktype = SOCK_STREAM; ai_hints.ai_addr = NULL; ai_hints.ai_canonname = NULL; ai_hints.ai_next = NULL; ai_list = NULL; rc = getaddrinfo(node, service, &ai_hints, &ai_list); if (rc != 0) return -1; new_socket = -1; for (ai_ptr = ai_list; ai_ptr != NULL; ai_ptr = ai_ptr->ai_next) { int s; s = socket(ai_ptr->ai_family, ai_ptr->ai_socktype, ai_ptr->ai_protocol); if (s < 0) { if (ctx->debug) { perror("socket"); } continue; } else { int yes = 1; rc = setsockopt(s, SOL_SOCKET, SO_REUSEADDR, (void *) &yes, sizeof (yes)); if (rc != 0) { close(s); if (ctx->debug) { perror("setsockopt"); } continue; } } rc = bind(s, ai_ptr->ai_addr, ai_ptr->ai_addrlen); if (rc != 0) { close(s); if (ctx->debug) { perror("bind"); } continue; } rc = listen(s, nb_connection); if (rc != 0) { close(s); if (ctx->debug) { perror("listen"); } continue; } new_socket = s; break; } freeaddrinfo(ai_list); if (new_socket < 0) { return -1; } return new_socket; } /* On success, the function return a non-negative integer that is a descriptor for the accepted socket. On error, -1 is returned, and errno is set appropriately. */ int modbus_tcp_accept(modbus_t *ctx, int *socket) { struct sockaddr_in addr; socklen_t addrlen; addrlen = sizeof(addr); ctx->s = accept(*socket, (struct sockaddr *)&addr, &addrlen); if (ctx->s == -1) { close(*socket); *socket = 0; return -1; } if (ctx->debug) { printf("The client connection from %s is accepted\n", inet_ntoa(addr.sin_addr)); } return ctx->s; } int modbus_tcp_pi_accept(modbus_t *ctx, int *socket) { struct sockaddr_storage addr; socklen_t addrlen; addrlen = sizeof(addr); ctx->s = accept(*socket, (void *)&addr, &addrlen); if (ctx->s == -1) { close(*socket); *socket = 0; } if (ctx->debug) { printf("The client connection is accepted.\n"); } return ctx->s; } int _modbus_tcp_select(modbus_t *ctx, fd_set *rfds, struct timeval *tv, int length_to_read) { int s_rc; while ((s_rc = select(ctx->s+1, rfds, NULL, NULL, tv)) == -1) { if (errno == EINTR) { if (ctx->debug) { fprintf(stderr, "A non blocked signal was caught\n"); } /* Necessary after an error */ FD_ZERO(rfds); FD_SET(ctx->s, rfds); } else { return -1; } } if (s_rc == 0) { errno = ETIMEDOUT; return -1; } return s_rc; } int _modbus_tcp_filter_request(modbus_t *ctx, int slave) { return 0; } const modbus_backend_t _modbus_tcp_backend = { _MODBUS_BACKEND_TYPE_TCP, _MODBUS_TCP_HEADER_LENGTH, _MODBUS_TCP_CHECKSUM_LENGTH, MODBUS_TCP_MAX_ADU_LENGTH, _modbus_set_slave, _modbus_tcp_build_request_basis, _modbus_tcp_build_response_basis, _modbus_tcp_prepare_response_tid, _modbus_tcp_send_msg_pre, _modbus_tcp_send, _modbus_tcp_recv, _modbus_tcp_check_integrity, _modbus_tcp_pre_check_confirmation, _modbus_tcp_connect, _modbus_tcp_close, _modbus_tcp_flush, _modbus_tcp_select, _modbus_tcp_filter_request }; const modbus_backend_t _modbus_tcp_pi_backend = { _MODBUS_BACKEND_TYPE_TCP, _MODBUS_TCP_HEADER_LENGTH, _MODBUS_TCP_CHECKSUM_LENGTH, MODBUS_TCP_MAX_ADU_LENGTH, _modbus_set_slave, _modbus_tcp_build_request_basis, _modbus_tcp_build_response_basis, _modbus_tcp_prepare_response_tid, _modbus_tcp_send_msg_pre, _modbus_tcp_send, _modbus_tcp_recv, _modbus_tcp_check_integrity, _modbus_tcp_pre_check_confirmation, _modbus_tcp_pi_connect, _modbus_tcp_close, _modbus_tcp_flush, _modbus_tcp_select, _modbus_tcp_filter_request }; modbus_t* modbus_new_tcp(const char *ip, int port) { modbus_t *ctx; modbus_tcp_t *ctx_tcp; size_t dest_size; size_t ret_size; #if defined(OS_BSD) /* MSG_NOSIGNAL is unsupported on *BSD so we install an ignore handler for SIGPIPE. */ struct sigaction sa; sa.sa_handler = SIG_IGN; if (sigaction(SIGPIPE, &sa, NULL) < 0) { /* The debug flag can't be set here... */ fprintf(stderr, "Coud not install SIGPIPE handler.\n"); return NULL; } #endif ctx = (modbus_t *) malloc(sizeof(modbus_t)); _modbus_init_common(ctx); /* Could be changed after to reach a remote serial Modbus device */ ctx->slave = MODBUS_TCP_SLAVE; ctx->backend = &(_modbus_tcp_backend); ctx->backend_data = (modbus_tcp_t *) malloc(sizeof(modbus_tcp_t)); ctx_tcp = (modbus_tcp_t *)ctx->backend_data; dest_size = sizeof(char) * 16; ret_size = strlcpy(ctx_tcp->ip, ip, dest_size); if (ret_size == 0) { fprintf(stderr, "The IP string is empty\n"); modbus_free(ctx); errno = EINVAL; return NULL; } if (ret_size >= dest_size) { fprintf(stderr, "The IP string has been truncated\n"); modbus_free(ctx); errno = EINVAL; return NULL; } ctx_tcp->port = port; return ctx; } modbus_t* modbus_new_tcp_pi(const char *node, const char *service) { modbus_t *ctx; modbus_tcp_pi_t *ctx_tcp_pi; size_t dest_size; size_t ret_size; ctx = (modbus_t *) malloc(sizeof(modbus_t)); _modbus_init_common(ctx); /* Could be changed after to reach a remote serial Modbus device */ ctx->slave = MODBUS_TCP_SLAVE; ctx->backend = &(_modbus_tcp_pi_backend); ctx->backend_data = (modbus_tcp_pi_t *) malloc(sizeof(modbus_tcp_pi_t)); ctx_tcp_pi = (modbus_tcp_pi_t *)ctx->backend_data; dest_size = sizeof(char) * _MODBUS_TCP_PI_NODE_LENGTH; ret_size = strlcpy(ctx_tcp_pi->node, node, dest_size); if (ret_size == 0) { fprintf(stderr, "The node string is empty\n"); modbus_free(ctx); errno = EINVAL; return NULL; } if (ret_size >= dest_size) { fprintf(stderr, "The node string has been truncated\n"); modbus_free(ctx); errno = EINVAL; return NULL; } dest_size = sizeof(char) * _MODBUS_TCP_PI_SERVICE_LENGTH; ret_size = strlcpy(ctx_tcp_pi->service, service, dest_size); if (ret_size == 0) { fprintf(stderr, "The service string is empty\n"); modbus_free(ctx); errno = EINVAL; return NULL; } if (ret_size >= dest_size) { fprintf(stderr, "The service string has been truncated\n"); modbus_free(ctx); errno = EINVAL; return NULL; } return ctx; } libmodbus-3.0.5/src/modbus-tcp.h000066400000000000000000000034411222457407600165270ustar00rootroot00000000000000/* * Copyright © 2001-2010 Stéphane Raimbault * * This library is free software; you can redistribute it and/or * modify it under the terms of the GNU Lesser General Public * License as published by the Free Software Foundation; either * version 2.1 of the License, or (at your option) any later version. * * This library is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU * Lesser General Public License for more details. * * You should have received a copy of the GNU Lesser General Public * License along with this library; if not, write to the Free Software * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA */ #ifndef _MODBUS_TCP_H_ #define _MODBUS_TCP_H_ #include "modbus.h" MODBUS_BEGIN_DECLS #if defined(_WIN32) && !defined(__CYGWIN__) /* Win32 with MinGW, supplement to */ #include #define ECONNRESET WSAECONNRESET #define ECONNREFUSED WSAECONNREFUSED #define ETIMEDOUT WSAETIMEDOUT #define ENOPROTOOPT WSAENOPROTOOPT #endif #define MODBUS_TCP_DEFAULT_PORT 502 #define MODBUS_TCP_SLAVE 0xFF /* Modbus_Application_Protocol_V1_1b.pdf Chapter 4 Section 1 Page 5 * TCP MODBUS ADU = 253 bytes + MBAP (7 bytes) = 260 bytes */ #define MODBUS_TCP_MAX_ADU_LENGTH 260 modbus_t* modbus_new_tcp(const char *ip_address, int port); int modbus_tcp_listen(modbus_t *ctx, int nb_connection); int modbus_tcp_accept(modbus_t *ctx, int *socket); modbus_t* modbus_new_tcp_pi(const char *node, const char *service); int modbus_tcp_pi_listen(modbus_t *ctx, int nb_connection); int modbus_tcp_pi_accept(modbus_t *ctx, int *socket); MODBUS_END_DECLS #endif /* _MODBUS_TCP_H_ */ libmodbus-3.0.5/src/modbus-version.h.in000066400000000000000000000041231222457407600200310ustar00rootroot00000000000000/* * Copyright © 2010 Stéphane Raimbault * * This program is free software: you can redistribute it and/or modify * it under the terms of the GNU Lesser Public License as published by * the Free Software Foundation; either version 3 of the License, or * (at your option) any later version. * * This program is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU Lesser Public License for more details. * * You should have received a copy of the GNU Lesser Public License * along with this program. If not, see . */ #ifndef _MODBUS_VERSION_H_ #define _MODBUS_VERSION_H_ /* The major version, (1, if %LIBMODBUS_VERSION is 1.2.3) */ #define LIBMODBUS_VERSION_MAJOR (@LIBMODBUS_VERSION_MAJOR@) /* The minor version (2, if %LIBMODBUS_VERSION is 1.2.3) */ #define LIBMODBUS_VERSION_MINOR (@LIBMODBUS_VERSION_MINOR@) /* The micro version (3, if %LIBMODBUS_VERSION is 1.2.3) */ #define LIBMODBUS_VERSION_MICRO (@LIBMODBUS_VERSION_MICRO@) /* The full version, like 1.2.3 */ #define LIBMODBUS_VERSION @LIBMODBUS_VERSION@ /* The full version, in string form (suited for string concatenation) */ #define LIBMODBUS_VERSION_STRING "@LIBMODBUS_VERSION@" /* Numerically encoded version, like 0x010203 */ #define LIBMODBUS_VERSION_HEX ((LIBMODBUS_MAJOR_VERSION << 24) | \ (LIBMODBUS_MINOR_VERSION << 16) | \ (LIBMODBUS_MICRO_VERSION << 8)) /* Evaluates to True if the version is greater than @major, @minor and @micro */ #define LIBMODBUS_VERSION_CHECK(major,minor,micro) \ (LIBMODBUS_VERSION_MAJOR > (major) || \ (LIBMODBUS_VERSION_MAJOR == (major) && \ LIBMODBUS_VERSION_MINOR > (minor)) || \ (LIBMODBUS_VERSION_MAJOR == (major) && \ LIBMODBUS_VERSION_MINOR == (minor) && \ LIBMODBUS_VERSION_MICRO >= (micro))) #endif /* _MODBUS_VERSION_H_ */ libmodbus-3.0.5/src/modbus.c000066400000000000000000001424741222457407600157500ustar00rootroot00000000000000/* * Copyright © 2001-2011 Stéphane Raimbault * * This library is free software; you can redistribute it and/or * modify it under the terms of the GNU Lesser General Public * License as published by the Free Software Foundation; either * version 2.1 of the License, or (at your option) any later version. * * This library is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU * Lesser General Public License for more details. * * You should have received a copy of the GNU Lesser General Public * License along with this library; if not, write to the Free Software * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA * * * This library implements the Modbus protocol. * http://libmodbus.org/ */ #include #include #include #include #include #include #include #include "modbus.h" #include "modbus-private.h" /* Internal use */ #define MSG_LENGTH_UNDEFINED -1 /* Exported version */ const unsigned int libmodbus_version_major = LIBMODBUS_VERSION_MAJOR; const unsigned int libmodbus_version_minor = LIBMODBUS_VERSION_MINOR; const unsigned int libmodbus_version_micro = LIBMODBUS_VERSION_MICRO; /* Max between RTU and TCP max adu length (so TCP) */ #define MAX_MESSAGE_LENGTH 260 /* 3 steps are used to parse the query */ typedef enum { _STEP_FUNCTION, _STEP_META, _STEP_DATA } _step_t; const char *modbus_strerror(int errnum) { switch (errnum) { case EMBXILFUN: return "Illegal function"; case EMBXILADD: return "Illegal data address"; case EMBXILVAL: return "Illegal data value"; case EMBXSFAIL: return "Slave device or server failure"; case EMBXACK: return "Acknowledge"; case EMBXSBUSY: return "Slave device or server is busy"; case EMBXNACK: return "Negative acknowledge"; case EMBXMEMPAR: return "Memory parity error"; case EMBXGPATH: return "Gateway path unavailable"; case EMBXGTAR: return "Target device failed to respond"; case EMBBADCRC: return "Invalid CRC"; case EMBBADDATA: return "Invalid data"; case EMBBADEXC: return "Invalid exception code"; case EMBMDATA: return "Too many data"; default: return strerror(errnum); } } void _error_print(modbus_t *ctx, const char *context) { if (ctx->debug) { fprintf(stderr, "ERROR %s", modbus_strerror(errno)); if (context != NULL) { fprintf(stderr, ": %s\n", context); } else { fprintf(stderr, "\n"); } } } int _sleep_and_flush(modbus_t *ctx) { #ifdef _WIN32 /* usleep doesn't exist on Windows */ Sleep((ctx->response_timeout.tv_sec * 1000) + (ctx->response_timeout.tv_usec / 1000)); #else /* usleep source code */ struct timespec request, remaining; request.tv_sec = ctx->response_timeout.tv_sec; request.tv_nsec = ((long int)ctx->response_timeout.tv_usec % 1000000) * 1000; while (nanosleep(&request, &remaining) == -1 && errno == EINTR) request = remaining; #endif return modbus_flush(ctx); } int modbus_flush(modbus_t *ctx) { int rc = ctx->backend->flush(ctx); if (rc != -1 && ctx->debug) { printf("%d bytes flushed\n", rc); } return rc; } /* Computes the length of the expected response */ static unsigned int compute_response_length_from_request(modbus_t *ctx, uint8_t *req) { int length; const int offset = ctx->backend->header_length; switch (req[offset]) { case _FC_READ_COILS: case _FC_READ_DISCRETE_INPUTS: { /* Header + nb values (code from write_bits) */ int nb = (req[offset + 3] << 8) | req[offset + 4]; length = 2 + (nb / 8) + ((nb % 8) ? 1 : 0); } break; case _FC_WRITE_AND_READ_REGISTERS: case _FC_READ_HOLDING_REGISTERS: case _FC_READ_INPUT_REGISTERS: /* Header + 2 * nb values */ length = 2 + 2 * (req[offset + 3] << 8 | req[offset + 4]); break; case _FC_READ_EXCEPTION_STATUS: length = 3; break; case _FC_REPORT_SLAVE_ID: /* The response is device specific (the header provides the length) */ return MSG_LENGTH_UNDEFINED; default: length = 5; } return offset + length + ctx->backend->checksum_length; } /* Sends a request/response */ static int send_msg(modbus_t *ctx, uint8_t *msg, int msg_length) { int rc; int i; msg_length = ctx->backend->send_msg_pre(msg, msg_length); if (ctx->debug) { for (i = 0; i < msg_length; i++) printf("[%.2X]", msg[i]); printf("\n"); } /* In recovery mode, the write command will be issued until to be successful! Disabled by default. */ do { rc = ctx->backend->send(ctx, msg, msg_length); if (rc == -1) { _error_print(ctx, NULL); if (ctx->error_recovery & MODBUS_ERROR_RECOVERY_LINK) { int saved_errno = errno; if ((errno == EBADF || errno == ECONNRESET || errno == EPIPE)) { modbus_close(ctx); modbus_connect(ctx); } else { _sleep_and_flush(ctx); } errno = saved_errno; } } } while ((ctx->error_recovery & MODBUS_ERROR_RECOVERY_LINK) && rc == -1); if (rc > 0 && rc != msg_length) { errno = EMBBADDATA; return -1; } return rc; } int modbus_send_raw_request(modbus_t *ctx, uint8_t *raw_req, int raw_req_length) { sft_t sft; uint8_t req[MAX_MESSAGE_LENGTH]; int req_length; if (raw_req_length < 2) { /* The raw request must contain function and slave at least */ errno = EINVAL; return -1; } sft.slave = raw_req[0]; sft.function = raw_req[1]; /* The t_id is left to zero */ sft.t_id = 0; /* This response function only set the header so it's convenient here */ req_length = ctx->backend->build_response_basis(&sft, req); if (raw_req_length > 2) { /* Copy data after function code */ memcpy(req + req_length, raw_req + 2, raw_req_length - 2); req_length += raw_req_length - 2; } return send_msg(ctx, req, req_length); } /* ---------- Request Indication ---------- | Client | ---------------------->| Server | ---------- Confirmation Response ---------- */ typedef enum { /* Request message on the server side */ MSG_INDICATION, /* Request message on the client side */ MSG_CONFIRMATION } msg_type_t; /* Computes the length to read after the function received */ static uint8_t compute_meta_length_after_function(int function, msg_type_t msg_type) { int length; if (msg_type == MSG_INDICATION) { if (function <= _FC_WRITE_SINGLE_REGISTER) { length = 4; } else if (function == _FC_WRITE_MULTIPLE_COILS || function == _FC_WRITE_MULTIPLE_REGISTERS) { length = 5; } else if (function == _FC_WRITE_AND_READ_REGISTERS) { length = 9; } else { /* _FC_READ_EXCEPTION_STATUS, _FC_REPORT_SLAVE_ID */ length = 0; } } else { /* MSG_CONFIRMATION */ switch (function) { case _FC_WRITE_SINGLE_COIL: case _FC_WRITE_SINGLE_REGISTER: case _FC_WRITE_MULTIPLE_COILS: case _FC_WRITE_MULTIPLE_REGISTERS: length = 4; break; default: length = 1; } } return length; } /* Computes the length to read after the meta information (address, count, etc) */ static int compute_data_length_after_meta(modbus_t *ctx, uint8_t *msg, msg_type_t msg_type) { int function = msg[ctx->backend->header_length]; int length; if (msg_type == MSG_INDICATION) { switch (function) { case _FC_WRITE_MULTIPLE_COILS: case _FC_WRITE_MULTIPLE_REGISTERS: length = msg[ctx->backend->header_length + 5]; break; case _FC_WRITE_AND_READ_REGISTERS: length = msg[ctx->backend->header_length + 9]; break; default: length = 0; } } else { /* MSG_CONFIRMATION */ if (function <= _FC_READ_INPUT_REGISTERS || function == _FC_REPORT_SLAVE_ID || function == _FC_WRITE_AND_READ_REGISTERS) { length = msg[ctx->backend->header_length + 1]; } else { length = 0; } } length += ctx->backend->checksum_length; return length; } /* Waits a response from a modbus server or a request from a modbus client. This function blocks if there is no replies (3 timeouts). The function shall return the number of received characters and the received message in an array of uint8_t if successful. Otherwise it shall return -1 and errno is set to one of the values defined below: - ECONNRESET - EMBBADDATA - EMBUNKEXC - ETIMEDOUT - read() or recv() error codes */ static int receive_msg(modbus_t *ctx, uint8_t *msg, msg_type_t msg_type) { int rc; fd_set rfds; struct timeval tv; struct timeval *p_tv; int length_to_read; int msg_length = 0; _step_t step; if (ctx->debug) { if (msg_type == MSG_INDICATION) { printf("Waiting for a indication...\n"); } else { printf("Waiting for a confirmation...\n"); } } /* Add a file descriptor to the set */ FD_ZERO(&rfds); FD_SET(ctx->s, &rfds); /* We need to analyse the message step by step. At the first step, we want * to reach the function code because all packets contain this * information. */ step = _STEP_FUNCTION; length_to_read = ctx->backend->header_length + 1; if (msg_type == MSG_INDICATION) { /* Wait for a message, we don't know when the message will be * received */ p_tv = NULL; } else { tv.tv_sec = ctx->response_timeout.tv_sec; tv.tv_usec = ctx->response_timeout.tv_usec; p_tv = &tv; } while (length_to_read != 0) { rc = ctx->backend->select(ctx, &rfds, p_tv, length_to_read); if (rc == -1) { _error_print(ctx, "select"); if (ctx->error_recovery & MODBUS_ERROR_RECOVERY_LINK) { int saved_errno = errno; if (errno == ETIMEDOUT) { _sleep_and_flush(ctx); } else if (errno == EBADF) { modbus_close(ctx); modbus_connect(ctx); } errno = saved_errno; } return -1; } rc = ctx->backend->recv(ctx, msg + msg_length, length_to_read); if (rc == 0) { errno = ECONNRESET; rc = -1; } if (rc == -1) { _error_print(ctx, "read"); if ((ctx->error_recovery & MODBUS_ERROR_RECOVERY_LINK) && (errno == ECONNRESET || errno == ECONNREFUSED || errno == EBADF)) { int saved_errno = errno; modbus_close(ctx); modbus_connect(ctx); /* Could be removed by previous calls */ errno = saved_errno; } return -1; } /* Display the hex code of each character received */ if (ctx->debug) { int i; for (i=0; i < rc; i++) printf("<%.2X>", msg[msg_length + i]); } /* Sums bytes received */ msg_length += rc; /* Computes remaining bytes */ length_to_read -= rc; if (length_to_read == 0) { switch (step) { case _STEP_FUNCTION: /* Function code position */ length_to_read = compute_meta_length_after_function( msg[ctx->backend->header_length], msg_type); if (length_to_read != 0) { step = _STEP_META; break; } /* else switches straight to the next step */ case _STEP_META: length_to_read = compute_data_length_after_meta( ctx, msg, msg_type); if ((msg_length + length_to_read) > ctx->backend->max_adu_length) { errno = EMBBADDATA; _error_print(ctx, "too many data"); return -1; } step = _STEP_DATA; break; default: break; } } if (length_to_read > 0 && ctx->byte_timeout.tv_sec != -1) { /* If there is no character in the buffer, the allowed timeout interval between two consecutive bytes is defined by byte_timeout */ tv.tv_sec = ctx->byte_timeout.tv_sec; tv.tv_usec = ctx->byte_timeout.tv_usec; p_tv = &tv; } } if (ctx->debug) printf("\n"); return ctx->backend->check_integrity(ctx, msg, msg_length); } /* Receive the request from a modbus master */ int modbus_receive(modbus_t *ctx, uint8_t *req) { return receive_msg(ctx, req, MSG_INDICATION); } /* Receives the confirmation. The function shall store the read response in rsp and return the number of values (bits or words). Otherwise, its shall return -1 and errno is set. The function doesn't check the confirmation is the expected response to the initial request. */ int modbus_receive_confirmation(modbus_t *ctx, uint8_t *rsp) { return receive_msg(ctx, rsp, MSG_CONFIRMATION); } static int check_confirmation(modbus_t *ctx, uint8_t *req, uint8_t *rsp, int rsp_length) { int rc; int rsp_length_computed; const int offset = ctx->backend->header_length; if (ctx->backend->pre_check_confirmation) { rc = ctx->backend->pre_check_confirmation(ctx, req, rsp, rsp_length); if (rc == -1) { if (ctx->error_recovery & MODBUS_ERROR_RECOVERY_PROTOCOL) { _sleep_and_flush(ctx); } return -1; } } rsp_length_computed = compute_response_length_from_request(ctx, req); /* Check length */ if (rsp_length == rsp_length_computed || rsp_length_computed == MSG_LENGTH_UNDEFINED) { int req_nb_value; int rsp_nb_value; const int function = rsp[offset]; /* Check function code */ if (function != req[offset]) { if (ctx->debug) { fprintf(stderr, "Received function not corresponding to the request (%d != %d)\n", function, req[offset]); } if (ctx->error_recovery & MODBUS_ERROR_RECOVERY_PROTOCOL) { _sleep_and_flush(ctx); } errno = EMBBADDATA; return -1; } /* Check the number of values is corresponding to the request */ switch (function) { case _FC_READ_COILS: case _FC_READ_DISCRETE_INPUTS: /* Read functions, 8 values in a byte (nb * of values in the request and byte count in * the response. */ req_nb_value = (req[offset + 3] << 8) + req[offset + 4]; req_nb_value = (req_nb_value / 8) + ((req_nb_value % 8) ? 1 : 0); rsp_nb_value = rsp[offset + 1]; break; case _FC_WRITE_AND_READ_REGISTERS: case _FC_READ_HOLDING_REGISTERS: case _FC_READ_INPUT_REGISTERS: /* Read functions 1 value = 2 bytes */ req_nb_value = (req[offset + 3] << 8) + req[offset + 4]; rsp_nb_value = (rsp[offset + 1] / 2); break; case _FC_WRITE_MULTIPLE_COILS: case _FC_WRITE_MULTIPLE_REGISTERS: /* N Write functions */ req_nb_value = (req[offset + 3] << 8) + req[offset + 4]; rsp_nb_value = (rsp[offset + 3] << 8) | rsp[offset + 4]; break; case _FC_REPORT_SLAVE_ID: /* Report slave ID (bytes received) */ req_nb_value = rsp_nb_value = rsp[offset + 1]; break; default: /* 1 Write functions & others */ req_nb_value = rsp_nb_value = 1; } if (req_nb_value == rsp_nb_value) { rc = rsp_nb_value; } else { if (ctx->debug) { fprintf(stderr, "Quantity not corresponding to the request (%d != %d)\n", rsp_nb_value, req_nb_value); } if (ctx->error_recovery & MODBUS_ERROR_RECOVERY_PROTOCOL) { _sleep_and_flush(ctx); } errno = EMBBADDATA; rc = -1; } } else if (rsp_length == (offset + 2 + ctx->backend->checksum_length) && req[offset] == (rsp[offset] - 0x80)) { /* EXCEPTION CODE RECEIVED */ int exception_code = rsp[offset + 1]; if (exception_code < MODBUS_EXCEPTION_MAX) { errno = MODBUS_ENOBASE + exception_code; } else { errno = EMBBADEXC; } _error_print(ctx, NULL); rc = -1; } else { if (ctx->debug) { fprintf(stderr, "Message length not corresponding to the computed length (%d != %d)\n", rsp_length, rsp_length_computed); } if (ctx->error_recovery & MODBUS_ERROR_RECOVERY_PROTOCOL) { _sleep_and_flush(ctx); } errno = EMBBADDATA; rc = -1; } return rc; } static int response_io_status(int address, int nb, uint8_t *tab_io_status, uint8_t *rsp, int offset) { int shift = 0; int byte = 0; int i; for (i = address; i < address+nb; i++) { byte |= tab_io_status[i] << shift; if (shift == 7) { /* Byte is full */ rsp[offset++] = byte; byte = shift = 0; } else { shift++; } } if (shift != 0) rsp[offset++] = byte; return offset; } /* Build the exception response */ static int response_exception(modbus_t *ctx, sft_t *sft, int exception_code, uint8_t *rsp) { int rsp_length; sft->function = sft->function + 0x80; rsp_length = ctx->backend->build_response_basis(sft, rsp); /* Positive exception code */ rsp[rsp_length++] = exception_code; return rsp_length; } /* Send a response to the received request. Analyses the request and constructs a response. If an error occurs, this function construct the response accordingly. */ int modbus_reply(modbus_t *ctx, const uint8_t *req, int req_length, modbus_mapping_t *mb_mapping) { int offset = ctx->backend->header_length; int slave = req[offset - 1]; int function = req[offset]; uint16_t address = (req[offset + 1] << 8) + req[offset + 2]; uint8_t rsp[MAX_MESSAGE_LENGTH]; int rsp_length = 0; sft_t sft; if (ctx->backend->filter_request(ctx, slave) == 1) { /* Filtered */ return 0; } sft.slave = slave; sft.function = function; sft.t_id = ctx->backend->prepare_response_tid(req, &req_length); switch (function) { case _FC_READ_COILS: { int nb = (req[offset + 3] << 8) + req[offset + 4]; if (nb < 1 || MODBUS_MAX_READ_BITS < nb) { if (ctx->debug) { fprintf(stderr, "Illegal nb of values %d in read_bits (max %d)\n", nb, MODBUS_MAX_READ_BITS); } rsp_length = response_exception( ctx, &sft, MODBUS_EXCEPTION_ILLEGAL_DATA_VALUE, rsp); } else if ((address + nb) > mb_mapping->nb_bits) { if (ctx->debug) { fprintf(stderr, "Illegal data address %0X in read_bits\n", address + nb); } rsp_length = response_exception( ctx, &sft, MODBUS_EXCEPTION_ILLEGAL_DATA_ADDRESS, rsp); } else { rsp_length = ctx->backend->build_response_basis(&sft, rsp); rsp[rsp_length++] = (nb / 8) + ((nb % 8) ? 1 : 0); rsp_length = response_io_status(address, nb, mb_mapping->tab_bits, rsp, rsp_length); } } break; case _FC_READ_DISCRETE_INPUTS: { /* Similar to coil status (but too many arguments to use a * function) */ int nb = (req[offset + 3] << 8) + req[offset + 4]; if (nb < 1 || MODBUS_MAX_READ_BITS < nb) { if (ctx->debug) { fprintf(stderr, "Illegal nb of values %d in read_input_bits (max %d)\n", nb, MODBUS_MAX_READ_BITS); } rsp_length = response_exception( ctx, &sft, MODBUS_EXCEPTION_ILLEGAL_DATA_VALUE, rsp); } else if ((address + nb) > mb_mapping->nb_input_bits) { if (ctx->debug) { fprintf(stderr, "Illegal data address %0X in read_input_bits\n", address + nb); } rsp_length = response_exception( ctx, &sft, MODBUS_EXCEPTION_ILLEGAL_DATA_ADDRESS, rsp); } else { rsp_length = ctx->backend->build_response_basis(&sft, rsp); rsp[rsp_length++] = (nb / 8) + ((nb % 8) ? 1 : 0); rsp_length = response_io_status(address, nb, mb_mapping->tab_input_bits, rsp, rsp_length); } } break; case _FC_READ_HOLDING_REGISTERS: { int nb = (req[offset + 3] << 8) + req[offset + 4]; if (nb < 1 || MODBUS_MAX_READ_REGISTERS < nb) { if (ctx->debug) { fprintf(stderr, "Illegal nb of values %d in read_holding_registers (max %d)\n", nb, MODBUS_MAX_READ_REGISTERS); } rsp_length = response_exception( ctx, &sft, MODBUS_EXCEPTION_ILLEGAL_DATA_VALUE, rsp); } else if ((address + nb) > mb_mapping->nb_registers) { if (ctx->debug) { fprintf(stderr, "Illegal data address %0X in read_registers\n", address + nb); } rsp_length = response_exception( ctx, &sft, MODBUS_EXCEPTION_ILLEGAL_DATA_ADDRESS, rsp); } else { int i; rsp_length = ctx->backend->build_response_basis(&sft, rsp); rsp[rsp_length++] = nb << 1; for (i = address; i < address + nb; i++) { rsp[rsp_length++] = mb_mapping->tab_registers[i] >> 8; rsp[rsp_length++] = mb_mapping->tab_registers[i] & 0xFF; } } } break; case _FC_READ_INPUT_REGISTERS: { /* Similar to holding registers (but too many arguments to use a * function) */ int nb = (req[offset + 3] << 8) + req[offset + 4]; if (nb < 1 || MODBUS_MAX_READ_REGISTERS < nb) { if (ctx->debug) { fprintf(stderr, "Illegal number of values %d in read_input_registers (max %d)\n", nb, MODBUS_MAX_READ_REGISTERS); } rsp_length = response_exception( ctx, &sft, MODBUS_EXCEPTION_ILLEGAL_DATA_VALUE, rsp); } else if ((address + nb) > mb_mapping->nb_input_registers) { if (ctx->debug) { fprintf(stderr, "Illegal data address %0X in read_input_registers\n", address + nb); } rsp_length = response_exception( ctx, &sft, MODBUS_EXCEPTION_ILLEGAL_DATA_ADDRESS, rsp); } else { int i; rsp_length = ctx->backend->build_response_basis(&sft, rsp); rsp[rsp_length++] = nb << 1; for (i = address; i < address + nb; i++) { rsp[rsp_length++] = mb_mapping->tab_input_registers[i] >> 8; rsp[rsp_length++] = mb_mapping->tab_input_registers[i] & 0xFF; } } } break; case _FC_WRITE_SINGLE_COIL: if (address >= mb_mapping->nb_bits) { if (ctx->debug) { fprintf(stderr, "Illegal data address %0X in write_bit\n", address); } rsp_length = response_exception( ctx, &sft, MODBUS_EXCEPTION_ILLEGAL_DATA_ADDRESS, rsp); } else { int data = (req[offset + 3] << 8) + req[offset + 4]; if (data == 0xFF00 || data == 0x0) { mb_mapping->tab_bits[address] = (data) ? ON : OFF; memcpy(rsp, req, req_length); rsp_length = req_length; } else { if (ctx->debug) { fprintf(stderr, "Illegal data value %0X in write_bit request at address %0X\n", data, address); } rsp_length = response_exception( ctx, &sft, MODBUS_EXCEPTION_ILLEGAL_DATA_VALUE, rsp); } } break; case _FC_WRITE_SINGLE_REGISTER: if (address >= mb_mapping->nb_registers) { if (ctx->debug) { fprintf(stderr, "Illegal data address %0X in write_register\n", address); } rsp_length = response_exception( ctx, &sft, MODBUS_EXCEPTION_ILLEGAL_DATA_ADDRESS, rsp); } else { int data = (req[offset + 3] << 8) + req[offset + 4]; mb_mapping->tab_registers[address] = data; memcpy(rsp, req, req_length); rsp_length = req_length; } break; case _FC_WRITE_MULTIPLE_COILS: { int nb = (req[offset + 3] << 8) + req[offset + 4]; if ((address + nb) > mb_mapping->nb_bits) { if (ctx->debug) { fprintf(stderr, "Illegal data address %0X in write_bits\n", address + nb); } rsp_length = response_exception( ctx, &sft, MODBUS_EXCEPTION_ILLEGAL_DATA_ADDRESS, rsp); } else { /* 6 = byte count */ modbus_set_bits_from_bytes(mb_mapping->tab_bits, address, nb, &req[offset + 6]); rsp_length = ctx->backend->build_response_basis(&sft, rsp); /* 4 to copy the bit address (2) and the quantity of bits */ memcpy(rsp + rsp_length, req + rsp_length, 4); rsp_length += 4; } } break; case _FC_WRITE_MULTIPLE_REGISTERS: { int nb = (req[offset + 3] << 8) + req[offset + 4]; if ((address + nb) > mb_mapping->nb_registers) { if (ctx->debug) { fprintf(stderr, "Illegal data address %0X in write_registers\n", address + nb); } rsp_length = response_exception( ctx, &sft, MODBUS_EXCEPTION_ILLEGAL_DATA_ADDRESS, rsp); } else { int i, j; for (i = address, j = 6; i < address + nb; i++, j += 2) { /* 6 and 7 = first value */ mb_mapping->tab_registers[i] = (req[offset + j] << 8) + req[offset + j + 1]; } rsp_length = ctx->backend->build_response_basis(&sft, rsp); /* 4 to copy the address (2) and the no. of registers */ memcpy(rsp + rsp_length, req + rsp_length, 4); rsp_length += 4; } } break; case _FC_REPORT_SLAVE_ID: { int str_len; int byte_count_pos; rsp_length = ctx->backend->build_response_basis(&sft, rsp); /* Skip byte count for now */ byte_count_pos = rsp_length++; rsp[rsp_length++] = _REPORT_SLAVE_ID; /* Run indicator status to ON */ rsp[rsp_length++] = 0xFF; /* LMB + length of LIBMODBUS_VERSION_STRING */ str_len = 3 + strlen(LIBMODBUS_VERSION_STRING); memcpy(rsp + rsp_length, "LMB" LIBMODBUS_VERSION_STRING, str_len); rsp_length += str_len; rsp[byte_count_pos] = rsp_length - byte_count_pos - 1; } break; case _FC_READ_EXCEPTION_STATUS: if (ctx->debug) { fprintf(stderr, "FIXME Not implemented\n"); } errno = ENOPROTOOPT; return -1; break; case _FC_WRITE_AND_READ_REGISTERS: { int nb = (req[offset + 3] << 8) + req[offset + 4]; uint16_t address_write = (req[offset + 5] << 8) + req[offset + 6]; int nb_write = (req[offset + 7] << 8) + req[offset + 8]; int nb_write_bytes = req[offset + 9]; if (nb_write < 1 || MODBUS_MAX_RW_WRITE_REGISTERS < nb_write || nb < 1 || MODBUS_MAX_READ_REGISTERS < nb || nb_write_bytes != nb_write * 2) { if (ctx->debug) { fprintf(stderr, "Illegal nb of values (W%d, R%d) in write_and_read_registers (max W%d, R%d)\n", nb_write, nb, MODBUS_MAX_RW_WRITE_REGISTERS, MODBUS_MAX_READ_REGISTERS); } rsp_length = response_exception( ctx, &sft, MODBUS_EXCEPTION_ILLEGAL_DATA_VALUE, rsp); } else if ((address + nb) > mb_mapping->nb_registers || (address_write + nb_write) > mb_mapping->nb_registers) { if (ctx->debug) { fprintf(stderr, "Illegal data read address %0X or write address %0X write_and_read_registers\n", address + nb, address_write + nb_write); } rsp_length = response_exception(ctx, &sft, MODBUS_EXCEPTION_ILLEGAL_DATA_ADDRESS, rsp); } else { int i, j; rsp_length = ctx->backend->build_response_basis(&sft, rsp); rsp[rsp_length++] = nb << 1; /* Write first. 10 and 11 are the offset of the first values to write */ for (i = address_write, j = 10; i < address_write + nb_write; i++, j += 2) { mb_mapping->tab_registers[i] = (req[offset + j] << 8) + req[offset + j + 1]; } /* and read the data for the response */ for (i = address; i < address + nb; i++) { rsp[rsp_length++] = mb_mapping->tab_registers[i] >> 8; rsp[rsp_length++] = mb_mapping->tab_registers[i] & 0xFF; } } } break; default: rsp_length = response_exception(ctx, &sft, MODBUS_EXCEPTION_ILLEGAL_FUNCTION, rsp); break; } return send_msg(ctx, rsp, rsp_length); } int modbus_reply_exception(modbus_t *ctx, const uint8_t *req, unsigned int exception_code) { int offset = ctx->backend->header_length; int slave = req[offset - 1]; int function = req[offset]; uint8_t rsp[MAX_MESSAGE_LENGTH]; int rsp_length; int dummy_length = 99; sft_t sft; if (ctx->backend->filter_request(ctx, slave) == 1) { /* Filtered */ return 0; } sft.slave = slave; sft.function = function + 0x80;; sft.t_id = ctx->backend->prepare_response_tid(req, &dummy_length); rsp_length = ctx->backend->build_response_basis(&sft, rsp); /* Positive exception code */ if (exception_code < MODBUS_EXCEPTION_MAX) { rsp[rsp_length++] = exception_code; return send_msg(ctx, rsp, rsp_length); } else { errno = EINVAL; return -1; } } /* Reads IO status */ static int read_io_status(modbus_t *ctx, int function, int addr, int nb, uint8_t *dest) { int rc; int req_length; uint8_t req[_MIN_REQ_LENGTH]; uint8_t rsp[MAX_MESSAGE_LENGTH]; req_length = ctx->backend->build_request_basis(ctx, function, addr, nb, req); rc = send_msg(ctx, req, req_length); if (rc > 0) { int i, temp, bit; int pos = 0; int offset; int offset_end; rc = receive_msg(ctx, rsp, MSG_CONFIRMATION); if (rc == -1) return -1; rc = check_confirmation(ctx, req, rsp, rc); if (rc == -1) return -1; offset = ctx->backend->header_length + 2; offset_end = offset + rc; for (i = offset; i < offset_end; i++) { /* Shift reg hi_byte to temp */ temp = rsp[i]; for (bit = 0x01; (bit & 0xff) && (pos < nb);) { dest[pos++] = (temp & bit) ? TRUE : FALSE; bit = bit << 1; } } } return rc; } /* Reads the boolean status of bits and sets the array elements in the destination to TRUE or FALSE (single bits). */ int modbus_read_bits(modbus_t *ctx, int addr, int nb, uint8_t *dest) { int rc; if (nb > MODBUS_MAX_READ_BITS) { if (ctx->debug) { fprintf(stderr, "ERROR Too many bits requested (%d > %d)\n", nb, MODBUS_MAX_READ_BITS); } errno = EMBMDATA; return -1; } rc = read_io_status(ctx, _FC_READ_COILS, addr, nb, dest); if (rc == -1) return -1; else return nb; } /* Same as modbus_read_bits but reads the remote device input table */ int modbus_read_input_bits(modbus_t *ctx, int addr, int nb, uint8_t *dest) { int rc; if (nb > MODBUS_MAX_READ_BITS) { if (ctx->debug) { fprintf(stderr, "ERROR Too many discrete inputs requested (%d > %d)\n", nb, MODBUS_MAX_READ_BITS); } errno = EMBMDATA; return -1; } rc = read_io_status(ctx, _FC_READ_DISCRETE_INPUTS, addr, nb, dest); if (rc == -1) return -1; else return nb; } /* Reads the data from a remove device and put that data into an array */ static int read_registers(modbus_t *ctx, int function, int addr, int nb, uint16_t *dest) { int rc; int req_length; uint8_t req[_MIN_REQ_LENGTH]; uint8_t rsp[MAX_MESSAGE_LENGTH]; if (nb > MODBUS_MAX_READ_REGISTERS) { if (ctx->debug) { fprintf(stderr, "ERROR Too many registers requested (%d > %d)\n", nb, MODBUS_MAX_READ_REGISTERS); } errno = EMBMDATA; return -1; } req_length = ctx->backend->build_request_basis(ctx, function, addr, nb, req); rc = send_msg(ctx, req, req_length); if (rc > 0) { int offset; int i; rc = receive_msg(ctx, rsp, MSG_CONFIRMATION); if (rc == -1) return -1; rc = check_confirmation(ctx, req, rsp, rc); if (rc == -1) return -1; offset = ctx->backend->header_length; for (i = 0; i < rc; i++) { /* shift reg hi_byte to temp OR with lo_byte */ dest[i] = (rsp[offset + 2 + (i << 1)] << 8) | rsp[offset + 3 + (i << 1)]; } } return rc; } /* Reads the holding registers of remote device and put the data into an array */ int modbus_read_registers(modbus_t *ctx, int addr, int nb, uint16_t *dest) { int status; if (nb > MODBUS_MAX_READ_REGISTERS) { if (ctx->debug) { fprintf(stderr, "ERROR Too many registers requested (%d > %d)\n", nb, MODBUS_MAX_READ_REGISTERS); } errno = EMBMDATA; return -1; } status = read_registers(ctx, _FC_READ_HOLDING_REGISTERS, addr, nb, dest); return status; } /* Reads the input registers of remote device and put the data into an array */ int modbus_read_input_registers(modbus_t *ctx, int addr, int nb, uint16_t *dest) { int status; if (nb > MODBUS_MAX_READ_REGISTERS) { fprintf(stderr, "ERROR Too many input registers requested (%d > %d)\n", nb, MODBUS_MAX_READ_REGISTERS); errno = EMBMDATA; return -1; } status = read_registers(ctx, _FC_READ_INPUT_REGISTERS, addr, nb, dest); return status; } /* Write a value to the specified register of the remote device. Used by write_bit and write_register */ static int write_single(modbus_t *ctx, int function, int addr, int value) { int rc; int req_length; uint8_t req[_MIN_REQ_LENGTH]; req_length = ctx->backend->build_request_basis(ctx, function, addr, value, req); rc = send_msg(ctx, req, req_length); if (rc > 0) { /* Used by write_bit and write_register */ uint8_t rsp[MAX_MESSAGE_LENGTH]; rc = receive_msg(ctx, rsp, MSG_CONFIRMATION); if (rc == -1) return -1; rc = check_confirmation(ctx, req, rsp, rc); } return rc; } /* Turns ON or OFF a single bit of the remote device */ int modbus_write_bit(modbus_t *ctx, int addr, int status) { return write_single(ctx, _FC_WRITE_SINGLE_COIL, addr, status ? 0xFF00 : 0); } /* Writes a value in one register of the remote device */ int modbus_write_register(modbus_t *ctx, int addr, int value) { return write_single(ctx, _FC_WRITE_SINGLE_REGISTER, addr, value); } /* Write the bits of the array in the remote device */ int modbus_write_bits(modbus_t *ctx, int addr, int nb, const uint8_t *src) { int rc; int i; int byte_count; int req_length; int bit_check = 0; int pos = 0; uint8_t req[MAX_MESSAGE_LENGTH]; if (nb > MODBUS_MAX_WRITE_BITS) { if (ctx->debug) { fprintf(stderr, "ERROR Writing too many bits (%d > %d)\n", nb, MODBUS_MAX_WRITE_BITS); } errno = EMBMDATA; return -1; } req_length = ctx->backend->build_request_basis(ctx, _FC_WRITE_MULTIPLE_COILS, addr, nb, req); byte_count = (nb / 8) + ((nb % 8) ? 1 : 0); req[req_length++] = byte_count; for (i = 0; i < byte_count; i++) { int bit; bit = 0x01; req[req_length] = 0; while ((bit & 0xFF) && (bit_check++ < nb)) { if (src[pos++]) req[req_length] |= bit; else req[req_length] &=~ bit; bit = bit << 1; } req_length++; } rc = send_msg(ctx, req, req_length); if (rc > 0) { uint8_t rsp[MAX_MESSAGE_LENGTH]; rc = receive_msg(ctx, rsp, MSG_CONFIRMATION); if (rc == -1) return -1; rc = check_confirmation(ctx, req, rsp, rc); } return rc; } /* Write the values from the array to the registers of the remote device */ int modbus_write_registers(modbus_t *ctx, int addr, int nb, const uint16_t *src) { int rc; int i; int req_length; int byte_count; uint8_t req[MAX_MESSAGE_LENGTH]; if (nb > MODBUS_MAX_WRITE_REGISTERS) { if (ctx->debug) { fprintf(stderr, "ERROR Trying to write to too many registers (%d > %d)\n", nb, MODBUS_MAX_WRITE_REGISTERS); } errno = EMBMDATA; return -1; } req_length = ctx->backend->build_request_basis(ctx, _FC_WRITE_MULTIPLE_REGISTERS, addr, nb, req); byte_count = nb * 2; req[req_length++] = byte_count; for (i = 0; i < nb; i++) { req[req_length++] = src[i] >> 8; req[req_length++] = src[i] & 0x00FF; } rc = send_msg(ctx, req, req_length); if (rc > 0) { uint8_t rsp[MAX_MESSAGE_LENGTH]; rc = receive_msg(ctx, rsp, MSG_CONFIRMATION); if (rc == -1) return -1; rc = check_confirmation(ctx, req, rsp, rc); } return rc; } /* Write multiple registers from src array to remote device and read multiple registers from remote device to dest array. */ int modbus_write_and_read_registers(modbus_t *ctx, int write_addr, int write_nb, const uint16_t *src, int read_addr, int read_nb, uint16_t *dest) { int rc; int req_length; int i; int byte_count; uint8_t req[MAX_MESSAGE_LENGTH]; uint8_t rsp[MAX_MESSAGE_LENGTH]; if (write_nb > MODBUS_MAX_RW_WRITE_REGISTERS) { if (ctx->debug) { fprintf(stderr, "ERROR Too many registers to write (%d > %d)\n", write_nb, MODBUS_MAX_RW_WRITE_REGISTERS); } errno = EMBMDATA; return -1; } if (read_nb > MODBUS_MAX_READ_REGISTERS) { if (ctx->debug) { fprintf(stderr, "ERROR Too many registers requested (%d > %d)\n", read_nb, MODBUS_MAX_READ_REGISTERS); } errno = EMBMDATA; return -1; } req_length = ctx->backend->build_request_basis(ctx, _FC_WRITE_AND_READ_REGISTERS, read_addr, read_nb, req); req[req_length++] = write_addr >> 8; req[req_length++] = write_addr & 0x00ff; req[req_length++] = write_nb >> 8; req[req_length++] = write_nb & 0x00ff; byte_count = write_nb * 2; req[req_length++] = byte_count; for (i = 0; i < write_nb; i++) { req[req_length++] = src[i] >> 8; req[req_length++] = src[i] & 0x00FF; } rc = send_msg(ctx, req, req_length); if (rc > 0) { int offset; rc = receive_msg(ctx, rsp, MSG_CONFIRMATION); if (rc == -1) return -1; rc = check_confirmation(ctx, req, rsp, rc); if (rc == -1) return -1; offset = ctx->backend->header_length; /* If rc is negative, the loop is jumped ! */ for (i = 0; i < rc; i++) { /* shift reg hi_byte to temp OR with lo_byte */ dest[i] = (rsp[offset + 2 + (i << 1)] << 8) | rsp[offset + 3 + (i << 1)]; } } return rc; } /* Send a request to get the slave ID of the device (only available in serial communication). */ int modbus_report_slave_id(modbus_t *ctx, uint8_t *dest) { int rc; int req_length; uint8_t req[_MIN_REQ_LENGTH]; req_length = ctx->backend->build_request_basis(ctx, _FC_REPORT_SLAVE_ID, 0, 0, req); /* HACKISH, addr and count are not used */ req_length -= 4; rc = send_msg(ctx, req, req_length); if (rc > 0) { int i; int offset; uint8_t rsp[MAX_MESSAGE_LENGTH]; rc = receive_msg(ctx, rsp, MSG_CONFIRMATION); if (rc == -1) return -1; rc = check_confirmation(ctx, req, rsp, rc); if (rc == -1) return -1; offset = ctx->backend->header_length + 2; /* Byte count, slave id, run indicator status, additional data */ for (i=0; i < rc; i++) { dest[i] = rsp[offset + i]; } } return rc; } void _modbus_init_common(modbus_t *ctx) { /* Slave and socket are initialized to -1 */ ctx->slave = -1; ctx->s = -1; ctx->debug = FALSE; ctx->error_recovery = MODBUS_ERROR_RECOVERY_NONE; ctx->response_timeout.tv_sec = 0; ctx->response_timeout.tv_usec = _RESPONSE_TIMEOUT; ctx->byte_timeout.tv_sec = 0; ctx->byte_timeout.tv_usec = _BYTE_TIMEOUT; } /* Define the slave number */ int modbus_set_slave(modbus_t *ctx, int slave) { return ctx->backend->set_slave(ctx, slave); } int modbus_set_error_recovery(modbus_t *ctx, modbus_error_recovery_mode error_recovery) { /* The type of modbus_error_recovery_mode is unsigned enum */ ctx->error_recovery = (uint8_t) error_recovery; return 0; } void modbus_set_socket(modbus_t *ctx, int socket) { ctx->s = socket; } int modbus_get_socket(modbus_t *ctx) { return ctx->s; } /* Get the timeout interval used to wait for a response */ void modbus_get_response_timeout(modbus_t *ctx, struct timeval *timeout) { *timeout = ctx->response_timeout; } void modbus_set_response_timeout(modbus_t *ctx, const struct timeval *timeout) { ctx->response_timeout = *timeout; } /* Get the timeout interval between two consecutive bytes of a message */ void modbus_get_byte_timeout(modbus_t *ctx, struct timeval *timeout) { *timeout = ctx->byte_timeout; } void modbus_set_byte_timeout(modbus_t *ctx, const struct timeval *timeout) { ctx->byte_timeout = *timeout; } int modbus_get_header_length(modbus_t *ctx) { return ctx->backend->header_length; } int modbus_connect(modbus_t *ctx) { return ctx->backend->connect(ctx); } void modbus_close(modbus_t *ctx) { if (ctx == NULL) return; ctx->backend->close(ctx); } void modbus_free(modbus_t *ctx) { if (ctx == NULL) return; free(ctx->backend_data); free(ctx); } void modbus_set_debug(modbus_t *ctx, int boolean) { ctx->debug = boolean; } /* Allocates 4 arrays to store bits, input bits, registers and inputs registers. The pointers are stored in modbus_mapping structure. The modbus_mapping_new() function shall return the new allocated structure if successful. Otherwise it shall return NULL and set errno to ENOMEM. */ modbus_mapping_t* modbus_mapping_new(int nb_bits, int nb_input_bits, int nb_registers, int nb_input_registers) { modbus_mapping_t *mb_mapping; mb_mapping = (modbus_mapping_t *)malloc(sizeof(modbus_mapping_t)); if (mb_mapping == NULL) { return NULL; } /* 0X */ mb_mapping->nb_bits = nb_bits; if (nb_bits == 0) { mb_mapping->tab_bits = NULL; } else { /* Negative number raises a POSIX error */ mb_mapping->tab_bits = (uint8_t *) malloc(nb_bits * sizeof(uint8_t)); if (mb_mapping->tab_bits == NULL) { free(mb_mapping); return NULL; } memset(mb_mapping->tab_bits, 0, nb_bits * sizeof(uint8_t)); } /* 1X */ mb_mapping->nb_input_bits = nb_input_bits; if (nb_input_bits == 0) { mb_mapping->tab_input_bits = NULL; } else { mb_mapping->tab_input_bits = (uint8_t *) malloc(nb_input_bits * sizeof(uint8_t)); if (mb_mapping->tab_input_bits == NULL) { free(mb_mapping->tab_bits); free(mb_mapping); return NULL; } memset(mb_mapping->tab_input_bits, 0, nb_input_bits * sizeof(uint8_t)); } /* 4X */ mb_mapping->nb_registers = nb_registers; if (nb_registers == 0) { mb_mapping->tab_registers = NULL; } else { mb_mapping->tab_registers = (uint16_t *) malloc(nb_registers * sizeof(uint16_t)); if (mb_mapping->tab_registers == NULL) { free(mb_mapping->tab_input_bits); free(mb_mapping->tab_bits); free(mb_mapping); return NULL; } memset(mb_mapping->tab_registers, 0, nb_registers * sizeof(uint16_t)); } /* 3X */ mb_mapping->nb_input_registers = nb_input_registers; if (nb_input_registers == 0) { mb_mapping->tab_input_registers = NULL; } else { mb_mapping->tab_input_registers = (uint16_t *) malloc(nb_input_registers * sizeof(uint16_t)); if (mb_mapping->tab_input_registers == NULL) { free(mb_mapping->tab_registers); free(mb_mapping->tab_input_bits); free(mb_mapping->tab_bits); free(mb_mapping); return NULL; } memset(mb_mapping->tab_input_registers, 0, nb_input_registers * sizeof(uint16_t)); } return mb_mapping; } /* Frees the 4 arrays */ void modbus_mapping_free(modbus_mapping_t *mb_mapping) { if (mb_mapping == NULL) { return; } free(mb_mapping->tab_input_registers); free(mb_mapping->tab_registers); free(mb_mapping->tab_input_bits); free(mb_mapping->tab_bits); free(mb_mapping); } #ifndef HAVE_STRLCPY /* * Function strlcpy was originally developed by * Todd C. Miller to simplify writing secure code. * See ftp://ftp.openbsd.org/pub/OpenBSD/src/lib/libc/string/strlcpy.3 * for more information. * * Thank you Ulrich Drepper... not! * * Copy src to string dest of size dest_size. At most dest_size-1 characters * will be copied. Always NUL terminates (unless dest_size == 0). Returns * strlen(src); if retval >= dest_size, truncation occurred. */ size_t strlcpy(char *dest, const char *src, size_t dest_size) { register char *d = dest; register const char *s = src; register size_t n = dest_size; /* Copy as many bytes as will fit */ if (n != 0 && --n != 0) { do { if ((*d++ = *s++) == 0) break; } while (--n != 0); } /* Not enough room in dest, add NUL and traverse rest of src */ if (n == 0) { if (dest_size != 0) *d = '\0'; /* NUL-terminate dest */ while (*s++) ; } return (s - src - 1); /* count does not include NUL */ } #endif libmodbus-3.0.5/src/modbus.h000066400000000000000000000172721222457407600157520ustar00rootroot00000000000000/* * Copyright © 2001-2011 Stéphane Raimbault * * This library is free software; you can redistribute it and/or * modify it under the terms of the GNU Lesser General Public * License as published by the Free Software Foundation; either * version 2.1 of the License, or (at your option) any later version. * * This library is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU * Lesser General Public License for more details. * * You should have received a copy of the GNU Lesser General Public * License along with this library; if not, write to the Free Software * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA */ #ifndef _MODBUS_H_ #define _MODBUS_H_ /* Add this for macros that defined unix flavor */ #if (defined(__unix__) || defined(unix)) && !defined(USG) #include #endif #ifndef _MSC_VER #include #include #else #include "stdint.h" #include #endif #include "modbus-version.h" #ifdef __cplusplus # define MODBUS_BEGIN_DECLS extern "C" { # define MODBUS_END_DECLS } #else # define MODBUS_BEGIN_DECLS # define MODBUS_END_DECLS #endif MODBUS_BEGIN_DECLS #ifndef FALSE #define FALSE 0 #endif #ifndef TRUE #define TRUE 1 #endif #ifndef OFF #define OFF 0 #endif #ifndef ON #define ON 1 #endif #define MODBUS_BROADCAST_ADDRESS 0 /* Modbus_Application_Protocol_V1_1b.pdf (chapter 6 section 1 page 12) * Quantity of Coils to read (2 bytes): 1 to 2000 (0x7D0) * (chapter 6 section 11 page 29) * Quantity of Coils to write (2 bytes): 1 to 1968 (0x7B0) */ #define MODBUS_MAX_READ_BITS 2000 #define MODBUS_MAX_WRITE_BITS 1968 /* Modbus_Application_Protocol_V1_1b.pdf (chapter 6 section 3 page 15) * Quantity of Registers to read (2 bytes): 1 to 125 (0x7D) * (chapter 6 section 12 page 31) * Quantity of Registers to write (2 bytes) 1 to 123 (0x7B) * (chapter 6 section 17 page 38) * Quantity of Registers to write in R/W registers (2 bytes) 1 to 121 (0x79) */ #define MODBUS_MAX_READ_REGISTERS 125 #define MODBUS_MAX_WRITE_REGISTERS 123 #define MODBUS_MAX_RW_WRITE_REGISTERS 121 /* Random number to avoid errno conflicts */ #define MODBUS_ENOBASE 112345678 /* Protocol exceptions */ enum { MODBUS_EXCEPTION_ILLEGAL_FUNCTION = 0x01, MODBUS_EXCEPTION_ILLEGAL_DATA_ADDRESS, MODBUS_EXCEPTION_ILLEGAL_DATA_VALUE, MODBUS_EXCEPTION_SLAVE_OR_SERVER_FAILURE, MODBUS_EXCEPTION_ACKNOWLEDGE, MODBUS_EXCEPTION_SLAVE_OR_SERVER_BUSY, MODBUS_EXCEPTION_NEGATIVE_ACKNOWLEDGE, MODBUS_EXCEPTION_MEMORY_PARITY, MODBUS_EXCEPTION_NOT_DEFINED, MODBUS_EXCEPTION_GATEWAY_PATH, MODBUS_EXCEPTION_GATEWAY_TARGET, MODBUS_EXCEPTION_MAX }; #define EMBXILFUN (MODBUS_ENOBASE + MODBUS_EXCEPTION_ILLEGAL_FUNCTION) #define EMBXILADD (MODBUS_ENOBASE + MODBUS_EXCEPTION_ILLEGAL_DATA_ADDRESS) #define EMBXILVAL (MODBUS_ENOBASE + MODBUS_EXCEPTION_ILLEGAL_DATA_VALUE) #define EMBXSFAIL (MODBUS_ENOBASE + MODBUS_EXCEPTION_SLAVE_OR_SERVER_FAILURE) #define EMBXACK (MODBUS_ENOBASE + MODBUS_EXCEPTION_ACKNOWLEDGE) #define EMBXSBUSY (MODBUS_ENOBASE + MODBUS_EXCEPTION_SLAVE_OR_SERVER_BUSY) #define EMBXNACK (MODBUS_ENOBASE + MODBUS_EXCEPTION_NEGATIVE_ACKNOWLEDGE) #define EMBXMEMPAR (MODBUS_ENOBASE + MODBUS_EXCEPTION_MEMORY_PARITY) #define EMBXGPATH (MODBUS_ENOBASE + MODBUS_EXCEPTION_GATEWAY_PATH) #define EMBXGTAR (MODBUS_ENOBASE + MODBUS_EXCEPTION_GATEWAY_TARGET) /* Native libmodbus error codes */ #define EMBBADCRC (EMBXGTAR + 1) #define EMBBADDATA (EMBXGTAR + 2) #define EMBBADEXC (EMBXGTAR + 3) #define EMBUNKEXC (EMBXGTAR + 4) #define EMBMDATA (EMBXGTAR + 5) extern const unsigned int libmodbus_version_major; extern const unsigned int libmodbus_version_minor; extern const unsigned int libmodbus_version_micro; typedef struct _modbus modbus_t; typedef struct { int nb_bits; int nb_input_bits; int nb_input_registers; int nb_registers; uint8_t *tab_bits; uint8_t *tab_input_bits; uint16_t *tab_input_registers; uint16_t *tab_registers; } modbus_mapping_t; typedef enum { MODBUS_ERROR_RECOVERY_NONE = 0, MODBUS_ERROR_RECOVERY_LINK = (1<<1), MODBUS_ERROR_RECOVERY_PROTOCOL = (1<<2), } modbus_error_recovery_mode; int modbus_set_slave(modbus_t* ctx, int slave); int modbus_set_error_recovery(modbus_t *ctx, modbus_error_recovery_mode error_recovery); void modbus_set_socket(modbus_t *ctx, int socket); int modbus_get_socket(modbus_t *ctx); void modbus_get_response_timeout(modbus_t *ctx, struct timeval *timeout); void modbus_set_response_timeout(modbus_t *ctx, const struct timeval *timeout); void modbus_get_byte_timeout(modbus_t *ctx, struct timeval *timeout); void modbus_set_byte_timeout(modbus_t *ctx, const struct timeval *timeout); int modbus_get_header_length(modbus_t *ctx); int modbus_connect(modbus_t *ctx); void modbus_close(modbus_t *ctx); void modbus_free(modbus_t *ctx); int modbus_flush(modbus_t *ctx); void modbus_set_debug(modbus_t *ctx, int boolean); const char *modbus_strerror(int errnum); int modbus_read_bits(modbus_t *ctx, int addr, int nb, uint8_t *dest); int modbus_read_input_bits(modbus_t *ctx, int addr, int nb, uint8_t *dest); int modbus_read_registers(modbus_t *ctx, int addr, int nb, uint16_t *dest); int modbus_read_input_registers(modbus_t *ctx, int addr, int nb, uint16_t *dest); int modbus_write_bit(modbus_t *ctx, int coil_addr, int status); int modbus_write_register(modbus_t *ctx, int reg_addr, int value); int modbus_write_bits(modbus_t *ctx, int addr, int nb, const uint8_t *data); int modbus_write_registers(modbus_t *ctx, int addr, int nb, const uint16_t *data); int modbus_write_and_read_registers(modbus_t *ctx, int write_addr, int write_nb, const uint16_t *src, int read_addr, int read_nb, uint16_t *dest); int modbus_report_slave_id(modbus_t *ctx, uint8_t *dest); modbus_mapping_t* modbus_mapping_new(int nb_coil_status, int nb_input_status, int nb_holding_registers, int nb_input_registers); void modbus_mapping_free(modbus_mapping_t *mb_mapping); int modbus_send_raw_request(modbus_t *ctx, uint8_t *raw_req, int raw_req_length); int modbus_receive(modbus_t *ctx, uint8_t *req); int modbus_receive_from(modbus_t *ctx, int sockfd, uint8_t *req); int modbus_receive_confirmation(modbus_t *ctx, uint8_t *rsp); int modbus_reply(modbus_t *ctx, const uint8_t *req, int req_length, modbus_mapping_t *mb_mapping); int modbus_reply_exception(modbus_t *ctx, const uint8_t *req, unsigned int exception_code); /** * UTILS FUNCTIONS **/ #define MODBUS_GET_HIGH_BYTE(data) (((data) >> 8) & 0xFF) #define MODBUS_GET_LOW_BYTE(data) ((data) & 0xFF) #define MODBUS_GET_INT32_FROM_INT16(tab_int16, index) ((tab_int16[(index)] << 16) + tab_int16[(index) + 1]) #define MODBUS_GET_INT16_FROM_INT8(tab_int8, index) ((tab_int8[(index)] << 8) + tab_int8[(index) + 1]) #define MODBUS_SET_INT16_TO_INT8(tab_int8, index, value) \ do { \ tab_int8[(index)] = (value) >> 8; \ tab_int8[(index) + 1] = (value) & 0xFF; \ } while (0) void modbus_set_bits_from_byte(uint8_t *dest, int index, const uint8_t value); void modbus_set_bits_from_bytes(uint8_t *dest, int index, unsigned int nb_bits, const uint8_t *tab_byte); uint8_t modbus_get_byte_from_bits(const uint8_t *src, int index, unsigned int nb_bits); float modbus_get_float(const uint16_t *src); void modbus_set_float(float f, uint16_t *dest); #include "modbus-tcp.h" #include "modbus-rtu.h" MODBUS_END_DECLS #endif /* _MODBUS_H_ */ libmodbus-3.0.5/tests/000077500000000000000000000000001222457407600146525ustar00rootroot00000000000000libmodbus-3.0.5/tests/Makefile.am000066400000000000000000000021011222457407600167000ustar00rootroot00000000000000EXTRA_DIST = README noinst_PROGRAMS = \ bandwidth-server-one \ bandwidth-server-many-up \ bandwidth-client \ random-test-server \ random-test-client \ unit-test-server \ unit-test-client \ version common_ldflags = \ $(top_builddir)/src/libmodbus.la bandwidth_server_one_SOURCES = bandwidth-server-one.c bandwidth_server_one_LDADD = $(common_ldflags) bandwidth_server_many_up_SOURCES = bandwidth-server-many-up.c bandwidth_server_many_up_LDADD = $(common_ldflags) bandwidth_client_SOURCES = bandwidth-client.c bandwidth_client_LDADD = $(common_ldflags) random_test_server_SOURCES = random-test-server.c random_test_server_LDADD = $(common_ldflags) random_test_client_SOURCES = random-test-client.c random_test_client_LDADD = $(common_ldflags) unit_test_server_SOURCES = unit-test-server.c unit-test.h unit_test_server_LDADD = $(common_ldflags) unit_test_client_SOURCES = unit-test-client.c unit-test.h unit_test_client_LDADD = $(common_ldflags) version_SOURCES = version.c version_LDADD = $(common_ldflags) INCLUDES = -I$(top_srcdir) -I$(top_srcdir)/src CLEANFILES = *~ libmodbus-3.0.5/tests/README000066400000000000000000000024071222457407600155350ustar00rootroot00000000000000Compilation ----------- After installation, you can use pkg-config to compile these tests. For example, to compile random-test-server run: gcc random-test-server.c -o random-test-server `pkg-config --libs --cflags libmodbus` random-test-server ----------------- It's necessary to launch this server before run random-test-client. By default, it receives and responses to Modbus query on the localhost and port 1502. random-test-client ------------------ This programm sends many different queries to a large range of addresses and values to test the communication between the client and the server. unit-test-server unit-test-client ---------------- By default, this program sends some queries with the values defined in unit-test.h and checks the responses. These programs are useful to test the protocol implementation. bandwidth-server-one bandwidth-server-many-up bandwidth-client ----------------------- It returns some very useful informations about the performance of transfert rate between the server and the client. - bandwidth-server-one: it can handles only one connection with a client. - bandwidth-server-many-up: it opens a connection each time a new client asks for, but the number of connection is limited. The same server process handles all the connections. libmodbus-3.0.5/tests/bandwidth-client.c000066400000000000000000000151131222457407600202370ustar00rootroot00000000000000/* * Copyright © 2008-2010 Stéphane Raimbault * * This program is free software: you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by * the Free Software Foundation; either version 3 of the License, or * (at your option) any later version. * * This program is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. * * You should have received a copy of the GNU General Public License * along with this program. If not, see . */ #include #include #include #include #include #include #include #include #define G_MSEC_PER_SEC 1000 uint32_t gettime_ms(void) { struct timeval tv; gettimeofday (&tv, NULL); return (uint32_t) tv.tv_sec * 1000 + tv.tv_usec / 1000; } enum { TCP, RTU }; /* Tests based on PI-MBUS-300 documentation */ int main(int argc, char *argv[]) { uint8_t *tab_bit; uint16_t *tab_reg; modbus_t *ctx; int i; int nb_points; double elapsed; uint32_t start; uint32_t end; uint32_t bytes; uint32_t rate; int rc; int n_loop; int use_backend; if (argc > 1) { if (strcmp(argv[1], "tcp") == 0) { use_backend = TCP; n_loop = 100000; } else if (strcmp(argv[1], "rtu") == 0) { use_backend = RTU; n_loop = 100; } else { printf("Usage:\n %s [tcp|rtu] - Modbus client to measure data bandwith\n\n", argv[0]); exit(1); } } else { /* By default */ use_backend = TCP; n_loop = 100000; } if (use_backend == TCP) { ctx = modbus_new_tcp("127.0.0.1", 1502); } else { ctx = modbus_new_rtu("/dev/ttyUSB1", 115200, 'N', 8, 1); modbus_set_slave(ctx, 1); } if (modbus_connect(ctx) == -1) { fprintf(stderr, "Connexion failed: %s\n", modbus_strerror(errno)); modbus_free(ctx); return -1; } /* Allocate and initialize the memory to store the status */ tab_bit = (uint8_t *) malloc(MODBUS_MAX_READ_BITS * sizeof(uint8_t)); memset(tab_bit, 0, MODBUS_MAX_READ_BITS * sizeof(uint8_t)); /* Allocate and initialize the memory to store the registers */ tab_reg = (uint16_t *) malloc(MODBUS_MAX_READ_REGISTERS * sizeof(uint16_t)); memset(tab_reg, 0, MODBUS_MAX_READ_REGISTERS * sizeof(uint16_t)); printf("READ BITS\n\n"); nb_points = MODBUS_MAX_READ_BITS; start = gettime_ms(); for (i=0; i * * This program is free software: you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by * the Free Software Foundation; either version 3 of the License, or * (at your option) any later version. * * This program is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. * * You should have received a copy of the GNU General Public License * along with this program. If not, see . */ #include #include #include #include #include #include #include #if defined(_WIN32) #include #else #include #include #include #endif #define NB_CONNECTION 5 modbus_t *ctx = NULL; int server_socket; modbus_mapping_t *mb_mapping; static void close_sigint(int dummy) { close(server_socket); modbus_free(ctx); modbus_mapping_free(mb_mapping); exit(dummy); } int main(void) { int master_socket; int rc; fd_set refset; fd_set rdset; /* Maximum file descriptor number */ int fdmax; ctx = modbus_new_tcp("127.0.0.1", 1502); mb_mapping = modbus_mapping_new(MODBUS_MAX_READ_BITS, 0, MODBUS_MAX_READ_REGISTERS, 0); if (mb_mapping == NULL) { fprintf(stderr, "Failed to allocate the mapping: %s\n", modbus_strerror(errno)); modbus_free(ctx); return -1; } server_socket = modbus_tcp_listen(ctx, NB_CONNECTION); signal(SIGINT, close_sigint); /* Clear the reference set of socket */ FD_ZERO(&refset); /* Add the server socket */ FD_SET(server_socket, &refset); /* Keep track of the max file descriptor */ fdmax = server_socket; for (;;) { rdset = refset; if (select(fdmax+1, &rdset, NULL, NULL, NULL) == -1) { perror("Server select() failure."); close_sigint(1); } /* Run through the existing connections looking for data to be * read */ for (master_socket = 0; master_socket <= fdmax; master_socket++) { if (FD_ISSET(master_socket, &rdset)) { if (master_socket == server_socket) { /* A client is asking a new connection */ socklen_t addrlen; struct sockaddr_in clientaddr; int newfd; /* Handle new connections */ addrlen = sizeof(clientaddr); memset(&clientaddr, 0, sizeof(clientaddr)); newfd = accept(server_socket, (struct sockaddr *)&clientaddr, &addrlen); if (newfd == -1) { perror("Server accept() error"); } else { FD_SET(newfd, &refset); if (newfd > fdmax) { /* Keep track of the maximum */ fdmax = newfd; } printf("New connection from %s:%d on socket %d\n", inet_ntoa(clientaddr.sin_addr), clientaddr.sin_port, newfd); } } else { /* An already connected master has sent a new query */ uint8_t query[MODBUS_TCP_MAX_ADU_LENGTH]; modbus_set_socket(ctx, master_socket); rc = modbus_receive(ctx, query); if (rc != -1) { modbus_reply(ctx, query, rc, mb_mapping); } else { /* Connection closed by the client, end of server */ printf("Connection closed on socket %d\n", master_socket); close(master_socket); /* Remove from reference set */ FD_CLR(master_socket, &refset); if (master_socket == fdmax) { fdmax--; } } } } } } return 0; } libmodbus-3.0.5/tests/bandwidth-server-one.c000066400000000000000000000047151222457407600210540ustar00rootroot00000000000000/* * Copyright © 2008-2010 Stéphane Raimbault * * This program is free software: you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by * the Free Software Foundation; either version 3 of the License, or * (at your option) any later version. * * This program is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. * * You should have received a copy of the GNU General Public License * along with this program. If not, see . */ #include #include #include #include #include #include enum { TCP, RTU }; int main(int argc, char *argv[]) { int socket; modbus_t *ctx; modbus_mapping_t *mb_mapping; int rc; int use_backend; /* TCP */ if (argc > 1) { if (strcmp(argv[1], "tcp") == 0) { use_backend = TCP; } else if (strcmp(argv[1], "rtu") == 0) { use_backend = RTU; } else { printf("Usage:\n %s [tcp|rtu] - Modbus client to measure data bandwith\n\n", argv[0]); exit(1); } } else { /* By default */ use_backend = TCP; } if (use_backend == TCP) { ctx = modbus_new_tcp("127.0.0.1", 1502); socket = modbus_tcp_listen(ctx, 1); modbus_tcp_accept(ctx, &socket); } else { ctx = modbus_new_rtu("/dev/ttyUSB0", 115200, 'N', 8, 1); modbus_set_slave(ctx, 1); modbus_connect(ctx); } mb_mapping = modbus_mapping_new(MODBUS_MAX_READ_BITS, 0, MODBUS_MAX_READ_REGISTERS, 0); if (mb_mapping == NULL) { fprintf(stderr, "Failed to allocate the mapping: %s\n", modbus_strerror(errno)); modbus_free(ctx); return -1; } for(;;) { uint8_t query[MODBUS_TCP_MAX_ADU_LENGTH]; rc = modbus_receive(ctx, query); if (rc >= 0) { modbus_reply(ctx, query, rc, mb_mapping); } else { /* Connection closed by the client or server */ break; } } printf("Quit the loop: %s\n", modbus_strerror(errno)); modbus_mapping_free(mb_mapping); close(socket); modbus_free(ctx); return 0; } libmodbus-3.0.5/tests/random-test-client.c000066400000000000000000000224471222457407600205400ustar00rootroot00000000000000/* * Copyright © 2001-2010 Stéphane Raimbault * * This program is free software: you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by * the Free Software Foundation; either version 3 of the License, or * (at your option) any later version. * * This program is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. * * You should have received a copy of the GNU General Public License * along with this program. If not, see . */ #include #include #include #include #include #include /* The goal of this program is to check all major functions of libmodbus: - write_coil - read_bits - write_coils - write_register - read_registers - write_registers - read_registers All these functions are called with random values on a address range defined by the following defines. */ #define LOOP 1 #define SERVER_ID 17 #define ADDRESS_START 0 #define ADDRESS_END 99 /* At each loop, the program works in the range ADDRESS_START to * ADDRESS_END then ADDRESS_START + 1 to ADDRESS_END and so on. */ int main(void) { modbus_t *ctx; int rc; int nb_fail; int nb_loop; int addr; int nb; uint8_t *tab_rq_bits; uint8_t *tab_rp_bits; uint16_t *tab_rq_registers; uint16_t *tab_rw_rq_registers; uint16_t *tab_rp_registers; /* RTU */ /* ctx = modbus_new_rtu("/dev/ttyUSB0", 19200, 'N', 8, 1); modbus_set_slave(ctx, SERVER_ID); */ /* TCP */ ctx = modbus_new_tcp("127.0.0.1", 1502); modbus_set_debug(ctx, TRUE); if (modbus_connect(ctx) == -1) { fprintf(stderr, "Connection failed: %s\n", modbus_strerror(errno)); modbus_free(ctx); return -1; } /* Allocate and initialize the different memory spaces */ nb = ADDRESS_END - ADDRESS_START; tab_rq_bits = (uint8_t *) malloc(nb * sizeof(uint8_t)); memset(tab_rq_bits, 0, nb * sizeof(uint8_t)); tab_rp_bits = (uint8_t *) malloc(nb * sizeof(uint8_t)); memset(tab_rp_bits, 0, nb * sizeof(uint8_t)); tab_rq_registers = (uint16_t *) malloc(nb * sizeof(uint16_t)); memset(tab_rq_registers, 0, nb * sizeof(uint16_t)); tab_rp_registers = (uint16_t *) malloc(nb * sizeof(uint16_t)); memset(tab_rp_registers, 0, nb * sizeof(uint16_t)); tab_rw_rq_registers = (uint16_t *) malloc(nb * sizeof(uint16_t)); memset(tab_rw_rq_registers, 0, nb * sizeof(uint16_t)); nb_loop = nb_fail = 0; while (nb_loop++ < LOOP) { for (addr = ADDRESS_START; addr <= ADDRESS_END; addr++) { int i; /* Random numbers (short) */ for (i=0; i * * This program is free software: you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by * the Free Software Foundation; either version 3 of the License, or * (at your option) any later version. * * This program is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. * * You should have received a copy of the GNU General Public License * along with this program. If not, see . */ #include #include #include #include #include int main(void) { int socket; modbus_t *ctx; modbus_mapping_t *mb_mapping; ctx = modbus_new_tcp("127.0.0.1", 1502); /* modbus_set_debug(ctx, TRUE); */ mb_mapping = modbus_mapping_new(500, 500, 500, 500); if (mb_mapping == NULL) { fprintf(stderr, "Failed to allocate the mapping: %s\n", modbus_strerror(errno)); modbus_free(ctx); return -1; } socket = modbus_tcp_listen(ctx, 1); modbus_tcp_accept(ctx, &socket); for (;;) { uint8_t query[MODBUS_TCP_MAX_ADU_LENGTH]; int rc; rc = modbus_receive(ctx, query); if (rc != -1) { /* rc is the query size */ modbus_reply(ctx, query, rc, mb_mapping); } else { /* Connection closed by the client or error */ break; } } printf("Quit the loop: %s\n", modbus_strerror(errno)); modbus_mapping_free(mb_mapping); modbus_close(ctx); modbus_free(ctx); return 0; } libmodbus-3.0.5/tests/unit-test-client.c000066400000000000000000000505261222457407600202360ustar00rootroot00000000000000/* * Copyright © 2008-2010 Stéphane Raimbault * * This program is free software: you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by * the Free Software Foundation; either version 3 of the License, or * (at your option) any later version. * * This program is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. * * You should have received a copy of the GNU General Public License * along with this program. If not, see . */ #include #include #include #include #include #include #include "unit-test.h" enum { TCP, TCP_PI, RTU }; int main(int argc, char *argv[]) { uint8_t *tab_rp_bits; uint16_t *tab_rp_registers; uint16_t *tab_rp_registers_bad; modbus_t *ctx; int i; uint8_t value; int nb_points; int rc; float real; uint32_t ireal; struct timeval old_response_timeout; struct timeval response_timeout; int use_backend; if (argc > 1) { if (strcmp(argv[1], "tcp") == 0) { use_backend = TCP; } else if (strcmp(argv[1], "tcppi") == 0) { use_backend = TCP_PI; } else if (strcmp(argv[1], "rtu") == 0) { use_backend = RTU; } else { printf("Usage:\n %s [tcp|tcppi|rtu] - Modbus client for unit testing\n\n", argv[0]); exit(1); } } else { /* By default */ use_backend = TCP; } if (use_backend == TCP) { ctx = modbus_new_tcp("127.0.0.1", 1502); } else if (use_backend == TCP_PI) { ctx = modbus_new_tcp_pi("::1", "1502"); } else { ctx = modbus_new_rtu("/dev/ttyUSB1", 115200, 'N', 8, 1); } if (ctx == NULL) { fprintf(stderr, "Unable to allocate libmodbus context\n"); return -1; } modbus_set_debug(ctx, TRUE); modbus_set_error_recovery(ctx, MODBUS_ERROR_RECOVERY_LINK | MODBUS_ERROR_RECOVERY_PROTOCOL); if (use_backend == RTU) { modbus_set_slave(ctx, SERVER_ID); } if (modbus_connect(ctx) == -1) { fprintf(stderr, "Connection failed: %s\n", modbus_strerror(errno)); modbus_free(ctx); return -1; } /* Allocate and initialize the memory to store the bits */ nb_points = (UT_BITS_NB > UT_INPUT_BITS_NB) ? UT_BITS_NB : UT_INPUT_BITS_NB; tab_rp_bits = (uint8_t *) malloc(nb_points * sizeof(uint8_t)); memset(tab_rp_bits, 0, nb_points * sizeof(uint8_t)); /* Allocate and initialize the memory to store the registers */ nb_points = (UT_REGISTERS_NB > UT_INPUT_REGISTERS_NB) ? UT_REGISTERS_NB : UT_INPUT_REGISTERS_NB; tab_rp_registers = (uint16_t *) malloc(nb_points * sizeof(uint16_t)); memset(tab_rp_registers, 0, nb_points * sizeof(uint16_t)); printf("** UNIT TESTING **\n"); printf("\nTEST WRITE/READ:\n"); /** COIL BITS **/ /* Single */ rc = modbus_write_bit(ctx, UT_BITS_ADDRESS, ON); printf("1/2 modbus_write_bit: "); if (rc == 1) { printf("OK\n"); } else { printf("FAILED\n"); goto close; } rc = modbus_read_bits(ctx, UT_BITS_ADDRESS, 1, tab_rp_bits); printf("2/2 modbus_read_bits: "); if (rc != 1) { printf("FAILED (nb points %d)\n", rc); goto close; } if (tab_rp_bits[0] != ON) { printf("FAILED (%0X = != %0X)\n", tab_rp_bits[0], ON); goto close; } printf("OK\n"); /* End single */ /* Multiple bits */ { uint8_t tab_value[UT_BITS_NB]; modbus_set_bits_from_bytes(tab_value, 0, UT_BITS_NB, UT_BITS_TAB); rc = modbus_write_bits(ctx, UT_BITS_ADDRESS, UT_BITS_NB, tab_value); printf("1/2 modbus_write_bits: "); if (rc == UT_BITS_NB) { printf("OK\n"); } else { printf("FAILED\n"); goto close; } } rc = modbus_read_bits(ctx, UT_BITS_ADDRESS, UT_BITS_NB, tab_rp_bits); printf("2/2 modbus_read_bits: "); if (rc != UT_BITS_NB) { printf("FAILED (nb points %d)\n", rc); goto close; } i = 0; nb_points = UT_BITS_NB; while (nb_points > 0) { int nb_bits = (nb_points > 8) ? 8 : nb_points; value = modbus_get_byte_from_bits(tab_rp_bits, i*8, nb_bits); if (value != UT_BITS_TAB[i]) { printf("FAILED (%0X != %0X)\n", value, UT_BITS_TAB[i]); goto close; } nb_points -= nb_bits; i++; } printf("OK\n"); /* End of multiple bits */ /** DISCRETE INPUTS **/ rc = modbus_read_input_bits(ctx, UT_INPUT_BITS_ADDRESS, UT_INPUT_BITS_NB, tab_rp_bits); printf("1/1 modbus_read_input_bits: "); if (rc != UT_INPUT_BITS_NB) { printf("FAILED (nb points %d)\n", rc); goto close; } i = 0; nb_points = UT_INPUT_BITS_NB; while (nb_points > 0) { int nb_bits = (nb_points > 8) ? 8 : nb_points; value = modbus_get_byte_from_bits(tab_rp_bits, i*8, nb_bits); if (value != UT_INPUT_BITS_TAB[i]) { printf("FAILED (%0X != %0X)\n", value, UT_INPUT_BITS_TAB[i]); goto close; } nb_points -= nb_bits; i++; } printf("OK\n"); /** HOLDING REGISTERS **/ /* Single register */ rc = modbus_write_register(ctx, UT_REGISTERS_ADDRESS, 0x1234); printf("1/2 modbus_write_register: "); if (rc == 1) { printf("OK\n"); } else { printf("FAILED\n"); goto close; } rc = modbus_read_registers(ctx, UT_REGISTERS_ADDRESS, 1, tab_rp_registers); printf("2/2 modbus_read_registers: "); if (rc != 1) { printf("FAILED (nb points %d)\n", rc); goto close; } if (tab_rp_registers[0] != 0x1234) { printf("FAILED (%0X != %0X)\n", tab_rp_registers[0], 0x1234); goto close; } printf("OK\n"); /* End of single register */ /* Many registers */ rc = modbus_write_registers(ctx, UT_REGISTERS_ADDRESS, UT_REGISTERS_NB, UT_REGISTERS_TAB); printf("1/5 modbus_write_registers: "); if (rc == UT_REGISTERS_NB) { printf("OK\n"); } else { printf("FAILED\n"); goto close; } rc = modbus_read_registers(ctx, UT_REGISTERS_ADDRESS, UT_REGISTERS_NB, tab_rp_registers); printf("2/5 modbus_read_registers: "); if (rc != UT_REGISTERS_NB) { printf("FAILED (nb points %d)\n", rc); goto close; } for (i=0; i < UT_REGISTERS_NB; i++) { if (tab_rp_registers[i] != UT_REGISTERS_TAB[i]) { printf("FAILED (%0X != %0X)\n", tab_rp_registers[i], UT_REGISTERS_TAB[i]); goto close; } } printf("OK\n"); rc = modbus_read_registers(ctx, UT_REGISTERS_ADDRESS, 0, tab_rp_registers); printf("3/5 modbus_read_registers (0): "); if (rc != -1 && errno == EMBMDATA) { printf("FAILED (nb points %d)\n", rc); goto close; } printf("OK\n"); nb_points = (UT_REGISTERS_NB > UT_INPUT_REGISTERS_NB) ? UT_REGISTERS_NB : UT_INPUT_REGISTERS_NB; memset(tab_rp_registers, 0, nb_points * sizeof(uint16_t)); /* Write registers to zero from tab_rp_registers and store read registers into tab_rp_registers. So the read registers must set to 0, except the first one because there is an offset of 1 register on write. */ rc = modbus_write_and_read_registers(ctx, UT_REGISTERS_ADDRESS + 1, UT_REGISTERS_NB - 1, tab_rp_registers, UT_REGISTERS_ADDRESS, UT_REGISTERS_NB, tab_rp_registers); printf("4/5 modbus_write_and_read_registers: "); if (rc != UT_REGISTERS_NB) { printf("FAILED (nb points %d != %d)\n", rc, UT_REGISTERS_NB); goto close; } if (tab_rp_registers[0] != UT_REGISTERS_TAB[0]) { printf("FAILED (%0X != %0X)\n", tab_rp_registers[0], UT_REGISTERS_TAB[0]); } for (i=1; i < UT_REGISTERS_NB; i++) { if (tab_rp_registers[i] != 0) { printf("FAILED (%0X != %0X)\n", tab_rp_registers[i], 0); goto close; } } printf("OK\n"); /* End of many registers */ /** INPUT REGISTERS **/ rc = modbus_read_input_registers(ctx, UT_INPUT_REGISTERS_ADDRESS, UT_INPUT_REGISTERS_NB, tab_rp_registers); printf("1/1 modbus_read_input_registers: "); if (rc != UT_INPUT_REGISTERS_NB) { printf("FAILED (nb points %d)\n", rc); goto close; } for (i=0; i < UT_INPUT_REGISTERS_NB; i++) { if (tab_rp_registers[i] != UT_INPUT_REGISTERS_TAB[i]) { printf("FAILED (%0X != %0X)\n", tab_rp_registers[i], UT_INPUT_REGISTERS_TAB[i]); goto close; } } printf("OK\n"); printf("\nTEST FLOATS\n"); /** FLOAT **/ printf("1/2 Set float: "); modbus_set_float(UT_REAL, tab_rp_registers); if (tab_rp_registers[1] == (UT_IREAL >> 16) && tab_rp_registers[0] == (UT_IREAL & 0xFFFF)) { printf("OK\n"); } else { /* Avoid *((uint32_t *)tab_rp_registers) * https://github.com/stephane/libmodbus/pull/104 */ ireal = (uint32_t) tab_rp_registers[0] & 0xFFFF; ireal |= (uint32_t) tab_rp_registers[1] << 16; printf("FAILED (%x != %x)\n", ireal, UT_IREAL); goto close; } printf("2/2 Get float: "); real = modbus_get_float(tab_rp_registers); if (real == UT_REAL) { printf("OK\n"); } else { printf("FAILED (%f != %f)\n", real, UT_REAL); goto close; } printf("\nAt this point, error messages doesn't mean the test has failed\n"); /** ILLEGAL DATA ADDRESS **/ printf("\nTEST ILLEGAL DATA ADDRESS:\n"); /* The mapping begins at 0 and ends at address + nb_points so * the addresses are not valid. */ rc = modbus_read_bits(ctx, UT_BITS_ADDRESS, UT_BITS_NB + 1, tab_rp_bits); printf("* modbus_read_bits: "); if (rc == -1 && errno == EMBXILADD) { printf("OK\n"); } else { printf("FAILED\n"); goto close; } rc = modbus_read_input_bits(ctx, UT_INPUT_BITS_ADDRESS, UT_INPUT_BITS_NB + 1, tab_rp_bits); printf("* modbus_read_input_bits: "); if (rc == -1 && errno == EMBXILADD) printf("OK\n"); else { printf("FAILED\n"); goto close; } rc = modbus_read_registers(ctx, UT_REGISTERS_ADDRESS, UT_REGISTERS_NB + 1, tab_rp_registers); printf("* modbus_read_registers: "); if (rc == -1 && errno == EMBXILADD) printf("OK\n"); else { printf("FAILED\n"); goto close; } rc = modbus_read_input_registers(ctx, UT_INPUT_REGISTERS_ADDRESS, UT_INPUT_REGISTERS_NB + 1, tab_rp_registers); printf("* modbus_read_input_registers: "); if (rc == -1 && errno == EMBXILADD) printf("OK\n"); else { printf("FAILED\n"); goto close; } rc = modbus_write_bit(ctx, UT_BITS_ADDRESS + UT_BITS_NB, ON); printf("* modbus_write_bit: "); if (rc == -1 && errno == EMBXILADD) { printf("OK\n"); } else { printf("FAILED\n"); goto close; } rc = modbus_write_bits(ctx, UT_BITS_ADDRESS + UT_BITS_NB, UT_BITS_NB, tab_rp_bits); printf("* modbus_write_coils: "); if (rc == -1 && errno == EMBXILADD) { printf("OK\n"); } else { printf("FAILED\n"); goto close; } rc = modbus_write_registers(ctx, UT_REGISTERS_ADDRESS + UT_REGISTERS_NB, UT_REGISTERS_NB, tab_rp_registers); printf("* modbus_write_registers: "); if (rc == -1 && errno == EMBXILADD) { printf("OK\n"); } else { printf("FAILED\n"); goto close; } /** TOO MANY DATA **/ printf("\nTEST TOO MANY DATA ERROR:\n"); rc = modbus_read_bits(ctx, UT_BITS_ADDRESS, MODBUS_MAX_READ_BITS + 1, tab_rp_bits); printf("* modbus_read_bits: "); if (rc == -1 && errno == EMBMDATA) { printf("OK\n"); } else { printf("FAILED\n"); goto close; } rc = modbus_read_input_bits(ctx, UT_INPUT_BITS_ADDRESS, MODBUS_MAX_READ_BITS + 1, tab_rp_bits); printf("* modbus_read_input_bits: "); if (rc == -1 && errno == EMBMDATA) { printf("OK\n"); } else { printf("FAILED\n"); goto close; } rc = modbus_read_registers(ctx, UT_REGISTERS_ADDRESS, MODBUS_MAX_READ_REGISTERS + 1, tab_rp_registers); printf("* modbus_read_registers: "); if (rc == -1 && errno == EMBMDATA) { printf("OK\n"); } else { printf("FAILED\n"); goto close; } rc = modbus_read_input_registers(ctx, UT_INPUT_REGISTERS_ADDRESS, MODBUS_MAX_READ_REGISTERS + 1, tab_rp_registers); printf("* modbus_read_input_registers: "); if (rc == -1 && errno == EMBMDATA) { printf("OK\n"); } else { printf("FAILED\n"); goto close; } rc = modbus_write_bits(ctx, UT_BITS_ADDRESS, MODBUS_MAX_WRITE_BITS + 1, tab_rp_bits); printf("* modbus_write_bits: "); if (rc == -1 && errno == EMBMDATA) { printf("OK\n"); } else { goto close; printf("FAILED\n"); } rc = modbus_write_registers(ctx, UT_REGISTERS_ADDRESS, MODBUS_MAX_WRITE_REGISTERS + 1, tab_rp_registers); printf("* modbus_write_registers: "); if (rc == -1 && errno == EMBMDATA) { printf("OK\n"); } else { printf("FAILED\n"); goto close; } /** SLAVE REPLY **/ printf("\nTEST SLAVE REPLY:\n"); modbus_set_slave(ctx, INVALID_SERVER_ID); rc = modbus_read_registers(ctx, UT_REGISTERS_ADDRESS, UT_REGISTERS_NB, tab_rp_registers); if (use_backend == RTU) { const int RAW_REQ_LENGTH = 6; uint8_t raw_req[] = { INVALID_SERVER_ID, 0x03, 0x00, 0x01, 0xFF, 0xFF }; uint8_t rsp[MODBUS_TCP_MAX_ADU_LENGTH]; /* No response in RTU mode */ printf("1/4-A No response from slave %d: ", INVALID_SERVER_ID); if (rc == -1 && errno == ETIMEDOUT) { printf("OK\n"); } else { printf("FAILED\n"); goto close; } /* Send an invalid query with a wrong slave ID */ modbus_send_raw_request(ctx, raw_req, RAW_REQ_LENGTH * sizeof(uint8_t)); rc = modbus_receive_confirmation(ctx, rsp); printf("1/4-B No response from slave %d with invalid request: ", INVALID_SERVER_ID); if (rc == -1 && errno == ETIMEDOUT) { printf("OK\n"); } else { printf("FAILED (%d)\n", rc); goto close; } } else { /* Response in TCP mode */ printf("1/4 Response from slave %d: ", 18); if (rc == UT_REGISTERS_NB) { printf("OK\n"); } else { printf("FAILED\n"); goto close; } } rc = modbus_set_slave(ctx, MODBUS_BROADCAST_ADDRESS); if (rc == -1) { printf("Invalid broacast address\n"); goto close; } rc = modbus_read_registers(ctx, UT_REGISTERS_ADDRESS, UT_REGISTERS_NB, tab_rp_registers); printf("2/4 Reply after a broadcast query: "); if (rc == UT_REGISTERS_NB) { printf("OK\n"); } else { printf("FAILED\n"); goto close; } /* Restore slave */ if (use_backend == RTU) { modbus_set_slave(ctx, SERVER_ID); } else { modbus_set_slave(ctx, MODBUS_TCP_SLAVE); } printf("3/4 Report slave ID: \n"); /* tab_rp_bits is used to store bytes */ rc = modbus_report_slave_id(ctx, tab_rp_bits); if (rc == -1) { printf("FAILED\n"); goto close; } /* Slave ID is an arbitraty number for libmodbus */ if (rc > 0) { printf("OK Slave ID is %d\n", tab_rp_bits[0]); } else { printf("FAILED\n"); goto close; } /* Run status indicator */ if (rc > 1 && tab_rp_bits[1] == 0xFF) { printf("OK Run Status Indicator is %s\n", tab_rp_bits[1] ? "ON" : "OFF"); } else { printf("FAILED\n"); goto close; } /* Print additional data as string */ if (rc > 2) { printf("Additional data: "); for (i=2; i < rc; i++) { printf("%c", tab_rp_bits[i]); } printf("\n"); } /* Save original timeout */ modbus_get_response_timeout(ctx, &old_response_timeout); /* Define a new and too short timeout */ response_timeout.tv_sec = 0; response_timeout.tv_usec = 0; modbus_set_response_timeout(ctx, &response_timeout); rc = modbus_read_registers(ctx, UT_REGISTERS_ADDRESS, UT_REGISTERS_NB, tab_rp_registers); printf("4/4 Too short timeout: "); if (rc == -1 && errno == ETIMEDOUT) { printf("OK\n"); } else { printf("FAILED (can fail on slow systems or Windows)\n"); } /* Restore original timeout */ modbus_set_response_timeout(ctx, &old_response_timeout); /* A wait and flush operation is done by the error recovery code of * libmodbus */ /** BAD RESPONSE **/ printf("\nTEST BAD RESPONSE ERROR:\n"); /* Allocate only the required space */ tab_rp_registers_bad = (uint16_t *) malloc( UT_REGISTERS_NB_SPECIAL * sizeof(uint16_t)); rc = modbus_read_registers(ctx, UT_REGISTERS_ADDRESS, UT_REGISTERS_NB_SPECIAL, tab_rp_registers_bad); printf("* modbus_read_registers: "); if (rc == -1 && errno == EMBBADDATA) { printf("OK\n"); } else { printf("FAILED\n"); goto close; } free(tab_rp_registers_bad); /** MANUAL EXCEPTION **/ printf("\nTEST MANUAL EXCEPTION:\n"); rc = modbus_read_registers(ctx, UT_REGISTERS_ADDRESS_SPECIAL, UT_REGISTERS_NB, tab_rp_registers); printf("* modbus_read_registers at special address: "); if (rc == -1 && errno == EMBXSBUSY) { printf("OK\n"); } else { printf("FAILED\n"); goto close; } /** RAW REQUEST */ printf("\nTEST RAW REQUEST:\n"); { const int RAW_REQ_LENGTH = 6; uint8_t raw_req[] = { (use_backend == RTU) ? SERVER_ID : 0xFF, 0x03, 0x00, 0x01, 0x0, 0x05 }; int req_length; uint8_t rsp[MODBUS_TCP_MAX_ADU_LENGTH]; req_length = modbus_send_raw_request(ctx, raw_req, RAW_REQ_LENGTH * sizeof(uint8_t)); printf("* modbus_send_raw_request: "); if ((use_backend == RTU && req_length == (RAW_REQ_LENGTH + 2)) || ((use_backend == TCP || use_backend == TCP_PI) && req_length == (RAW_REQ_LENGTH + 6))) { printf("OK\n"); } else { printf("FAILED (%d)\n", req_length); goto close; } printf("* modbus_receive_confirmation: "); rc = modbus_receive_confirmation(ctx, rsp); if ((use_backend == RTU && rc == 15) || ((use_backend == TCP || use_backend == TCP_PI) && rc == 19)) { printf("OK\n"); } else { printf("FAILED (%d)\n", rc); goto close; } } printf("\nALL TESTS PASS WITH SUCCESS.\n"); close: /* Free the memory */ free(tab_rp_bits); free(tab_rp_registers); /* Close the connection */ modbus_close(ctx); modbus_free(ctx); return 0; } libmodbus-3.0.5/tests/unit-test-server.c000066400000000000000000000112711222457407600202600ustar00rootroot00000000000000/* * Copyright © 2008-2010 Stéphane Raimbault * * This program is free software: you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by * the Free Software Foundation; either version 3 of the License, or * (at your option) any later version. * * This program is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. * * You should have received a copy of the GNU General Public License * along with this program. If not, see . */ #include #include #include #include #include #include #include "unit-test.h" enum { TCP, TCP_PI, RTU }; int main(int argc, char*argv[]) { int socket; modbus_t *ctx; modbus_mapping_t *mb_mapping; int rc; int i; int use_backend; uint8_t *query; int header_length; if (argc > 1) { if (strcmp(argv[1], "tcp") == 0) { use_backend = TCP; } else if (strcmp(argv[1], "tcppi") == 0) { use_backend = TCP_PI; } else if (strcmp(argv[1], "rtu") == 0) { use_backend = RTU; } else { printf("Usage:\n %s [tcp|tcppi|rtu] - Modbus server for unit testing\n\n", argv[0]); return -1; } } else { /* By default */ use_backend = TCP; } if (use_backend == TCP) { ctx = modbus_new_tcp("127.0.0.1", 1502); query = malloc(MODBUS_TCP_MAX_ADU_LENGTH); } else if (use_backend == TCP_PI) { ctx = modbus_new_tcp_pi("::0", "1502"); query = malloc(MODBUS_TCP_MAX_ADU_LENGTH); } else { ctx = modbus_new_rtu("/dev/ttyUSB0", 115200, 'N', 8, 1); modbus_set_slave(ctx, SERVER_ID); query = malloc(MODBUS_RTU_MAX_ADU_LENGTH); } header_length = modbus_get_header_length(ctx); modbus_set_debug(ctx, TRUE); mb_mapping = modbus_mapping_new( UT_BITS_ADDRESS + UT_BITS_NB, UT_INPUT_BITS_ADDRESS + UT_INPUT_BITS_NB, UT_REGISTERS_ADDRESS + UT_REGISTERS_NB, UT_INPUT_REGISTERS_ADDRESS + UT_INPUT_REGISTERS_NB); if (mb_mapping == NULL) { fprintf(stderr, "Failed to allocate the mapping: %s\n", modbus_strerror(errno)); modbus_free(ctx); return -1; } /* Examples from PI_MODBUS_300.pdf. Only the read-only input values are assigned. */ /** INPUT STATUS **/ modbus_set_bits_from_bytes(mb_mapping->tab_input_bits, UT_INPUT_BITS_ADDRESS, UT_INPUT_BITS_NB, UT_INPUT_BITS_TAB); /** INPUT REGISTERS **/ for (i=0; i < UT_INPUT_REGISTERS_NB; i++) { mb_mapping->tab_input_registers[UT_INPUT_REGISTERS_ADDRESS+i] = UT_INPUT_REGISTERS_TAB[i];; } if (use_backend == TCP) { socket = modbus_tcp_listen(ctx, 1); modbus_tcp_accept(ctx, &socket); } else if (use_backend == TCP_PI) { socket = modbus_tcp_pi_listen(ctx, 1); modbus_tcp_pi_accept(ctx, &socket); } else { rc = modbus_connect(ctx); if (rc == -1) { fprintf(stderr, "Unable to connect %s\n", modbus_strerror(errno)); modbus_free(ctx); return -1; } } for (;;) { rc = modbus_receive(ctx, query); if (rc == -1) { /* Connection closed by the client or error */ break; } /* Read holding registers */ if (query[header_length] == 0x03) { if (MODBUS_GET_INT16_FROM_INT8(query, header_length + 3) == UT_REGISTERS_NB_SPECIAL) { printf("Set an incorrect number of values\n"); MODBUS_SET_INT16_TO_INT8(query, header_length + 3, UT_REGISTERS_NB_SPECIAL - 1); } else if (MODBUS_GET_INT16_FROM_INT8(query, header_length + 1) == UT_REGISTERS_ADDRESS_SPECIAL) { printf("Reply to this special register address by an exception\n"); modbus_reply_exception(ctx, query, MODBUS_EXCEPTION_SLAVE_OR_SERVER_BUSY); continue; } } rc = modbus_reply(ctx, query, rc, mb_mapping); if (rc == -1) { break; } } printf("Quit the loop: %s\n", modbus_strerror(errno)); if (use_backend == TCP) { close(socket); } modbus_mapping_free(mb_mapping); free(query); modbus_free(ctx); return 0; } libmodbus-3.0.5/tests/unit-test.h.in000066400000000000000000000041211222457407600173620ustar00rootroot00000000000000/* * Copyright © 2008-2011 Stéphane Raimbault * * This program is free software: you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by * the Free Software Foundation; either version 3 of the License, or * (at your option) any later version. * * This program is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. * * You should have received a copy of the GNU General Public License * along with this program. If not, see . */ #ifndef _UNIT_TEST_H_ #define _UNIT_TEST_H_ /* Constants defined by configure.ac */ #define HAVE_INTTYPES_H @HAVE_INTTYPES_H@ #define HAVE_STDINT_H @HAVE_STDINT_H@ #ifdef HAVE_INTTYPES_H #include #endif #ifdef HAVE_STDINT_H # ifndef _MSC_VER # include # else # include "stdint.h" # endif #endif #define SERVER_ID 17 #define INVALID_SERVER_ID 18 const uint16_t UT_BITS_ADDRESS = 0x13; const uint16_t UT_BITS_NB = 0x25; const uint8_t UT_BITS_TAB[] = { 0xCD, 0x6B, 0xB2, 0x0E, 0x1B }; const uint16_t UT_INPUT_BITS_ADDRESS = 0xC4; const uint16_t UT_INPUT_BITS_NB = 0x16; const uint8_t UT_INPUT_BITS_TAB[] = { 0xAC, 0xDB, 0x35 }; const uint16_t UT_REGISTERS_ADDRESS = 0x6B; /* Raise a manual exception when this adress is used for the first byte */ const uint16_t UT_REGISTERS_ADDRESS_SPECIAL = 0x6C; const uint16_t UT_REGISTERS_NB = 0x3; const uint16_t UT_REGISTERS_TAB[] = { 0x022B, 0x0001, 0x0064 }; /* If the following value is used, a bad response is sent. It's better to test with a lower value than UT_REGISTERS_NB_POINTS to try to raise a segfault. */ const uint16_t UT_REGISTERS_NB_SPECIAL = 0x2; const uint16_t UT_INPUT_REGISTERS_ADDRESS = 0x08; const uint16_t UT_INPUT_REGISTERS_NB = 0x1; const uint16_t UT_INPUT_REGISTERS_TAB[] = { 0x000A }; const float UT_REAL = 916.540649; const uint32_t UT_IREAL = 0x4465229a; #endif /* _UNIT_TEST_H_ */ libmodbus-3.0.5/tests/version.c000066400000000000000000000023571222457407600165120ustar00rootroot00000000000000/* * Copyright © 2010 Stéphane Raimbault * * This program is free software: you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by * the Free Software Foundation; either version 3 of the License, or * (at your option) any later version. * * This program is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. * * You should have received a copy of the GNU General Public License * along with this program. If not, see . */ #include #include int main(void) { printf("Compiled with libmodbus version %s\n", LIBMODBUS_VERSION_STRING); printf("Linked with libmodbus version %d.%d.%d\n", libmodbus_version_major, libmodbus_version_minor, libmodbus_version_micro); if (LIBMODBUS_VERSION_CHECK(2, 1, 0)) { printf("The functions to read/write float values are available (2.1.0).\n"); } if (LIBMODBUS_VERSION_CHECK(2, 1, 1)) { printf("Oh gosh, brand new API (2.1.1)!\n"); } return 0; }