Develop

.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/changelog_reminder.yaml

@@ -5,7 +5,7 @@ jobs:
     name: Changelog Reminder
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v5
         with:
           persist-credentials: false # otherwise, the token used is the GITHUB_TOKEN, instead of your personal token
 

.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
@@ -17,9 +18,6 @@ $RECYCLE.BIN/
 # Windows shortcuts
 *.lnk
 
-# Microsoft Office temp files
-~$*
-
 # =========================
 # Operating System Files
 # =========================
@@ -49,117 +47,76 @@ 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/*
-
-# Prerequisites
-*.d
-
-# Compiled Object files
-*.slo
-*.lo
-*.o
-*.obj
-
-# Precompiled Headers
-*.gch
-*.pch
-
-# Compiled Dynamic libraries
-*.so
-*.dylib
-*.dll
-
-# Fortran module files
-*.mod
-*.smod
-
-# Compiled Static libraries
-*.lai
-*.la
-*.a
-*.lib
-
-# Executables
-*.exe
-*.out
-*.app
+.sconsign.dblite
 
 # VSCode
+.vscode/.browse.c_cpp.db*
+.vscode/c_cpp_properties.json
+.vscode/launch.json
 .vscode
-
-
-# Ignore list for Eagle, a PCB layout tool
-
-# Backup files
-*.s#?
-*.b#?
-*.l#?
-*.b$?
-*.s$?
-*.l$?
-
-# Eagle project file
-# It contains a serial number and references to the file structure
-# on your computer.
-# comment the following line if you want to have your project file included.
-eagle.epf
-
-# Autorouter files
-*.pro
-*.job
-
-# CAM files
-*.$$$
-*.cmp
-*.ly2
-*.l15
-*.sol
-*.plc
-*.stc
-*.sts
-*.crc
-*.crs
-
-*.dri
-*.drl
-*.gpi
-*.pls
-*.ger
-*.xln
-
-*.drd
-*.drd.*
-
-*.s#*
-*.b#*
-
-*.info
-
-*.eps
-
-# file locks introduced since 7.x
-*.lck
 .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,23 @@ This project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.htm
 
 ***
 
+## [0.1.2]
+
+### Changed
+
+- Updated doxygen formatting
+- Bumped SensorModbusMaster dependency
+
+### Added
+
+- Added code spell configurations
+
+### Fixed
+
+- Fixed spelling errors
+
+***
+
 ## [0.1.1]
 
 ### Changed
@@ -34,6 +51,7 @@ This project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.htm
 - Added keywords.txt for Arduino IDE
 
 ***
+
 ### Fixed
 
 ***
@@ -44,5 +62,7 @@ Initial release
 
 ***
 
-[Unreleased]: https://github.com/EnviroDIY/GroPointModbus/compare/v0.1.1...HEAD
+[Unreleased]: https://github.com/EnviroDIY/GroPointModbus/compare/v0.1.2...HEAD
+[0.1.2]: https://github.com/EnviroDIY/GroPointModbus/releases/tag/v0.1.2
+[0.1.1]: https://github.com/EnviroDIY/GroPointModbus/releases/tag/v0.1.1
 [0.1.0]: https://github.com/EnviroDIY/GroPointModbus/releases/tag/v0.1.0

README.md

@@ -1,3 +1,21 @@
-# GroPointModbus<!-- {#mainpage} -->
+# GroPointModbus<!--! {#mainpage} -->
 
 A library to use an Arduino as a master to control and communicate via modbus with GroPoint soil moisture sensors. Depends on the EnviroDIY/SensorModbusMaster library.
+
+<!--! @tableofcontents -->
+
+<!--! @m_footernavigation -->
+
+<!--! @if GITHUB -->
+
+- [GroPointModbus](#gropointmodbus)
+  - [Library installation](#library-installation)
+
+<!--! @endif -->
+
+## 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/GroPointModbus)
+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/GroPointModbus/).

VERSION

@@ -1 +1 @@
-0.1.1
+0.1.2

cspell.json

@@ -0,0 +1,80 @@
+{
+  "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": [
+    "Aufdenkampe",
+    "Damiano",
+    "datasheet",
+    "DERE",
+    "doxyfile",
+    "enviro_diy",
+    "EnviroDIY",
+    "Geleskie",
+    "GPLP",
+    "GPLPX",
+    "Gropoint",
+    "microsiemens",
+    "millisiemens",
+    "Modbus",
+    "SRGD",
+    "SRGDamia1",
+    "SWSERIAL",
+    "USBVIRTUAL",
+    "YosemiTech"
+  ],
+  "ignoreWords": [],
+  "ignorePaths": ["platformio.ini", "*doxyfile*", ".vscode"]
+}