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.

57 lines
2.5 KiB

8 years ago
8 years ago
8 years ago
8 years ago
8 years ago
8 years ago
8 years ago
8 years ago
8 years ago
8 years ago
8 years ago
  1. # ESPurna
  2. ESPurna ("spark" in Catalan) is a custom C firmware for ESP8266 based smart switches.
  3. It was originally developed with the **[ITead Sonoff][1]** in mind but now it supports a growing number of ESP8266-based boards.
  4. ## Features
  5. * **Asynchronous WebServer for configuration** and simple relay toggle with **basic authentication**
  6. * Communication between webserver and webclient via **websockets** with secure ticket check
  7. * **Flashing firmware Over-The-Air** (OTA)
  8. * Up to **3 configurable WIFI networks**, connects to the strongest signal
  9. * **MQTT support** with configurable host and topic
  10. * **REST API** to query and set relay statuses
  11. * Support for **multi-relay boards** (Sonoff Dual, Electrodragon ESP Relay Board,...)
  12. * Manual switch ON/OFF with button (single click the button)
  13. * AP mode backup (double click the button)
  14. * Manual reset the board (long click the button)
  15. * Visual status of the connection via the LED
  16. * **Alexa** integration (Amazon Echo or Dot) by emulating a Belkin WeMo switch
  17. * Support for **automatic over-the-air updates** through the [NoFUSS Library][2]
  18. * Support for **DHT22** and **DS18B20** sensors
  19. * Support for the **HLW8012** power sensor present in the Sonoff POW
  20. * Support for **current monitoring** through the [EmonLiteESP Library][3] using a non-intrusive current sensor ([requires some hacking][4])
  21. * Command line configuration
  22. ## Index
  23. * [Supported hardware](docs/Hardware.md)
  24. * [Build and flash the firmware](docs/Firmware.md)
  25. * [Build and flash the filesystem](docs/Filesystem.md)
  26. * [Configuration](docs/Configuration.md)
  27. * [Over-the-air updates](docs/OTA.md)
  28. * [Sensors](docs/Sensors.md)
  29. * [Troubleshooting](docs/Troubleshooting.md)
  30. ## License
  31. Copyright (C) 2016 by Xose Pérez (@xoseperez)
  32. This program is free software: you can redistribute it and/or modify
  33. it under the terms of the GNU General Public License as published by
  34. the Free Software Foundation, either version 3 of the License, or
  35. (at your option) any later version.
  36. This program is distributed in the hope that it will be useful,
  37. but WITHOUT ANY WARRANTY; without even the implied warranty of
  38. MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  39. GNU General Public License for more details.
  40. You should have received a copy of the GNU General Public License
  41. along with this program. If not, see <http://www.gnu.org/licenses/>.
  42. [1]: https://www.itead.cc/sonoff-wifi-wireless-switch.html
  43. [2]: https://bitbucket.org/xoseperez/nofuss
  44. [3]: https://bitbucket.org/xoseperez/emonliteesp
  45. [4]: http://tinkerman.cat/your-laundry-is-done/