Create sphinx key flow diagram (#19)

* first steps

* fix formatting

* more details

* Clarify wifi reset branch, and loop branch on mqtt message listen

* Small nits
This commit is contained in:
Jules
2022-06-09 08:45:11 -06:00
committed by GitHub
parent c911f778cf
commit 31cffcd2f6

45
FLOW.md Normal file
View File

@@ -0,0 +1,45 @@
```
POWER UP ────── SOLID RED
YES ┌────────▼──────────┐
┌─────┤NVS GOT WIFI, KEYS?│
│ └────────┬──────────┘
│ │
│ │NO
│ │
│ ▼
┌─► RESET ───────────┼───────► SERVING WIFI AP ────── YELLOW BLINK
│ WIFI │ │
│ │ │
│ │ │
│ │ ▼
│ │ CONNECTION RECEIVED ────── YELLOW SOLID
│ │ │
│ │ │
│ │ │
│ │ ▼
│ └───────► GOT THE CREDENTIALS, KEYS ────── ORANGE BLINK
│ ATTEMPTING TO CONNECT TO WIFI
│ │
│BUTTON PRESS │
│ │
│ ▼
┌───┴────────────────┬────► WIFI CONNECTED,
│WIFI CONNECTIOW DOWN│ CONNECTING TO MQTT BROKER ────── VIOLET BLINK
│ == │ │
│ SLOW BLINK RED │ │
└────────────────────┘ │
┌─────────────────────┬───► ┌──► CONNECTED TO MQTT BROKER, ────── BLUE BLINKS
│ MQTT CONNECTION DOWN│ │ LISTENING TO MESSAGES EVERY FIVE SECONDS
│ == │ │ │
│ FAST BLINK RED │ │ │
└─────────────────────┘ │ │
│ ▼
└─── SIGNED A MESSAGE ────── GREEN BLINK
```
Paste the code block above into `asciiblock.com` to make edits. Then press the download button on the top right of the pane to bring it back here.