Skip to content

Quick Start Guide

Arunkumar Mourougappane edited this page Oct 26, 2025 · 3 revisions

Quick Start Guide

Get up and running with ESP32 WiFi Utility v4.2.0 in minutes.

Prerequisites

Hardware Requirements

  • ESP32 Development Board OR Adafruit Feather ESP32-S3 TFT
  • USB cable (Micro-USB for ESP32dev, USB-C for Feather)
  • Computer with PlatformIO or Arduino IDE

Software Requirements

Installation

Option 1: PlatformIO (Recommended)

# Clone the repository
git clone https://github.com/arunkumar-mourougappane/esp32-wifi-utility.git
cd esp32-wifi-utility

# For ESP32 Development Board
pio run -e esp32dev --target upload

# For Adafruit Feather ESP32-S3 TFT
pio run -e adafruit_feather_esp32s3_tft --target upload

# Monitor serial output
pio device monitor

Option 2: Arduino IDE

  1. Download latest release from GitHub Releases
  2. Extract and open in Arduino IDE
  3. Select appropriate board and port
  4. Compile and upload

First Boot Setup

1. Connect and Monitor

  1. Connect ESP32 via USB
  2. Open serial monitor at 115200 baud
  3. Press reset button on ESP32

You should see:

ESP32 WiFi Utility v4.2.0
==========================================
     ESP32 WiFi Scanner & AP
==========================================
πŸ” Initializing system...
βœ“ Configuration system ready
βœ“ WiFi hardware initialized
ℹ️ No saved configuration found - starting in IDLE mode

🟑 Device in IDLE mode - Ready for commands
Type 'help' for available commands

🟑 ESP32>

2. Explore Available Commands

> help

This displays all available commands including:

  • WiFi operations (scan, connect, status)
  • Configuration management (ap config, station config)
  • Web interface (webserver start)
  • Network analysis (channel scan, latency test)

3. Connect to Your WiFi

# Scan for networks
> scan

# Connect to your WiFi
> connect "YourWiFiName" "YourPassword"

4. Save Configuration (NEW in v4.2.0)

Save your WiFi settings so they persist across reboots:

# Save station config with auto-connect
> station config "YourWiFiName" "YourPassword" auto

# Device will now automatically connect on boot

5. Start Web Interface

> webserver start

The device will display the web interface URL:

Web server started at: http://192.168.1.100
Access the configuration page at: http://192.168.1.100/config

Next Steps

Essential Features to Try

  1. Configuration Persistence - Save AP and Station settings
  2. Web Configuration Interface - Browser-based management
  3. Signal Strength Monitor - Real-time RSSI monitoring (NEW v4.2.1)
  4. WiFi Scanning & Analysis - Network discovery and evaluation
  5. Channel Analysis - Spectrum optimization
  6. Performance Testing - Latency and throughput analysis

Quick Commands Reference

Command Description
scan Scan for WiFi networks
connect "SSID" "password" Connect to WiFi
status Show system information
signal show Display signal strength
signal scan Scan nearby signals
webserver start Launch web interface
ap config "SSID" "password" auto Save AP configuration
station config "SSID" "password" auto Save Station configuration
channel scan Analyze WiFi spectrum
reset Restart device

Troubleshooting

Common Issues

Device not connecting to WiFi:

  • Verify SSID and password are correct
  • Check WiFi network is 2.4GHz (ESP32 doesn't support 5GHz)
  • Use status command to check connection details

Serial monitor shows garbled text:

  • Ensure baud rate is set to 115200
  • Try different USB cable
  • Press reset button after connecting

Web interface not accessible:

  • Ensure device is connected to same network
  • Check IP address with status command
  • Try accessing via AP mode first

Getting Help


← Back to Home | Next: Hardware Setup β†’

πŸ“‘ ESP32 WiFi Utility

🏠 Main

πŸ“¦ Setup

βš™οΈ Configuration

πŸ“Š Features

πŸ’» Development

πŸ†˜ Support

πŸ”— Links


Version: 4.2.0
License: MIT

Clone this wiki locally