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 a Python integrated development environment (IDE).
    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. 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 is deployed in the China (Shanghai) region:

Use the client.AcsClient(accessKeyId, accessKeySecret, 'cn-shanghai') method to load the SDK initialization information.

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 Alibaba Cloud Management Console to create or view your AccessKey ID.

accessKeySecret The AccessKey secret of you 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.

For more information about region IDs, see Regions.

Initiate a request

The SDK encapsulates a class for each API operation. The class name is in the ${Operation name}+"Request" format. You can use the request instance of this class and call the "set_"+${request parameters} method to specify the request parameters. You can use the clt client and call the do_action_with_exception(request) method to obtain a response.

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 request parameters, see Pub.

Notice In the following sample code, iotInstanceId is used as the instance ID. You can view the ID of the instance on the Overview page in the IoT Platform console.
  • If your instance has an ID, you must specify the ID for this parameter. Otherwise, the call fails.
  • If no Overview page or ID is generated for your instance, you do not need to configure this parameter.

For more information about instances, see Overview.

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_TopicFullName('/productKey/deviceName/user/get')  # The full name of the topic to which the message is sent.
request.set_MessageContent('aGVsbG8gd29ybGQ=')  #hello world Base64 String
result = clt.do_action_with_exception(request)
print 'result : ' + result

Appendix: Sample code

Download the IoT Platform SDK sample code. The sample code for Java, Python, PHP, .NET, and Go is provided.

Alibaba Cloud provides OpenAPI Explorer to simplify API usage. You can use OpenAPI Explorer to search for API operations, call API operations, and dynamically generate SDK sample code. OpenAPI Explorer dynamically generates SDK sample code in different languages based on the parameters that you configured. On the right side of the page, you can view the sample code of an SDK on the Example Code tab. On the Debugging Result tab, you can view the actual request URL and response in the JSON format.