diff --git a/.codespellrc b/.codespellrc new file mode 100644 index 0000000..0281148 --- /dev/null +++ b/.codespellrc @@ -0,0 +1,7 @@ +# See: https://github.com/codespell-project/codespell#using-a-config-file +[codespell] +# In the event of a false positive, add the problematic word, in all lowercase, to a comma-separated list here: +ignore-words-list = , +check-filenames = +check-hidden = +skip = ./.git,./src/libmodbus diff --git a/.github/dependabot.yml b/.github/dependabot.yml new file mode 100644 index 0000000..fa738ec --- /dev/null +++ b/.github/dependabot.yml @@ -0,0 +1,12 @@ +# See: https://docs.github.com/en/github/administering-a-repository/configuration-options-for-dependency-updates#about-the-dependabotyml-file +version: 2 + +updates: + # Configure check for outdated GitHub Actions actions in workflows. + # See: https://docs.github.com/en/github/administering-a-repository/keeping-your-actions-up-to-date-with-dependabot + - package-ecosystem: github-actions + directory: / # Check the repository's workflows under /.github/workflows/ + schedule: + interval: daily + labels: + - "topic: infrastructure" diff --git a/.github/workflows/check-arduino.yml b/.github/workflows/check-arduino.yml new file mode 100644 index 0000000..e818685 --- /dev/null +++ b/.github/workflows/check-arduino.yml @@ -0,0 +1,28 @@ +name: Check Arduino + +# See: https://docs.github.com/en/free-pro-team@latest/actions/reference/events-that-trigger-workflows +on: + push: + pull_request: + schedule: + # Run every Tuesday at 8 AM UTC to catch breakage caused by new rules added to Arduino Lint. + - cron: "0 8 * * TUE" + workflow_dispatch: + repository_dispatch: + +jobs: + lint: + runs-on: ubuntu-latest + + steps: + - name: Checkout repository + uses: actions/checkout@v4 + + - name: Arduino Lint + uses: arduino/arduino-lint-action@v2 + with: + compliance: specification + library-manager: update + # Always use this setting for official repositories. Remove for 3rd party projects. + official: true + project-type: library diff --git a/.github/workflows/compile-examples.yml b/.github/workflows/compile-examples.yml new file mode 100644 index 0000000..aae4de7 --- /dev/null +++ b/.github/workflows/compile-examples.yml @@ -0,0 +1,119 @@ +name: Compile Examples + +on: + pull_request: + paths: + - ".github/workflows/compile-examples.yml" + - "library.properties" + - "examples/**" + - "src/**" + push: + paths: + - ".github/workflows/compile-examples.yml" + - "library.properties" + - "examples/**" + - "src/**" + schedule: + # run every Tuesday at 3 AM UTC to catch breakage caused by changes to external dependencies (libraries, platforms) + - cron: "0 3 * * 2" + # See: https://docs.github.com/en/free-pro-team@latest/actions/reference/events-that-trigger-workflows#workflow_dispatch + workflow_dispatch: + +jobs: + build: + name: ${{ matrix.board.fqbn }} + runs-on: ubuntu-latest + + env: + SKETCHES_REPORTS_PATH: sketches-reports + # Libraries to install for all boards + UNIVERSAL_LIBRARIES: | + # Install the ArduinoModbus library from the local path + - source-path: ./ + - name: ArduinoRS485 + UNIVERSAL_SKETCH_PATHS: | + - examples/RTU + + strategy: + fail-fast: false + + matrix: + board: + - fqbn: arduino:megaavr:uno2018:mode=off + ethernet: true + nina: true + artifact-name-suffix: arduino-megaavr-uno2018 + - fqbn: arduino:samd:mkrwifi1010 + ethernet: true + nina: true + artifact-name-suffix: arduino-samd-mkrwifi1010 + - fqbn: arduino:mbed_nano:nano33ble + ethernet: false + nina: false + artifact-name-suffix: arduino-mbed_nano-nano33ble + - fqbn: arduino:mbed_portenta:envie_m7 + ethernet: false + nina: false + artifact-name-suffix: arduino-mbed_portenta-envie_m7 + - fqbn: arduino:mbed_opta:opta + ethernet: true + nina: false + artifact-name-suffix: arduino-mbed_opta-opta + + # Make board type-specific customizations to the matrix jobs + include: + - board: + # Boards with Ethernet library support + ethernet: true + # Install these libraries in addition to the ones defined by env.UNIVERSAL_LIBRARIES + ethernet-libraries: | + - name: Ethernet + # Compile these sketches in addition to the ones defined by env.UNIVERSAL_SKETCH_PATHS + ethernet-sketch-paths: | + - examples/TCP/EthernetModbusClientToggle + - examples/TCP/EthernetModbusServerLED + - board: + ethernet: false + ethernet-libraries: "" + ethernet-sketch-paths: "" + - board: + # Boards with NINA-W102 module + nina: true + # Install these libraries in addition to the ones defined by env.UNIVERSAL_LIBRARIES + nina-libraries: | + - name: WiFiNINA + # Compile these sketches in addition to the ones defined by env.UNIVERSAL_SKETCH_PATHS + nina-sketch-paths: | + - examples/TCP/WiFiModbusClientToggle + - examples/TCP/WiFiModbusServerLED + - board: + nina: false + nina-libraries: "" + nina-sketch-paths: "" + + steps: + - name: Checkout + uses: actions/checkout@v4 + + - name: Compile examples + uses: arduino/compile-sketches@v1 + with: + github-token: ${{ secrets.GITHUB_TOKEN }} + fqbn: ${{ matrix.board.fqbn }} + libraries: | + ${{ env.UNIVERSAL_LIBRARIES }} + ${{ matrix.ethernet-libraries }} + ${{ matrix.nina-libraries }} + sketch-paths: | + ${{ env.UNIVERSAL_SKETCH_PATHS }} + ${{ matrix.ethernet-sketch-paths }} + ${{ matrix.nina-sketch-paths }} + enable-deltas-report: true + sketches-report-path: ${{ env.SKETCHES_REPORTS_PATH }} + + - name: Save memory usage change report as artifact + uses: actions/upload-artifact@v4 + with: + if-no-files-found: error + name: sketches-report-${{ matrix.board.artifact-name-suffix }} + path: ${{ env.SKETCHES_REPORTS_PATH }} diff --git a/.github/workflows/report-size-deltas.yml b/.github/workflows/report-size-deltas.yml new file mode 100644 index 0000000..067c504 --- /dev/null +++ b/.github/workflows/report-size-deltas.yml @@ -0,0 +1,18 @@ +name: Report Size Deltas + +on: + schedule: + - cron: "*/5 * * * *" + # See: https://docs.github.com/en/free-pro-team@latest/actions/reference/events-that-trigger-workflows#workflow_dispatch + workflow_dispatch: + +jobs: + report: + runs-on: ubuntu-latest + + steps: + - name: Comment size deltas reports to PRs + uses: arduino/report-size-deltas@v1 + with: + # Regex matching the names of the workflow artifacts created by the "Compile Examples" workflow + sketches-reports-source: ^sketches-report-.+ diff --git a/.github/workflows/spell-check.yml b/.github/workflows/spell-check.yml new file mode 100644 index 0000000..3ce6a08 --- /dev/null +++ b/.github/workflows/spell-check.yml @@ -0,0 +1,22 @@ +name: Spell Check + +on: + pull_request: + push: + schedule: + # run every Tuesday at 3 AM UTC + - cron: "0 3 * * 2" + workflow_dispatch: + repository_dispatch: + +jobs: + spellcheck: + runs-on: ubuntu-latest + + steps: + - name: Checkout + uses: actions/checkout@v4 + + # See: https://github.com/codespell-project/actions-codespell/blob/master/README.md + - name: Spell check + uses: codespell-project/actions-codespell@master diff --git a/.github/workflows/sync-labels.yml b/.github/workflows/sync-labels.yml new file mode 100644 index 0000000..53a9f54 --- /dev/null +++ b/.github/workflows/sync-labels.yml @@ -0,0 +1,138 @@ +# Source: https://github.com/arduino/tooling-project-assets/blob/main/workflow-templates/sync-labels.md +name: Sync Labels + +# See: https://docs.github.com/en/actions/reference/events-that-trigger-workflows +on: + push: + paths: + - ".github/workflows/sync-labels.ya?ml" + - ".github/label-configuration-files/*.ya?ml" + pull_request: + paths: + - ".github/workflows/sync-labels.ya?ml" + - ".github/label-configuration-files/*.ya?ml" + schedule: + # Run daily at 8 AM UTC to sync with changes to shared label configurations. + - cron: "0 8 * * *" + workflow_dispatch: + repository_dispatch: + +env: + CONFIGURATIONS_FOLDER: .github/label-configuration-files + CONFIGURATIONS_ARTIFACT: label-configuration-files + +jobs: + check: + runs-on: ubuntu-latest + + steps: + - name: Checkout repository + uses: actions/checkout@v4 + + - name: Download JSON schema for labels configuration file + id: download-schema + uses: carlosperate/download-file-action@v2 + with: + file-url: https://raw.githubusercontent.com/arduino/tooling-project-assets/main/workflow-templates/assets/sync-labels/arduino-tooling-gh-label-configuration-schema.json + location: ${{ runner.temp }}/label-configuration-schema + + - name: Install JSON schema validator + run: | + sudo npm install \ + --global \ + ajv-cli \ + ajv-formats + + - name: Validate local labels configuration + run: | + # See: https://github.com/ajv-validator/ajv-cli#readme + ajv validate \ + --all-errors \ + -c ajv-formats \ + -s "${{ steps.download-schema.outputs.file-path }}" \ + -d "${{ env.CONFIGURATIONS_FOLDER }}/*.{yml,yaml}" + + download: + needs: check + runs-on: ubuntu-latest + + strategy: + matrix: + filename: + # Filenames of the shared configurations to apply to the repository in addition to the local configuration. + # https://github.com/arduino/tooling-project-assets/blob/main/workflow-templates/assets/sync-labels + - universal.yml + + steps: + - name: Download + uses: carlosperate/download-file-action@v2 + with: + file-url: https://raw.githubusercontent.com/arduino/tooling-project-assets/main/workflow-templates/assets/sync-labels/${{ matrix.filename }} + + - name: Pass configuration files to next job via workflow artifact + uses: actions/upload-artifact@v4 + with: + path: | + *.yaml + *.yml + if-no-files-found: error + name: ${{ env.CONFIGURATIONS_ARTIFACT }} + + sync: + needs: download + runs-on: ubuntu-latest + + steps: + - name: Set environment variables + run: | + # See: https://docs.github.com/en/actions/reference/workflow-commands-for-github-actions#setting-an-environment-variable + echo "MERGED_CONFIGURATION_PATH=${{ runner.temp }}/labels.yml" >> "$GITHUB_ENV" + + - name: Determine whether to dry run + id: dry-run + if: > + github.event_name == 'pull_request' || + ( + ( + github.event_name == 'push' || + github.event_name == 'workflow_dispatch' + ) && + github.ref != format('refs/heads/{0}', github.event.repository.default_branch) + ) + run: | + # Use of this flag in the github-label-sync command will cause it to only check the validity of the + # configuration. + echo "::set-output name=flag::--dry-run" + + - name: Checkout repository + uses: actions/checkout@v4 + + - name: Download configuration files artifact + uses: actions/download-artifact@v4 + with: + name: ${{ env.CONFIGURATIONS_ARTIFACT }} + path: ${{ env.CONFIGURATIONS_FOLDER }} + + - name: Remove unneeded artifact + uses: geekyeggo/delete-artifact@v5 + with: + name: ${{ env.CONFIGURATIONS_ARTIFACT }} + + - name: Merge label configuration files + run: | + # Merge all configuration files + shopt -s extglob + cat "${{ env.CONFIGURATIONS_FOLDER }}"/*.@(yml|yaml) > "${{ env.MERGED_CONFIGURATION_PATH }}" + + - name: Install github-label-sync + run: sudo npm install --global github-label-sync + + - name: Sync labels + env: + GITHUB_ACCESS_TOKEN: ${{ secrets.GITHUB_TOKEN }} + run: | + # See: https://github.com/Financial-Times/github-label-sync + github-label-sync \ + --labels "${{ env.MERGED_CONFIGURATION_PATH }}" \ + ${{ steps.dry-run.outputs.flag }} \ + ${{ github.repository }} diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..9f11b75 --- /dev/null +++ b/.gitignore @@ -0,0 +1 @@ +.idea/ diff --git a/LICENSE.txt b/LICENSE.txt new file mode 100644 index 0000000..8000a6f --- /dev/null +++ b/LICENSE.txt @@ -0,0 +1,504 @@ + 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! diff --git a/README.adoc b/README.adoc index 79fab17..7221642 100644 --- a/README.adoc +++ b/README.adoc @@ -1,5 +1,13 @@ +// Define the repository information in these attributes +:repository-owner: arduino-libraries +:repository-name: ArduinoModbus + = Modbus Library for Arduino = +image:https://github.com/{repository-owner}/{repository-name}/actions/workflows/check-arduino.yml/badge.svg["Check Arduino status", link="https://github.com/%7Brepository-owner%7D/%7Brepository-name%7D/actions/workflows/check-arduino.yml"] +image:https://github.com/{repository-owner}/{repository-name}/actions/workflows/compile-examples.yml/badge.svg["Compile Examples status", link="https://github.com/%7Brepository-owner%7D/%7Brepository-name%7D/actions/workflows/compile-examples.yml"] +image:https://github.com/{repository-owner}/{repository-name}/actions/workflows/spell-check.yml/badge.svg["Spell Check status", link="https://github.com/%7Brepository-owner%7D/%7Brepository-name%7D/actions/workflows/spell-check.yml"] + Use http://www.modbus.org/[Modbus] with your Arduino. Using TCP or RS485 shields, like the MKR 485 Shield. This library depends on the ArduinoRS485 library. diff --git a/docs/api.md b/docs/api.md new file mode 100644 index 0000000..5610cf9 --- /dev/null +++ b/docs/api.md @@ -0,0 +1,842 @@ +# Arduino Modbus Library + +## Modbus Client + +### `client.coilRead()` + +#### Description + +Perform a "Read Coils" operation for the specified address for a single coil. + +#### Syntax + +``` +int coilRead(int address); +int coilRead(int id, int address); +``` + +#### Parameters +- id (slave) - id of target, defaults to 0x00 if not specified +- address address to use for operation + + +#### Returns +coil value on success, -1 on failure. + +### `client.discreteInputRead()` + +#### Description + +Perform a "Read Discrete Inputs" operation for the specified address for a single discrete input. + +#### Syntax + +``` +int discreteInputRead(int address); +int discreteInputRead(int id, int address); +``` + +#### Parameters +- id (slave) - id of target, defaults to 0x00 if not specified +- address address to use for operation + + +#### Returns +discrete input value on success, -1 on failure. + +### `client.holdingRegisterRead()` + +#### Description + +Perform a "Read Holding Registers" operation for a single holding register. + +#### Syntax + +``` +long holdingRegisterRead(int address); +long holdingRegisterRead(int id, int address); +``` + +#### Parameters + +- id (slave) - id of target, defaults to 0x00 if not specified +- address start address to use for operation +- holding register value on success, -1 on failure. + +### `client.inputRegisterRead()` + +#### Description + +Perform a "Read Input Registers" operation for a single input register. + +#### Syntax + +``` +long inputRegisterRead(int address); +long inputRegisterRead(int id, int address); +``` + +#### Parameters +- id (slave) - id of target, defaults to 0x00 if not specified +- address address to use for operation + + +#### Returns +input register value on success, -1 on failure. + +### `client.coilWrite()` + +#### Description + +Perform a "Write Single Coil" operation for the specified address and value. + +#### Syntax + +``` +int coilWrite(int address, uint8_t value); +int coilWrite(int id, int address, uint8_t value); +``` + +#### Parameters +- id (slave) - id of target, defaults to 0x00 if not specified +- address address to use for operation +- value coi -l value to write + + +#### Returns +1 on success, 0 on failure. + +### `client.holdingRegisterWrite()` + +#### Description + +Perform a "Write Single Holding Register" operation for the specified address and value. + +#### Syntax + +``` +int holdingRegisterWrite(int address, uint16_t value); +int holdingRegisterWrite(int id, int address, uint16_t value); +``` + +#### Parameters +- id (slave) - id of target, defaults to 0x00 if not specified +- address address to use for operation +- value - holding register value to write + + +#### Returns +1 on success, 0 on failure. + +### `client.registerMaskWrite()` + +#### Description + +Perform a "Mask Write Registers" operation for the specified address, AND mask and OR mask. + +#### Syntax + +``` +int registerMaskWrite(int address, uint16_t andMask, uint16_t orMask); +int registerMaskWrite(int id, int address, uint16_t andMask, uint16_t orMask); +``` + +#### Parameters +- id (slave) - id of target, defaults to 0x00 if not specified +- address address to use for operation +- andMask - AND mask to use for operation +- orMask - OR mask to use for operation + + +#### Returns +1 on success, 0 on failure. + +### `client.beginTransmission()` + +#### Description + +Begin the process of a writing multiple coils or holding registers. +Use write(value) to set the values you want to send, and endTransmission() to send request on the wire. + +#### Syntax + +``` +int beginTransmission(int type, int address, int nb); +int beginTransmission(int id, int type, int address, int nb); +``` + +#### Parameters +- id (slave) - id of target, defaults to 0x00 if not specified +- type - type of write to perform, either + - COILS (FC 0x01) + - HOLDING_REGISTERS (FC 0x03) +- address start address to use for operation +- nb - number of values to write + +#### Returns +1 on success, 0 on failure + +### `client.write()` + +#### Description + +Set the values of a write operation started by beginTransmission(...). + +#### Syntax + +``` +int write(unsigned int value); +``` + +#### Parameters +- value - value to write + + +#### Returns +1 on success, 0 on failure + +### `client.endTransmission()` + +#### Description + +End the process of a writing multiple coils or holding registers. + +#### Syntax + +``` +int endTransmission(); +``` + +#### Parameters +none + + +#### Returns +1 on success, 0 on failure + +### `client.requestFrom()` + +#### Description + +Read multiple coils, discrete inputs, holding registers, or input register values. +Use available() and read() to process the read values. + +#### Syntax + +``` +int requestFrom(int type, int address, int nb); +int requestFrom(int id, int type, int address,int nb); +``` + +#### Parameters +- id (slave) - id of target, defaults to 0x00 if not specified +- type - type of read to perform, either + - COILS (FC 0x01) + - DISCRETE_INPUTS (FC 0x02) + - HOLDING_REGISTERS (FC 0x03) + - INPUT_REGISTERS (FC 0x04) +- address start address to use for operation +- nb - number of values to read + + +#### Returns +0 on failure, number of values read on success + +### `client.available()` + +#### Description + +Query the number of values available to read after calling requestFrom(...) + +#### Syntax + +``` +int available(); +``` + +#### Parameters +none + + +#### Returns +number of values available for reading use read() + +### `client.read()` + +#### Description + +Read a value after calling requestFrom(...) + +#### Syntax + +``` +long read(); +``` + +#### Parameters +None + + +#### Returns +-1 on failure, value on success + +### `client.lastError()` + +#### Description + +Read the last error reason as a string + +#### Syntax + +``` +const char* lastError(); +``` + +#### Parameters +none + + +#### Returns +Last error reason as a C string + +### `client.end()` + +#### Description + +Stop the client and clean up + +#### Syntax + +``` +void end(); +``` + +#### Parameters +None + + +#### Returns +nothing + +## ModbusRTUClient Class + +### `modbusRTUClient.begin()` + +#### Description + +Start the Modbus RTU client with the specified parameters. + +#### Syntax + +``` +ModbusRTUClient.begin(baudrate); +ModbusRTUClient.begin(baudrate, config); +``` + +#### Parameters +- baudrate - Baud rate to use for serial +- config - Config to use for serial (see Serial.begin(...) for more info.) defaults to SERIAL_8N1 if not provided + + +#### Returns +1 on success, 0 on failure + +## ModbusTCPClient Class + +### `ModbusTCPClient()` + +#### Description + +Creates a Modbus TCP client using the provided Client for the transport. + +#### Syntax + +``` +ModbusTCPClient(client); +``` + +#### Parameters +- Client - to use for the transport + +### `modbusTCPClient.begin()` + +#### Description + +Start the Modbus TCP client with the specified parameters. + +#### Syntax + +``` +modbusTCPClient.begin(ip, port); +``` + +#### Parameters +- ip - the IP Address the client will connect to +- port - port to the client will connect to + + +#### Returns +1 on success, 0 on failure + +### `modbusTCPClient.connected()` + +#### Description + +Returns the connection status. + +#### Syntax + +``` +modbusTCPClient.connected(); +``` + +#### Parameters +None + + +#### Returns +Returns true if the client is connected, false if not. + +### `modbusTCPClient.stop()` + +#### Description + +Disconnect from the server. + +#### Syntax + +``` +modbusTCPClient.stop(); +``` + +#### Parameters +None + + +#### Returns +Nothing + +## ModbusServer Class + +### `modbusServer.configureCoils()` + +#### Description + +Configure the servers coils. + +#### Syntax + +``` +int configureCoils(int startAddress, int nb); +``` + +#### Parameters +- startAddress - start address of coils +- nb - number of coils to configure + + +#### Returns +0 on success, 1 on failure + +### `modbusServer.configureDiscreteInputs()` + +#### Description + +Configure the servers discrete inputs. + +#### Syntax + +``` +int configureDiscreteInputs(int startAddress, int nb); +``` + +#### Parameters +- startAddress - start address of discrete inputs +- nb - number of discrete inputs to configure + + +#### Returns +0 on success, 1 on failure + +### `modbusServer.configureHoldingRegisters()` + +#### Description + +Configure the servers holding registers. + +#### Syntax + +``` +int configureHoldingRegisters(int startAddress, int nb); +``` + +#### Parameters +- startAddress - start address of holding registers +- nb - number of holding registers to configure + + +#### Returns +0 on success, 1 on failure + +### `modbusServer.configureInputRegisters()` + +#### Description + +Configure the servers input registers. + +#### Syntax + +``` +int configureInputRegisters(int startAddress, int nb); +``` + +#### Parameters +- startAddress - start address of input registers +- nb - number of input registers to configure + + +#### Returns +0 on success, 1 on failure + +### `modbusServer.coilRead()` + +#### Description + +Perform a "Read Coils" operation for the specified address for a single coil. + +#### Syntax + +``` +int coilRead(int address); +int coilRead(int id, int address); +``` + +#### Parameters +- id (slave) - id of target, defaults to 0x00 if not specified +- address address to use for operation + + +#### Returns +coil value on success, -1 on failure. + +### `modbusServer.discreteInputRead()` + +#### Description + +Perform a "Read Discrete Inputs" operation for the specified address for a single discrete input. + +#### Syntax + +``` +int discreteInputRead(int address); +int discreteInputRead(int id, int address); +``` + +#### Parameters +- id (slave) - id of target, defaults to 0x00 if not specified +- address address to use for operation + + +#### Returns +discrete input value on success, -1 on failure. + +### `modbusServer.holdingRegisterRead()` + +#### Description + +Perform a "Read Holding Registers" operation for a single holding register. + +#### Syntax + +``` +long holdingRegisterRead(int address); +long holdingRegisterRead(int id, int address); +``` + +#### Parameters +- id (slave) - id of target, defaults to 0x00 if not specified +- address start address to use for operation +- holding register value on success, -1 on failure. + +### `modbusServer.inputRegisterRead()` + +#### Description + +Perform a "Read Input Registers" operation for a single input register. + +#### Syntax + +``` +long inputRegisterRead(int address); +long inputRegisterRead(int id, int address); +``` + +#### Parameters +- id (slave) - id of target, defaults to 0x00 if not specified +- address address to use for operation + + +#### Returns +input register value on success, -1 on failure. + +### `modbusServer.coilWrite()` + +#### Description + +Perform a "Write Single Coil" operation for the specified address and value. + +#### Syntax + +``` +int coilWrite(int address, uint8_t value); +int coilWrite(int id, int address, uint8_t value); +``` + +#### Parameters +- id (slave) - id of target, defaults to 0x00 if not specified +- address address to use for operation +- value coi -l value to write + + +#### Returns +1 on success, 0 on failure. + +### `modbusServer.holdingRegisterWrite()` + +#### Description + +Perform a "Write Single Holding Register" operation for the specified address and value. + +#### Syntax + +``` +int holdingRegisterWrite(int address, uint16_t value); +int holdingRegisterWrite(int id, int address, uint16_t value); +``` + +#### Parameters +- id (slave) - id of target, defaults to 0x00 if not specified +- address address to use for operation +- value - holding register value to write + + +#### Returns +1 on success, 0 on failure. + +### `modbusServer.registerMaskWrite()` + +#### Description + +Perform a "Mask Write Registers" operation for the specified address, AND mask and OR mask. + +#### Syntax +``` +int registerMaskWrite(int address, uint16_t andMask, uint16_t orMask); +int registerMaskWrite(int id, int address, uint16_t andMask, uint16_t orMask); +``` + +#### Parameters +- id (slave) - id of target, defaults to 0x00 if not specified +- address address to use for operation +- andMask - AND mask to use for operation +- orMask - OR mask to use for operation + + +#### Returns +1 on success, 0 on failure. + +### `modbusServer.discreteInputWrite()` + +#### Description + +Write the value of the server's Discrete Input for the specified address and value. + +#### Syntax + +``` +int discreteInputWrite(int address, uint8_t value); +``` + +#### Parameters +- address address to use for operation +- value - discrete input value to write + + +#### Returns +1 on success, 0 on failure. + +### `modbusServer.writeDiscreteInputs()` + +#### Description + +Write values to the server's Discrete Inputs for the specified address and values. + +#### Syntax + +``` +int writeDiscreteInputs(int address, uint8_t values[], int nb); +``` + +#### Parameters +- address address to use for operation +- values - array of discrete inputs values to write +- nb - number of discrete inputs to write + + +#### Returns +1 on success, 0 on failure. + +### `modbusServer.inputRegisterWrite()` + +#### Description + +Write the value of the server's Input Register for the specified address and value. + +#### Syntax + +``` +int inputRegisterWrite(int address, uint16_t value); +``` + +#### Parameters +- address address to use for operation +- value - input register value to write + + +#### Returns +1 on success, 0 on failure. + +### `modbusServer.writeInputRegisters()` + +#### Description + +Write values to the server's Input Registers for the specified address and values. + +#### Syntax + +``` +int writeInputRegisters(int address, uint16_t values[], int nb); +``` + +#### Parameters +- address address to use for operation +- values - array of input registers values to write +- nb - number of input registers to write + +#### Returns +1 on success, 0 on failure. + +### `modbusServer.poll()` + +#### Description + +Poll for requests + +#### Syntax + +``` +virtual int poll() = 0; +``` + +#### Parameters +None + +#### Returns +1 on request, 0 on no request + +### `modbusServer.end()` + +#### Description + +Stop the server + +#### Syntax + +``` +void end(); +``` + +#### Parameters +None + +#### Return +nothing + +## ModbusRTUServer Class + +### `modbusRTUServer.begin()` + +#### Description + +Start the Modbus RTU server with the specified parameters. + +#### Syntax + +``` +ModbusRTUServer.begin(id, baudrate); +ModbusRTUServer.begin(id, baudrate, config); +``` + +#### Parameters +- id - (slave) id of the server baudrate - Baud rate to use for serial +- config - Config to use for serial (see Serial.begin(...) for more info.) defaults to SERIAL_8N1 if not provided + + +#### Returns +1 on success, 0 on failure + +## ModbusTCPServer + +### `ModbusTCPServer()` + +#### Description + +Creates a Modbus TCP server. + +#### Syntax + +``` +ModbusTCPServer(); +``` + +#### Parameters +None + +### `modbusTCPServer.begin()` + +#### Description + +Start the Modbus TCP server. + +#### Syntax + +``` +modbusTCPserver.begin(); +modbusTCPserver.begin(id); +``` + +#### Parameters +- id - the (slave) id of the server, defaults to 0xff (TCP); + + +#### Returns +1 on success, 0 on failure + +### `modbusTCPServer.accept()` + +#### Description + +Accept a client connection. + +#### Syntax + +``` +modbusTCPserver.accept(client); +``` + +#### Parameters +- client - the Client to accept a connection from; + + +#### Returns +Nothing diff --git a/docs/readme.md b/docs/readme.md new file mode 100644 index 0000000..c1ae8bd --- /dev/null +++ b/docs/readme.md @@ -0,0 +1,20 @@ +# Arduino Modbus Library + +This library implements the [Modbus protocol](https://en.wikipedia.org/wiki/Modbus) over two different types of transport: serial communication over RS485 with RTU (Remote Terminal Unit) or Ethernet and WiFi communication with TCP protocol. There are a few differences in the APIs depending on the transport, but the majority of the functions are the same for both. +Modbus is also a client server protocol where Client = master and Server = slave in Modbus terminilogy; we suggest to read some papers about this protocol if you don't have any former experience because it is based heavily on some formal conventions. + +We have organized this reference so that you find the common functions of both transports together and only the transport related functions are given individually. As a rule of thumb, RTU communication is multipoint and therefore the ID of the unit involved in the communication needs to be specified. TCP is point to point using the IP address and therefore there is no need for an ID in the parameters. + +The library is available in our Library Manager; it is compatible with our [MKR RS485 Shield](https://store.arduino.cc/products/arduino-mkr-485-shield) and with our network enabled products like the [Ethernet shield](https://store-usa.arduino.cc/products/arduino-ethernet-shield-2), the MKR family of boards and the [Arduino UNO WiFi Rev 2](https://store.arduino.cc/products/arduino-uno-wifi-rev2) just to name a few. + +To use this library: + +``` +#include +``` + +## Further readings + +- [Modbus Tutorial from Control Solutions](https://www.csimn.com/CSI_pages/Modbus101.html) +- [Modbus Application Protocol (PDF)](http://www.modbus.org/docs/Modbus_Application_Protocol_V1_1b3.pdf) +- [Modbus FAQ](https://modbus.org/faq.php) \ No newline at end of file diff --git a/examples/RTU/ModbusRTUClientKitchenSink/ModbusRTUClientKitchenSink.ino b/examples/RTU/ModbusRTUClientKitchenSink/ModbusRTUClientKitchenSink.ino index 1fa14ec..397a382 100644 --- a/examples/RTU/ModbusRTUClientKitchenSink/ModbusRTUClientKitchenSink.ino +++ b/examples/RTU/ModbusRTUClientKitchenSink/ModbusRTUClientKitchenSink.ino @@ -1,7 +1,7 @@ /* Modbus RTU Client Kitchen Sink - This sketch creates a Modbus RTU Client and demostrates + This sketch creates a Modbus RTU Client and demonstrates how to use various Modbus Client APIs. Circuit: @@ -164,7 +164,7 @@ void readHoldingRegisterValues() { void readInputRegisterValues() { Serial.print("Reading input register values ... "); - // read 10 dsicrete input values from (slave) id 42, + // read 10 discrete input values from (slave) id 42, if (!ModbusRTUClient.requestFrom(42, INPUT_REGISTERS, 0x00, 10)) { Serial.print("failed! "); Serial.println(ModbusRTUClient.lastError()); @@ -181,4 +181,3 @@ void readInputRegisterValues() { // Alternatively, to read a single Input Register value use: // ModbusRTUClient.inputRegisterRead(...) } - diff --git a/examples/RTU/ModbusRTUClientMD02TemperatureHumiditySensor/ModbusRTUClientMD02TemperatureHumiditySensor.ino b/examples/RTU/ModbusRTUClientMD02TemperatureHumiditySensor/ModbusRTUClientMD02TemperatureHumiditySensor.ino new file mode 100644 index 0000000..2f113be --- /dev/null +++ b/examples/RTU/ModbusRTUClientMD02TemperatureHumiditySensor/ModbusRTUClientMD02TemperatureHumiditySensor.ino @@ -0,0 +1,76 @@ +/* + Modbus RTU Client MD02 Temperature Humidity sensor + + This sketch creates a Modbus RTU Client and demonstrates + how to use read temperature and humidity values as sensed + by the RTU Modbus capable MD02 sensor. +*/ + +/************************************************************************************** + * INCLUDE + **************************************************************************************/ + +#include +#include + +/************************************************************************************** + * CONSTANTS + **************************************************************************************/ + +static unsigned int const MODBUS_BAUDRATE = 9600; +static float const MODBUS_BIT_DURATION = 1.f / MODBUS_BAUDRATE; +static float const MODBUS_PRE_DELAY_BR = MODBUS_BIT_DURATION * 9.6f * 3.5f * 1e6; +static float const MODBUS_POST_DELAY_BR = MODBUS_BIT_DURATION * 9.6f * 3.5f * 1e6; + +static int const MODBUS_DEVICE_ID = 1; +static int const MODBUS_DEVICE_TEMPERATURE_REGISTER = 0x0001; +static int const MODBUS_DEVICE_HUMIDITY_REGISTER = 0x0002; + +/************************************************************************************** + * SETUP/LOOP + **************************************************************************************/ + +void setup() +{ + Serial.begin(9600); + while (!Serial); + + RS485.setDelays(MODBUS_PRE_DELAY_BR, MODBUS_POST_DELAY_BR); + + if (!ModbusRTUClient.begin(MODBUS_BAUDRATE, SERIAL_8N1)) + { + Serial.println("Failed to start Modbus RTU Client!"); + for (;;) { } + } + + ModbusRTUClient.setTimeout(2 * 1000UL); /* 2 seconds. */ +} + +void loop() +{ + if (!ModbusRTUClient.requestFrom(MODBUS_DEVICE_ID, INPUT_REGISTERS, MODBUS_DEVICE_TEMPERATURE_REGISTER, 1)) { + Serial.print("failed to read temperature register! "); + Serial.println(ModbusRTUClient.lastError()); + return; + } + if (ModbusRTUClient.available()) + { + int16_t const temperature_raw = ModbusRTUClient.read(); + float const temperature_deg = temperature_raw / 100.f; + Serial.println(temperature_deg); + } + + if (!ModbusRTUClient.requestFrom(MODBUS_DEVICE_ID, INPUT_REGISTERS, MODBUS_DEVICE_HUMIDITY_REGISTER, 1)) { + Serial.print("failed to read humidity register! "); + Serial.println(ModbusRTUClient.lastError()); + return; + } + if (ModbusRTUClient.available()) + { + int16_t const humidity_raw = ModbusRTUClient.read(); + float const humidity_per_cent = humidity_raw / 100.f; + Serial.println(humidity_per_cent); + } + + delay(1000); +} diff --git a/examples/RTU/ModbusRTUClientParameters/ModbusRTUClientParameters.ino b/examples/RTU/ModbusRTUClientParameters/ModbusRTUClientParameters.ino new file mode 100644 index 0000000..ec30e0d --- /dev/null +++ b/examples/RTU/ModbusRTUClientParameters/ModbusRTUClientParameters.ino @@ -0,0 +1,63 @@ +/* + Modbus RTU Client Parameters + + This sketch is the same as ModbusRTUClientToggle and shows how to set + a few RS485 parameters. + + Circuit: + - Arduino Opta + - GND connected to GND of the Modbus RTU server + - A(-) connected to A of the Modbus RTU server + - B(+) connected to B of the Modbus RTU server +*/ + +#include // ArduinoModbus depends on the ArduinoRS485 library +#include + +constexpr auto baudrate { 19200 }; + +void setup() { + Serial.begin(9600); + while (!Serial); + + Serial.println("Modbus RTU Client Toggle w/ Parameters"); + + // start the Modbus RTU client in 8E1 mode + if (!ModbusRTUClient.begin(baudrate, SERIAL_8E1)) { + Serial.println("Failed to start Modbus RTU Client!"); + while (1); + } +} + +void loop() { + // for (slave) id 1: write the value of 0x01, to the coil at address 0x00 + if (!ModbusRTUClient.coilWrite(1, 0x00, 0x01)) { + Serial.print("Failed to write coil! "); + Serial.println(ModbusRTUClient.lastError()); + } + + // wait for 0.5 second + delay(500); + + // for (slave) id 1: write the value of 0x00, to the coil at address 0x00 + if (!ModbusRTUClient.coilWrite(1, 0x00, 0x00)) { + Serial.print("Failed to write coil! "); + Serial.println(ModbusRTUClient.lastError()); + } + + // wait for 0.5 second + delay(500); + + auto coil = ModbusRTUClient.coilRead(0x02, 0x00); + + if (coil < 0) { + Serial.print("Failed to read coil: "); + Serial.println(ModbusRTUClient.lastError()); + } else { + Serial.print("Coil: "); + Serial.println(coil); + } + + // wait for 0.5 second + delay(500); +} diff --git a/examples/RTU/ModbusRTUServerKitchenSink/ModbusRTUServerKitchenSink.ino b/examples/RTU/ModbusRTUServerKitchenSink/ModbusRTUServerKitchenSink.ino index 8501aa3..832f05b 100644 --- a/examples/RTU/ModbusRTUServerKitchenSink/ModbusRTUServerKitchenSink.ino +++ b/examples/RTU/ModbusRTUServerKitchenSink/ModbusRTUServerKitchenSink.ino @@ -1,7 +1,7 @@ /* Modbus RTU Server Kitchen Sink - This sketch creates a Modbus RTU Server and demostrates + This sketch creates a Modbus RTU Server and demonstrates how to use various Modbus Server APIs. Circuit: @@ -62,7 +62,7 @@ void loop() { ModbusRTUServer.discreteInputWrite(i, coilValue); } - // map the holiding register values to the input register values + // map the holding register values to the input register values for (int i = 0; i < numHoldingRegisters; i++) { long holdingRegisterValue = ModbusRTUServer.holdingRegisterRead(i); diff --git a/examples/RTU/ModbusRTUServerLED/ModbusRTUServerLED.ino b/examples/RTU/ModbusRTUServerLED/ModbusRTUServerLED.ino index bf0b1cd..07a059b 100644 --- a/examples/RTU/ModbusRTUServerLED/ModbusRTUServerLED.ino +++ b/examples/RTU/ModbusRTUServerLED/ModbusRTUServerLED.ino @@ -44,16 +44,18 @@ void setup() { void loop() { // poll for Modbus RTU requests - ModbusRTUServer.poll(); - - // read the current value of the coil - int coilValue = ModbusRTUServer.coilRead(0x00); - - if (coilValue) { - // coil value set, turn LED on - digitalWrite(ledPin, HIGH); - } else { - // coild value clear, turn LED off - digitalWrite(ledPin, LOW); + int packetReceived = ModbusRTUServer.poll(); + + if(packetReceived) { + // read the current value of the coil + int coilValue = ModbusRTUServer.coilRead(0x00); + + if (coilValue) { + // coil value set, turn LED on + digitalWrite(ledPin, HIGH); + } else { + // coil value clear, turn LED off + digitalWrite(ledPin, LOW); + } } } diff --git a/examples/RTU/ModbusRTUTemperatureSensor/ModbusRTUTemperatureSensor.ino b/examples/RTU/ModbusRTUTemperatureSensor/ModbusRTUTemperatureSensor.ino index dceb1dd..323e55a 100644 --- a/examples/RTU/ModbusRTUTemperatureSensor/ModbusRTUTemperatureSensor.ino +++ b/examples/RTU/ModbusRTUTemperatureSensor/ModbusRTUTemperatureSensor.ino @@ -1,5 +1,5 @@ /* - Modbus RTU Temeperature Sensor + Modbus RTU Temperature Sensor This sketch shows you how to interact with a Modbus RTU temperature and humidity sensor. It reads the temperature and humidity values every 5 seconds and outputs them to the diff --git a/examples/TCP/EthernetModbusClientToggle/EthernetModbusClientToggle.ino b/examples/TCP/EthernetModbusClientToggle/EthernetModbusClientToggle.ino new file mode 100644 index 0000000..a15ae11 --- /dev/null +++ b/examples/TCP/EthernetModbusClientToggle/EthernetModbusClientToggle.ino @@ -0,0 +1,87 @@ +/* + Ethernet Modbus TCP Client Toggle + + This sketch toggles the coil of a Modbus TCP server connected + on and off every second. + + Circuit: + - Any Arduino MKR Board + - MKR ETH Shield + + created 16 July 2018 + by Sandeep Mistry +*/ + +#include +#include + +#include // ArduinoModbus depends on the ArduinoRS485 library +#include + +// Enter a MAC address for your controller below. +// Newer Ethernet shields have a MAC address printed on a sticker on the shield +// The IP address will be dependent on your local network: +byte mac[] = { + 0xDE, 0xAD, 0xBE, 0xEF, 0xFE, 0xED +}; +IPAddress ip(192, 168, 1, 177); + +EthernetClient ethClient; +ModbusTCPClient modbusTCPClient(ethClient); + +IPAddress server(192, 168, 1, 10); // update with the IP Address of your Modbus server + +void setup() { + //Initialize serial and wait for port to open: + Serial.begin(9600); + while (!Serial) { + ; // wait for serial port to connect. Needed for native USB port only + } + + // start the Ethernet connection and the server: + Ethernet.begin(mac, ip); + + // Check for Ethernet hardware present + if (Ethernet.hardwareStatus() == EthernetNoHardware) { + Serial.println("Ethernet shield was not found. Sorry, can't run without hardware. :("); + while (true) { + delay(1); // do nothing, no point running without Ethernet hardware + } + } + if (Ethernet.linkStatus() == LinkOFF) { + Serial.println("Ethernet cable is not connected."); + } +} + +void loop() { + if (!modbusTCPClient.connected()) { + // client not connected, start the Modbus TCP client + Serial.println("Attempting to connect to Modbus TCP server"); + + if (!modbusTCPClient.begin(server, 502)) { + Serial.println("Modbus TCP Client failed to connect!"); + } else { + Serial.println("Modbus TCP Client connected"); + } + } else { + // client connected + + // write the value of 0x01, to the coil at address 0x00 + if (!modbusTCPClient.coilWrite(0x00, 0x01)) { + Serial.print("Failed to write coil! "); + Serial.println(modbusTCPClient.lastError()); + } + + // wait for 1 second + delay(1000); + + // write the value of 0x00, to the coil at address 0x00 + if (!modbusTCPClient.coilWrite(0x00, 0x00)) { + Serial.print("Failed to write coil! "); + Serial.println(modbusTCPClient.lastError()); + } + + // wait for 1 second + delay(1000); + } +} diff --git a/examples/TCP/EthernetModbusServerLED/EthernetModbusServerLED.ino b/examples/TCP/EthernetModbusServerLED/EthernetModbusServerLED.ino new file mode 100644 index 0000000..bedc2b7 --- /dev/null +++ b/examples/TCP/EthernetModbusServerLED/EthernetModbusServerLED.ino @@ -0,0 +1,116 @@ +/* + Ethernet Modbus TCP Server LED + + This sketch creates a Modbus TCP Server with a simulated coil. + The value of the simulated coil is set on the LED + + Circuit: + - Any Arduino MKR Board + - MKR ETH Shield + + created 16 July 2018 + by Sandeep Mistry +*/ + +#include +#include + +#include // ArduinoModbus depends on the ArduinoRS485 library +#include + +// Enter a MAC address for your controller below. +// Newer Ethernet shields have a MAC address printed on a sticker on the shield +// The IP address will be dependent on your local network: +byte mac[] = { + 0xDE, 0xAD, 0xBE, 0xEF, 0xFE, 0xED +}; +IPAddress ip(192, 168, 1, 177); + +EthernetServer ethServer(502); + +ModbusTCPServer modbusTCPServer; + +const int ledPin = LED_BUILTIN; + +void setup() { + // You can use Ethernet.init(pin) to configure the CS pin + //Ethernet.init(10); // Most Arduino shields + //Ethernet.init(5); // MKR ETH shield + //Ethernet.init(0); // Teensy 2.0 + //Ethernet.init(20); // Teensy++ 2.0 + //Ethernet.init(15); // ESP8266 with Adafruit Featherwing Ethernet + //Ethernet.init(33); // ESP32 with Adafruit Featherwing Ethernet + + // Open serial communications and wait for port to open: + Serial.begin(9600); + while (!Serial) { + ; // wait for serial port to connect. Needed for native USB port only + } + Serial.println("Ethernet Modbus TCP Example"); + + // start the Ethernet connection and the server: + Ethernet.begin(mac, ip); + + // Check for Ethernet hardware present + if (Ethernet.hardwareStatus() == EthernetNoHardware) { + Serial.println("Ethernet shield was not found. Sorry, can't run without hardware. :("); + while (true) { + delay(1); // do nothing, no point running without Ethernet hardware + } + } + if (Ethernet.linkStatus() == LinkOFF) { + Serial.println("Ethernet cable is not connected."); + } + + // start the server + ethServer.begin(); + + // start the Modbus TCP server + if (!modbusTCPServer.begin()) { + Serial.println("Failed to start Modbus TCP Server!"); + while (1); + } + + // configure the LED + pinMode(ledPin, OUTPUT); + digitalWrite(ledPin, LOW); + + // configure a single coil at address 0x00 + modbusTCPServer.configureCoils(0x00, 1); +} + +void loop() { + // listen for incoming clients + EthernetClient client = ethServer.available(); + + if (client) { + // a new client connected + Serial.println("new client"); + + // let the Modbus TCP accept the connection + modbusTCPServer.accept(client); + + while (client.connected()) { + // poll for Modbus TCP requests, while client connected + modbusTCPServer.poll(); + + // update the LED + updateLED(); + } + + Serial.println("client disconnected"); + } +} + +void updateLED() { + // read the current value of the coil + int coilValue = modbusTCPServer.coilRead(0x00); + + if (coilValue) { + // coil value set, turn LED on + digitalWrite(ledPin, HIGH); + } else { + // coild value clear, turn LED off + digitalWrite(ledPin, LOW); + } +} diff --git a/examples/TCP/WiFiModbusClientToggle/WiFiModbusClientToggle.ino b/examples/TCP/WiFiModbusClientToggle/WiFiModbusClientToggle.ino index 98c29db..0322c89 100644 --- a/examples/TCP/WiFiModbusClientToggle/WiFiModbusClientToggle.ino +++ b/examples/TCP/WiFiModbusClientToggle/WiFiModbusClientToggle.ino @@ -40,7 +40,7 @@ void setup() { Serial.println("Modbus TCP Client Toggle"); - // attempt to connect to Wifi network: + // attempt to connect to WiFi network: while (status != WL_CONNECTED) { Serial.print("Attempting to connect to SSID: "); Serial.println(ssid); diff --git a/examples/TCP/WiFiModbusServerLED/WiFiModbusServerLED.ino b/examples/TCP/WiFiModbusServerLED/WiFiModbusServerLED.ino index c4c23fe..60276c0 100644 --- a/examples/TCP/WiFiModbusServerLED/WiFiModbusServerLED.ino +++ b/examples/TCP/WiFiModbusServerLED/WiFiModbusServerLED.ino @@ -41,7 +41,7 @@ void setup() { Serial.println("Modbus TCP Server LED"); - // attempt to connect to Wifi network: + // attempt to connect to WiFi network: while (status != WL_CONNECTED) { Serial.print("Attempting to connect to SSID: "); Serial.println(ssid); diff --git a/keywords.txt b/keywords.txt index 2480751..b30c910 100644 --- a/keywords.txt +++ b/keywords.txt @@ -7,6 +7,7 @@ ####################################### ArduinoModbus KEYWORD1 +ModbusRTUDelay KEYWORD1 ModbusRTUClient KEYWORD1 ModbusRTUServer KEYWORD1 ModbusRTUClient KEYWORD1 @@ -21,6 +22,9 @@ poll KEYWORD2 end KEYWORD2 setTimeout KEYWORD2 +preDelay KEYWORD2 +postDelay KEYWORD2 + beginTransmission KEYWORD2 write KEYWORD2 endTransmission KEYWORD2 @@ -50,5 +54,5 @@ inputRegisterWrite KEYWORD2 COILS LITERAL1 DISCRETE_INPUTS LITERAL1 -HOLIDING_REGISTERS LITERAL1 +HOLDING_REGISTERS LITERAL1 INPUT_REGISTERS LITERAL1 diff --git a/library.properties b/library.properties index 1279504..84aace6 100644 --- a/library.properties +++ b/library.properties @@ -1,11 +1,11 @@ name=ArduinoModbus -version=1.0.1 +version=1.0.9 author=Arduino maintainer=Arduino sentence=Use Modbus equipment with your Arduino. paragraph=Using TCP or RS485 shields, like the MKR 485 Shield. This library depends on the ArduinoRS485 library. category=Communication url=https://www.arduino.cc/en/ArduinoModbus/ArduinoModbus -architectures=* +architectures=megaavr,samd,mbed_nano,mbed_portenta,mbed_opta includes=ArduinoModbus.h depends=ArduinoRS485 diff --git a/src/ModbusClient.h b/src/ModbusClient.h index 1c881b1..468e07a 100644 --- a/src/ModbusClient.h +++ b/src/ModbusClient.h @@ -65,7 +65,7 @@ class ModbusClient { * @param id (slave) id of target, defaults to 0x00 if not specified * @param address start address to use for operation * - * @return holiding register value on success, -1 on failure. + * @return holding register value on success, -1 on failure. */ long holdingRegisterRead(int address); long holdingRegisterRead(int id, int address); @@ -129,7 +129,7 @@ class ModbusClient { * to send request on the wire. * * @param id (slave) id of target, defaults to 0x00 if not specified - * @param type type of write to perform, either COILS or HOLD_REGISTERS + * @param type type of write to perform, either COILS or HOLDING_REGISTERS * @param address start address to use for operation * @param nb number of values to write * @@ -162,7 +162,7 @@ class ModbusClient { * * @param id (slave) id of target, defaults to 0x00 if not specified * @param type type of read to perform, either COILS, DISCRETE_INPUTS, - * HOLD_REGISTERS, or INPUT_REGISTERS + * HOLDING_REGISTERS, or INPUT_REGISTERS * @param address start address to use for operation * @param nb number of values to read * diff --git a/src/ModbusRTUClient.cpp b/src/ModbusRTUClient.cpp index 29521c6..9e31a27 100644 --- a/src/ModbusRTUClient.cpp +++ b/src/ModbusRTUClient.cpp @@ -26,18 +26,27 @@ extern "C" { #include "ModbusRTUClient.h" +#include "ModbusRTUDelay.h" + ModbusRTUClientClass::ModbusRTUClientClass() : ModbusClient(1000) { } +ModbusRTUClientClass::ModbusRTUClientClass(RS485Class& rs485) : + ModbusClient(1000), _rs485(&rs485) +{ +} + ModbusRTUClientClass::~ModbusRTUClientClass() { } int ModbusRTUClientClass::begin(unsigned long baudrate, uint16_t config) { - modbus_t* mb = modbus_new_rtu(baudrate, config); + _rs485->setDelays(ModbusRTUDelay::preDelay(baudrate), ModbusRTUDelay::postDelay(baudrate)); + + modbus_t* mb = modbus_new_rtu(_rs485, baudrate, config); if (!ModbusClient::begin(mb, 0x00)) { return 0; @@ -46,4 +55,10 @@ int ModbusRTUClientClass::begin(unsigned long baudrate, uint16_t config) return 1; } +int ModbusRTUClientClass::begin(RS485Class& rs485, unsigned long baudrate, uint16_t config) +{ + _rs485 = &rs485; + return begin(baudrate, config); +} + ModbusRTUClientClass ModbusRTUClient; diff --git a/src/ModbusRTUClient.h b/src/ModbusRTUClient.h index 2dc96c9..2667594 100644 --- a/src/ModbusRTUClient.h +++ b/src/ModbusRTUClient.h @@ -21,10 +21,12 @@ #define _MODBUS_RTU_CLIENT_H_INCLUDED #include "ModbusClient.h" +#include class ModbusRTUClientClass : public ModbusClient { public: ModbusRTUClientClass(); + ModbusRTUClientClass(RS485Class& rs485); virtual ~ModbusRTUClientClass(); /** @@ -36,6 +38,10 @@ class ModbusRTUClientClass : public ModbusClient { * Return 1 on success, 0 on failure */ int begin(unsigned long baudrate, uint16_t config = SERIAL_8N1); + int begin(RS485Class& rs485, unsigned long baudrate, uint16_t config = SERIAL_8N1); + +private: + RS485Class* _rs485 = &RS485; }; extern ModbusRTUClientClass ModbusRTUClient; diff --git a/src/ModbusRTUDelay.h b/src/ModbusRTUDelay.h new file mode 100644 index 0000000..929e287 --- /dev/null +++ b/src/ModbusRTUDelay.h @@ -0,0 +1,50 @@ +/* + This file is part of the ArduinoModbus library. + Copyright (c) 2018 Arduino SA. All rights reserved. + + 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_DELAY_H_INCLUDED +#define _MODBUS_RTU_DELAY_H_INCLUDED + +class ModbusRTUDelay +{ +public: + /* Do not allow construction or copying. */ + ModbusRTUDelay() = delete; + ModbusRTUDelay(ModbusRTUDelay const &) = delete; + + /* Calculate __minimum__ preDelay and postDelay in + * microseconds as per Modbus RTU Specification. + * + * MODBUS over serial line specification and implementation guide V1.02 + * Paragraph 2.5.1.1 MODBUS Message RTU Framing + * https://modbus.org/docs/Modbus_over_serial_line_V1_02.pdf + */ + static unsigned long const preDelay(unsigned long const baudrate) + { + double const bit_duration = 1. / baudrate; + double const word_len = 9.6f; // try also with 10.0f + double const pre_delay_us = bit_duration * word_len * 3.5f * 1e6; + return static_cast(pre_delay_us); + } + static unsigned long const postDelay(unsigned long const baudrate) + { + return preDelay(baudrate); + } +}; + +#endif /* _MODBUS_RTU_DELAY_H_INCLUDED */ diff --git a/src/ModbusRTUServer.cpp b/src/ModbusRTUServer.cpp index 7c4dfb9..836ba7b 100644 --- a/src/ModbusRTUServer.cpp +++ b/src/ModbusRTUServer.cpp @@ -26,17 +26,26 @@ extern "C" { #include "ModbusRTUServer.h" +#include "ModbusRTUDelay.h" + + ModbusRTUServerClass::ModbusRTUServerClass() { } +ModbusRTUServerClass::ModbusRTUServerClass(RS485Class& rs485) : _rs485(&rs485) +{ +} + ModbusRTUServerClass::~ModbusRTUServerClass() { } int ModbusRTUServerClass::begin(int id, unsigned long baudrate, uint16_t config) { - modbus_t* mb = modbus_new_rtu(baudrate, config); + _rs485->setDelays(ModbusRTUDelay::preDelay(baudrate), ModbusRTUDelay::postDelay(baudrate)); + + modbus_t* mb = modbus_new_rtu(_rs485, baudrate, config); if (!ModbusServer::begin(mb, id)) { return 0; @@ -47,7 +56,13 @@ int ModbusRTUServerClass::begin(int id, unsigned long baudrate, uint16_t config) return 1; } -void ModbusRTUServerClass::poll() +int ModbusRTUServerClass::begin(RS485Class& rs485, int id, unsigned long baudrate, uint16_t config) +{ + _rs485 = &rs485; + return begin(id, baudrate, config); +} + +int ModbusRTUServerClass::poll() { uint8_t request[MODBUS_RTU_MAX_ADU_LENGTH]; @@ -55,7 +70,9 @@ void ModbusRTUServerClass::poll() if (requestLength > 0) { modbus_reply(_mb, request, requestLength, &_mbMapping); + return 1; } + return 0; } ModbusRTUServerClass ModbusRTUServer; diff --git a/src/ModbusRTUServer.h b/src/ModbusRTUServer.h index 82cd885..53b7d40 100644 --- a/src/ModbusRTUServer.h +++ b/src/ModbusRTUServer.h @@ -21,10 +21,12 @@ #define _MODBUS_RTU_SERVER_H_INCLUDED #include "ModbusServer.h" +#include class ModbusRTUServerClass : public ModbusServer { public: ModbusRTUServerClass(); + ModbusRTUServerClass(RS485Class& rs485); virtual ~ModbusRTUServerClass(); /** @@ -37,11 +39,15 @@ class ModbusRTUServerClass : public ModbusServer { * Return 1 on success, 0 on failure */ int begin(int id, unsigned long baudrate, uint16_t config = SERIAL_8N1); + int begin(RS485Class& rs485, int id, unsigned long baudrate, uint16_t config = SERIAL_8N1); /** * Poll interface for requests */ - virtual void poll(); + virtual int poll(); + +private: + RS485Class* _rs485 = &RS485; }; extern ModbusRTUServerClass ModbusRTUServer; diff --git a/src/ModbusServer.cpp b/src/ModbusServer.cpp index 2fd8f78..883f746 100644 --- a/src/ModbusServer.cpp +++ b/src/ModbusServer.cpp @@ -249,29 +249,39 @@ int ModbusServer::registerMaskWrite(int address, uint16_t andMask, uint16_t orMa } int ModbusServer::discreteInputWrite(int address, uint8_t value) +{ + return writeDiscreteInputs(address, &value, 1); +} + +int ModbusServer::writeDiscreteInputs(int address, uint8_t values[], int nb) { if (_mbMapping.start_input_bits > address || - (_mbMapping.start_input_bits + _mbMapping.nb_input_bits) < (address + 1)) { + (_mbMapping.start_input_bits + _mbMapping.nb_input_bits) < (address + nb)) { errno = EMBXILADD; return 0; } - _mbMapping.tab_input_bits[address - _mbMapping.start_input_bits] = value; + memcpy(&_mbMapping.tab_input_bits[address - _mbMapping.start_input_bits], values, sizeof(values[0]) * nb); return 1; } int ModbusServer::inputRegisterWrite(int address, uint16_t value) +{ + return writeInputRegisters(address, &value, 1); +} + +int ModbusServer::writeInputRegisters(int address, uint16_t values[], int nb) { if (_mbMapping.start_input_registers > address || - (_mbMapping.start_input_registers + _mbMapping.nb_input_registers) < (address + 1)) { + (_mbMapping.start_input_registers + _mbMapping.nb_input_registers) < (address + nb)) { errno = EMBXILADD; return 0; } - _mbMapping.tab_input_registers[address - _mbMapping.start_input_registers] = value; + memcpy(&_mbMapping.tab_input_registers[address - _mbMapping.start_input_registers], values, sizeof(values[0]) * nb); return 1; } diff --git a/src/ModbusServer.h b/src/ModbusServer.h index 76fa7e3..cb1d67b 100644 --- a/src/ModbusServer.h +++ b/src/ModbusServer.h @@ -126,8 +126,10 @@ class ModbusServer { /** * Poll for requests + * + * @return 1 on request, 0 on no request. */ - virtual void poll() = 0; + virtual int poll() = 0; /** * Stop the server diff --git a/src/ModbusTCPServer.cpp b/src/ModbusTCPServer.cpp index d4da76c..16e3a1e 100644 --- a/src/ModbusTCPServer.cpp +++ b/src/ModbusTCPServer.cpp @@ -57,7 +57,7 @@ void ModbusTCPServer::accept(Client& client) } } -void ModbusTCPServer::poll() +int ModbusTCPServer::poll() { if (_client != NULL) { uint8_t request[MODBUS_TCP_MAX_ADU_LENGTH]; @@ -66,6 +66,8 @@ void ModbusTCPServer::poll() if (requestLength > 0) { modbus_reply(_mb, request, requestLength, &_mbMapping); + return 1; } } + return 0; } diff --git a/src/ModbusTCPServer.h b/src/ModbusTCPServer.h index 8c7ddc6..cbf6e65 100644 --- a/src/ModbusTCPServer.h +++ b/src/ModbusTCPServer.h @@ -48,7 +48,7 @@ class ModbusTCPServer : public ModbusServer { /** * Poll accepted client for requests */ - virtual void poll(); + virtual int poll(); private: Client* _client; diff --git a/src/libmodbus/modbus-data.c b/src/libmodbus/modbus-data.c index ce63cc9..2007257 100644 --- a/src/libmodbus/modbus-data.c +++ b/src/libmodbus/modbus-data.c @@ -23,7 +23,7 @@ #define htonl(x) bswap_32(x) #define htons(x) bswap_16(x) #define ntohl(x) bswap_32(x) -#define ntohs(x) bswap_32(x) +#define ntohs(x) bswap_16(x) #else #define htonl(x) (x) #define htons(x) (x) diff --git a/src/libmodbus/modbus-rtu-private.h b/src/libmodbus/modbus-rtu-private.h index 736cbce..5cd6a8b 100644 --- a/src/libmodbus/modbus-rtu-private.h +++ b/src/libmodbus/modbus-rtu-private.h @@ -17,7 +17,7 @@ #if defined(_WIN32) #include #elif defined(ARDUINO) -// nothing extra needed +#include #else #include #endif @@ -49,6 +49,7 @@ typedef struct _modbus_rtu { #if defined(ARDUINO) unsigned long baud; uint16_t config; + RS485Class* rs485; #else /* Device: "/dev/ttyS0", "/dev/ttyUSB0" or "/dev/tty.USA19*" on Mac OS X. */ char *device; diff --git a/src/libmodbus/modbus-rtu.cpp b/src/libmodbus/modbus-rtu.cpp index d24b520..c5a8302 100644 --- a/src/libmodbus/modbus-rtu.cpp +++ b/src/libmodbus/modbus-rtu.cpp @@ -5,16 +5,6 @@ * SPDX-License-Identifier: LGPL-2.1+ */ -#include -#include -#include -#include -#include -#ifndef _MSC_VER -#include -#endif -#include - #ifdef ARDUINO #include @@ -24,6 +14,16 @@ #endif #endif +#include +#include +#include +#include +#include +#if !defined(_MSC_VER) && !defined(ARDUINO) +#include +#endif +#include + #include "modbus-private.h" #include "modbus-rtu.h" @@ -323,15 +323,15 @@ static ssize_t _modbus_rtu_send(modbus_t *ctx, const uint8_t *req, int req_lengt DWORD n_bytes = 0; return (WriteFile(ctx_rtu->w_ser.fd, req, req_length, &n_bytes, NULL)) ? (ssize_t)n_bytes : -1; #elif defined(ARDUINO) - (void)ctx; + modbus_rtu_t *ctx_rtu = (modbus_rtu_t*)ctx->backend_data; ssize_t size; - RS485.noReceive(); - RS485.beginTransmission(); - size = RS485.write(req, req_length); - RS485.endTransmission(); - RS485.receive(); + ctx_rtu->rs485->noReceive(); + ctx_rtu->rs485->beginTransmission(); + size = ctx_rtu->rs485->write(req, req_length); + ctx_rtu->rs485->endTransmission(); + ctx_rtu->rs485->receive(); return size; #else @@ -394,9 +394,9 @@ static 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); #elif defined(ARDUINO) - (void)ctx; + modbus_rtu_t *ctx_rtu = (modbus_rtu_t*)ctx->backend_data; - return RS485.readBytes(rsp, rsp_length); + return ctx_rtu->rs485->readBytes(rsp, rsp_length); #else return read(ctx->s, rsp, rsp_length); #endif @@ -654,8 +654,8 @@ static int _modbus_rtu_connect(modbus_t *ctx) return -1; } #elif defined(ARDUINO) - RS485.begin(ctx_rtu->baud, ctx_rtu->config); - RS485.receive(); + ctx_rtu->rs485->begin(ctx_rtu->baud, ctx_rtu->config); + ctx_rtu->rs485->receive(); #else /* The O_NOCTTY flag tells UNIX that this program doesn't want to be the "controlling terminal" for that port. If you @@ -1210,8 +1210,8 @@ static void _modbus_rtu_close(modbus_t *ctx) #elif defined(ARDUINO) (void)ctx_rtu; - RS485.noReceive(); - RS485.end(); + ctx_rtu->rs485->noReceive(); + ctx_rtu->rs485->end(); #else if (ctx->s != -1) { tcsetattr(ctx->s, TCSANOW, &ctx_rtu->old_tios); @@ -1228,10 +1228,10 @@ static int _modbus_rtu_flush(modbus_t *ctx) ctx_rtu->w_ser.n_bytes = 0; return (PurgeComm(ctx_rtu->w_ser.fd, PURGE_RXCLEAR) == FALSE); #elif defined(ARDUINO) - (void)ctx; + modbus_rtu_t *ctx_rtu = (modbus_rtu_t*)ctx->backend_data; - while (RS485.available()) { - RS485.read(); + while (ctx_rtu->rs485->available()) { + ctx_rtu->rs485->read(); } return 0; @@ -1256,14 +1256,14 @@ static int _modbus_rtu_select(modbus_t *ctx, fd_set *rset, return -1; } #elif defined(ARDUINO) - (void)ctx; + modbus_rtu_t *ctx_rtu = (modbus_rtu_t*)ctx->backend_data; (void)rset; unsigned long wait_time_millis = (tv == NULL) ? 0 : (tv->tv_sec * 1000) + (tv->tv_usec / 1000); unsigned long start = millis(); do { - s_rc = RS485.available(); + s_rc = ctx_rtu->rs485->available(); if (s_rc >= length_to_read) { break; @@ -1330,7 +1330,7 @@ const modbus_backend_t _modbus_rtu_backend = { }; #ifdef ARDUINO -modbus_t* modbus_new_rtu(unsigned long baud, uint16_t config) +modbus_t* modbus_new_rtu(RS485Class *rs485, unsigned long baud, uint16_t config) #else modbus_t* modbus_new_rtu(const char *device, int baud, char parity, int data_bit, @@ -1362,6 +1362,7 @@ modbus_t* modbus_new_rtu(const char *device, ctx->backend_data = (modbus_rtu_t *)malloc(sizeof(modbus_rtu_t)); ctx_rtu = (modbus_rtu_t *)ctx->backend_data; #ifdef ARDUINO + ctx_rtu->rs485 = rs485; ctx_rtu->baud = baud; ctx_rtu->config = config; #else diff --git a/src/libmodbus/modbus-rtu.h b/src/libmodbus/modbus-rtu.h index 1237403..9521114 100644 --- a/src/libmodbus/modbus-rtu.h +++ b/src/libmodbus/modbus-rtu.h @@ -18,7 +18,8 @@ MODBUS_BEGIN_DECLS #define MODBUS_RTU_MAX_ADU_LENGTH 256 #ifdef ARDUINO -MODBUS_API modbus_t* modbus_new_rtu(unsigned long baud, uint16_t config); +class RS485Class; +MODBUS_API modbus_t* modbus_new_rtu(RS485Class *rs485, unsigned long baud, uint16_t config); #else MODBUS_API modbus_t* modbus_new_rtu(const char *device, int baud, char parity, int data_bit, int stop_bit); diff --git a/src/libmodbus/modbus-tcp.cpp b/src/libmodbus/modbus-tcp.cpp index 57b94fe..2d69cc0 100644 --- a/src/libmodbus/modbus-tcp.cpp +++ b/src/libmodbus/modbus-tcp.cpp @@ -9,7 +9,7 @@ #include #include #include -#ifndef _MSC_VER +#if !defined(_MSC_VER) && !defined(ARDUINO) #include #endif #include @@ -28,6 +28,7 @@ # define SHUT_RDWR 2 # define close closesocket #elif defined(ARDUINO) +#include "Arduino.h" #ifndef DEBUG #define printf(...) {} #define fprintf(...) {} @@ -498,7 +499,10 @@ static void _modbus_tcp_close(modbus_t *ctx) #ifdef ARDUINO modbus_tcp_t *ctx_tcp = (modbus_tcp_t*)ctx->backend_data; - ctx_tcp->client->stop(); + if(ctx_tcp && ctx_tcp->client) { + ctx_tcp->client->stop(); + } + #else if (ctx->s != -1) { shutdown(ctx->s, SHUT_RDWR); @@ -738,7 +742,11 @@ int modbus_tcp_pi_listen(modbus_t *ctx, int nb_connection) #ifdef ARDUINO +#ifdef __NEED_NAMESPACE__ +int modbus_tcp_accept(modbus_t *ctx, arduino::Client* client) +#else int modbus_tcp_accept(modbus_t *ctx, Client* client) +#endif #else int modbus_tcp_accept(modbus_t *ctx, int *s) #endif @@ -913,7 +921,11 @@ const modbus_backend_t _modbus_tcp_pi_backend = { #endif #ifdef ARDUINO +#ifdef __NEED_NAMESPACE__ +modbus_t* modbus_new_tcp(arduino::Client* client, arduino::IPAddress ip_address, int port) +#else modbus_t* modbus_new_tcp(Client* client, IPAddress ip_address, int port) +#endif #else modbus_t* modbus_new_tcp(const char *ip, int port) #endif diff --git a/src/libmodbus/modbus-tcp.h b/src/libmodbus/modbus-tcp.h index 5ab2819..1adf4fd 100644 --- a/src/libmodbus/modbus-tcp.h +++ b/src/libmodbus/modbus-tcp.h @@ -9,9 +9,19 @@ #define MODBUS_TCP_H #ifdef ARDUINO +// check if __has_include ArduinoAPI +#if defined __has_include +# if __has_include("api/ArduinoAPI.h") +#define __NEED_NAMESPACE__ +namespace arduino { +# endif +#endif class Client; class IPAddress; #endif +#ifdef __NEED_NAMESPACE__ +} +#endif #include "modbus.h" @@ -46,9 +56,14 @@ MODBUS_BEGIN_DECLS #define MODBUS_TCP_MAX_ADU_LENGTH 260 #ifdef ARDUINO +#ifdef __NEED_NAMESPACE__ +MODBUS_API modbus_t* modbus_new_tcp(arduino::Client* client, arduino::IPAddress ip_address, int port); +MODBUS_API int modbus_tcp_accept(modbus_t *ctx, arduino::Client* client); +#else MODBUS_API modbus_t* modbus_new_tcp(Client* client, IPAddress ip_address, int port); -MODBUS_API int modbus_tcp_listen(modbus_t *ctx); MODBUS_API int modbus_tcp_accept(modbus_t *ctx, Client* client); +#endif +MODBUS_API int modbus_tcp_listen(modbus_t *ctx); #else MODBUS_API modbus_t* modbus_new_tcp(const char *ip_address, int port); MODBUS_API int modbus_tcp_listen(modbus_t *ctx, int nb_connection); diff --git a/src/libmodbus/modbus.c b/src/libmodbus/modbus.c index acf5b10..3afeb3b 100644 --- a/src/libmodbus/modbus.c +++ b/src/libmodbus/modbus.c @@ -19,6 +19,7 @@ #include #endif #ifdef ARDUINO +#include #include #ifndef DEBUG @@ -497,7 +498,7 @@ int _modbus_receive_msg(modbus_t *ctx, uint8_t *msg, msg_type_t msg_type) if (length_to_read != 0) { step = _STEP_META; break; - } /* else switches straight to the next step */ + } /*FALLTHROUGH */ /* else switches straight to the next step */ case _STEP_META: length_to_read = compute_data_length_after_meta( ctx, msg, msg_type); @@ -863,7 +864,7 @@ int modbus_reply(modbus_t *ctx, const uint8_t *req, #else if (data == 0xFF00 || data == 0x0) { #endif - mb_mapping->tab_bits[mapping_address] = data ? ON : OFF; + mb_mapping->tab_bits[mapping_address] = data ? 1 : 0; memcpy(rsp, req, req_length); rsp_length = req_length; } else { @@ -896,9 +897,10 @@ int modbus_reply(modbus_t *ctx, const uint8_t *req, break; case MODBUS_FC_WRITE_MULTIPLE_COILS: { int nb = (req[offset + 3] << 8) + req[offset + 4]; + int nb_bits = req[offset + 5]; int mapping_address = address - mb_mapping->start_bits; - if (nb < 1 || MODBUS_MAX_WRITE_BITS < nb) { + if (nb < 1 || MODBUS_MAX_WRITE_BITS < nb || nb_bits * 8 < nb) { /* May be the indication has been truncated on reading because of * invalid address (eg. nb is 0 but the request contains values to * write) so it's necessary to flush. */ @@ -927,9 +929,10 @@ int modbus_reply(modbus_t *ctx, const uint8_t *req, break; case MODBUS_FC_WRITE_MULTIPLE_REGISTERS: { int nb = (req[offset + 3] << 8) + req[offset + 4]; + int nb_bytes = req[offset + 5]; int mapping_address = address - mb_mapping->start_registers; - if (nb < 1 || MODBUS_MAX_WRITE_REGISTERS < nb) { + if (nb < 1 || MODBUS_MAX_WRITE_REGISTERS < nb || nb_bytes * 8 < nb) { rsp_length = response_exception( ctx, &sft, MODBUS_EXCEPTION_ILLEGAL_DATA_VALUE, rsp, TRUE, "Illegal number of values %d in write_registers (max %d)\n", @@ -1016,7 +1019,7 @@ int modbus_reply(modbus_t *ctx, const uint8_t *req, nb_write, nb, MODBUS_MAX_WR_WRITE_REGISTERS, MODBUS_MAX_WR_READ_REGISTERS); } else if (mapping_address < 0 || (mapping_address + nb) > mb_mapping->nb_registers || - mapping_address < 0 || + mapping_address_write < 0 || (mapping_address_write + nb_write) > mb_mapping->nb_registers) { rsp_length = response_exception( ctx, &sft, MODBUS_EXCEPTION_ILLEGAL_DATA_ADDRESS, rsp, FALSE, diff --git a/src/libmodbus/modbus.h b/src/libmodbus/modbus.h index c7b5e0b..85f7630 100644 --- a/src/libmodbus/modbus.h +++ b/src/libmodbus/modbus.h @@ -50,13 +50,6 @@ MODBUS_BEGIN_DECLS #define TRUE 1 #endif -#ifndef OFF -#define OFF 0 -#endif - -#ifndef ON -#define ON 1 -#endif /* Modbus function codes */ #define MODBUS_FC_READ_COILS 0x01