iotconnect-sdk-lite 1.0.0__tar.gz

iotconnect_sdk_lite-1.0.0/LICENSE.md

@@ -0,0 +1,20 @@
+Copyright (c) 2020-2024 Avnet
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

iotconnect_sdk_lite-1.0.0/PKG-INFO

@@ -0,0 +1,63 @@
+Metadata-Version: 2.2
+Name: iotconnect-sdk-lite
+Version: 1.0.0
+Summary: Avnet IoTConnect Lite SDK
+Author-email: Nik Markovic <nikola.markovic@avnet.com>
+Project-URL: Homepage, https://github.com/avnet-iotconnect/iotc-python-lite-sdk
+Keywords: IoTconnect,AWS,IoTCore,Azure,IoTHub
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Natural Language :: English
+Classifier: Operating System :: MacOS :: MacOS X
+Classifier: Operating System :: Microsoft :: Windows
+Classifier: Operating System :: POSIX
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Communications
+Classifier: Topic :: Internet
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE.md
+Requires-Dist: paho-mqtt>=2.1.0
+
+# Introduction
+This project is the IoTConnect Python Lite Client (SDK)
+that aims for a modern, intuitive and robust interface to connect your
+Linux, Windows or MacOS devices to the Avnet IoTConnect platform.
+
+The project supports IoTConnect Device Protocol 2.1 devices. 
+The project requires Python 3.9 or newer and provides
+a set of features for most common IoTConnect use cases.
+
+If you need support for older Pyton, Protocol 1.0, Properties (Shadow/Twin)
+Offline or HTTP Client along with other features like Gateway/Child support
+you should check out the standard
+[Iotconnect Python SDK](https://github.com/avnet-iotconnect/iotc-python-sdk) repository.
+
+# Licensing
+
+This python package is distributed under the [MIT License](LICENSE.md).
+
+# Installing
+
+The quickest way to get started with the project is to follow the [QUICKSTART.md](QUICKSTART.md) document.
+
+# Using the Client
+
+Using this client to communicate to IoTConnect involves the following steps:
+- Get familiar with the client API by examining documentation at [client.py](src/avnet/iotconnect/sdk/lite/client.py)
+- Initialize the client with either:
+  - iotcDeviceConfig.json (downloaded from the device *Info* panel) - see the [basic-example](examples/basic-example.py)
+  - Explicit parameters to the constructor - see the [minimal example](examples/minimal.py).
+- Optionally, configure your own Client settings (log verbosity, timeouts etc.) and pass those to the constructor.
+- Optionally, pass callbacks for C2D message and OTA (see the [basic-example](examples/basic-example.py)) or even your own [custom message handler](examples/c2d-special-event-handling.py) to the constructor 
+  - While actual download and application replacement mechanism would depend on how your application runs
+    (via a system service, cron or other method) a simple OTA download and install method is shown in the [ota-handling](examples/ota-handling.py) example.  
+- Optionally, pass a callback for the MQTT disconnect event and handle it according to your application requirements.  
+- Call Client.connect(). The call should block until connected based on timeout retry settings.
+- Call Client.send_telemetry() at regular intervals. Verify that the client is connected with Client.is_connected()

iotconnect_sdk_lite-1.0.0/README.md

@@ -0,0 +1,36 @@
+# Introduction
+This project is the IoTConnect Python Lite Client (SDK)
+that aims for a modern, intuitive and robust interface to connect your
+Linux, Windows or MacOS devices to the Avnet IoTConnect platform.
+
+The project supports IoTConnect Device Protocol 2.1 devices. 
+The project requires Python 3.9 or newer and provides
+a set of features for most common IoTConnect use cases.
+
+If you need support for older Pyton, Protocol 1.0, Properties (Shadow/Twin)
+Offline or HTTP Client along with other features like Gateway/Child support
+you should check out the standard
+[Iotconnect Python SDK](https://github.com/avnet-iotconnect/iotc-python-sdk) repository.
+
+# Licensing
+
+This python package is distributed under the [MIT License](LICENSE.md).
+
+# Installing
+
+The quickest way to get started with the project is to follow the [QUICKSTART.md](QUICKSTART.md) document.
+
+# Using the Client
+
+Using this client to communicate to IoTConnect involves the following steps:
+- Get familiar with the client API by examining documentation at [client.py](src/avnet/iotconnect/sdk/lite/client.py)
+- Initialize the client with either:
+  - iotcDeviceConfig.json (downloaded from the device *Info* panel) - see the [basic-example](examples/basic-example.py)
+  - Explicit parameters to the constructor - see the [minimal example](examples/minimal.py).
+- Optionally, configure your own Client settings (log verbosity, timeouts etc.) and pass those to the constructor.
+- Optionally, pass callbacks for C2D message and OTA (see the [basic-example](examples/basic-example.py)) or even your own [custom message handler](examples/c2d-special-event-handling.py) to the constructor 
+  - While actual download and application replacement mechanism would depend on how your application runs
+    (via a system service, cron or other method) a simple OTA download and install method is shown in the [ota-handling](examples/ota-handling.py) example.  
+- Optionally, pass a callback for the MQTT disconnect event and handle it according to your application requirements.  
+- Call Client.connect(). The call should block until connected based on timeout retry settings.
+- Call Client.send_telemetry() at regular intervals. Verify that the client is connected with Client.is_connected()

iotconnect_sdk_lite-1.0.0/pyproject.toml

@@ -0,0 +1,51 @@
+[build-system]
+requires = ["setuptools"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "iotconnect-sdk-lite"
+dynamic = ["version"]
+description = "Avnet IoTConnect Lite SDK"
+readme = "README.md"
+requires-python = ">=3.9"
+authors = [
+    { name = "Nik Markovic", email = "nikola.markovic@avnet.com" },
+]
+
+keywords = [
+    "IoTconnect",
+    "AWS",
+    "IoTCore",
+    "Azure",
+    "IoTHub",
+]
+classifiers = [
+    "Development Status :: 3 - Alpha",
+    "Intended Audience :: Developers",
+    "License :: OSI Approved :: MIT License",
+    "Natural Language :: English",
+    "Operating System :: MacOS :: MacOS X",
+    "Operating System :: Microsoft :: Windows",
+    "Operating System :: POSIX",
+    "Programming Language :: Python",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.9",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Topic :: Communications",
+    "Topic :: Internet",
+]
+dependencies = [
+    "paho-mqtt>=2.1.0",
+]
+
+[project.urls]
+Homepage = "https://github.com/avnet-iotconnect/iotc-python-lite-sdk"
+
+[tool.setuptools.packages.find]
+where = ["src"]
+
+[tool.setuptools.dynamic]
+version = {attr = "avnet.iotconnect.sdk.lite.__version__"}
+

iotconnect_sdk_lite-1.0.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

iotconnect_sdk_lite-1.0.0/src/avnet/iotconnect/sdk/lite/__init__.py

@@ -0,0 +1,8 @@
+__version__ = '1.0.0'
+
+from .error import DeviceConfigError
+from .config import DeviceConfig
+from .client import Client, ClientSettings, Callbacks
+
+# redirect these imports so that the user code is not affected by any changes in file organization
+from avnet.iotconnect.sdk.sdklib.mqtt import C2dCommand, C2dOta, C2dAck, C2dMessage, TelemetryRecord