Skip to content

Commit 9d6cbfd

Browse files
authored
Merge pull request #3 from karan6190/OTAWebUpdate_Doc
OTAWebUpdater doc
2 parents 0c2680e + 7c63528 commit 9d6cbfd

File tree

5 files changed

+57
-0
lines changed

5 files changed

+57
-0
lines changed

docs/OTAWebUpdate/OTAWebUpdate.md

Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
# Over the Air through Web browser
2+
OTAWebUpdate is done with a web browser that can be useful in the following typical scenarios:
3+
- Once the application developed and loading directly from Arduino IDE is inconvenient or not possible
4+
- after deployment if user is unable to expose Firmware for OTA from external update server
5+
- provide updates after deployment to small quantity of modules when setting an update server is not practicable
6+
7+
## Requirements
8+
- The ESP and the computer must be connected to the same network
9+
10+
## Implementation
11+
The sample implementation has been done using:
12+
- example sketch OTAWebUpdater.ino
13+
- NodeMCU 1.0 (ESP-12E Module)
14+
You can use another module also if it meets Flash chip size of the sketch
15+
1-Before you begin, please make sure that you have the following software installed:
16+
- Arduino IDE
17+
- Host software depending on O/S you use:
18+
- Avahi http://avahi.org/ for Linux
19+
- Bonjour http://www.apple.com/support/bonjour/ for Windows
20+
- Mac OSX and iOS - support is already built in / no any extra s/w is required
21+
22+
Prepare the sketch and configuration for initial upload with a serial port
23+
- Start Arduino IDE and load sketch OTAWebUpdater.ino available under File > Examples > OTAWebUpdater.ino
24+
- Update ssid and pass in the sketch so the module can join your Wi-Fi network
25+
- Open File > Preferences, look for “Show verbose output during:” and check out “compilation” option
26+
27+
![verbrose](esp32verbose.PNG)
28+
29+
- Upload sketch (Ctrl+U)
30+
- Now open web browser and enter the url, i.e. http://ESP32.local. Once entered, browser should display a form
31+
32+
![login](esp32login.PNG)
33+
34+
> username= admin
35+
36+
> password= admin
37+
38+
**Note**-*If entering “http://ESP32.local” does not work, try replacing “ESP32” with module’s IP address.This workaround is useful in case the host software installed does not work*.
39+
40+
Now click on Login button and browser will display a upload form
41+
42+
![upload](esp32upload.PNG)
43+
44+
For Uploading the New Firmware you need to provide the Binary File of your Code.
45+
46+
Exporting Binary file of the Firmware (Code)
47+
- Open up the Arduino IDE
48+
- Open up the Code, for Exporting up Binary file
49+
- Now go to Sketch > export compiled Binary
50+
![export](exportTobinary.PNG)
51+
52+
- Binary file is exported to the same Directory where your code is present
53+
54+
Once you are comfortable with this procedure go ahead and modify OTAWebUpdater.ino sketch to print some additional messages, compile it, Export new binary file and upload it using web browser to see entered changes on a Serial Monitor
55+
56+
57+

docs/OTAWebUpdate/esp32login.PNG

12.2 KB
Loading

docs/OTAWebUpdate/esp32upload.PNG

8.83 KB
Loading

docs/OTAWebUpdate/esp32verbose.PNG

13.5 KB
Loading

docs/OTAWebUpdate/exportTobinary.PNG

19 KB
Loading

0 commit comments

Comments
 (0)