GitHub-Proxy/ESP3D
1
0
Fork 0
mirror of https://git.mirrors.martin98.com/https://github.com/luc-github/ESP3D.git synced 2025-08-04 08:10:39 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity
ESP3D/docs/Commands.md
Luc a885afced8 Update documentation 
Remove SDFat2 warning
Add several sanity check
Fix some edge cases in authentication process
Remove debug messages
Clarify some status in http handler responses
2022-09-04 15:40:03 +08:00

14 KiB
Raw Blame History

Direct ESP3D commands (V3.x)

Conventions

1 - add space to separate parameters 2 - if parameter has space add \ in front of space to not be seen as separator 3 - json json=YES json=TRUE json=1 are paremeters to switch output to json By default output is plain text, to get json formated output add json or json=yes after main parameters
The json format is { cmd:"", //the id of requested command status:"<ok/error>" //give if it is success or an failure data:"" // response corresponding to answer in json format too }

Commands

  • Show commands help
    [ESP]<command id> json=<no>

  • Set/Get STA SSID
    [ESP100]<SSID> json=<no> pwd=<admin password for set/get & user password to get>

  • Set STA Password
    [ESP101]<Password> json=<no> pwd=<admin password>

  • Set/Get STA IP mode (DHCP/STATIC)
    [ESP102]<mode> json=<no> pwd=<admin password>

  • Set/Get STA IP/Mask/GW/DNS
    [ESP103]IP=<IP> MSK=<IP> GW=<IP> DNS=<IP> json=<no> pwd=<admin password>

  • Set/Get sta fallback mode which can be WIFI-AP, BT, OFF
    [ESP104]<state> json=<no> pwd=<admin password>

  • Set/Get AP SSID
    [ESP105]<SSID> json=<no> pwd=<admin password>

  • Change AP Password
    [ESP106]<Password> json=<no> pwd=<admin password>

  • Set/Get AP IP
    [ESP107]<IP> json=<no> pwd=<admin password>

  • Set/Get AP channel
    [ESP108]<channel> json=<no> pwd=<admin password>

  • Set/Get radio state which can be WIFI-STA, WIFI-AP, BT, ETH-STA, ETH-AP, OFF
    [ESP110]<state> json=<no> pwd=<admin password>

  • Get current IP
    [ESP111]json=<no>

  • Get/Set hostname
    [ESP112]<Hostname> json=<no> pwd=<admin password>

  • Get /Set Boot radio state which can be ON, OFF
    [ESP114]<state> json=<no> pwd=<user/admin password>

  • Get/Set immediate network(WiFi/BT/Ethernet) state which can be ON, OFF
    [ESP115]<state> json=<no> pwd=<admin password>

  • Get/Set HTTP state which can be ON, OFF
    [ESP120]<state> json=<no> pwd=<admin password>

  • Get/Set HTTP port
    [ESP121]<port> json=<no> pwd=<admin password>

  • Get/Set Telnet state which can be ON, OFF, CLOSE
    [ESP130]<state> json=<no> pwd=<admin password>

  • Get/Set Telnet port
    [ESP131]<port> json=<no> pwd=<admin password>

  • Sync / Set / Get current time
    [ESP140]<SYNC> <srv1=XXXXX> <srv2=XXXXX> <srv3=XXXXX> <zone=xxx> <dst=YES/NO> <time=YYYY-MM-DD#H24:MM:SS> <NOW> json=<no> pwd=<admin password>

  • Get/Set display/set boot delay in ms / Verbose boot
    [ESP150]<delay=time in milliseconds><verbose=ON/OFF>pwd=<admin password>

  • Get/Set WebSocket state which can be ON, OFF
    [ESP160]<state> json=<no> pwd=<admin password>

  • Get/Set WebSocket port
    [ESP161]<port> json=<no> pwd=<admin password>

  • Get/Set Camera command value / list all values in JSON/plain
    label can be: light/framesize/quality/contrast/brightness/saturation/gainceiling/colorbar/awb/agc/aec/hmirror/vflip/awb_gain/agc_gain/aec_value/aec2/cw/bpc/wpc/raw_gma/lenc/special_effect/wb_mode/ae_level
    [ESP170]<label=value> json=<no> pwd=<admin password>

  • Save frame to target path and filename (default target = today date, default name=timestamp.jpg)
    [ESP171] <path=target path> <filename=target filename>

  • Get/Set Ftp state which can be ON, OFF, CLOSE
    [ESP180]<state> json=<no> pwd=<admin password>

  • Get/Set Ftp ports
    [ESP181]ctrl=<port> active=<port> passive=<port> json=<no> pwd=<admin password>

  • Get/Set WebDav state which can be ON, OFF, CLOSE
    [ESP190]<state> json=<no> pwd=<admin password>

  • Get/Set WebDav port
    [ESP191]<port> json=<no> pwd=<admin password>

  • Get/Set SD Card Status
    [ESP200]<RELEASE> <REFRESH> json=<no> pwd=<user/admin password>
    RELEASE will force the release of SD from ESP3D if SD is shared
    REFRESH will refresh the SD info is available`

  • Get/Set pin value
    [ESP201]P=<pin> V=<value> [PULLUP=YES RAW=YES ANALOG=NO ANALOG_RANGE=255]pwd=<admin password>

    • if no V= get P= value
    • if V= 0/1 set INPUT_PULLUP value, but for GPIO16(ESP8266) INPUT_PULLDOWN_16
    • if PULLUP=YES set input pull up (for GPIO16(ESP8266) INPUT_PULLDOWN_16), if not set input
    • if RAW=YES do not set pinmode just read value

    Note: Flash pins according chip cannot be used

  • Get/Set SD card Speed factor 1 2 4 6 8 16 32
    [ESP202]SPEED=<value> json=<no> pwd=<user/admin password>

  • Get Sensor Value / type/Set Sensor type
    [ESP210]<type=NONE/xxx> <interval=XXX in millisec> json=<no> pwd=<user/admin password>

  • Output to esp screen status
    [ESP214]<Text> json=<no> pwd=<user/admin password>

  • Touch Calibration [ESP215]<CALIBRATE> json=<no> pwd=<user password>

  • Show defined pins
    [ESP220]<SNAP> json=<no> pwd=<user password>

  • Play sound
    [ESP250]F=<frequency> D=<duration> json=<no> pwd=<user password>
    Note: No parameter just play beep

  • Delay command
    [ESP290]<delay in ms> json=<no>pwd=<user password>

  • Get full EEPROM settings content
    [ESP400] pwd=<admin password>
    Note: do not give any passwords

*Set EEPROM setting
position in EEPROM, type: B(byte), I(integer/long), S(string), A(IP address / mask)
[ESP401]P=<position> T=<type> V=<value> json=<no> pwd=<user/admin password>

        Description:        Positions:   
        ESP_RADIO_MODE          0       //1 byte = flag    
        ESP_STA_SSID            1       //33 bytes 32+1 = string  ; warning does not support multibyte char like chinese   
        ESP_STA_PASSWORD        34      //65 bytes 64 +1 = string ;warning does not support multibyte char like chinese   
        ESP_STA_IP_MODE         99      //1 byte = flag   
        ESP_STA_IP_VALUE        100     //4  bytes xxx.xxx.xxx.xxx   
        ESP_STA_MASK_VALUE      104     //4  bytes xxx.xxx.xxx.xxx   
        ESP_STA_GATEWAY_VALUE   108     //4  bytes xxx.xxx.xxx.xxx   
        ESP_BAUD_RATE           112     //4  bytes = int   
        ESP_NOTIFICATION_TYPE   116     //1 byte = flag   
        ESP_CALIBRATION         117     //1 byte = flag    
        ESP_AP_CHANNEL          118     //1 byte = flag   
        ESP_BUZZER              119     //1 byte = flag   
        ESP_INTERNET_TIME       120     //1  byte = flag   
        ESP_HTTP_PORT           121     //4  bytes = int   
        ESP_TELNET_PORT         125     //4  bytes = int   
        ESP_SERIAL_FLAG         129     //1  bytes = flag   
        ESP_HOSTNAME            130     //33 bytes 32+1 = string  ; warning does not support multibyte char like chinese   
        ESP_SENSOR_INTERVAL     164     //4  bytes = int   
        ESP_SETTINGS_VERSION    168     //8  bytes = 7+1 = string ESP3D + 2 digits   
        ESP_ADMIN_PWD           176     //21  bytes 20+1 = string  ; warning does not support multibyte char like chinese   
        ESP_USER_PWD            197     //21  bytes 20+1 = string  ; warning does not support multibyte char like chinese   
        ESP_AP_SSID             218     //33 bytes 32+1 = string  ; warning does not support multibyte char like chinese   
        ESP_AP_PASSWORD         251     //65 bytes 64 +1 = string ;warning does not support multibyte char like chinese   
        ESP_AP_IP_VALUE         316     //4  bytes xxx.xxx.xxx.xxx   
        ESP_BOOT_DELAY          320     //4  bytes = int   
        ESP_WEBSOCKET_PORT      324     //4  bytes= int   
        ESP_HTTP_ON             328     //1 byte = flag   
        ESP_TELNET_ON           329     //1 byte = flag   
        ESP_WEBSOCKET_ON        330     //1 byte = flag   
        ESP_SD_SPEED_DIV        331     //1 byte = flag   
        ESP_NOTIFICATION_TOKEN1 332     //64 bytes 63+1 = string  ; warning does not support multibyte char like chinese   
        ESP_NOTIFICATION_TOKEN2 396     //64 bytes 63+1 = string  ; warning does not support multibyte char like chinese    
        ESP_SENSOR_TYPE         460     //1  bytes = flag   
        ESP_TARGET_FW           461     //1  bytes = flag   
        ESP_TIMEZONE            462     //1  bytes = flag   
        ESP_TIME_IS_DST         463     //1  bytes = flag   
        ESP_TIME_SERVER1        464     //129 bytes 128+1 = string  ; warning does not support multibyte char like chinese   
        ESP_TIME_SERVER2        593     //129 bytes 128+1 = string  ; warning does not support multibyte char like chinese   
        ESP_TIME_SERVER3        722     //129 bytes 128+1 = string  ; warning does not support multibyte char like chinese   
        ESP_REMOTE_SCREEN       851     //1  bytes = flag   
        ESP_SD_MOUNT            852     //1  bytes = flag   
        ESP_SESSION_TIMEOUT     853     //1  bytes = flag   
        ESP_WEBSOCKET_FLAG      854     //1  bytes = flag   
        ESP_SD_CHECK_UPDATE_AT_BOOT 855//1  bytes = flag   
        ESP_NOTIFICATION_SETTINGS 856   //129 bytes 128+1 = string  ; warning does not support multibyte char like chinese    
        ESP_CALIBRATION_1       985     //4  bytes = int   
        ESP_CALIBRATION_2       989     //4  bytes = int   
        ESP_CALIBRATION_3       993     //4  bytes = int    
        ESP_CALIBRATION_4       997     //4  bytes = int   
        ESP_CALIBRATION_5       1001     //4  bytes = int   
        ESP_SETUP               1005    //1 byte = flag    
        ESP_TELNET_FLAG         1006    //1 byte = flag   
        ESP_BT_FLAG             1007    //1 byte = flag   
        ESP_SCREEEN_FLAG        1008    //1 byte = flag   
        ESP_FTP_CTRL_PORT       1009    //4  bytes = int   
        ESP_FTP_DATA_ACTIVE_PORT  1013    //4  bytes = int   
        ESP_FTP_DATA_PASSIVE_PORT 1017    //4  bytes = int   
        ESP_FTP_ON              1021     //1 byte = flag   
        ESP_AUTO_NOTIFICATION   1022    //1 byte = flag   
        ESP_VERBOSE_BOOT	    1023	//1 byte = flag   
        ESP_WEBDAV_ON           1024    //1 byte = flag   
        ESP_WEBDAV_PORT  	    1025	//4  bytes = int   
        ESP_STA_DNS_VALUE       1029    //4  bytes= int    
        ESP_SECURE_SERIAL       1033    //1 byte = flag   
        ESP_SERIAL_BRIDGE_ON    1036    //1 byte = flag
        ESP_SERIAL_BRIDGE_FLAG  1037    //1 byte = flag
        ESP_SERIAL_BRIDGE_BAUD  1038    //4  bytes= int

  • Get/Set Check update at boot state which can be ON, OFF
    [ESP402]<state> json=<no> pwd=<admin password>

  • Get available AP list (limited to 30)
    output is JSON or plain text according parameter
    [ESP410]json=<no> <pwd=admin/user>

  • Get current settings of ESP3D
    Output is JSON or plain text according parameter
    [ESP420]json=<no> <pwd=admin/user>

  • Set ESP State
    cmd can be RESTART to restart board or RESET to reset all setting to defaults values
    [ESP444]<cmd> json=<no> <pwd=admin>

  • Get available ESP3D list
    output is JSON or plain text according parameter
    [ESP450]json=<no> <pwd=admin/user>

  • Change admin password
    [ESP550]<password> json=<no> pwd=<admin password>

  • Change user password
    [ESP555]<password> json=<no> pwd=<admin/user password>

  • Send Notification
    [ESP600]msg json=<no> pwd=<admin/user password>

  • Set/Get Notification settings
    [ESP610]type=<NONE/PUSHOVER/EMAIL/LINE/IFTTT> T1=<token1> T2=<token2> TS=<Settings> json=<no> [pwd=<admin password>]
    Get will give type and settings only, not the protected T1/T2

  • Send Notification using URL
    [ESP620]URL=<encoded url> json=<no> pwd=<admin/user password>

  • Read / Stream / Process FS file
    [ESP700]<filename> json=<no> pwd=<admin/user password>

  • Query and Control ESP700 stream
    [ESP701]action=<PAUSE/RESUME/ABORT> json=<no> pwd=<admin/user password>

  • Format ESP Filesystem
    [ESP710]FORMATFS json=<no> pwd=<admin password>

  • Format SD Filesystem
    [ESP715]FORMATSD json=<no> pwd=<admin password>

  • List ESP Filesystem
    [ESP720]<Root> json=<no> pwd=<admin password>

  • Action on ESP Filesystem Action can be rmdir to remove empty directory / remove to delete file / mkdir to create directory / exists to check if file or directory exists / create create an empty file
    [ESP730]<Action>=<path> json=<no> pwd=<admin password>

  • List SD Filesystem
    [ESP740]<Root> json=<no> pwd=<admin password>

  • Action on SD Filesystem
    Action can be rmdir to remove empty directory / remove to delete file / mkdir to create directory / exists to check if file or directory exists / create create an empty file
    [ESP750]<Action>=<path> json=<no> pwd=<admin password>

  • List Global Filesystem
    [ESP780]<Root> json=<no> pwd=<admin password>

  • Action on Global Filesystem
    Action can be rmdir to remove empty directory / remove to delete file / mkdir to create directory / exists to check if file or directory exists / create create an empty file
    [ESP790]<Action>=<path> json=<no> pwd=<admin password>

  • FW Informations
    [ESP800]json=<no> pwd=<admin password>

  • Get state / Set Enable / Disable Serial Communication
    [ESP900]<ENABLE/DISABLE> json=<no> pwd=<admin/user password>

  • Get / Set Serial Baud Rate [ESP901]<BAUD RATE> json=<no> pwd=<admin/user password>

  • Get state / Set Enable / Disable buzzer
    [ESP910]<ENABLE/DISABLE> json=<no> pwd=<admin/user password>

  • Get state / Set state of output message clients
    [ESP920]<SERIAL / SCREEN / REMOTE_SCREEN/ WEBSOCKET / TELNET /BT / ALL>=<ON/OFF> json=<no> pwd=<admin/user password>

  • Get state / Set Enable / Disable Serial Bridge Communication
    [ESP930]<ENABLE/DISABLE> json=<no> pwd=<admin/user password>

  • Get / Set Serial Bridge Baud Rate [ESP931]<BAUD RATE> json=<no> pwd=<admin/user password>

  • Set quiet boot if strapping pin is High
    [ESP999]QUIETBOOT pwd=<admin/user password>