more wiki update (#779)

* update D1-mini HW

* rename file

* general wiki update

* delete 3.0 commands fro 2.x branch, transform commands to md files

* WIP command 2.0

* update commandline.md

* remove v3 commandline

* v2.1
This commit is contained in:
Julien Staub 2022-09-04 05:32:34 +02:00 committed by GitHub
parent d2a83d95e3
commit dacd1e0a70
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
13 changed files with 361 additions and 604 deletions

View File

@ -70,7 +70,7 @@ if Authentication is enabled :
## Direct commands:
Check wiki : https://github.com/luc-github/ESP3D/wiki/Direct-ESP3D-commands
Check wiki : https://github.com/luc-github/ESP3D/wiki/Command-line-commands
## Installation instructions
See [Wiki](https://github.com/luc-github/ESP3D/wiki/Install-Instructions)

155
wiki/Command-line-2_0.md Normal file
View File

@ -0,0 +1,155 @@
# Command line commands for 2.0
## Format
Please note all commands are in format `[ESPxx]`. These first brackets `[]` are not optional.
Most of the time givin no argument will return current configuration
If authentication is on, somme commands will need admin password. They are recognised by the optional argument `[pwd=<admin password>]` in command line.
## Deviations from standard command line
Based on command line format from <http://docopt.org/>.
* `[ESPxxx]` the brackets are part of the command here and do not mean "optional argument"
* ALL commands with `=` should be using long arg format `--arg=<val>` for example `[pwd=<admin password>]` should be `[--pwd=<admin password>]`
## Commands
### Get/change STA SSID
`[ESP100] [<SSID>] [pwd=<admin password>]`
### Change STA Password
`[ESP101] <Password> [pwd=<admin password>]`
### Get/change Hostname
`[ESP102] [<hostname>] [pwd=<admin password>]`
### Get/change Wifi mode (STA/AP)
`[ESP103] [STA | AP] [pwd=<admin password>]`
### Get/change STA IP mode (DHCP/STATIC)
`[ESP104] [DHCP | STATIC] [pwd=<admin password>]`
### Get/change AP SSID
`[ESP105] [<SSID>] [pwd=<admin password>]`
### Change AP Password
`[ESP106] <Password> [pwd=<admin password>]`
### Get/change AP IP mode (DHCP/STATIC)
`[ESP107] [DHCP | STATIC] [pwd=<admin password>]`
### Get/change wifi state (on/off)
`[ESP110] [ON | OFF | RESTART] [pwd=<admin password>]`
### Get current IP
`[ESP111]`
### Get/Change hostname
`[ESP112] [<hostname>]`
### Get/Set pin value
`[ESP201] P<pin> [V<value> PULLUP=YES RAW=YES ANALOG=NO ANALOG_RANGE=255 CLEARCHANNELS=NO pwd=<admin password>]`
if no V<value> get P<pin> value
if V<value> 0/1 set INPUT_PULLUP value, but for GPIO16 INPUT_PULLDOWN_16
GPIO1 and GPIO3 cannot be used as they are used for serial
if PULLUP=YES set input pull up, if not set input
if RAW=YES do not set pinmode just read value
### Output to oled column C and line L
`[ESP210] C=<col> L=<line> T=<Text>`
### Output to oled line 1
`[ESP211] <Text>`
### Output to oled line 2
`[ESP212] <Text>`
### Output to oled line 3
`[ESP213] <Text>`
### Output to oled line 4
`[ESP214] <Text>`
### Get full EEPROM settings content
but do not give any passwords
can filter if only need wifi or printer
`[ESP400] <network/printer>`
### Set EEPROM setting
`[ESP401] P=<position> T={B | I | S | A} V=<value> [pwd=<user/admin password>]`
`T` type: B(byte), I(integer/long), S(string), A(IP address / mask)
`P` position: address in EEPROM
* `EP_WIFI_MODE 0 //1 byte = flag`
* `EP_STA_SSID 1 //33 bytes 32+1 = string ; warning does not support multibyte char like chinese`
* `EP_STA_PASSWORD 34 //65 bytes 64 +1 = string ;warning does not support multibyte char like chinese`
* `EP_STA_IP_MODE 99 //1 byte = flag`
* `EP_STA_IP_VALUE 100 //4 bytes xxx.xxx.xxx.xxx`
* `EP_STA_MASK_VALUE 104 //4 bytes xxx.xxx.xxx.xxx`
* `EP_STA_GATEWAY_VALUE 108 //4 bytes xxx.xxx.xxx.xxx`
* `EP_BAUD_RATE 112 //4 bytes = int`
* `EP_STA_PHY_MODE 116 //1 byte = flag`
* `EP_SLEEP_MODE 117 //1 byte = flag`
* `EP_CHANNEL 118 //1 byte = flag`
* `EP_AUTH_TYPE 119 //1 byte = flag`
* `EP_SSID_VISIBLE 120 //1 byte = flag`
* `EP_WEB_PORT 121 //4 bytes = int`
* `EP_DATA_PORT 125 //4 bytes = int`
* `EP_OUTPUT_FLAG 129 //1 bytes = flag`
* `EP_HOSTNAME 130 //33 bytes 32+1 = string ; warning does not support multibyte char like chinese`
* `EP_DHT_INTERVAL 164 //4 bytes = int`
* `EP_FREE_INT2 168 //4 bytes = int`
* `EP_FREE_INT3 172 //4 bytes = int`
* `EP_ADMIN_PWD 176 //21 bytes 20+1 = string ; warning does not support multibyte char like chinese`
* `EP_USER_PWD 197 //21 bytes 20+1 = string ; warning does not support multibyte char like chinese`
* `EP_AP_SSID 218 //33 bytes 32+1 = string ; warning does not support multibyte char like chinese`
* `EP_AP_PASSWORD 251 //65 bytes 64 +1 = string ;warning does not support multibyte char like chinese`
* `EP_AP_IP_VALUE 316 //4 bytes xxx.xxx.xxx.xxx`
* `EP_AP_MASK_VALUE 320 //4 bytes xxx.xxx.xxx.xxx`
* `EP_AP_GATEWAY_VALUE 324 //4 bytes xxx.xxx.xxx.xxx`
* `EP_AP_IP_MODE 329 //1 byte = flag`
* `EP_AP_PHY_MODE 330 //1 byte = flag`
* `EP_FREE_STRING1 331 //129 bytes 128+1 = string ; warning does not support multibyte char like chinese`
* `EP_DHT_TYPE 460 //1 bytes = flag`
* `EP_TARGET_FW 461 //1 bytes = flag`
### Get available AP list (limited to 30)
`[ESP410] [plain]`
Output is JSON or plain text according parameter
### Get current settings of ESP3D
`[ESP420] [plain]`
Output is JSON or plain text according parameter
### Get/Set ESP mode
`[ESP444] [RESET | SAFEMODE | CONFIG | RESTART] [pwd=<admin password>]`
if authentication is on, need admin password for RESET, RESTART and SAFEMODE
### Change / Reset user password
`[ESP555] [<password>] [pwd=<admin password>]`
If no password set it use default one
### Send GCode with check sum caching right line numbering
`[ESP600] <gcode>`
### Send line checksum
`[ESP601] <line>`
### Read SPIFFS file and send each line to serial
`[ESP700] <filename>`
### Format SPIFFS
`[ESP710] FORMAT [pwd=<admin password>]`
### Get SPIFFS total size and used size
`[ESP720]`
### Get fw version and basic information
`[ESP800]`
### Get fw target
`[ESP801]`
### Check SD presence
`[ESP802]`

168
wiki/Command-line-2_1.md Normal file
View File

@ -0,0 +1,168 @@
# Command line commands for 2.1
## Format
Please note all commands are in format `[ESPxx]`. These first brackets `[]` are not optional.
Most of the time givin no argument will return current configuration
If authentication is on, somme commands will need admin password. They are recognised by the optional argument `[pwd=<admin password>]` in command line.
## Deviations from standard command line
Based on command line format from <http://docopt.org/>.
* `[ESPxxx]` the brackets are part of the command here and do not mean "optional argument"
* ALL commands with `=` should be using long arg format `--arg=<val>` for example `[pwd=<admin password>]` should be `[--pwd=<admin password>]`
## Commands
### Get/change STA SSID
`[ESP100] [<SSID>] [pwd=<admin password>]`
### Change STA Password
`[ESP101] <Password> [pwd=<admin password>]`
### Get/change Hostname
`[ESP102] [<hostname>] [pwd=<admin password>]`
### Get/change Wifi mode (STA/AP)
`[ESP103] [STA | AP] [pwd=<admin password>]`
### Get/change STA IP mode (DHCP/STATIC)
`[ESP104] [DHCP | STATIC] [pwd=<admin password>]`
### Get/change AP SSID
`[ESP105] [<SSID>] [pwd=<admin password>]`
### Change AP Password
`[ESP106] <Password> [pwd=<admin password>]`
### Get/change AP IP mode (DHCP/STATIC)
`[ESP107] [DHCP | STATIC] [pwd=<admin password>]`
### Get/change wifi state (on/off)
`[ESP110] [ON | OFF | RESTART] [pwd=<admin password>]`
### Get current IP
`[ESP111]`
### Get/Change hostname
`[ESP112] [<hostname>]`
### Get/Set pin value
`[ESP201] P<pin> [V<value> PULLUP=YES RAW=YES ANALOG=NO ANALOG_RANGE=255 CLEARCHANNELS=NO pwd=<admin password>]`
if no V<value> get P<pin> value
if V<value> 0/1 set INPUT_PULLUP value, but for GPIO16 INPUT_PULLDOWN_16
GPIO1 and GPIO3 cannot be used as they are used for serial
if PULLUP=YES set input pull up, if not set input
if RAW=YES do not set pinmode just read value
### Output to oled column C and line L
`[ESP210] C=<col> L=<line> T=<Text>`
### Output to oled line 1
`[ESP211] <Text>`
### Output to oled line 2
`[ESP212] <Text>`
### Output to oled line 3
`[ESP213] <Text>`
### Output to oled line 4
`[ESP214] <Text>`
### Delay
`[ESP290] <delayMs> [pwd=<admin password>]`
### Get EEPROM mapping version
`[ESP300]`
### Get full EEPROM settings content
but do not give any passwords
can filter if only need wifi or printer
`[ESP400] <network/printer>`
### Set EEPROM setting
`[ESP401] P=<position> T={B | I | S | A} V=<value> [pwd=<user/admin password>]`
`T` type: B(byte), I(integer/long), S(string), A(IP address / mask)
`P` position: address in EEPROM
* `EP_WIFI_MODE 0 //1 byte = flag`
* `EP_STA_SSID 1 //33 bytes 32+1 = string ; warning does not support multibyte char like chinese`
* `EP_STA_PASSWORD 34 //65 bytes 64 +1 = string ;warning does not support multibyte char like chinese`
* `EP_STA_IP_MODE 99 //1 byte = flag`
* `EP_STA_IP_VALUE 100 //4 bytes xxx.xxx.xxx.xxx`
* `EP_STA_MASK_VALUE 104 //4 bytes xxx.xxx.xxx.xxx`
* `EP_STA_GATEWAY_VALUE 108 //4 bytes xxx.xxx.xxx.xxx`
* `EP_BAUD_RATE 112 //4 bytes = int`
* `EP_STA_PHY_MODE 116 //1 byte = flag`
* `EP_SLEEP_MODE 117 //1 byte = flag`
* `EP_CHANNEL 118 //1 byte = flag`
* `EP_AUTH_TYPE 119 //1 byte = flag`
* `EP_SSID_VISIBLE 120 //1 byte = flag`
* `EP_WEB_PORT 121 //4 bytes = int`
* `EP_DATA_PORT 125 //4 bytes = int`
* `EP_OUTPUT_FLAG 129 //1 bytes = flag`
* `EP_HOSTNAME 130 //33 bytes 32+1 = string ; warning does not support multibyte char like chinese`
* `EP_DHT_INTERVAL 164 //4 bytes = int`
* `EP_FREE_INT2 168 //4 bytes = int`
* `EP_FREE_INT3 172 //4 bytes = int`
* `EP_ADMIN_PWD 176 //21 bytes 20+1 = string ; warning does not support multibyte char like chinese`
* `EP_USER_PWD 197 //21 bytes 20+1 = string ; warning does not support multibyte char like chinese`
* `EP_AP_SSID 218 //33 bytes 32+1 = string ; warning does not support multibyte char like chinese`
* `EP_AP_PASSWORD 251 //65 bytes 64 +1 = string ;warning does not support multibyte char like chinese`
* `EP_AP_IP_VALUE 316 //4 bytes xxx.xxx.xxx.xxx`
* `EP_AP_MASK_VALUE 320 //4 bytes xxx.xxx.xxx.xxx`
* `EP_AP_GATEWAY_VALUE 324 //4 bytes xxx.xxx.xxx.xxx`
* `EP_AP_IP_MODE 329 //1 byte = flag`
* `EP_AP_PHY_MODE 330 //1 byte = flag`
* `EP_FREE_STRING1 331 //129 bytes 128+1 = string ; warning does not support multibyte char like chinese`
* `EP_DHT_TYPE 460 //1 bytes = flag`
* `EP_TARGET_FW 461 //1 bytes = flag`
### Get available AP list (limited to 30)
`[ESP410] [plain]`
Output is JSON or plain text according parameter
### Get current settings of ESP3D
`[ESP420] [plain]`
Output is JSON or plain text according parameter
### Get/Set ESP mode
`[ESP444] [RESET | SAFEMODE | CONFIG | RESTART] [pwd=<admin password>]`
if authentication is on, need admin password for RESET, RESTART and SAFEMODE
### Send GCode with check sum caching right line numbering
`[ESP500] <gcode>`
### Send line checksum
`[ESP501] <line>`
### Change / Reset user password
`[ESP555] [<password>] [pwd=<admin password>]`
If no password set it use default one
### Send notification
`[ESP600] <message> [pwd=<admin password>]`
### Set/Get notification settings
`[ESP610] type={NONE | PUSHOVER | EMAIL | LINE} T1=<token1> T2=<token2> TS=<Settings> [pwd=<admin password>]`
Get will give type and settings only not the protected T1/T2
### Read SPIFFS file and send each line to serial
`[ESP700] <filename>`
### Format SPIFFS
`[ESP710] FORMAT [pwd=<admin password>]`
### Get SPIFFS total size and used size
`[ESP720]`
### Get fw version and basic information
`[ESP800]`
### Get fw target
`[ESP801]`
### Get state / Set Enable / Disable Serial Communication
`[ESP900] <{ENABLE | DISABLE}>`

View File

@ -0,0 +1,5 @@
# Command line commands
* [v2.0.x](https://github.com/luc-github/ESP3D/wiki/Command-line-2_0)
* [v2.1.x](https://github.com/luc-github/ESP3D/wiki/Command-line-2_1)
* v3.0.x : work in progress

View File

@ -1,28 +0,0 @@
# D1 mini
Two Methods for connecting the Wemos d1 mini
---
## connection Wemos d1 mini and Logic Level Converter:
connection:
![level converter wireing](https://github.com/jayjojayson/ESP3D/blob/2.1/images/D1_mini/wemos-d1-mini_logic-level-converter.jpg)
example:
![end result](https://github.com/jayjojayson/ESP3D/blob/2.1/images/D1_mini/wemos-d1-mini_logic-level-converter-2.jpg)
printed case:<https://www.thingiverse.com/thing:4128593>
---
## connection Wemos d1 mini and Diode
connection:
![diode wireing diagram](https://raw.githubusercontent.com/wiki/luc-github/ESP3D/images/D1_mini/FB_IMG_1510306696875.jpg)
example:
![end result](https://raw.githubusercontent.com/wiki/luc-github/ESP3D/images/D1_mini/20171111_215253.jpg)
printed case:
<https://www.thingiverse.com/thing:2671591>

View File

@ -1,5 +0,0 @@
# Direct commands
* [v2.0](https://raw.githubusercontent.com/wiki/luc-github/ESP3D/docs/Commands2_0.txt)
* [v2.1](https://raw.githubusercontent.com/wiki/luc-github/ESP3D/docs/Commands2_1.txt)
* [v3.0](https://raw.githubusercontent.com/wiki/luc-github/ESP3D/docs/Commands3.txt)

View File

@ -1,18 +1,18 @@
# Welcome to ESP3D wiki
## Releases
## Releases are vailable here
<https://github.com/luc-github/ESP3D/releases>
---
## Nice things done using ESP3D
## Other nice things done using ESP3D
* [Rainmeter skin by @StArL0rd84](https://github.com/luc-github/ESP3D/wiki/Rainmeter-skin)
---
Check right menu for more
## Contributing
To update wiki please submit a PR to wiki directory content of default branch

View File

@ -1,4 +1,4 @@
# Firmware support
# Printer firmware compatibility
## References
@ -10,7 +10,7 @@ Marlin | <http://marlinfw.org/meta/gcode/>
Marlinkimbra |<https://github.com/MagoKimbra/MarlinKimbra/blob/V4_2_9/Documentation/GCodes.md>
Smoothieware | <http://smoothieware.org/supported-g-codes>
GRBL | <https://github.com/gnea/grbl/wiki/Grbl-v1.1-Commands>
Reprap | <https://duet3d.dozuki.com/Wiki/Gcode>
Reprap | <https://docs.duet3d.com/en/User_manual/Reference/Gcodes>
---

View File

@ -1,11 +1,23 @@
# ESP3D Wiki
* [Home](https://github.com/luc-github/ESP3D/wiki)
* [Hardware connection](https://github.com/luc-github/ESP3D/wiki/Hardware-connection)
* [Firmware compatibility](https://github.com/luc-github/ESP3D/wiki/Firmware--support)
* [How to get the ESP Flash-Size](https://github.com/luc-github/ESP3D/wiki/Flash-Size)
* [Direct ESP3D commands](https://github.com/luc-github/ESP3D/wiki/Direct-ESP3D-commands)
* [Install-Instructions](https://github.com/luc-github/ESP3D/wiki/Install-Instructions)
* Stating with ESP3D
* [Hardware connection](https://github.com/luc-github/ESP3D/wiki/Hardware-connection)
* [Install instructions](https://github.com/luc-github/ESP3D/wiki/Install-Instructions)
* [Printer firmware compatibility](https://github.com/luc-github/ESP3D/wiki/Printer-firmware-compatibility)
* Going further
* [Command line commands](https://github.com/luc-github/ESP3D/wiki/Command-line-commands)
* [v2.0.x](https://github.com/luc-github/ESP3D/wiki/Command-line-2_0)
* [v2.1.x](https://github.com/luc-github/ESP3D/wiki/Command-line-2_1)
* v3.0.x : work in progress
* [Cybersecurity concerns](https://github.com/luc-github/ESP3D/wiki/Cybersecurity-concerns)
* [Notifications](https://github.com/luc-github/ESP3D/wiki/Notifications)
* [Frequent Asked Questions](https://github.com/luc-github/ESP3D/issues?q=is%3Aissue+is%3Aclosed+label%3AFAQ)
* [Frequent Asked Questions 2](https://github.com/luc-github/ESP3D/discussions/categories/f-a-q)
* [Line](https://github.com/luc-github/ESP3D/wiki/Line)
* [Pushover](https://github.com/luc-github/ESP3D/wiki/Pushover)
* [Email and SMTP](https://github.com/luc-github/ESP3D/wiki/Email_and_SMTP)
* [Telegram](https://github.com/luc-github/ESP3D/wiki/Telegram)
* [IFTTT](https://github.com/luc-github/ESP3D/wiki/IFTTT)
* Needing help
* [Discussion FAQ](https://github.com/luc-github/ESP3D/discussions/categories/f-a-q)
* [Issues FAQ](https://github.com/luc-github/ESP3D/issues?q=is%3Aissue+is%3Aclosed+label%3AFAQ)
* [How to get the ESP Flash-Size](https://github.com/luc-github/ESP3D/wiki/Flash-Size)

View File

@ -1,161 +0,0 @@
* Change STA SSID
[ESP100]<SSID>
if authentication is on, need admin password
[ESP100]<SSID> pwd=<admin password>
* Change STA Password
[ESP101]<Password>
if authentication is on, need admin password
[ESP101]<Password> pwd=<admin password>
* Change Hostname
[ESP102]<hostname>
if authentication is on, need admin password
[ESP102]<hostname> pwd=<admin password>
* Change Wifi mode (STA/AP)
[ESP103]<mode>
if authentication is on, need admin password
[ESP103]<mode> pwd=<admin password>
* Change STA IP mode (DHCP/STATIC)
[ESP104]<mode>
if authentication is on, need admin password
[ESP104]<mode> pwd=<admin password>
* Change AP SSID
[ESP105]<SSID>
if authentication is on, need admin password
[ESP105]<SSID> pwd=<admin password>
* Change AP Password
[ESP106]<Password>
if authentication is on, need admin password
[ESP106]<Password> pwd=<admin password>
* Change AP IP mode (DHCP/STATIC)
[ESP107]<mode>
if authentication is on, need admin password
[ESP107]<mode> pwd=<admin password>
* Set wifi on/off
[ESP110]<state>
state can be ON, OFF, RESTART
if authentication is on, need admin password
[ESP110]<state> pwd=<admin password>
* Get current IP
[ESP111]<header answer>
* Get hostname
[ESP112]<header answer>
*Get/Set pin value
[ESP201]P<pin> V<value> [PULLUP=YES RAW=YES ANALOG=NO ANALOG_RANGE=255 CLEARCHANNELS=NO]pwd=<admin password>
if no V<value> get P<pin> value
if V<value> 0/1 set INPUT_PULLUP value, but for GPIO16 INPUT_PULLDOWN_16
GPIO1 and GPIO3 cannot be used as they are used for serial
if PULLUP=YES set input pull up, if not set input
if RAW=YES do not set pinmode just read value
* Output to oled column C and line L
[ESP210]C=<col> L=<line> T=<Text>
* Output to oled line 1
[ESP211]<Text>
* Output to oled line 2
[ESP212]<Text>
* Output to oled line 3
[ESP213]<Text>
* Output to oled line 4
[ESP214]<Text>
*Get full EEPROM settings content
but do not give any passwords
can filter if only need wifi or printer
[ESP400]<network/printer>
*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>
Positions:
* EP_WIFI_MODE 0 //1 byte = flag
* EP_STA_SSID 1 //33 bytes 32+1 = string ; warning does not support multibyte char like chinese
* EP_STA_PASSWORD 34 //65 bytes 64 +1 = string ;warning does not support multibyte char like chinese
* EP_STA_IP_MODE 99 //1 byte = flag
* EP_STA_IP_VALUE 100 //4 bytes xxx.xxx.xxx.xxx
* EP_STA_MASK_VALUE 104 //4 bytes xxx.xxx.xxx.xxx
* EP_STA_GATEWAY_VALUE 108 //4 bytes xxx.xxx.xxx.xxx
* EP_BAUD_RATE 112 //4 bytes = int
* EP_STA_PHY_MODE 116 //1 byte = flag
* EP_SLEEP_MODE 117 //1 byte = flag
* EP_CHANNEL 118 //1 byte = flag
* EP_AUTH_TYPE 119 //1 byte = flag
* EP_SSID_VISIBLE 120 //1 byte = flag
* EP_WEB_PORT 121 //4 bytes = int
* EP_DATA_PORT 125 //4 bytes = int
* EP_OUTPUT_FLAG 129 //1 bytes = flag
* EP_HOSTNAME 130//33 bytes 32+1 = string ; warning does not support multibyte char like chinese
* EP_DHT_INTERVAL 164//4 bytes = int
* EP_FREE_INT2 168//4 bytes = int
* EP_FREE_INT3 172//4 bytes = int
* EP_ADMIN_PWD 176//21 bytes 20+1 = string ; warning does not support multibyte char like chinese
* EP_USER_PWD 197//21 bytes 20+1 = string ; warning does not support multibyte char like chinese
* EP_AP_SSID 218 //33 bytes 32+1 = string ; warning does not support multibyte char like chinese
* EP_AP_PASSWORD 251 //65 bytes 64 +1 = string ;warning does not support multibyte char like chinese
* EP_AP_IP_VALUE 316 //4 bytes xxx.xxx.xxx.xxx
* EP_AP_MASK_VALUE 320 //4 bytes xxx.xxx.xxx.xxx
* EP_AP_GATEWAY_VALUE 324 //4 bytes xxx.xxx.xxx.xxx
* EP_AP_IP_MODE 329 //1 byte = flag
* EP_AP_PHY_MODE 330 //1 byte = flag
* EP_FREE_STRING1 331 //129 bytes 128+1 = string ; warning does not support multibyte char like chinese
* EP_DHT_TYPE 460 //1 bytes = flag
* EP_TARGET_FW 461 //1 bytes = flag
*Get available AP list (limited to 30)
output is JSON or plain text according parameter
[ESP410]<plain>
*Get current settings of ESP3D
output is JSON or plain text according parameter
[ESP420]<plain>
* Get/Set ESP mode
cmd can be RESET, SAFEMODE, CONFIG, RESTART
[ESP444]<cmd>
if authentication is on, need admin password for RESET, RESTART and SAFEMODE
[ESP444]<cmd> pwd=<admin password>
* Change / Reset user password
[ESP555]<password> pwd=<admin password>
if no password set it use default one
* Send GCode with check sum caching right line numbering
[ESP600]<gcode>
* Send line checksum
[ESP601]<line>
* Read SPIFFS file and send each line to serial
[ESP700]<filename>
* Format SPIFFS
[ESP710]FORMAT pwd=<admin password>
* SPIFFS total size and used size
[ESP720]<header answer>
* Get fw version and basic information
[ESP800]<header answer>
* Get fw target
[ESP801]<header answer>
* Check SD presence
[ESP802]

View File

@ -1,172 +0,0 @@
* Change STA SSID
[ESP100]<SSID>
if authentication is on, need admin password
[ESP100]<SSID> pwd=<admin password>
* Change STA Password
[ESP101]<Password>
if authentication is on, need admin password
[ESP101]<Password> pwd=<admin password>
* Change Hostname
[ESP102]<hostname>
if authentication is on, need admin password
[ESP102]<hostname> pwd=<admin password>
* Change Wifi mode (STA/AP)
[ESP103]<mode>
if authentication is on, need admin password
[ESP103]<mode> pwd=<admin password>
* Change STA IP mode (DHCP/STATIC)
[ESP104]<mode>
if authentication is on, need admin password
[ESP104]<mode> pwd=<admin password>
* Change AP SSID
[ESP105]<SSID>
if authentication is on, need admin password
[ESP105]<SSID> pwd=<admin password>
* Change AP Password
[ESP106]<Password>
if authentication is on, need admin password
[ESP106]<Password> pwd=<admin password>
* Change AP IP mode (DHCP/STATIC)
[ESP107]<mode>
if authentication is on, need admin password
[ESP107]<mode> pwd=<admin password>
* Set wifi on/off
[ESP110]<state>
state can be ON, OFF, RESTART
if authentication is on, need admin password
[ESP110]<state> pwd=<admin password>
* Get current IP
[ESP111]<header answer>
* Get hostname
[ESP112]<header answer>
*Get/Set pin value
[ESP201]P<pin> V<value> [PULLUP=YES RAW=YES ANALOG=NO ANALOG_RANGE=255 CLEARCHANNELS=NO]pwd=<admin password>
if no V<value> get P<pin> value
if V<value> 0/1 set INPUT_PULLUP value, but for GPIO16 INPUT_PULLDOWN_16
GPIO1 and GPIO3 cannot be used as they are used for serial
if PULLUP=YES set input pull up, if not set input
if RAW=YES do not set pinmode just read value
* Output to oled column C and line L
[ESP210]C=<col> L=<line> T=<Text>
* Output to oled line 1
[ESP211]<Text>
* Output to oled line 2
[ESP212]<Text>
* Output to oled line 3
[ESP213]<Text>
* Output to oled line 4
[ESP214]<Text>
* Delay command
[ESP290]<delay in ms>[pwd=<user password>]
* Give EEPROM Version detected
[ESP300]
*Get full EEPROM settings content
but do not give any passwords
can filter if only need wifi or printer
[ESP400]<network/printer>
*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>
Positions:
* EP_WIFI_MODE 0 //1 byte = flag
* EP_STA_SSID 1 //33 bytes 32+1 = string ; warning does not support multibyte char like chinese
* EP_STA_PASSWORD 34 //65 bytes 64 +1 = string ;warning does not support multibyte char like chinese
* EP_STA_IP_MODE 99 //1 byte = flag
* EP_STA_IP_VALUE 100 //4 bytes xxx.xxx.xxx.xxx
* EP_STA_MASK_VALUE 104 //4 bytes xxx.xxx.xxx.xxx
* EP_STA_GATEWAY_VALUE 108 //4 bytes xxx.xxx.xxx.xxx
* EP_BAUD_RATE 112 //4 bytes = int
* EP_STA_PHY_MODE 116 //1 byte = flag
* EP_SLEEP_MODE 117 //1 byte = flag
* EP_CHANNEL 118 //1 byte = flag
* EP_AUTH_TYPE 119 //1 byte = flag
* EP_SSID_VISIBLE 120 //1 byte = flag
* EP_WEB_PORT 121 //4 bytes = int
* EP_DATA_PORT 125 //4 bytes = int
* EP_OUTPUT_FLAG 129 //1 bytes = flag
* EP_HOSTNAME 130//33 bytes 32+1 = string ; warning does not support multibyte char like chinese
* EP_DHT_INTERVAL 164//4 bytes = int
* EP_FREE_INT2 168//4 bytes = int
* EP_FREE_INT3 172//4 bytes = int
* EP_ADMIN_PWD 176//21 bytes 20+1 = string ; warning does not support multibyte char like chinese
* EP_USER_PWD 197//21 bytes 20+1 = string ; warning does not support multibyte char like chinese
* EP_AP_SSID 218 //33 bytes 32+1 = string ; warning does not support multibyte char like chinese
* EP_AP_PASSWORD 251 //65 bytes 64 +1 = string ;warning does not support multibyte char like chinese
* EP_AP_IP_VALUE 316 //4 bytes xxx.xxx.xxx.xxx
* EP_AP_MASK_VALUE 320 //4 bytes xxx.xxx.xxx.xxx
* EP_AP_GATEWAY_VALUE 324 //4 bytes xxx.xxx.xxx.xxx
* EP_AP_IP_MODE 329 //1 byte = flag
* EP_AP_PHY_MODE 330 //1 byte = flag
* EP_FREE_STRING1 331 //129 bytes 128+1 = string ; warning does not support multibyte char like chinese
* EP_DHT_TYPE 460 //1 bytes = flag
* EP_TARGET_FW 461 //1 bytes = flag
*Get available AP list (limited to 30)
output is JSON or plain text according parameter
[ESP410]<plain>
*Get current settings of ESP3D
output is JSON or plain text according parameter
[ESP420]<plain>
* Get/Set ESP mode
cmd can be RESET, SAFEMODE, CONFIG, RESTART
[ESP444]<cmd>
if authentication is on, need admin password for RESET, RESTART and SAFEMODE
[ESP444]<cmd> pwd=<admin password>
* Send GCode with check sum caching right line numbering
[ESP500]<gcode>
* Send line checksum
[ESP501]<line>
* Change / Reset user password
[ESP555]<password> pwd=<admin password>
if no password set it use default one
* Send Notification
[ESP600]msg [pwd=<admin password>]
* Set/Get Notification settings
[ESP610]type=<NONE/PUSHOVER/EMAIL/LINE> T1=<token1> T2=<token2> TS=<Settings> [pwd=<admin password>]
Get will give type and settings only not the protected T1/T2
* Read SPIFFS file and send each line to serial
[ESP700]<filename>
* Format SPIFFS
[ESP710]FORMAT pwd=<admin password>
* SPIFFS total size and used size
[ESP720]<header answer>
* Get fw version and basic information
[ESP800]<header answer>
* Get fw target
[ESP801]<header answer>
* Get state / Set Enable / Disable Serial Communication
[ESP900]<ENABLE/DISABLE>

View File

@ -1,223 +0,0 @@
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 Fallback mode which can be BT, SETUP, OFF
[ESP104]<state> 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, WIFI-SETUP, 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, CLOSE
[ESP130]<state> pwd=<admin password>
* Get/Set Telnet port
[ESP131]<port> 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> pwd=<admin password>
* Get/Set boot delay
[ESP150]<time in milliseconds>[pwd=<admin password>]
* Get/Set WebSocket state which can be ON, OFF
[ESP160]<state> pwd=<admin password>
* Get/Set WebSocket port
[ESP161]<port> pwd=<admin password>
* Get/Set camera server state which can be ON, OFF, but not saved in EEPROM
[ESP170]<state> pwd=<admin password>
* Get/Set Camera port
[ESP171]<port> 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
[ESP172]<plain><label=value> pwd=<admin password>
* Get/Set Ftp state which can be ON, OFF, CLOSE
[ESP180]<state> pwd=<admin password>
* Get/Set Ftp ports
[ESP181]ctrl=<port> active=<port> passive=<port> pwd=<admin password>
* Get SD Card Status
[ESP200] pwd=<user/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
* Output to esp screen status
[ESP214]<Text> pwd=<user password>
* Touch Calibration
[ESP215]<CALIBRATE> [pwd=<user password>]
* Take screen snapshot
[ESP216]<SNAP> [pwd=<user password>]
* Play sound
No parameter just play beep
[ESP250]F=<frequency> D=<duration> [pwd=<user password>]
* Delay command
[ESP290]<delay in ms> [pwd=<user password>]
* 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_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_OUTPUT_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 xxx.xxx.xxx.xxx
ESP_WEBSOCKET_PORT 324 //4 bytes xxx.xxx.xxx.xxx
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_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
ESP_NOTIFICATION_SETTINGS 855//128 bytes 127+1 = string ; warning does not support multibyte char like chinese
ESP_CALIBRATION_1 983 //4 bytes = int
ESP_CALIBRATION_2 987 //4 bytes = int
ESP_CALIBRATION_3 991 //4 bytes = int
ESP_CALIBRATION_4 995 //4 bytes = int
ESP_CALIBRATION_5 999 //4 bytes = int
ESP_AUTO_NOTIFICATION 1004 //1 byte = flag
*Get available AP list (limited to 30)
output is JSON or plain text according parameter
[ESP410]<plain> pwd=<admin/user password>
*Get current settings of ESP3D
output is plain text
[ESP420]pwd=<admin/user password>
* Set ESP State
cmd are RESTART / RESET
[ESP444]<cmd> pwd=<admin password>
* Change admin password
[ESP550]<password> pwd=<admin password>
* Change user password
[ESP555]<password> pwd=<admin/user password>
* Send Notification
[ESP600]msg [pwd=<admin password>]
* Set/Get Notification settings
[ESP610]type=<NONE/PUSHOVER/EMAIL/LINE> T1=<token1> T2=<token2> TS=<Settings> [pwd=<admin password>]
Get will give type and settings only, not the protected T1/T2
* Format ESP Filesystem
[ESP710]FORMAT pwd=<admin password>
* Format SD Filesystem
[ESP715]FORMATSD pwd=<admin password>
* List ESP Filesystem
[ESP720]<Root> pwd=<admin password>
* Action on ESP Filesystem
rmdir / remove / mkdir / exists / create
[ESP730]<Action>=<path> pwd=<admin password>
* List SD Filesystem
[ESP740]<Root> pwd=<admin password>
* Action on SD Filesystem
rmdir / remove / mkdir / exists / create
[ESP750]<Action>=<path> pwd=<admin password>
* FW Informations
[ESP800]<plain> pwd=<admin password>
* Get state / Set Enable / Disable Serial Communication
[ESP900]<ENABLE/DISABLE> [pwd=<admin/user password>]
* Get state / Set Enable / Disable buzzer
[ESP910]<ENABLE/DISABLE> [pwd=<admin/user password>]

View File

@ -383,8 +383,14 @@ So `[ESP201]P12 V0` should be off and `[ESP201]P12 V1` should be on
### Wemos D1 mini
<img src='https://raw.githubusercontent.com/wiki/luc-github/ESP3D/images/D1_mini/FB_IMG_1510306696875.jpg' width='200'><br>
Connection with logic level conveter:
<img src='https://github.com/jayjojayson/ESP3D/blob/2.1/images/D1_mini/wemos-d1-mini_logic-level-converter.jpg?raw=true' width='200'><br>
click to enlarge
<img src='https://raw.githubusercontent.com/wiki/luc-github/ESP3D/images/D1_mini/20171111_215253.jpg' width='200'><br>
example:
<img src='https://github.com/jayjojayson/ESP3D/blob/2.1/images/D1_mini/wemos-d1-mini_logic-level-converter-2.jpg?raw=true' width='200'><br>
click to enlarge
printed cases:
* <https://www.thingiverse.com/thing:4128593>
* <https://www.thingiverse.com/thing:2671591>