diff --git a/.codespellrc b/.codespellrc new file mode 100644 index 0000000..51c1605 --- /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/utility/ioexpander/I2Cdev.*,./src/utility/ioexpander/TCA6424A.*,./src/utility/QEI,./src/utility/RS485, diff --git a/.github/dependabot.yml b/.github/dependabot.yml new file mode 100644 index 0000000..03600dd --- /dev/null +++ b/.github/dependabot.yml @@ -0,0 +1,10 @@ +# 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 diff --git a/.github/workflows/check-arduino.yml b/.github/workflows/check-arduino.yml new file mode 100644 index 0000000..34c952b --- /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@v2 + + - name: Arduino Lint + uses: arduino/arduino-lint-action@v1 + with: + compliance: strict + library-manager: submit + # 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 index b44dc79..63bf08e 100644 --- a/.github/workflows/compile-examples.yml +++ b/.github/workflows/compile-examples.yml @@ -4,11 +4,13 @@ on: pull_request: paths: - ".github/workflows/compile-examples.yml" + - "library.properties" - "src/**" - "examples/**" push: paths: - ".github/workflows/compile-examples.yml" + - "library.properties" - "src/**" - "examples/**" # Scheduled trigger checks for breakage caused by changes to external resources (libraries, platforms) @@ -30,42 +32,16 @@ jobs: compile-examples: runs-on: ubuntu-latest - env: - ARDUINOCORE_MBED_STAGING_PATH: extras/ArduinoCore-mbed - ARDUINOCORE_API_STAGING_PATH: extras/ArduinoCore-API - steps: - name: Checkout repository uses: actions/checkout@v2 - # It's necessary to checkout the platform before installing it so that the ArduinoCore-API dependency can be added - - name: Checkout ArduinoCore-mbed - uses: actions/checkout@v2 - with: - repository: arduino/ArduinoCore-mbed - # The arduino/actions/libraries/compile-examples action will install the platform from this path - path: ${{ env.ARDUINOCORE_MBED_STAGING_PATH }} - - - name: Checkout ArduinoCore-API - uses: actions/checkout@v2 - with: - repository: arduino/ArduinoCore-API - path: ${{ env.ARDUINOCORE_API_STAGING_PATH }} - - - name: Install ArduinoCore-API - run: | - mv "${{ env.ARDUINOCORE_API_STAGING_PATH }}/api" "${{ env.ARDUINOCORE_MBED_STAGING_PATH }}/cores/arduino" - - name: Compile example sketches - uses: arduino/compile-sketches@main + uses: arduino/compile-sketches@v1 with: - fqbn: arduino:mbed:envie_m7 + fqbn: arduino:mbed_portenta:envie_m7 platforms: | - # Install Arduino mbed-Enabled Boards via Boards Manager for the toolchain - - name: arduino:mbed - # Overwrite the Arduino mbed-Enabled Boards release version with version from the tip of the master branch (located in local path because of the need to first install ArduinoCore-API) - - source-path: extras/ArduinoCore-mbed - name: arduino:mbed + - name: arduino:mbed_portenta enable-deltas-report: true enable-warnings-report: true sketches-report-path: ${{ env.SKETCHES_REPORTS_PATH }} @@ -74,21 +50,27 @@ jobs: - name: Save memory usage change report as artifact uses: actions/upload-artifact@v2 with: + if-no-files-found: error path: ${{ env.SKETCHES_REPORTS_PATH }} name: ${{ env.SKETCHES_REPORTS_ARTIFACT_NAME }} report: needs: compile-examples # Only run the job when the workflow is triggered by a pull request from this repository (because arduino/report-size-deltas requires write permissions) - if: github.event_name == 'pull_request' && github.event.pull_request.head.repo.full_name == github.repository + if: always() && github.event_name == 'pull_request' && github.event.pull_request.head.repo.full_name == github.repository runs-on: ubuntu-latest steps: - name: Download sketches reports artifact + id: download-artifact + continue-on-error: true # If compilation failed for all boards then there are no artifacts uses: actions/download-artifact@v2 with: name: ${{ env.SKETCHES_REPORTS_ARTIFACT_NAME }} path: ${{ env.SKETCHES_REPORTS_PATH }} - - uses: arduino/report-size-deltas@main + - name: Comment size deltas report to PR + uses: arduino/report-size-deltas@v1 + # If actions/download-artifact failed, there are no artifacts to report from. + if: steps.download-artifact.outcome == 'success' with: sketches-reports-source: ${{ env.SKETCHES_REPORTS_PATH }} diff --git a/.github/workflows/spell-check.yml b/.github/workflows/spell-check.yml new file mode 100644 index 0000000..01bee87 --- /dev/null +++ b/.github/workflows/spell-check.yml @@ -0,0 +1,22 @@ +name: Spell Check + +# 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 new misspelling detections resulting from dictionary updates. + - cron: "0 8 * * TUE" + workflow_dispatch: + repository_dispatch: + +jobs: + spellcheck: + runs-on: ubuntu-latest + + steps: + - name: Checkout repository + uses: actions/checkout@v2 + + - name: Spell check + uses: codespell-project/actions-codespell@master 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.md b/README.md index 5f18952..808422b 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,9 @@ = Machine Control Library for Arduino = +[![Check Arduino status](https://github.com/arduino-libraries/AutomationCarrierLibrary/actions/workflows/check-arduino.yml/badge.svg)](https://github.com/arduino-libraries/AutomationCarrierLibrary/actions/workflows/check-arduino.yml) +[![Compile Examples status](https://github.com/arduino-libraries/AutomationCarrierLibrary/actions/workflows/compile-examples.yml/badge.svg)](https://github.com/arduino-libraries/AutomationCarrierLibrary/actions/workflows/compile-examples.yml) +[![Spell Check status](https://github.com/arduino-libraries/AutomationCarrierLibrary/actions/workflows/spell-check.yml/badge.svg)](https://github.com/arduino-libraries/AutomationCarrierLibrary/actions/workflows/spell-check.yml) + Arduino Library for the Machine Control For more information about this library please visit us at https://www.arduino.cc/en/Reference/MachineControl diff --git a/examples/Analog_Out/Analog_Out.ino b/examples/Analog_Out/Analog_Out.ino index 0190641..e65c194 100644 --- a/examples/Analog_Out/Analog_Out.ino +++ b/examples/Analog_Out/Analog_Out.ino @@ -45,7 +45,7 @@ void loop() { if (counter >= 10.5) { counter = 0; - //Additional 100ms delay introduced to manage 10.5V -> 0V fall time of 150ms + //Additional 100 ms delay introduced to manage 10.5V -> 0V fall time of 150 ms delay(100); } delay(100); diff --git a/examples/Analog_input/Analog_input_4_20mA/Analog_input_4_20mA.ino b/examples/Analog_input/Analog_input_4_20mA/Analog_input_4_20mA.ino index 60f66d9..9804030 100644 --- a/examples/Analog_input/Analog_input_4_20mA/Analog_input_4_20mA.ino +++ b/examples/Analog_input/Analog_input_4_20mA/Analog_input_4_20mA.ino @@ -3,7 +3,7 @@ This example provides the current value acquired by the Machine Control. For each channel of the ANALOG IN - connector, there is a 120 ohm resistor to GND. The current + connector, there is a 120 ohm resistor to GND. The current of the 4-20mA sensor flows through it, generating a voltage which is sampled by the Portenta's ADC. To use the 4-20mA functionality, a 24V supply on diff --git a/examples/Digital_output/Digital_output.ino b/examples/Digital_output/Digital_output.ino index cb7a893..48c4059 100644 --- a/examples/Digital_output/Digital_output.ino +++ b/examples/Digital_output/Digital_output.ino @@ -13,11 +13,11 @@ different behaviors, and it is the same for all channels: 1) Latch mode: when the over current is detected the channel is opened, and will remain opened until - it will be toggle via software. + it is toggled via software. 2) Auto retry: when the over current is detected - the channel is openend, but after some tents of + the channel is opened, but after some tens of milliseconds the channel will automatically try - to close itself again. In case of a persistant + to close itself again. In case of a persistent overcurrent the channel will continuously toggle. The circuit: @@ -33,7 +33,7 @@ using namespace machinecontrol; void setup() { Serial.begin(9600); - // The loop starts only when the serial monitor is opened. + // The loop starts only when the Serial Monitor is opened. while (!Serial); //Set over current behavior of all channels to latch mode: @@ -53,7 +53,7 @@ void loop() { // Set all channels to CLOSED digital_outputs.setAll(255); - Serial.print("All channels are CLOSED for 1s..."); + Serial.print("All channels are CLOSED for 1 s..."); delay(1000); // Set all channels to OPEN @@ -61,52 +61,52 @@ void loop() { Serial.println("now they are OPEN."); delay(1000); - // Toggle each channel for 1s, one by one + // Toggle each channel for 1 s, one by one digital_outputs.set(0, HIGH); - Serial.print("CH0 is CLOSED for 1s..."); + Serial.print("CH0 is CLOSED for 1 s..."); delay(1000); digital_outputs.set(0, LOW); Serial.println("now is OPEN."); digital_outputs.set(1, HIGH); - Serial.print("CH1 is CLOSED for 1s..."); + Serial.print("CH1 is CLOSED for 1 s..."); delay(1000); digital_outputs.set(1, LOW); Serial.println("now is OPEN."); digital_outputs.set(2, HIGH); - Serial.print("CH2 is CLOSED for 1s..."); + Serial.print("CH2 is CLOSED for 1 s..."); delay(1000); digital_outputs.set(2, LOW); Serial.println("now is OPEN."); digital_outputs.set(3, HIGH); - Serial.print("CH3 is CLOSED for 1s..."); + Serial.print("CH3 is CLOSED for 1 s..."); delay(1000); digital_outputs.set(3, LOW); Serial.println("now is OPEN."); digital_outputs.set(4, HIGH); - Serial.print("CH4 is CLOSED for 1s..."); + Serial.print("CH4 is CLOSED for 1 s..."); delay(1000); digital_outputs.set(4, LOW); Serial.println("now is OPEN."); digital_outputs.set(5, HIGH); - Serial.print("CH5 is CLOSED for 1s..."); + Serial.print("CH5 is CLOSED for 1 s..."); delay(1000); digital_outputs.set(5, LOW); Serial.println("now is OPEN."); digital_outputs.set(6, HIGH); - Serial.print("CH6 is CLOSED for 1s..."); + Serial.print("CH6 is CLOSED for 1 s..."); delay(1000); digital_outputs.set(6, LOW); Serial.println("now is OPEN."); digital_outputs.set(7, HIGH); - Serial.print("CH7 is CLOSED for 1s..."); + Serial.print("CH7 is CLOSED for 1 s..."); delay(1000); digital_outputs.set(7, LOW); Serial.println("now is OPEN."); diff --git a/examples/Digital_programmable/Digital_input/Digital_input.ino b/examples/Digital_programmable/Digital_input/Digital_input.ino index cef7532..d33c652 100644 --- a/examples/Digital_programmable/Digital_input/Digital_input.ino +++ b/examples/Digital_programmable/Digital_input/Digital_input.ino @@ -18,7 +18,7 @@ using namespace machinecontrol; void setup() { Serial.begin(9600); - //The loop starts only when the serial monitor is opened. + //The loop starts only when the Serial Monitor is opened. while(!Serial); Wire.begin(); diff --git a/examples/RS485_fullduplex/RS485_fullduplex.ino b/examples/RS485_fullduplex/RS485_fullduplex.ino index 034a7d5..26dd8b4 100644 --- a/examples/RS485_fullduplex/RS485_fullduplex.ino +++ b/examples/RS485_fullduplex/RS485_fullduplex.ino @@ -9,7 +9,7 @@ Circuit: - Portenta H7 - Machine Control - - A Slave device with RS485 inteface + - A Slave device with RS485 interface */ @@ -34,8 +34,8 @@ void setup() comm_protocols.rs485.sel_485 = 1; // RS485_RS232_N comm_protocols.rs485.half_duplex = 0; // HALF_FULL_N comm_protocols.rs485.receive(); // RE_N - comm_protocols.rs485.fd_tx_term = 1; // FD_TX_TERM - 120 Ohm Y-Z termination enabled when both TERM and FD_TX_TERM are high - comm_protocols.rs485.term = 1; // TERM - 120 Ohm A-B termination enabled when high + comm_protocols.rs485.fd_tx_term = 1; // FD_TX_TERM - 120 ohm Y-Z termination enabled when both TERM and FD_TX_TERM are high + comm_protocols.rs485.term = 1; // TERM - 120 ohm A-B termination enabled when high Serial.println("Initialization done!"); } diff --git a/examples/RTC_Alarm/RTC_Alarm.ino b/examples/RTC_Alarm/RTC_Alarm.ino index 3e747da..bc727ff 100644 --- a/examples/RTC_Alarm/RTC_Alarm.ino +++ b/examples/RTC_Alarm/RTC_Alarm.ino @@ -36,7 +36,7 @@ void setup() { Serial.println("Initialization Done!"); - // APIs to set date's fields:hours, minutes and seconds + // APIs to set date's fields: hours, minutes and seconds rtc_controller.setHours(hours); rtc_controller.setMinutes(minutes); rtc_controller.setSeconds(seconds); diff --git a/examples/Temp_probes_RTD/Temp_probes_RTD.ino b/examples/Temp_probes_RTD/Temp_probes_RTD.ino index 7ab3593..e86d0b5 100644 --- a/examples/Temp_probes_RTD/Temp_probes_RTD.ino +++ b/examples/Temp_probes_RTD/Temp_probes_RTD.ino @@ -2,10 +2,10 @@ Machine Control - Temperature probes RTD example This example provides a way to test the 3-wire RTDs - on the Machine control Carrier. It is possibile to + on the Machine control Carrier. It is possible to acquire 2-wire RTD simply by shorting the RTDx pin to the TPx pin. The Machine control carrier has on - board a precise 400ohm 0.1% reference resistor which + board a precise 400 ohm 0.1% reference resistor which is used as a reference by the MAX31865. The circuit: diff --git a/examples/Temp_probes_Thermocouples/Temp_probes_Thermocouples.ino b/examples/Temp_probes_Thermocouples/Temp_probes_Thermocouples.ino index 87a797a..8f46aa8 100644 --- a/examples/Temp_probes_Thermocouples/Temp_probes_Thermocouples.ino +++ b/examples/Temp_probes_Thermocouples/Temp_probes_Thermocouples.ino @@ -31,7 +31,7 @@ void setup() { } void loop() { - //Set CH0, has internal 150ms delay + //Set CH0, has internal 150 ms delay temp_probes.selectChannel(0); //Take CH0 measurement float temp_ch0 = temp_probes.tc.readTemperature(); @@ -39,7 +39,7 @@ void loop() { Serial.print(temp_ch0); Serial.println(); - //Set CH1, has internal 150ms delay + //Set CH1, has internal 150 ms delay temp_probes.selectChannel(1); //Take CH1 measurement float temp_ch1 = temp_probes.tc.readTemperature(); @@ -47,7 +47,7 @@ void loop() { Serial.print(temp_ch1); Serial.println(); - //Set CH2, has internal 150ms delay + //Set CH2, has internal 150 ms delay temp_probes.selectChannel(2); //Take CH2 measurement float temp_ch2 = temp_probes.tc.readTemperature(); diff --git a/examples/USB_host/USB_host.ino b/examples/USB_host/USB_host.ino index 83e40c5..3ba9c63 100644 --- a/examples/USB_host/USB_host.ino +++ b/examples/USB_host/USB_host.ino @@ -161,4 +161,4 @@ static int process_key(tusbh_ep_info_t* ep, const uint8_t* keys) tusbh_set_keyboard_led(ep, key_leds); } return 0; -} \ No newline at end of file +} diff --git a/src/MachineControl.h b/src/MachineControl.h index 3fb1485..2fe6102 100644 --- a/src/MachineControl.h +++ b/src/MachineControl.h @@ -54,7 +54,7 @@ static mbed::CAN _can(PB_8, PH_13); class COMMClass { public: - // to be tested: cjeck if can be made a big pin initialization + // to be tested: check if can be made a big pin initialization void init() { //SHUTDOWN OF RS485 LEDS digitalWrite(PA_0, LOW); diff --git a/src/utility/RTC/PCF8563T.cpp b/src/utility/RTC/PCF8563T.cpp index 1edf272..7998a9d 100644 --- a/src/utility/RTC/PCF8563T.cpp +++ b/src/utility/RTC/PCF8563T.cpp @@ -28,7 +28,7 @@ #define PCF8563T_MONTHS_REG 0x07 #define PCF8563T_YEARS_REG 0x08 -// allarm managemet +// allarm management #define PCF8563T_MINUTE_ALARM_REG 0x09 #define PCF8563T_MINUTE_ALARM_AE_M_MASK 0x80 #define PCF8563T_MINUTE_ALARM_ON 0x7F diff --git a/src/utility/THERMOCOUPLE/MAX31855.cpp b/src/utility/THERMOCOUPLE/MAX31855.cpp index 7215886..6053867 100644 --- a/src/utility/THERMOCOUPLE/MAX31855.cpp +++ b/src/utility/THERMOCOUPLE/MAX31855.cpp @@ -84,7 +84,7 @@ float MAX31855Class::readTemperature(int type) return NAN; } // The temperature is stored in the last 14 word's bits - // sendend by the Thermocouple-to-Digital Converter + // sent by the Thermocouple-to-Digital Converter if (rawword & 0x80000000) { // Negative value, drop the lower 18 bits and explicitly extend sign bits. rawword = 0xFFFFC000 | ((rawword >> 18) & 0x00003FFFF); @@ -113,7 +113,7 @@ float MAX31855Class::readReferenceTemperature(int type) rawword >>= 4; // The cold junction reference temperature is stored in the first 11 word's bits - // sendend by the Thermocouple-to-Digital Converter + // sent by the Thermocouple-to-Digital Converter rawword = rawword & 0x7FF; // check sign bit and convert to negative value. if (rawword & 0x800) {