Skip to content

Commit 03ced55

Browse files
luc-githubluc-github
committed
Additionnal notes
1 parent ab56ad4 commit 03ced55

File tree

2 files changed

+330
-0
lines changed

2 files changed

+330
-0
lines changed

‎Memo/Commands.md‎

Lines changed: 308 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,308 @@
1+
# Direct ESP3D commands (V3.x)
2+
3+
## Conventions
4+
1 - add space to separate parameters
5+
2 - if parameter has space add \\ in front of space to not be seen as separator
6+
3 - json json=YES json=TRUE json=1 are paremeters to switch output to json
7+
By default output is plain text, to get json formated output
8+
add json or json=yes after main parameters
9+
The json format is {
10+
cmd:"<command id>", //the id of requested command
11+
status:"<ok/error>" //give if it is success or an failure
12+
data:"<response>" // response corresponding to answer in json format too
13+
}
14+
15+
## Commands
16+
* Show commands help
17+
`[ESP]<command id> json=<no>`
18+
19+
* Set/Get STA SSID
20+
`[ESP100]<SSID> json=<no> pwd=<admin password for set/get & user password to get>`
21+
22+
* Set STA Password
23+
`[ESP101]<Password> json=<no> pwd=<admin password>`
24+
25+
* Set/Get STA IP mode (DHCP/STATIC)
26+
`[ESP102]<mode> json=<no> pwd=<admin password>`
27+
28+
* Set/Get STA IP/Mask/GW/DNS
29+
`[ESP103]IP=<IP> MSK=<IP> GW=<IP> DNS=<IP> json=<no> pwd=<admin password>`
30+
31+
* Set/Get sta fallback mode which can be WIFI-AP, BT, OFF
32+
`[ESP104]<state> json=<no> pwd=<admin password>`
33+
34+
* Set/Get AP SSID
35+
`[ESP105]<SSID> json=<no> pwd=<admin password>`
36+
37+
* Change AP Password
38+
`[ESP106]<Password> json=<no> pwd=<admin password>`
39+
40+
* Set/Get AP IP
41+
`[ESP107]<IP> json=<no> pwd=<admin password>`
42+
43+
* Set/Get AP channel
44+
`[ESP108]<channel> json=<no> pwd=<admin password>`
45+
46+
* Set/Get radio state which can be WIFI-STA, WIFI-AP, BT, ETH-STA, ETH-AP, OFF
47+
`[ESP110]<state> json=<no> pwd=<admin password>`
48+
49+
* Get current IP
50+
`[ESP111]json=<no>`
51+
52+
* Get/Set hostname
53+
`[ESP112]<Hostname> json=<no> pwd=<admin password>`
54+
55+
* Get /Set Boot radio state which can be ON, OFF
56+
`[ESP114]<state> json=<no> pwd=<user/admin password>`
57+
58+
* Get/Set immediate network(WiFi/BT/Ethernet) state which can be ON, OFF
59+
`[ESP115]<state> json=<no> pwd=<admin password>`
60+
61+
* Get/Set HTTP state which can be ON, OFF
62+
`[ESP120]<state> json=<no> pwd=<admin password>`
63+
64+
* Get/Set HTTP port
65+
`[ESP121]<port> json=<no> pwd=<admin password>`
66+
67+
* Get/Set Telnet state which can be ON, OFF, CLOSE
68+
`[ESP130]<state> json=<no> pwd=<admin password>`
69+
70+
* Get/Set Telnet port
71+
`[ESP131]<port> json=<no> pwd=<admin password>`
72+
73+
* Sync / Set / Get current time
74+
`[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>`
75+
76+
* Get/Set display/set boot delay in ms / Verbose boot
77+
`[ESP150]<delay=time in milliseconds><verbose=ON/OFF>pwd=<admin password>`
78+
79+
* Get/Set WebSocket state which can be ON, OFF
80+
`[ESP160]<state> json=<no> pwd=<admin password>`
81+
82+
* Get/Set WebSocket port
83+
`[ESP161]<port> json=<no> pwd=<admin password>`
84+
85+
* Get/Set Camera command value / list all values in JSON/plain
86+
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
87+
`[ESP170]<label=value> json=<no> pwd=<admin password>`
88+
89+
* Save frame to target path and filename (default target = today date, default name=timestamp.jpg)
90+
`[ESP171] <path=target path> <filename=target filename>`
91+
92+
* Get/Set Ftp state which can be ON, OFF, CLOSE
93+
`[ESP180]<state> json=<no> pwd=<admin password>`
94+
95+
* Get/Set Ftp ports
96+
`[ESP181]ctrl=<port> active=<port> passive=<port> json=<no> pwd=<admin password>`
97+
98+
* Get/Set WebDav state which can be ON, OFF, CLOSE
99+
`[ESP190]<state> json=<no> pwd=<admin password>`
100+
101+
* Get/Set WebDav port
102+
`[ESP191]<port> json=<no> pwd=<admin password>`
103+
104+
* Get/Set SD Card Status
105+
`[ESP200]<RELEASE> <REFRESH> json=<no> pwd=<user/admin password>`
106+
`RELEASE` will force the release of SD from ESP3D if SD is shared
107+
`REFRESH` will refresh the SD info is available`
108+
109+
* Get/Set pin value
110+
`[ESP201]P=<pin> V=<value> [PULLUP=YES RAW=YES ANALOG=NO ANALOG_RANGE=255]pwd=<admin password>`
111+
- if no V=<value> get P=<pin> value
112+
- if V=<value> 0/1 set INPUT_PULLUP value, but for GPIO16(ESP8266) INPUT_PULLDOWN_16
113+
- if PULLUP=YES set input pull up (for GPIO16(ESP8266) INPUT_PULLDOWN_16), if not set input
114+
- if RAW=YES do not set pinmode just read value
115+
116+
Note: Flash pins according chip cannot be used
117+
118+
* Get/Set SD card Speed factor 1 2 4 6 8 16 32
119+
`[ESP202]SPEED=<value> json=<no> pwd=<user/admin password>`
120+
121+
* Get Sensor Value / type/Set Sensor type
122+
`[ESP210]<type=NONE/xxx> <interval=XXX in millisec> json=<no> pwd=<user/admin password>`
123+
124+
* Output to esp screen status
125+
`[ESP214]<Text> json=<no> pwd=<user/admin password>`
126+
127+
* Touch Calibration
128+
`[ESP215]<CALIBRATE> json=<no> pwd=<user password>`
129+
130+
* Show defined pins
131+
`[ESP220]<SNAP> json=<no> pwd=<user password>`
132+
133+
* Play sound
134+
`[ESP250]F=<frequency> D=<duration> json=<no> pwd=<user password>`
135+
Note: No parameter just play beep
136+
137+
* Delay command
138+
`[ESP290]<delay in ms> json=<no>pwd=<user password>`
139+
140+
* Get full EEPROM settings content
141+
`[ESP400] pwd=<admin password>`
142+
Note: do not give any passwords
143+
144+
*Set EEPROM setting
145+
position in EEPROM, type: B(byte), I(integer/long), S(string), A(IP address / mask)
146+
`[ESP401]P=<position> T=<type> V=<value> json=<no> pwd=<user/admin password>`
147+
```
148+
Description: Positions:
149+
ESP_RADIO_MODE 0 //1 byte = flag
150+
ESP_STA_SSID 1 //33 bytes 32+1 = string ; warning does not support multibyte char like chinese
151+
ESP_STA_PASSWORD 34 //65 bytes 64 +1 = string ;warning does not support multibyte char like chinese
152+
ESP_STA_IP_MODE 99 //1 byte = flag
153+
ESP_STA_IP_VALUE 100 //4 bytes xxx.xxx.xxx.xxx
154+
ESP_STA_MASK_VALUE 104 //4 bytes xxx.xxx.xxx.xxx
155+
ESP_STA_GATEWAY_VALUE 108 //4 bytes xxx.xxx.xxx.xxx
156+
ESP_BAUD_RATE 112 //4 bytes = int
157+
ESP_NOTIFICATION_TYPE 116 //1 byte = flag
158+
ESP_CALIBRATION 117 //1 byte = flag
159+
ESP_AP_CHANNEL 118 //1 byte = flag
160+
ESP_BUZZER 119 //1 byte = flag
161+
ESP_INTERNET_TIME 120 //1 byte = flag
162+
ESP_HTTP_PORT 121 //4 bytes = int
163+
ESP_TELNET_PORT 125 //4 bytes = int
164+
ESP_SERIAL_FLAG 129 //1 bytes = flag
165+
ESP_HOSTNAME 130 //33 bytes 32+1 = string ; warning does not support multibyte char like chinese
166+
ESP_SENSOR_INTERVAL 164 //4 bytes = int
167+
ESP_SETTINGS_VERSION 168 //8 bytes = 7+1 = string ESP3D + 2 digits
168+
ESP_ADMIN_PWD 176 //21 bytes 20+1 = string ; warning does not support multibyte char like chinese
169+
ESP_USER_PWD 197 //21 bytes 20+1 = string ; warning does not support multibyte char like chinese
170+
ESP_AP_SSID 218 //33 bytes 32+1 = string ; warning does not support multibyte char like chinese
171+
ESP_AP_PASSWORD 251 //65 bytes 64 +1 = string ;warning does not support multibyte char like chinese
172+
ESP_AP_IP_VALUE 316 //4 bytes xxx.xxx.xxx.xxx
173+
ESP_BOOT_DELAY 320 //4 bytes = int
174+
ESP_WEBSOCKET_PORT 324 //4 bytes= int
175+
ESP_HTTP_ON 328 //1 byte = flag
176+
ESP_TELNET_ON 329 //1 byte = flag
177+
ESP_WEBSOCKET_ON 330 //1 byte = flag
178+
ESP_SD_SPEED_DIV 331 //1 byte = flag
179+
ESP_NOTIFICATION_TOKEN1 332 //64 bytes 63+1 = string ; warning does not support multibyte char like chinese
180+
ESP_NOTIFICATION_TOKEN2 396 //64 bytes 63+1 = string ; warning does not support multibyte char like chinese
181+
ESP_SENSOR_TYPE 460 //1 bytes = flag
182+
ESP_TARGET_FW 461 //1 bytes = flag
183+
ESP_TIMEZONE 462 //1 bytes = flag
184+
ESP_TIME_IS_DST 463 //1 bytes = flag
185+
ESP_TIME_SERVER1 464 //129 bytes 128+1 = string ; warning does not support multibyte char like chinese
186+
ESP_TIME_SERVER2 593 //129 bytes 128+1 = string ; warning does not support multibyte char like chinese
187+
ESP_TIME_SERVER3 722 //129 bytes 128+1 = string ; warning does not support multibyte char like chinese
188+
ESP_REMOTE_SCREEN 851 //1 bytes = flag
189+
ESP_SD_MOUNT 852 //1 bytes = flag
190+
ESP_SESSION_TIMEOUT 853 //1 bytes = flag
191+
ESP_WEBSOCKET_FLAG 854 //1 bytes = flag
192+
ESP_SD_CHECK_UPDATE_AT_BOOT 855//1 bytes = flag
193+
ESP_NOTIFICATION_SETTINGS 856 //129 bytes 128+1 = string ; warning does not support multibyte char like chinese
194+
ESP_CALIBRATION_1 985 //4 bytes = int
195+
ESP_CALIBRATION_2 989 //4 bytes = int
196+
ESP_CALIBRATION_3 993 //4 bytes = int
197+
ESP_CALIBRATION_4 997 //4 bytes = int
198+
ESP_CALIBRATION_5 1001 //4 bytes = int
199+
ESP_SETUP 1005 //1 byte = flag
200+
ESP_TELNET_FLAG 1006 //1 byte = flag
201+
ESP_BT_FLAG 1007 //1 byte = flag
202+
ESP_SCREEEN_FLAG 1008 //1 byte = flag
203+
ESP_FTP_CTRL_PORT 1009 //4 bytes = int
204+
ESP_FTP_DATA_ACTIVE_PORT 1013 //4 bytes = int
205+
ESP_FTP_DATA_PASSIVE_PORT 1017 //4 bytes = int
206+
ESP_FTP_ON 1021 //1 byte = flag
207+
ESP_AUTO_NOTIFICATION 1022 //1 byte = flag
208+
ESP_VERBOSE_BOOT 1023 //1 byte = flag
209+
ESP_WEBDAV_ON 1024 //1 byte = flag
210+
ESP_WEBDAV_PORT 1025 //4 bytes = int
211+
ESP_STA_DNS_VALUE 1029 //4 bytes= int
212+
ESP_SECURE_SERIAL 1033 //1 byte = flag
213+
ESP_SERIAL_BRIDGE_ON 1036 //1 byte = flag
214+
ESP_SERIAL_BRIDGE_FLAG 1037 //1 byte = flag
215+
ESP_SERIAL_BRIDGE_BAUD 1038 //4 bytes= int
216+
```
217+
218+
* Get/Set Check update at boot state which can be ON, OFF
219+
`[ESP402]<state> json=<no> pwd=<admin password>`
220+
221+
* Get available AP list (limited to 30)
222+
output is JSON or plain text according parameter
223+
`[ESP410]json=<no> <pwd=admin/user>`
224+
225+
* Get current settings of ESP3D
226+
Output is JSON or plain text according parameter
227+
`[ESP420]json=<no> <pwd=admin/user>`
228+
229+
* Set ESP State
230+
`cmd` can be `RESTART` to restart board or `RESET` to reset all setting to defaults values
231+
`[ESP444]<cmd> json=<no> <pwd=admin>`
232+
233+
* Get available ESP3D list
234+
output is JSON or plain text according parameter
235+
`[ESP450]json=<no> <pwd=admin/user>`
236+
237+
* Change admin password
238+
`[ESP550]<password> json=<no> pwd=<admin password>`
239+
240+
* Change user password
241+
`[ESP555]<password> json=<no> pwd=<admin/user password>`
242+
243+
* Send Notification
244+
`[ESP600]msg json=<no> pwd=<admin/user password>`
245+
246+
* Set/Get Notification settings
247+
`[ESP610]type=<NONE/PUSHOVER/EMAIL/LINE/IFTTT> T1=<token1> T2=<token2> TS=<Settings> json=<no> [pwd=<admin password>]`
248+
Get will give type and settings only, not the protected T1/T2
249+
250+
* Send Notification using URL
251+
`[ESP620]URL=<encoded url> json=<no> pwd=<admin/user password>`
252+
253+
* Read / Stream / Process FS file
254+
`[ESP700]<filename> json=<no> pwd=<admin/user password>`
255+
256+
* Query and Control ESP700 stream
257+
`[ESP701]action=<PAUSE/RESUME/ABORT> json=<no> pwd=<admin/user password>`
258+
259+
* Format ESP Filesystem
260+
`[ESP710]FORMATFS json=<no> pwd=<admin password>`
261+
262+
* Format SD Filesystem
263+
`[ESP715]FORMATSD json=<no> pwd=<admin password>`
264+
265+
* List ESP Filesystem
266+
`[ESP720]<Root> json=<no> pwd=<admin password>`
267+
268+
* Action on ESP Filesystem
269+
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
270+
`[ESP730]<Action>=<path> json=<no> pwd=<admin password>`
271+
272+
* List SD Filesystem
273+
`[ESP740]<Root> json=<no> pwd=<admin password>`
274+
275+
* Action on SD Filesystem
276+
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
277+
`[ESP750]<Action>=<path> json=<no> pwd=<admin password>`
278+
279+
* List Global Filesystem
280+
`[ESP780]<Root> json=<no> pwd=<admin password>`
281+
282+
* Action on Global Filesystem
283+
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
284+
`[ESP790]<Action>=<path> json=<no> pwd=<admin password>`
285+
286+
* FW Informations
287+
`[ESP800]json=<no> pwd=<admin password>`
288+
289+
* Get state / Set Enable / Disable Serial Communication
290+
`[ESP900]<ENABLE/DISABLE> json=<no> pwd=<admin/user password>`
291+
292+
* Get / Set Serial Baud Rate
293+
`[ESP901]<BAUD RATE> json=<no> pwd=<admin/user password>`
294+
295+
* Get state / Set Enable / Disable buzzer
296+
`[ESP910]<ENABLE/DISABLE> json=<no> pwd=<admin/user password>`
297+
298+
* Get state / Set state of output message clients
299+
`[ESP920]<SERIAL / SCREEN / REMOTE_SCREEN/ WEBSOCKET / TELNET /BT / ALL>=<ON/OFF> json=<no> pwd=<admin/user password>`
300+
301+
* Get state / Set Enable / Disable Serial Bridge Communication
302+
`[ESP930]<ENABLE/DISABLE> json=<no> pwd=<admin/user password>`
303+
* Get / Set Serial Bridge Baud Rate
304+
`[ESP931]<BAUD RATE> json=<no> pwd=<admin/user password>`
305+
306+
307+
* Set quiet boot if strapping pin is High
308+
`[ESP999]QUIETBOOT pwd=<admin/user password>`

‎Memo/ESP3D [ESP401] format.md‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
# ESP3D [ESP401] format
2+
3+
WebUI need use json format to get propelry formated answer
4+
As described in Commands.md:
5+
6+
## Conventions
7+
8+
1 - add space to separate parameters
9+
2 - if parameter has space add \\ in front of space to not be seen as separator
10+
3 - json json=YES json=TRUE json=1 are paremeters to switch output to json
11+
By default output is plain text, to get json formated output
12+
add json or json=yes after main parameters
13+
The json format is {
14+
cmd:"<401>", //the id of requested command
15+
status:"<ok/error>" //give if it is success or an failure
16+
data:"the position of setting"
17+
}
18+
19+
Example
20+
`[ESP401]P=1 T=S V=My\ SSID json`
21+
you will get the following if ok
22+
`{"cmd":"401","status":"ok","data":"1"}`

0 commit comments

Comments
 (0)