Fork of the espurna firmware for `mhsw` switches
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
 
 
Xose Pérez 52a63b1849 Changes in file comment headers 8 years ago
code Changes in file comment headers 8 years ago
images/devices Version bump 8 years ago
.gitignore Bump fs version 8 years ago
.gitmodules Declared all libraries as PlatformIO dependencies, updated documentation 8 years ago
CHANGELOG.md Changes in file comment headers 8 years ago
LICENSE Initial commit 8 years ago
README.md Version and year bump 8 years ago

README.md

ESPurna Firmware

ESPurna ("spark" in Catalan) is a custom firmware for ESP8266 based smart switches. It was originally developed with the IteadStudio Sonoff in mind but now it supports a growing number of ESP8266-based boards. It uses the Arduino Core for ESP8266 framework and a number of 3rd party libraries.

Current Release Version is 1.4.3, read the changelog.

Features

  • Support for multiple ESP8266-based boards (check list)
  • Wifi AP Mode or STA mode with multiple network definitions and static IP support
  • MQTT enabled
    • Switch on/off and toggle relays
    • LED notifications
  • Support for different sensors
    • DHT11 / DHT22 / DHT21 / AM2301
    • DS18B20
    • HLW8012 (Sonoff POW)
    • Non-invasive current sensor using the EmonLiteESP Library (requires some hacking)
  • Fast asynchronous HTTP Server
    • Basic authentication
    • Web-based configuration
    • Relay switching from the web
    • Websockets-based communication between the device and the browser
  • REST API
    • GET and PUT relay status
  • Command line configuration
  • Over-The-Air (OTA) updates even for 1Mb boards
    • Manually from PlatformIO or Arduino Inside
    • Automatic updates through the NoFUSS Library
  • Alexa integration using the FauxmoESP Library
  • Domoticz integration via MQTT

Documentation

For more information please refer to the ESPurna Wiki.

Supported hardware

|IteadStudio S20 IteadStudio S20|IteadStudio Slampher IteadStudio Slampher|IteadStudio Sonoff 4CH IteadStudio Sonoff 4CH| |IteadStudio Sonoff Basic IteadStudio Sonoff Basic|IteadStudio Motor Switch IteadStudio Motor Switch|IteadStudio 1CH Inching IteadStudio 1CH Inching| |IteadStudio Sonoff Dual IteadStudio Sonoff Dual|IteadStudio Sonoff POW IteadStudio Sonoff POW|IteadStudio Sonoff TH10/TH16 IteadStudio Sonoff TH10/TH16| |IteadStudio Sonoff RF IteadStudio Sonoff RF|IteadStudio Sonoff SV IteadStudio Sonoff SV|IteadStudio Sonoff Touch IteadStudio Sonoff Touch| |Wemos D1 Mini Relay Shield Wemos D1 Mini Relay Shield|Electrodragon Relay Board Electrodragon Relay Board|WorkChoice EcoPlug WorkChoice EcoPlug|

License

Copyright (C) 2016-2017 by Xose Pérez (@xoseperez)

This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see http://www.gnu.org/licenses/.