Skip to content

Commit ad09a49

Browse files
committed
added html contents as file
added code generator for html contents cleanedup images updated readme
1 parent 104c070 commit ad09a49

20 files changed

+329
-61
lines changed

README.md

Lines changed: 25 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -42,13 +42,10 @@ It will provide a webpage for updating the firmware/filesystem of `ESP8266` or `
4242
### Install
4343

4444
This Library is available in `Arduino Library Repository` and `PIO` and you can install it from:
45-
- Arduino IDE Library Manager
46-
47-
<img width="500" src="image.png" alt="Arduino library manager"/>
4845

49-
- PlatformIO Libraries
50-
51-
<img width="500" src="image-1.png" alt="pltformio library"/>
46+
| Arduino IDE Library Manager | PlatformIO Libraries |
47+
|:---:|:---:|
48+
|<img width="500" src="previews/arduino.png" alt="Arduino library manager"/>|<img width="500" src="previews/pio.png" alt="pltformio library"/>|
5249

5350
`ipdotsetaf/ESPAsyncHTTPUpdateServer@^2.0.0`
5451
### Setup
@@ -82,42 +79,35 @@ _updateServer.setup(&_server, "/customroute", "username", "password");
8279

8380
### Styling and Customizing OTA Page
8481

85-
<table>
86-
<tr>
87-
<td>OTA Mode</td>
88-
<td>Stylized</td>
89-
<td>Minimal(default)</td>
90-
</tr>
91-
<tr>
92-
<td>Default</td>
93-
<td><img width="450" src="image-2.png" alt="Stylized OTA Page"/></td>
94-
<td><img width="450" src="image-3.png" alt="Minimal OTA Page"/></td>
95-
</tr>
96-
<tr>
97-
<td>Firmware Only</td>
98-
<td><img width="450" src="image-4_s_firmware.png" alt="Stylized OTA Firmware Only Page"/></td>
99-
<td><img width="450" src="image-4_n_firmware.png" alt="Minimal OTA Firmware Only Page"/></td>
100-
</tr>
101-
<tr>
102-
<td>Filesystem Only</td>
103-
<td><img width="450" src="image-4_s_filesystem.png" alt="Stylized OTA Filesystem OnlyPage"/></td>
104-
<td><img width="450" src="image-4_n_filesystem.png" alt="Minimal OTA Filesystem Only Page"/></td>
105-
</tr>
106-
</table>
82+
| Stylized | Minimal |
83+
|:---:|:---:|
84+
|<img width="450" src="previews/stylized.png" alt="Stylized OTA Page"/> | <img width="450" src="previews/minimal.png" alt="Minimal OTA Page"/> |
10785

10886
> [!IMPORTANT]
10987
> By default styling is disabled to save ~350 bytes of flash memory.
11088
>
11189
> You can enable the styling by adding the `-DESPASYNCHTTPUPDATESERVER_PRETTY` Build Flag to your environment.
90+
91+
### Customizing OTA Page
92+
93+
> [!IMPORTANT]
94+
> Adding the `-DESPASYNCHTTPUPDATESERVER_MODE` Build Flag to choose different update mode. choose the right value based on your needs:
11295
>
113-
> Adding the `-DESPASYNCHTTPUPDATESERVER_MODE` Build Flag to choose different update mode. this flag has three values:
114-
>
115-
> `-DESPASYNCHTTPUPDATESERVER_MODE=0` firmware and filesystem, which is the default.
116-
>
117-
> `-DESPASYNCHTTPUPDATESERVER_MODE=1` update firmware only.
118-
>
119-
> `-DESPASYNCHTTPUPDATESERVER_MODE=2` update filesystem only.
96+
> | Update mode | value |
97+
> |:---:|:---:|
98+
> |Firmaware and FileSystem|0|
99+
> |Firmaware only|1|
100+
> |FileSystem only|2|
101+
102+
#### Modifying Htmls
103+
104+
in case you liked to modify the html of any of the pages, you need to run the `scripts/codeGenerator.py` afterwards so html contents get processed and placed in the source.
120105

106+
Instructions:
107+
1. Make sure you have python installed
108+
2. In your python environment run the following
109+
3. `pip install -r requirements.txt`
110+
4. `python codeGenerator.py`
121111

122112
### Selecting FileSystem
123113
> [!IMPORTANT]

image-1.png

-34.4 KB
Binary file not shown.

image-4_n_filesystem.png

-5.27 KB
Binary file not shown.

image-4_n_firmware.png

-4.86 KB
Binary file not shown.

image-4_s_filesystem.png

-33.4 KB
Binary file not shown.

image-4_s_firmware.png

-32.6 KB
Binary file not shown.

image.png

-25.7 KB
Binary file not shown.

previews/arduino.png

23.4 KB
Loading
File renamed without changes.

previews/pio.png

27.2 KB
Loading

0 commit comments

Comments
 (0)