Package: simpleiot-cli
SimpleIOT Command-Line-Interface (CLI)This is the command-line-interface (CLI) for theSimpleIOTframework.SimpleIOT abstracts out IoT device connectivity and hides the underlying details so you can focus on your application's unique features.Basic ConceptsIn the SimpleIOT world, an installation supports the following concepts:team: A single installation of SimpleIOT in the cloud. This is mainly relevant to using the Command-Line-Interface (CLI) tool.project: Each backend supports one or moreProjects.Model: AModeldescribes a device's capabilities. For example, what data it likes to exchange with the cloud, whether an end-node or a gateway device, what features it supports (i.e., storage, encryption, or AI/ML.), and how it communicates with the cloud.DataType: ADataTypeis a single named value that can be exchanged between a device and the cloud. AModeltypically has one or moreDataTypesassociated with it.Device: ADevicerepresents a single instance of aModel. Each device has a unique identification via itsserial_number.Data: ADataelement is an instance of aDataTypeassociated with a singleDevice. For example, if aModeldefines aDataTypenamedpressure, each uniqueDevicewill have its own instance ofpressure. You can get/set values associated with eachDeviceinstance by name.Dataelements are bi-directional so that updates go from the devices to or from the cloud back to the device. It is up to the firmware to handle what to do with values received from the cloud.Dual-useThis CLI can be used by both backend administrators as well as end-users.As an Administrator, you need to:Have one or more AWS accounts with IAM Administrative privileges.Configure a profile for each account by running theaws configurecommand.With this CLI, you can:Create a private, serverless IOT backend on AWS.Create one or more Teams (individual backend installations on each account).Securely invite users to join the team (including support for bulk emailing).Remove users from a Team.As a User, you can:Join a Team to which you have been invited.Install an Arduino command-line toolchain with support for ESP32 processors.Create and manage Projects, Models, DataTypes, and Devices.Simulate and monitor remote device values viasetandgetoperations.Provision and deploy secure IOT device instances.Generate firmware source code based on templates (currently supporting the ESP32/Arduino toolchain).Compile and flash firmware to an M5Stack ESP-32 device via USB cable.Monitor MQTT traffic sent to/from AWS IOT.The CLI can be installed on systems running at least Windows 10 or MacOS Big Sur. It requires pre-installation ofPython(Users + Administrators) andDocker Desktop(Administrators).InstallationAdministrators can install and remove the backend cloud for a SimpleIOT deployment. They can also invite new users to theTeamso they can interact with an existing installation.Step 1: AWS CLIBefore creating a backend, you need to make sure you have an AWS account created and a user account configured via theAWS Command Line Interface.NOTEThis will require downloading and setting up an account with AWS IAM Administrative Privileges. If you are not allowed to have AWS admin privileges, a list of fine-grain IAM privileges will be released along with the SimpleIOT back-end sources. These can be used to create only the privileges needed by the system.This is a one-time operation. Once configured, you may proceed with the following steps. You can configure multiple named profiles using theaws configcommand. During installation, you will be prompted to choose which profile you would like to use. If only one account is configured, it will be considered thedefaultprofile.Step 2: Install pre-requisitesFor all Users:Latest version of Python fromhttps://python.org(minimum 3.9+)Silicon LabsCP210x USB to UART Bridge drivers. Under Windows, once you plug in an AWS EduKit device, it should automatically install this driver. You will have to download the above driver and manually install it if it fails. Under MacOS, you need to download and install it manually.Additionally, for Administrators:Docker Desktop:https://docs.docker.com/desktop/Installing these may require other dependencies on Windows or Mac. Once installed, the system may need to be rebooted.Step 3: Install SimpleIOT CLIOpen a powershell (Windows) or terminal (Mac) terminal window, then run:pip install simpleiot-cliOnce installed, you can test the command-line interface:% iot help
Usage: iot [OPTIONS] COMMAND [ARGS]...

Options:
 --help Show this message and exit.

Commands:
 auth User Authentication
 cloud Cloud backend provisioning
 data Data set and retrieve
 datatype Model DataType management
 device Device provisioning
 firmware Generate sample source
 location Location management
 model Manage Models
 project Project management
 team Team management (CLI only)
 template Project Template management
 toolchain Project Template management
 twin Manage Digital 3D Twin files
 update OTA Firmware UpdatesUninstallingTo uninstallsimpleiot-cliuse thepipcommand:% pip uninstall simpleiot-cliNote that this only removes the CLI itself. If you have installed other items, like the compiler toolchain or actual projects, those must be removed before reinstalling.If the CLI was used to create a cloud backend, it should be deleted via:% iot cloud uninstallBe careful if you have allowed others access to this team. This command will permanently delete the entire backend infrastructure, including user accounts and all provisioned AWS IOT Things and certificates.TroubleshootingPython missing or out-of-dateOncesimpleiot-cliis installed, you can verify that it is operational by running theiot --helpcommand. If this returns an error, your version of Python may be missing or not up-to-date. To verify, open aPowershellorTerminalwindow and enter:% python --version
Python 3.9.4You should get a version higher than 3.9. If not, please update or install the latest version of Python. If thepythoncommand is not found, re-run the Python installer and check the box that asks if it should be added to the PATH.Unable to deploy the backendThis could be due to a variety of reasons, including:AWS CLI is not installed correctly.aws configurehas not been run properly.AWS configuration settings in~/.awsare not valid.The account does not have sufficient IAM privileges to create the components for the SimpleIOT platform.Please check and remedy these problems before proceeding.LicenseThis project is licensed under the Apache-2.0 License.