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.

125 lines
7.9 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
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
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.9.2**, read the [changelog](https://bitbucket.org/xoseperez/espurna/src/master/CHANGELOG.md).
  6. **NOTE**: since version 1.9.0 the default **MQTT topics for commands have changed**. They all now end with "/set". This means you will have to change your controller software (Node-RED or alike) to send messages to -for instance- "/home/living/light/relay/0/set". The device will publish its state in "/home/living/light/relay/0" like before.
  7. ## Features
  8. * Support for **multiple ESP8266-based boards** ([check list](https://bitbucket.org/xoseperez/espurna/wiki/Hardware))
  9. * Wifi **AP Mode** or **STA mode**
  10. * Up to 5 different networks can be defined
  11. * Supports static IP
  12. * Scans for strongest network if more than one defined
  13. * Defaults to AP mode (also available after double clicking the main button)
  14. * Switch management
  15. * Support for **push buttons** and **toggle switches**
  16. * Configurable **status on boot** (always ON, always OFF, same as before or toggle)
  17. * Support for **pulse mode** (normally ON or normally OFF) with configurable time
  18. * Support for **relay synchronization** (all equal, only one ON, one and only on ON)
  19. * Support for **delayed ON/OFF**
  20. * **MQTT** enabled
  21. * **SSL/TLS support** (not on regular builds, requires staging version of Arduino Core for ESP8266)
  22. * Switch on/off and toggle relays
  23. * Report button event notifications
  24. * Enable/disable pulse mode
  25. * Change LED notification mode
  26. * Remote reset the board
  27. * **Alexa** integration using the [FauxmoESP Library](https://bitbucket.org/xoseperez/fauxmoesp)
  28. * [**Domoticz**](https://domoticz.com/) integration via MQTT
  29. * [**Home Assistant**](https://home-assistant.io/) integration via MQTT
  30. * Supports MQTT auto-discover feature
  31. * [**InfluxDB**](https://www.influxdata.com/) integration via HTTP API
  32. * Support for different **sensors**
  33. * DHT11 / DHT22 / DHT21 / AM2301 (supports celsius & fahrenheit reporting)
  34. * DS18B20 (supports celsius & fahrenheit reporting)
  35. * HLW8012 using the [HLW8012 Library](https://bitbucket.org/xoseperez/hlw8012) (Sonoff POW)
  36. * Non-invasive current sensor using the [EmonLiteESP Library](https://bitbucket.org/xoseperez/emonliteesp) (requires some hacking)
  37. * Raw analog sensor
  38. * Fast asynchronous **HTTP Server**
  39. * Configurable port
  40. * Basic authentication
  41. * Web-based configuration
  42. * Relay switching and sensor data from the web interface
  43. * Handle color, brightness, and white/warm channels for lights
  44. * Websockets-based communication between the device and the browser
  45. * Backup and restore settings option
  46. * Upgrade firmware from the web interface
  47. * **REST API** (enable/disable from web interface)
  48. * GET and PUT relay status
  49. * Change light color (for supported hardware)
  50. * GET sensor data (power, current, voltage, temperature and humidity) depending on the available hardware
  51. * **RPC API** (enable/disable from web interface)
  52. * Remote reset the board
  53. * **Over-The-Air** (OTA) updates even for 1Mb boards
  54. * Manually from PlatformIO or Arduino IDE
  55. * Automatic updates through the [NoFUSS Library](https://bitbucket.org/xoseperez/nofuss)
  56. * Update from web interface using pre-built images
  57. * **Command line configuration**
  58. * Change configuration
  59. * Run special commands
  60. * **Telnet support**
  61. * Available only if connected to the AP interface
  62. * Show debug info and allows to run terminal commands
  63. * **Unstable system check**
  64. * Detects unstable system (crashes on boot continuously) and defaults to a stable system
  65. * Only WiFi AP, OTA and Telnet available if system is flagged as unstable
  66. * Button interface
  67. * Click to toggle relays
  68. * Double click to enter AP mode (only main button)
  69. * Long click (>1 second) to reboot device (only main button)
  70. * Extra long click (>10 seconds) to go back to factory settings (only main button)
  71. ## Documentation
  72. For more information please refer to the [ESPurna Wiki](https://bitbucket.org/xoseperez/espurna/wiki/Home).
  73. ## Supported hardware
  74. 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).
  75. ||||
  76. |---|---|---|
  77. |![Tinkerman Espurna H](images/devices/tinkerman-espurna-h.jpg)|![IteadStudio Sonoff RF Bridge](images/devices/itead-sonoff-rfbridge.jpg)||
  78. |**Tinkerman ESPurna H**|**IteadStudio Sonoff RF Bridge**||
  79. |![IteadStudio Sonoff Basic](images/devices/itead-sonoff-basic.jpg)|![IteadStudio Sonoff RF](images/devices/itead-sonoff-rf.jpg)|![Electrodragon WiFi IOT](images/devices/electrodragon-wifi-iot.jpg)|
  80. |**IteadStudio Sonoff Basic**|**IteadStudio Sonoff RF**|**Electrodragon WiFi IOT**|
  81. |![IteadStudio Sonoff Dual](images/devices/itead-sonoff-dual.jpg)|![IteadStudio Sonoff POW](images/devices/itead-sonoff-pow.jpg)|![IteadStudio Sonoff TH10/TH16](images/devices/itead-sonoff-th.jpg)|
  82. |**IteadStudio Sonoff Dual**|**IteadStudio Sonoff POW**|**IteadStudio Sonoff TH10/TH16**|
  83. |![IteadStudio Sonoff 4CH](images/devices/itead-sonoff-4ch.jpg)|![IteadStudio Sonoff 4CH Pro](images/devices/itead-sonoff-4ch-pro.jpg)|![OpenEnergyMonitor WiFi MQTT Relay / Thermostat](images/devices/openenergymonitor-mqtt-relay.jpg)|
  84. |**IteadStudio Sonoff 4CH**|**IteadStudio Sonoff 4CH Pro**|**OpenEnergyMonitor WiFi MQTT Relay / Thermostat**|
  85. |![IteadStudio S20](images/devices/itead-s20.jpg)|![WorkChoice EcoPlug](images/devices/workchoice-ecoplug.jpg)||
  86. |**IteadStudio S20**|**WorkChoice EcoPlug**||
  87. |![IteadStudio Sonoff Touch](images/devices/itead-sonoff-touch.jpg)|![IteadStudio Sonoff T1](images/devices/itead-sonoff-t1.jpg)||
  88. |**IteadStudio Sonoff Touch**|**IteadStudio Sonoff T1**||
  89. |![IteadStudio Slampher](images/devices/itead-slampher.jpg)|![AI-Thinker Wifi Light / Noduino OpenLight](images/devices/aithinker-ai-light.jpg)|![Itead Sonoff B1](images/devices/itead-sonoff-b1.jpg)|
  90. |**IteadStudio Slampher**|**AI-Thinker Wifi Light / Noduino OpenLight**|**IteadStudio Sonoff B1**|
  91. |![MagicHome LED Controller](images/devices/magichome-led-controller.jpg)|![Huacanxing H801](images/devices/huacanxing-h801.jpg)|![Itead BN-SZ01](images/devices/itead-bn-sz01.jpg)|
  92. |**MagicHome LED Controller**|**Huacanxing H801**|**Itead BN-SZ01**|
  93. |![IteadStudio Sonoff SV](images/devices/itead-sonoff-sv.jpg)|![IteadStudio 1CH Inching](images/devices/itead-1ch-inching.jpg)|![IteadStudio Motor Clockwise/Anticlockwise](images/devices/itead-motor.jpg)|
  94. |**IteadStudio Sonoff SV**|**IteadStudio 1CH Inching**|**IteadStudio Motor Clockwise/Anticlockwise**|
  95. |![Wemos D1 Mini Relay Shield](images/devices/wemos-d1-mini-relayshield.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.jpg)|
  96. |**Wemos D1 Mini Relay Shield**|**Jan Goedeke Wifi Relay (NO/NC)**|**Jorge García Wifi + Relays Board Kit**|
  97. |![EXS Wifi Relay v3.1](images/devices/exs-wifi-relay-v31.jpg)|||
  98. |**EXS Wifi Relay v3.1**|||
  99. ## License
  100. Copyright (C) 2016-2017 by Xose Pérez (@xoseperez)
  101. This program is free software: you can redistribute it and/or modify
  102. it under the terms of the GNU General Public License as published by
  103. the Free Software Foundation, either version 3 of the License, or
  104. (at your option) any later version.
  105. This program is distributed in the hope that it will be useful,
  106. but WITHOUT ANY WARRANTY; without even the implied warranty of
  107. MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  108. GNU General Public License for more details.
  109. You should have received a copy of the GNU General Public License
  110. along with this program. If not, see <http://www.gnu.org/licenses/>.