iotconnect-lib 1.0.0

Avnet IoTConnect SDK Library

This document is reformatted to better viewing as a standalone document. We recommend visiting this GitHub v1.0.0 link for best experience.

Introduction

This project is the library that abstracts the /IOTCONNECT protocols for the SDKs like the /IOTCONNECT Python Lite SDK and the /IOTCONNECT Greengrass SDK.

This library should generally not be used in other projects as the SDKs should be able to provide all the functionality that you would need in your python applications.

Features

The library provides common code for interacting with /IOTCONNECT MQTT and HTTP device connectivity services:

• Format Telemetry (Reporting) messages
• Provide events for OTA and Command processing
• Streamline OTA and Command acknowledgements
• Obtain Discovery and Identity information

Using The Library

To use this library in your project, ensure that your pyton project depends on iotconnect-lib. Use a fixed major version dependency (E.g. "iotconnect-lib<2.0.0".) to avoid potential major version breaking your application calls.

The best way to learn how to use this library is to examine the unit test usage examples in the tests directory or use the SDK implementations listed above in this document for reference.

Testing

Regression tests should be run with every release using pytest.

See tests/TESTS_CONFIGURATION.md for more details.

Licensing

This python package is distributed under the MIT License.