Skip to content

Commit 1173a96

Browse files
committed
Updates for newer doxygen
Signed-off-by: Sara Damiano <sdamiano@stroudcenter.org>
1 parent e44a705 commit 1173a96

6 files changed

Lines changed: 18 additions & 5 deletions

File tree

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -167,3 +167,4 @@ run_mcss.bat
167167
installWorkingDependencies.bat
168168
clang-format-all.py
169169
clang_format_all.bat
170+
pio_common_libdeps.ini

docs/directories.dox

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -9,10 +9,6 @@
99
/**
1010
* @dir examples
1111
* @brief Contains all of the example sketches
12-
* @dir examples/GetValues
13-
* @copybrief GetValues.ino
14-
* @dir examples/ChangeModbusSettings
15-
* @copybrief ChangeModbusSettings.ino
1612
*/
1713
/**
1814
* @dir extras

examples/ChangeModbusSettings/ChangeModbusSettings.ino

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,9 @@
1616
* This sketch depends on the GropointModbus library and also loosely on the
1717
* SensorModbusMaster library via it's example sketch:
1818
* SensorModbusMaster/examples/readWriteRegister/readWriteRegister.ino
19+
*
20+
* @m_examplenavigation{example_change_modbus_settings,}
21+
* @m_footernavigation
1922
* ======================================================================= */
2023

2124
// ---------------------------------------------------------------------------

extras/ChangeParity/ChangeParity.ino

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@
1717
* SensorModbusMaster library and is based on it's example sketch:
1818
* SensorModbusMaster/examples/readWriteRegister/readWriteRegister.ino
1919
*
20-
* @m_examplenavigation{example_get_values,}
20+
* @m_examplenavigation{extras_change_parity,}
2121
* @m_footernavigation
2222
* ======================================================================= */
2323

extras/ChangeParity/ReadMe.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
# Changing the parity <!-- {#extras_change_parity} -->
2+
3+
This sketch uses hardware serial to connect with GroPoint Profile and change default modbus settings from 19200 8E1 to 9600 8N1.
4+
5+
> [!note]
6+
> GroPoint Profile sensor default Modbus communication settings are 19200 Baud, 8 Bits, Even Parity, one Stop Bit (8-E-1).
7+
> See p35 of manual. 8-N-1 (no parity) is the most common configuration for serial communications.
8+
9+
> [!warning]
10+
> Neither SoftwareSerial, AltSoftSerial, nor NeoSoftwareSerial will support either even or odd parity!

extras/ReadMe.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# Extra Helpers for GroPoint Modbus Library<!-- {#page_extras} -->
2+
3+
Some extra helpful tools for the GroPoint sensors.

0 commit comments

Comments
 (0)