ESP3D/docs/Commands.txt
Luc b0375a3541 Upstream sync
Add Time Support (server  + manual setup), only used for ESP32 FS currently as ESP8266 SPIFFS does not support Time, need to wait for LittleFS may be ?
Add DHT support
Add Pin reset support
Add Base for Display
Add libraries for new supported features
Add /config handle as shortcut for [ESP420]plain to be used in embedded page
Code refactoring for defines, use less Define as switches but more define as values for switches
Clean warnings
Lot of small bug fixes
Add docs for [ESPXXX] commands
2019-03-09 09:16:08 +01:00

141 lines
5.1 KiB
Plaintext

Note:
1 - add space to separate parameters
2 - if parameter has space add \ in front of space to not be seen as separator
* Set/Get STA SSID
[ESP100]<SSID>pwd=<admin password>
* Set STA Password
[ESP101]<Password>pwd=<admin password>
* Set/Get STA IP mode (DHCP/STATIC)
[ESP102]<mode>pwd=<admin password>
* Set/Get STA IP/Mask/GW
[ESP103]IP=<IP> MSK=<IP> GW=<IP> pwd=<admin password>
* Set/Get AP SSID
[ESP105]<SSID>pwd=<admin password>
* Change AP Password
[ESP106]<Password>pwd=<admin password>
* Set/Get AP IP
[ESP107]<IP>pwd=<admin password>
* Set/Get AP channel
[ESP108]<channel>pwd=<admin password>
* Set/Get radio state which can be WIFI-STA, WIFI-AP, BT, ETH-STA, ETH-AP, OFF
[ESP110]<state>pwd=<admin password>
* Get current IP
[ESP111]<header answer>
* Get/Set hostname
[ESP112]<Hostname> pwd=<admin password>
* Get/Set immediate network(WiFi/BT/Ethernet) state which can be ON, OFF
[ESP115]<state>pwd=<admin password>
* Get/Set HTTP state which can be ON, OFF
[ESP120]<state>pwd=<admin password>
* Get/Set HTTP port
[ESP121]<port>pwd=<admin password>
* Get/Set Telnet state which can be ON, OFF
[ESP130]<state>pwd=<admin password>
* Get/Set Telnet port
[ESP131]<port>pwd=<admin password>
* Init / Get current time
[ESP140]<INIT> <srv1=XXXXX> <srv2=XXXXX> <srv3=XXXXX> <zone=xxx> <dst=YES/NO> <time=YYYY-MM-DD#H24:MM:SS> pwd=<admin password>
*Get/Set pin value
[ESP201]P<pin> V<value> [PULLUP=YES RAW=YES]pwd=<admin password>
if no V<value> get P<pin> value
if V<value> 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
Flash pins (6~11) cannot be used
* Get full EEPROM settings content
but do not give any passwords
[ESP400] pwd=<admin password>
*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> 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_STA_PHY_MODE 116 //1 byte = flag
ESP_SLEEP_MODE 117 //1 byte = flag
ESP_AP_CHANNEL 118 //1 byte = flag
ESP_AP_AUTH_TYPE 119 //1 byte = flag
ESP_SSID_VISIBLE 120 //1 byte = flag
ESP_HTTP_PORT 121 //4 bytes = int
ESP_TELNET_PORT 125 //4 bytes = int
ESP_OUTPUT_FLAG 129 //1 bytes = flag
ESP_HOSTNAME 130 //33 bytes 32+1 = string ; warning does not support multibyte char like chinese
ESP_DHT_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_HTTP_ON 328 //1 byte = flag
ESP_TELNET_ON 329 //1 byte = flag
ESP_AP_PHY_MODE 330 //1 byte = flag
ESP_SD_SPEED_DIV 331 //1 byte = flag
ESP_DHT_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_IS_DIRECT_SD 850//1 bytes = flag
ESP_PRIMARY_SD 851//1 bytes = flag
ESP_SECONDARY_SD 852//1 bytes = flag
ESP_DIRECT_SD_CHECK 853//1 bytes = flag
ESP_SD_CHECK_UPDATE_AT_BOOT 854//1 bytes = flag
*Get available AP list (limited to 30)
output is JSON or plain text according parameter
[ESP410]<plain><pwd=admin/user>
*Get current settings of ESP3D
output is plain text
[ESP420]<pwd=admin/user>
* Set ESP State
cmd are RESTART / RESET
[ESP444]<cmd><pwd=admin>
* Change admin password
[ESP550]<password>pwd=<admin password>
* Change user password
[ESP555]<password>pwd=<admin/user password>
* Format ESP Filesystem
[ESP710]FORMAT pwd=<admin password>
* List ESP Filesystem
[ESP720]<Root> pwd=<admin password>
* FW Informations
[ESP800]<plain> pwd=<admin password>