The ArduinoIoTCloud library is the central element of the firmware enabling certain Arduino boards to connect to the Arduino IoT Cloud.
- To get started, check out the official documentation
- For source code, check out the GitHub repository
When you are create and configure a Thing in the Arduino IoT Cloud interface, the thingProperties.h file is generated automatically.
This file adds all the variable/properties along with its specifications (e.g. update policy, read/write permissions), and the type of connection handler depending on what device you have attached.
Methods such as addProperty() and setThingId() are implemented here, so there's no need for manually entering anything.
We recommend that you do not edit this file as it is automatically updating whenever you make changes in the Arduino IoT Cloud.
If you have set up your sketch in an offline environment, make sure that whatever changes you make are reflected in this file, as it will be updated in the online environment.
Depending on what type of connection is used (TCP/LPWAN), either the ArduinoIoTCloudTCP or ArduinoIoTCloudLPWAN base classes are initialized. This specification is done in the Arduino IoT Cloud's "Thing" interface, and is reflected in the automatically generated thingProperties.h file.
- If a board is configured as a TCP device, it will automatically include the
ArduinoIoTCloudTCP.hfile, and methods of theArduinoIoTCloudTCPclass will be made available. This is the most common option. - If a board is configured as an LPWAN device, it will instead include the
ArduinoIoTCloudLPWAN.hfile, and methods of theArduinoIoTCloudLPWANclass will be made available.
As a result, functions such as begin(), update(), connected() and printDebugInfo() are documented under each corresponding class.
When the library is initialized via the begin() function, it will choose the specified connection handler, which is automatically added to your thingProperties.h file when configuring a Thing.
The connection handler is done via another library, Arduino_ConnectionHandler, which supports Wi-Fi®, GSM, NB-IoT, LoRa® & Ethernet.