物联网平台提供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格式的返回结果。