|
|
Line 258: |
Line 258: |
| = 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. | | 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: | + | We explain all configuration pages and settings [[ESP Easy web interface|here]]. |
− | | |
− | == Main page ==
| |
− | URL:<espeasyip><br/>
| |
− | [[File:ESPEasy_Main.png]] | |
− | | |
− | This is an informational page that provides some technical and operational parameters.
| |
− | 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.
| |
− | | |
− | == Config page ==
| |
− | URL:<espeasyip>/'''config'''<br/>
| |
− | Main settings can be found under "Config" page.
| |
− | | |
− | [[File:ESPEasy_Config.png]]
| |
− | | |
− | '''Name''' Can be set to an easy to remember name for this system. Can also be used in MQTT communication templates.
| |
− | | |
− | '''Admin Password''' Can be set if you want to protect your system config with a password.
| |
− | | |
− | '''SSID''' Wifi network SSID
| |
− | | |
− | '''WPA Key''' The key used on your Wifi Access Point
| |
− | | |
− | '''WPA AP Mode Key''' The key that ESP Easy will use if it starts as a Wifi Access Point to set the first time configuration
| |
− | | |
− | '''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>
| |
− | | |
− | '''Protocol''' Select the protocol for your Home Automation controller or webservice like ThingSpeak.
| |
− | | |
− | '''Locate Controller''' You can set the controller based on it's DNS hostname or it's IP address.
| |
− | | |
− | '''Controller IP/Hostname''' Set IP or hostname for the controller
| |
− | | |
− | '''Controller Port''' Set the TCP port used on your controller or webservice.
| |
− | | |
− | '''Sensor Delay''' Set the delay between sensor reporting in seconds.
| |
− | | |
− | '''Sleep Mode''' Tick this field to use the ESP in deepsleep mode for low power operation. Read more: [[SleepMode]]
| |
− | | |
− | Optional
| |
− | | |
− | '''ESP IP''' You can set a static IP for this ESP unit. Set to 0.0.0.0 to use DHCP
| |
− | | |
− | '''ESP GW''' If using a static IP, enter the gateway (not needed if no connection to internet is needed!)
| |
− | | |
− | '''ESP Subnet''' Enter the local used subnet, usually 255.255.255.0
| |
− | | |
− | '''ESP DNS''' Enter you local DNS server IP address. Usually the IP of your local internet router.
| |
− | | |
− | == Controllers page (version 2.0+) ==
| |
− | URL:<espeasyip>/'''controllers'''<br/>
| |
− | [[File:WebGUI_controllers.PNG]]
| |
− | | |
− | It is possible to have multiple controllers/brokers activated.
| |
− | | |
− | == Hardware page ==
| |
− | URL:<espeasyip>/'''hardware'''<br/>
| |
− | [[File:ESPEasy_Hardware.png]]
| |
− | | |
− | '''Status LED''' (version 2.0 only) Select the data pin used for a low active LED to show the status of the firmware. Use D4 (GPIO2) for the on-board blue LED.
| |
− | | |
− | [[File:StatusLEDModes.png|200px]]
| |
− | | |
− | '''SDA''' Select the data pin used for I2C communications.
| |
− | | |
− | '''SCL''' Select the clock pin used for I2C communications.
| |
− | | |
− | '''Pin mode x''' Select an optional boot state for this pin, either output low or high
| |
− | | |
− | I2C is a well known standard to let multiple devices communicate over just two wires (and ground). We use it to connect sensors to ESP Easy. You can connect multiple sensors to the same two wires. Don't forget to use pull-up resistors on both SDA and SCL, unless one of your sensors already has them mounted on board.
| |
− | | |
− | == Rules page ==
| |
− | URL:<espeasyip>/'''rules'''<br/>
| |
− | [[File:WebGUI_rules.PNG]]
| |
− | Here's where the rules goes.
| |
− | | |
− | == Notifications page (version 2.0+) ==
| |
− | URL:<espeasyip>/'''notifications'''<br/>
| |
− | [[File:WebGUI_notifications.PNG]]
| |
− | | |
− | It is possible to have the ESP unit send emails or giving you notifications using a buzzer.
| |
− | | |
− | == Devices page ==
| |
− | URL:<espeasyip>/'''devices'''<br/>
| |
− | [[File:ESPEasy_Devices.png]]
| |
− | | |
− | 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.
| |
− | | |
− | After selecting a new device, press the ? button to get specific help on this device!
| |
− | | |
− | <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>
| |
− | | |
− | == Tools page ==
| |
− | URL:<espeasyip>/'''tools'''<br/>
| |
− | [[File:ESPEasy_Tools.png]]
| |
− | | |
− | Some maintenance tools.
| |
− | | |
− | | |
− | === Tools Log page ===
| |
− | URL:<espeasyip>/'''log'''<br/>
| |
− | [[File:WebGUI_log.PNG]]
| |
− | | |
− | This page can be used for debugging issues. The debug level is set to '2' by default and will show sensor readings. Debugging levels can be changed under Tools/Advanced.
| |
− | | |
− | If your system runs fine, you can set the level to '0' to turn of logging. This will save valuable RAM!
| |
− | | |
− | === Tools Advanced page ===
| |
− | URL:<espeasyip>/'''advanced'''<br/>
| |
− | [[File:ESPEasy_Tools_Advanced.png]]
| |
− | | |
− | '''Subscribe Template''' Used for MQTT subscription. Selecting a MQTT protocol will automatically fill this field
| |
− | | |
− | '''Publish Template''' Used for MQTT publishing. Selecting a MQTT protocol will automatically fill this field
| |
− | It is also used for the Generic HTTP protocol. Create your custom template here.
| |
− | | |
− | '''MQTT Retain Msg'''
| |
− | | |
− | '''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>
| |
− | | |
− | '''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.
| |
− | | |
− | '''Use NTP''' To enable internal software clock, synchronized using internet time.
| |
− | | |
− | '''NTP Hostname''' Can be left empty as it defaults to pool.ntp.org. Can be changed here if needed.
| |
− | | |
− | '''Timezone Offset''' Offset in minutes to GMT. In the Netherlands this should be '60'
| |
− | | |
− | '''DST''' Daylight Saving Time. Must be set manually when DST is active to adjust the time.
| |
− | | |
− | '''Syslog IP''' Enter your syslog server IP if you have one running and want to debug something.
| |
− | | |
− | '''Syslog level''' Level of log messaging to the syslog server. Can be set between 0 - 4 (0=no logging, 1=error, 2=error+info, 3=error+info+debug, 4=error+info+more debug)
| |
− | | |
− | '''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.
| |
− | <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.
| |
− | | |
− | '''Enable Serial Port''' Enable/disable the serial port.
| |
− | | |
− | '''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)
| |
− | | |
− | '''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)
| |
− | | |
− | '''Baud Rate''' Serial port baud rate
| |
− | | |
− | '''WD I2C Address''' I2C address to send watchdog messages to. Experimental feature to feed a ATTiny based external watchdog.
| |
− | | |
− | '''Custom CSS''' Tick this box to use a custom CSS (style sheet). You must first upload a "esp.css" file one to use this.
| |
− | <span style="color:red">The CSS filesize can not exceed 4 kbyte!</span>.
| |
− | | |
− | '''Use SSDP''' SSDP is a network protocol based on the Internet Protocol Suite for advertisement and discovery of network services and presence information. This option toggles this service.
| |
− | | |
− | '''Rules''' Tick this checkbox to enable the Rules section for scripting the device. Else the rules aren't visible and editable and won't be processed at all.
| |
− | | |
− | '''I2C ClockStrechLimit'''
| |
− | | |
− | '''Global Sync'''
| |
− | | |
− | === Tools Wifi scan ===
| |
− | URL:<espeasyip>/'''wifiscanner'''<br/>
| |
− | [[File:WebGUI_wifiscanner.PNG]]
| |
− | | |
− | Here's a list of all accessible wifi networks and their signal strength.
| |
− | | |
− | === Tools I2C scan ===
| |
− | URL:<espeasyip>/'''i2cscanner'''<br/>
| |
− | [[File:WebGUI_i2cscanner.PNG]]
| |
− | | |
− | If one or more I2C devices are connected to the ESP Easy, you can use this scan feature to verify if devices can be located using their I2C address. If no device is shown, you likely made a mistake on wiring or the I2C configuration in the Hardware page.
| |
− | | |
− | If the I2C scanner lists an address, it will also list some well known devices that are fixed or typically found on that address. It does NOT mean that the detected device is verified to work in any way. I2C devices use a 7 bit address and the ESP will just scan all 127 possible addresses. If a device listens to some address it will acknowledge this to the ESP. It does not report the type of device so the ESP can only tell that something is listening!
| |
− | | |
− | === Tools Settings up/download ===
| |
− | URL:<espeasyip>/'''upload''' (for uploading settings)<br/>
| |
− | [[File:WebGUI_upload.PNG]]
| |
− | | |
− | URL:<espeasyip>/'''download''' (for downloading settings, not a webpage but a direct download)<br/>
| |
− | [[File:WebGUI_download.PNG]]
| |
− | | |
− | The ESP Easy settings can be saved to your computer so you can restore them if they are lost or you just want to restore them after some experimenting. You can also upload a custom style sheet.
| |
− | | |
− | The system recognizes only two filenames:
| |
− | | |
− | '''config.txt'''
| |
− | | |
− | This file contains the ESP main configuration settings, except security data. The filesize should be 32k.
| |
− | You can exchange this file with other people if you like, because WPA keys and config password are not stored into this file.
| |
− | | |
− | Security data cannot be saved or restored from file!
| |
− | | |
− | | |
− | '''esp.css''' (Custom Style Sheet, max 4 kb !)
| |
− | | |
− | If you want to customize the web gui you can upload (a small) css file. Remember that the webgui is only there for configuration so customization is limited. You may use the following stylesheet as an working example or template for further customization. And don't forget to activate the uploaded stylesheet in the TOOLS>ADVANCED section by enabling the "Custom CSS" option.
| |
− | | |
− | <pre style="margin:0%;20%;">
| |
− | * {
| |
− | font-family: verdana,sans-serif;
| |
− | font-size: 13px;
| |
− | }
| |
− | h1 {
| |
− | color: black;
| |
− | font-size: 16pt;
| |
− | }
| |
− | | |
− | h1::after {
| |
− | content: " (Powersocket Livingroom)"; /* Give your Device an additional selfexplaing name after the topmost headline */
| |
− | }
| |
− | | |
− | h6 {
| |
− | color: black;
| |
− | font-size: 10pt;
| |
− | text-align: center;
| |
− | }
| |
− | .button-menu {
| |
− | background: #3498db;
| |
− | background-image: -webkit-linear-gradient(top, #3498db, #2980b9);
| |
− | background-image: -moz-linear-gradient(top, #3498db, #2980b9);
| |
− | background-image: -ms-linear-gradient(top, #3498db, #2980b9);
| |
− | background-image: -o-linear-gradient(top, #3498db, #2980b9);
| |
− | background-image: linear-gradient(to bottom, #3498db, #2980b9);
| |
− | -webkit-border-radius: 7;
| |
− | -moz-border-radius: 7;
| |
− | border-radius: 7px;
| |
− | color: #ffffff;
| |
− | padding: 3px 10px 3px 10px;
| |
− | border: solid #1f628d 1px;
| |
− | text-decoration: none;
| |
− | margin:0px 2px;
| |
− | }
| |
− | | |
− | .button-menu:hover {
| |
− | background: #8fd4ff;
| |
− | background-image: -webkit-linear-gradient(top, #8fd4ff, #3498db);
| |
− | background-image: -moz-linear-gradient(top, #8fd4ff, #3498db);
| |
− | background-image: -ms-linear-gradient(top, #8fd4ff, #3498db);
| |
− | background-image: -o-linear-gradient(top, #8fd4ff, #3498db);
| |
− | background-image: linear-gradient(to bottom, #8fd4ff, #3498db);
| |
− | text-decoration: none;
| |
− | margin:0px 2px;
| |
− | }
| |
− | | |
− | .button-link {
| |
− | border: 1px solid;
| |
− | border-radius: 5px;
| |
− | background:ButtonFace;
| |
− | color:ButtonText;
| |
− | border-color:ButtonHighlight ButtonShadow ButtonShadow ButtonHighlight;
| |
− | padding: 5px 15px;
| |
− | text-decoration: none;
| |
− | }
| |
− | .button-link:hover {
| |
− | background-color:Highlight;
| |
− | color:HighlightText;
| |
− | }
| |
− | .button-link:active {
| |
− | border-color:ButtonShadow ButtonHighlight ButtonHighlight ButtonShadow;
| |
− | }
| |
− | th {
| |
− | background-color: #369;
| |
− | color: #ffffff;
| |
− | padding: 10px;
| |
− | }
| |
− | td {
| |
− | padding: 7px;
| |
− | }
| |
− | table {
| |
− | color: black;
| |
− | border-collapse:collapse;
| |
− | }
| |
− | .div_l {
| |
− | float: left;
| |
− | }
| |
− | .div_r {
| |
− | background-color: #080;
| |
− | border-radius: 7px;
| |
− | color: white;
| |
− | float: right;
| |
− | margin: 2px;
| |
− | padding: 1px 10px;
| |
− | }
| |
− | .div_br {
| |
− | clear: both;
| |
− | }
| |
− | | |
− | </pre>
| |
− | | |
− | === Tools Firmware update using OTA ===
| |
− | URL:<espeasyip>/'''update'''<br/>
| |
− | [[File:WebGUI_update.PNG]]
| |
− | | |
− | Once your first ESP Easy firmware is loaded using the serial interface, subsequent updates can be loaded using the Wifi connection (if your unit has 1MB flash or more!).
| |
− | More details on OTA firmware update: [[EasyOTA]]
| |
− | | |
− | === Tools File List (version 2.0+) ===
| |
− | URL:<espeasyip>/'''filelist'''<br/>
| |
− | [[File:WebGUI_filelist.PNG]]
| |
− | | |
− | Access to the ESP's files. Possible to download for backup, or upload your own files.
| |
− | | |
− | === Tools SD CARD File List (version 2.0+) ===
| |
− | URL:<espeasyip>/'''SDfilelist'''<br/>
| |
− | [[File:WebGUI_SDfilelist.PNG]]
| |
− | | |
− | Access to the ESP's files stored on the SD card (if any SD card). Possible to download for backup, or upload your own files.
| |
− | | |
− | == JSON page (hidden prior to version 2.0+) ==
| |
− | URL:<espeasyip>/'''json'''<br/>
| |
− | [[File:WebGUI_json.PNG]]
| |
− | | |
− | If you want to get the ESP units variables in a JSON package this is where you want to go. The page is not accessible through any webpage button like the other pages.
| |
| | | |
| = Command Reference = | | = Command Reference = |