# 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 ```json { cmd:"", //the id of requested command status:"" //give if it is success or an failure data:"" // response corresponding to answer in json format too } ``` ## Commands * Show commands help `[ESP] json=` * Set/Get STA SSID `[ESP100] json= pwd=` * Set STA Password `[ESP101] json= pwd=` * Set/Get STA IP mode (DHCP/STATIC) `[ESP102] json= pwd=` * Set/Get STA IP/Mask/GW/DNS `[ESP103]IP= MSK= GW= DNS= json= pwd=` * Set/Get sta fallback mode which can be WIFI-AP, BT, OFF `[ESP104] json= pwd=` * Set/Get AP SSID `[ESP105] json= pwd=` * Change AP Password `[ESP106] json= pwd=` * Set/Get AP IP `[ESP107] json= pwd=` * Set/Get AP channel `[ESP108] json= pwd=` * Set/Get radio state which can be WIFI-STA, WIFI-AP, BT, ETH-STA, ETH-AP, OFF `[ESP110] json= pwd=` * Get current IP `[ESP111]json=` * Get/Set hostname `[ESP112] json= pwd=` * Get /Set Boot radio state which can be ON, OFF `[ESP114] json= pwd=` * Get/Set immediate network(WiFi/BT/Ethernet) state which can be ON, OFF `[ESP115] json= pwd=` * Get/Set HTTP state which can be ON, OFF `[ESP120] json= pwd=` * Get/Set HTTP port `[ESP121] json= pwd=` * Get/Set Telnet state which can be ON, OFF, CLOSE `[ESP130] json= pwd=` * Get/Set Telnet port `[ESP131] json= pwd=` * Sync / Set / Get current time `[ESP140] json= pwd=` * Get/Set display/set boot delay in ms / Verbose boot `[ESP150]pwd=` * Get/Set WebSocket state which can be ON, OFF `[ESP160] json= pwd=` * Get/Set WebSocket port `[ESP161] json= pwd=` * 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] json= pwd=` * Save frame to target path and filename (default target = today date, default name=timestamp.jpg) `[ESP171] ` * Get/Set Ftp state which can be ON, OFF, CLOSE `[ESP180] json= pwd=` * Get/Set Ftp ports `[ESP181]ctrl= active= passive= json= pwd=` * Get/Set WebDav state which can be ON, OFF, CLOSE `[ESP190] json= pwd=` * Get/Set WebDav port `[ESP191] json= pwd=` * Get/Set SD Card Status `[ESP200] json= pwd=` `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= V= [PULLUP=YES RAW=YES ANALOG=NO ANALOG_RANGE=255]pwd=` - 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= json= pwd=` * Get Sensor Value / type/Set Sensor type `[ESP210] json= pwd=` * Output to printer screen status `[ESP212] json= pwd=` * Output to esp screen status `[ESP214] json= pwd=` * Touch Calibration `[ESP215] json= pwd=` * Get ESP pins definition `[ESP220]json= pwd=` * Play sound `[ESP250]F= D= json= pwd=` Note: No parameter just play beep * Delay command `[ESP290] json=pwd=` * Get full EEPROM settings content `[ESP400] pwd=` 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= T= V= json= pwd=` ``` 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 FREE 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 //251 bytes 250+1 = string ; warning does not support multibyte char like chinese ESP_NOTIFICATION_TOKEN2 583 //64 bytes 63+1 = string ; warning does not support multibyte char like chinese ESP_SENSOR_TYPE 647 //1 bytes = flag ESP_TARGET_FW 648 //1 bytes = flag FREE 649 //1 bytes = flag FREE 650 //1 bytes = flag ESP_TIME_SERVER1 651 //129 bytes 128+1 = string ; warning does not support multibyte char like chinese ESP_TIME_SERVER2 780 //129 bytes 128+1 = string ; warning does not support multibyte char like chinese ESP_TIME_SERVER3 909 //129 bytes 128+1 = string ; warning does not support multibyte char like chinese ESP_REMOTE_SCREEN 1038 //1 bytes = flag ESP_SD_MOUNT 1039 //1 bytes = flag ESP_SESSION_TIMEOUT 1040 //1 bytes = flag FREE FLAG 1041 //1 bytes = flag ESP_SD_CHECK_UPDATE_AT_BOOT 1042//1 bytes = flag ESP_NOTIFICATION_SETTINGS 1043 //129 bytes 128+1 = string ; warning does not support multibyte char like chinese ESP_CALIBRATION_1 1172 //4 bytes = int ESP_CALIBRATION_2 1176 //4 bytes = int ESP_CALIBRATION_3 1180 //4 bytes = int ESP_CALIBRATION_4 1184 //4 bytes = int ESP_CALIBRATION_5 1188 //4 bytes = int ESP_SETUP 1192 //1 byte = flag FREE 1193 //1 byte = flag FREE 1194 //1 byte = flag FREE 1195 //1 byte = flag ESP_FTP_CTRL_PORT 1196 //4 bytes = int ESP_FTP_DATA_ACTIVE_PORT 1200 //4 bytes = int ESP_FTP_DATA_PASSIVE_PORT 1204 //4 bytes = int ESP_FTP_ON 1208 //1 byte = flag ESP_AUTO_NOTIFICATION 1209 //1 byte = flag ESP_VERBOSE_BOOT 1210 //1 byte = flag ESP_WEBDAV_ON 1211 //1 byte = flag ESP_WEBDAV_PORT 1212 //4 bytes = int ESP_STA_DNS_VALUE 1216 //4 bytes= int ESP_SECURE_SERIAL 1220 //1 byte = flag ESP_SERIAL_BRIDGE_ON 1223 //1 byte = flag FREE 1224 //1 byte = flag ESP_SERIAL_BRIDGE_BAUD 1225 //4 bytes= int ESP_TIME_ZONE 1229 //7 bytes= string ``` * Get/Set Check update at boot state which can be ON, OFF `[ESP402] json= pwd=` * Get available AP list (limited to 30) output is JSON or plain text according parameter `[ESP410]json= ` * Get current settings of ESP3D Output is JSON or plain text according parameter `[ESP420]json= ` * Set ESP State `cmd` can be `RESTART` to restart board or `RESET` to reset all setting to defaults values `[ESP444] json= ` * Get available ESP3D list output is JSON or plain text according parameter `[ESP450]json= ` * Get authentication level `[ESP500] json=` * Get/Set session timeout `[ESP510] json= pwd=` * Change admin password `[ESP550] json= pwd=` * Change user password `[ESP555] json= pwd=` * Send Notification `[ESP600]msg json= pwd=` * Set/Get Notification settings `[ESP610]type= T1= T2= TS= json= [pwd=]` Get will give type and settings only, not the protected T1/T2 * Send Notification using URL `[ESP620]URL= json= pwd=` * Read / Stream / Process FS file `[ESP700] json= pwd=` * Query and Control ESP700 stream `[ESP701]action= json= pwd=` * Format ESP Filesystem `[ESP710]FORMATFS json= pwd=` * Format SD Filesystem `[ESP715]FORMATSD json= pwd=` * List ESP Filesystem `[ESP720] json= pwd=` * 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]= json= pwd=` * List SD Filesystem `[ESP740] json= pwd=` * 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]= json= pwd=` * List Global Filesystem `[ESP780] json= pwd=` * 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]= json= pwd=` * FW Informations `[ESP800]json= pwd= ` * Get state / Set Enable / Disable Serial Communication `[ESP900] json= pwd=` * Get / Set Serial Baud Rate `[ESP901] json= pwd=` * Get state / Set Enable / Disable buzzer `[ESP910] json= pwd=` * Get state / Set Enable / Disable Serial Bridge Communication `[ESP930] json= pwd=` * Get / Set Serial Bridge Baud Rate `[ESP931] json= pwd=` * Set quiet boot if strapping pin is High `[ESP999]QUIETBOOT pwd=`