salfter/ESP3D
1
0
Fork 0
mirror of https://github.com/luc-github/ESP3D.git synced 2025-10-24 11:50:52 -07:00
Code Issues Packages Projects Releases Wiki Activity

Update README.md

Browse Source 
Signed-off-by: Luc <8822552+luc-github@users.noreply.github.com>
This commit is contained in:
Luc
2023-02-28 13:37:42 +08:00
committed by GitHub
parent 3ff58b0786
commit d515775301
1 changed files with 2 additions and 26 deletions
Download Patch File Download Diff File Expand all files Collapse all files

28
README.md
View File

@@ -4,7 +4,7 @@
please use Arduino ide 1.8.9+ with [![Release Version](https://img.shields.io/badge/ESP32-1.0.4-green?style=plastic)](https://github.com/espressif/arduino-esp32/releases/tag/1.0.4) or [![Release Version](https://img.shields.io/badge/ESP8266-2.5.2-green?style=plastic)](https://github.com/esp8266/Arduino/releases/tag/2.5.2) please use Arduino ide 1.8.9+ with [![Release Version](https://img.shields.io/badge/ESP32-1.0.4-green?style=plastic)](https://github.com/espressif/arduino-esp32/releases/tag/1.0.4) or [![Release Version](https://img.shields.io/badge/ESP8266-2.5.2-green?style=plastic)](https://github.com/esp8266/Arduino/releases/tag/2.5.2)
[Latest development version ![Development Version](https://img.shields.io/badge/Devt-v3.0-yellow?style=plastic) ![GitHub last commit (branch)](https://img.shields.io/github/last-commit/luc-github/ESP3D/3.0?style=plastic)](https://github.com/luc-github/ESP3D/tree/3.0) [![Travis (.org) branch](https://img.shields.io/travis/luc-github/ESP3D/3.0?style=plastic)](https://travis-ci.org/luc-github/ESP3D) [![Development Version](https://img.shields.io/badge/Devt-v3.0-yellow?style=plastic&label=WebUI)](https://github.com/luc-github/ESP3D-WEBUI/tree/3.0) [Latest development version ![Development Version](https://img.shields.io/badge/Devt-v3.0-yellow?style=plastic) ![GitHub last commit (branch)](https://img.shields.io/github/last-commit/luc-github/ESP3D/3.0?style=plastic)](https://github.com/luc-github/ESP3D/tree/3.0) [![Travis (.org) branch](https://img.shields.io/travis/luc-github/ESP3D/3.0?style=plastic)](https://travis-ci.org/luc-github/ESP3D) [![Development Version](https://img.shields.io/badge/Devt-v3.0-yellow?style=plastic&label=WebUI)](https://github.com/luc-github/ESP3D-WEBUI/tree/3.0)
please use Arduino ide 1.8.9+ with [![Release Version](https://img.shields.io/badge/ESP32-git-yellow?style=plastic&logo=github)](https://github.com/espressif/arduino-esp32) or [![Release Version](https://img.shields.io/badge/ESP8266-git-yellow?style=plastic&logo=github)](https://github.com/esp8266/Arduino/)
[All releases](https://github.com/luc-github/ESP3D/releases) [All releases](https://github.com/luc-github/ESP3D/releases)
@@ -71,31 +71,7 @@ if Authentication is enabled :
Check wiki : https://github.com/luc-github/ESP3D/wiki/Direct-ESP3D-commands Check wiki : https://github.com/luc-github/ESP3D/wiki/Direct-ESP3D-commands
## Installation ## 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. Please go to [httpd://esp3d.io](http://esp3d.io/esp3d/v2.x/index.html) for latest notes on instalation and documentation
1. Please follow installation of the ESP core you want to use : [ESP8266 core version](https://github.com/esp8266/Arduino) or [ESP32 core version](https://github.com/espressif/arduino-esp32)
2. Add manually libraries present in libraries directory to your arduino libraries directory (no need if you use platformIO) -these versions are verified to work with ESP3D, any others (newer version) may cause untested behavior.
Use webserver support (recommended as stable), asyncwebserver support is no more stable on ESP3D
* arduinoWebSockets from @Links2004
Generic ones:
Specific for ESP32
* ESP32SSDP
If you want OLED support:
* oled-ssd1306 from @squix78
If you want DHT11/22 support:
* DHT_sensor_library_for_ESPx from @beegee-tokyo
3. Compile project esp3d.ino according target: ESP8266 board or ESP32 board, please review config.h to enable disable a feature, by default athentication is disabled and most others are enabled.
* for ESP8266 set CPU freq to 160MHz for better (https://github.com/luc-github/ESP3D/wiki/Install-Instructions)
4. Upload the data content on ESP3D file system
* Using SPIFFS uploader, this plugin and install instructions is available on each ESP core - please refere to it
or
* Using embedded uploader (you may need to format SPIFFS using : [ESP710]FORMAT on ESP8266 first)
if embedded uploader does not show up you can force it ti display using : http://your_IP_address?forcefallback=yes
<img src=https://raw.githubusercontent.com/luc-github/ESP3D/2.1/images/docs/embedded.png><br>
## Update ## Update
* Generate a binary using the export binary menu from Arduino IDE and upload it using ESP-WEBUI or embedded interface * Generate a binary using the export binary menu from Arduino IDE and upload it using ESP-WEBUI or embedded interface