ESP3D commands

Conventions

1. Add a space to separate parameters
2. If a parameter contains a space, add \ before the space so it is not treated as a separator
3. json, json=YES, json=TRUE, json=1 switch the output to JSON format

By default output is plain text. To get JSON-formatted output add json or json=yes after the main parameters.

{
    cmd:"(command id)",
    status:"(ok/error)",
    data:"(response)"
}

Note

Use [ESP0] to get the full command list, or [ESP0](number) for a specific command.

---

WiFi & Network

Command	Description
ESP100	Set / Display Station SSID
ESP101	Set Station Password
ESP102	Set / Display Station IP mode
ESP103	Set / Display Station IP address
ESP104	Set station fallback mode state at boot
ESP105	Set / Display Access point SSID
ESP106	Set Access point password
ESP107	Set / Display Access point IP value
ESP108	Set / Display Access point channel value
ESP110	Set / Display radio state at boot
ESP111	Display current IP
ESP112	Set / Display Hostname
ESP114	Get / Set boot radio state
ESP115	Get / Set immediate network state
ESP116	Set / Display Ethernet station IP mode
ESP117	Set / Display Ethernet station IP address
ESP118	Set Ethernet station fallback mode state at boot

---

Services

Command	Description
ESP120	Get / Set HTTP state
ESP121	Get / Set HTTP port
ESP130	Get / Set Telnet state
ESP131	Get / Set Telnet port
ESP140	Sync / Set / Get current time
ESP150	Get / Set boot delay in ms / verbose boot
ESP160	Get / Set WebSocket state
ESP161	Get / Set WebSocket port
ESP170	Get / Set Camera commands / values
ESP171	Save frame to target path and filename
ESP180	Get / Set FTP state
ESP181	Get / Set FTP ports
ESP190	Get / Set WebDAV state
ESP191	Get / Set WebDAV port

---

Hardware & Device

Command	Description
ESP200	Get / Set SD state
ESP201	Get / Set pin value
ESP202	Get / Set SD card speed factor
ESP210	Get / Set sensor value / type
ESP212	Output to ESP3D screen status
ESP214	Output to ESP3D screen status
ESP215	Start a touch calibration
ESP220	Get ESP3D pins definition
ESP250	Play sound
ESP290	Delay / Pause command

---

Scripting

Command	Description
ESP300	Process local Lua script file on /FS or /SD
ESP301	Query and control ESP300 script

---

System Settings

Command	Description
ESP400	Get full ESP3D settings
ESP401	Set ESP3D settings
ESP402	Get / Set SD updater check at boot time
ESP410	List all AP detected around
ESP420	Get ESP3D current status
ESP444	Set ESP3D state
ESP450	List available ESP3D modules / devices

---

Authentication

Command	Description
ESP500	Get authentication status
ESP510	Set / Get session timeout
ESP550	Set / Change admin password
ESP555	Set / Change user password

---

Notifications

Command	Description
ESP600	Send notification
ESP610	Set / Get notification settings
ESP620	Send notification using encoded URL

---

File System

Command	Description
ESP700	Process local file on /FS or /SD
ESP701	Query and control ESP700 stream
ESP710	Format ESP filesystem
ESP715	Format SD card
ESP720	List files on /FS or defined repository
ESP730	Actions on ESP filesystem: rmdir / remove / mkdir / exists / create
ESP740	List files on /SD or defined repository
ESP750	Actions on SD card: rmdir / remove / mkdir / exists / create
ESP780	List global filesystem
ESP790	Actions on global filesystem: rmdir / remove / mkdir / exists / create

---

Firmware

Command	Description
ESP800	Get ESP3D firmware capabilities

---

Communication

Command	Description
ESP900	Get / Set state for main serial communication
ESP901	Set serial baudrate for main serial communication
ESP902	Set USB serial baudrate
ESP910	Get / Set state for buzzer
ESP930	Get / Set state for serial bridge
ESP931	Get / Set baudrate for serial bridge
ESP950	Get / Set default output
ESP999	Set quiet boot