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.

133 lines
8.7 KiB

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