Welcome

The functions of the main IoTC Client API are used to build a client connection to the Google Cloud IoT Core Service over a secure socket, and publish / subscribe to messages over MQTT. This documention, in conjuction with the IoTC Client User Guide (/doc/user_guide.md) and source examples in /examples/, should provide you with enough information to create your custom IoTC Client-enabled applications.

If you're looking for information on how to port the IoTC Client to your custom embedded device, then please direct your attention to the Board Support Package (BSP) documentation. This exists in two parts, the IoTC Client Porting Guide (/doc/porting_guide.md) and the BSP doxygen.

Where to Start

All of the standard IoTC Client API functions are contained within the /include directory of the project's base path, and have the 'iotc' prefix. We suggest clicking on iotc.h in the doxygen File tab to get started.

For most POSIX systems this might be all of the documentation that you need. However, if you're building the library to be exeucted on your own custom platform with non POSIX library support, then you may also need to browse the Board Support Package (BSP) functions as well. These functions are documented in the BSP doxygen documentation contained in a sibling directory as this doxygen.

Welcome

Where to Start

Further Reading