Skip to content

Commit 21e8036

Browse files
committed
chore: documentation
1 parent fde0373 commit 21e8036

File tree

1 file changed

+19
-2
lines changed

1 file changed

+19
-2
lines changed

README.md

Lines changed: 19 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -57,6 +57,8 @@ Before setting up SmartClimate, ensure you have the following installed:
5757
- Open VS Code and install the ESP-IDF extension.
5858
- Follow the setup instructions to configure the ESP32-C6 environment.
5959

60+
### Both
61+
6062
3. **Build and flash the firmware:**
6163
```sh
6264
idf.py build
@@ -73,14 +75,29 @@ Before setting up SmartClimate, ensure you have the following installed:
7375
```
7476

7577
## Swagger API documentation
78+
➡️ [SmartClimate API Swagger](./swagger.yml)
7679

7780
## Features
7881

79-
- [x] Captive portal functionality compatible with both Android and iOS for easy Wi-Fi configuration.
82+
- [x] Embedded web server with HTTP endpoints
83+
- [x] Wi-Fi station (STA) mode support
84+
- [x] Captive portal for Wi-Fi access point (AP) mode
85+
- [x] NVS-based persistent storage for configuration and credentials
86+
- [x] Uptime tracking (seconds to days format)
87+
- [x] Lightweight JSON API for system status and configuration
88+
- [x] Graphical user interface built with LVGL
8089

8190
## Roadmap
8291

83-
- [ ] First release
92+
- [] NTP-based time synchronization
93+
- [] UI theming & styling system
94+
- [] Internationalization (i18n) support
95+
- [] Better error feedback on failed Wi-Fi connection
96+
- [] System metrics dashboard (RAM, CPU, temp)
97+
- [] Web UI with live config over HTTP
98+
- [] BLE pairing & config mode
99+
- [] WebSocket real-time updates
100+
- [] Config export/import (JSON/NVS backup)
84101

85102
## License
86103

0 commit comments

Comments
 (0)