Building a WiFi Gateway using ESP8266

created by hek , updated

It's possible to build a WIFI enabled gateway running directly on an ESP8266 module. The porting has been done by Yveaux and has been documented here.

The easiest build option is probably to use the NodeMcu Devkit v.10 (by the NodeMcu Team). Schematics and layout can be found here. This board has the ESP-12 module mounted. Just connect the radio, install gateway software and you're good to go.

NodeMCU Radio Comment
3V3 VCC Red
D2 CE Orange
D8 CSN/CS Yellow
D5 SCK Green
D7 MOSI Blue
D6 MISO Violet

Note: The IRQ is currently not used by the MySensors library so it can be left un-connected.

Installing Gateway Software

The standard ESP8266 Gateway sketch can be used without modification (except for SSID & password).

Setting things up

  • Install Arduino IDE 1.6.5+
  • Add support for ESP8266 to Arduino, see Installing with Boards Manager
  • Install the latest MySensors library from the Library Manager.
  • Install CP2102 drivers from here.
  • Connect NodeMCU board.

Compiling and uploading the gateway sketch

  • Open the WiFi gateway in the Arduino IDE (File -> Sketchbook -> Libraries -> MySensors -> Esp8266Gateway
  • Save it, to allow editing
  • Enter your SSID and WiFi password in the 'ssid' and 'pass' variables
  • Select the ESP8266 board you're targeting in Tools -> Board. Use an ESP12 module, which is a 'NodeMCU 1.0 (ESP 12E module)' board target.
  • Verify your sketch. It should compile without errors.
  • Now upload the sketch. This NodeMCU board normally can be flashed automatically and shouldn't need bootload/reset buttons to be pressed. If you see error, try changing baudrate from from 9600 to 57600. Still problems? Hold flash and press reset. Start upload in IDE while keeping flash-button pressed until upload starts.
  • Open the serial console and watch the board connecting to your WiFi network.
  • Note the IP address assigned to it. Optionally, enable a static ip in your DHCP server if you prefer to keep same ip at the next startup.
  • Any application capable of communicating with the regular MySensors Ethernet gateway should be able to communicate with the ESP Gateway
  • Enjoy!

To verify things you can connect a telnet session (e.g. putty) to the IP address mentioned in the serial output, port 5003 and send some serial commands!


See advanced build options for more about inclusion button and leds.

ESP8266Gateway Example

 * The MySensors Arduino library handles the wireless radio link and protocol
 * between your home built sensors/actuators and HA controller of choice.
 * The sensors forms a self healing radio network with optional repeaters. Each
 * repeater and gateway builds a routing tables in EEPROM which keeps track of the
 * network topology allowing messages to be routed to nodes.
 * Created by Henrik Ekblad <[email protected]>
 * Copyright (C) 2013-2015 Sensnology AB
 * Full contributor list:
 * Documentation:
 * Support Forum:
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * version 2 as published by the Free Software Foundation.
 * Version 1.0 - Henrik EKblad
 * Contribution by a-lurker and Anticimex,
 * Contribution by Norbert Truchsess <[email protected]>
 * Contribution by Ivo Pullens (ESP8266 support)
 * The EthernetGateway sends data received from sensors to the WiFi link.
 * The gateway also accepts input on ethernet interface, which is then sent out to the radio network.
 * Enter "ip-number:port" in the ip-field of the Arduino GW device. This will temporarily override any serial configuration for the Vera plugin.
 * E.g. If you want to use the defualt values in this sketch enter:
 * LED purposes:
 * - To use the feature, uncomment any of the MY_DEFAULT_xx_LED_PINs in your sketch, only the LEDs that is defined is used.
 * - RX (green) - blink fast on radio message recieved. In inclusion mode will blink fast only on presentation recieved
 * - TX (yellow) - blink fast on radio message transmitted. In inclusion mode will blink slowly
 * - ERR (red) - fast blink on error during transmission error or recieve crc error
 * See for wiring instructions.
 * nRF24L01+  ESP8266
 * VCC        VCC
 * CE         GPIO4
 * CSN/CS     GPIO15
 * SCK        GPIO14
 * MISO       GPIO12
 * MOSI       GPIO13
 * GND        GND
 * Not all ESP8266 modules have all pins available on their external interface.
 * This code has been tested on an ESP-12 module.
 * The ESP8266 requires a certain pin configuration to download code, and another one to run code:
 * - Connect REST (reset) via 10K pullup resistor to VCC, and via switch to GND ('reset switch')
 * - Connect GPIO15 via 10K pulldown resistor to GND
 * - Connect CH_PD via 10K resistor to VCC
 * - Connect GPIO2 via 10K resistor to VCC
 * - Connect GPIO0 via 10K resistor to VCC, and via switch to GND ('bootload switch')
  * Inclusion mode button:
 * - Connect GPIO5 via switch to GND ('inclusion switch')
 * Hardware SHA204 signing is currently not supported!
 * Make sure to fill in your ssid and WiFi password below for ssid & pass.

// Enable debug prints to serial monitor
#define MY_DEBUG

// Use a bit lower baudrate for serial prints on ESP8266 than default in MyConfig.h
#define MY_BAUD_RATE 9600

// Enables and select radio type (if attached)
#define MY_RADIO_NRF24
//#define MY_RADIO_RFM69

#define MY_GATEWAY_ESP8266

#define MY_ESP8266_SSID "MySSID"
#define MY_ESP8266_PASSWORD "MyVerySecretPassword"

// Enable UDP communication
//#define MY_USE_UDP

// Set the hostname for the WiFi Client. This is the hostname
// it will pass to the DHCP server if not static.
// #define MY_ESP8266_HOSTNAME "sensor-gateway"

// Enable MY_IP_ADDRESS here if you want a static ip address (no DHCP)
//#define MY_IP_ADDRESS 192,168,178,87

// If using static ip you need to define Gateway and Subnet address as well
#define MY_IP_GATEWAY_ADDRESS 192,168,178,1
#define MY_IP_SUBNET_ADDRESS 255,255,255,0

// The port to keep open on node server mode
#define MY_PORT 5003

// How many clients should be able to connect to this gateway (default 1)

// Controller ip address. Enables client mode (default is "server" mode).
// Also enable this if MY_USE_UDP is used and you want sensor data sent somewhere.
//#define MY_CONTROLLER_IP_ADDRESS 192, 168, 178, 68

// Enable inclusion mode

// Enable Inclusion mode button on gateway
// Set inclusion mode duration (in seconds)
// Digital pin used for inclusion mode button

// Set blinking period

// Flash leds on rx/tx/err
// Led pins used if blinking feature is enabled above
#define MY_DEFAULT_ERR_LED_PIN 16  // Error led pin
#define MY_DEFAULT_RX_LED_PIN  16  // Receive led pin
#define MY_DEFAULT_TX_LED_PIN  16  // the PCB, on board LED

#if defined(MY_USE_UDP)
  #include <WiFiUdp.h>

#include <ESP8266WiFi.h>

#include <MySensors.h>

void setup() {

void presentation() {
  // Present locally attached sensors here

void loop() {
  // Send locally attached sensors data here

Shopping Guide

10pcs NRF24L01+ 2.4GHz Wireless Transceiver
This is what enables your sensors to communicate wirelessly across a nominal range of 60 meters.
1752 available - $9.99   Buy
In stock - $7.75   Buy
NodeMcu Lua development board
ESP8266 Wifi module with USB and auto reset which makes it easy to program from Arduino IDE.
3119 available - $3.50   Buy
Stock unknown   Buy
Short Dupont jumper cables Female->Female. 10cm
Cables used for connecting radio and sensors.
238 available - $0.99   Buy
In stock - $0.90   Buy