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-LANdiff --git a/README.md b/README.md index fa872b0..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 (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 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. | @@ -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 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). +- **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..b4015ee 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 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 model can differ. diff --git a/docs/HARDWARE.md b/docs/HARDWARE.md index 2381a8b..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 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 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 fbcf310..923e460 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 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`). ## 1. Which port diff --git a/website/pages/00-home.html b/website/pages/00-home.html index c708112..e3e5cd8 100644 --- a/website/pages/00-home.html +++ b/website/pages/00-home.html @@ -46,7 +46,7 @@
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-LANUse 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 devicesUse 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 devicesGive 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 GatewayAdvertise approved subnets to Tailnet clients, or give local devices a dedicated Wi-Fi network through the ESP32.
Network modesReview local event history and resource trends. Connect Home Assistant via MQTT, send alerts via Telegram, email or ntfy, or monitor over SNMP.
Automation · Event historynas, nas.your-tailnet.ts.net). A name is not access: rules and policies still apply.Community reports for other ESP32-S3 boards are collected in docs/HARDWARE.md; please add yours with the Hardware report issue form.
-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 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).
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..bbbacd9 100644 --- a/website/pages/21-compatibility.html +++ b/website/pages/21-compatibility.html @@ -15,7 +15,7 @@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 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.
Most ESP32-S3 N8R8/N16R8 boards have two USB-C sockets: