Skip to content

Commit ddf1541

Browse files
committed
Extend README with better instructions for how to perform OTA via cloud server
1 parent 236f744 commit ddf1541

File tree

1 file changed

+17
-6
lines changed

1 file changed

+17
-6
lines changed

Diff for: extras/tools/README.md

+17-6
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,18 @@
1-
`bin2ota.py`
2-
============
1+
Firmware Over-The-Air Tools
2+
===========================
3+
4+
## How-to-OTA
5+
6+
Arduino IDE: `Sketch` -> `Export compiled Binary`
7+
```bash
8+
cp sketch.bin ~/Arduino/libraries/ArduinoIoTCloud/extras/tools/
9+
cd ~/Arduino/libraries/ArduinoIoTCloud/extras/tools
10+
./bin2ota.py sketch.bin sketch.ota
11+
./bin2json.py sketch.ota sketch.json
12+
./ota-upload.sh CLIENT_ID CLIENT_SECRET DEVICE_ID sketch.json
13+
```
14+
15+
## `bin2ota.py`
316
This tool can be used to extend (actually prefix) a binary generated with e.g. the Arduino IDE with the required length and crc values required to perform an OTA (Over-The-Air) update of the firmware.
417

518
### How-To-Use
@@ -25,17 +38,15 @@ This tool can be used to extend (actually prefix) a binary generated with e.g. t
2538
0000030 0000 0000 7485 0000 0000 0000 0000 0000
2639
```
2740

28-
`bin2json.py`
29-
=============
41+
## `bin2json.py`
3042
This tool converts the binary file into base64 encoded JSON which is necessary for feeding it to the server.
3143

3244
### How-To-Use
3345
```bash
3446
./bin2json.py sketch.ota sketch.json
3547
```
3648

37-
`ota-upload.sh`
38-
==============
49+
## `ota-upload.sh`
3950
This tool allows to upload a OTA binary to a device via a Arduino cloud server.
4051

4152
### How-To-Use

0 commit comments

Comments
 (0)