Introduction to a New ESP8266 IoT Framework

This post explains the reasoning and philosophy behind the ESP8266 IoT Framework. Since the framework is evolving over time, some of this post might be outdated. Find the latest on GitHub .

Most projects I do with the ESP8266 require an internet connection. If this would not be needed I would probably use something else like an Arduino for that project. Most of these Internet of Things (IoT) projects require a common set of functions to deal with for instance WiFi connections and HTTP(S) requests. For some of this I already have a few snippets of code, but these are neither robust nor elegant. Therefore I decided to develop a custom framework for the ESP8266. Here I will discuss its requirements.

Before we go into the details, let me start off by listing the basic principles used in developing this framework:

  1. The framework will be built upon the ESP8266 Arduino libraries
  2. The framework will not include any hardware functionality. If I start a new project, I still want to write the code for that project myself, from scratch.
  3. The framework must be fully self-contained for easy deployment. Using the SPIFFS for files needed by the framework is not allowed.
  4. There must be a strict split between the ESP8266 application and the web interface through an API.

In short, the framework must be unobtrusive, easy to deploy, and the web interface should be easy to modify and expand for different projects . With that out of the way, let's see what functions the framwork will cover.

The proposed architecture and functionality of the framework shown in blue

The framework will consist of five main parts. A web server including the interface it's serving, a WiFi manager, a configuration manager and classes for HTTP requests and OTA updates. Each of these parts will be briefly introduced and the most important parts will be detailed out in a follow-up post.

Web Server

A web server is required to present a web interface which is needed to configure WiFi and other settings from the browser. This web interface will be developed in React, and communicate with the ESP8266 through an API. To be able to get and set information from this API, the web server class will interact with the other framework modules.

WiFi Manager

The function of the WiFi manager is to help the user connect to a WiFi network. If no known network is found the ESP8266 should start a hotspot with a captive portal in which the network settings can be changed. WiFi information will be preserved in memory so that the ESP8266 will connect automatically in the future.

Configuration Manager

For whatever function a device with an ESP8266 might have, it could be that you want the user to change some settings or parameters. For instance with my linear clock, The user could want to change the display mode or the colors of the clock. The configuration manager will aim to provide a method to modify parameters from the broswer which will be accessible from the software application.

HTTPS Requests

Fetching or posting data to the internet is one of the core tasks of an IoT device. Doing so over HTTP is implemented quite well in the default ESP8266 Arduino libraries, but for HTTPS requests things are less straightforward. This class will aim to implement arbitrary HTTPS requests in a secure way, without requiring any specific certificates or fingerprints to be hard coded in the application.

OTA Updates

Finally the framework will provide a function to update the firmware on the ESP8266 from the browser. This can be useful when you give or sell your products to somebody else and need to update the software later on.

ESP8266 IoT Framework

Project 0x004 Finshed

In this project I develop a framework to be used as in new ESP8266 projects, implementing HTTPS requests, a React web interface and a configuration manager.

View on GitHub