From d5ee120fe807a6f20111eee097c6071f6ee7835c Mon Sep 17 00:00:00 2001 From: Jochen Vothknecht <jochen3120@gmail.com> Date: Wed, 29 Jun 2022 08:36:15 +0200 Subject: [PATCH] ST: documentation++ --- DeviceConfigurator/README.md | 14 ++++++++++++++ README.md | 14 ++++++++++++++ 2 files changed, 28 insertions(+) create mode 100644 DeviceConfigurator/README.md diff --git a/DeviceConfigurator/README.md b/DeviceConfigurator/README.md new file mode 100644 index 0000000..de3fd2b --- /dev/null +++ b/DeviceConfigurator/README.md @@ -0,0 +1,14 @@ +DeviceConfigurator +================== + +Configure `SiliconTorch` devices remotely through `MQTT`. + +Supports the whole API of `NVSExplorer` and knows the `NVS` structures from most of the `SiliconTorch` services. + + +#### TODO: Give a few examples as an introduction!! + +#### TODO: Document its usage!! + +#### TODO: Move this to a proper location!! Maybe inside of `SiliconTorch` ? Dont's know atm, there are arguments for and against :/ + diff --git a/README.md b/README.md index 00616da..2051207 100644 --- a/README.md +++ b/README.md @@ -26,6 +26,20 @@ Big things are on the way! Source-less animation building coming soonâ„¢! Section moved to the [PCB README file](/pcb/README.md) +`NVSExplorer` - The `ESP32` flash provisioning toolkit +------------------------------------------------------ + +This part of `SiliconTorch` has its own [documentation](/CLC-qthing/SiliconTorch/NVSExplorer.md) + + +`DeviceConfigurator` - The remote configuration `REPL` using `NVSExplorer`'s API +-------------------------------------------------------------------------------- + +#### TODO: Better naming!! + +This part of `SiliconTorch` has its own [documentation](/DeviceConfigurator/README.md) + + `FxCyanF` aka `CyanLight`s network protocol -------------------------------------------- -- GitLab