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.

85 lines
5.1 KiB

8 years ago
7 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
  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.6.1**, read the [changelog](https://bitbucket.org/xoseperez/espurna/src/master/CHANGELOG.md).
  6. ## Features
  7. * Support for **multiple ESP8266-based boards** ([check list](https://bitbucket.org/xoseperez/espurna/wiki/Hardware))
  8. * Wifi **AP Mode** or **STA mode** with **multiple network definitions** with support for **static IP**
  9. * Switch management
  10. * Support for **push buttons** and **toggle switches**
  11. * Configurable **status on boot** (always ON, always OFF, same as before or toggle)
  12. * Support for **pulse mode** (normally ON or normally OFF) with configurable time
  13. * Support for **relay synchronization** (all equal, only one ON, one and only on ON)
  14. * **MQTT** enabled
  15. * Switch on/off and toggle relays
  16. * Report button event notifications
  17. * Enable/disable pulse mode
  18. * Change LED notification mode
  19. * Remote reset the board
  20. * **Alexa** integration using the [FauxmoESP Library](https://bitbucket.org/xoseperez/fauxmoesp)
  21. * [**Domoticz**](https://domoticz.com/) integration via MQTT
  22. * [**Home Assistant**](https://home-assistant.io/) integration via MQTT
  23. * Support for different **sensors**
  24. * DHT11 / DHT22 / DHT21 / AM2301
  25. * DS18B20
  26. * HLW8012 using the [HLW8012 Library](https://bitbucket.org/xoseperez/hlw8012) (Sonoff POW)
  27. * Non-invasive current sensor using the [EmonLiteESP Library](https://bitbucket.org/xoseperez/emonliteesp) (requires some hacking)
  28. * Fast asynchronous **HTTP Server**
  29. * Basic authentication
  30. * Web-based configuration
  31. * Relay switching and sensor data from the web interface
  32. * Websockets-based communication between the device and the browser
  33. * **REST API** (enable/disable from web interface)
  34. * GET and PUT relay status
  35. * GET sensor data (power, current, voltage, temperature and humidity) depending on the available hardware
  36. * **RPC API** (enable/disable from web interface)
  37. * Remote reset the board
  38. * **Over-The-Air** (OTA) updates even for 1Mb boards
  39. * Manually from PlatformIO or Arduino IDE
  40. * Automatic updates through the [NoFUSS Library](https://bitbucket.org/xoseperez/nofuss)
  41. * **Command line configuration**
  42. ## Documentation
  43. For more information please refer to the [ESPurna Wiki](https://bitbucket.org/xoseperez/espurna/wiki/Home).
  44. ## Supported hardware
  45. Here is the list of supported hardware. For more information please refer to the [ESPurna Wiki Hardware page](https://bitbucket.org/xoseperez/espurna/wiki/Hardware).
  46. ||||
  47. |-|-|-|
  48. |![IteadStudio S20](images/devices/s20.jpg)|![IteadStudio Slampher](images/devices/slampher.jpg)|![IteadStudio Sonoff 4CH](images/devices/sonoff-4ch.jpg)|
  49. |**IteadStudio S20**|**IteadStudio Slampher**|**IteadStudio Sonoff 4CH**|
  50. |![IteadStudio Sonoff Basic](images/devices/sonoff-basic.jpg)|![IteadStudio Motor Switch](images/devices/motor-switch.jpg)|![IteadStudio 1CH Inching](images/devices/1ch-inching.jpg)|
  51. |**IteadStudio Sonoff Basic**|**IteadStudio Motor Switch**|**IteadStudio 1CH Inching**|
  52. |![IteadStudio Sonoff Dual](images/devices/sonoff-dual.jpg)|![IteadStudio Sonoff POW](images/devices/sonoff-pow.jpg)|![IteadStudio Sonoff TH10/TH16](images/devices/sonoff-th10-th16.jpg)|
  53. |**IteadStudio Sonoff Dual**|**IteadStudio Sonoff POW**|**IteadStudio Sonoff TH10/TH16**|
  54. |![IteadStudio Sonoff RF](images/devices/sonoff-rf.jpg)|![IteadStudio Sonoff SV](images/devices/sonoff-sv.jpg)|![IteadStudio Sonoff Touch](images/devices/sonoff-touch.jpg)|
  55. |**IteadStudio Sonoff RF**|**IteadStudio Sonoff SV**|**IteadStudio Sonoff Touch**|
  56. |![Wemos D1 Mini Relay Shield](images/devices/d1mini.jpg)|![Electrodragon Relay Board](images/devices/electrodragon-relay-board.jpg)|![WorkChoice EcoPlug](images/devices/workchoice-ecoplug.jpg)|
  57. |**Wemos D1 Mini Relay Shield**|**Electrodragon Relay Board**|**WorkChoice EcoPlug**|
  58. |![JanGoe Wifi Relay (NO/NC)](images/devices/jangoe-wifi-relay.png)|![OpenEnergyMonitor WiFi MQTT Relay / Thermostat](images/devices/mqtt-relay.jpg)|![Jorge García Wifi + Relays Board Kit](images/devices/jorgegarcia-wifi-relays-board-kit.jpg)|
  59. |**JanGoe Wifi Relay (NO/NC)**|**OpenEnergyMonitor WiFi MQTT Relay / Thermostat**|**Jorge García Wifi + Relays Board Kit**|
  60. ## License
  61. Copyright (C) 2016-2017 by Xose Pérez (@xoseperez)
  62. This program is free software: you can redistribute it and/or modify
  63. it under the terms of the GNU General Public License as published by
  64. the Free Software Foundation, either version 3 of the License, or
  65. (at your option) any later version.
  66. This program is distributed in the hope that it will be useful,
  67. but WITHOUT ANY WARRANTY; without even the implied warranty of
  68. MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  69. GNU General Public License for more details.
  70. You should have received a copy of the GNU General Public License
  71. along with this program. If not, see <http://www.gnu.org/licenses/>.