Skip to content

Commit c084203

Browse files
Giuseppe Lumiapolldo
Giuseppe Lumia
authored andcommitted
Improve README.md
1 parent 56a1e79 commit c084203

File tree

1 file changed

+6
-5
lines changed

1 file changed

+6
-5
lines changed

Diff for: README.md

+6-5
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
# iot-cloud-cli
22

3-
iot-cloud-cli is a command line interface that allows to exploit the features of Arduino IoT Cloud. As of now, it is possible to provision a device and to simulate a device to be connected to the cloud using MQTT for thoubleshooting purpose.
3+
iot-cloud-cli is a command line interface that allows to exploit the features of Arduino IoT Cloud. As of now, it is possible to provision a device and to simulate a device to be connected to the cloud using MQTT for troubleshooting purposes.
44

55
### Requirements
66

77
This is all you need to use iot-cloud-cli for device **provisioning**:
88
* A client ID and a secret ID, retrievable from the [cloud](https://create.arduino.cc/iot/integrations) by creating a new API key
9-
* arduino-cli in daemon mode, use the command 'arduino-cli daemon'
9+
* arduino-cli in daemon mode, to start it use the command 'arduino-cli daemon'
1010

1111
This is all you need to use iot-cloud-cli as a **virtual device**:
1212
* A "Generic ESP8266 Module" or "Generic ESP32 Module" device in IoT Cloud (requires a Maker plan)
@@ -15,7 +15,7 @@ This is all you need to use iot-cloud-cli as a **virtual device**:
1515

1616
## Set a configuration
1717

18-
iot-cloud-cli should be configured before being used. In particular a client ID and the corresponding secret ID should be set.
18+
iot-cloud-cli needs to be configured before being used. In particular a client ID and the corresponding secret ID should be set.
1919
You can retrieve them from the [cloud](https://create.arduino.cc/iot/integrations) by creating a new API key.
2020

2121
Once you have the IDs, call this command with your parameters:
@@ -24,7 +24,8 @@ Once you have the IDs, call this command with your parameters:
2424

2525
## Device provisioning
2626

27-
When provisioning a device, you can optionally explicit the port which the device is connected to and its fqbn. If they are not given, then the first device found is provisioned.
27+
When provisioning a device, you can optionally specify the port to which the device is connected to and its fqbn. If they are not given, then the first device found will be provisioned.
28+
2829
Use this command to provision a device:
2930

3031
`$ iot-cloud-cli device create --name <deviceName> --port <port> --fqbn <deviceFqbn>`
@@ -51,7 +52,7 @@ $ iot-cloud-cli ping -u "<deviceId>" -p "<secret>" -t <thing ID>>
5152
* Select "ESP8266".
5253
* From the drop down select "Generic ESP8266 Module", and click "Continue".
5354
* Pick a nice and friendly device name.
54-
* Save the "Device ID" and "Secret Key" is a safe place, because you will not be able to see them anymore.
55+
* Save the "Device ID" and "Secret Key" in a safe place (1Password, KeepassXC, a piece of paper in your vault) , because you will not be able to see them anymore.
5556

5657
#### Thing ID
5758

0 commit comments

Comments
 (0)