ESP Easy
  • Rules
  • Forum
  • Site

      Table of Contents

      • About Us
        • History
          • Early days (Nodo Uno)
          • 04/2010 (Nodo Due)
          • 10/2011 (Joining the Nodo community)
          • 03/2012 (Nodo Mega)
          • 05/2013 (Nodo NES Shield)
          • 01/2014 (Exploring new wireless capabilities)
          • 02/2015 (Entering the Wi-Fi solution)
          • 04/2015 (ESP Connexio)
          • 05/2015 (ESP Easy initiative)
          • 09/2015 (ESP Easy R020)
          • 02/2016 (ESP Easy R078)
          • 08/2016 (ESP Easy R120)
          • 11/2016 (ESP Easy Mega)
          • 02/2017 (Change of roles)
          • 08/2018 (New core team)
      • ESP Easy Function Blocks
      • Config page
        • Main Settings
          • Unit Name
          • Unit Number
          • Append Unit Number to hostname
          • Admin Password
        • WiFi Settings
          • SSID
          • WPA Key
          • Fallback SSID / WPA Key
          • WPA AP Mode Key
        • Client IP filtering
          • Client IP block level
          • Access IP lower range
          • Access IP upper range
        • WiFi/Ethernet IP Settings
        • Sleep Mode
          • Description
          • Sleep awake time
          • Sleep time
          • Sleep on connection failure
      • Controller
        • Controller Plugins
        • Controller Parameters
          • Generic fields
          • Send queue parameters
          • Controller user credentials
          • MQTT related settings
      • Hardware page
        • Overview
          • Wifi Status LED
          • Reset pin
          • I2C Interface
          • I2C Multiplexer
          • SPI Interface
          • Ethernet
          • GPIO boot states
      • Plugins
        • List of official plugins
          • Internal GPIO handling
          • Analog input
          • Communication
          • Display
          • Dust
          • Energy (AC)
          • Energy (DC)
          • Energy (Heat)
          • Environment
          • Extra IO
          • Gases
          • Generic
          • Gesture
          • Gyro
          • Hardware
          • Keypad
          • Light/Color
          • Light/Lux
          • Light/UV
          • Motor
          • Notify
          • Output
          • Position
          • Regulator
          • RFID
          • Switch input
          • Weight
      • Rules
        • Introduction
          • Enable Rules
          • Device name special considerations
          • Special Notations
          • Syntax
          • IF/ELSE - IF/ELSEIF/ELSE
          • AND/OR
          • Trigger
          • Operator (inequality function)
          • (System) events
          • Test
          • Action
          • Comment
          • Referring values
          • Special task names
          • Parameter parsing
          • Formatting refered values
          • String Formatting and Interpreting
          • System variables
          • Best practice
        • Some working examples
          • TaskValueSet
          • Event value (%eventvalue%)
          • Internal variables
          • Averaging filters
          • PIR and LDR
          • SR04 and LDR
          • Timer
          • Sub-second resolution and loop timers
          • Starting/stopping repeating timers with events
          • HTTP call
          • SendTo and Publish
          • Time
          • SendToHTTP
          • Dew Point for temp/humidity sensors (BME280 for example)
          • Report IP every 30 seconds using MQTT
          • Custom reports to Domoticz with own IDX
          • One button, multiple actions using long press
          • Calculating water consumption
          • Iterate over lookup table
      • Tools
        • Log
          • Log Directions
          • Log Levels
        • Info
        • Advanced
          • Rules Settings
          • NTP Settings
          • DST Settings
          • Location Settings
          • Log Settings
          • Serial Settings
          • Inter-ESPEasy Network
          • Special and Experimental Settings
        • Show JSON
        • Timing Stats
          • Interpret Statistics
          • Typical Outliers
          • Tweaking Timeout using Timing Stats
        • System Variables
        • Factory Reset
        • Settings Archive
          • Download Settings
          • Side Effects on cloning
      • WiFi
        • WiFi State Machine
          • WiFi STA states
          • WiFi AP mode states
        • WiFi disconnect reasons
          • Beacon timeout (200)

      Appendix

      • PlatformIO
        • PlatformIO Prerequisites
          • Windows ExecutionPolicy
        • PlatformIO with Atom
        • PlatformIO with VS-Code
          • install
          • Uncrustify
          • Load a project using PlatformIO
          • Make a custom build using PlatformIO
        • Upload to ESP
          • Linux
      • Arduino IDE
        • Prepare Arduino IDE
        • Arduino IDE Prerequisites
        • Download ESPEasy Sources
        • Building using Custom.h
          • Define USE_CUSTOM_H in ESPEasy_common.h
          • Build definition via platform.local.txt
        • Board definitions
      • Documentation
        • PlatformIO with Atom
        • LaTeX (PDF) build on Linux
      • Project Structure
        • ESPEasy Project Directories
        • ESPEasy src dir
        • ESPEasy ‘nightly builds’
          • Build Type
          • ESP Chip Type
          • Memory Size and Partitioning
          • Difference between .bin and .bin.gz
          • ESP32 builds
          • Blank Images
      • Safety
        • HWL8012 & CSE7766
      • Command Reference
        • Commands listed
          • Event command
          • Internal GPIO handling and ringtones
          • Plugin based commands
      • Event Reference
        • Internal (core) events
        • Plugin based events
          • P081 P081_page
          • P082 P082_page
      • GPIO
        • Best pins to use on ESP8266
          • Special notes on GPIO 6 - 11
          • Special notes on GPIO 16
        • Best pins to use on ESP32
          • Special notes on GPIO 6 - 11
          • Pins used for RMII Ethernet PHY
      • System Variables
        • Available System Variables
        • Standard Conversions
      • URLs
        • JSON
        • CSV
        • Control
      • RTC Reference
        • RTC layout ESPEasy
        • RTC Struct
      • Change Log
        • 2.0
  • Page
      • Welcome to ESP Easy’s documentation!
      • Indices and tables
  • About Us »

Welcome to ESP Easy’s documentation!¶

Table of Contents

  • About Us
    • History
  • ESP Easy Function Blocks
  • Config page
    • Main Settings
    • WiFi Settings
    • Client IP filtering
    • WiFi/Ethernet IP Settings
    • Sleep Mode
  • Controller
    • Controller Plugins
    • Controller Parameters
  • Hardware page
    • Overview
  • Plugins
    • List of official plugins
  • Rules
    • Introduction
    • Some working examples
  • Tools
    • Log
    • Info
    • Advanced
    • Show JSON
    • Timing Stats
    • System Variables
    • Factory Reset
    • Settings Archive
  • WiFi
    • WiFi State Machine
    • WiFi disconnect reasons

Appendix

  • PlatformIO
    • PlatformIO Prerequisites
    • PlatformIO with Atom
    • PlatformIO with VS-Code
    • Upload to ESP
  • Arduino IDE
    • Prepare Arduino IDE
    • Arduino IDE Prerequisites
    • Download ESPEasy Sources
    • Building using Custom.h
    • Board definitions
  • Documentation
    • PlatformIO with Atom
    • LaTeX (PDF) build on Linux
  • Project Structure
    • ESPEasy Project Directories
    • ESPEasy src dir
    • ESPEasy ‘nightly builds’
  • Safety
    • HWL8012 & CSE7766
  • Command Reference
    • Commands listed
  • Event Reference
    • Internal (core) events
    • Plugin based events
  • GPIO
    • Best pins to use on ESP8266
    • Best pins to use on ESP32
  • System Variables
    • Available System Variables
    • Standard Conversions
  • URLs
    • JSON
    • CSV
    • Control
  • RTC Reference
    • RTC layout ESPEasy
    • RTC Struct
  • Change Log
    • 2.0

Indices and tables¶

  • Index

  • Module Index

  • Search Page

Back to top

Support us by using one of these alternatives: Patreon Ko-Fi PayPal

© Copyright 2018-2020, ESP Easy.
Created using Sphinx 3.1.2.