ESPEasy Command Reference

From Let's Control It
Jump to: navigation, search

ESP Easy offers a set of commands to control hardware devices and provide some basic local control using rules. There are several ways to launch commands on ESP Easy:

  • Using HTTP: syntax http://<espeasyip>/control?cmd=<command>
  • Using MQTT: send the <command> to topic <MQTT subscribe template>/cmd (as of current status this is obeyed only for the first controller in the list)
  • Using Serial port: just type the <command>
  • Using UDP between ESP units: SendTo <unit nr>, <command> (Setup UDP peer-2-peer first!)
  • Using the Rule engine: just enter the <command> within an event block or conditional block.

Commands are divided into several classes:

Internal - Can be run from serial and rules engine
Rules -  Can be run from serial and rules engine
Plugins - Can be run from serial, rules engine, HTTP, MQTT
Special - This can be used from any source

If you want to use internal or rules commands using HTTP/MQTT, setup an event within the rules section and remotely launch the "event" command.

Command Class Purpose Syntax
Debug Internal Change Serial port debug level Debug <1-4>
Delay Rules Delay rule processing Delay <delay in milliSeconds>
Event Special Create an event event <event>
GPIO Plugin Direct control of output pins See:GPIO
Pulse Plugin Send short pulses See:GPIO
PWM Plugin PWM control See:GPIO
Servo Plugin Servo motor control See:GPIO
Tone Plugin Play tone via speaker or piezo See:GPIO
Rtttl Plugin Play melody via speaker or piezo See:GPIO
IP Internal Change IP address IP <IP address>
LCD Plugin Write text messages to LCD screen See:LCDDisplay
LCDCMD Plugin Control LCD screen See:LCDDisplay
LongPulse Plugin Direct pulse control of output pins See:GPIO
MCPGPIO Plugin Control MCP23017 output pins See:MCP23017
MCPPulse Plugin Pulse control on MCP23017 output pins See:MCP23017
MCPLongPulse Plugin Long pulse control on MCP23017 output pins See:MCP23017
OLED Plugin Write text messages to OLED screen See:OLEDDisplay
OLEDCMD Plugin Control OLED screen See:OLEDDisplay
PCAPWM Plugin Control PCA9685 pwm pins See:PCA9685
PCFGPIO Plugin Control PCF8574 output pins See:PCF8574
PCFPulse Plugin Pulse control on PCF8574 output pins See:PCF8574
PCFLongPulse Plugin Long pulse control on PCF8574 output pins See:PCF8574
Pulse Plugin Direct pulse control of output pins See:GPIO
Publish Rules Send command using MQTT broker service Publish <topic>, <value>
PWM Plugin Direct PWM control of output pins See:GPIO
Reboot Internal Reboot the ESP Reboot
Reset Internal Reset config to factory default Reset
Save Internal Save config to persistent flash memory Save
SendTo Rules Send command to other ESP (using UDP) SendTo <unit nr>, <command>
SendToHTTP Rules Send command to other network device using HTTP SendToHTTP <IP address>, <Portnumber>, <command>
SendToUDP Rules Send command to other network device using UDP SendToUDP <IP address>, <Portnumber>, <command>
Servo Plugin Direct control of servo motors See:GPIO
Settings Internal Show settings on serial terminal Settings
Status Plugin Show status on previously controlled pins Status <device>, <pin>
TaskValueSet Rules Set values on a Dummy Task device TaskValueSet <task nr>, <value nr>, <value/formula>
TimerSet Rules Start a timed event TimerSet <timernr>,
WifiAPKey Internal Change AP WPA key WifiAPKey <WPA key>
WifiConnect Internal Connect to configured wireless network WifiConnect
WifiDisconnect Internal Disconnect from wireless network WifiDisconnect
WifiKey Internal Change WPA key WifiKey <Wifi WPA key>
WifiScan Internal Scan Wireless networks WifiScan
WifiSSID Internal Change SSID WifiSSID <SSID>