Skip to content

Commit 14eb8d3

Browse files
authored
Update ota.rst (#1592)
Spelling mistakes and grammatical corrections
1 parent 4c90b29 commit 14eb8d3

File tree

1 file changed

+9
-9
lines changed

1 file changed

+9
-9
lines changed

docs/ota.rst

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -90,7 +90,7 @@ Signing requires the generation of an RSA-2048 key (other bit lengths are suppor
9090
Automatic Signing
9191
^^^^^^^^^^^^^^^^^
9292

93-
The simplest way of implementing signing is to use the automatic mode, which presently is only possible on Linux and Mac due to some of the tools not being available for Windows. This mode uses the IDE to configure the source code to enable sigining verification with a given public key, and signs binaries as part of the standard build process using a given public key.
93+
The simplest way of implementing signing is to use the automatic mode, which presently is only possible on Linux and Mac due to some of the tools not being available for Windows. This mode uses the IDE to configure the source code to enable signing verification with a given public key, and signs binaries as part of the standard build process using a given public key.
9494

9595
To enable this mode, just include `private.key` and `public.key` in the sketch `.ino` directory. The IDE will call a helper script (`tools/signing.py`) before the build begins to create a header to enable key validation using the given public key, and to actually do the signing after the build process, generating a `sketch.bin.signed` file. When OTA is enabled (ArduinoOTA, Web, or HTTP), the binary will automatically only accept signed updates.
9696

@@ -144,7 +144,7 @@ The eboot bootloader incorporates a GZIP decompressor, built for very low code r
144144

145145
No changes to the application are required. The `Updater` class and `eboot` bootloader (which performs actual application overwriting on update) automatically search for the `gzip` header in the uploaded binary, and if found, handle it.
146146

147-
Compress an application `.bin` file or filesystem package using any `gzip` available, at any desired compression level (`gzip -9` is recommended because it provides the maximum compression and uncompresses as fast as any other compressino level). For example:
147+
Compress an application `.bin` file or filesystem package using any `gzip` available, at any desired compression level (`gzip -9` is recommended because it provides the maximum compression and uncompresses as fast as any other compression level). For example:
148148

149149
.. code:: bash
150150
@@ -185,11 +185,11 @@ Uploading modules wirelessly from Arduino IDE is intended for the following typi
185185

186186
- Only if modules are accessible on the same network as the computer with the Arduino IDE.
187187

188-
- For all IDE uploads,m the Pico W and the computer must be connected to the same network.
188+
- For all IDE uploads, the Pico W and the computer must be connected to the same network.
189189

190190
To upload wirelessly from the IDE:
191191

192-
1. Build a sketch starts ``WiFi`` and includes the appropriare calls to ``ArduinoOTA`` (see the examples for reference). These include the ``ArduinoOTA.begin()`` call in ``setup()`` and periodically calling ``ArduinoOTA.handle();`` from the ``loop()``
192+
1. Build a sketch starts ``WiFi`` and includes the appropriate calls to ``ArduinoOTA`` (see the examples for reference). These include the ``ArduinoOTA.begin()`` call in ``setup()`` and periodically calling ``ArduinoOTA.handle();`` from the ``loop()``
193193

194194
2. Upload using standard USB connection the first time.
195195

@@ -200,19 +200,19 @@ To upload wirelessly from the IDE:
200200
Password Protection
201201
-------------------
202202

203-
Protecting your OTA uploads with password is really straightforward. All you need to do, is to include the following statement in your code:
203+
Protecting your OTA uploads with a password is really straightforward. All you need to do, is to include the following statement in your code:
204204

205205
.. code:: cpp
206206
207207
ArduinoOTA.setPassword((const char *)"123");
208208
209209
Where ``123`` is a sample password that you should replace with your own.
210210

211-
Before implementing it in your sketch, it is a good idea to check how it works using *BasicOTA.ino* sketch available under *File > Examples > ArduinoOTA*. Go ahead, open *BasicOTA.ino*, uncomment the above statement that is already there, and upload the sketch. To make troubleshooting easier, do not modify example sketch besides what is absolutely required. This is including original simple ``123`` OTA password. Then attempt to upload sketch again (using OTA). After compilation is complete, once upload is about to begin, you should see prompt for password.
211+
Before implementing it in your sketch, it is a good idea to check how it works using *BasicOTA.ino* sketch available under *File > Examples > ArduinoOTA*. Go ahead, open *BasicOTA.ino*, uncomment the above statement that is already there, and upload the sketch. To make troubleshooting easier, do not modify example sketch besides what is absolutely required. This includes the original simple ``123`` OTA password. Then attempt to upload a sketch again (using OTA). After compilation is complete, once upload is about to begin, you should see a prompt for password.
212212

213-
Enter the password and upload should be initiated as usual with the only difference being ``Authenticating...OK`` message visible in upload log.
213+
Enter the password and upload should be initiated as usual with the only difference being ``Authenticating...OK`` message visible in the upload log.
214214

215-
You will not be prompted for a reentering the same password next time. Arduino IDE will remember it for you. You will see prompt for password only after reopening IDE, or if you change it in your sketch, upload the sketch and then try to upload it again.
215+
You will not be prompted for a reentering the same password next time. Arduino IDE will remember it for you. You will see a prompt for password only after reopening IDE, or if you change it in your sketch, upload the sketch and then try to upload it again.
216216

217217
Please note, it is possible to reveal password entered previously in Arduino IDE, if IDE has not been closed since last upload. This can be done by enabling *Show verbose output during: upload* in *File > Preferences* and attempting to upload the module.
218218

@@ -289,7 +289,7 @@ Simple updater downloads the file every time the function is called.
289289
Advanced updater
290290
^^^^^^^^^^^^^^^^
291291

292-
Its possible to point the update function to a script on the server. If a version string argument is given, it will be sent to the server. The server side script can use this string to check whether an update should be performed.
292+
It's possible to point the update function to a script on the server. If a version string argument is given, it will be sent to the server. The server side script can use this string to check whether an update should be performed.
293293

294294
The server-side script can respond as follows: - response code 200, and send the firmware image, - or response code 304 to notify Pico that no update is required.
295295

0 commit comments

Comments
 (0)