All Products
Search
Document Center

Link IoT Edge:Use IoT Platform SDK for Python

Last Updated:Jan 26, 2024

IoT Platform provides developers with an SDK for Python. This article describes how to install and configure IoT Platform SDK for Python. This article also describes how to use the SDK to call the API operations of IoT Platform.

Install the SDK

  1. Install Python.

    Download a Python installation package from the official Python website and install Python. Python 2.7.x and 3.x are supported.

  2. Install pip that is used to manage Python packages.If you have installed pip, skip this step.

    Download a pip installation package from the official pip website and install pip.

  3. Install IoT Platform SDK for Python.

    Run the following commands as an administrator to install IoT Platform SDK for Python. For more information, see IoT Platform SDK for Python.

    sudo pip install aliyun-python-sdk-core
    sudo pip install aliyun-python-sdk-iot
  4. Import the files that are related to IoT Platform SDK for Python to a Python file.

    from aliyunsdkcore import client
    from aliyunsdkiot.request.v20180120 import RegisterDeviceRequest
    from aliyunsdkiot.request.v20180120 import PubRequest
    ...

Initialize the SDK

The following example shows how to initialize the SDK if your IoT Platform service resides in the China (Shanghai) region:

accessKeyId = '<your accessKey>'
accessKeySecret = '<your accessSecret>'
clt = client.AcsClient(accessKeyId, accessKeySecret, 'cn-shanghai')

Parameter

Description

accessKeyId

The AccessKey ID of your Alibaba Cloud account.

You can go to the User Management console to create or view your AccessKey ID.

accessKeySecret

The AccessKey secret of your Alibaba Cloud account.

clt

The initialized SDK client. cn-shanghai indicates the region ID of your IoT Platform service.

You can view the region in the upper-left corner of the IoT Platform console.

Initiate a request

The SDK encapsulates two classes for each API operation. The class names are in the ${API operation name}+"Request" and ${API operation name}+"Response" formats.

For more information about the API operations of IoT Platform, see List of operations by function. For more information about the request and response parameters of each API operation, see the API documentation.

The following example shows how to call the Pub operation to publish a message to a topic. For more information about the request parameters, see Pub.

request = PubRequest.PubRequest()
request.set_accept_format('json')  # The format in which the response is returned. By default, the XML format is used. In this example, the JSON format is used. 
request.set_ProductKey('productKey')
request.set_TopicFullName('/productKey/deviceName/get')  # The full name of the topic to which the message is sent.
request.set_MessageContent('aGVsbG8gd29ybGQ=')  #hello world Base64 String
request.set_Qos(0)
result = clt.do_action_with_exception(request)
print 'result : ' + result