From 00a66860ac38ba98474cfaa334fc959db2266b5b Mon Sep 17 00:00:00 2001 From: Jochen Vothknecht <jochen3120@gmail.com> Date: Wed, 25 May 2022 08:24:02 +0200 Subject: [PATCH] Moar doc --- CLC-qthing/SiliconTorch/NVSExplorer.md | 21 ++++++++++++++++++++- 1 file changed, 20 insertions(+), 1 deletion(-) diff --git a/CLC-qthing/SiliconTorch/NVSExplorer.md b/CLC-qthing/SiliconTorch/NVSExplorer.md index 37ff623..acfb7cf 100644 --- a/CLC-qthing/SiliconTorch/NVSExplorer.md +++ b/CLC-qthing/SiliconTorch/NVSExplorer.md @@ -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 -- GitLab