物聯網平台提供Python語言的雲端SDK供開發人員使用。本文介紹雲端Python SDK的安裝和配置,及使用Python SDK調用雲端API的樣本。
安裝SDK
安裝Python開發環境。
訪問Python官網下載Python安裝包,並完成安裝。目前Python SDK支援Python的3.6及以上版本。
安裝Python的包管理工具pip。(如果您已安裝pip,請忽略此步驟。)
訪問pip 官網下載pip安裝包,並完成安裝。
安裝IoT Python SDK。
以管理員權限執以下命令,安裝IoT Python SDK。SDK使用說明,請參見新版alibabacloud-python-sdk。
pip3 install alibabacloud_tea_openapi # 安裝新版本IoT SDK。 pip3 install alibabacloud_iot20180120 # 安裝指定SDK版本,以3.0.9版本為例。 pip3 install alibabacloud_iot20180120==3.0.9
安裝alibabacloud-tea-console包,用於控制台列印日誌。
以管理員權限執行以下命令:
pip3 install alibabacloud-tea-console
將IoT Python SDK相關檔案引入Python檔案。
from Tea.core import TeaCore from alibabacloud_iot20180120.client import Client as IotClient from alibabacloud_tea_openapi import models as open_api_models from alibabacloud_iot20180120 import models as iot_models from alibabacloud_tea_console.client import Client as ConsoleClient from alibabacloud_tea_util.client import Client as UtilClient ...
初始化SDK
建立對象config,存放SDK初始化資訊(AccessKey ID、AccessKey Secret、地區ID等)。
建立對象執行個體client,通過
IotClient(config)
方法,載入config中的SDK資訊,完成SDK用戶端初始化。
以華東2(上海)地區及其服務接入地址為例,初始代碼如下。實際情境設定中,需使用您的物聯網平台服務所在地區。
config = open_api_models.Config()
# 您的AccessKey ID
config.access_key_id = os.environ.get('ALICLOUD_ACCESS_KEY_ID')
# 您的AccessKey Secret
config.access_key_secret = os.environ.get('ALICLOUD_ACCESS_KEY_SECRET')
# 您的可用性區域ID
config.region_id = 'cn-shanghai'
client = IotClient(config)
參數 | 說明 |
region_id | 您的物聯網平台服務的地區ID,用於拼接服務接入地址,格式為:iot.${RegionId}.aliyuncs.com。 您可在物聯網平台控制台左上方,查看當前服務所在地區。 地區ID的表達方法,請參見地區和可用性區域。 |
發起調用
物聯網平台雲端SDK為每個API封裝了一個類,命名為${API名稱}+"Request"
,用於API的調用請求。
調用步驟
已完成SDK用戶端初始化。具體內容,請參見初始化SDK。
建立對應API的調用請求,產生
${API名稱}+"Request"
類對象執行個體request。通過對象執行個體request,使用
"set_"+${請求參數的名稱}
方法,設定API所需的請求參數值。通過初始化SDK的對象執行個體client,使用
${經過底線分隔單詞的API名稱}(request)
方法,承載API調用結果。其中,尾碼為_async
的方法表示非同步方法呼叫。例如:
invoke_things_service(request)
,invoke_things_service_async(request)
。
物聯網平台雲端API,請參見API列表。有關request中請求參數說明,及response中返回參數說明,請參見對應API文檔。
本文以調用Pub介面發布訊息到Topic為例。請求參數資訊,請參見Pub。
request = iot_models.PubRequest(
# 物聯網平台執行個體ID。
iot_instance_id='${iotInstanceId}',
# 產品ProductKey。
product_key='${productKey}',
# 要發送的訊息主體,hello world Base64 String。
message_content='aGVsbG8gd29ybGQ=',
# 要接收訊息的裝置的自訂Topic。
topic_full_name='/${productKey}/${deviceName}/user/get',
# 指定訊息的發送方式,支援QoS0和QoS1。
qos=0
)
response = client.pub(request)
print('response : ' + response)
完整範例程式碼
實際情境中,請參照上文的參數說明,替換對應參數值。
# -*- coding: utf-8 -*-
import sys
from typing import List
from Tea.core import TeaCore
from alibabacloud_iot20180120.client import Client as IotClient
from alibabacloud_tea_openapi import models as open_api_models
from alibabacloud_iot20180120 import models as iot_models
from alibabacloud_tea_console.client import Client as ConsoleClient
from alibabacloud_tea_util.client import Client as UtilClient
access_key_id = os.environ.get('ACCESS_KEY_ID')
access_key_secret = os.environ.get('ACCESS_KEY_SECRET')
class Sample:
def __init__(self):
pass
@staticmethod
def create_client(
access_key_id: str,
access_key_secret: str,
) -> IotClient:
"""
使用AK&SK初始化Client
"""
使用AK&SK初始化帳號Client
@param access_key_id:
@param access_key_secret:
@return: Client
@throws Exception
"""
config = open_api_models.Config()
# 您的AccessKey ID
config.access_key_id = os.environ.get('ALICLOUD_ACCESS_KEY_ID')
# 您的AccessKey Secret
config.access_key_secret = os.environ.get('ALICLOUD_ACCESS_KEY_SECRET')
# 您的可用性區域ID
config.region_id = 'cn-shanghai'
return Iot20180120Client(config)
@staticmethod
def main(
args: List[str],
) -> None:
"""
同步調用方式
"""
try:
client = Sample.create_client('${accessKey}', '${accessKeySecret}')
request = iot_models.PubRequest(
# 物聯網平台執行個體ID。
iot_instance_id='${iotInstanceId}',
# 產品ProductKey。
product_key='${productKey}',
# 要發送的訊息主體,hello world Base64 String。
message_content='eyJ0ZXN0IjoidGFzayBwdWIgYnJvYWRjYXN0In0=',
# 要接收訊息的裝置的自訂Topic。
topic_full_name='/${productKey}/${deviceName}/user/get',
# 指定訊息的發送方式,支援QoS0和QoS1。
qos=0
)
response = client.pub(request)
ConsoleClient.log(UtilClient.to_jsonstring(TeaCore.to_map(response)))
except Exception as error:
ConsoleClient.log(error.message)
@staticmethod
async def main_async(
args: List[str],
) -> None:
"""
非同步呼叫方式
"""
try:
client = Sample.create_client('${accessKey}', '${accessKeySecret}')
request = iot_models.PubRequest(
# 物聯網平台執行個體ID。
iot_instance_id='${iotInstanceId}',
# 產品ProductKey。
product_key='${productKey}',
# 要發送的訊息主體,hello world Base64 String。
message_content='eyJ0ZXN0IjoidGFzayBwdWIgYnJvYWRjYXN0In0=',
# 要接收訊息的裝置的自訂Topic。
topic_full_name='/${productKey}/${deviceName}/user/get',
# 指定訊息的發送方式,支援QoS0和QoS1。
qos=0
)
response = await client.pub_async(request)
ConsoleClient.log(UtilClient.to_jsonstring(TeaCore.to_map(response)))
except Exception as error:
ConsoleClient.log(error.message)
if __name__ == '__main__':
Sample.main(sys.argv[1:])
附錄:範例程式碼
前往物聯網平台雲端SDK樣本中心查看或下載API調用的範例程式碼。範例程式碼中包含Java、Python、PHP、Node.js、Go、C++和.NET等版本SDK樣本。
阿里雲OpenAPI開發人員門戶提供API線上調試工具。在API調試頁面,您可以快速檢索和體驗調用API。系統會根據您輸入的參數同步產生各語言SDK的程式碼範例。各語言SDK程式碼範例顯示在頁面右側SDK樣本頁簽下供您參考。在調用結果頁簽下,可查看API調用的真實請求URL和JSON格式的返回結果。