Skip to content

Commit 652cff9

Browse files
pedrominatelpedrominatel
committed
Added OTA Web Update to the docs and removed from md files
1 parent 8ad3113 commit 652cff9

21 files changed

+120
-78
lines changed

‎docs/OTAWebUpdate/OTAWebUpdate.md

Lines changed: 0 additions & 59 deletions
This file was deleted.

‎docs/source/_static/linux-logo.png renamed to ‎docs/source/_static/logo_linux.png

File renamed without changes.

‎docs/source/_static/macos-logo.png renamed to ‎docs/source/_static/logo_macos.png

File renamed without changes.

‎docs/source/_static/windows-logo.png renamed to ‎docs/source/_static/logo_windows.png

File renamed without changes.

‎docs/OTAWebUpdate/esp32login.PNG renamed to ‎docs/source/_static/ota_esp32_login.png

File renamed without changes.

‎docs/OTAWebUpdate/esp32upload.PNG renamed to ‎docs/source/_static/ota_esp32_upload.png

File renamed without changes.

‎docs/OTAWebUpdate/esp32verbose.PNG renamed to ‎docs/source/_static/ota_esp32_verbose.png

File renamed without changes.

‎docs/OTAWebUpdate/exportTobinary.PNG renamed to ‎docs/source/_static/ota_export_to_binary.png

File renamed without changes.

‎docs/source/api/deepsleep.rst

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
##########
2+
Deep Sleep
3+
##########

‎docs/source/api/espnow.rst

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
######
2+
ESPNOW
3+
######

‎docs/source/api/gpio.rst

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
####
2+
GPIO
3+
####

‎docs/source/api/rainmaker.rst

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
#########
2+
RainMaker
3+
#########

‎docs/source/api/reset_reason.rst

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
############
2+
Reset Reason
3+
############

‎docs/source/boards/ESP32-DevKitC-1.rst

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -117,6 +117,8 @@ IO15 Pull-up Enabling/Disabling Log Print During Booting and Timing of SDIO
117117
IO5 Pull-up Timing of SDIO Slave See `ESP32`_ See `ESP32`_
118118
==== ========= ===================================================================== ============ ==============
119119

120+
Be aware when choosing those pins to use.
121+
120122
Restricted Usage GPIO's
121123
-----------------------
122124

@@ -138,10 +140,10 @@ Other GPIO's are `INPUT ONLY` and cannot be used as output pin:
138140
==== =========================
139141
GPIO Function
140142
==== =========================
141-
IO36 GPIO36, ADC1_CH0, S_VP
142-
IO39 GPIO39, ADC1_CH3, S_VN
143143
IO34 GPIO34, ADC1_CH6, VDET_1
144144
IO35 GPIO35, ADC1_CH7, VDET_2
145+
IO36 GPIO36, ADC1_CH0, S_VP
146+
IO39 GPIO39, ADC1_CH3, S_VN
145147
==== =========================
146148

147149
Resources

‎docs/source/getting_started.rst

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -49,9 +49,9 @@ Supported Operating Systems
4949
| Windows | Linux | macOS |
5050
+-------------------+-------------------+-------------------+
5151

52-
.. |windows-logo| image:: _static/windows-logo.png
53-
.. |linux-logo| image:: _static/linux-logo.png
54-
.. |macos-logo| image:: _static/macos-logo.png
52+
.. |windows-logo| image:: _static/logo_windows.png
53+
.. |linux-logo| image:: _static/logo_linux.png
54+
.. |macos-logo| image:: _static/logo_macos.png
5555

5656
Support
5757
*******
@@ -93,15 +93,15 @@ Installing
9393

9494
To install Arduino-ESP32, please see the dedicated section on the Installation guide. We recommend you to install using the boards manager.
9595

96-
`Installing <installing>`_
96+
`Installing <installing.html>`_
9797

9898
Examples
9999
********
100100

101101
After installing the toolchain into your environment, you will be able to see all dedicated examples for the ESP32. Those examples are located
102102
in the examples menu or by the `examples` folder inside each `libraries`.
103103

104-
https://github.com/espressif/arduino-esp32/tree/master/libraries
104+
https://github.com/espressif/arduino-esp32/tree/master/libraries
105105

106106
Development Boards
107107
------------------

‎docs/source/index.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ Welcome to ESP32 Arduino Core's documentation
1010
Installing <installing>
1111
Boards <boards/boards>
1212
Libraries <libraries>
13+
Tutorials <tutorials/tutorials>
1314
Library Builder <lib_builder>
1415
ESP-IDF as Component <esp-idf_component>
1516
OTA Web Update <ota_web_update>

‎docs/source/installing.rst

Lines changed: 3 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -89,14 +89,12 @@ Steps to install Arduino ESP32 support on Windows
8989

9090
.. figure:: _static/win-gui-2.png
9191
:align: center
92-
:width: 600
9392
:figclass: align-center
9493

9594
**Step 3**
9695

9796
.. figure:: _static/win-gui-3.png
9897
:align: center
99-
:width: 600
10098
:figclass: align-center
10199

102100
- open a `Git Bash` session pointing to ```[ARDUINO_SKETCHBOOK_DIR]/hardware/espressif/esp32``` and execute ```git submodule update --init --recursive```
@@ -106,7 +104,6 @@ Steps to install Arduino ESP32 support on Windows
106104

107105
.. figure:: _static/win-gui-4.png
108106
:align: center
109-
:width: 600
110107
:figclass: align-center
111108

112109
- When ```get.exe``` finishes, you should see the following files in the directory
@@ -115,7 +112,6 @@ Steps to install Arduino ESP32 support on Windows
115112

116113
.. figure:: _static/win-gui-5.png
117114
:align: center
118-
:width: 600
119115
:figclass: align-center
120116

121117
1. Plug your ESP32 board and wait for the drivers to install (or install manually any that might be required)
@@ -126,7 +122,6 @@ Steps to install Arduino ESP32 support on Windows
126122

127123
.. figure:: _static/arduino-ide.png
128124
:align: center
129-
:width: 600
130125
:figclass: align-center
131126

132127
How to update to the latest code
@@ -136,22 +131,19 @@ How to update to the latest code
136131

137132
.. figure:: _static/win-gui-update-1.png
138133
:align: center
139-
:width: 600
140134
:figclass: align-center
141135

142-
2. From menu ```Remote``` select ```Fetch from``` > ```origin```
136+
1. From menu ```Remote``` select ```Fetch from``` > ```origin```
143137

144138
.. figure:: _static/win-gui-update-2.png
145139
:align: center
146-
:width: 600
147140
:figclass: align-center
148141

149-
3. Wait for git to pull any changes and close ```Git GUI```
150-
4. Open ```[ARDUINO_SKETCHBOOK_DIR]/hardware/espressif/esp32/tools``` and double-click ```get.exe```
142+
1. Wait for git to pull any changes and close ```Git GUI```
143+
2. Open ```[ARDUINO_SKETCHBOOK_DIR]/hardware/espressif/esp32/tools``` and double-click ```get.exe```
151144

152145
.. figure:: _static/win-gui-4.png
153146
:align: center
154-
:width: 600
155147
:figclass: align-center
156148

157149
Linux

‎docs/source/libraries.rst

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,5 +6,10 @@ Libraries
66
:maxdepth: 2
77
:caption: Espressif Boards:
88

9-
Wi-Fi <api/wifi>
109
Bluetooth <api/bluetooth>
10+
Deep Sleep <api/deepsleep>
11+
ESPNOW <api/espnow>
12+
GPIO <api/gpio>
13+
RainMaker <api/rainmaker>
14+
Reset Reason <api/reset_reason>
15+
Wi-Fi <api/wifi>

‎docs/source/ota_web_update.rst

Lines changed: 73 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,76 @@
11
##############
22
OTA Web Update
33
##############
4+
5+
OTAWebUpdate is done with a web browser that can be useful in the following typical scenarios:
6+
7+
- Once the application developed and loading directly from Arduino IDE is inconvenient or not possible
8+
- after deployment if user is unable to expose Firmware for OTA from external update server
9+
- provide updates after deployment to small quantity of modules when setting an update server is not practicable
10+
11+
Requirements
12+
------------
13+
14+
- The ESP and the computer must be connected to the same network
15+
16+
Implementation
17+
--------------
18+
19+
The sample implementation has been done using:
20+
21+
- Example sketch ```OTAWebUpdater.ino```.
22+
- ESP32 Board.
23+
24+
You can use another module also if it meets Flash chip size of the sketch
25+
26+
Before you begin, please make sure that you have the following software installed:
27+
28+
- Arduino IDE
29+
- Host software depending on O/S you use
30+
- `Avahi <http://avahi.org/>`_ for Linux
31+
- `Bonjour <http://www.apple.com/support/bonjour/>`_ for Windows
32+
- Mac OSX and iOS - support is already built in / no any extra s/w is required
33+
34+
Prepare the sketch and configuration for initial upload with a serial port
35+
- Start Arduino IDE and load sketch OTAWebUpdater.ino available under File > Examples > OTAWebUpdater.ino
36+
- Update ssid and pass in the sketch so the module can join your Wi-Fi network
37+
- Open File > Preferences, look for “Show verbose output during:” and check out “compilation” option
38+
39+
.. figure:: _static/ota_esp32_verbose.png
40+
:align: center
41+
:figclass: align-center
42+
43+
- Upload sketch (Ctrl+U)
44+
- Now open web browser and enter the url, i.e. http://esp32.local. Once entered, browser should display a form
45+
46+
.. figure:: _static/ota_esp32_login.png
47+
:align: center
48+
:figclass: align-center
49+
50+
* username = admin
51+
52+
* password = admin
53+
54+
.. note::
55+
*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*.
56+
57+
Now click on Login button and browser will display a upload form
58+
59+
.. figure:: _static/ota_esp32_upload.png
60+
:align: center
61+
:figclass: align-center
62+
63+
For Uploading the New Firmware you need to provide the Binary File of your Code.
64+
65+
Exporting Binary file of the Firmware (Code)
66+
- Open up the Arduino IDE
67+
- Open up the Code, for Exporting up Binary file
68+
- Now go to Sketch > export compiled Binary
69+
70+
.. figure:: _static/ota_export_to_binary.png
71+
:align: center
72+
:figclass: align-center
73+
74+
- Binary file is exported to the same Directory where your code is present
75+
76+
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

‎docs/source/tutorials/basic.rst

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
#########
2+
Tutorials
3+
#########

‎docs/source/tutorials/tutorials.rst

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
#########
2+
Tutorials
3+
#########
4+
5+
.. toctree::
6+
:maxdepth: 2
7+
:caption: Tutorials:
8+
9+
Basic <basic>
10+

0 commit comments

Comments
 (0)