Published May 13, 2020 © GPL3+

ESP32 Wireless Mesh ( Made Easy with PainlessMesh ) - Part 1

Lets build a complete wireless mesh network, fully functional, with all the features you need. A starting point for your next project

IntermediateProtip1 hour34,544

Story

Long story short

There's nothing more simple than the concept of a wireless mesh network... but there's nothing more complex than building such a mesh. A steep learning curve is involved ( and, worst af all, the examples you may find never cover the whole story ) !

Here the steps to build your mesh ( we will cover each separately ):

1) build the mesh between nodes - easy

2) add ota ( wireless ) update of the nodes - intermediate

3) add a bridge ( to the internet ) - intermediate

4) an app ( to access the mesh from anywhere ) - intermediate

Let's start from the first step.

Parts required

ESP32 development boards ( two or more ), I used a ttgo t-display
PlatformIO development software ( install from here)
PainlessMesh library

Programming

After programming the boards with the node software you should have something like this

NOTE: You should program one board with the WHITE define enabled ( line 22 ) and the other board with the RED define enabled ( line 23 )

The code simply:

creates a wireless mesh ( see defines in line 15-17 )
writes the software version, the id of the node and the number of nodes in the mesh on the first 3 lines ( yes I know is the number of the 'other nodes' in the mesh, but I was too lazy to add 1 to the value returned by nodes.size() )
writes the message received on the fourth line
broadcasts a message ( to all the other nodes ) every time the lower button is pressed

Now you can add other nodes and they will be automatically discovered and added to the mesh ( after a small delay )

Mesh testing

Now you know that the nodes ( a few inches apart ) on your desk are able to communicate.

So lets space a node until it is out of the mesh range ( until the mesh node count decreases ) now add a new node 'in between', a green node, ( let's call it 'the-node-in-the-middle' attack )... and after a small delay... the node is automagically reconnected.

Good job, your mesh is indeed self configuring, self healing, self recovering...

NOTE It is never a good idea to keep the nodes too close to each other ( as shown on the video ;-)

What Next?

This is the first ( and easy ) step of our job.

In the next step we'll continue adding ota support.

MeshLamp ( fast and easy project )

If you are not happy with the basic node software proposed let's see how easily we can control a lamp with a switch using our wireless mesh.

Parts Required

Same as above

Programming

After programming the boards with the MeshLamp software you should have something like this

NOTE: You should program both boards with the same software ( and yes both boards are switch and lamp at the same time )

The code simply:

creates a wireless mesh ( see defines in line 15-17 )
the lower button toggle the associated lamp ( or all lamps if no association performed )
the higher button perform the association: short press on the lamp, long press on the switch and the association is completed

Last Note on the board

I do not recommend any hardware or software

The ttgo t-display I used is a small and inexpensive ESP32 board, with a small color display ( 240x135 ), onboard antenna ( sorry no external antenna connector ), tp4054 battery charger, cp2014 usb converter, no sd slot, small form factor. It becomes quite warm during usage. Can't say nothing about its reliability. Here you can find a small documentation.

//************************************************************
// this is a simple example that uses the painlessMesh library
//
// 1. sends a silly message to every node on the mesh at a random time between 1 and 5 seconds
// 2. prints anything it receives to Serial.print
//
//
//************************************************************
//#include <Arduino.h>
#include "painlessMesh.h"
#include "Button2.h"
#include <TFT_eSPI.h>

#define   MESH_PREFIX     "whateverYouLike"
#define   MESH_PASSWORD   "somethingSneaky"
#define   MESH_PORT       5555

Scheduler userScheduler; // to control your personal task
painlessMesh  mesh;

// uncomment only one of the following
#define WHITE
//#define RED
//#define GREEN

#ifdef WHITE
#define ROLE    "white"
#define VERSION "WHITE v1.0.0"
#define MESSAGE "White "
#endif

#ifdef RED
#define ROLE    "red"
#define VERSION "RED - 1.0.0"
#define MESSAGE "Red "
#endif

#ifdef GREEN
#define ROLE    "green"
#define VERSION "GREEN - 1.0.0"
#define MESSAGE "Green "
#endif

// TFT start
#ifndef TFT_DISPOFF
#define TFT_DISPOFF 0x28
#endif

#ifndef TFT_SLPIN
#define TFT_SLPIN   0x10
#endif

#define TFT_MOSI            19
#define TFT_SCLK            18
#define TFT_CS              5
#define TFT_DC              16
#define TFT_RST             23

#define TFT_BL          4   // Display backlight control pin
#define ADC_EN          14  //ADC_EN is the ADC detection enable port
#define ADC_PIN         34
#define BUTTON_1        35
#define BUTTON_2        0

TFT_eSPI tft = TFT_eSPI(135, 240); // Invoke custom library
// TFT end
Button2 btn1(BUTTON_1);
Button2 btn2(BUTTON_2);

bool calc_delay = false;
SimpleList<uint32_t> nodes;
uint32_t nsent=0;
char buff[512];


// User stub
void sendMessage(String msg) ; // Prototype so PlatformIO doesn't complain

//Task taskSendMessage( TASK_SECOND * 1 , TASK_FOREVER, &sendMessage );

// Needed for painless library


void receivedCallback( uint32_t from, String &msg ) 
  {
  Serial.printf("Rx from %u <- %s\n", from, msg.c_str());

  if (strcmp(msg.c_str(),"GETRT") == 0)
    {
    mesh.sendBroadcast( mesh.subConnectionJson(true).c_str() );
    }
  else
    {
    sprintf(buff,"Rx:%s",msg.c_str());
    tft.drawString(buff, 0, 48);
    }
  
  }



void newConnectionCallback(uint32_t nodeId) 
  {
  Serial.printf("--> Start: New Connection, nodeId = %u\n", nodeId);
  Serial.printf("--> Start: New Connection, %s\n", mesh.subConnectionJson(true).c_str());
  }



void changedConnectionCallback() 
  {
  Serial.printf("Changed connections\n");

  nodes = mesh.getNodeList();
  Serial.printf("Num nodes: %d\n", nodes.size());
  Serial.printf("Connection list:");
  SimpleList<uint32_t>::iterator node = nodes.begin();
  while (node != nodes.end()) 
    {
    Serial.printf(" %u", *node);
    node++;
    }
  Serial.println();
  calc_delay = true;

  sprintf(buff,"Nodes:%d",nodes.size());
  tft.drawString(buff, 0, 32);
  }



void nodeTimeAdjustedCallback(int32_t offset) 
  {
  Serial.printf("Adjusted time %u Offset = %d\n", mesh.getNodeTime(),offset);
  }



void onNodeDelayReceived(uint32_t nodeId, int32_t delay)
  {
  Serial.printf("Delay from node:%u delay = %d\n", nodeId,delay);
  }




void sendMessage(String msg) {
  if (strcmp(msg.c_str(), "") == 0)
    {
    nsent++;
    msg = MESSAGE;
    //msg += mesh.getNodeId();
    msg += nsent;
    }
  mesh.sendBroadcast( msg );
  Serial.printf("Tx-> %s\n", msg.c_str());

  sprintf(buff,"Tx:%s",msg.c_str());
  tft.drawString(buff, 0, 64);

  if (calc_delay) 
    {
    SimpleList<uint32_t>::iterator node = nodes.begin();
    while (node != nodes.end()) 
      {
      mesh.startDelayMeas(*node);
      node++;
      }
    calc_delay = false;
    }

  //taskSendMessage.setInterval( random( TASK_SECOND * 2, TASK_SECOND * 10 ));
}




void button_setup()
{
  // button dx
  btn1.setPressedHandler([](Button2 & b) 
    {
    sendMessage("GETRT");   // get routing table
    });
  
  // button sx
  btn2.setPressedHandler([](Button2 & b) 
    {
    sendMessage("");
    });
}




void setup() 
  {
  Serial.begin(115200);

  // TFT
  tft.init();
  tft.setRotation(1);
  tft.fillScreen(TFT_BLACK);
  //tft.setTextSize(4);
  tft.setTextColor(TFT_GREEN,TFT_BLACK);
  tft.setCursor(0, 0);
  tft.setTextDatum(MC_DATUM);
  tft.setTextSize(2);

  if (TFT_BL > 0) 
    { // TFT_BL has been set in the TFT_eSPI library in the User Setup file TTGO_T_Display.h
    pinMode(TFT_BL, OUTPUT); // Set backlight pin to output mode
    digitalWrite(TFT_BL, TFT_BACKLIGHT_ON); // Turn backlight on. TFT_BACKLIGHT_ON has been set in the TFT_eSPI library in the User Setup file TTGO_T_Display.h
    }
  tft.fillScreen(TFT_BLACK);
  tft.setTextDatum(TL_DATUM);
  tft.drawString(VERSION, 0, 0);
  //tft.setTextDatum(MC_DATUM);
  //tft.drawString("LeftButton:", tft.width() / 2, tft.height() / 2 - 16);

  //mesh.setDebugMsgTypes( ERROR | MESH_STATUS | CONNECTION | SYNC | COMMUNICATION | MSG_TYPES | REMOTE ); // all types on except GENERAL
  //mesh.setDebugMsgTypes( ERROR | MESH_STATUS | CONNECTION | SYNC | COMMUNICATION | GENERAL | MSG_TYPES | REMOTE ); // all types on
  mesh.setDebugMsgTypes( ERROR | STARTUP );  // set before init() so that you can see startup messages

  mesh.init( MESH_PREFIX, MESH_PASSWORD, &userScheduler, MESH_PORT );
  mesh.onReceive(&receivedCallback);
  mesh.onNewConnection(&newConnectionCallback);
  mesh.onChangedConnections(&changedConnectionCallback);
  mesh.onNodeTimeAdjusted(&nodeTimeAdjustedCallback);

  // if you want your node to accept OTA firmware, simply include this line
  // with whatever role you want your hardware to be. For instance, a
  // mesh network may have a thermometer, rain detector, and bridge. Each of
  // those may require different firmware, so different roles are preferrable.
  //
  // MAKE SURE YOUR UPLOADED OTA FIRMWARE INCLUDES OTA SUPPORT OR YOU WILL LOSE
  // THE ABILITY TO UPLOAD MORE FIRMWARE OVER OTA. YOU ALSO WANT TO MAKE SURE
  // THE ROLES ARE CORRECT
  mesh.initOTAReceive(ROLE);

  //userScheduler.addTask( taskSendMessage );
  //taskSendMessage.enable();
  
  sprintf(buff,"Id:%d",mesh.getNodeId());
  tft.drawString(buff, 0, 16);

  button_setup();
  }






void loop() 
  {
  // it will run the user scheduler as well
  mesh.update();
  btn1.loop();
  btn2.loop();
  }

//************************************************************
// this is a simple example that uses the painlessMesh library
//
// 1. uses btn2 to turn on/off a lamp 
// 2. uses btn1 to 'join' a lamp
// 3. simulates a lamp
//
//************************************************************
//#include <Arduino.h>
#include "painlessMesh.h"
#include "Button2.h"
#include <TFT_eSPI.h>

#define   MESH_PREFIX     "whateverYouLike"
#define   MESH_PASSWORD   "somethingSneaky"
#define   MESH_PORT       5555

Scheduler userScheduler; // to control your personal task
painlessMesh  mesh;

#define ROLE    "switchlamp"
#define VERSION "SWITCHLAMP v1.0.0"
#define MESSAGE "switchlamp "

// TFT start
#ifndef TFT_DISPOFF
#define TFT_DISPOFF 0x28
#endif

#ifndef TFT_SLPIN
#define TFT_SLPIN   0x10
#endif

#define TFT_MOSI            19
#define TFT_SCLK            18
#define TFT_CS              5
#define TFT_DC              16
#define TFT_RST             23

#define TFT_BL          4   // Display backlight control pin
#define ADC_EN          14  //ADC_EN is the ADC detection enable port
#define ADC_PIN         34
#define BUTTON_1        35
#define BUTTON_2        0

TFT_eSPI tft = TFT_eSPI(135, 240); // Invoke custom library
// TFT end
Button2 btn1(BUTTON_1);
Button2 btn2(BUTTON_2);

bool calc_delay = false;
SimpleList<uint32_t> nodes;
uint32_t nsent=0;
char buff[512];
uint8_t iLampState1=0;
uint32_t iLastAddr=0;
uint32_t iAddr1=0;


// User stub
//void sendMessage(String msg) ; // Prototype so PlatformIO doesn't complain

//Task taskSendMessage( TASK_SECOND * 1 , TASK_FOREVER, &sendMessage );

// Needed for painless library


void receivedCallback( uint32_t from, String &msg ) 
  {
  Serial.printf("Rx from %u <- %s\n", from, msg.c_str());
  sprintf(buff,"Rx:%s    ",msg.c_str());
  tft.drawString(buff, 0, 48);

  if (strcmp(msg.c_str(),"GETRT") == 0)
    {
    mesh.sendBroadcast( mesh.subConnectionJson(true).c_str() );
    }
  else if (strcmp(msg.c_str(),"toggle1") == 0)
    {
    iLampState1=!iLampState1;
    tft.fillRect(0,80,240,135-80,iLampState1?TFT_WHITE:TFT_BLACK);      
    }
  else if (strcmp(msg.c_str(),"on1") == 0)
    {
    iLampState1=1;
    tft.fillRect(0,80,240,135-80,iLampState1?TFT_WHITE:TFT_BLACK);      
    }
  else if (strcmp(msg.c_str(),"off1") == 0)
    {
    iLampState1=0;
    tft.fillRect(0,80,240,135-80,iLampState1?TFT_WHITE:TFT_BLACK);      
    }
  else if (strcmp(msg.c_str(),"join") == 0)
    {
    iLastAddr=from;
    }
  }



void newConnectionCallback(uint32_t nodeId) 
  {
  Serial.printf("--> Start: New Connection, nodeId = %u\n", nodeId);
  Serial.printf("--> Start: New Connection, %s\n", mesh.subConnectionJson(true).c_str());
  }



void changedConnectionCallback() 
  {
  Serial.printf("Changed connections\n");

  nodes = mesh.getNodeList();
  Serial.printf("Num nodes: %d\n", nodes.size());
  Serial.printf("Connection list:");
  SimpleList<uint32_t>::iterator node = nodes.begin();
  while (node != nodes.end()) 
    {
    Serial.printf(" %u", *node);
    node++;
    }
  Serial.println();
  calc_delay = true;

  sprintf(buff,"Nodes:%d",nodes.size());
  tft.drawString(buff, 0, 32);
  }



void nodeTimeAdjustedCallback(int32_t offset) 
  {
  Serial.printf("Adjusted time %u Offset = %d\n", mesh.getNodeTime(),offset);
  }



void onNodeDelayReceived(uint32_t nodeId, int32_t delay)
  {
  Serial.printf("Delay from node:%u delay = %d\n", nodeId,delay);
  }




void sendMessage(String msg, uint32_t addr) {
  if (strcmp(msg.c_str(), "") == 0)
    {
    nsent++;
    msg = MESSAGE;
    msg += nsent;
    }
  if (addr)
    mesh.sendSingle( addr, msg );
  else
    mesh.sendBroadcast( msg );
  Serial.printf("Tx-> %s\n", msg.c_str());

  sprintf(buff,"Tx:%s    ",msg.c_str());
  tft.drawString(buff, 0, 64);

  if (calc_delay) 
    {
    SimpleList<uint32_t>::iterator node = nodes.begin();
    while (node != nodes.end()) 
      {
      mesh.startDelayMeas(*node);
      node++;
      }
    calc_delay = false;
    }

  //taskSendMessage.setInterval( random( TASK_SECOND * 2, TASK_SECOND * 10 ));
}




void button_setup()
{
  // button dx
  btn1.setPressedHandler([](Button2 & b) 
    {
    if (iLastAddr)
      {iAddr1=iLastAddr;}
    });
  btn1.setLongClickHandler([](Button2 & b) 
    {
    sendMessage("join",0);
    });
  
  // button sx
  btn2.setPressedHandler([](Button2 & b) 
    {
    sendMessage("toggle1",iAddr1);
    });
}




void setup() 
  {
  Serial.begin(115200);

  // TFT
  tft.init();
  tft.setRotation(1);
  tft.fillScreen(TFT_BLACK);
  //tft.setTextSize(4);
  tft.setTextColor(TFT_GREEN,TFT_BLACK);
  tft.setCursor(0, 0);
  tft.setTextDatum(MC_DATUM);
  tft.setTextSize(2);

  if (TFT_BL > 0) 
    { // TFT_BL has been set in the TFT_eSPI library in the User Setup file TTGO_T_Display.h
    pinMode(TFT_BL, OUTPUT); // Set backlight pin to output mode
    digitalWrite(TFT_BL, TFT_BACKLIGHT_ON); // Turn backlight on. TFT_BACKLIGHT_ON has been set in the TFT_eSPI library in the User Setup file TTGO_T_Display.h
    }
  tft.fillScreen(TFT_BLACK);
  tft.setTextDatum(TL_DATUM);
  tft.drawString(VERSION, 0, 0);

  //mesh.setDebugMsgTypes( ERROR | MESH_STATUS | CONNECTION | SYNC | COMMUNICATION | MSG_TYPES | REMOTE ); // all types on except GENERAL
  //mesh.setDebugMsgTypes( ERROR | MESH_STATUS | CONNECTION | SYNC | COMMUNICATION | GENERAL | MSG_TYPES | REMOTE ); // all types on
  mesh.setDebugMsgTypes( ERROR | STARTUP );  // set before init() so that you can see startup messages

  mesh.init( MESH_PREFIX, MESH_PASSWORD, &userScheduler, MESH_PORT );
  mesh.onReceive(&receivedCallback);
  mesh.onNewConnection(&newConnectionCallback);
  mesh.onChangedConnections(&changedConnectionCallback);
  mesh.onNodeTimeAdjusted(&nodeTimeAdjustedCallback);

  // if you want your node to accept OTA firmware, simply include this line
  // with whatever role you want your hardware to be. For instance, a
  // mesh network may have a thermometer, rain detector, and bridge. Each of
  // those may require different firmware, so different roles are preferrable.
  //
  // MAKE SURE YOUR UPLOADED OTA FIRMWARE INCLUDES OTA SUPPORT OR YOU WILL LOSE
  // THE ABILITY TO UPLOAD MORE FIRMWARE OVER OTA. YOU ALSO WANT TO MAKE SURE
  // THE ROLES ARE CORRECT
  mesh.initOTAReceive(ROLE);

  //userScheduler.addTask( taskSendMessage );
  //taskSendMessage.enable();
  
  sprintf(buff,"Id:%d",mesh.getNodeId());
  tft.drawString(buff, 0, 16);

  button_setup();
  }






void loop() 
  {
  // it will run the user scheduler as well
  mesh.update();
  btn1.loop();
  btn2.loop();
  }

Credits

davidefa

4 projects • 36 followers

Please don't reinvent the wheel

ESP32 Wireless Mesh ( Made Easy with PainlessMesh ) - Part 1

Story

Long story short

Parts required

Programming

Mesh testing

What Next?

MeshLamp ( fast and easy project )

Last Note on the board

Code

Node.cpp

MeshLamp

platformio.ini

Credits

davidefa

Comments

Embed the widget on your own site

ESP32 Wireless Mesh ( Made Easy with PainlessMesh ) - Part 1

ESP32 Wireless Mesh ( Made Easy with PainlessMesh ) - Part 1

Story

Long story short

Parts required

Programming

Mesh testing

What Next?

MeshLamp ( fast and easy project )

Last Note on the board

Code

Node.cpp

MeshLamp

platformio.ini

Credits

davidefa

Comments

Related channels and tags