全部產品
Search
文件中心

IoT Platform:Python SDK使用說明

更新時間:Jun 30, 2024

物聯網平台提供Python語言的雲端SDK供開發人員使用。本文介紹雲端Python SDK的安裝和配置及使用Python SDK調用雲端API的樣本。

安裝SDK

  1. 安裝Python開發環境。

    訪問Python官網,下載Python安裝包,並完成安裝。目前,Python SDK支援Python的2.7.x和3.x版本。

  2. 安裝Python的包管理工具pip。(如果您已安裝pip,請忽略此步驟。)

    訪問 pip 官網,下載pip安裝包,並完成安裝。

  3. 以管理員權限執行以下命令,安裝IoT Python SDK。

    該SDK使用說明,請參見新版aliyun-python-sdk-iot資訊。

    sudo pip install aliyun-python-sdk-core
    sudo pip install aliyun-python-sdk-iot
  4. 將IoT Python SDK相關檔案引入Python檔案。

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

初始化SDK

以調用華東2(上海)地區的API為例,初始化代碼如下。

通過client.AcsClient(accessKeyId, accessKeySecret, 'cn-shanghai')方法,載入SDK資訊,完成SDK用戶端初始化。

import os
accessKeyId = os.getenv('ACCESS_KEY_ID')
accessKeySecret = os.getenv('ACCESS_KEY_SECRET')
clt = client.AcsClient(accessKeyId, accessKeySecret, 'cn-shanghai')

參數

說明

clt

初始化SDK用戶端,其中cn-shanghai是您的物聯網平台服務的地區代碼。

您可在物聯網平台控制台左上方,查看當前服務所在地區。

地區代碼的表達方法,請參見支援的地區

發起調用

物聯網平台雲端SDK為每個API封裝了一個類,命名為${API名稱}+"Request",用於API的調用請求。通過該類的對象執行個體request,使用"set_"+${請求參數的名稱}方法,佈建要求參數值。通過初始化SDK的對象執行個體clt,使用do_action_with_exception(request)方法,承載API調用結果。

物聯網平台雲端API,請參見API列表。有關request中請求參數說明,及response中返回參數說明,請參見對應API文檔。

本文以調用Pub介面發布訊息到Topic為例。請求參數資訊,請參見Pub

request = PubRequest.PubRequest()
request.set_accept_format('json')  #設定返回資料格式,預設為XML,此例中設定為JSON
request.set_IotInstanceId('iotInstanceId') 
request.set_ProductKey('productKey')
request.set_TopicFullName('/productKey/deviceName/user/get')  #訊息發送到的Topic全名
request.set_MessageContent('aGVsbG8gd29ybGQ=')  #hello world Base64 String
request.set_Qos(0)
result = clt.do_action_with_exception(request)
print('result : ' + result)

附錄:範例程式碼

前往物聯網平台雲端SDK樣本中心查看或下載API調用的範例程式碼。範例程式碼中包含Java、Python、PHP、.NET和Go版本SDK樣本。

阿里雲OpenAPI開發人員門戶提供API線上調試工具。在API調試頁面,您可以快速檢索和體驗調用API。系統會根據您輸入的參數同步產生各語言SDK的程式碼範例。各語言SDK程式碼範例顯示在頁面右側SDK樣本頁簽下供您參考。在調用結果頁簽下,可查看API調用的真實請求URL和JSON格式的返回結果。