Merge pull request #11 from EnviroDIY/develop

Develop

Author: SRGDamia1

.github/workflows/build_documentation.yaml

@@ -33,7 +33,9 @@ jobs:
     name: Build documentation
     uses: EnviroDIY/workflows/.github/workflows/build_documentation.yaml@main
     with:
+      use_latex: false
       use_graphviz: false
       publish: ${{ (github.event_name == 'release' && github.event.action == 'published') || (github.event_name == 'workflow_run' && github.event.workflow_run.conclusion == 'success')  || (github.event_name == 'workflow_dispatch' && github.event.inputs.publish == 'true')}}
       rebuild_cache_number: 1
+      doxygen_version: 1.14.0
     secrets: inherit

.github/workflows/prepare_release.yaml

@@ -33,7 +33,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Wait on Workflow
-        uses: ArcticLampyrid/action-wait-for-workflow@v1.2.0
+        uses: ArcticLampyrid/action-wait-for-workflow@v1.3.0
         with:
           workflow: ${{ matrix.req_workflow }}
           sha: ${{ github.sha || github.event.pull_request.head.sha || github.event.pull_request.head.ref }} # optional

.gitignore

@@ -1,6 +1,7 @@
 # Windows image file caches
 Thumbs.db
 ehthumbs.db
+~*
 
 # Folder config file
 Desktop.ini
@@ -49,21 +50,25 @@ Network Trash Folder
 Temporary Items
 .apdisk
 
+# Python
+__pycache__/
+
 # PyCharm
 .idea/
 
-# Python
-__pycache__/
+# Atom
+.atomrc.cson
 
-# Atom / PlatformIO
-.pio
-.pioenvs
-.piolibdeps
+# PlatformIO
+.pio/*
 .clang_complete
 .gcc-flags.json
-lib/readme.txt
+lib/*
+include/*
+boards/*
 /platformio.ini
 tests/*
+.sconsign.dblite
 
 # Prerequisites
 *.d
@@ -98,9 +103,6 @@ tests/*
 *.out
 *.app
 
-# VSCode
-.vscode
-
 
 # Ignore list for Eagle, a PCB layout tool
 
@@ -153,13 +155,58 @@ eagle.epf
 
 # file locks introduced since 7.x
 *.lck
+
+# VSCode
+.vscode/.browse.c_cpp.db*
+.vscode/c_cpp_properties.json
+.vscode/launch.json
+.vscode
 .history
-compile_commands.json
 
-# Other Stuff
-pioScripts
+# Certificates
+*.pem
+*.pem.crt
+*.pem.cert
+*.pem.key
+*.crt
+*.cert
+*.key
+
+# Other
+archive/
+compile_tests/
+logger_test*/
+ex_one_offs/*
 runDoxygen.bat
-generateKeywords.bat
+docs/examples/*
+docs/examples.dox_x
+platformio_extra_envs.ini
+src/sensors/table.md
+cache
 output_*.log
-sync.ffs_db
+clang_format_all.bat
+arduino_lint.md
+arduino_lint.json
+**/home/arduino/*
+compile_results.md
+arduino_cli_log.log
+continuous_integration/arduino_cli_local.yaml
+continuous_integration/platformio_ci_local.ini
+continuous_integration/arduino_cli_cmd.bat
+continuous_integration_artifacts/*
+arduino_cli.log
+**/sensor_tests/*
 docs/Doxyfile.bak
+generateKeywords.bat
+pio_common_libdeps.ini
+compile_commands.json
+sync.ffs_db
+.github/workflows/compile_arduino_cli.yaml
+.github/workflows/compile_platformio.yaml
+.github/workflows/determine_library_source.yaml
+run_mcss.bat
+docs/customdoxygen.css
+docs/footer.html
+docs/header.html
+installWorkingDependencies.bat
+clang-format-all.py

ChangeLog.md

@@ -20,6 +20,21 @@ This project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.htm
 
 ***
 
+## [0.2.4]
+
+### Changed
+
+- Updated doxygen formatting
+- Bumped SensorModbusMaster dependency
+
+### Added
+
+- Added code spell configurations
+
+### Fixed
+
+- Fixed spelling errors
+
 ## [0.2.3]
 
 ### Added
@@ -56,7 +71,8 @@ Initial release
 
 ***
 
-[Unreleased]: https://github.com/EnviroDIY/KellerModbus/compare/v0.2.3...HEAD
+[Unreleased]: https://github.com/EnviroDIY/KellerModbus/compare/v0.2.4...HEAD
+[0.2.4]: https://github.com/EnviroDIY/YosemitechModbus/releases/tag/v0.2.4
 [0.2.3]: https://github.com/EnviroDIY/YosemitechModbus/releases/tag/v0.2.3
 [0.2.2]: https://github.com/EnviroDIY/YosemitechModbus/releases/tag/v0.2.2
 [0.2.1]: https://github.com/EnviroDIY/YosemitechModbus/releases/tag/v0.2.1

README.md

@@ -1,4 +1,4 @@
-# KellerModbus<!-- {#mainpage} -->
+# KellerModbus<!--! {#mainpage} -->
 
 A library to use an Arduino as a master to control and communicate via modbus with the pressure and water level sensors produced by Keller International & [Keller America](https://www.kelleramerica.com).
 
@@ -7,43 +7,51 @@ The [EnviroDIY/ModularSensor](https://github.com/EnviroDIY/ModularSensors) libra
 
 The library has been tested to work with a Keller Nanolevel and a Keller Acculevel, which is a Keller Series 30, Class 5, Group 20 sensor water level transmitter with a software/firmware version of 5.20-12.28 (i.e. made after the 2012 in the 28th week). The library should also work with all Keller sensors of the same Series/Class/Group with the same or a later software version.
 
-[//]: # ( @tableofcontents )
+<!--! @tableofcontents -->
 
-[//]: # ( @m_footernavigation )
+<!--! @m_footernavigation -->
 
-[//]: # ( Start GitHub Only )
+<!--! @if GITHUB -->
 
 - [KellerModbus](#kellermodbus)
   - [Functions](#functions)
+  - [Library installation](#library-installation)
   - [License](#license)
   - [Acknowledgments](#acknowledgments)
 
-[//]: # ( End GitHub Only )
+<!--! @endif -->
 
-## Functions<!-- {#mainpage_functions} -->
+## Functions<!--! {#mainpage_functions} -->
 
 This library only implements the following small subset of functions from those described in the [Keller Series 30 Communication Protocol Manual](https://www.kelleramerica.com/manuals-and-software/manuals/series30%20comm_protocol_e.pdf). These are:
 
 - `getSerialNumber`
-- `getValues`, for presssure and temperature
+- `getValues`, for pressure and temperature
 
 This library also calculates water depth via the following function:
 
 - `calcWaterDepthM`, based on water pressure and temperature-dependency on water density, following equation 6 from [JonesHarris1992-NIST-DensityWater.pdf](https://github.com/EnviroDIY/KellerModbus/blob/master/doc/JonesHarris1992-NIST-DensityWater.pdf).
 
-## License<!-- {#mainpage_license} -->
+## Library installation
+
+This library is available through both the Arduino and PlatformIO library registries.
+[Here is the PlatformIO registry page.](https://registry.platformio.org/libraries/envirodiy/KellerModbus)
+Use the Arduino IDE to find the library in that registry.
+The build and ingest logs for this library into the Arduino library registry are available [here](https://downloads.arduino.cc/libraries/logs/github.com/EnviroDIY/KellerModbus/).
+
+## License<!--! {#mainpage_license} -->
 
 Software sketches and code are released under the BSD 3-Clause License -- See [LICENSE.md](https://github.com/EnviroDIY/ModularSensors/blob/master/LICENSE.md) file for details.
 
 Documentation is licensed as [Creative Commons Attribution-ShareAlike 4.0](https://creativecommons.org/licenses/by-sa/4.0/) (CC-BY-SA) copyright.
 
-## Acknowledgments<!-- {#mainpage_acknowledgments} -->
+## Acknowledgments<!--! {#mainpage_acknowledgments} -->
 
 [EnviroDIY](http://envirodiy.org/)™ is presented by the Stroud Water Research Center, with contributions from a community of enthusiasts sharing do-it-yourself ideas for environmental science and monitoring.
 
-[Anthony Aufdenakmpe](https://github.com/aufdenkampe) is the primary developer of this library.
+[Anthony Aufdenkampe](https://github.com/aufdenkampe) is the primary developer of this library.
 We are grateful for the helpful technical assistance from the staff at [Keller America](https://www.kelleramerica.com).
 
-This library has benefited from the support from the following funders:
+This library has benefited from the support from the following funding sources:
 
 - [Winona State University](https://www.winona.edu), [Southeastern Minnesota Water Resources Center](https://www.winona.edu/geoscience/waterresource.asp)

VERSION

@@ -1 +1 @@
-0.2.3
+0.2.4

cspell.json

@@ -0,0 +1,77 @@
+{
+  "language": "en-US",
+  "ignoreRegExpList": [
+    "header-defines",
+    "doxygen-commands",
+    "doxygen-commands-custom",
+    "example_tags"
+  ],
+  "patterns": [
+    {
+      "name": "header-defines",
+      "pattern": "/SRC_[A-Z0-9_]+_H_/g"
+    },
+    {
+      "name": "latex-command",
+      "pattern": "/\\\\\\\\[a-z]+/g"
+    },
+    {
+      "name": "javadoc-command",
+      "pattern": "/@[a-z_]+/g"
+    },
+    {
+      "name": "doxygen-commands",
+      "pattern": ["latex-command", "javadoc-command"]
+    },
+    {
+      "name": "hash-reference",
+      "pattern": "/#[a-z0-9_]+/g"
+    },
+    {
+      "name": "ref-command",
+      "pattern": "/@ref\\s[a-z0-9_]+/g"
+    },
+    {
+      "name": "anchor-command",
+      "pattern": "/@anchor\\s[a-z0-9_]+/g"
+    },
+    {
+      "name": "group-command",
+      "pattern": "/@(?:def|in)group\\s[a-z0-9_]+/g"
+    },
+    {
+      "name": "section-command",
+      "pattern": "/@(?:sub)*section\\s[a-z0-9_]+/g"
+    },
+    {
+      "name": "doxygen-commands-custom",
+      "pattern": [
+        "hash-reference",
+        "ref-command",
+        "anchor-command",
+        "group-command",
+        "section-command"
+      ]
+    }
+  ],
+  "words": [
+    "Acculevel",
+    "Aufdenkampe",
+    "Damiano",
+    "datasheet",
+    "DERE",
+    "doxyfile",
+    "enviro_diy",
+    "EnviroDIY",
+    "Geleskie",
+    "Modbus",
+    "Nanolevel",
+    "SRGD",
+    "SRGDamia1",
+    "SWSERIAL",
+    "USBVIRTUAL",
+    "YosemiTech"
+  ],
+  "ignoreWords": [],
+  "ignorePaths": ["platformio.ini", "*doxyfile*", ".vscode"]
+}