Skip to content

Commit cc1cac1

Browse files
committed
Update doxygen config, fix spelling errors
Signed-off-by: Sara Damiano <sdamiano@stroudcenter.org>
1 parent 758113b commit cc1cac1

32 files changed

Lines changed: 1562 additions & 1397 deletions

File tree

.github/workflows/build_documentation.yaml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,9 @@ jobs:
3333
name: Build documentation
3434
uses: EnviroDIY/workflows/.github/workflows/build_documentation.yaml@main
3535
with:
36+
use_latex: false
3637
use_graphviz: false
3738
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')}}
3839
rebuild_cache_number: 1
40+
doxygen_version: 1.14.0
3941
secrets: inherit

.github/workflows/changelog_reminder.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ jobs:
55
name: Changelog Reminder
66
runs-on: ubuntu-latest
77
steps:
8-
- uses: actions/checkout@v4
8+
- uses: actions/checkout@v5
99
with:
1010
persist-credentials: false # otherwise, the token used is the GITHUB_TOKEN, instead of your personal token
1111

.github/workflows/prepare_release.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ jobs:
3333
runs-on: ubuntu-latest
3434
steps:
3535
- name: Wait on Workflow
36-
uses: ArcticLampyrid/action-wait-for-workflow@v1.2.0
36+
uses: ArcticLampyrid/action-wait-for-workflow@v1.3.0
3737
with:
3838
workflow: ${{ matrix.req_workflow }}
3939
sha: ${{ github.sha || github.event.pull_request.head.sha || github.event.pull_request.head.ref }} # optional

.gitignore

Lines changed: 59 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -49,21 +49,25 @@ Network Trash Folder
4949
Temporary Items
5050
.apdisk
5151

52+
# Python
53+
__pycache__/
54+
5255
# PyCharm
5356
.idea/
5457

55-
# Python
56-
__pycache__/
58+
# Atom
59+
.atomrc.cson
5760

58-
# Atom / PlatformIO
59-
.pio
60-
.pioenvs
61-
.piolibdeps
61+
# PlatformIO
62+
.pio/*
6263
.clang_complete
6364
.gcc-flags.json
64-
lib/readme.txt
65+
lib/*
66+
include/*
67+
boards/*
6568
/platformio.ini
6669
tests/*
70+
.sconsign.dblite
6771

6872
# Prerequisites
6973
*.d
@@ -98,9 +102,6 @@ tests/*
98102
*.out
99103
*.app
100104

101-
# VSCode
102-
.vscode
103-
104105

105106
# Ignore list for Eagle, a PCB layout tool
106107

@@ -153,13 +154,56 @@ eagle.epf
153154

154155
# file locks introduced since 7.x
155156
*.lck
157+
158+
# VSCode
159+
.vscode/.browse.c_cpp.db*
160+
.vscode/c_cpp_properties.json
161+
.vscode/launch.json
162+
.vscode
156163
.history
157-
compile_commands.json
158164

159-
# Other Stuff
160-
pioScripts
165+
# Certificates
166+
*.pem
167+
*.pem.crt
168+
*.pem.cert
169+
*.pem.key
170+
*.crt
171+
*.cert
172+
*.key
173+
174+
# Other
175+
archive/
176+
logger_test*/
177+
ex_one_offs/*
161178
runDoxygen.bat
162-
generateKeywords.bat
179+
docs/examples/*
180+
docs/examples.dox_x
181+
platformio_extra_envs.ini
182+
src/sensors/table.md
183+
cache
163184
output_*.log
164-
sync.ffs_db
185+
clang_format_all.bat
186+
arduino_lint.md
187+
arduino_lint.json
188+
**/home/arduino/*
189+
compile_results.md
190+
arduino_cli_log.log
191+
continuous_integration/arduino_cli_local.yaml
192+
continuous_integration/platformio_ci_local.ini
193+
continuous_integration/arduino_cli_cmd.bat
194+
continuous_integration_artifacts/*
195+
arduino_cli.log
165196
docs/Doxyfile.bak
197+
generateKeywords.bat
198+
pio_common_libdeps.ini
199+
compile_commands.json
200+
sync.ffs_db
201+
.github/workflows/compile_arduino_cli.yaml
202+
.github/workflows/compile_platformio.yaml
203+
.github/workflows/determine_library_source.yaml
204+
run_mcss.bat
205+
docs/customdoxygen.css
206+
docs/footer.html
207+
docs/header.html
208+
installWorkingDependencies.bat
209+
clang-format-all.py

ChangeLog.md

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ Add Y513 Blue Green Algae (BGA) and fix examples.
2626

2727
### Changed
2828

29-
- updated Y504 to first try to get thridvalue for DOmgL before calculating it.
29+
- updated Y504 to first try to get third value for DOmgL before calculating it.
3030
- The `getValue.ino` example has better formatted outputs.
3131
- The `getSlaveID()` command now works better with broadcast address 0xFF.
3232
- NOTE that old YosemiTech sensors (before 2020??) don't have a functioning broadcast address
@@ -40,14 +40,15 @@ Add Y513 Blue Green Algae (BGA) and fix examples.
4040

4141
### Fixed
4242

43-
- The `getValue.ino` example wouldn't work with AltSoftSerial (see d4204ebd1212608aaf05a7a65b763e432c59fe37 and https://github.com/EnviroDIY/SensorModbusMaster/commit/f1daa2fdd22c7ec991fc2ff50330aa41e4a7a53e)
43+
- The `getValue.ino` example wouldn't work with AltSoftSerial (see d4204ebd1212608aaf05a7a65b763e432c59fe37 and <https://github.com/EnviroDIY/SensorModbusMaster/commit/f1daa2fdd22c7ec991fc2ff50330aa41e4a7a53e>)
4444
- Fixed broken links to YosemiTech product pages
4545

4646
***
4747

4848
## [0.4.2]
4949

5050
### Changed
51+
5152
- Modified example to apply to more processors.
5253

5354
### Added
@@ -89,14 +90,14 @@ Add Y700 Water Level; fix Y4000 Sonde; restore calibrators.
8990

9091
### Fixed
9192

92-
- Fixed issue with Y4000 not outputing Chl & BGA readings #13
93+
- Fixed issue with Y4000 not outputting Chl & BGA readings #13
9394
- Specified python version for GitHub actions (used by PlatformIO)
9495

9596
***
9697

9798
## [0.3.2] 2022-03-01
9899

99-
Version bump only for reindexing by PlatformIO and Arduino library managers.
100+
Version bump only for re-indexing by PlatformIO and Arduino library managers.
100101

101102
***
102103

@@ -162,7 +163,7 @@ Better Y532 pH support, updated manuals & software
162163
- Fix to Y532 pH startMeasurement return, which is required to get Y532 pH to work as a stand-alone sensor in ModularSensors. Commit 574a31c.
163164
- Updates to Windows software utilities and documentation
164165
- ModbusRunner v2.5.1.5
165-
- MulitSensor v1.9
166+
- MultiSensor v1.9
166167
- Updates to YosemiTech manuals
167168
- Updates to calibration spreadsheets & protocols. Issues #14, #16.
168169

@@ -217,4 +218,4 @@ Initial release
217218
[0.1.9]: https://github.com/EnviroDIY/YosemitechModbus/releases/tag/v0.1.9
218219
[0.1.6]: https://github.com/EnviroDIY/YosemitechModbus/releases/tag/v0.1.6
219220

220-
[//]: # ( @m_footernavigation )
221+
<!--! @m_footernavigation -->

README.md

Lines changed: 23 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Yosemitech Modbus<!-- {#mainpage} -->
1+
# Yosemitech Modbus<!--! {#mainpage} -->
22

33
A library to use an Arduino as a master to control and communicate with the sensors produced by [Yosemitech](http://en.yosemitech.com) via [Modbus RTU](https://en.wikipedia.org/wiki/Modbus) over [RS-485](https://en.wikipedia.org/wiki/RS-485).
44
This library requires the use of the [EnviroDIY/SensorModbusMaster](https://github.com/EnviroDIY/SensorModbusMaster) library.
@@ -18,15 +18,15 @@ These are some of the irregularities we have found so far:
1818
- The sensors give no response to properly formed requests for data from any registers except those few listed in the modbus manuals.
1919
(See the "doc" folder for copies of the manuals for the sensors we have.)
2020

21-
Another note: The sensors seem to be somewhat.. finickey about resolving similar addresses when several are connected to the same bus.
21+
Another note: The sensors seem to be somewhat.. finicky about resolving similar addresses when several are connected to the same bus.
2222
I recommend giving the sensors addresses a few numbers away from each other to help separate them on the bus.
2323
(That is, instead of numbering them as 0x01, 0x02, 0x03, 0x04, and 0x05 try 0x01, 0x03, 0x05, 0x07, and 0x09.)
2424

25-
[//]: # ( @tableofcontents )
25+
<!--! @tableofcontents -->
2626

27-
[//]: # ( @m_footernavigation )
27+
<!--! @m_footernavigation -->
2828

29-
[//]: # ( Start GitHub Only )
29+
<!--! @if GITHUB -->
3030

3131
- [Yosemitech Modbus](#yosemitech-modbus)
3232
- [Hardware](#hardware)
@@ -35,22 +35,23 @@ I recommend giving the sensors addresses a few numbers away from each other to h
3535
- [RS485 communication/connection](#rs485-communicationconnection)
3636
- [Receiving TTL Data](#receiving-ttl-data)
3737
- [Suggested setup with an EnviroDIY Mayfly](#suggested-setup-with-an-envirodiy-mayfly)
38+
- [Library installation](#library-installation)
3839

39-
[//]: # ( End GitHub Only )
40+
<!--! @endif -->
4041

41-
## Hardware<!-- {#mainpage_hardware} -->
42+
## Hardware<!--! {#mainpage_hardware} -->
4243

43-
### Power Supply<!-- {#mainpage_power} -->
44+
### Power Supply<!--! {#mainpage_power} -->
4445

4546
All of these sensors require a 5-12V DC power supply and the power supply can be stopped between measurements.
4647
Older sensors may require higher voltage power supplies.
47-
Do note that any time the sensor looses power, some internal configurations (such as brushing interval for sensors with wipers) will be reset to their factory values, whereas other internal configurations (such as calibration coefficiencts) are saved..
48+
Do note that any time the sensor looses power, some internal configurations (such as brushing interval for sensors with wipers) will be reset to their factory values, whereas other internal configurations (such as calibration coefficients) are saved..
4849
The red wire from the sensor should connect to the positive pole of the 5-12V power supply and the black to ground.
4950

50-
#### Current Consumption<!-- {#mainpage_current} -->
51+
#### Current Consumption<!--! {#mainpage_current} -->
5152

5253
The current consumption of the Yosemitech sensors is specified to be <50mA, this is not accurate for their sensors which include a wiper brush, for these sensors an inductive spike exists when the brush begins to spin, which draws significantly more current than specified.
53-
Below is a table describing the current draws for several different opeating conditions of the Yosemitech 511 Turbidity senor (with brush).
54+
Below is a table describing the current draws for several different operating conditions of the Yosemitech 511 Turbidity senor (with brush).
5455
All tests were driven by a power supply with a 9v output
5556

5657
| Condition | Current |
@@ -61,11 +62,11 @@ All tests were driven by a power supply with a 9v output
6162
| Idle | 7mA |
6263

6364
Note <sup>1</sup>: The current on brush start can be seen in the image below, where the yellow line shows current into the sensor with a gain of 10 V/A, and the blue line is the output voltage to the sensor.
64-
The spike peak is approximately 290mA, with an exponential decay over the next 10-15ms, while this is short, it is more than enough time to brown out many low current power supplies found in data logger systems, so appropriate percautions must be taken to avoid this problem.
65+
The spike peak is approximately 290mA, with an exponential decay over the next 10-15ms, while this is short, it is more than enough time to brown out many low current power supplies found in data logger systems, so appropriate precautions must be taken to avoid this problem.
6566

6667
![CurrentSpike](doc/TEK00013.PNG)
6768

68-
### RS485 communication/connection<!-- {#mainpage_rs485} -->
69+
### RS485 communication/connection<!--! {#mainpage_rs485} -->
6970

7071
The sensors need to communicate with the Arduino via a RS485-to-TTL adapter.
7172
The white wire of the Yosemitech sensor will connect to the "B" pin of the adapter and the green wire will connect to "A".
@@ -76,17 +77,24 @@ Also, be mindful of the logic level of the TTL output by the adapter.
7677
The MAX485, one of the most popular adapters, has a 5V logic level in the TTL signal.
7778
Up to 247 different devices can be connected in the same RS485 circuit, provided that each sensor has been separately assigned a uniques slave id.
7879

79-
### Receiving TTL Data<!-- {#mainpage_ttl} -->
80+
### Receiving TTL Data<!--! {#mainpage_ttl} -->
8081

8182
If possible, always connect the RS485 adapter so the TTL signal is going to a Hardware Serial port on the Arduino.
8283
Hardware serial ports are more stable than software/pin change serial emulation.
8384
If you do not have an available hardware serial port, [AltSoftSerial](https://github.com/PaulStoffregen/AltSoftSerial) is probably the best Arduino alternative, if your board is supported.
8485
[NeoSWSerial](https://github.com/SlashDevin/NeoSWSerial) is also a decent alternative at the Yosemitech's 9600 baud.
8586
Use the standard Arduino SoftwareSerial if nothing else is available, but be aware that some sensors may not respond correctly.
8687

87-
## Suggested setup with an EnviroDIY Mayfly<!-- {#mainpage_mayfly} -->
88+
## Suggested setup with an EnviroDIY Mayfly<!--! {#mainpage_mayfly} -->
8889

8990
We suggest using a [Modbus-Mayfly_WingShield](https://github.com/EnviroDIY/SensorModbusMaster/tree/master/hardware/Modbus-Mayfly_WingShield), which combines this [TTL to RS485 Adapter / 485 to Serial Port UART Level Converter Module (XY-017)](https://www.amazon.com/gp/product/B06XHH6B6R) with a step-up boost regulator and capacitors.
9091
Plans to construct one can be found at <https://github.com/EnviroDIY/SensorModbusMaster/tree/master/hardware/Modbus-Mayfly_WingShield>.
9192

9293
<img src="https://github.com/EnviroDIY/SensorModbusMaster/blob/master/hardware/Modbus-Mayfly_WingShield/Photos/IMG_6733.JPG" width="600">
94+
95+
## Library installation
96+
97+
This library is available through both the Arduino and PlatformIO library registries.
98+
[Here is the PlatformIO registry page.](https://registry.platformio.org/libraries/envirodiy/YosemitechModbus)
99+
Use the Arduino IDE to find the library in that registry.
100+
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/YosemitechModbus/).

cspell.json

Lines changed: 82 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,82 @@
1+
{
2+
"language": "en-US",
3+
"ignoreRegExpList": [
4+
"header-defines",
5+
"doxygen-commands",
6+
"doxygen-commands-custom",
7+
"example_tags"
8+
],
9+
"patterns": [
10+
{
11+
"name": "header-defines",
12+
"pattern": "/SRC_[A-Z0-9_]+_H_/g"
13+
},
14+
{
15+
"name": "latex-command",
16+
"pattern": "/\\\\\\\\[a-z]+/g"
17+
},
18+
{
19+
"name": "javadoc-command",
20+
"pattern": "/@[a-z_]+/g"
21+
},
22+
{
23+
"name": "doxygen-commands",
24+
"pattern": ["latex-command", "javadoc-command"]
25+
},
26+
{
27+
"name": "hash-reference",
28+
"pattern": "/#[a-z0-9_]+/g"
29+
},
30+
{
31+
"name": "ref-command",
32+
"pattern": "/@ref\\s[a-z0-9_]+/g"
33+
},
34+
{
35+
"name": "anchor-command",
36+
"pattern": "/@anchor\\s[a-z0-9_]+/g"
37+
},
38+
{
39+
"name": "group-command",
40+
"pattern": "/@(?:def|in)group\\s[a-z0-9_]+/g"
41+
},
42+
{
43+
"name": "section-command",
44+
"pattern": "/@(?:sub)*section\\s[a-z0-9_]+/g"
45+
},
46+
{
47+
"name": "doxygen-commands-custom",
48+
"pattern": [
49+
"hash-reference",
50+
"ref-command",
51+
"anchor-command",
52+
"group-command",
53+
"section-command"
54+
]
55+
}
56+
],
57+
"words": [
58+
"Adafruit",
59+
"Aufdenkampe",
60+
"Damiano",
61+
"datasheet",
62+
"DERE",
63+
"doxyfile",
64+
"enviro_diy",
65+
"EnviroDIY",
66+
"Espressif",
67+
"Geleskie",
68+
"Modbus",
69+
"OLED",
70+
"sondes",
71+
"SRGD",
72+
"SRGDamia1",
73+
"SWSERIAL",
74+
"Turb",
75+
"UART",
76+
"USBVIRTUAL",
77+
"wipered",
78+
"YosemiTech"
79+
],
80+
"ignoreWords": [],
81+
"ignorePaths": ["platformio.ini", "*doxyfile*", ".vscode"]
82+
}

0 commit comments

Comments
 (0)