Skip to content

Commit c21146b

Browse files
committed
README update
1 parent d92415f commit c21146b

File tree

1 file changed

+47
-2
lines changed

1 file changed

+47
-2
lines changed

README.md

Lines changed: 47 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -114,6 +114,8 @@ Here are the FQBNs of the Arduino boards that can be provisioned with this comma
114114
* `arduino:samd:mkrnb1500`
115115
* `arduino:mbed_opta:opta`
116116
* `arduino:mbed_giga:giga`
117+
* `arduino:esp32:nano_nora`
118+
* `arduino:renesas_uno:unor4wifi`
117119

118120
If the device supports more than one connectivity type (Eg: WiFi and Ethernet) the --connection flag can be used to set the desired connectivity
119121

@@ -327,10 +329,17 @@ Note that the binary file (`.bin`) should be compiled using an arduino core that
327329
arduino-cloud-cli ota upload --device-id <deviceID> --file <sketch-file.ino.bin>
328330
```
329331

330-
The default OTA upload should complete in 10 minutes. Use `--deferred` flag to extend this time to one week (see an example sketch [here](https://github.com/arduino-libraries/ArduinoIoTCloud/blob/ab0af75a5666f875929029ac6df59e04789269c5/examples/ArduinoIoTCloud-DeferredOTA/ArduinoIoTCloud-DeferredOTA.ino)):
332+
This schedule a new OTA. Its ID is printed as output.
333+
It is possible to check status for scheduled/executed OTAs using status command.
331334

332335
```bash
333-
arduino-cloud-cli ota upload --device-id <deviceID> --file <sketch-file.ino.bin> --deferred
336+
arduino-cloud-cli ota status --ota-id <otaID>
337+
```
338+
339+
or by device
340+
341+
```bash
342+
arduino-cloud-cli ota status --device-id <deviceID>
334343
```
335344

336345
### Mass upload
@@ -383,3 +392,39 @@ Create a dashboard: dashboards can be created only starting from a template. Sup
383392
```bash
384393
arduino-cloud-cli dashboard create --name <dashboardName> --template <template.(json|yaml)> --override <thing-0>=<actualThingID>,<thing-1>=<otherActualThingID>
385394
```
395+
396+
## Custom templates
397+
398+
### List custom templates
399+
400+
Use following command to list available custom templates
401+
402+
```bash
403+
arduino-cloud-cli template list
404+
```
405+
406+
### Export custom template
407+
408+
Given list command, it is possible to get custom template ID. Given its ID, use following command to export it as '.tino' archive:
409+
410+
```bash
411+
arduino-cloud-cli template export -t <templateID>
412+
```
413+
414+
it is possible to specify output directory with '-d' flag
415+
416+
### Import custom template
417+
418+
To import a custom template, use command:
419+
420+
```bash
421+
arduino-cloud-cli template import -f <template .tino archive>
422+
```
423+
424+
### Template apply
425+
426+
It is possible to apply a given template to a device. Apply will generate required resources. Configure device connectivity using '-n' option (see --help for further details).
427+
428+
```bash
429+
arduino-cloud-cli template apply -d <deviceID> -t <templateID> -p "<name prefix>" -n SECRET_SSID=<ssid>,SECRET_OPTIONAL_PASS=<pwd>
430+
```

0 commit comments

Comments
 (0)