Browse Source

Update README

fastled
Xose Pérez 7 years ago
parent
commit
b0c9178e0c
2 changed files with 10 additions and 7 deletions
  1. +1
    -1
      CHANGELOG.md
  2. +9
    -6
      README.md

+ 1
- 1
CHANGELOG.md View File

@ -10,7 +10,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
- Allow reset the board via an RPC (HTTP) message - Allow reset the board via an RPC (HTTP) message
- Added support for ADC121 I2C for current monitoring (Check [http://tinkerman.cat/power-monitoring-sonoff-th-adc121/](http://tinkerman.cat/power-monitoring-sonoff-th-adc121/)) - Added support for ADC121 I2C for current monitoring (Check [http://tinkerman.cat/power-monitoring-sonoff-th-adc121/](http://tinkerman.cat/power-monitoring-sonoff-th-adc121/))
- Reporting voltage to Domoticz (only HLW8012) - Reporting voltage to Domoticz (only HLW8012)
- Map buttons events to actions (toggle relay, AP mode, reset, pulse mode)
- Map button events to actions (toggle relay, AP mode, reset, pulse mode)
### Changed ### Changed
- Reporting energy incrementals (Domoticz, MQTT) - Reporting energy incrementals (Domoticz, MQTT)


+ 9
- 6
README.md View File

@ -4,20 +4,23 @@ ESPurna ("spark" in Catalan) is a custom firmware for ESP8266 based smart switch
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. 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.
It uses the Arduino Core for ESP8266 framework and a number of 3rd party libraries. It uses the Arduino Core for ESP8266 framework and a number of 3rd party libraries.
**Current Release Version is 1.6.0**, read the [changelog](CHANGELOG.md).
**Current Release Version is 1.6.0**, read the [changelog](https://bitbucket.org/xoseperez/espurna/src/master/CHANGELOG.md).
## Features ## Features
* Support for **multiple ESP8266-based boards**
* Wifi **AP Mode** or **STA mode** with **multiple network definitions** and static IP support
* Support for **multiple ESP8266-based boards** ([check list](https://bitbucket.org/xoseperez/espurna/wiki/Hardware))
* Wifi **AP Mode** or **STA mode** with **multiple network definitions** with support for **static IP**
* Switch management * Switch management
* Support for **push buttons** and **toggle switches**
* Configurable **status on boot** (always ON, always OFF, same as before or toggle) * Configurable **status on boot** (always ON, always OFF, same as before or toggle)
* Support for **pulse mode** (normally ON or normally OFF) with configurable time * Support for **pulse mode** (normally ON or normally OFF) with configurable time
* Support for **relay synchronization** (all equal, only one ON, one and only on ON) * Support for **relay synchronization** (all equal, only one ON, one and only on ON)
* **MQTT** enabled * **MQTT** enabled
* Switch on/off and toggle relays * Switch on/off and toggle relays
* Report button event notifications
* Enable/disable pulse mode * Enable/disable pulse mode
* LED notifications
* Change LED notification mode
* Remote reset the board
* **Alexa** integration using the [FauxmoESP Library](https://bitbucket.org/xoseperez/fauxmoesp) * **Alexa** integration using the [FauxmoESP Library](https://bitbucket.org/xoseperez/fauxmoesp)
* [**Domoticz**](https://domoticz.com/) integration via MQTT * [**Domoticz**](https://domoticz.com/) integration via MQTT
* [**Home Assistant**](https://home-assistant.io/) integration via MQTT * [**Home Assistant**](https://home-assistant.io/) integration via MQTT
@ -34,6 +37,8 @@ It uses the Arduino Core for ESP8266 framework and a number of 3rd party librari
* **REST API** (enable/disable from web interface) * **REST API** (enable/disable from web interface)
* GET and PUT relay status * GET and PUT relay status
* GET sensor data (power, current, voltage, temperature and humidity) depending on the available hardware * GET sensor data (power, current, voltage, temperature and humidity) depending on the available hardware
* **RPC API** (enable/disable from web interface)
* Remote reset the board
* **Over-The-Air** (OTA) updates even for 1Mb boards * **Over-The-Air** (OTA) updates even for 1Mb boards
* Manually from PlatformIO or Arduino IDE * Manually from PlatformIO or Arduino IDE
* Automatic updates through the [NoFUSS Library](https://bitbucket.org/xoseperez/nofuss) * Automatic updates through the [NoFUSS Library](https://bitbucket.org/xoseperez/nofuss)
@ -43,7 +48,6 @@ It uses the Arduino Core for ESP8266 framework and a number of 3rd party librari
For more information please refer to the [ESPurna Wiki](https://bitbucket.org/xoseperez/espurna/wiki/Home). For more information please refer to the [ESPurna Wiki](https://bitbucket.org/xoseperez/espurna/wiki/Home).
## Supported hardware ## Supported hardware
|||| ||||
@ -61,7 +65,6 @@ For more information please refer to the [ESPurna Wiki](https://bitbucket.org/xo
|![JanGoe Wifi Relay (NO/NC)](images/devices/jangoe-wifi-relay.png)|![OpenEnergyMonitor WiFi MQTT Relay / Thermostat](images/devices/mqtt-relay.jpg)|| |![JanGoe Wifi Relay (NO/NC)](images/devices/jangoe-wifi-relay.png)|![OpenEnergyMonitor WiFi MQTT Relay / Thermostat](images/devices/mqtt-relay.jpg)||
|**JanGoe Wifi Relay (NO/NC)**|**OpenEnergyMonitor WiFi MQTT Relay / Thermostat**|| |**JanGoe Wifi Relay (NO/NC)**|**OpenEnergyMonitor WiFi MQTT Relay / Thermostat**||
## License ## License
Copyright (C) 2016-2017 by Xose Pérez (@xoseperez) Copyright (C) 2016-2017 by Xose Pérez (@xoseperez)


Loading…
Cancel
Save