Skip to content

Commit a84c558

Browse files
authored
Release 0.4.0-beta (#26)
* refactoring: Improve files structure and multiple improvements for maintainability (#22) * feature: update intro message with WebScreen image. (#24) * feature: Add serial commands to perform CRUD operations on sd card + some useful help commands. (#25) * chore: update binaries.
1 parent ecdab5e commit a84c558

File tree

12 files changed

+52289
-47163
lines changed

12 files changed

+52289
-47163
lines changed

README.md

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,7 @@ WebScreen is a hackable, open-source gadget for gamers, makers, and creators! Ge
2828

2929
### Development Features
3030
- **Modular Architecture**: Separated concerns across hardware, network, and runtime modules
31+
- **Serial Commands**: Interactive development console with comprehensive command system
3132
- **Configuration System**: JSON-based configuration with comprehensive validation
3233
- **Error Handling**: Robust error reporting and recovery mechanisms
3334
- **Debug Support**: Serial logging and development utilities
@@ -342,6 +343,49 @@ This enables verbose logging and memory debugging features.
342343
[1234.991] INFO: [JavaScript] Loaded /apps/weather.js (2.4KB)
343344
```
344345
346+
#### Serial Commands
347+
348+
WebScreen includes a comprehensive serial command system for interactive development. Commands work in both fallback and dynamic JavaScript modes:
349+
350+
**Core Commands:**
351+
```
352+
/help - Show all available commands
353+
/stats - Display system statistics (memory, storage, WiFi)
354+
/info - Show device information and version
355+
/write <filename> - Interactive JavaScript editor
356+
/load <script.js> - Switch to different JS application
357+
/reboot - Restart the device
358+
```
359+
360+
**Configuration Management:**
361+
```
362+
/config get <key> - Get configuration value
363+
/config set <key> <val> - Set configuration value
364+
```
365+
366+
**File Operations:**
367+
```
368+
/ls [path] - List files/directories
369+
/cat <file> - Display file contents
370+
/rm <file> - Delete file
371+
```
372+
373+
**Example Development Workflow:**
374+
```
375+
WebScreen> /write hello.js
376+
Enter JavaScript code. End with a line containing only 'END':
377+
---
378+
+ create_label_with_text('Hello WebScreen!');
379+
+ END
380+
[OK] Script saved: /hello.js (45 bytes)
381+
382+
WebScreen> /load hello.js
383+
[OK] Script queued for loading: /hello.js
384+
[OK] Restarting to load new script...
385+
```
386+
387+
For detailed command reference, see [docs/SerialCommands.md](docs/SerialCommands.md).
388+
345389
#### Debug Commands
346390
```cpp
347391
// Memory usage report

0 commit comments

Comments
 (0)