1
0
mirror of https://github.com/s00500/ESPUI.git synced 2024-11-24 17:30:55 +00:00

Rename new api and some readme cleaning

This commit is contained in:
Lukas Bachschwell 2019-12-27 15:43:36 +01:00
parent fcc80b5843
commit 0323920a0d
Signed by: lbsadmin
GPG Key ID: CCC6AA87CC8DF425
2 changed files with 18 additions and 22 deletions

View File

@ -35,26 +35,20 @@ THIS IS THE 2.0.0 DEVELOPMENT BRANCH, NOT GUARANTIED TO WORK
- Graph Widget ✅ - Graph Widget ✅
* Cleanup Example, DNS and autojoin * Cleanup Example, DNS and autojoin
* Persist save graph in local storage
* data upload new info to doc? (copy to folder?)
* Cleanup and extend Documentation * Cleanup and extend Documentation
- Number field ✅ - Number field ✅
- Text field ✅ - Text field ✅
- Data directory ✅ - Data directory ✅
- Graph Usage - Graph Usage
- Number min and max value to docs
- Slider - Slider
- OptionList - OptionList
- Tab usage - Tab usage
- Verbosity setting - Verbosity setting
To check: ## Changelog for 2.0 functions:
data upload new info to doc?
## OLD Roadmap :
- Datagraph output -> _WIP_
- Number min and max value
- proper return value (as int and not as string) for slider
## Changelog for functions:
- split pad into pad and padWithCenter - split pad into pad and padWithCenter
- Cleaned order or parameters on switch - Cleaned order or parameters on switch
@ -70,38 +64,40 @@ This library is dependent on the following libraries to function properly.
- [ArduinoJson](https://github.com/bblanchon/ArduinoJson) (Last tested with - [ArduinoJson](https://github.com/bblanchon/ArduinoJson) (Last tested with
version 6.10.0) **Plus for ESP8266** version 6.10.0) **Plus for ESP8266**
- [ESPAsyncTCP](https://github.com/me-no-dev/ESPAsyncTCP) - (_For ESP8266_) [ESPAsyncTCP](https://github.com/me-no-dev/ESPAsyncTCP)
- (_For ESP32_) [AsyncTCP](https://github.com/me-no-dev/AsyncTCP)
**Additionally necessary for ESP32**
- [AsyncTCP](https://github.com/me-no-dev/AsyncTCP)
## How to Install ## How to Install
Make sure all the dependencies are installed, then install like so: Make sure all the dependencies are installed, then install like so:
#### Using PlattformIO (_recommended_)
Just include this library as a dependency on lib_deps like so:
```
lib_deps = ESPUI
```
#### Directly Through Arduino IDE (_recommended_) #### Directly Through Arduino IDE (_recommended_)
You can find this Library in the Arduino IDE library manager Go to Sketch > You can find this Library in the Arduino IDE library manager Go to Sketch >
Include Library > Library Manager > Search for "ESPUI" > Install Include Library > Library Manager > Search for "ESPUI" > Install
#### Manual Install #### Manual Install Arduino IDE
For Windows: Download the _For Windows:_ Download the
[Repository](https://github.com/s00500/ESPUI/archive/master.zip) and extract the [Repository](https://github.com/s00500/ESPUI/archive/master.zip) and extract the
.zip in Documents>Arduino>Libraries>{Place "ESPUI" folder Here} .zip in Documents>Arduino>Libraries>{Place "ESPUI" folder Here}
For Linux: Download the _For Linux:_ Download the
[Repository](https://github.com/s00500/ESPUI/archive/master.zip) and extract the [Repository](https://github.com/s00500/ESPUI/archive/master.zip) and extract the
.zip in Sketchbook/Libraries/{Place "ESPUI" folder Here} .zip in Sketchbook/Libraries/{Place "ESPUI" folder Here}
For macOs: Download the _For macOs:_ Download the
[Repository](https://github.com/s00500/ESPUI/archive/master.zip) and extract the [Repository](https://github.com/s00500/ESPUI/archive/master.zip) and extract the
.zip in ~/Documents/Arduino/libraries/{Place "ESPUI" folder Here} .zip in ~/Documents/Arduino/libraries/{Place "ESPUI" folder Here}
#### Manually through IDE
Download the [Repository](https://github.com/s00500/ESPUI/archive/master.zip),
Go to Sketch>Include Library>Add .zip Library> Select the Downloaded .zip File. Go to Sketch>Include Library>Add .zip Library> Select the Downloaded .zip File.
## Getting started ## Getting started