Commit Graph

50 Commits

Author SHA1 Message Date
ca56d91fb7 getcommands will remove old getcommand file clones 2026-01-08 00:38:59 +01:00
ef39855f20 fix getcommands.js creating a "ghost changed files with no changes" due to line endings 2026-01-08 00:19:32 +01:00
5f45f69768 Doc updates to "getcommands.js" (#1888)
* getcommnads.js:

Add text and link to obk_config.h for defines used to enable a driver

Added first simple way to generate basic "events" documentation

* Add first version for the new documents "docs/events.md" and "docs/json/events.json"

* Changed handling of HTML-encoding of "<" and ">"

* Add new version of driver.md, too
2025-12-09 09:05:22 +01:00
3f93828622 Update getcommands.js, some minor doc-fixes (#1884)
updated documentation
2025-12-05 18:56:16 +01:00
a23e4183c2 Fix missing "onHassDiscovery" and "XX_AppendInformationToHTTPIndexPage()" (#1877)
* Fix missing "onHassDiscovery" and "XX_AppendInformationToHTTPIndexPage()"

Fixes to drv_main.c (some missing args for "onHassDiscovery") - changed format to have one line per argument and driver
Fixed missing arg "bPreState" in some XX_AppendInformationToHTTPIndexPage() functions

* fix getcommands for new structure of drv_main.c (commands may be mutliple lines long)

* Make comments for "duplicate" drivers more readble

* Fix sourcefiles for documentation done with getcommands.js
Mainly missing comments or comments "contradicted" by function calls

* fixed one missed comment

* Fix path in descriprion command
make getcommands.js testing duplicates for content
 - if content (=documentation) is equal, show that ist potentially safe to ignore
2025-12-03 16:01:28 +01:00
c5116a4f2b fix getcommands.js (#1788)
* fix getcommands.js

Fix parsing
don't overwrite source files but generate alternate file

* Fix comments so "getcommands.js" won't complain.
Hpoe I got descriptions right ...

* Some more comments to fill "qqq" fields ...

* Fix getcommands.js generatind fn-entries for registered commands

Fix all source files with wrong "NULL);" as fn

* add some more tests to getcommands.js to verify commands:
	check filename of command
	check fn called
some more fixes to documentation commands as result from above tests
2025-09-09 21:53:07 +02:00
b6e9862563 autoexecExamples.md: Use C++ higlighting (#1687)
* Run getcommands.js through a linter

* Use C++ higlighting for autoexec.bat examples
2025-06-24 17:08:35 +02:00
6f8e790a22 fix a bug in docs script that was hiding first line of script 2024-01-16 14:36:28 +01:00
b4c539f9e0 capitzlite 2023-08-16 11:00:07 +02:00
e1d0768a34 better 2023-08-16 10:54:18 +02:00
2c258bdf5b examples 2023-08-16 10:52:43 +02:00
ed2b9954da docas better 2023-08-16 09:53:05 +02:00
38d8580442 better 2023-08-16 09:48:25 +02:00
4db4c39918 docs searh link 2023-08-16 09:47:38 +02:00
Tom
cb39120560 Documentation Update (#843)
* Fixed one typo in the battery commands, also added description for Map command.

* Generated the doc files to see if my changes worked.

* Sorted commands array to make it easier to find command information

* Fixed some command descriptions. Sorted commands in docs list.

* Fixed command sorting to be case-insensitive

* Removed extra comments on SendPost added by docs script.
2023-06-02 15:05:46 +02:00
60d3c9666e debug info print for cmdgen 2023-04-30 08:28:02 +02:00
9c8cada12d docs 2023-04-17 10:00:06 +02:00
92072aae51 docs 2023-04-17 09:55:03 +02:00
c367038020 docs cosmetics 2023-04-05 09:15:02 +02:00
186da7d1ca test final docs split 2023-04-05 08:57:23 +02:00
c8face8e3d move out mqttopics to docs 2023-04-04 23:23:03 +02:00
c000c63c99 flags remove comma 2023-03-13 20:20:40 +01:00
ca0c9ed110 cmd docs 2023-03-11 08:49:27 +01:00
191d9d689f docs formatting 2023-03-07 12:42:37 +01:00
042f2601b2 move script examples to docs 2023-03-07 12:30:54 +01:00
81c616d03c examples 2023-03-06 19:24:47 +01:00
28ca2b366a style 2023-03-06 19:11:46 +01:00
816812fd16 styling 2023-03-06 19:10:50 +01:00
9c26730d89 styling 2023-03-06 19:09:44 +01:00
99df7d2dea autoexec examples 2023-03-06 19:06:46 +01:00
120a78912b newlin e fix 2023-03-06 18:05:54 +01:00
475aa2d10b command exanmples migration 2023-03-06 18:03:31 +01:00
8fa2ce29d9 docs 2023-03-06 17:08:48 +01:00
0e1df6dd89 test docs faq 2023-03-06 16:34:14 +01:00
9b3220fa0a test faq 2023-03-06 16:20:41 +01:00
5391bdca3c docs test 2023-03-06 12:24:45 +01:00
d4aaa8dfcd docs 2023-03-06 12:23:08 +01:00
c215110cfc drivers doc, post jsons 2023-03-06 11:37:01 +01:00
d94c0bce30 channelTypes docs , misc fixes 2023-03-06 09:21:23 +01:00
cfab370605 getcommands almost ready with dumping data 2023-03-06 08:39:39 +01:00
b62d382a36 getcommands.js can now parse constants, also write drivers 2023-03-06 08:35:38 +01:00
33ad367a4d parse flags 2023-03-05 20:28:34 +01:00
9f6ee915a4 title field, driver parse 2023-03-05 18:33:38 +01:00
4144a43f21 io roles and channels json gen 2023-03-05 18:03:58 +01:00
7cfa6e78c2 channel type parsing 2023-03-05 17:26:47 +01:00
f61a1c9436 cosmetic change before chan getter, chan getter prototype 2023-03-05 17:09:28 +01:00
f119554969 misc fixes, snprintf, cmd gen 2023-02-10 15:03:27 +01:00
2febe2a6e7 commands update 2022-12-21 11:03:12 +01:00
8519e26afe commands update p1 2022-12-21 09:19:45 +01:00
0168052582 add getcommands.js,
can be run via
npm run getcommands
or
node scripts/getcommands.js
examines source for command registeration, moves stuff into comments and removes C strings..
2022-11-21 18:39:33 +00:00