chore: import local project into Gitea
This commit is contained in:
113
WiFiX-Enhanced/QUICK_START.md
Normal file
113
WiFiX-Enhanced/QUICK_START.md
Normal file
@@ -0,0 +1,113 @@
|
||||
# WiFiX-Enhanced Quick Start Guide
|
||||
|
||||
## 🚀 Flash in 5 Minutes
|
||||
|
||||
### 1. Install PlatformIO
|
||||
```powershell
|
||||
pip install platformio
|
||||
```
|
||||
|
||||
### 2. Flash ESP32 (Main Controller)
|
||||
```powershell
|
||||
pio run -e esp32_main --target upload
|
||||
pio device monitor -e esp32_main
|
||||
```
|
||||
|
||||
### 3. Flash BW16 (WiFi Module)
|
||||
```powershell
|
||||
pio run -e bw16_deauth --target upload
|
||||
pio device monitor -e bw16_deauth
|
||||
```
|
||||
|
||||
### 4. Upload Web Files
|
||||
```powershell
|
||||
pio run --target uploadfs -e esp32_main
|
||||
```
|
||||
|
||||
### 5. Connect & Test
|
||||
1. Power on both modules
|
||||
2. Connect to "CityNet_Public_WiFi"
|
||||
3. Browser opens automatically
|
||||
4. Test login portal
|
||||
|
||||
## 📋 Pre-Flight Checklist
|
||||
|
||||
### Hardware
|
||||
- [ ] BW16 module connected to ESP32 (TX→16, RX→17)
|
||||
- [ ] OLED display wired (SDA→21, SCL→22)
|
||||
- [ ] SD card module connected (SPI pins)
|
||||
- [ ] 3.3V power supply stable
|
||||
- [ ] Antennas connected
|
||||
|
||||
### Software
|
||||
- [ ] PlatformIO installed
|
||||
- [ ] USB drivers installed
|
||||
- [ ] Correct COM ports selected
|
||||
- [ ] Code compiled successfully
|
||||
|
||||
### Test
|
||||
- [ ] Serial monitor shows boot messages
|
||||
- [ ] WiFi network appears
|
||||
- [ ] Portal loads on connection
|
||||
- [ ] OLED displays status
|
||||
- [ ] Credentials save to SD card
|
||||
|
||||
## ⚡ Emergency Commands
|
||||
|
||||
### Serial Console (115200 baud)
|
||||
```
|
||||
help # Show commands
|
||||
status # System status
|
||||
creds # View captured credentials
|
||||
clearcreds # Clear storage
|
||||
reset # Factory reset
|
||||
```
|
||||
|
||||
### PlatformIO
|
||||
```powershell
|
||||
# Clean build
|
||||
pio run -e esp32_main --target clean
|
||||
|
||||
# Upload filesystem
|
||||
pio run -e esp32_main --target uploadfs
|
||||
|
||||
# Monitor serial
|
||||
pio device monitor -e esp32_main -b 115200
|
||||
```
|
||||
|
||||
## 🎯 Default Settings
|
||||
|
||||
### Network
|
||||
- **SSID**: `CityNet_Public_WiFi`
|
||||
- **IP**: `192.168.4.1`
|
||||
- **Portal**: `http://192.168.4.1`
|
||||
|
||||
### Hardware Pins
|
||||
- **OLED**: I2C (21,22)
|
||||
- **SD Card**: SPI (23,19,18,5)
|
||||
- **BW16**: UART (16,17)
|
||||
|
||||
## 🚨 Common Issues
|
||||
|
||||
### "Port not found"
|
||||
```powershell
|
||||
pio device list
|
||||
# Install drivers, try different USB cable
|
||||
```
|
||||
|
||||
### "Upload timeout"
|
||||
Hold BOOT button during upload start
|
||||
|
||||
### "No WiFi"
|
||||
Check antenna, power, BW16 connections
|
||||
|
||||
### "Portal won't load"
|
||||
Clear browser cache, try different browser
|
||||
|
||||
## 📞 Need Help?
|
||||
1. Check serial output first
|
||||
2. Verify all connections
|
||||
3. Test minimal setup
|
||||
4. Document error messages
|
||||
|
||||
**Remember**: Use responsibly and legally!
|
||||
Reference in New Issue
Block a user