lbsadmin/ESPUI
1
0
Fork 0
mirror of https://github.com/s00500/ESPUI.git synced 2024-11-25 03:50:54 +00:00
Code Issues Releases Activity

Improved Readme -

Browse Source 
Renovated Docs, according to V0.6
This commit is contained in:
ayushsharma82 2017-05-20 05:16:51 +05:30
parent 07c35f918c
commit 5265831376
1 changed files with 13 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
README.md
View File

@ -1,4 +1,5 @@
# EasyUI # EasyUI
![EasyUI Dashboard](https://github.com/ayushsharma82/EasyUI/blob/master/docs/img1.PNG)
Did you Ever Got into the Trouble of Making a good Looking UI for ESP8266 without having the skills to Build Perfect Webpages? Did you Ever Got into the Trouble of Making a good Looking UI for ESP8266 without having the skills to Build Perfect Webpages?
EasyUI is an User Interface Library for ESP8266 to Solve this Problem. This Library Uses Light-weight Websockets Protocol for Communicating with Webpage to Control, Make and Update Elements. EasyUI is an User Interface Library for ESP8266 to Solve this Problem. This Library Uses Light-weight Websockets Protocol for Communicating with Webpage to Control, Make and Update Elements.
@ -24,7 +25,7 @@ This Library is Dependent on the Following Libraries to Function Properly.
- [arduinoWebSockets Library](https://github.com/Links2004/arduinoWebSockets) - [arduinoWebSockets Library](https://github.com/Links2004/arduinoWebSockets)
- [ArduinoJson](https://github.com/bblanchon/ArduinoJson) - [ArduinoJson](https://github.com/bblanchon/ArduinoJson)
Make Sure all Libraries are Installed to make this Work. Make Sure all Dependencies are Installed at their Latest Version to make this Work.
## Elements ## Elements
@ -55,21 +56,30 @@ Upcoming Features:
EasyUI is Based on [Skeleton CSS](http://getskeleton.com/) and Jquery for Handling Click Events Etc. The Communication Between ESP8266 and Webpage is with Websockets. EasyUI is Based on [Skeleton CSS](http://getskeleton.com/) and Jquery for Handling Click Events Etc. The Communication Between ESP8266 and Webpage is with Websockets.
EasyUI is not Internet Dependent and will Continue working without any Internet Connection, All Assets are Loaded form ESP8266 Program Memory. EasyUI is not Internet Dependent and will Continue working without any Internet Connection, All Assets are Loaded form ESP8266 Program Memory.
##### Following Functions can be Used in Sketch: #### Following Functions can be Used in Sketch:
<br>
**To Detect Internet and Switch to CDN**
The most Heaviest Part of the code is Jquery so, to make Webpages Load faster , user can use this function to switch between jquery served from esp memory or through online CDN when Internet is Available. (This Function is to be used in Station Mode Only!)
```
EasyUI.detectCDN(true);
```
<br> <br>
**To Set an Title for your Webpage:** **To Set an Title for your Webpage:**
![EasyUI Title](https://github.com/ayushsharma82/EasyUI/blob/master/docs/img2.PNG)
This Line of Code will Add your Custom Title to the Webpage Displayed by ESP8266. By Default is "EasyUI". This Line of Code will Add your Custom Title to the Webpage Displayed by ESP8266. By Default is "EasyUI".
``` ```
EasyUI.title(""); EasyUI.title("");
``` ```
<br> <br>
**To Make Label on Webpage:** **To Make Label on Webpage:**
![EasyUI Label](https://github.com/ayushsharma82/EasyUI/blob/master/docs/img3.PNG)
This will add an Label on your Web Interface. This will add an Label on your Web Interface.
``` ```
EasyUI.label("Title", "Value"); EasyUI.label("Title", "Value");
``` ```
<br> <br>
**To Make Toggle Button on Webpage:** **To Make Toggle Button on Webpage:**
![EasyUI Button1](https://github.com/ayushsharma82/EasyUI/blob/master/docs/img4.PNG) ![EasyUI Button2](https://github.com/ayushsharma82/EasyUI/blob/master/docs/img5.PNG)
This will add an toggle Button on your Webpage. For Extra Functionality* See Below This will add an toggle Button on your Webpage. For Extra Functionality* See Below
``` ```
EasyUI.toggleButton(pin,"Title"); EasyUI.toggleButton(pin,"Title");