ESPEASY

Rules Event reference, Command Reference

Flash a NodeMCU ESP8266 / ESP01S

Send sensor to MQTT broker (tested)

  • At “config” give the ESP a Unit Name
  • Add a controller “Home Assistant (openHAB) MQTT”
    • Fill in the IP address
    • Credentials if used
    • Enable
  • Devices
    • Edit the sensor
    • Enable send to controller (select the MQTT controller)
    • Index number higher than zero, this must be unique for each signal.

ESPEASY P2P network (tested)

  • Both > Config > Unique unit name and unique unit number
  • Both > Controllers > add at #1 a ESPEasy P2P Networking controller
    • portnumber 8266 (both esp the same)
      • Check at Tools > Advanced > ESPEasy p2p UDP port:
    • Make sure it is enabled
    • Both > At the Main page the node list must contain 2 nodes.
  • Both >Hardware no change
  • Go to the 1st ESP
  • Devices > create one wire sensor at task #6 for example
    • refresh rate 5 sec ( not necessary but better than waiting a minute )
    • Send to controller 1
    • Make sure it is enabled
    • Make it working (check devices overview to see a changing value)
  • Go to the 2nd ESP
  • Refresh the devices list and it should appear at task #6
  • Enable the device and adapt the interval

ESP EASY Rules

ESPEASY rules on YouTube

A simple rule to switch on the onboard LED depending of a temperature measurement.

ON OneWireTest#temperature>22 do
gpio,2,0
endon

ON OneWireTest#temperature<21 do
gpio,2,1
endon

ESP EASY rules example

Create a Generic – Dummy Device
– Task 1
– Name it SetPoints
– Enable
– Output Data Type Quad
Submit
Create a 2nd Generic – Dummy Device
– Task 2
– Name it Dummy02
– Enable
– Output Data Type Quad
Submit

Rules > Set fixed numbers over http

// HTTP command > http://<ip_address>/control?cmd=event,SetVar01
On SetVar01 Do
taskvalueset,1,1,10 // Or taskvalueset,SetPoints,1,10
taskvalueset,1,2,20
taskvalueset,1,3,33
taskvalueset,1,4,40
Endon

Result:

Rules > Set variable over http

// HTTP command > http://<ip_address>/control?cmd=event,SetVar02=11,12,13,14
On SetVar02 Do
taskvalueset,1,1,%eventvalue1% // Or taskvalueset,SetPoints,1,%eventvalue1%
taskvalueset,1,2,%eventvalue2%
taskvalueset,1,3,%eventvalue3%
taskvalueset,1,4,%eventvalue4%
Endon

Result:

Rules > Set variable numbers over http with follow up action
// HTTP command > http:///control?cmd=event,SetVar03=11,12,13,14
On SetVar03 Do
taskvalueset,1,1,%eventvalue1% // Or taskvalueset,SetPoints,1,%eventvalue1%
taskvalueset,1,2,%eventvalue2%
taskvalueset,1,3,%eventvalue3%
taskvalueset,1,4,%eventvalue4%
// To initiate followup actions
TaskRun,1 // Or TaskRun,SetPoints
Endon

on SetPoints#Dummy do // Activated by three lines above
if %eventvalue1% < 15.00
// Set a GPIO output
GPIO,2,1
// Set another Dummy Device
taskvalueset,2,1,11
endif
if %eventvalue1% > 15.00
GPIO,2,0
taskvalueset,2,1,10
endif
Endon

Rules > Calculation and variable
// HTTP command > http:///control?cmd=event,SetVar04=12,22,32,42
On SetVar04 Do
Let 1,(%eventvalue1%*3) // Read variable as %v1% or [VAR#1]
taskvalueset,2,2,(%v1%*3)
Endon

Result:

Test a device and set follow-up action

// HTTP command > http:///control?cmd=event,Test01
On Test01 Do
If [SetPoints#Signal01] < 15 //If SetPoints#%eventvalue1% < 15 GPIO,2,0 // Set another Device Signal taskvalueset,2,1,36 endif If [SetPoints#Signal01] > 15
//If SetPoints#%eventvalue1% < 15
GPIO,2,1
// Set another Device Signal
taskvalueset,2,1,37
endif
Endon

ESPEASY Fade in/out

The easy way >htttp://<IP>/control?cmd=PWM,16,450,1000
– 16 is the GPIO pin
– 450 is the intensity endpoint- 1000 is the duration to go to the endpoint.

Fade in/out by script.

On verlichting_ON do
  looptimerset_ms,2,50,20 // Timer 2 / Time in Ms / Number of loops

On Rules#Timer=2 do
  let,2,(%eventvalue2%*15)  // Store the loop count in a variable
  PWM,16,%v2%
Endon


On verlichting_OFF do
  LoopTimerSet,3,5,70
Endon 

On Rules#Timer=3 do
// Take the current value of a device, reduce the value and store it a variable
  let,3,([Plugin#GPIO#Pinstate#3]-%eventvalue2%*15)
// Minimum value is 0
  If %v3% < 0    
    Let,3,0
  Endif
  PWM,3,%v3%
Endon

Plugins

NormalABCDEFGClimateCustom_274Custom_312Custom_IREnergy
0– None –0000000000000
1Switch input – Switch1111111111111
2Analog input – internal2222222222222
3Generic – Pulse counter3333333333333
4Environment – 1-Wire Temperature4444444444444
5Environment – DHT11/12/22  SONOFF2301/7021/MS01555555555–––5
6Environment – BMP085/180666666666–––6
7Analog input – PCF859177777777––––7
8RFID – Wiegand88888888––––8
9Switch input – MCP2301799999999––––9
10Light/Lux – BH1750101010101010101010–––10
11Extra IO – ProMini Extender111111111111111111–––11
12Display – LCD2004121212121212121212–––12
13Position – HC-SR04, RCW-0001, etc.131313131313131313–––13
14Environment – SI70xx/HTU21D141414141414141414–––14
15Light/Lux – TSL2561151515151515151515–––15
16Communication – IR Receive (TSOP4838)–––––––––––16–
17RFID – PN5321717171717171717––––17
18Dust – Sharp GP2Y10181818181818181818–––18
19Switch input – PCF8574191919191919191919–––19
20Communication – Serial Server2020202020202020––––20
21Regulator – Level Control212121212121212121–––21
22Extra IO – PCA96852222222222222222––––22
23Display – OLED SSD1306232323232323232323–––23
24Environment – MLX90614242424242424242424–––24
25Analog input – ADS1x15252525252525252525–––25
26Generic – System Info26262626262626262626262626
27Energy (DC) – INA2192727272727272727–27272727
28Environment – BMx28028282828282828282828282828
29Output – Domoticz MQTT Helper29292929292929292929292929
30––––––––––––––
31Environment – SHT1x313131313131313131–––31
32Environment – MS5611 (GY-63)323232323232323232–––32
33Generic – Dummy Device33333333333333333333333333
34Environment – DHT12 (I2C)343434343434343434–––34
35Communication – IR Transmit–––––––––––35–
36Display – OLED SSD1306/SH1106 Framed36363636363636363636363636
37Generic – MQTT Import3737373737373737373737–37
38Output – NeoPixel (Basic)383838383838383838–––38
39Environment – Thermosensors393939393939393939–––39
40RFID – ID12LA/RDM63004040404040404040––––40
41––––––––––––––
42––––––––––––––
43Output – Clock434343434343434343–––43
44Communication – P1 Wifi Gateway444444444444444444–––44
45Gyro – MPU 6050–45454545454545–454545–
46––––––––––––––
47Environment – Soil moisture sensor–4747474747474747––––
48Motor – Adafruit Motorshield v2–48484848484848–––––
49Gases – CO2 MH-Z1949494949494949494949494949
50Color – TCS34725–50505050505050–––––
51Environment – AM2320–5151515151515151––––
52Gases – CO2 Senseair52525252525252525252525252
53Dust – PMSx003 / PMSx003ST535353535353535353–––53
54Communication – DMX512 TX–54545454545454–––––
55Notify – Chiming–55555555555555–––––
56Dust – SDS011/018/19856565656565656565656565656
57Communication – DMX512 TX–57575757575757–––––
58Notify – Chiming–58585858585858–––––
59Switch Input – Rotary Encoder595959595959595959–––59
60Analog input – MCP3221–60606060606060–––––
61Keypad – PCF8574 / MCP23017 / PCF8575–61616161616161–––––
62Keypad – MPR121 Touch–62626262626262–––––
63Keypad – TTP229 Touch6363636363636363––––63
64Gesture – APDS9960–64646464646464–––––
65Notify – DFPlayer-Mini MP3–65656565656565–––––
66Color – VEML6040–66666666666666–––––
67Weight – HX711 Load Cell–67–––––––––––
68Environment – SHT3x–68––––––68––––
69Environment – LM75A––69–––––69––––
70Output – NeoPixel Ring Clock–70–––––––––––
71Communication – Kamstrup Multical 401–71–––––––––––
72Environment – HDC10xx (I2C)–72––––––72––––
73Display – 7-segment display737373737373737373–––73
74Light/Lux – TSL2591–74–––––––––––
75Display – Nextion–75757575757575–––––
76Energy (AC) – HLW8012/BL0937––––––––––––76
77Energy (AC) – CSE7766––––––––––––77
78Energy (AC) – Eastron SDMxxx Modbus––––––––––––78
79Motor – Wemos/Lolin Motorshield7979797979797979––––79
80Input – iButton–80–––––––––––
81Generic – CRON–8181818181818181818181–
82Position – GPS–82828282828282–828282–
83Gases – SGP30 TVOC/eCO2–83––––––83––––
84UV – VEML6070–84–––––––––––
85Energy – AccuEnergy AcuDC24x–––85––––––––85
86Generic – Homie receiver–86–––––––––––
87Communication – Serial Proxy–––87–––––––––
88––––––––––––––
89Communication – Ping–89898989898989–––––
90Gases – CCS811 TVOC/eCO2–90––––––90––––
91Serial MCU controlled switch–––91–––––––––
92Heating – DL-Bus (Technische Alternative)–––92–––––––––
93Energy (Heat) – Mitsubishi Heat Pump––––93–––––––93
94Communication – CUL Reader––––94––––––––
95––––––––––––––
96––––––––––––––
97––––––––––––––
98Motor – PWM Motor–98––98––––––98–
99––––––––––––––
100Pulse Counter – DS2423––100––––––––––
101Communication – Wake On LAN––101––––––––––
102Energy (AC) – PZEM-004Tv30-Multiple––––––––––––102
103Environment – Atlas EZO pH ORP EC DO––103–––––103––––
104––––––––––––––
105Environment – AHT10/AHT2x–105––––––105––––
106Environment – BME68x––106–––––106––––
107UV – SI1145––107––––––––––
108Energy (AC) – DDS238-x ZN––108–––––––––108
109––––––––––––––
110Distance – VL53L0X (200cm)––110––––––––––
111RFID – RC522–––111–––––––––
112Color – AS7265X––––––112––––––
113Distance – VL53L1X (400cm)––113––––––––––
114UV – VEML6075 UVA/UVB Sensor––––114––––––––
115Energy – Fuel Gauge MAX1704x––––115–––––––115
116––––––––––––––
117Gases – CO2 SCD30––––117–––117––––
118Communication – Itho ventilation––––––118–118––––
119Gyro – ITG3205–––––119–––––––
120Accelerometer – ADXL345 (I2C)–––––120–––––––
121Position – HMC5883L–––––121–––––––
122Environment – SHT2x––––––122–122––––
123––––––––––––––
124Output – I2C Multi Relay––––124––––––––
125Accelerometer – ADXL345 (SPI)–––––125–––––––
126Output – Shift registers (74HC595)–––––126–––––––
127Gases – CO2 CDM7160––––127–––127––––
128––––––––––––––
129Input – Shift registers (74HC165)–––––129–––––––
130––––––––––––––
131––––––––––––––
132Energy (DC) – INA3221––––––––––––132
133UV – LTR390–––––133––133––––
134Distance – A02YYUW–134–––––––––––
135Gases – CO2 SCD4x–––––135––135––––
136––––––––––––––
137––––––––––––––
138––––––––––––––
139––––––––––––––
140––––––––––––––
141––––––––––––––
142––––––––––––––
143Switch input – I2C Rotary encoders–––143–––––––––
144Dust – PM1006(K) (Vindriktning)–––––144––144––––
145Gases – MQxxx (MQ135 CO2, MQ3 Alcohol) [TESTING]––––––145––––––
146Generic – Cache Reader–––––––––146146––
147Gases – SGP4x VOC(/NOx)––––––147–147––––
148––––––––––––––
149––––––––––––––
150Environment – TMP117 Temperature––––––150–150––––
151Environment – I2C Honeywell Pressure––––––151–151––––
152––––––––––––––
153Environment – SHT4x––––––153–153––––