|Maxim Prokhorov 7226a7d37f||2 years ago|
|.github||2 years ago|
|code||2 years ago|
|dist||3 years ago|
|images||2 years ago|
|.bandit||3 years ago|
|.gitattributes||2 years ago|
|.gitignore||3 years ago|
|.gitmodules||6 years ago|
|CHANGELOG.md||3 years ago|
|CONTRIBUTING.md||2 years ago|
|LICENSE||7 years ago|
|README.md||2 years ago|
|SUPPORT.md||4 years ago|
|ci_install.sh||2 years ago|
|ci_script.sh||2 years ago|
|pre-commit||2 years ago|
ESPurna ("spark" in Catalan) is a custom firmware for ESP8285/ESP8266 based smart switches, lights and sensors. It uses the Arduino Core for ESP8266 framework and a number of 3rd party libraries.
Since November 2018, Max Prokhorov (@mcspr) is also actively working as a collaborator of the project.
Without your help this project would not be possible. I (@xoseperez) simply can't spend all the time I wish on ESPurna but luckly I recieve a lot of contributions, bug fixes, enhancement suggestions,... from people all around the world. I would like to thank each and every one of you. The contributors page shows the ones that have done a PR in the past, but I also get contributions in the issues, by email or via the gitter ESPurna channel, those I also want to thank.
Thank you all very much.
Ladies and gentlemen in the embedded world, use PlatformIO. If I could offer you only one tip for the future, PlatformIO would be it.
Please use the gitter ESPurna channel for support and questions, you have better chances to get fast answers from me or other ESPurna users. Open an issue here only if you feel there is a bug or you want to request an enhancement. Thank you.
Process of building ESPurna from source is documented in the Wiki:
Using PlatformIO IDE for VSCode
Using PlatformIO CLI
Using Arduino IDE
If you want to try out latest changes from dev branch without building the firmware yourself or if you are having problems with the stable release, please visit espurna-nightly-builder releases page.
Please use gitter for support and questions, you have better chances to get fast answers by me or other ESPurna users. Open an issue here only if you feel there is a bug or you want to request an enhancement. Thank you.
Default branch in GitHub is now the development branch "dev".
The stable branch (the one used to create the binary releases) is "master".
This repository has been migrated from Bitbucket to GitHub. There were a number of reason to migrate the repository to GitHub. I like Bitbucket and I'm still using it for a lot of projects, but ESPurna has grown and its community as well. Some users have complain about Bitbucket not being enough community-focused. This change is mainly aimed to use a platform with greater acceptance on the open-source community and tools better suited to them (to you), like the possibility to contribute to the documentation in an easy way.
What happened with all the info in Bitbucket? Well, most of it has been ported to GitHub, albeit with some quirks:
- Code has, of course been migrated completely
- Issues are all on GitHub already but all issues and comments show up as reported by me. The original reporter is referenced inside the body of the issue (or comment) with a link to his/her profile at Bitbucket and a link to his/her profile at GitHub if it happens to be the same username. I suggest all reporters to subscribe to the issues they originally filed (search for your BitBucket username to list them).
- Pull requests historic has not been migrated. At the moment of the migration all pull-requests have been either merged or declined. Of course, those PR merged are in the code base, but the historic and comments in the PR pages will be lost.
- Documentation it's on it way, first step will be to migrate existing wiki, maybe with a new TOC structure
- Watchers, Forks, I'm afraid they are all gone. Visit the new repo home and click on the "Watch" button on the top right. And as you do it click also on the "Star" button too :)
I apologize for any inconvenience this migration may have caused. I have decided to do it the hard way.
As of current version (1.12.0) ESPurna is tested using Arduino Core 2.3.0 and it's meant to be built against that version.
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.
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.
There are several ways to contribute to ESPurna development. You can contribute to the repository by doing:
And of course you can always buy me a beer, coffee, tea,... via the donation button below.
For more information please refer to the ESPurna Wiki.
Here is the list of supported hardware. For more information please refer to the ESPurna Wiki Hardware page.
|Blitzwolf BW-SHP6||Blitzwolf BW-SHP2
(also by Coosa, Gosund, HomeCube, Teckin)
|Power meters based on V9261F||Itead Sonoff POW||Itead Sonoff POW R2|
|Itead Sonoff S31||Smartlife (NETVIP) Mini Smart Socket||Teckin SP20|
|Digoo NX SP202||Vanzavanzu Smart WiFi Plug Mini||Hykker Smart Home Power Plug|
|Itead Sonoff Basic (including R2 and R3)||Itead Sonoff Dual/Dual R2||Itead Sonoff TH10/TH16|
|Electrodragon WiFi IOT||OpenEnergyMonitor WiFi MQTT Relay / Thermostat|
|Itead Sonoff 4CH||Itead Sonoff 4CH Pro|
|Alterco Shelly 1 / 1PM||Alterco Shelly 2 / 2.5||Jan Goedeke Wifi Relay (NO/NC)|
|EXS Wifi Relay v3.1||EXS Wifi Relay v5.0||Jorge García Wifi + Relays Board Kit|
|Allnet ESP8266-UP-Relay||Bruno Horta's OnOfre||Luani HVIO|
|Itead S20||Itead S26||Neo Coolcam NAS WR01W|
|Maxcio W-US002S||HEYGO HY02||YiDian XS-SSA05|
|WiOn 50055||LINGAN SWA1||HomeCube 16A|
|WorkChoice EcoPlug||Bestek MRJ1011||Tonbux XS-SSA01|
|Schuko Wifi Plug||Schuko Wifi Plug V2||KMC 70011|
|Xenon SM-PW702U||Orvibo B25||Oukitel P1|
|Tonbux XS-SSA06||Litesun LA-WF3||Maxcio W DE-004|
|Hama WiFi Steckdose||GBLife RGBW Socket|
|Itead Sonoff Touch||Itead Sonoff T1||YJZK 1/2/3-gangs switch|
|Gosund WS1 / KS-602S|
|Tonbux PowerStrip02||Fornorm Power Strip||Zhilde ZLD-EU55-W|
|Itead Slampher||Arilux E27||Itead Sonoff B1|
|AI-Thinker Wifi Light / Noduino OpenLight||Authometion LYT8266||AG-L4|
|Lohas 9W||Xiaomi Smart Desk Lamp||iWoole LED Table Lamp|
|Itead Sonoff LED||Itead BN-SZ01||Lombex LUX Nova 2 (white and color)|
|Arilux AL-LC01 (RGB)||Arilux AL-LC02 (RGBW)||Arilux AL-LC06 (RGBWWCW)|
|Arilux AL-LC11 (RGBWWW) & RF||MagicHome LED Controller (1.0/2.x, also ZJ WFMN A/B11)||Huacanxing H801/802|
|Muvit I/O MIOBULB001|
|Tinkerman RFM69GW||Itead Sonoff RF Bridge||Itead Sonoff RF|
|Tonbux Mosquito Killer||Itead Sonoff IFAN02|
|Tinkerman ESPurna H||NodeMCU Lolin V3|
|Itead Sonoff SV||Itead 1CH Inching||Itead Motor Clockwise/Anticlockwise|
|ManCaveMade ESP-Live||Wemos D1 Mini Relay Shield||Gizwits Witty Cloud|
|IKE ESPike||Pilotak ESP DIN||Arniex Swifitch|
|Heltec Touch Relay||Generic Relay v4.0||Generic RGBLed v1.0|
|Generic DHT11 v1.0||Generic DS18B20 v1.0||InterMitTech QuinLED 2.6|
|Phyx ESP12 RGBW||RH Electronics Geiger Counter||Green ESP Relay|
|Foxel Lightfox Dual|
Other supported boards (beta): KMC 4 Outlet, Gosund WS1, MakerFocus Intelligent Module LM33 for Lamps
Copyright (C) 2016-2019 by Xose Pérez (@xoseperez)
This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
You should have received a copy of the GNU General Public License along with this program. If not, see http://www.gnu.org/licenses/.