You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: AGENTS.md
+6-5Lines changed: 6 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -39,8 +39,8 @@ You do **not** need to flash the ESP32 to test UI changes! The project includes
39
39
-`src/network/` - WiFi setup, Spoolman API clients, and Webhook/U1 HTTP request handling.
40
40
-`src/serial/` - CLI interface via the USB serial port for device configuration.
41
41
-`src/power/` - Battery voltage monitoring (ADC) and sleep management heuristics.
42
-
-`docs/` - User-facing documentation and hardware setup guides.
43
-
-`scripts/` - Python pre/post scripts for PlatformIO (e.g., binary copying, version injection).
42
+
-`docs/` - User-facing documentation and hardware setup guides.**This is the source of truth.** Do not edit `web/docs/` directly.
43
+
-`scripts/` - Python pre/post scripts for PlatformIO, and bash scripts like `copy_docs.sh` to sync docs to the `web/` folder.
44
44
-`simulator/` - Mock data and configs for the native UI simulator.
45
45
46
46
## 6. Global Rules & Code Conventions
@@ -57,6 +57,7 @@ You do **not** need to flash the ESP32 to test UI changes! The project includes
57
57
## 8. Agentic Workflow
58
58
1. Read the user's prompt carefully.
59
59
2. If UI changes are requested, modify `src/ui/`, build the `simulator` environment, and run it to verify.
60
-
3. Keep `notes.md` updated if you complete tasks or find new known issues.
61
-
4. Keep `AGENTS.md` updated if the project architecture, dependencies, hardware integrations, or core guidelines change.
62
-
5. If a task involves complex logic, use your `brainstorming` skill before writing code.
60
+
3.**Documentation:** The files in `docs/` and the root `README.md` are the source of truth. If you edit them, you MUST run `./scripts/copy_docs.sh` to update the `web/` directory. Do not edit `web/docs/` or `web/README.md` directly.
61
+
4. Keep `notes.md` updated if you complete tasks or find new known issues.
62
+
5. Keep `AGENTS.md` updated if the project architecture, dependencies, hardware integrations, or core guidelines change.
63
+
6. If a task involves complex logic, use your `brainstorming` skill before writing code.
Copy file name to clipboardExpand all lines: docs/CONFIGURATION.md
+6-3Lines changed: 6 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -10,7 +10,8 @@ CheapSpoolDisplay can be configured via a Serial Terminal (115200 baud) when con
10
10
| :--- | :--- |
11
11
|`help`| Show available commands |
12
12
|`get config`| Show current configuration values |
13
-
|`set wifi <ssid> <password>`| Special command to set Wi-Fi credentials |
13
+
|`set wifi_ssid <ssid>`| Set Wi-Fi network name |
14
+
|`set wifi_pass <password>`| Set Wi-Fi network password |
14
15
|`set spoolman http://<ip>:<port>`| Set the Spoolman server URL |
15
16
|`set webhook http://...`| Set the webhook URL |
16
17
|`set u1_host <ip>:<port>`| Set the Snapmaker U1 host URL |
@@ -37,7 +38,8 @@ This setting also applies a specific gamma correction table to fix the washed-ou
37
38
38
39
### Wi-Fi
39
40
40
-
`set wifi SSID PASSWORD`
41
+
`set wifi_ssid SSID`
42
+
`set wifi_pass PASSWORD`
41
43
42
44
**Note:** The device will only connect to Wi-Fi when needed (e.g., for Spoolman or Webhooks). You can optionally configure the connection timeout limit using:
43
45
`set wifi_timeout <seconds>` (Default: 60)
@@ -106,7 +108,8 @@ Configures how many seconds the device must be idle before entering deep sleep (
0 commit comments