From 85a9bbe8c2940abfa9e5fa7e229432735c12a6fc Mon Sep 17 00:00:00 2001 From: mattbox03 <26332097+mattbox03@users.noreply.github.com> Date: Thu, 19 Nov 2026 23:52:16 +0100 Subject: [PATCH 1/2] docs/site: the USB SIM stick uplink is tested (TCL LinkKey) Owner, 2026-11-19: tested on board A with a TCL LinkKey 4G USB stick as the main uplink (3.0.29/3.0.30 records). README, website and docs drop the experimental label for that path and link the tested stick (affiliate link, disclosed). UART modems, USB serial modems, USB Ethernet adapters, tethering and W5500 stay marked untested. --- README.md | 17 +++++++++++++---- docs/CELLULAR.md | 6 ++++-- docs/HARDWARE.md | 2 +- docs/USB-DEVICES.md | 6 ++++-- website/pages/00-home.html | 2 +- website/pages/01-features.html | 2 +- website/pages/06-getting-started.html | 2 +- website/pages/07-hardware.html | 6 ++++-- website/pages/21-compatibility.html | 2 +- website/pages/25-usb-devices.html | 2 +- 10 files changed, 31 insertions(+), 16 deletions(-) diff --git a/README.md b/README.md index fa872b0..1acf1d7 100644 --- a/README.md +++ b/README.md @@ -37,7 +37,7 @@ Tailscale to use Wake-on-LAN or the backup uplinks. | Use case | What the ESP32 does | | --- | --- | | **Wake and check a NAS or PC — no VPN needed** | Send Wake-on-LAN and verify that the device answers, from a Telegram bot or an ntfy topic. Works with or without Tailscale. [Setup and command reference](https://mattboxx.github.io/RecoveryGateway/remote-recovery/#commands). | -| **Keep IoT devices online** | Use a mobile SIM or wired Ethernet as the main or the backup uplink, with automatic failover and an optional monthly data limit. **SIM:** a 4G/LTE modem wired to the board's pins (UART, e.g. SIM7600 or A7670 modules), or plugged into its USB port (USB LTE modems and 4G sticks, beta). **Ethernet:** a W5500 module on the pins (SPI), or a USB Ethernet adapter or phone tethering on the USB port (beta). [Hardware](https://mattboxx.github.io/RecoveryGateway/hardware/) · [USB devices](docs/USB-DEVICES.md). | +| **Keep IoT devices online** | Use a mobile SIM or wired Ethernet as the main or the backup uplink, with automatic failover and an optional monthly data limit. **SIM:** a 4G/LTE modem wired to the board's pins (UART, e.g. SIM7600 or A7670 modules), or plugged into its USB port (4G USB sticks, tested with a TCL LinkKey, and USB LTE modems). **Ethernet:** a W5500 module on the pins (SPI), or a USB Ethernet adapter or phone tethering on the USB port (beta). [Hardware](https://mattboxx.github.io/RecoveryGateway/hardware/) · [USB devices](docs/USB-DEVICES.md). | | **Connect devices that cannot run Tailscale** | Forward one TCP or UDP service from the local LAN to a Tailnet peer. Restrict the source by IP/CIDR. | | **Reach a remote LAN** | Advertise approved subnets to Tailnet clients. Configure the gateway's own Wi-Fi for IoT devices. | | **Monitor and automate** | Track events and resource trends locally. Optionally use MQTT and Home Assistant, ntfy, Telegram, email or SNMP. | @@ -162,14 +162,23 @@ to you. As an Amazon Associate I earn from qualifying purchases.* Any board in t Details and community reports: [Hardware](docs/HARDWARE.md). -### USB modems, 4G sticks and Ethernet adapters (experimental, from 3.0.25) +### USB 4G sticks, modems and Ethernet adapters (from 3.0.25) Besides a W5500 module or a modem wired to the pins, the gateway can use one USB device on the board's **USB** port (not the COM port): a USB LTE modem or 4G stick with a SIM, a USB Ethernet adapter (Realtek RTL8152/8153/8156, CDC-ECM/NCM) or Android USB tethering. Choose *USB* in first-boot setup or on -the Network page, save, restart, then plug the device. Not yet tested with real -devices. +the Network page, save, restart, then plug the device. + +- **Tested:** a [TCL LinkKey 4G USB stick](https://link.amazon/B08rO5Fv3) with a SIM, as the main + Internet uplink: Tailscale stays connected over mobile data, name lookups + use the SIM, and home devices stay reachable even though the stick uses + the same 192.168.1.x range as the home router (from 3.0.29). +- **Not yet tested with real devices:** USB modems in serial (AT/PPP) mode, + USB Ethernet adapters and phone tethering. Reports are welcome. + +*Affiliate link: buying through it supports the project at no extra cost to +you. As an Amazon Associate I earn from qualifying purchases.* - **The board does not supply 5 V on its USB port.** Use a powered USB-C OTG Y-cable with a 5 V charger (at least 2.5 A for a modem or stick), or the diff --git a/docs/CELLULAR.md b/docs/CELLULAR.md index b8af68d..db78f55 100644 --- a/docs/CELLULAR.md +++ b/docs/CELLULAR.md @@ -1,4 +1,4 @@ -# Cellular uplink (GSM/LTE with a SIM) — experimental +# Cellular uplink (GSM/LTE with a SIM) Firmware 3.0 can use an external cellular modem as its Internet uplink: as the main uplink, or only while WiFi and Ethernet are down (failover). The modem @@ -113,7 +113,9 @@ modem's own default context (or the stick's settings) is used. ### Compatibility -Nothing below has been tested with real hardware yet. "Expected" means the +Tested with real hardware: a **TCL LinkKey 4G USB stick** (`1bbb:0195`, USB +network mode) as the main Internet uplink. Nothing else below has been tested +with real hardware yet. "Expected" means the device exposes interfaces this firmware drives; firmware variants of the same model can differ. diff --git a/docs/HARDWARE.md b/docs/HARDWARE.md index 2381a8b..d451bcb 100644 --- a/docs/HARDWARE.md +++ b/docs/HARDWARE.md @@ -48,7 +48,7 @@ to you. As an Amazon Associate I earn from qualifying purchases.* Any supported | Flash layout | 3.x: two 3.5 MB update slots, settings, core dump and a 832 KB storage area (`partitions.csv`). 2.x gateways move with the [migration guide](MIGRATION-3.0.md); settings are kept. | | Radio | One 2.4 GHz radio shared by uplink and access point. | | Ethernet | Optional W5500 SPI module, driver in the standard image, off until configured; not validated on real hardware: [ETHERNET.md](ETHERNET.md). | -| Cellular | Optional UART modem with a SIM, off until configured; experimental, not tested with a real modem: [CELLULAR.md](CELLULAR.md). | +| Cellular | Optional 4G USB stick or modem with a SIM, off until configured. Tested: TCL LinkKey 4G USB stick; UART modems not yet tested: [CELLULAR.md](CELLULAR.md). | | microSD | Optional log recorder on GPIO38/39/40 (SDMMC 1-bit); those pins are reserved. | | Power | Independent, reliable supply; no power-consumption measurement is claimed. | diff --git a/docs/USB-DEVICES.md b/docs/USB-DEVICES.md index fbcf310..0dfad42 100644 --- a/docs/USB-DEVICES.md +++ b/docs/USB-DEVICES.md @@ -7,8 +7,10 @@ explains which port to use, how to wire it and, above all, **how to power the device**. Which devices are expected to work is listed in [CELLULAR.md](CELLULAR.md#compatibility) and [ETHERNET.md](ETHERNET.md#usb-adapters-and-tethering). -> Experimental: these connections have not been tested yet with real devices. -> Report your board, cable and device (the card shows its `vendor:product`). +> Tested: a TCL LinkKey 4G USB stick (USB ID `1bbb:0195`, network mode) as the +> main Internet uplink, with Tailscale over mobile data. USB modems in serial +> mode, USB Ethernet adapters and tethering are not yet tested with real +> devices: report your board, cable and device (the card shows its `vendor:product`). ## 1. Which port diff --git a/website/pages/00-home.html b/website/pages/00-home.html index c708112..bb4bc37 100644 --- a/website/pages/00-home.html +++ b/website/pages/00-home.html @@ -46,7 +46,7 @@

RecoveryGateway

What you can do

Wake a NAS or PC — no VPN needed

Wake a device and verify that it responds, from a Telegram bot or an ntfy topic. Tailscale is optional: the ESP32 can be just a Wake-on-LAN node.

Set up Wake-on-LAN
-

Keep IoT devices online

Use a mobile SIM or wired Ethernet as the main or backup uplink, with automatic failover and an optional monthly data limit. Connect a 4G/LTE modem or a W5500 Ethernet module to the board's pins, or plug a USB modem, 4G stick or USB Ethernet adapter into its USB port (USB in beta).

Hardware · USB devices
+

Keep IoT devices online

Use a mobile SIM or wired Ethernet as the main or backup uplink, with automatic failover and an optional monthly data limit. Connect a 4G/LTE modem or a W5500 Ethernet module to the board's pins, or plug a 4G USB stick (tested with a TCL LinkKey), a USB modem or a USB Ethernet adapter into its USB port.

Hardware · USB devices

Reach a specific service

Give a device on your LAN access to a selected TCP or UDP service on a Tailnet peer. Restrict access by source IP or subnet.

Service Gateway

Reach a home or IoT network

Advertise approved subnets to Tailnet clients, or give local devices a dedicated Wi-Fi network through the ESP32.

Network modes

Monitor and automate

Review local event history and resource trends. Connect Home Assistant via MQTT, send alerts via Telegram, email or ntfy, or monitor over SNMP.

Automation · Event history
diff --git a/website/pages/01-features.html b/website/pages/01-features.html index e20cc98..c9cf722 100644 --- a/website/pages/01-features.html +++ b/website/pages/01-features.html @@ -27,7 +27,7 @@

Capabilities and defaults

Tailnet names for local devicesDevices without Tailscale on the gateway's Wi-Fi or your home LAN should reach peers by name (nas, nas.your-tailnet.ts.net). A name is not access: rules and policies still apply.Off Telegram and email notificationsYou want problems or every event on your phone or in your inbox. Email over TLS (465) or STARTTLS (587) with verified certificates; passwords are never sent without TLS.Off Throughput testYou need to know whether the link is fast enough: the gateway downloads from a URL (a NAS through the tailnet, or the internet), or the browser downloads from the gateway.On request - Cellular uplink (experimental)A site has no usable Wi-Fi: a UART modem with a SIM as primary or failover uplink. Not yet tested with a real modem.Off + Cellular uplinkA site has no usable Wi-Fi: a 4G USB stick or a modem with a SIM as primary or failover uplink, with an optional monthly data limit. Tested with a TCL LinkKey USB stick; UART modems not yet tested.Off One image, every languageEnglish, Italiano, Español, 简体中文, Français and Deutsch in the same firmware, plus the W5500 Ethernet driver (experimental, off until configured).— diff --git a/website/pages/06-getting-started.html b/website/pages/06-getting-started.html index 5df3ec5..7ed0309 100644 --- a/website/pages/06-getting-started.html +++ b/website/pages/06-getting-started.html @@ -12,7 +12,7 @@

Before you start

diff --git a/website/pages/07-hardware.html b/website/pages/07-hardware.html index af6bb9d..773ddce 100644 --- a/website/pages/07-hardware.html +++ b/website/pages/07-hardware.html @@ -51,9 +51,11 @@

Requirements

Community reports for other ESP32-S3 boards are collected in docs/HARDWARE.md; please add yours with the Hardware report issue form.

-

W5500 Ethernet and cellular (experimental)

+

Cellular (SIM) and W5500 Ethernet

+

Tested 4G USB stick: a TCL LinkKey with a SIM, as the main Internet uplink with Tailscale connected over mobile data. TCL LinkKey 4G USB stick on Amazon

+

Affiliate link: buying through it supports the project at no extra cost to you. As an Amazon Associate I earn from qualifying purchases.

From 3.0.25 a USB LTE modem, a 4G stick, a USB Ethernet adapter or phone tethering can also use the board's USB port. The board does not power that port: read USB modems, sticks and Ethernet adapters before plugging anything in.

-

The standard firmware image includes a driver for an explicitly wired W5500 SPI module: off until configured, explicit pins, DHCP or static IPv4, WiFi-first or Ethernet-first. It is host-tested only and not validated on real hardware; wire it as documented in docs/ETHERNET.md, or use an ESP32-S3 board with built-in Ethernet and PoE (see above). A UART cellular modem with a SIM can be used as a primary or failover uplink, also off until configured and not yet tested with a real modem (docs/CELLULAR.md).

+

The standard firmware image includes a driver for an explicitly wired W5500 SPI module: off until configured, explicit pins, DHCP or static IPv4, WiFi-first or Ethernet-first. It is host-tested only and not validated on real hardware; wire it as documented in docs/ETHERNET.md, or use an ESP32-S3 board with built-in Ethernet and PoE (see above). A UART cellular modem with a SIM can also be used as a primary or failover uplink, off until configured; UART modems are not yet tested with real hardware (docs/CELLULAR.md).

Single radio

The uplink and the access point share one 2.4 GHz radio and channel. After a roam to a different channel the device realigns the AP, which briefly interrupts AP clients.

diff --git a/website/pages/21-compatibility.html b/website/pages/21-compatibility.html index 5ec1b55..2b38890 100644 --- a/website/pages/21-compatibility.html +++ b/website/pages/21-compatibility.html @@ -15,7 +15,7 @@

Hardware

MemoryAt least 8 MB quad flash and 8 MB octal PSRAM: N8R8 and N16R8 modules (N16R8 tested). Not 4 MB flash, R2 or no PSRAM, or octal-flash modules — see Hardware Wi-Fi2.4 GHz network, WPA2/WPA3 Personal or WPA2-Enterprise (PEAP/TTLS) USBNative USB or a USB-to-UART chip, with a data cable - USB uplinksFrom 3.0.25, one USB modem, 4G stick, USB Ethernet adapter or phone on the board's USB port, with its own 5 V supply; experimental, not yet tested with real devices — see USB devices + USB uplinksFrom 3.0.25, one USB modem, 4G stick, USB Ethernet adapter or phone on the board's USB port, with its own 5 V supply. Tested: TCL LinkKey 4G USB stick (mobile data as the main uplink); USB modems in serial mode, USB Ethernet adapters and tethering not yet tested with real devices — see USB devices EthernetOptional W5500 SPI module, driver in the standard image, off until configured; experimental, not hardware-qualified diff --git a/website/pages/25-usb-devices.html b/website/pages/25-usb-devices.html index c819383..eff644e 100644 --- a/website/pages/25-usb-devices.html +++ b/website/pages/25-usb-devices.html @@ -7,7 +7,7 @@ -->

USB modems, sticks and Ethernet adapters

From firmware 3.0.25 the gateway can use one USB device on the board's own USB port: a USB LTE modem or 4G stick for the mobile network (SIM) uplink, or a USB Ethernet adapter or Android USB tethering for the Ethernet uplink. The W5500 module and the modem wired to the pins keep working as before.

-

Experimental. These USB connections have not been tested with real devices yet. If you try one, report your board, cable and device: the Network page shows the device as vendor:product.

+

Tested: a TCL LinkKey 4G USB stick with a SIM, as the main Internet uplink with Tailscale connected over mobile data. USB modems in serial mode, USB Ethernet adapters and phone tethering have not been tested with real devices yet: if you try one, report your board, cable and device (the Network page shows it as vendor:product). Affiliate link: as an Amazon Associate I earn from qualifying purchases.

1. Which port

Most ESP32-S3 N8R8/N16R8 boards have two USB-C sockets:

From 9654726b7a2c548b283e6be18aa9be2d2a7d6a64 Mon Sep 17 00:00:00 2001 From: mattbox03 <26332097+mattbox03@users.noreply.github.com> Date: Thu, 19 Nov 2026 23:54:12 +0100 Subject: [PATCH 2/2] docs/site: name the tested stick model, TCL LinkKey IK41 --- README.md | 4 ++-- docs/CELLULAR.md | 2 +- docs/HARDWARE.md | 2 +- docs/USB-DEVICES.md | 2 +- website/pages/00-home.html | 2 +- website/pages/01-features.html | 2 +- website/pages/07-hardware.html | 2 +- website/pages/21-compatibility.html | 2 +- website/pages/25-usb-devices.html | 2 +- 9 files changed, 10 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 1acf1d7..abf09f4 100644 --- a/README.md +++ b/README.md @@ -37,7 +37,7 @@ Tailscale to use Wake-on-LAN or the backup uplinks. | Use case | What the ESP32 does | | --- | --- | | **Wake and check a NAS or PC — no VPN needed** | Send Wake-on-LAN and verify that the device answers, from a Telegram bot or an ntfy topic. Works with or without Tailscale. [Setup and command reference](https://mattboxx.github.io/RecoveryGateway/remote-recovery/#commands). | -| **Keep IoT devices online** | Use a mobile SIM or wired Ethernet as the main or the backup uplink, with automatic failover and an optional monthly data limit. **SIM:** a 4G/LTE modem wired to the board's pins (UART, e.g. SIM7600 or A7670 modules), or plugged into its USB port (4G USB sticks, tested with a TCL LinkKey, and USB LTE modems). **Ethernet:** a W5500 module on the pins (SPI), or a USB Ethernet adapter or phone tethering on the USB port (beta). [Hardware](https://mattboxx.github.io/RecoveryGateway/hardware/) · [USB devices](docs/USB-DEVICES.md). | +| **Keep IoT devices online** | Use a mobile SIM or wired Ethernet as the main or the backup uplink, with automatic failover and an optional monthly data limit. **SIM:** a 4G/LTE modem wired to the board's pins (UART, e.g. SIM7600 or A7670 modules), or plugged into its USB port (4G USB sticks, tested with a TCL LinkKey IK41, and USB LTE modems). **Ethernet:** a W5500 module on the pins (SPI), or a USB Ethernet adapter or phone tethering on the USB port (beta). [Hardware](https://mattboxx.github.io/RecoveryGateway/hardware/) · [USB devices](docs/USB-DEVICES.md). | | **Connect devices that cannot run Tailscale** | Forward one TCP or UDP service from the local LAN to a Tailnet peer. Restrict the source by IP/CIDR. | | **Reach a remote LAN** | Advertise approved subnets to Tailnet clients. Configure the gateway's own Wi-Fi for IoT devices. | | **Monitor and automate** | Track events and resource trends locally. Optionally use MQTT and Home Assistant, ntfy, Telegram, email or SNMP. | @@ -170,7 +170,7 @@ USB device on the board's **USB** port (not the COM port): a USB LTE modem or CDC-ECM/NCM) or Android USB tethering. Choose *USB* in first-boot setup or on the Network page, save, restart, then plug the device. -- **Tested:** a [TCL LinkKey 4G USB stick](https://link.amazon/B08rO5Fv3) with a SIM, as the main +- **Tested:** a [TCL LinkKey IK41 4G USB stick](https://link.amazon/B08rO5Fv3) with a SIM, as the main Internet uplink: Tailscale stays connected over mobile data, name lookups use the SIM, and home devices stay reachable even though the stick uses the same 192.168.1.x range as the home router (from 3.0.29). diff --git a/docs/CELLULAR.md b/docs/CELLULAR.md index db78f55..b4015ee 100644 --- a/docs/CELLULAR.md +++ b/docs/CELLULAR.md @@ -113,7 +113,7 @@ modem's own default context (or the stick's settings) is used. ### Compatibility -Tested with real hardware: a **TCL LinkKey 4G USB stick** (`1bbb:0195`, USB +Tested with real hardware: a **TCL LinkKey IK41 4G USB stick** (`1bbb:0195`, USB network mode) as the main Internet uplink. Nothing else below has been tested with real hardware yet. "Expected" means the device exposes interfaces this firmware drives; firmware variants of the same diff --git a/docs/HARDWARE.md b/docs/HARDWARE.md index d451bcb..14cdcc2 100644 --- a/docs/HARDWARE.md +++ b/docs/HARDWARE.md @@ -48,7 +48,7 @@ to you. As an Amazon Associate I earn from qualifying purchases.* Any supported | Flash layout | 3.x: two 3.5 MB update slots, settings, core dump and a 832 KB storage area (`partitions.csv`). 2.x gateways move with the [migration guide](MIGRATION-3.0.md); settings are kept. | | Radio | One 2.4 GHz radio shared by uplink and access point. | | Ethernet | Optional W5500 SPI module, driver in the standard image, off until configured; not validated on real hardware: [ETHERNET.md](ETHERNET.md). | -| Cellular | Optional 4G USB stick or modem with a SIM, off until configured. Tested: TCL LinkKey 4G USB stick; UART modems not yet tested: [CELLULAR.md](CELLULAR.md). | +| Cellular | Optional 4G USB stick or modem with a SIM, off until configured. Tested: TCL LinkKey IK41 4G USB stick; UART modems not yet tested: [CELLULAR.md](CELLULAR.md). | | microSD | Optional log recorder on GPIO38/39/40 (SDMMC 1-bit); those pins are reserved. | | Power | Independent, reliable supply; no power-consumption measurement is claimed. | diff --git a/docs/USB-DEVICES.md b/docs/USB-DEVICES.md index 0dfad42..923e460 100644 --- a/docs/USB-DEVICES.md +++ b/docs/USB-DEVICES.md @@ -7,7 +7,7 @@ explains which port to use, how to wire it and, above all, **how to power the device**. Which devices are expected to work is listed in [CELLULAR.md](CELLULAR.md#compatibility) and [ETHERNET.md](ETHERNET.md#usb-adapters-and-tethering). -> Tested: a TCL LinkKey 4G USB stick (USB ID `1bbb:0195`, network mode) as the +> Tested: a TCL LinkKey IK41 4G USB stick (USB ID `1bbb:0195`, network mode) as the > main Internet uplink, with Tailscale over mobile data. USB modems in serial > mode, USB Ethernet adapters and tethering are not yet tested with real > devices: report your board, cable and device (the card shows its `vendor:product`). diff --git a/website/pages/00-home.html b/website/pages/00-home.html index bb4bc37..e3e5cd8 100644 --- a/website/pages/00-home.html +++ b/website/pages/00-home.html @@ -46,7 +46,7 @@

RecoveryGateway

What you can do

Wake a NAS or PC — no VPN needed

Wake a device and verify that it responds, from a Telegram bot or an ntfy topic. Tailscale is optional: the ESP32 can be just a Wake-on-LAN node.

Set up Wake-on-LAN
-

Keep IoT devices online

Use a mobile SIM or wired Ethernet as the main or backup uplink, with automatic failover and an optional monthly data limit. Connect a 4G/LTE modem or a W5500 Ethernet module to the board's pins, or plug a 4G USB stick (tested with a TCL LinkKey), a USB modem or a USB Ethernet adapter into its USB port.

Hardware · USB devices
+

Keep IoT devices online

Use a mobile SIM or wired Ethernet as the main or backup uplink, with automatic failover and an optional monthly data limit. Connect a 4G/LTE modem or a W5500 Ethernet module to the board's pins, or plug a 4G USB stick (tested with a TCL LinkKey IK41), a USB modem or a USB Ethernet adapter into its USB port.

Hardware · USB devices

Reach a specific service

Give a device on your LAN access to a selected TCP or UDP service on a Tailnet peer. Restrict access by source IP or subnet.

Service Gateway

Reach a home or IoT network

Advertise approved subnets to Tailnet clients, or give local devices a dedicated Wi-Fi network through the ESP32.

Network modes

Monitor and automate

Review local event history and resource trends. Connect Home Assistant via MQTT, send alerts via Telegram, email or ntfy, or monitor over SNMP.

Automation · Event history
diff --git a/website/pages/01-features.html b/website/pages/01-features.html index c9cf722..422b7ba 100644 --- a/website/pages/01-features.html +++ b/website/pages/01-features.html @@ -27,7 +27,7 @@

Capabilities and defaults

Tailnet names for local devicesDevices without Tailscale on the gateway's Wi-Fi or your home LAN should reach peers by name (nas, nas.your-tailnet.ts.net). A name is not access: rules and policies still apply.Off Telegram and email notificationsYou want problems or every event on your phone or in your inbox. Email over TLS (465) or STARTTLS (587) with verified certificates; passwords are never sent without TLS.Off Throughput testYou need to know whether the link is fast enough: the gateway downloads from a URL (a NAS through the tailnet, or the internet), or the browser downloads from the gateway.On request - Cellular uplinkA site has no usable Wi-Fi: a 4G USB stick or a modem with a SIM as primary or failover uplink, with an optional monthly data limit. Tested with a TCL LinkKey USB stick; UART modems not yet tested.Off + Cellular uplinkA site has no usable Wi-Fi: a 4G USB stick or a modem with a SIM as primary or failover uplink, with an optional monthly data limit. Tested with a TCL LinkKey IK41 USB stick; UART modems not yet tested.Off One image, every languageEnglish, Italiano, Español, 简体中文, Français and Deutsch in the same firmware, plus the W5500 Ethernet driver (experimental, off until configured).— diff --git a/website/pages/07-hardware.html b/website/pages/07-hardware.html index 773ddce..517cc93 100644 --- a/website/pages/07-hardware.html +++ b/website/pages/07-hardware.html @@ -52,7 +52,7 @@

Requirements

Community reports for other ESP32-S3 boards are collected in docs/HARDWARE.md; please add yours with the Hardware report issue form.

Cellular (SIM) and W5500 Ethernet

-

Tested 4G USB stick: a TCL LinkKey with a SIM, as the main Internet uplink with Tailscale connected over mobile data. TCL LinkKey 4G USB stick on Amazon

+

Tested 4G USB stick: a TCL LinkKey IK41 with a SIM, as the main Internet uplink with Tailscale connected over mobile data. TCL LinkKey IK41 4G USB stick on Amazon

Affiliate link: buying through it supports the project at no extra cost to you. As an Amazon Associate I earn from qualifying purchases.

From 3.0.25 a USB LTE modem, a 4G stick, a USB Ethernet adapter or phone tethering can also use the board's USB port. The board does not power that port: read USB modems, sticks and Ethernet adapters before plugging anything in.

The standard firmware image includes a driver for an explicitly wired W5500 SPI module: off until configured, explicit pins, DHCP or static IPv4, WiFi-first or Ethernet-first. It is host-tested only and not validated on real hardware; wire it as documented in docs/ETHERNET.md, or use an ESP32-S3 board with built-in Ethernet and PoE (see above). A UART cellular modem with a SIM can also be used as a primary or failover uplink, off until configured; UART modems are not yet tested with real hardware (docs/CELLULAR.md).

diff --git a/website/pages/21-compatibility.html b/website/pages/21-compatibility.html index 2b38890..bbbacd9 100644 --- a/website/pages/21-compatibility.html +++ b/website/pages/21-compatibility.html @@ -15,7 +15,7 @@

Hardware

MemoryAt least 8 MB quad flash and 8 MB octal PSRAM: N8R8 and N16R8 modules (N16R8 tested). Not 4 MB flash, R2 or no PSRAM, or octal-flash modules — see Hardware Wi-Fi2.4 GHz network, WPA2/WPA3 Personal or WPA2-Enterprise (PEAP/TTLS) USBNative USB or a USB-to-UART chip, with a data cable - USB uplinksFrom 3.0.25, one USB modem, 4G stick, USB Ethernet adapter or phone on the board's USB port, with its own 5 V supply. Tested: TCL LinkKey 4G USB stick (mobile data as the main uplink); USB modems in serial mode, USB Ethernet adapters and tethering not yet tested with real devices — see USB devices + USB uplinksFrom 3.0.25, one USB modem, 4G stick, USB Ethernet adapter or phone on the board's USB port, with its own 5 V supply. Tested: TCL LinkKey IK41 4G USB stick (mobile data as the main uplink); USB modems in serial mode, USB Ethernet adapters and tethering not yet tested with real devices — see USB devices EthernetOptional W5500 SPI module, driver in the standard image, off until configured; experimental, not hardware-qualified diff --git a/website/pages/25-usb-devices.html b/website/pages/25-usb-devices.html index eff644e..e8bd36c 100644 --- a/website/pages/25-usb-devices.html +++ b/website/pages/25-usb-devices.html @@ -7,7 +7,7 @@ -->

USB modems, sticks and Ethernet adapters

From firmware 3.0.25 the gateway can use one USB device on the board's own USB port: a USB LTE modem or 4G stick for the mobile network (SIM) uplink, or a USB Ethernet adapter or Android USB tethering for the Ethernet uplink. The W5500 module and the modem wired to the pins keep working as before.

-

Tested: a TCL LinkKey 4G USB stick with a SIM, as the main Internet uplink with Tailscale connected over mobile data. USB modems in serial mode, USB Ethernet adapters and phone tethering have not been tested with real devices yet: if you try one, report your board, cable and device (the Network page shows it as vendor:product). Affiliate link: as an Amazon Associate I earn from qualifying purchases.

+

Tested: a TCL LinkKey IK41 4G USB stick with a SIM, as the main Internet uplink with Tailscale connected over mobile data. USB modems in serial mode, USB Ethernet adapters and phone tethering have not been tested with real devices yet: if you try one, report your board, cable and device (the Network page shows it as vendor:product). Affiliate link: as an Amazon Associate I earn from qualifying purchases.

1. Which port

Most ESP32-S3 N8R8/N16R8 boards have two USB-C sockets: