GitHub-Proxy/ESP3D
1
0
Fork 0
mirror of https://git.mirrors.martin98.com/https://github.com/luc-github/ESP3D.git synced 2025-06-06 02:36:49 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity

update wiki and readme (#736)

Browse Source 
* fix folder name
* Direct Link to installation in readme 
* keep also old version infos
* add title to avoid small lines beeing missed
* add MCU frequency directly to configuration and reorder as in arduino IDE v1.8.19
* library installation copied from readme to wiki
This commit is contained in:
Julien Staub 2022-04-25 03:11:07 +02:00 committed by GitHub
parent e0079a6750
commit b0ca6e15b1
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
4 changed files with 29 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
.vscode/settings.json vendored
View File

@ -39,5 +39,11 @@
"type_traits": "cpp",
"utility": "cpp",
"typeinfo": "cpp"
}
}
},
"files.trimTrailingWhitespace": true,
"[markdown]": {
"files.trimTrailingWhitespace": false
},
"files.trimFinalNewlines": true,
"files.insertFinalNewline": true,
}

6
README.md
View File

@ -74,6 +74,9 @@ if Authentication is enabled :
## Direct commands:
Check wiki : https://github.com/luc-github/ESP3D/wiki/Direct-ESP3D-commands
## Installation instructions
See [Wiki](https://github.com/luc-github/ESP3D/wiki/Install-Instructions)
## Installation
Feedback on 2.0 was : ESP3D being a library is not really useful and make setup more complex, so now we are back to simple application.
@ -146,6 +149,3 @@ and Wifi boards for 3D printers : https://www.panucatt.com/ProductDetails.asp?Pr
If you use ESP3D on your product, drop me a message so I can link your product page here.

27
wiki/Flash-Size.md
View File

@ -1,38 +1,43 @@
# Arduino IDE board configuration
The ESP8266 comes in various models:
configure your Arduino IDE -> Tools -> Boards as:
# Known working configs
### The latest ESP01 and ESP12Es come with 4Mb of flash: For those
### The latest ESP01 and ESP12Es come with 4Mb of flash: For those
* Board: Generic ESP8266 Module
* Upload Speed: 115200
* CPU frequency: 160 MHz
* Flash Size: 4M (3M SPIFFS)
* Flash Mode: DIO
* Flash Frequency: 40Mhz
* Flash Size: 4M (3M SPIFFS)
* Reset Method: CK
* Debug Port: Disabled
* Debug Level: None
* Reset Method: CK
* Upload Speed: 115200
### Some of the older devices come with 1M flash
* Board: Generic ESP8266 Module
* Upload Speed: 115200
* CPU frequency: 160 MHz
* Flash Size: 1M (128K SPIFFS)
* Flash Mode: DIO
* Flash Frequency: 40Mhz
* Flash Size: 1M (128K SPIFFS)
* Reset Method: CK
* Debug Port: Disabled
* Debug Level: None
* Reset Method: CK
* Upload Speed: 115200
### Though now no longer supported, it is possible to run the firmware on devices like the ESP07 with 512K of flash:
* Board: Generic ESP8266 Module
* Upload Speed: 115200
* CPU frequency: 160 MHz
* Flash Size: 512k (128K SPIFFS)
* Flash Mode: DIO
* Flash Frequency: 40Mhz
* Flash Size: 512k (128K SPIFFS)
* Reset Method: CK
* Debug Port: Disabled
* Debug Level: None
* Reset Method: CK
* Upload Speed: 115200
# Figuring out the Flash Size
If you are unsure how much flash memory your particular module has. you can figure it out from the Arduino IDE:
@ -58,4 +63,4 @@ For example
`Flash Chip configuration ok.`
(NB: If you dont get a 'Flash Chip configuration ok.' uploading will appear to work succesfully but the chip will crash on startup and never show an access point / serial output)
(NB: If you dont get a 'Flash Chip configuration ok.' uploading will appear to work succesfully but the chip will crash on startup and never show an access point / serial output)

3
wiki/Install-Instructions.md
View File

@ -14,6 +14,7 @@ For people not willing to read check this great video from Chris Riley :
`2.4` Scroll to near the bottom, and find "esp8266 by ESP8266 Community) and click on the row
`2.5` On the "Select Version" dropdown, select latest version and click Install
`2.6` Wait for the ESP8266 support to be installed
`2.7` Download the latest release and manually copy the libraries present in the ESP3D-x.y.z/libraries directory into your Arduino/libraries directory. (no need if using platformIO). These versions are verified to work with ESP3D, any others (newer version) may cause untested behavior.
`3.` Download and install the SPIFFS Uploader tool
<B>EDIT:This part is no more necessary since FW 0.9.99 which contains self uploader </B>
@ -29,7 +30,7 @@ For people not willing to read check this great video from Chris Riley :
`4.` Download the latest release of this project:
https://github.com/luc-github/ESP3D/releases/latest
`4.1` Extract it to your sketchbook or other location
`4.2` Open the Arduino IDE and open the ESP8266 subdirectory -> esp8266.ino (or esp3d.ino for latest versions)
`4.2` Open the Arduino IDE and open the ESP3D subdirectory (ESP8266 for older versions) -> esp3d.ino (or esp8266.ino for older versions)
`5.` Configure your Board
_NB: Read [this article for NB notes](https://github.com/luc-github/ESP8266/wiki/Flash-Size) on selecting the correct Board settings._