# xinyuan-lilygo/lilygo-modem-series-micropython architecture

> Architecture diagram of the GitHub repository xinyuan-lilygo/lilygo-modem-series-micropython, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-11-19). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/xinyuan-lilygo/lilygo-modem-series-micropython
- Repository: https://github.com/xinyuan-lilygo/lilygo-modem-series-micropython

## Overview

This repository provides MicroPython firmware and examples for LilyGo ESP32/ESP32-S3 cellular modem boards. The user workflow is to select a board variant, follow its quick-start guide, install suitable firmware, and run an example for a modem capability such as MQTT, GPS, SMS, or HTTP. The sampled runtime layer includes board-pin configuration and two standalone libraries for Blynk connectivity and HTTP serving. README links establish the quick-start entry points; unsampled guides and examples limit confidence about their detailed runtime wiring.

Main entry points: [`libraries/BlynkLib.py`](https://github.com/xinyuan-lilygo/lilygo-modem-series-micropython/blob/main/libraries/BlynkLib.py) (Blynk client), [`docs/en`](https://github.com/xinyuan-lilygo/lilygo-modem-series-micropython/tree/main/docs/en) (Board quick starts), [`examples`](https://github.com/xinyuan-lilygo/lilygo-modem-series-micropython/tree/main/examples) (ESP32 examples), [`libraries/utilities.py`](https://github.com/xinyuan-lilygo/lilygo-modem-series-micropython/blob/main/libraries/utilities.py) (Pin configuration)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_board["Board support"]
  node_quickstarts["Board quick starts"]
  node_pinconfig["Pin configuration<br/>[utilities.py]"]
end

subgraph group_examples["Modem examples"]
  node_esp32examples["ESP32 examples"]
  node_gps["GPS and location"]
  node_http["HTTP&#40;S&#41; examples"]
  node_mqtt["MQTT examples"]
  node_sms["SMS examples"]
  node_network["Network examples"]
end

subgraph group_libraries["Runtime libraries"]
  node_blynk["Blynk client<br/>[BlynkLib.py]"]
  node_microdot["HTTP server<br/>[microdot.py]"]
end

subgraph group_resources["Firmware and references"]
  node_firmware["Prebuilt firmware"]
  node_datasheets["Modem references"]
  node_hardware["Board designs"]
end

node_user(("Device developer"))
node_modem["Cellular modem"]
node_blynkservice["Blynk service"]

node_user -->|"chooses board guide"| node_quickstarts
node_user -.->|"runs examples"| node_esp32examples
node_user -.->|"selects firmware"| node_firmware
node_quickstarts -.->|"explains setup"| node_esp32examples
node_pinconfig -.->|"configures pins"| node_modem
node_gps -.->|"uses modem GPS"| node_modem
node_http -.->|"uses modem HTTP"| node_modem
node_mqtt -.->|"uses modem MQTT"| node_modem
node_sms -.->|"uses modem SMS"| node_modem
node_network -.->|"uses modem network"| node_modem
node_blynk -->|"connects to"| node_blynkservice
node_blynk -->|"opens socket"| node_modem
node_microdot -.->|"serves HTTP requests"| node_user

click node_quickstarts "https://github.com/xinyuan-lilygo/lilygo-modem-series-micropython/tree/main/docs/en"
click node_pinconfig "https://github.com/xinyuan-lilygo/lilygo-modem-series-micropython/blob/main/libraries/utilities.py"
click node_esp32examples "https://github.com/xinyuan-lilygo/lilygo-modem-series-micropython/tree/main/examples"
click node_gps "https://github.com/xinyuan-lilygo/lilygo-modem-series-micropython/tree/main/examples"
click node_http "https://github.com/xinyuan-lilygo/lilygo-modem-series-micropython/tree/main/examples"
click node_mqtt "https://github.com/xinyuan-lilygo/lilygo-modem-series-micropython/tree/main/examples"
click node_sms "https://github.com/xinyuan-lilygo/lilygo-modem-series-micropython/tree/main/examples"
click node_network "https://github.com/xinyuan-lilygo/lilygo-modem-series-micropython/tree/main/examples"
click node_blynk "https://github.com/xinyuan-lilygo/lilygo-modem-series-micropython/blob/main/libraries/BlynkLib.py"
click node_microdot "https://github.com/xinyuan-lilygo/lilygo-modem-series-micropython/blob/main/libraries/microdot.py"
click node_firmware "https://github.com/xinyuan-lilygo/lilygo-modem-series-micropython/tree/main/firmware"
click node_datasheets "https://github.com/xinyuan-lilygo/lilygo-modem-series-micropython/tree/main/datasheet"
click node_hardware "https://github.com/xinyuan-lilygo/lilygo-modem-series-micropython/tree/main/schematic"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_quickstarts,node_pinconfig toneBlue
class node_esp32examples,node_gps,node_http,node_mqtt,node_sms,node_network toneAmber
class node_blynk,node_microdot toneMint
class node_firmware,node_datasheets,node_hardware toneRose
class node_user,node_modem,node_blynkservice toneIndigo
```

## Components

### Board support

- [Board quick starts](https://github.com/xinyuan-lilygo/lilygo-modem-series-micropython/tree/main/docs/en): `docs/en`
- [Pin configuration](https://github.com/xinyuan-lilygo/lilygo-modem-series-micropython/blob/main/libraries/utilities.py): `libraries/utilities.py`

### Modem examples

- [ESP32 examples](https://github.com/xinyuan-lilygo/lilygo-modem-series-micropython/tree/main/examples): `examples`
- [GPS and location](https://github.com/xinyuan-lilygo/lilygo-modem-series-micropython/tree/main/examples): `examples`
- [HTTP(S) examples](https://github.com/xinyuan-lilygo/lilygo-modem-series-micropython/tree/main/examples): `examples`
- [MQTT examples](https://github.com/xinyuan-lilygo/lilygo-modem-series-micropython/tree/main/examples): `examples`
- [SMS examples](https://github.com/xinyuan-lilygo/lilygo-modem-series-micropython/tree/main/examples): `examples`
- [Network examples](https://github.com/xinyuan-lilygo/lilygo-modem-series-micropython/tree/main/examples): `examples`

### Runtime libraries

- [Blynk client](https://github.com/xinyuan-lilygo/lilygo-modem-series-micropython/blob/main/libraries/BlynkLib.py): `libraries/BlynkLib.py`
- [HTTP server](https://github.com/xinyuan-lilygo/lilygo-modem-series-micropython/blob/main/libraries/microdot.py): `libraries/microdot.py`

### Firmware and references

- [Prebuilt firmware](https://github.com/xinyuan-lilygo/lilygo-modem-series-micropython/tree/main/firmware): `firmware`
- [Modem references](https://github.com/xinyuan-lilygo/lilygo-modem-series-micropython/tree/main/datasheet): `datasheet`
- [Board designs](https://github.com/xinyuan-lilygo/lilygo-modem-series-micropython/tree/main/schematic): `schematic`

### Other components

- **Device developer**
- **Cellular modem**
- **Blynk service**

## Connections

- Device developer → Board quick starts: chooses board guide (evidence: `README.md`)
- Device developer → ESP32 examples: runs examples
- Device developer → Prebuilt firmware: selects firmware
- Board quick starts → ESP32 examples: explains setup
- Pin configuration → Cellular modem: configures pins
- GPS and location → Cellular modem: uses modem GPS
- HTTP(S) examples → Cellular modem: uses modem HTTP
- MQTT examples → Cellular modem: uses modem MQTT
- SMS examples → Cellular modem: uses modem SMS
- Network examples → Cellular modem: uses modem network
- Blynk client → Blynk service: connects to (evidence: `libraries/BlynkLib.py`)
- Blynk client → Cellular modem: opens socket (evidence: `libraries/BlynkLib.py`)
- HTTP server → Device developer: serves HTTP requests
