Skip to content

Latest commit

 

History

History
101 lines (67 loc) · 3.72 KB

README.md

File metadata and controls

101 lines (67 loc) · 3.72 KB

iot-cloud-cli

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.

Requirements

This is all you need to use iot-cloud-cli for device provisioning:

  • A client ID and a secret ID, retrievable from the cloud by creating a new API key
  • The folder containing the precompiled provisioning firmwares (binaries) needs to be in the same location you run the command from

This is all you need to use iot-cloud-cli as a virtual device:

  • A "Generic ESP8266 Module" or "Generic ESP32 Module" device in IoT Cloud (requires a Maker plan)
  • A thing with a counter property connected to the "Generic ESP8266/ESP32 Module" device

Set a configuration

iot-cloud-cli needs to be configured before being used. In particular a client ID and the corresponding secret ID should be set. You can retrieve them from the cloud by creating a new API key.

Once you have the IDs, call this command with your parameters:

$ iot-cloud-cli config -c <clientID> -s <secretID>

A file named config.yaml will be created in the Current Working Directory containing the login credentials. Example

client: 00112233445566778899aabbccddeeff
secret: 00112233445566778899aabbccddeeffffeeddccbbaa99887766554433221100

Device provisioning

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.

Use this command to provision a device:

$ iot-cloud-cli device create --name <deviceName> --port <port> --fqbn <deviceFqbn>

Use iot-cloud-cli as a virtual device

The iot-cloud-cli can be used as a virtual device for Arduino IoT Cloud for testing.

$ iot-cloud-cli ping -d "<deviceId>" -s "<secret>" -t <thing ID>>
  Connected to Arduino IoT Cloud
  Subscribed true
  Property value sent successfully 81
  Property value sent successfully 87

How to set up the device and thing in IoT Cloud

Device

  • Visit https://create.arduino.cc/iot/devices and select "Add device".
  • Select "Set up a 3rd party device".
  • Select "ESP8266".
  • From the drop down select "Generic ESP8266 Module", and click "Continue".
  • Pick a nice and friendly device name.
  • 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.

Thing ID

  • Visit https://create.arduino.cc/iot/things and select "Create Thing".
  • Select "Add Variable".
  • Give the variable the name "counter", type "Integer Number" and leave the variable permission the value "Read & Write".
  • Press the "Add Variable" button to confirm.
  • Copy the "Thing ID" from the bottom right of the page.

Connect the device and the thing

You should connect the new device to the new thing.

Testing

Connect to the PROD environment
$ iot-cloud-cli ping -d "<Device ID>" -s "<Secret Key>" -t <Thing ID>>

If every works as expected you should see something similar to this output:

Connected to Arduino IoT Cloud
Subscribed true
Property value sent successfully 81
Property value sent successfully 87

If you visit https://create.arduino.cc/iot/devices the "Generic ESP8266 Module" device status should be "Online".

Connect to the DEV environment

The DEV environment is using a different broker, so you need to add the option --host:

$ iot-cloud-cli ping --host tcps://mqtts-sa.iot.oniudra.cc:8884 -d "<Device ID>" -s "<Secret Key>" -t "<thing-id>"