Merge pull request #35 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/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
 

.gitignore

@@ -165,3 +165,13 @@ sync.ffs_db
 runDoxygen_args.bat
 docs/markdown_prefilter.py
 docs/Doxyfile.bak
+clang_format_all.bat
+clang-format-all.py
+installWorkingDependencies.bat
+run_mcss.bat
+pio_common_libdeps.ini
+Ubuntu-Bold.ttf
+docs/clipboard.js
+docs/enviroDIY_favicon.png
+docs/css/m-EnviroDIY+documentation.compiled.css
+docs/examples.dox

ChangeLog.md

@@ -20,6 +20,23 @@ This project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.htm
 
 ***
 
+## [1.0.0]
+
+### Added
+
+- Added functions to read coils
+- Added functions to write single and multiple coils
+- Added functions to read discrete inputs
+- Added functions to read holding and input registers without requiring the command type as input
+- Added functions to read coils, discrete inputs, holding, and input registers into a user buffer
+- Added code spell configuration
+
+### Fixed
+
+- Fixed spelling errors
+
+***
+
 ## [0.7.3]
 
 ### Changed
@@ -80,7 +97,7 @@ This information can now be found in its [own repository](https://github.com/Env
 
 ### Added
 
-- Added documetation for the wing shield.
+- Added documentation for the wing shield.
 
 ***
 
@@ -97,7 +114,7 @@ This information can now be found in its [own repository](https://github.com/Env
 ### Fixed
 
 - Fixed attoseconds for TAI64NA time formats.
-- Fixed compiler warnings when compiling with stricter -Wextra flag.
+- Fixed compiler warnings when compiling with stricter `-Wextra` flag.
 
 ***
 
@@ -168,7 +185,10 @@ This information can now be found in its [own repository](https://github.com/Env
 
 ***
 
-[Unreleased]: https://github.com/EnviroDIY/SensorModbusMaster/compare/v0.7.0...HEAD
+[Unreleased]: https://github.com/EnviroDIY/SensorModbusMaster/compare/v1.0.0...HEAD
+[1.0.0]: https://github.com/EnviroDIY/SensorModbusMaster/releases/tag/v0.7.3
+[0.7.3]: https://github.com/EnviroDIY/SensorModbusMaster/releases/tag/v0.7.3
+[0.7.2]: https://github.com/EnviroDIY/SensorModbusMaster/releases/tag/v0.7.2
 [0.7.1]: https://github.com/EnviroDIY/SensorModbusMaster/releases/tag/v0.7.1
 [0.7.0]: https://github.com/EnviroDIY/SensorModbusMaster/releases/tag/v0.7.0
 [0.6.8]: https://github.com/EnviroDIY/SensorModbusMaster/releases/tag/v0.6.8
@@ -178,7 +198,6 @@ This information can now be found in its [own repository](https://github.com/Env
 [0.5.3]: https://github.com/EnviroDIY/SensorModbusMaster/releases/tag/v0.5.3
 [0.5.2]: https://github.com/EnviroDIY/SensorModbusMaster/releases/tag/v0.5.2
 [0.4.8]: https://github.com/EnviroDIY/SensorModbusMaster/releases/tag/v0.4.8
-[0.4.7]: https://github.com/EnviroDIY/SensorModbusMaster/releases/tag/v0.4.7
 [0.4.3]: https://github.com/EnviroDIY/SensorModbusMaster/releases/tag/v0.4.3
 [0.4.0]: https://github.com/EnviroDIY/SensorModbusMaster/releases/tag/v0.4.0
 [0.1.2]: https://github.com/EnviroDIY/SensorModbusMaster/releases/tag/v0.1.2

README.md

@@ -1,4 +1,4 @@
-# SensorModbusMaster<!-- {#mainpage} -->
+# SensorModbusMaster<!--! {#mainpage} -->
 
 This library is designed to use an Arduino as a Modbus master to communicate with a sensor/slave via the [Modbus RTU](https://en.wikipedia.org/wiki/Modbus) communication protocol.
 It's specifically written with lots of "higher-level" functions to help out users who are largely unfamiliar with the Modbus protocol and want an easy way to get information from a Modbus device.
@@ -84,7 +84,7 @@ You need the following data from your Modbus map:
   - All input registers are read-only.
 If your map says a register is read/write (R/W), it is a holding register.
 - the register or coil number the data is stored in
-- the format of data within the registers/coils (ie, float, integer, bitmask, ascii text)
+- the format of data within the registers/coils (ie, float, integer, bit mask, ascii text)
 - whether multi-register numeric data is stored as ["big-endian" or "little-endian"](https://en.wikipedia.org/wiki/Endianness) values (That is, is it high _word_ first or low _word_ first.
 There are no specifications for this.)
 - whether single-register data is stored "big-endian" or "little-endian" (That is, is it high _byte_ first or low _byte_ first.
@@ -178,7 +178,7 @@ Again, mind your voltages and the method of direction control.
 
 ## Hardware interface suggestions for EnviroDIY Mayfly
 
-For use with the [EnviroDIY Mayfly datalogger](https://github.com/EnviroDIY/EnviroDIY_Mayfly_Logger) and other Arduino framework boards, you will likely need some additional [Hardware for using ModbusRTU with RS-485 on Arduino](https://github.com/EnviroDIY/SensorModbusMaster/tree/master/hardware).
+For use with the [EnviroDIY Mayfly data logger](https://github.com/EnviroDIY/EnviroDIY_Mayfly_Logger) and other Arduino framework boards, you will likely need some additional [Hardware for using ModbusRTU with RS-485 on Arduino](https://github.com/EnviroDIY/SensorModbusMaster/tree/master/hardware).
 
 We have developed a [Modbus-Mayfly-WingShield](https://github.com/EnviroDIY/SensorModbusMaster/tree/master/hardware/Modbus-Mayfly_WingShield) that combines AltSoftSerial TTL to RS-485 conversion with an optional power boost to 9V or 12V.
 This has worked quite well for us for a variety of deployment configurations and sensors.

VERSION

@@ -1 +1 @@
-0.7.3
+1.0.0

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": [
+    "attosecond",
+    "attoseconds",
+    "Aufdenkampe",
+    "Damiano",
+    "datasheet",
+    "doxyfile",
+    "enviro_diy",
+    "EnviroDIY",
+    "Geleskie",
+    "Modbus",
+    "neilh10",
+    "SRGD",
+    "SRGDamia1",
+    "USBVIRTUAL",
+    "Wextra",
+    "YosemiTech"
+  ],
+  "ignoreWords": [],
+  "ignorePaths": ["platformio.ini", "*doxyfile*", ".vscode"]
+}