Skip to content
Snippets Groups Projects
Commit 00a66860 authored by fxk8y's avatar fxk8y :spider:
Browse files

Moar doc

parent 7f7db21c
No related branches found
No related tags found
No related merge requests found
......@@ -12,6 +12,25 @@ All API endpoints are also mapped to `MQTT` topics to provide a some kind of a r
`NVSExplorer` has its topics living inside the local `qthing` topic scheme.
The base-topic thus is `device/<NAME>/NVS` where `<NAME>` is the device name.
This topic will further be referred to just as `BASE`, like in `BASE/ls`.
This topic will further be referred to just as `BASE`, like in `BASE/cmd`.
The request/response scheme doesn't follow the usual property ones as this would lead to publish loops.
Therefore we establish distinct request/response topics.
- `request` topic:
`BASE/rq`
- `response` topic:
`BASE/rs` (the `response`-topic *may* change in the future as I'm certainly unclear about it)
This topics will further on be referred to as `REQUEST` and `RESPONSE`, as in `REQUEST/ls`.
### Commands
### Types
#### TODO
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment