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.

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