No description, website, or topics provided.
Switch branches/tags
Nothing to show
Clone or download
Latest commit cde9aca Feb 12, 2018
Permalink
Failed to load latest commit information.
.gitignore reuploaded Feb 12, 2018
LICENSE reuploaded Feb 12, 2018
README.md reuploaded Feb 12, 2018
SonoffBoilerplate.ino reuploaded Feb 12, 2018

README.md

SonoffBoilerplate

This is a replacement firmware (Arduino IDE with ESP8266 core needed) for the ESP8266 based Sonoff devices. Use it as a starting block for customizing your Sonoff.

What's a "Sonoff"?

Sonoff is just a small ESP8266 based module, that can toggle mains power on it's output. It has everything included in a nice plastic package. See more here Sonoff manufacturer website

What can your code do for me?

The goal of this is to give you a kickstart. Using it as a starter package you should be fairly advanced on the way of making your Sonoff behave the way you want. Adding, removing features should now be trivial.

Features include (strikethrough = not implemented yet)

  • wifi credentials configuration/onboarding using WiFiManager
  • web configuration portal to setup tokes, servers, ports, etc
  • Blynk integration
  • MQTT integration
  • HTTP sever API
  • OTA over the air firmware update
  • turn off and on relay from onboard button and external button

If you want a more complete/complex firmware you should check out the Sonoff-MQTT-OTA-Arduino project.

Getting started

First of all you will need to solder a 4 or 5 pin header on your Sonoff so you can flash the new firmware.

You will need to download any libraries included, they should all have URLs in the source code mentioned, or you can find them in the Arduino Library Manager.

After you have the header, the libraries installed and a serial to usb dongle ready, power up the module while pressing the onboard button. This should put it into programming mode.

Flash the firmware, the module should reset afterwards and the green LED should be blinking. Slow blink = connecting Fast blink = configuration portal started

Being your first run, connect to the Access Point the module created and configure it. If you don t get a configuration popup when connecting, open 192.168.4.1 in your browser.

After it's configured and connected, the green LED should stay lit, and the relay should be enabled (this is the default).

Over-The-Air updates

OTA should also be enabled now and you can do future updates over the air. It uses the basic ArduinoOTA available in Arduino IDE port of the ESP8266 core.

Blynk App

Blynk App is supported in both local server or cloud mode. Add the token and the server details in the web config portal.

MQTT Support

MQTT has now been added You can send messages to deviceId/channel-0 with the following parameters:

  • no parameter (blank) and the device will send it's status back
  • 'on' to turn on
  • 'off' to turn off
  • 'toggle' to toggle between on and off The status will come as a response on topic deviceId/channel-0/status

More information

Here are some posts I wrote on making all this work that you might find helpful

Part 1 - Original Sonoff Introduction

Sonoff (ESP8266) reprogramming – Control Mains from Anywhere

Part 2 - Original Sonoff firmware replacement

Sonoff (ESP8266) Part 2 – Control with Blynk App on iOS or Android

Part 3 - Sonoff POW and S20 Smart Socket Introduction

Sonoff POW and S20 Smart Socket from ITEAD

Part 4 - Sonoff S20 firmware replacement

Coming Soon