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.

64 lines
3.7 KiB

8 years ago
7 years ago
8 years ago
7 years ago
7 years ago
7 years ago
7 years ago
7 years ago
7 years ago
8 years ago
8 years ago
8 years ago
8 years ago
8 years ago
  1. # ESPurna Firmware
  2. ESPurna ("spark" in Catalan) is a custom firmware for ESP8266 based smart switches.
  3. It was originally developed with the **[IteadStudio Sonoff](https://www.itead.cc/sonoff-wifi-wireless-switch.html)** in mind but now it supports a growing number of ESP8266-based boards.
  4. It uses the Arduino Core for ESP8266 framework and a number of 3rd party libraries.
  5. **Current Release Version is 1.4.3**, read the [changelog](CHANGELOG.md).
  6. ## Features
  7. * Support for **multiple ESP8266-based boards** ([check list](#supported-hardware))
  8. * Wifi **AP Mode** or **STA mode** with **multiple network definitions** and static IP support
  9. * **MQTT** enabled
  10. * Switch on/off and toggle relays
  11. * LED notifications
  12. * Support for different **sensors**
  13. * DHT11 / DHT22 / DHT21 / AM2301
  14. * DS18B20
  15. * HLW8012 (Sonoff POW)
  16. * Non-invasive current sensor using the [EmonLiteESP Library](https://bitbucket.org/xoseperez/emonliteesp) (requires some hacking)
  17. * Fast asynchronous **HTTP Server**
  18. * Basic authentication
  19. * Web-based configuration
  20. * Relay switching from the web
  21. * Websockets-based communication between the device and the browser
  22. * **REST API**
  23. * GET and PUT relay status
  24. * **Command line configuration**
  25. * **Over-The-Air** (OTA) updates even for 1Mb boards
  26. * Manually from PlatformIO or Arduino Inside
  27. * Automatic updates through the [NoFUSS Library](https://bitbucket.org/xoseperez/nofuss)
  28. * **Alexa** integration using the [FauxmoESP Library](https://bitbucket.org/xoseperez/fauxmoesp)
  29. * [**Domoticz**](https://domoticz.com/) integration via MQTT
  30. ## Documentation
  31. For more information please refer to the [ESPurna Wiki](https://bitbucket.org/xoseperez/espurna/wiki/Home).
  32. ## Supported hardware
  33. |![IteadStudio S20](images/devices/s20.jpg) **IteadStudio S20**|![IteadStudio Slampher](images/devices/slampher.jpg) **IteadStudio Slampher**|![IteadStudio Sonoff 4CH](images/devices/sonoff-4ch.jpg) **IteadStudio Sonoff 4CH**|
  34. |![IteadStudio Sonoff Basic](images/devices/sonoff-basic.jpg) **IteadStudio Sonoff Basic**|![IteadStudio Motor Switch](images/devices/motor-switch.jpg) **IteadStudio Motor Switch**|![IteadStudio 1CH Inching](images/devices/1ch-inching.jpg) **IteadStudio 1CH Inching**|
  35. |![IteadStudio Sonoff Dual](images/devices/sonoff-dual.jpg) **IteadStudio Sonoff Dual**|![IteadStudio Sonoff POW](images/devices/sonoff-pow.jpg) **IteadStudio Sonoff POW**|![IteadStudio Sonoff TH10/TH16](images/devices/sonoff-th10-th16.jpg) **IteadStudio Sonoff TH10/TH16**|
  36. |![IteadStudio Sonoff RF](images/devices/sonoff-rf.jpg) **IteadStudio Sonoff RF**|![IteadStudio Sonoff SV](images/devices/sonoff-sv.jpg) **IteadStudio Sonoff SV**|![IteadStudio Sonoff Touch](images/devices/sonoff-touch.jpg) **IteadStudio Sonoff Touch**|
  37. |![Wemos D1 Mini Relay Shield](images/devices/d1mini.jpg) **Wemos D1 Mini Relay Shield**|![Electrodragon Relay Board](images/devices/electrodragon-relay-board.jpg) **Electrodragon Relay Board**|![WorkChoice EcoPlug](images/devices/workchoice-ecoplug.jpg) **WorkChoice EcoPlug**|
  38. ## License
  39. Copyright (C) 2016-2017 by Xose Pérez (@xoseperez)
  40. This program is free software: you can redistribute it and/or modify
  41. it under the terms of the GNU General Public License as published by
  42. the Free Software Foundation, either version 3 of the License, or
  43. (at your option) any later version.
  44. This program is distributed in the hope that it will be useful,
  45. but WITHOUT ANY WARRANTY; without even the implied warranty of
  46. MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  47. GNU General Public License for more details.
  48. You should have received a copy of the GNU General Public License
  49. along with this program. If not, see <http://www.gnu.org/licenses/>.