UniPRT_Cloud SDK

Welcome to SDK Documentation

Welcome to the SDK documentation! This guide will help you get started with using our SDK and provide links to key classes and functionalities.

Getting Started

To get started, please refer to the following key classes:

Communication:

• MqttComm

Remarks

Do not call any method or class that is not documented.

Overview

Our SDK provides a comprehensive set of tools to help you integrate our functionalities into your application. Please read our sample code, you will find a brief overview of the most important classes and how the SDK work.

We hope this documentation helps you get up and running quickly. If you have any questions or need further assistance, please refer to the detailed guides or contact our support team.

1. Let the printer connect to the internet using Wi-Fi.
2. Open a browser and enter the IP address displayed on the Panel.
   

   Panel
3. Choose "File Manager" and upload the "ca.crt, client.crt, client.key" files.
   

   Choose File Manager and upload files.
4. Choose "MQTT Setting."
   

   Choose MQTT Setting.
5. Fill in the blanks and click the "Set" button.

Fill in the blanks

Importing SDK Into Visual Studio Code

1. Download the SDK package to a local directory on your PC.
2. Create an Visual Studio Code Project.
3. Add the UniPRT_Cloud-1.0.0-py3-none-any.whl into the project file.
4. Create an environment use command:

   python -m venv ENVNAME

5. Activate the Environment use command:

   linux/macOS:

   source myenv/bin/activate

   PowerShell(Windows)：

   .\ENVNAME\Scripts\Activate

   CMD(Windows):

   ENVNAME\Scripts\activate.bat

6. install package use command:

   pip install UniPRT_Cloud-1.0.0-py3-none-any.whl 

7. Import MQTTSDK to your project use:

   from UniPRT_Cloud.Comm.MqttComm import MqttComm

TSC Topic Prefix Configuration

The topic structure is allow user-defined prefixes for more flexible integration.

Topic Structure

Topics shall follow the format:

{Tenant ID}/{Topic Prefix}/{Topic Subject}/{Agent ID} 

Remarks

To connect to TSC CloudConnect, the Topic must be set to TSCCloudConnect.

Where Topic Subject include:

• request/json
• status/json
• response/json
• alert/json

Example

If a tenant has ID 02bfda5a55d15f29214b99287a4e623f, and uses the CloudConnect topic prefix, and the topic subject is status/json with device MH241-ABC-123, the full topic would be:

02bfda5a55d15f29214b99287a4e623f /CloudConnect/clients/status/json/ MH241-ABC-123 

Support

For any issues or further assistance, please contact our Support Team.

---

Happy coding!

TSC