Skip to content

Commit 39e2333

Browse files
authored
Merge pull request #871 from david-cermak/fix/modem_sim_docs
[modem_sim]: Add initial modem simulator docs
2 parents 58a21e3 + 9c7ee07 commit 39e2333

File tree

1 file changed

+51
-0
lines changed

1 file changed

+51
-0
lines changed
Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
# Modem Simulator Component
2+
3+
A Wi-Fi modem simulator that extends ESP-AT with PPP server capabilities, turning ESP32 into a fully functional Wi-Fi modem. Perfect for testing AT commands and PPP connections without real hardware dependencies.
4+
5+
## What it does
6+
7+
- Extends ESP-AT firmware with PPP server functionality
8+
- Provides DATA mode for raw IP communication
9+
- Enables existing communication stacks (MQTT, HTTP, custom protocols) to work over Wi-Fi
10+
- Ideal for testing ESP-Modem library and CI reliability
11+
12+
## Quick Start
13+
14+
```bash
15+
cd common_components/modem_sim
16+
./install.sh
17+
source export.sh
18+
idf.py build
19+
```
20+
21+
## Custom Platform/Module
22+
23+
```bash
24+
./install.sh PLATFORM_ESP32S3 WROOM-32
25+
```
26+
27+
## Configuration
28+
29+
The `sdkconfig.defaults` includes:
30+
- Wi-Fi and Bluetooth enabled
31+
- PPP server support
32+
- AT commands for HTTP/MQTT
33+
- 4MB flash configuration
34+
35+
## Project Structure
36+
37+
```
38+
modem_sim/
39+
├── install.sh # Installation script
40+
├── export.sh # Environment setup
41+
├── sdkconfig.defaults # Default configuration
42+
├── pppd_cmd/ # Custom PPP commands
43+
└── modem_sim_esp32/ # Generated ESP-AT build
44+
```
45+
46+
## Use Cases
47+
48+
- Testing ESP-Modem library without real hardware
49+
- Quick Wi-Fi connectivity for existing communication stacks
50+
- CI/CD testing with reliable modem simulation
51+
- Development and debugging of AT command implementations

0 commit comments

Comments
 (0)