Skip to content

Commit d73dc5b

Browse files
committed
Update Doc
1 parent 2506ccb commit d73dc5b

File tree

143 files changed

+762
-10895
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

143 files changed

+762
-10895
lines changed

.github/stale.yml

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
# Number of days of inactivity before an issue becomes stale
2+
daysUntilStale: 7
3+
# Number of days of inactivity before a stale issue is closed
4+
daysUntilClose: 7
5+
# Issues with these labels will never be considered stale
6+
exemptLabels:
7+
- pinned
8+
- bug
9+
# Label to use when marking an issue as stale
10+
staleLabel: stale
11+
# Comment to post when marking an issue as stale. Set to `false` to disable
12+
markComment: >
13+
This issue has gone quiet. Spooky quiet.
14+
We currently close issues after 14 days of inactivity. It’s been at least 7 days since the last update here.
15+
If we missed this issue or if you want to keep it open, please reply here.
16+
As a friendly reminder, the best way to fix this or any other problem is to provide a detailed error description including a serial log.
17+
Thanks for being a part of the epsilonrt community!
18+
# Comment to post when closing a stale issue. Set to `false` to disable
19+
closeComment: >
20+
Hey again!
21+
It’s been 14 days since anything happened on this issue, so our friendly robot (that’s me!) is going to close it.
22+
Please keep in mind that I’m only a robot, so if I’ve closed this issue in error, I’m `HUMAN_EMOTION_SORRY`. Please feel free to comment on this issue or create a new one if you need anything else.
23+
As a friendly reminder, the best way to fix this or any other problem is to provide a detailed error description including a serial log.
24+
Thanks again for being a part of the epsilonrt community!
Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
name: Doxygen GitHub Pages Deploy Action
2+
3+
on:
4+
push:
5+
branches:
6+
- master
7+
workflow_dispatch:
8+
9+
jobs:
10+
deploy:
11+
runs-on: ubuntu-latest
12+
steps:
13+
- uses: DenverCoder1/doxygen-github-pages-action@v1.2.0
14+
with:
15+
github_token: ${{ secrets.GITHUB_TOKEN }}
16+
branch: gh-pages
17+
folder: docs
18+
config_file: Doxyfile

doc/Doxyfile.in renamed to Doxyfile

Lines changed: 713 additions & 368 deletions
Large diffs are not rendered by default.

README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -91,12 +91,12 @@ By opting for Modbus Serial or Modbus TCP you must include in your sketch the co
9191
In this library was decided to use the terms used in Modbus to the methods names, then is important clarify the names of
9292
register types:
9393

94-
| Register type | Use as | Access | Library methods |
95-
| -------------------- | ------------------ | ----------------- | --------------------- |
96-
| Coil | Digital Output | Read/Write | addCoil(), Coil() |
97-
| Holding Register | Analog Output | Read/Write | addHreg(), Hreg() |
98-
| Input Status | Digital Input | Read Only | addIsts(), Ists() |
99-
| Input Register | Analog Input | Read Only | addIreg(), Ireg() |
94+
| Register type | Use as | Access | Library methods |
95+
| -------------------- | ------------------ | ----------------- | ----------------------------- |
96+
| Coil | Digital Output | Read/Write | addCoil(), coil(), setCoil() |
97+
| Holding Register | Analog Output | Read/Write | addHreg(), hreg(), setHreg() |
98+
| Input Status | Digital Input | Read Only | addIsts(), ists(), setIsts() |
99+
| Input Register | Analog Input | Read Only | addIreg(), ireg(), setIreg() |
100100

101101
**Notes:**
102102

doc/DoxygenLayout.xml

Lines changed: 0 additions & 194 deletions
This file was deleted.

doc/Makefile

Lines changed: 0 additions & 71 deletions
This file was deleted.

doc/build_main_page.sh

Lines changed: 0 additions & 23 deletions
This file was deleted.

0 commit comments

Comments
 (0)