Difference between revisions of "ESPEasy"

From Let's Control It
Jump to navigation Jump to search
 
(419 intermediate revisions by 15 users not shown)
Line 1: Line 1:
−
[[File:ESPEasy1.png]]
+
<!--        BANNER ACROSS TOP OF PAGE        -->
−
= Introduction =
+
{| id="mp-topbanner" style="width:100%; background:#f5faff; margin:1.2em 0 6px 0; border:1px solid #0077dd;"
−
The ESP Easy firmware can be used to turn the ESP module into an easy multifunction sensor device for Home Automation solutions like Domoticz. Configuration of the ESP Easy is entirely web based, so once you've got the firmware loaded, you don't need any other tool besides a common web browser.
+
| style="width:61%; color:#000;" |
  
−
The ESP Easy firmware is currently at build R048 an looks stable enough for production purposes as long as it's being used as a sensor device.
+
{| style="width:280px; border:none; background:none;"
 +
| style="width:280px; text-align:center; white-space:nowrap; color:#000;" |
 +
<div style="font-size:162%; border:none; margin:0; padding:.1em; color:#000;">Welcome to [[History of ESP Easy|ESP Easy]],</div>
 +
<div style="top:+0.2em; font-size:95%;">the [https://github.com/letscontrolit open source] firmware for ESP8266 / ESP8285 / ESP32.</div>
 +
<div style="top:+0.2em; font-size:95%;">'''Latest builds:''' [https://github.com/letscontrolit/ESPEasy/releases GitHub nightly builds]</div>
 +
|}
  
−
ESP Easy also offers limited "low level" actuator functions but due to system instability, this could be less useful in real life applications.
+
<!--        PORTAL LIST ON RIGHT-HAND SIDE        -->
 +
| style="width:18%; font-size:95%;" |
 +
* [[ESP Hardware|ESP Hardware]]
 +
* [[Devices|Supported Sensors/Actuators]]
 +
* [[Modded Hardware|Modded Hardware]]
 +
* [[Basics,Tutorials & Howto's|Basics,Tutorials & Howto's]]
 +
| style="width:35%; font-size:95%;" |
 +
* [https://github.com/letscontrolit/ESPEasy/issues/ GitHub]
 +
* [https://www.letscontrolit.com/forum/ Forum]
 +
* [[ESP Easy web interface|ESP Easy web interface]]
 +
* [[Template Files|Template Files]]
 +
| style="width:25%; font-size:95%;" |
 +
* [[History of ESP Easy|History of ESP Easy]]
 +
* [[MilestonesRoadmap|Milestones/Roadmap]]
 +
* [[Contributors|Contributors/Sponsorship]]
 +
* [[UserProjects|Users & Projects]]
 +
|}
  
 +
<div style="border-bottom:1px solid black; background: red; padding:0.4em 1em; font-size:110%; font-weight:bold; font-color: white;"><span style="color:white">Wiki documentation outdated - Warning</span></div>
  
−
= Get started =
+
<div style="border-bottom:1px solid red;  background:#F6CECE; padding:0.4em 1em 0.4em;">This wiki documentation (for ESPEasy) has become outdated.
  
−
Getting started with the ESP Easy takes a few basic steps.
+
Please see [https://espeasy.readthedocs.io/en/latest/ ESPEasy ReadTheDocs] for more up to date documentation.
 +
As not all documentation has been transferred to RTD, this Wiki can still be useful.
 +
However, always check the RTD documentation first.
  
−
= Loading firmware =
+
There may be links to older builds online.
−
[[Tutorial_ESPEasy_Firmware_Upload]]
+
See [https://github.com/letscontrolit/ESPEasy/releases GitHub nightly builds] for latest builds and releases.
 +
</div>
  
−
= Protocol selection =
 
  
−
The ESP Easy supports several Home Automation controllers or web-services that collect sensor data.
+
= Introduction =
 +
The ESP Easy firmware can be used to turn the ESP module into an easy multifunction sensor device for Home Automation solutions like Domoticz. Configuration of the ESP Easy is entirely web based, so once you've got the firmware loaded, you don't need any other tool besides a common web browser.
  
−
[[EasyProtocols]]
+
ESP Easy also offers limited "low level" actuator functions but due to system instability, this could be less useful in real life applications.
  
−
= Configuration =
+
ESP Easy is under continuous development as can be seen on the [https://github.com/letscontrolit/ESPEasy GitHub page] and on the [https://www.letscontrolit.com/forum/ Forum].
−
To get you on track with the ESP Easy, we provide a tutorial to demonstrate the basics [[Tutorial_Domoticz_Switch]]
 
−
For all further applications, please check their respective wiki page [[Main_Page#Applications | Applications]]
 
  
 +
There are so called "nightly builds" which can be found on the [https://github.com/letscontrolit/ESPEasy/releases Releases page].
  
−
= ESP Easy web interface =
 
−
The ESP Easy has a user-friendly web interface for all configuration settings. They are locally stored in flash memory and retained on power-off.
 
−
We will explain all configuration pages and settings:
 
  
−
== Main page ==
 
−
[[File:ESPEasy_Main.png]]
 
  
−
This is an informational page that provides some technical and operational parameters.
+
== We need support ==
−
The bottom half shows a node list of all known ESP units that are running in your network (this is optional and needs to be configured in tools/advanced)
 
−
The list only shows live systems.
 
  
 +
<div style="border-bottom:1px solid white; background: green; padding:0.4em 1em; font-size:110%; font-weight:bold; font-color: white;"><span style="color:white">Funding = a better firmware</span></div>
  
−
== Config page ==
+
<div style="border-bottom:1px solid green;  background:#e5f442; padding:0.4em 1em 0.4em;">We are in great need for funding. The plan is to make this an awesome "operating system" for IoT. We have some big (even huge) features that we want to give you but time is scarce and we need to quit our daytime jobs... Do you want to help us with that? Read more in [https://www.letscontrolit.com/forum/viewtopic.php?t=5787 this announcement here].
−
[[File:ESPEasy_Config.png]]
+
</div>
  
−
Main settings can be found under "Config" page.
+
== Version names, numbers, and branches ==
  
−
'''Name''' Can be set to an easy to remember name for this system. Can also be used in MQTT communication templates.
+
Well, this is a short version of our naming convention here at the ESP Easy initiative. We started to call the extensive re-write of the source code "Mega", which is an hint of the size needed for the next big stable release. Prior to mega we allowed smaller mem-sizes (sub-megabyte, aka 512kb) for the official releases. This is a bit tight for our goal to add many more useful features to the firmware. So after a somewhat bad decision in the early days of the re-write project we started to call the development branch "Mega" instead of the more accepted name "Master". We later switched this to the correct name. The current master branch on GitHub is where all the development goes into. The legacy branch is the archive, a point zero if you like, which is the exact copy of the source code before we started the re-write. Once we have reached all the milestones for version 2.0.0 we will freeze the source from that point and fork that into a branch called v2.0, only bug fixes is going into that branch. New features that cannot wait until next v2.1 release will be branched into v2.0.1 (this might not happen if no ground breaking feature is added). New features, and experimental stuff, is poured into the development branch (master). Below you will find a explanation on how we intend to do the branching and releases of future firmware versions. Please observe that this table is not the road map, just an example to explain the different names and numbers.
  
−
'''Admin Password''' Can be set if you want to protect your system config with a password.
+
N.B. this table is outdated and needs to be updated.
  
−
'''SSID''' Wifi network SSID
+
{| class="wikitable"
 +
|+ style="caption-side:bottom;" | Explanation
 +
|+ style="caption-side:bottom; color: white; background-color: gray;" | ''L: legacy freeze (R147 code)''
 +
|+ style="caption-side:bottom; color: black; background-color: #ffbbbb;"|''D: development (cutting edge)''
 +
|+ style="caption-side:bottom; color: black; background-color: #ffffcc;"|''FF: feature freeze''
 +
|+ style="caption-side:bottom; color: black; background-color: #bbffbb;"|''R: release of new stable''
 +
! rowspan="2"|Branch !! rowspan="2"|Tag !! colspan="4" | 2017 !! colspan="4" | 2018 !! colspan="4" | 2019
 +
|-
 +
! Q1 || Q2 || Q3 || Q4 || Q1 || Q2 || Q3 || Q4 || Q1 || Q2 || Q3 || Q4
 +
|-
 +
! legacy
 +
| R147 || style="caption-side:bottom; color: white; background-color: gray;" | L ||  ||  ||  ||  ||  ||  ||  ||  ||  ||  ||
 +
|-
 +
! development
 +
| Mega/Knox/Carta ||  || colspan="11" style="color: black; background-color: #ffbbbb;" | D
 +
|-
 +
! v2.0
 +
| v2.0.0 ||  ||  || ||  ||  || style="color: black; background-color: #ffffcc;" | FF || style="color: black; background-color: #bbffbb;" | R ||  ||  ||  ||  ||
 +
|-
 +
! v2.1
 +
| v2.1.0 ||  ||  ||  || ||  ||  ||  ||  || style="color: black; background-color: #ffffcc;" | FF || style="color: black; background-color: #bbffbb;" | R ||  ||
 +
|-
 +
! v3.0
 +
| v3.0.0 ||  ||  ||  ||  ||  ||  ||  ||  ||  ||  ||  || style="color: black; background-color: #ffffcc;" | FF?
 +
|}
  
−
'''WPA Key''' The key used on your Wifi Access Point
+
=== Tag names ===
 +
Stable releases will have a version number similar to "v2.0.0" but focusing areas for development will have short tag names such as "Mega" which indicate the focus for the next big release. A preliminary list for the future focus areas are:
  
−
'''Unit nr''' Each ESP Easy unit needs a unique number in the range 1-31. <span style="color:red">This is important for MQTT connections and the Node list! Do not forget to set this field to a non-zero value, not conflicting with other units.</span>  
+
'''Mega''' which will become v2.0.0 - getting more plugins and much more features (thus the tag "mega" which indicates that a bigger memory is needed for the generic FW)<br>
 +
'''Knox''' which will become v2.1.0 - focusing on security<br>
 +
'''Carta''' which will become v2.2.0 - focusing on communication unit2unit and unit2controller
  
−
'''Protocol''' Select the protocol for your Home Automation controller or webservice like ThingSpeak.
+
As of release mega we will also try to get more hardware specific builds for especially Sonoff units. These will have much less plugins by default since they are not needed for these units, this makes flashing units with less than 1MB possible.
  
−
'''Locate Controller''' You can set the controller based on it's DNS hostname or it's IP address.
+
=== Release names ===
 +
Nightly builds are always generated if something has been updated in the source code. So the master branch will always have many more releases than the frozen stable releases which will only have one (until a bug fix release is generated). To explain this we provide these examples:
  
−
'''Controller IP/Hostname''' Set IP or hostname for the controller
+
Master is updated on 2018-04.07 with new code, next morning you will be able to download the release "master-20180408" (current tag name for that release is "mega").<br>
 +
Master is branched into an official stable release named "v2.0" on 2018-05-07, next morning you can download "v2.0-20180508".<br>
 +
v2.0 is bug fixed on 2018-05-23, next morning you can download "v2.0-20180524" which then supersede the older v2.0.0 version.<br>
  
−
'''Controller Port''' Set the TCP port used on your controller or webservice.
+
'''So how do you know which one is the latest?'''<br>
 +
That's where this wiki is here for (among many other things). We will list all the current states from v2.0.0 and onward. Releases named "master" should always be seen as not stable and only for users that wish to experiment with new releases and test stuff to help the development of future releases.
  
−
'''Sensor Delay''' Set the delay between sensor reporting in seconds.
+
= Get started =
  
−
'''Sleep Mode''' Tick this field to use the ESP in deepsleep mode for low power operation.
+
Getting started with the ESP Easy takes a few basic steps. In most cases your ESP module comes with the AT firmware or the NodeMCU LUA firmware. We need to replace the existing firmware with the ESP Easy firmware. We provide a (Windows only) flashtool to make this process an easy job. Below you find the general flow of this but an in [[Basics:_Connecting_and_flashing_the_ESP8266|depth guide is found here]].
  
−
Optional
+
<div class="center" style="width: auto; margin-left: auto; margin-right: auto;">
 +
<span style="color: white; background:#0077dd">1. Download firmware as binary including flash tool</span>
 +
<br/>&darr;<br/>
 +
<span style="color: white; background:#0077dd">2. Connect the ESP to Windows PC</span>
 +
<br/><span style="font-size:60%">Using either USB/UART of board or separate USB/TTL adapter</span>
 +
<br/>&darr;<br/>
 +
<span style="color: white; background:#0077dd">3. Write firmware using flash tool</span>
 +
<br/><span style="font-size:60%">Note necessity for GPIO to be LOW to enter flashmode</span>
 +
<br/>&darr;<br/>
 +
<span style="color: white; background:#0077dd">4. Restart ESP. WiFi AP <nowiki />"ESP_Easy_0" will appear, password: '''configesp'''</span><br/>(prior to 2.0 the AP was named ESP_0)
 +
<br/><span style="font-size:60%">If you're not automatically taken to the log-in page, browse to 192.168.4.1</span>
 +
<br/>&darr;<br/>
 +
<span style="color: white; background:#0077dd">5. Search for you routers WiFi and connect</span><br/>(if you have multiple AP they will all show up with the same SSID name multiple times)
 +
<br/>&darr;<br/>
 +
<span style="color: white; background:#0077dd">6. Reconnect to your WiFi and enter IP adress shown on previous screen</span>
 +
</div>
  
−
'''ESP IP''' You can set a static IP for this ESP unit. Set to 0.0.0.0 to use DHCP
+
= [[ESP_Hardware|Supported Hardware]] =
  
−
'''ESP GW''' If using a static IP, enter the gateway (not needed if no connection to internet is needed!)
+
ESP Easy can be installed/flashed on nearly every piece of Hardware that has an ESP8266 built-in, newest 2.0.0 version even does support the ESP8285 (basically an ESP8266 with built-in 1M Flash).<br/> Please see the list [[ESP Hardware|here]] for more in depth detail about the hardware.
  
−
'''ESP Subnet''' Enter the local used subnet, usually 255.255.255.0
+
= [[Devices|Supported Sensors/Actuators]] =
  
−
'''ESP DNS''' Enter you local DNS server IP address. Usually the IP of your local internet router.
+
The in depth list of devices (sensors and actuators) is found [[Devices|here]].
  
−
== Hardware page ==
+
= [[Modded_Hardware|Modded Hardware Products]] =
−
[[File:ESPEasy_Hardware.png]]
 
  
−
'''SDA''' Select the data pin used for I2C communications.
+
A list of (officially) modded hardware products is found [[Modded Hardware|here]].
  
−
'''SCL''' Select the clock pin used for I2C communications.
+
= Tutorials =
 +
* [[Tutorial_ESPEasy_Firmware_Upload | Using the flashtool to upload the ESP Easy firmware]]
 +
* [[Tutorial_Arduino_Firmware_Upload | Using the Arduino IDE to upload the ESP Easy firmware]]
 +
* [[EasySetup | How to setup ESPEasy after flashing it.]]
  
−
'''Pin mode x''' Select an optional boot state for this pin, either output low or high
+
* [[Tutorial_Domoticz_Switch | Using the ESP Easy as a simple input switch in Domoticz]]
 +
* [[Tutorial_OpenHAB_Switch | Using the ESP Easy to control a LED of Relay from OpenHAB]]
 +
* [[Tutorial_Rules | Rules, a modest way to locally control something in ESP Easy ]]
 +
* [[EasyGlobalSync | GlobalSync ]]
  
 +
= Loading firmware =
  
−
== Devices page ==
+
* New release candidates are on github: [https://github.com/letscontrolit/ESPEasy/releases ESPEasy version 2.0  and higher]
−
[[File:ESPEasy_Devices.png]]
+
  On the linked page you will find two daily builds of ESPEasy.
 +
  For some clarification:
 +
  Release V2.0-<date>: Beta version of the next stable release, no new features, bugfixes only.
 +
  Release mega-<date>: Bleeding edge of development.
  
−
This is a list of tasks that the ESP Easy will perform. A sensor needs to be defined here to get the values send to your controller.
+
* [https://www.letscontrolit.com/wiki/index.php/Basics:_Connecting_and_flashing_the_ESP8266 Connecting and flashing tutorial]
  
−
After selecting a new device, press the ? button to get specific help on this device!
+
* Old releases: [http://www.letscontrolit.com/downloads/ESPEasy_R120.zip ESPEasy R120] (will be replaced by v2.0.0!)
  
−
<span style="color:red">Most common mistake if your values remain 0: The ESP Easy mainly targets Domoticz and the internal framework is entirely build upon the IDX field. This needs to match Domoticz. If you run a different protocol, it can be any value but must be non-zero. Just choose '1' in those cases...</span>
+
* Old release candidate: [http://www.letscontrolit.com/downloads/ESPEasy_R147_RC8.zip ESPEasy R147_RC8]  (is now part of the dev build for v2.0.0)
  
−
== Tools page ==
 
−
[[File:ESPEasy_Tools.png]]
 
  
−
Some maintenance tools.
 
  
 +
== 2.0+ firmware on 1MB modules ==
 +
<div style="border-bottom:1px solid black; background: red; padding:0.4em 1em; font-size:110%; font-weight:bold; font-color: white;"><span style="color:white">2.0+ firmware on 1MB modules - Warning</span></div>
  
−
=== Tools Advanced page ===
+
<div style="border-bottom:1px solid red;  background:#F6CECE; padding:0.4em 1em 0.4em;">If you are running the stock Mega edition firmware on 1MB modules, you will find that you can no longer load newer images because there's insufficient free space to upload the image (344kB as of 2.0.0.-Dev 9 edition). You can compile smaller images to solve this issue or use a small image that has been build just to upload newer images. So you would always have to use a two-step process to renew using OTA on 1MB modules. Using the uploader image as an in-between step, you can use images up to 604kB.
−
[[File:ESPEasy_Tools_Advanced.png]]
 
  
−
'''Subscribe Template''' Used for MQTT subscription. Selecting a MQTT protocol will automatically fill this field
+
* Only devices with 1Mb or more flash are supported.
 +
* To use OTA you need more then 1Mb of flash. (otherwise your device will get unreachable via wireless and you need to fix it via serial)
 +
* You lose all your config settings if you upgrade from an Rxxx version. (from before ESPEasy v2.0)
 +
</div>
  
−
'''Publish Template''' Used for MQTT publishing. Selecting a MQTT protocol will automatically fill this field
+
[http://www.letscontrolit.com/downloads/ESPEasyUploaderMega.zip ESPEasyUploaderMega]
−
It is also used for the Generic HTTP protocol. Create your custom template here.
 
  
−
'''Message Delay''' To prevent overloading your controller or webservice, a delay between reports can be set. Defaults to 1000 milliseconds. <span style="color:red">For ThingSpeak, you need to set this to 15000! to have multiple sensor readings working</span>
+
''The uploader uses SPIFFS so it uses the same configuration regarding SSID, WPA key and IP. It will connect to your Wifi network as usual, but it will only present this small web page:
 +
''
  
−
'''Fixed IP Octet''' Special network config where the ESP starts with DHCP to get the basic network config and then sets the last octet to a fixed IP.
+
[[File:ESPUploader.png]]
  
−
'''Use NTP''' To enable internal software clock, synchronized using internet time.
+
[[Tutorial_ESPEasy_Firmware_Upload]]
  
−
'''NTP Hostname''' Can be left empty as it defaults to pool.ntp.org. Can be changed here if needed.
+
=== Compile your own firmware (Platformio) ===
  
−
'''Timezone Offset''' Offset in hours to GMT. In the Netherlands this should be '1'
+
If you want to compile your own firmware (with unreleased plugins etc.) you do pretty much the same as the [[Tutorial building and uploading with platformio|development method]] except that you only need to download extra plugins on the side. Just follow the official guide found [[Tutorial building and uploading with platformio|here]].
  
−
'''Syslog IP''' Enter your syslog server IP if you have one running and want to debug something.
+
= [[EasyProtocols|Protocol selection]] =
  
−
'''Syslog level''' Level of log messaging to the web gui. Can be set between 0 - 4 (0=no logging, 1=error, 2=error+info, 3=error+info+debug, 4=error+info+more debug)
+
The ESP Easy supports several Home Automation controllers or web-services that collect sensor data.
  
−
'''UDP port''' This is used for communication between ESP unit's. 65500 is just a sample. Use a number that does not conflict with other systems on your network as the ESP uses broadcast messages.
+
[[EasyProtocols]]
−
<span style="color:red">If you have a syslog server running, do not enter 514 here!</span>. This fields needs to be non-zero to have the node list running.
 
  
−
'''Serial log level''' Level of log messaging to the serial port. Can be set between 0 - 4 (0=no logging, 1=error, 2=error+info, 3=error+info+debug, 4=error+info+more debug)
+
= [[Configuration]] =
 +
The ESP8266 boards are generally easy to use and understand but some precautions need to be taken when it comes to the different GPIOs available. This [[Configuration|section]] tells you more about the ESPeasy setup and the ESP unit's need to know settings (GPIO boot states etc.).
  
−
'''Web log level''' Level of log messaging to the web gui. Can be set between 0 - 4 (0=no logging, 1=error, 2=error+info, 3=error+info+debug, 4=error+info+more debug)
+
= [[ESP Easy web interface|ESP Easy web interface]] =
−
 
+
The ESP Easy has a user-friendly web interface for all configuration settings. They are locally stored in flash memory and retained on power-off.
−
'''Baud Rate''' Serial port baud rate
+
We explain all configuration pages and settings [[ESP Easy web interface|here]].
  
−
'''WD I2C Address''' I2C address to send watchdog messages to. Experimental feature to feed a ATTiny based external watchdog.
+
'''<span style="color:red">Do NOT expose the ESP Easy web interface directly to the internet, always make sure that the web interface is only reachable from "trusted/local" networks!</span>'''
  
−
'''Custom CSS''' Tick this box to use a custom CSS (style sheet). You must first upload a "esp.css" file one to use this.
+
= [[ESPEasy Command Reference|Command Reference]] =
−
<span style="color:red">The CSS filesize can not exceed 4 kbyte!</span>.
 
  
 +
[[ESPEasy Command Reference]]
  
−
= Serial Commands =
+
= [[ESPEasy System Variables|System variables Reference]] =
−
It is possible to configure your esp Easy by the web graphical interface, you can also use some commands to configure it using the serial console. These commands are provided to assist in emergency situatons where you cannot get access to the web gui.
 
  
−
The following commands can be used by the esp easy.
+
[[ESPEasy System Variables]]
  
−
'''Debug''' Set the debug level. 1: Error 2: Info 3: Debug 4: Debug more. "Debug 4" sets the debug level to debug_more.
+
= [[Tutorial Rules|Tutorial Rules]]=
 +
Most information on rules (=local logic on ESP without controller) can be found in the tutorials. Rules are a great way of tweaking the ESP Easy firmware to do exactly what you want without the need to tinker with any source code.
  
−
'''IP''' Set a static ip adres.
+
More on how is found on the [[Tutorial Rules]] page.
  
−
'''WifiSSID''' Set the SSID of your homenetwork. "WifiSSID yournetworkname"
+
= Hardware Tips 'n Tricks=
 +
* [[Power | Power stability]]
 +
* [[Relays | Relays]]
 +
* [[Breadboards | Breadboards]]
 +
* [[Interference | WiFi interference]]
  
−
'''WifiKey''' Set the WPA key of your homenetwork "WifiKey yoursecretkey"
+
= Examples =
 +
* [[Analog Pressure sensor | Analog Pressure Sensor]]
 +
* [[DC Voltage divider | DC Voltage divider]]
 +
* [[SleepMode | SleepMode]]
  
−
'''WifiAPKey''' Set the spa key of this esp unit. This key needs to be used by clients when they want to connect in AP modus.
+
= Support and discussion =
  
−
'''WifiScan''' Scan for active wifi networks. This can be used to test if your wifi is recognized and to verify whether the wifi part is working or not.
+
* [http://www.letscontrolit.com/forum/ Forum]
 +
* IRC: #espeasy @freenode
 +
* Slack (for Wiki talk): [https://espeasywiki.slack.com ESP Easy Wiki]
  
−
'''WifiConnect''' Connect to wifi.
+
== Source code development ==
  
−
'''WifiDisConnect''' Disconnect from your wifi network.
+
Sources are on [https://github.com/letscontrolit/ESPEasy Github]
  
−
'''Reboot''' Reboot esp module
+
Want to contribute? Anyone is invited to do so, but please read this first: [[ESPEasyDevelopmentGuidelines]]
  
−
'''Reset''' Reset the esp module to it's defaults. It uses the values from the sketch when it's uploaded.
+
If you're new to this, follow these guides:
  
−
'''Save''' Save changes to the esp's EEPROM
+
* Install Atom and platformio: [[Tutorial Install Platformio]]
 +
* If you want to be send us back your changes via github follow: [[Tutorial preparing to work with github]] (otherwise skip it)
 +
* Then you're ready for: [[Tutorial building and uploading with platformio]]
 +
* And eventually, if you did the github stuff: [[Tutorial Contributing Back To ESPEasy]]
  
−
'''Settings''' Show the current settings stored in the esp's EEPROM
+
= Hardware page =
 +
<span style="color: red>For older versions, the Hardware page has now moved to:</span> [[ESP Easy web interface#Hardware page]]!

Latest revision as of 23:36, 3 February 2021

Welcome to ESP Easy,
the open source firmware for ESP8266 / ESP8285 / ESP32.
Latest builds: GitHub nightly builds
Wiki documentation outdated - Warning
This wiki documentation (for ESPEasy) has become outdated.

Please see ESPEasy ReadTheDocs for more up to date documentation. As not all documentation has been transferred to RTD, this Wiki can still be useful. However, always check the RTD documentation first.

There may be links to older builds online. See GitHub nightly builds for latest builds and releases.


Introduction

The ESP Easy firmware can be used to turn the ESP module into an easy multifunction sensor device for Home Automation solutions like Domoticz. Configuration of the ESP Easy is entirely web based, so once you've got the firmware loaded, you don't need any other tool besides a common web browser.

ESP Easy also offers limited "low level" actuator functions but due to system instability, this could be less useful in real life applications.

ESP Easy is under continuous development as can be seen on the GitHub page and on the Forum.

There are so called "nightly builds" which can be found on the Releases page.


We need support

Funding = a better firmware
We are in great need for funding. The plan is to make this an awesome "operating system" for IoT. We have some big (even huge) features that we want to give you but time is scarce and we need to quit our daytime jobs... Do you want to help us with that? Read more in this announcement here.

Version names, numbers, and branches

Well, this is a short version of our naming convention here at the ESP Easy initiative. We started to call the extensive re-write of the source code "Mega", which is an hint of the size needed for the next big stable release. Prior to mega we allowed smaller mem-sizes (sub-megabyte, aka 512kb) for the official releases. This is a bit tight for our goal to add many more useful features to the firmware. So after a somewhat bad decision in the early days of the re-write project we started to call the development branch "Mega" instead of the more accepted name "Master". We later switched this to the correct name. The current master branch on GitHub is where all the development goes into. The legacy branch is the archive, a point zero if you like, which is the exact copy of the source code before we started the re-write. Once we have reached all the milestones for version 2.0.0 we will freeze the source from that point and fork that into a branch called v2.0, only bug fixes is going into that branch. New features that cannot wait until next v2.1 release will be branched into v2.0.1 (this might not happen if no ground breaking feature is added). New features, and experimental stuff, is poured into the development branch (master). Below you will find a explanation on how we intend to do the branching and releases of future firmware versions. Please observe that this table is not the road map, just an example to explain the different names and numbers.

N.B. this table is outdated and needs to be updated.

Explanation L: legacy freeze (R147 code) D: development (cutting edge) FF: feature freeze R: release of new stable
Branch Tag 2017 2018 2019
Q1 Q2 Q3 Q4 Q1 Q2 Q3 Q4 Q1 Q2 Q3 Q4
legacy R147 L
development Mega/Knox/Carta D
v2.0 v2.0.0 FF R
v2.1 v2.1.0 FF R
v3.0 v3.0.0 FF?

Tag names

Stable releases will have a version number similar to "v2.0.0" but focusing areas for development will have short tag names such as "Mega" which indicate the focus for the next big release. A preliminary list for the future focus areas are:

Mega which will become v2.0.0 - getting more plugins and much more features (thus the tag "mega" which indicates that a bigger memory is needed for the generic FW)
Knox which will become v2.1.0 - focusing on security
Carta which will become v2.2.0 - focusing on communication unit2unit and unit2controller

As of release mega we will also try to get more hardware specific builds for especially Sonoff units. These will have much less plugins by default since they are not needed for these units, this makes flashing units with less than 1MB possible.

Release names

Nightly builds are always generated if something has been updated in the source code. So the master branch will always have many more releases than the frozen stable releases which will only have one (until a bug fix release is generated). To explain this we provide these examples:

Master is updated on 2018-04.07 with new code, next morning you will be able to download the release "master-20180408" (current tag name for that release is "mega").
Master is branched into an official stable release named "v2.0" on 2018-05-07, next morning you can download "v2.0-20180508".
v2.0 is bug fixed on 2018-05-23, next morning you can download "v2.0-20180524" which then supersede the older v2.0.0 version.

So how do you know which one is the latest?
That's where this wiki is here for (among many other things). We will list all the current states from v2.0.0 and onward. Releases named "master" should always be seen as not stable and only for users that wish to experiment with new releases and test stuff to help the development of future releases.

Get started

Getting started with the ESP Easy takes a few basic steps. In most cases your ESP module comes with the AT firmware or the NodeMCU LUA firmware. We need to replace the existing firmware with the ESP Easy firmware. We provide a (Windows only) flashtool to make this process an easy job. Below you find the general flow of this but an in depth guide is found here.

1. Download firmware as binary including flash tool
↓
2. Connect the ESP to Windows PC
Using either USB/UART of board or separate USB/TTL adapter
↓
3. Write firmware using flash tool
Note necessity for GPIO to be LOW to enter flashmode
↓
4. Restart ESP. WiFi AP "ESP_Easy_0" will appear, password: configesp
(prior to 2.0 the AP was named ESP_0)
If you're not automatically taken to the log-in page, browse to 192.168.4.1
↓
5. Search for you routers WiFi and connect
(if you have multiple AP they will all show up with the same SSID name multiple times)
↓
6. Reconnect to your WiFi and enter IP adress shown on previous screen

Supported Hardware

ESP Easy can be installed/flashed on nearly every piece of Hardware that has an ESP8266 built-in, newest 2.0.0 version even does support the ESP8285 (basically an ESP8266 with built-in 1M Flash).
Please see the list here for more in depth detail about the hardware.

Supported Sensors/Actuators

The in depth list of devices (sensors and actuators) is found here.

Modded Hardware Products

A list of (officially) modded hardware products is found here.

Tutorials

Loading firmware

 On the linked page you will find two daily builds of ESPEasy.
 For some clarification:
 Release V2.0-<date>: Beta version of the next stable release, no new features, bugfixes only.
 Release mega-<date>: Bleeding edge of development.
  • Old release candidate: ESPEasy R147_RC8 (is now part of the dev build for v2.0.0)


2.0+ firmware on 1MB modules

2.0+ firmware on 1MB modules - Warning
If you are running the stock Mega edition firmware on 1MB modules, you will find that you can no longer load newer images because there's insufficient free space to upload the image (344kB as of 2.0.0.-Dev 9 edition). You can compile smaller images to solve this issue or use a small image that has been build just to upload newer images. So you would always have to use a two-step process to renew using OTA on 1MB modules. Using the uploader image as an in-between step, you can use images up to 604kB.
  • Only devices with 1Mb or more flash are supported.
  • To use OTA you need more then 1Mb of flash. (otherwise your device will get unreachable via wireless and you need to fix it via serial)
  • You lose all your config settings if you upgrade from an Rxxx version. (from before ESPEasy v2.0)

ESPEasyUploaderMega

The uploader uses SPIFFS so it uses the same configuration regarding SSID, WPA key and IP. It will connect to your Wifi network as usual, but it will only present this small web page:

ESPUploader.png

Tutorial_ESPEasy_Firmware_Upload

Compile your own firmware (Platformio)

If you want to compile your own firmware (with unreleased plugins etc.) you do pretty much the same as the development method except that you only need to download extra plugins on the side. Just follow the official guide found here.

Protocol selection

The ESP Easy supports several Home Automation controllers or web-services that collect sensor data.

EasyProtocols

Configuration

The ESP8266 boards are generally easy to use and understand but some precautions need to be taken when it comes to the different GPIOs available. This section tells you more about the ESPeasy setup and the ESP unit's need to know settings (GPIO boot states etc.).

ESP Easy web interface

The ESP Easy has a user-friendly web interface for all configuration settings. They are locally stored in flash memory and retained on power-off. We explain all configuration pages and settings here.

Do NOT expose the ESP Easy web interface directly to the internet, always make sure that the web interface is only reachable from "trusted/local" networks!

Command Reference

ESPEasy Command Reference

System variables Reference

ESPEasy System Variables

Tutorial Rules

Most information on rules (=local logic on ESP without controller) can be found in the tutorials. Rules are a great way of tweaking the ESP Easy firmware to do exactly what you want without the need to tinker with any source code.

More on how is found on the Tutorial Rules page.

Hardware Tips 'n Tricks

Examples

Support and discussion

Source code development

Sources are on Github

Want to contribute? Anyone is invited to do so, but please read this first: ESPEasyDevelopmentGuidelines

If you're new to this, follow these guides:

Hardware page

For older versions, the Hardware page has now moved to: ESP Easy web interface#Hardware page!

Retrieved from "http://www.letscontrolit.com/wiki/index.php?title=ESPEasy&oldid=4621"