Difference between revisions of "ESPEasy Command Reference"
Jump to navigation
Jump to search
Line 101: | Line 101: | ||
| Direct pulse control of output pins | | Direct pulse control of output pins | ||
| See:[[GPIO]] | | See:[[GPIO]] | ||
+ | |- | ||
+ | | Publish | ||
+ | | Rules | ||
+ | | Send command using MQTT broker service | ||
+ | | Publish <topic>, <value> | ||
|- | |- | ||
| PWM | | PWM | ||
Line 125: | Line 130: | ||
| Rules | | Rules | ||
| Send command to other ESP (using UDP) | | Send command to other ESP (using UDP) | ||
− | | SendTo <unit nr, command> | + | | SendTo <unit nr>, <command> |
|- | |- | ||
| SendToHTTP | | SendToHTTP | ||
| Rules | | Rules | ||
| Send command to other network device using HTTP | | Send command to other network device using HTTP | ||
− | | SendToHTTP <IP address, Portnumber, command> | + | | SendToHTTP <IP address>, <Portnumber>, <command> |
|- | |- | ||
| SendToUDP | | SendToUDP | ||
| Rules | | Rules | ||
| Send command to other network device using UDP | | Send command to other network device using UDP | ||
− | | SendToUDP <IP address, Portnumber, command> | + | | SendToUDP <IP address>, <Portnumber>, <command> |
|- | |- | ||
| Servo | | Servo | ||
Line 150: | Line 155: | ||
| Rules | | Rules | ||
| Start a timed event | | Start a timed event | ||
− | | TimerSet <timernr, time in seconds> | + | | TimerSet <timernr>, <time in seconds> |
|- | |- | ||
| WifiAPKey | | WifiAPKey |
Revision as of 09:25, 19 July 2016
ESP Easy Command Reference
You can send all commands supported by the various plugins. There should be no difference between using http or mqtt. There is also a command to trigger an event: event <event>
If you want to run internal commands, you can use rules and trigger this with an event
Command | Class | Purpose | Syntax |
---|---|---|---|
Debug | Internal | Change debug level | Debug <1-4> |
Delay | Rules | Delay rule processing | Delay <delay in milliSeconds> |
Event | Rules | Create an event | event <event> |
GPIO | Plugin | Direct control of output pins | 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 |
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> |