ESP-Gateway Long Range* Smart Gateway Solution

ESP-Gateway is a smart gateway solution offered by Espressif, here you will find the modified version that allows espressif WiFi Long Range mode, which supports up to 1 km of data traffic.

flowchart LR
    A(esp32s3-STA) <-- 192.168.4.1 --> B(esp32s3-gateway)
    B(esp32s3-gateway) <-- 192.168.0.1 --> C(Router)
    C(Router) <-- 212.635.124.24 --> Internet
    A(esp32s3-STA) <-- MQTT --> Internet

Field test

• The documented throughput is 1/2 Mbps and 1/4 Mbps.

• Due to 4dB more sensitivity on Long Range mode, the range is expected to be 2.5 times the distance of 11B.

WHAT WE GOT (#TODO)

Table of Contents

• 1. Overview
• 2. Hardware
• 3. Development Environment
• 4. SDK
• 5. Configuration
• 6. Build & Flash & Monitor the Output
• 7. Network Configuration
• 8. Solution Highlights
• 9. GPIO Map

1. Overview

ESP-Gateway is supported by various Espressif chips, as shown in the table below:

Chip	ESP-IDF Release/v4.4.2	ESP-IDF Release/v5.0
ESP32
ESP32-S3

The ESP-Gateway solution provides several network interfaces, which can be divided into two main categories:

• Interfaces for connecting to the Internet

• Interfaces for forwarding network packets for other devices so that they can access the Internet

Users can realize personalized smart gateway solutions through different network interface combinations to maximize the network advantages of Espressif chips.

A variety of functions can be achieved depending on the combination of interfaces, as shown in the table below:

	Wireless Hotspot
Wi-Fi	Wi-Fi Long Range Router
Ethernet	Wi-Fi Long Range Router
Cat.1 4G (UART)	4G Long Range Hotspot
Cat.1 4G (USB)	4G Long Range Hotspot

Notes:

• NIC: network interface controller
• Wi-Fi, Ethernet, Cat.1 4G (UART), and Cat.1 4G (USB) in the first column are interfaces for connecting to the Internet
• The wireless hotspot is interface that provide Internet access to other devices.
• ESP32 doesn't have a USB interface and the USB interface for ESP32-C3 can't be used for application communication. If you need to use USB NIC or Cat.1 4G (USB) function, please choose ESP32-S2 or ESP32-S3.
• Only ESP32 supports Ethernet interface. Other chips need to connect with external Ethernet chip over SPI. For ESP32 MAC & PHY configuration, please refer to Configure MAC and PHY.
• For ESP32 SDIO interface, the pin pull-up requirements should be applied to the hardware. For details, please refer to SD Pull-up Requirements.

1.1 Wi-Fi Router

ESP-Gateway device can connect to the network by connecting to the router via Wi-Fi or by plugging the Ethernet cable into the LAN port of the router. Then other smart devices can connect to the SoftAP hotspot from the ESP-Gateway to access the Internet.

• Currently, ESP-Gateway supports lightweight mesh networking — LiteMesh. Users can customize the hierarchical network provision.

• By enabling ESP_GATEWAY_SOFTAP_SSID_END_WITH_THE_MAC in menuconfig (Gateway Configuration > SoftAP Config), users can add MAC information at the end of SoftAP SSID.

• A single ESP-Gateway device supports up to 10 stations connected at the same time, and bandwidth is shared by these stations.

• You need to configure your network if the ESP-Gateway device connects to the router via Wi-Fi. Currently, the following ways are supported:

  • Configure the network on web page
  • Configure the network through Wi-Fi Provisioning (Bluetooth LE)（ESP32-S2 not supported）

1.2 4G Hotspot

ESP-Gateway device can be equipped with a mobile network module with a SIM card and then convert the cellular network into a Wi-Fi signal. The surrounding smart devices can connect to the hotspot from the ESP-Gateway device to gain Internet access.

The table below shows modules that are compatible with 4G Cat.1.

UART	USB
A7670C	ML302-DNLM/CNLM
EC600N-CN	Air724UG-NFM
SIM76000	EC600N-CNLA-N05
	EC600N-CNLC-N06
	SIMCom A7600C1

2. Hardware

• Linux Environment

The Linux environment is necessary for building, flashing, and running.

For Windows users, it is recommended to install a virtual machine for setting up the Linux environment.

• ESP devices

ESP devices include ESP chips, ESP modules, ESP development boards, etc.

• For Ethernet Router and Ethernet Wireless Card features:
  • ESP32 requires an additional Ethernet PHY chip.
  • Other ESP chips need a chip to convert SPI to Ethernet.
• For the Portable Wi-Fi feature, ESP device requires an additional mobile network module with SIM card.

• USB Cable

USB cable is used to connect PC with ESP devices, flash or download programs, and view logs, etc.

3. Set Up Development Environment

If you are familiar with the ESP development environment, you can easily understand the following steps. If you are not familiar with a certain part, such as building or flashing, please refer to ESP-IDF Programming Guide.

3.1 Download & Set up Toolchain

Please refer to Standard Toolchain Setup for Linux to download and set up the toolchain for building your project.

3.2 Flash/Download Tool

• The flash tool is located under ./components/esptool_py/esptool/esptool.py of ESP-IDF.

• Run the following command to get the full features for esptool:

$ ./components/esptool_py/esptool/esptool.py --help

3.3 Clone ESP-Long-Range-Gateway Repository

$ git clone --recursive https://github.com/ldab/esp-gateway-long-range.git

4. Get SDK

• Get Espressif SDK from ESP-IDF.

• To ensure that the ESP-IDF is successfully obtained, please enter idf.py --version in the terminal. If the output is similar to ESP-IDF v4.4.2, ESP-IDF is installed successfully. For detailed installation and configuration instructions, please refer to ESP-IDF Get Started.

• After successfully obtaining ESP-IDF, please switch its version to the release/v4.4.2 branch.

5. Configuration

Select the interface for connecting to the Internet

Select the interface for forwarding network packets for other devices

• Users can choose a combination of different interfaces to achieve different functions.

• Whether to support the selection of multiple network data forwarding interfaces to provide network functions to different devices?

  IDF Version		Note
  ESP-IDF Release/v4.4.2	Not Support	Only one network data forwarding interface can be selected
  ESP-IDF Release/v5.0	Support	Currently, SDIO and SPI interfaces cannot be selected at the same time

                               +-- USB  <-+->  Computer
                               |
  RasPi + ethsta0 +-- SPI -- ESP32 --> External WiFi（Router）
                               |
                               +-- SoftAP <-+-> Phone
  

• The LiteMesh function can be enabled through the Enable LiteMesh option. For details, please refer to LiteMesh.

ETH Configuration

Modem Configuration

6. Build & Flash & Monitor the Output

6.1 Build the Project

Navigate to the esp-gateway directory and run the following command:

$ idf.py menuconfig

After selecting the appropriate configuration items according to Configuration Items, run the following command to generate the bin file.

$ idf.py build

6.2 Flash & Monitor the Output

Connect the ESP device to the PC with a USB cable, and make sure the right port is used.

6.2.1 Flash onto the Device

$ idf.py flash

6.2.3 Monitor the Output

$ idf.py monitor

You can combine building, flashing and monitoring into one step by running: idf.py build flash monitor.

7. Network Configuration

7.1 Configure Network on Web Page

After the PC or MCU connects to the hotspot from the ESP-Gateway device and obtains the IP address successfully, it can configure the network on the web page by accessing the gateway IP.

7.Solution Highlights

Features	Highlights
Wi-Fi Router (Station)	Act as a Wi-Fi repeater or Wi-Fi signal amplifier, effectively reducing the burden of the router and expanding Wi-Fi coverage
Wi-Fi Router (ETH)	Reduce the number of routers used and lower the deployment cost
4G Hotspot	Network provision is not required; strong mobility; can be used for shared massage chairs, shared power bank and other similar scenarios; low cost (only one shared device equipped with a mobile network module is required, and other devices can connect to the Internet by simply connecting to its hotspot

Please refer to the ESP-Gateway Video which demonstrates some of the features of the ESP-Gateway.

9.GPIO Map