diff --git a/.vscode/settings.json b/.vscode/settings.json index db798a72..fca77785 100644 --- a/.vscode/settings.json +++ b/.vscode/settings.json @@ -39,5 +39,11 @@ "type_traits": "cpp", "utility": "cpp", "typeinfo": "cpp" - } -} \ No newline at end of file + }, + "files.trimTrailingWhitespace": true, + "[markdown]": { + "files.trimTrailingWhitespace": false + }, + "files.trimFinalNewlines": true, + "files.insertFinalNewline": true, +} diff --git a/README.md b/README.md index 87788e7b..f1fc706d 100644 --- a/README.md +++ b/README.md @@ -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. - - - diff --git a/wiki/Flash-Size.md b/wiki/Flash-Size.md index 013d9db8..df827eb3 100644 --- a/wiki/Flash-Size.md +++ b/wiki/Flash-Size.md @@ -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) \ No newline at end of file +(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) diff --git a/wiki/Install-Instructions.md b/wiki/Install-Instructions.md index 1aee5a38..61d509a9 100644 --- a/wiki/Install-Instructions.md +++ b/wiki/Install-Instructions.md @@ -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 EDIT:This part is no more necessary since FW 0.9.99 which contains self uploader @@ -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._