https://github.com/duylinhphan123/wokwi_autoscript
Wokwi CLI - Self-contained executable for STM32/ESP32 firmware scanning and Wokwi diagram downloading. No Python required!
https://github.com/duylinhphan123/wokwi_autoscript
automation cli embedded esp32 firmware iot microcontroller simulation stm32 wokwi
Last synced: about 1 month ago
JSON representation
Wokwi CLI - Self-contained executable for STM32/ESP32 firmware scanning and Wokwi diagram downloading. No Python required!
- Host: GitHub
- URL: https://github.com/duylinhphan123/wokwi_autoscript
- Owner: duylinhphan123
- Created: 2025-09-26T05:00:17.000Z (9 months ago)
- Default Branch: master
- Last Pushed: 2025-09-30T08:47:03.000Z (9 months ago)
- Last Synced: 2025-10-06T02:24:44.638Z (8 months ago)
- Topics: automation, cli, embedded, esp32, firmware, iot, microcontroller, simulation, stm32, wokwi
- Language: Python
- Size: 25.4 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Wokwi CLI - Standalone Executable
🚀 **Self-contained executable version of Wokwi CLI**
## 📁 Files
- **`wokwi.exe`** - Main executable (9.4 MB)
- **`demo_test.cmd`** - Demo script to test all features
- **`test_url.txt`** - Sample URL file for testing
## 🎯 Usage
### 💻 Basic Commands
```cmd
# Show version
wokwi.exe version
# Show help
wokwi.exe help
# Setup firmware (auto scan)
wokwi.exe setup
# Download diagram from url.txt
wokwi.exe diagram
# Download diagram from specific file
wokwi.exe diagram ./my_url.txt
# Download diagram from direct URL
wokwi.exe diagram https://wokwi.com/projects/442394281549660161
```
### 🚀 Quick Start
1. **Copy `wokwi.exe`** to your project directory
2. **Run setup:** `wokwi.exe setup` to scan firmware
3. **Download diagram:** `wokwi.exe diagram url.txt` if needed
### 📋 Full Demo
```cmd
# Run demo test to see all features
demo_test.cmd
```
## 🌟 Features
### ✅ **Universal Firmware Scanner**
- 🔍 Auto scan STM32 (`Debug/` folders)
- 🔍 Auto scan ESP32/PlatformIO (`.pio/build/` folders)
- 🎯 Smart project detection
- 📋 Multiple firmware groups support
- 📝 Auto generate `wokwi.toml` with full info
### ✅ **Wokwi Diagram Downloader**
- 📦 Download `diagram.json` from Wokwi projects
- 📁 Support file input (`./url.txt`)
- 🌐 Support direct URL input
- 📊 Show diagram statistics
### ✅ **File Input Support**
```cmd
# File input examples
wokwi.exe diagram ./project_url.txt
wokwi.exe diagram ../configs/wokwi_url.txt
wokwi.exe diagram https://wokwi.com/projects/123456789
# URL file format (any of these formats):
https://wokwi.com/projects/442394281549660161
442394281549660161
```
## 🛠️ Technical Details
- **Size:** ~9.4 MB (standalone, no Python required)
- **Platform:** Windows 64-bit
- **Dependencies:** None (self-contained)
- **Python version:** Built with Python 3.13.7
- **Build tool:** PyInstaller 6.16.0
## 🎪 Advanced Examples
### Automation Scripts
```cmd
REM Batch script automation
wokwi.exe setup
if %errorlevel% equ 0 (
echo Setup successful!
wokwi.exe diagram
) else (
echo Setup failed!
)
```
### Multiple Projects
```cmd
REM Project A
cd ProjectA
wokwi.exe setup
wokwi.exe diagram project_a_url.txt
REM Project B
cd ..\ProjectB
wokwi.exe setup
wokwi.exe diagram project_b_url.txt
```
## 🆚 Comparison with Python Scripts
| Feature | wokwi.exe | Python Scripts |
|---------|-----------|----------------|
| **Installation** | ✅ Ready-to-use | ❌ Requires Python |
| **Dependencies** | ✅ Self-contained | ❌ Need libraries |
| **Size** | ⚠️ 9.4 MB | ✅ <100 KB |
| **Startup** | ⚠️ ~2-3s | ✅ Instant |
| **Portability** | ✅ Runs anywhere | ❌ Need Python env |
| **File Input** | ✅ Full support | ⚠️ Limited |
## 🔧 Troubleshooting
### ❌ "Windows protected your PC"
**Solution:** Click "More info" → "Run anyway"
### ❌ Slow startup
**Reason:** PyInstaller extracting libraries on first run
**Solution:** Wait 2-3 seconds for first run
### ❌ Antivirus false positive
**Solution:** Add wokwi.exe to whitelist
## 📝 Changelog
### v2.0 - Standalone Executable
- ➕ Self-contained executable
- ➕ File input support (`wokwi diagram ./file.txt`)
- ➕ Direct URL support (`wokwi diagram https://...`)
- ➕ Embedded firmware scanner & diagram downloader
- ➕ No external dependencies
- ➕ Professional CLI interface
---
**🎉 Ready to use! Just run `wokwi.exe help` to get started**