Skip to content

Commit e59c601

Browse files
committed
Updated documentation
1 parent 7b1ce55 commit e59c601

File tree

4 files changed

+31
-15
lines changed

4 files changed

+31
-15
lines changed

README.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ Upon the first boot of the ESP32 NAT Router, a WiFi network with an open AP and
3333

3434
The ESP32 NAT Router has a web interface that allows you to configure all its parameters. To access this interface, connect your PC or smartphone to the WiFi SSID "ESP32_NAT_Router+". Once you're connected, open your web browser and enter
3535

36-
"[http://192.168.4.1](http://192.168.4.1/)''  into the address bar of your browser. Once you have entered this, you will be prompted for a username and password. The default username is "admin" and the default password is "123456789". Please note that it is recommended to change these to a more secure username and password once you have logged in:
36+
"[http://192.168.4.1](http://192.168.4.1/)''  into the address bar of your browser. Once you have entered this, you will be prompted for a username and password. The default `username is "admin" `and the default` password is "123456789"`. Please note that it is recommended to change these to a more secure username and password once you have logged in:
3737

3838
<!-- ![image](docs/index.png) -->
3939

@@ -118,7 +118,6 @@ As an alternative you might use [Espressif's Flash Download Tools](https://www.e
118118
Check the marked parameters and files like below (ckeck the COM-Port for your environment).
119119
Check the addresses like below:
120120

121-
122121
![Single bin](docs/images/win_flash_full_bin.png)
123122

124123
### or

components/ota_handler/README.md

Lines changed: 7 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# ESP32-Nat Router +
1+
# ESP32-NAT Router +
22

33
## OTA Handler Component
44

@@ -9,15 +9,14 @@ The OTA Handler is a firmware updater, that allows you to update ESP32 device o
99
To use the OTA Handler, you need to include the `ota_update_handler` function in your code. Here's an example of how to use it:
1010

1111
```c
12-
#include "ota_handler.h"
13-
................
14-
//send post request to this function
15-
ota_update_handler(req);
12+
#include "ota_handler.h"
1613

14+
// Run initial in main()
15+
ota_update_init()
1716

18-
// run initial in main()
19-
20-
ota_update_task(void *Param);
17+
................
18+
//send Uploding post request to this function
19+
ota_update_handler(req);
2120
```
2221
2322
In `CMakeLists.txt` update `REQUIRES ota_handler`

components/web_server/www/README.md

Lines changed: 22 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,19 @@ To start using Jekyll, you need to follow these steps:
99
- Install Ruby, Gem package manager & Jekyll ( check [here](https://www.ruby-lang.org/ ) )
1010
- Run `bundle install` in the `/html` folder to install dependencies
1111

12+
Note :
13+
14+
Jekyll is a static site generator that uses a specific format to separate the metadata of a web page from its content. At the top of each web file, it's important to include a specific syntax in the form of three hyphens
15+
16+
```
17+
---
18+
---
19+
```
20+
21+
This is known as the front matter and it specifies the metadata of the web page, such as the author and the layout styles etc.
22+
23+
It's important to include these three hyphen lines at the top of each file in order for Jekyll to properly parse the content and avoid errors while running and building the site. Therefore, always make sure to position these lines in the correct place in your web files to ensure a smooth development and build process.
24+
1225
## How to run a local server
1326

1427
Once Jekyll is installed, you can start a local server by following these steps:
@@ -31,14 +44,18 @@ Once Jekyll is installed, you can start a local server by following these steps:
3144
### Auto Mode (Windows only)
3245

3346
- Make sure you have Jekyll & Gems installed (see above)
47+
3448
- Launch `auto_generate.exe`
35-
- Wait for it to finish
36-
- That's it **¯\_(ツ)_**
3749

38-
### How to Build auto_generate.exe
39-
The `auto_generate.exe` code is written in JavaScript and converted into an executable file using the `pkg` package for Node.js.
50+
- Wait for it to finish
4051

41-
To build the `auto_generate.exe` file, which automatically generates the website, follow these simple steps:
52+
- That's it **¯\_(ツ)_**
53+
54+
### How to Build auto_generate.exe
55+
56+
The `auto_generate.exe` code is written in JavaScript and converted into an executable file using the `pkg` package for Node.js.
57+
58+
To build the `auto_generate.exe` file, which automatically generates the website, follow these simple steps:
4259
1. Install [Node.js](https://nodejs.org)
4360
2. Open a terminal and run `npm i -g pkg` .
4461
3. Extract the ZIP file provided in the **additional** folder

docs/Advanced_topics.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,7 @@ OTA (Over-The-Air) update is a method of updating the firmware of a device throu
3939
3. Select the desired firmware for the update
4040

4141
Once the update process begins, the device will automatically download and install the new firmware. This process may take a few minutes to complete, depending on the size of the firmware update.
42+
4243
Please note that during an OTA update, the device may become temporarily unavailable or unresponsive. This is normal and should not be a cause for concern.
4344
Also, it's important to ensure that the firmware being updated is compatible with the device and that there is a stable network connection. Failure to do so can result in errors and damage to the device.
4445
By following these steps, you can update the firmware of your ESP32-NATS Router + remotely and keep it running smoothly with the latest features and improvements.

0 commit comments

Comments
 (0)