Skip to content

Commit e73f38b

Browse files
committed
fix(pre-commit): Fix spelling
1 parent 6a76274 commit e73f38b

File tree

3 files changed

+15
-5
lines changed

3 files changed

+15
-5
lines changed

libraries/ArduinoOTA/examples/SignedOTA/README.md

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,9 @@ Even if an attacker gains access to your network, they **cannot** install unsign
2626

2727
- **ESP32 Arduino Core 3.3.0+**
2828
- **Python 3.6+** with `cryptography` library
29+
<!-- vale Espressif-latest.Units = NO -->
2930
- **OTA-capable partition scheme** (e.g., "Minimal SPIFFS (1.9MB APP with OTA)")
31+
<!-- vale Espressif-latest.Units = YES -->
3032

3133
## Quick Start Guide
3234

@@ -52,13 +54,17 @@ python bin_signing.py --extract-pubkey private_key.pem --out public_key.pem
5254

5355
1. Copy `public_key.h` (generated in step 1) to this sketch directory
5456
2. Open `SignedOTA.ino` in Arduino IDE
57+
<!-- vale Espressif-latest.TermsSingleCorrectSpelling = NO -->
5558
3. Configure WiFi credentials:
5659
```cpp
5760
const char *ssid = "YourWiFiSSID";
5861
const char *password = "YourWiFiPassword";
5962
```
63+
<!-- vale Espressif-latest.TermsSingleCorrectSpelling = YES -->
64+
<!-- vale Espressif-latest.Units = NO -->
6065
4. Select appropriate partition scheme:
6166
- **Tools → Partition Scheme → "Minimal SPIFFS (1.9MB APP with OTA)"**
67+
<!-- vale Espressif-latest.Units = YES -->
6268

6369
### 3. Upload Initial Firmware
6470

@@ -189,9 +195,11 @@ const char *ota_password = "yourpassword"; // Set password
189195
**Cause**: Signature verification setup failed, or partition scheme issue
190196

191197
**Solutions**:
198+
<!-- vale Espressif-latest.Units = NO -->
192199
1. Check partition scheme (use "Minimal SPIFFS (1.9MB APP with OTA)")
193200
2. Verify `public_key.h` is in the sketch directory
194201
3. Check hash and signature algorithm match your key type
202+
<!-- vale Espressif-latest.Units = YES -->
195203

196204
### "End Failed" Error
197205

@@ -208,7 +216,7 @@ const char *ota_password = "yourpassword"; // Set password
208216
**Cause**: Network timeout or connection issue
209217

210218
**Solutions**:
211-
1. Check WiFi signal strength
219+
1. Check Wi-Fi signal strength
212220
2. Ensure device is reachable on the network
213221
3. Try increasing timeout: `ArduinoOTA.setTimeout(5000)`
214222

@@ -219,7 +227,7 @@ const char *ota_password = "yourpassword"; // Set password
219227
**Solutions**:
220228
1. Verify device is on the same network
221229
2. Check firewall settings aren't blocking port 3232
222-
3. Ensure WiFi signal strength is adequate
230+
3. Ensure Wi-Fi signal strength is adequate
223231
4. If using password protection, ensure the password is correct
224232
5. Try: `python <ARDUINO_ROOT>/tools/espota.py -i <device-ip> -f firmware_signed.bin -d`
225233

@@ -242,10 +250,12 @@ const char *ota_password = "yourpassword"; // Set password
242250

243251
### What This Does NOT Protect Against
244252

253+
<!-- vale Espressif-latest.Cursing = NO -->
245254
- ❌ Physical access (USB flashing still works)
246255
- ❌ Downgrade attacks (no version checking by default)
247256
- ❌ Replay attacks (no timestamp/nonce by default)
248257
- ❌ Key compromise (if private key is stolen)
258+
<!-- vale Espressif-latest.Cursing = YES -->
249259

250260
### Additional Security
251261

libraries/Update/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ The Update library provides functionality for Over-The-Air (OTA) firmware update
44

55
## Features
66

7-
- **OTA Updates**: Update firmware over WiFi
7+
- **OTA Updates**: Update firmware over Wi-Fi
88
- **Signature Verification**: RSA and ECDSA signature verification for secure updates (optional, must be enabled with `UPDATE_SIGN`)
99
- **Image Encryption**: Support for encrypted firmware updates (optional, can be disabled with `UPDATE_NOCRYPT`)
1010
- **Multiple Sources**: HTTP, HTTPS, SD card, and custom sources

libraries/Update/examples/Signed_OTA_Update/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ Where `<ARDUINO_ROOT>` is your ESP32 Arduino installation path (e.g., `~/Arduino
4747

4848
1. Copy the generated `public_key.h` to the example directory
4949
2. Open `Signed_OTA_Update.ino`
50-
3. Update WiFi credentials:
50+
3. Update Wi-Fi credentials:
5151
```cpp
5252
const char *ssid = "YOUR_SSID";
5353
const char *password = "YOUR_PASSWORD";
@@ -88,7 +88,7 @@ Upload `firmware_signed.bin` to your web server and make it accessible at the UR
8888
### Step 6: Perform OTA Update
8989

9090
Reset your ESP32. It will:
91-
1. Connect to WiFi
91+
1. Connect to Wi-Fi
9292
2. Download the signed firmware
9393
3. Verify the signature
9494
4. Apply the update if signature is valid

0 commit comments

Comments
 (0)