Skip to content

Commit 4b7b489

Browse files
committed
Harmonizing OTA tool usage description
1 parent a51b09e commit 4b7b489

File tree

4 files changed

+7
-7
lines changed

4 files changed

+7
-7
lines changed

extras/tools/README.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ This tool can be used to extend (actually prefix) a binary generated with e.g. t
44

55
### How-To-Use
66
```bash
7-
./bin2ota.py sketch.bin sketch-ota.bin
7+
./bin2ota.py sketch.bin sketch.ota
88
```
99
#### `sketch.bin`
1010
```bash
@@ -17,7 +17,7 @@ This tool can be used to extend (actually prefix) a binary generated with e.g. t
1717
* `length(sketch.bin) = 0x0003'A5E0`
1818
* `CRC32(sketch.bin) = 0xA9D1'265B`
1919

20-
#### `sketch-ota.bin`
20+
#### `sketch.ota`
2121
```bash
2222
0000000 A5E0 0003 265B A9D1 8000 2000 749D 0000
2323
0000010 7485 0000 7485 0000 0000 0000 0000 0000
@@ -31,7 +31,7 @@ This tool converts the binary file into base64 encoded JSON which is necessary f
3131

3232
### How-To-Use
3333
```bash
34-
./bin2json.py sketch-ota.bin sketch-ota.json
34+
./bin2json.py sketch.ota sketch.json
3535
```
3636

3737
`ota-upload.sh`
@@ -40,5 +40,5 @@ This tool allows to upload a OTA binary to a device via a Arduino cloud server.
4040

4141
### How-To-Use
4242
```bash
43-
./ota-upload.sh CLIENT_ID CLIENT_SECRET DEVICE_ID sketch-ota.json
43+
./ota-upload.sh CLIENT_ID CLIENT_SECRET DEVICE_ID sketch.json
4444
```

extras/tools/bin2json.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
INTER_CHUNK_DELAY_MS = 250 # This is delay between 2 consecutive chunks so as to not over load the embedded device.
99

1010
if len(sys.argv) != 3:
11-
print ("Usage: bin2json.py sketch-ota.bin sketch-ota.json")
11+
print ("Usage: bin2json.py sketch.ota sketch.json")
1212
sys.exit()
1313

1414
ifile = sys.argv[1]

extras/tools/bin2ota.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
import crccheck
55

66
if len(sys.argv) != 3:
7-
print ("Usage: bin2ota.py sketch.bin sketch-ota.bin")
7+
print ("Usage: bin2ota.py sketch.bin sketch.ota")
88
sys.exit()
99

1010
ifile = sys.argv[1]

extras/tools/ota-upload.sh

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
#!/bin/bash
22

33
if [ "$#" -ne 4 ]; then
4-
echo "Usage: ota-upload.sh CLIENT_ID CLIENT_SECRET DEVICE_ID sketch-ota.base64"
4+
echo "Usage: ota-upload.sh CLIENT_ID CLIENT_SECRET DEVICE_ID sketch.json"
55
exit 1
66
fi
77

0 commit comments

Comments
 (0)