You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
@@ -108,93 +106,16 @@ Uploading modules wirelessly from Arduino IDE is intended for the following typi
108
106
109
107
### Application Example
110
108
111
-
Currently there are two software configurations that support OTA updates.
109
+
Instructions below show configuration of OTA on NodeMCU 1.0 (ESP-12E Module) board. You can use any other board assuming that it meets [requirements](#basic-requirements) described above. This instruction is valid for all operating systems supported by Arduino IDE. Screen captures have been made on Windows 7 and you may see small differences (like name of serial port) if you are using Linux and MacOS.
112
110
113
-
-[Classic OTA](#classic-ota-configuration): Arduino IDE 1.6.5 and 1.6.5-947-g39819f0 (of July 23, 2015) version of ESP8266 board support platform package that provides first OTA implementation, yet without support for [ArduinoOTA](https://github.com/esp8266/Arduino/tree/master/libraries/ArduinoOTA) library. This particular configuration soon will be depreciated in favor of new implementation described below.
114
-
115
-
-[ArduinoOTA](#arduinoota-configuration): Arduino IDE 1.6.7 and 2.0.0 version of platform package. Arduino IDE 1.6.7 is the first release that provides support for [ArduinoOTA](https://github.com/esp8266/Arduino/tree/master/libraries/ArduinoOTA) library.
116
-
117
-
For information how to install ESP8266 board support in Arduino IDE please refer to https://github.com/esp8266/Arduino#installing-with-boards-manager. Once installed, it is possible to switch between available versions of platform package using Boards Manager:
118
-
119
-
120
-
121
-
Instructions below demonstrate how to configure both [Classic OTA](#classic-ota-configuration) and [ArduinoOTA](#arduinoota-configuration) using NodeMCU 1.0 (ESP-12E Module) board. You can use other boards assuming that they meet [requirements](#basic-requirements) described above.
122
-
123
-
124
-
#### Classic OTA
125
-
126
-
1. Before you begin, please make sure that you have the following installed:
127
-
- Arduino IDE 1.6.5 and 1.6.5-947-g39819f0 version of platform package,
128
-
-[Python](https://www.python.org/) 2.7 (do not install Python 3.5 that is not supported).
129
-
130
-
2. Now prepare the sketch and configuration for the upload over a serial port.
131
-
- Start Arduino IDE and load sketch DNS_SD_Arduino_OTA.ino available under File > Examples > ESP8266mDNS
**Note:** This sketch is available only for 1.6.5-947-g39819f0 (of July 23, 2015) platform package. It was removed in [#980](https://github.com/esp8266/Arduino/pull/980) from GitHub repository.
135
-
- Update SSID and password in the sketch so the module can join your Wi-Fi network
136
-
137
-
138
-
- Configure upload parameters as below (you may need to adjust configuration if you are using a different module):
139
-
140
-
141
-
3. Upload the sketch (Ctrl+U). Once done, open Serial Monitor (Ctrl+Shift+M) and check if module has joined your Wi-Fi network.
142
-
143
-
144
-
145
-
4. Only if module is connected to network, after a couple of seconds, the esp8266-ota port will show up in Arduino IDE:
146
-
147
-
148
-
149
-
5. Now get ready for your first OTA upload by changing configuration settings as follows:
150
-
151
-
152
-
153
-
**Note:** If you do not see “Upload Using: OTA” option available for “NodeMCU 1.0 (ESP-12E Module)” board, please upload the latest [boards.txt](https://github.com/esp8266/Arduino/blob/master/boards.txt) file from GitHub repository, replace existing file and restart Arduino IDE.
154
-
155
-
6. If you have successfully completed all the above steps, you can upload (Ctrl+U) the same (or any other) sketch over OTA:
**Note:** To be able to upload your sketch over and over again using OTA, you need to embed OTA routines inside. Please use DNS_SD_Arduino_OTA.ino as an example.
160
-
161
-
In case of issues please refer to information provided in section [Troubleshooting](#troubleshooting). Successful OTA process looks like below on serial terminal:
**Note:** Sketch and free memory sizes as well as IP addresses depend on your particular s/w and h/w configuration.
187
-
188
-
189
-
#### ArduinoOTA
190
-
191
-
1. Before you begin, please make sure that you have the following installed:
192
-
- Arduino IDE 1.6.7 and 2.0.0 version of platform package following the process described under https://github.com/esp8266/Arduino#installing-with-boards-manager
193
-
-[Python](https://www.python.org/) 2.7 (do not install Python 3.5 that is not supported):
111
+
1. Before you begin, please make sure that you have the following s/w installed:
112
+
- Arduino IDE 1.6.7 or newer - https://www.arduino.cc/en/Main/Software
113
+
- esp8266/Arduino platform package 2.0.0 or newer - for instructions follow https://github.com/esp8266/Arduino#installing-with-boards-manager
114
+
- Python 2.7 (do not install Python 3.5 that is not supported) - https://www.python.org/
194
115
195
116
**Note:** Windows users should select “Add python.exe to Path” (see below – this option is not selected by default).
196
117
197
-
118
+
198
119
199
120
2. Now prepare the sketch and configuration for the upload over a serial port.
200
121
- Start Arduino IDE and load sketch BasicOTA.ino available under File > Examples > ArduinoOTA
@@ -206,21 +127,23 @@ IP address: 192.168.1.100
206
127
- Configure upload parameters as below (you may need to adjust configuration if you are using a different module):
207
128
208
129
130
+
**Note:** Depending on version of platform package and board you have, you may see ``` Upload Using: ``` in the menu above. This option is inactive and it does not matter what you select. It has been left for compatibility with older implementation of OTA and is targeted for removal in platform package version 2.2.0.
131
+
209
132
3. Upload the sketch (Ctrl+U). Once done, open Serial Monitor (Ctrl+Shift+M) and check if module has joined your Wi-Fi network:
210
133
211
134
212
135
213
-
4. Only if module is connected to network, after a couple of seconds, the esp8266-ota port will show up in Arduino IDE:
136
+
4. Only if module is connected to network, after a couple of seconds, the esp8266-ota port will show up in Arduino IDE. Select port with IP adress shown in Serial Monitor in previus step:
214
137
215
138
216
139
217
-
**Note:** If OTA port does not show up, try to exit Arduino IDE, open it again and check if port is there.
140
+
**Note:** If OTA port does not show up, exit Arduino IDE, open it again and check if port is there. If it does not help check your firewall settings.
218
141
219
142
5. Now get ready for your first OTA upload by selecting the OTA port:
220
143
221
144
222
145
223
-
There is no need to change ``` Upload Using: ```or ``` Upload Speed: ```.
146
+
**Note:** The menu entry ``` Upload Speed: ```does not matter at this point as it concerns the serial port. Just left it unchanged.
224
147
225
148
6. If you have successfully completed all the above steps, you can upload (Ctrl+U) the same (or any other) sketch over OTA:
226
149
@@ -267,7 +190,7 @@ When uploading, Arduino IDE used previously entered password, so the upload fail
267
190
268
191
If OTA update fails, first step is to check for error messages that may be shown in upload window of Arduino IDE. If this is not providing any useful hints try to upload again while checking what is shown by ESP on serial port. Serial Monitor from IDE will not be useful in that case. When attempting to open it, you will likely see the following:
269
192
270
-
193
+
271
194
272
195
This window is for Arduino Yún and not yet implemented for esp8266/Arduino. It shows up because IDE is attempting to open Serial Monitor using network port you have selected for OTA upload.
273
196
@@ -285,11 +208,11 @@ If upload fails you will likely see errors caught by the uploader, exception and
285
208
286
209
The most common causes of OTA failure are as follows:
287
210
* not enough physical memory on the chip (e.g. ESP01 with 512K flash memory is not enough for OTA),
288
-
* too much memory declared for SPIFFS so new sketch will not fit between existing sketch and SPIFFS – see [Update process - memory view](https://github.com/esp8266/Arduino/blob/master/doc/ota_updates/ota_updates.md#update-process---memory-view),
211
+
* too much memory declared for SPIFFS so new sketch will not fit between existing sketch and SPIFFS – see [Update process - memory view](#update-process---memory-view),
289
212
* too little memory declared in Arduino IDE for your selected board (i.e. less than physical size).
290
213
291
214
For more details regarding flash memory layout please check [File system](https://github.com/esp8266/Arduino/blob/master/doc/filesystem.md).
292
-
For overview where new sketch is stored, how it is copied and how memory is organized for the purpose of OTA see [Update process - memory view](https://github.com/esp8266/Arduino/blob/master/doc/ota_updates/ota_updates.md#update-process---memory-view).
215
+
For overview where new sketch is stored, how it is copied and how memory is organized for the purpose of OTA see [Update process - memory view](#update-process---memory-view).
0 commit comments