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.

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