版权声明腾讯云版权所有本文档著作权归腾讯云单独所有, 未经腾讯云事先书面许可, 任何主体不得以任何形式复制修改抄袭传播全部或部分本文档内容商标声明及其它腾讯云服务相关的商标均为腾讯云计算 ( 北京 ) 有限责任公司及其关联公司所有本文档涉及的第三方主体的商标, 依法

Size: px

Start display at page:

九沼白
5 years ago
Views:

1 加速物联网套件用户指南产品文档第 1 共 28 页

版权声明 2013-2018 腾讯云版权所有本文档著作权归腾讯云单独所有, 未经腾讯云事先书面许可, 任何主体不得以任何形式复制修改抄袭

本文档涉及的第三方主体的商标, 依法由权利人所有服务声明本文档意在向客户介绍腾讯云全部或部分产品服务的当时的整体概况, 部分产品

2 版权声明腾讯云版权所有本文档著作权归腾讯云单独所有, 未经腾讯云事先书面许可, 任何主体不得以任何形式复制修改抄袭传播全部或部分本文档内容商标声明及其它腾讯云服务相关的商标均为腾讯云计算 ( 北京 ) 有限责任公司及其关联公司所有本文档涉及的第三方主体的商标, 依法由权利人所有服务声明本文档意在向客户介绍腾讯云全部或部分产品服务的当时的整体概况, 部分产品服务的内容可能有所调整您所购买的腾讯云产品服务的种类服务标准等应由您与腾讯云之间的商业合同约定, 除非双方另有约定, 否则, 腾讯云对本文档内容不做任何明示或模式的承诺或保证第 2 共 28 页

3 文档目录用户指南设备接入获取设备 SDK 设备 SDK 使用指南 C-SDK 使用指南 Android SDK 使用指南 SDK 跨平台移植手册规则引擎概述规则行为第 3 共 28 页

4 用户指南设备接入获取设备 SDK 最近更新时间 : :12:53 目前我们提供 C 语言与 Android 的设备端 SDK 版本已经开始在 Github 上托管, 欢迎广大开发者给我们提出 issues C 语言 SDK 主页为 : 版本 v1.0.0 发布时间 :2018/1/23 开发环境 :Linux,GNU Make( 可移植 ) 下载链接 :RELEASED_V1_00_ zip 支持内容 : 1. 支持标准 MQTT 协议, 设备轻松连接云端 mqtt server 2. 提供直连与动态鉴权两种模式与云端建连 3. 支持 MQTT over TLS 访问云端版本 v1.0.5 发布时间 :2018/2/01 开发环境 :Linux,GNU Make( 可移植 ) 下载链接 :RELEASED_V1_05_ zip 支持内容 : 1.SDK 默认内置 token 服务官网和 MQ 服务根证书 2. 使用自定义 Topic 进行通讯的场景 demo 3.SDK 函数及结构定义注释说明文档上线 Android SDK 主页为 : 第 4 共 28 页

5 版本 v1.0.0 发布时间 :2018/1/30 开发环境 :Android 系统下载链接 : 1. 支持标准 MQTT 协议, 设备轻松连接云端 mqtt server 2. 提供直连与动态鉴权两种模式与云端建连 3. 提供与云端通信的 Demo 例程第 5 共 28 页

6 设备 SDK 使用指南 C-SDK 使用指南最近更新时间 : :41:53 开发准备开发前请前往 github 下载最新版 C-SDK: 开发环境 1. 安装 cmake 工具 2. 在腾讯云 IoT Suite 控制台创建产品与设备, 选择鉴权模式 ( 注意, 选择不同模式则需要在 device_config.h 中配置不同的设备参数 ), 获取到对应的 MQTT Server Host Product ID Product key DeviceName DeviceSecret 参数, 用于填写配置文件选择鉴权模式第 6 共 28 页

7 直连模式下 product 相关参数 (MQTT Server Host Product ID Product key) 第 7 共 28 页

8 token 模式下 product 相关参数 (MQTT Server Host Product ID Product key mqtt username mqttpassword) 在设备管理页面中选择设备设备证书下获取设备相关参数 (DeviceName DeviceSecret) 第 8 共 28 页

9 3. 打开 examples/linux/tc_iot_device_config.h 配置文件, 配置设备参数必填项 // 以下配置需要先在官网创建产品和设备, 然后获取相关信息更新 ~ // MQ 服务地址, 可以在产品基本信息 -> mqtt 链接地址位置找到 #define TC_IOT_CONFIG_SERVER_HOST "<mqtt-xxx.ap-guangzhou.mqtt.tencentcloudmq.com>" // MQ 服务端口, 直连一般为 1883, 无需改动 #define TC_IOT_CONFIG_SERVER_PORT 1883 // 产品 id, 可以在产品基本信息 -> 产品 id 位置找到 #define TC_IOT_CONFIG_DEVICE_PRODUCT_ID "<iot-xxx>" // 设备密钥, 可以在产品设备管理 -> 设备证书 -> Device Secret 位置找到 #define TC_IOT_CONFIG_DEVICE_SECRET "< >" // 设备名称, 可以在产品设备管理 -> 设备名称位置找到 #define TC_IOT_CONFIG_DEVICE_NAME "<device001>" // client id, // 由两部分组成, 组成形式为 Instanceid@DeviceID,ClientID 的长度不超过 64 个字符第 9 共 28 页

10 //, 请不要使用不可见字符其中 // Instanceid 为 IoT MQ 的实例 ID, 可以在基本信息 -> 产品 key 位置找到 // DeviceID 为每个设备独一无二的标识, 由业务方自己指定, 需保证全局唯一, 例如, 每个 // 传感器设备的序列号, 或者设备名称等 #define TC_IOT_CONFIG_DEVICE_CLIENT_ID TC_IOT_CONFIG_DEVICE_NAME 选填项 ( 仅在选择直连模式时填写 ) 将控制台获取到的 mqtt username,mqtt password 填写到配置文件中的如下位置 #define TC_IOT_CONFIG_DEVICE_USER_NAME "" #define TC_IOT_CONFIG_DEVICE_PASSWORD "" 编译及运行 1. 执行下面的命令, 编译示例程序 : cd tencent-cloud-iotsuite-embedded-c mkdir -p build cd build cmake../ make 2. 编译后,build 目录下的关键输出及说明如下 : bin -- demo_mqtt # MQTT 连接云服务演示程序 -- demo_shadow # Shadow 影子设备操作演示程序 lib 第 10 共 28 页

11 -- libtc_iot_suite.a # SDK 的核心层, libtc_iot_hal libtc_iot_common 提供连接云服务的能力 -- libtc_iot_common.a # SDK 基础工具库, 负责 http json base64 等解析和编解码功能 -- libtc_iot_hal.a # SDK 的硬件及操作系统抽象, 负责内存定时器网络交互等功能 3. 执行示例程序 : cd bin # 运行 demo 程序./demo_mqtt # or./demo_shadow C-SDK 的 API 功能列表以下为 V1.0.6 版本的 C-SDK 所提供的功能与 API LIST, 用户可基于接口编写业务逻辑, 封装 AT 命令, 更加详细的说明请查看 include/tc_iot_export.h 中的注释 1. 日志接口序号函数名说明 1 tc_iot_set_log_level 设置打印的日志等级 2 tc_iot_get_log_level 返回日志输出的等级 3 tc_iot_log_level_enabled 返回日志输出的等级 2.MQTT 接口序号函数名说明 1 tc_iot_mqtt_client_construct 构造 MQTT client, 并连接 MQ 服务器 2 tc_iot_mqtt_client_destroy 关闭 MQTT client 连接, 并销毁 MQTT client 3 tc_iot_mqtt_client_yield 在当前线程为底层 MQTT client, 让出一定 CPU 执行时间 4 tc_iot_mqtt_client_publish 向指定的 Topic 发布消息第 11 共 28 页

12 序号函数名说明 5 tc_iot_mqtt_client_subscribe 订阅指定 Topic 的消息 6 tc_iot_mqtt_client_unsubscribe 取消订阅已订阅的 Topic 7 tc_iot_mqtt_client_is_connected 判断 MQTT client 目前是否已连接 8 tc_iot_mqtt_client_disconnecd 断开 MQTT client 与服务端的连接第 12 共 28 页

13 Android SDK 使用指南最近更新时间 : :42:13 本文介绍如何基于 Android SDK 接入腾讯云物联网套件, 实现基于 MQTT 协议的上下行请求其中 IotSDK 是腾讯云 iotsuite 的设备端 SDK,IotSample 是使用 IotSDK 的 demo 引入 SDK 两种引入方式 1 下载 SDK, 然后本地依赖 implementation project(path: ':IotSDK') 2 直接依赖 jcenter 上的库 implementation 'com.tencent.qcloud:iot-android-sdk:1.1.3' 编译运行 Demo 在 github 下载 Android 版 SDK 后, 使用 Android Studio 打开工程 tencent-cloud-iotsuite-android 配置参数在腾讯云 IoT Suite 控制台创建产品与设备, 选择鉴权模式 ( 注意, 选择不同模式则需要在 device_config.h 中配置不同的设备参数 ), 获取到对应的 MQTT Server Host Product ID Product key DeviceName DeviceSecret 参数, 用于填写配置文件第 13 共 28 页

14 选择鉴权模式直连模式下 product 相关参数 (MQTT Server Host Product ID Product key) 第 14 共 28 页

15 token 模式下 product 相关参数 (MQTT Server Host Product ID Product key mqtt username mqttpassword) 在设备管理设备证书下获取设备相关参数 (DeviceName DeviceSecret) 一个设备仅支持直连或临时 token 一种连接模式 1. 选择直连模式 : 需要把控制台获取的 mqtthost productkey productid devicename devicesecret mqtt username mqtt password 填入下列配置参数 // 直连模式参数 private String mdirectmqtthost = "mqtt-m2i58z3s.ap-guangzhou.mqtt.tencentcloudmq.com"; private String mdirectproductkey = "mqtt-m2i58z3s"; private String mdirectproductid = "iot-6xzr8ap8"; private String mdirectdevicename = "test_android_1"; private String mdirectdevicesecret = "48bf05179b6f1be3b38c89f27c804f11"; 第 15 共 28 页

16 private String mdirectusername = "AKIDNgssgTw1pW2NahKR4oRt9D6ofNuGgSKG"; private String mdirectpassword ="085Nmo6yhgR/TMjSPfFWP+TEVrggjVNFtAyvZUCxp0U="; 2. 选择临时 token 模式 : 需要把控制台获取的 mqtthost productkey productid devicename devicesecret 填入下列配置,SDK 内部会自动根据以上参数获取 mqtt 建连所需的 username 和 password //token 模式参数 private String mtokenmqtthost = "mqtt-5oo05hhn8.ap-guangzhou.mqtt.tencentcloudmq.com"; private String mtokenproductkey = "mqtt-5oo05hhn8"; private String mtokenproductid = "iot-kaqvlhxc"; private String mtokendevicename = "test_android_2"; private String mtokendevicesecret = "4a3a3b49c5103f8d4cfea154169f6b25"; 运行 Demo 在 ConnectionFragment 中填好配置参数后, 编译运行 Demo 选择连接模式并连接成功后, 就可以订阅和发布 topic SDK 说明腾讯云 iotsuite Android SDK 提供 mqtt connect disconnec subscribe unsubscribe publish 能力, 另外提供失败重连的参数配置, 相应的调用示例可以参见 Demo 中的 Connection.java mqtt 部分建立 mqtt 连接 void connect(final IMqttConnectStateCallback connectstatecallback) IMqttConnectStateCallback 用于监听连接状态变化断开 mqtt 连接 void disconnect() 订阅 topic 第 16 共 28 页

17 void subscribe(final MqttSubscribeRequest request) MqttSubscribeRequest 中可设置回调, 监听请求结果取消订阅 topic void unsubscribe(final MqttUnSubscribeRequest request) MqttUnSubscribeRequest 中可设置回调, 监听请求结果向 topic 发布消息 void publish(final MqttPublishRequest request) MqttPublishRequest 中可设置回调, 监听请求结果监听已订阅 topic 发来的消息 void setmqttmessagelistener(imqttmessagelistener listener) 影子操作获取影子 void getshadow() 设备端更新影子第 17 共 28 页

18 void reportshadow(jsonobject report) 删除影子部分属性或全部属性 void deleteshadow(jsonobject delete) 设置监听影子消息, 必须在 connect 调用之后 void setshadowmessagelistener(ishadowlistener shadowlistener) 其他设置 log 等级 QLog.setLogLevel(QLog.QLOG_LEVEL_DEBUG); 自动重连逻辑 SDK 可配置 minretrytime maxretrytime maxretrytimes 两次重连之间的时间间隔 retryinterval 按 2 的幂次方增长, 并且满足 minretrytime<=retryinterval<=maxretrytime, 当重连次数达到 maxretrytimes 后, 停止重连第 18 共 28 页

19 SDK 跨平台移植手册最近更新时间 : :42:25 硬件及操作系统平台抽象层 (HAL 层 ) SDK 抽象定义了硬件及操作系统平台抽象层 (HAL 层 ), 将所依赖的内存定时器网络传输交互等功能, 都封装在 HAL 层 ( 对应库 libtc_iot_hal) 中, 进行跨平台移植时, 首先都需要根据对应平台的硬件及操作系统情况, 对应适配或实现相关的功能平台移植相关的头文件及源文件代码结构如下 : include/platform/ -- linux # 不同的平台或系统, 单独建立独立的目录 -- tc_iot_platform.h # 引入对应平台相关的定义或系统头文件 -- tc_iot_hal_network.h # 网络相关定义 -- tc_iot_hal_os.h # 操作系统内存时间戳等相关定义 -- tc_iot_hal_timer.h # 定时器相关定义 src/platform/ -- CMakeLists.txt -- linux -- CMakeLists.txt -- tc_iot_hal_net.c # TCP 非加密直连方式网络接口实现 -- tc_iot_hal_os.c # 内存及时间戳实现 -- tc_iot_hal_timer.c # 定时器相关实现 -- tc_iot_hal_tls.c # TLS 加密网络接口实现 C-SDK 中提供的 HAL 层是基于 Linux 等 POSIX 体系系统的参考实现, 但并不强耦合要求实现按照 POSIX 接口方式, 移植时可根据目标系统的情况, 灵活调整所有 HAL 层函数都在 include/platform/tc_iot_hal*.h 中进行声明, 函数都以 tc_iot_hal 为前缀以下是需要实现的 HAL 层接口, 详细信息可以参考注释基础功能功能分类函数名说明是否可选内存 tc_iot_hal_malloc 分配所需的内存空间, 并返回一个指向它的指针基础必选第 19 共 28 页

20 功能分类函数名说明是否可选内存 tc_iot_hal_free 释放之前调用 tc_iot_hal_malloc 所分配的内存空间基础必选输入输出 tc_iot_hal_printf 发送格式化输出到标准输出 stdout 基础必选输入输出 tc_iot_hal_snprintf 发送格式化输出到字符串基础必选时间日期 tc_iot_hal_timestamp 系统时间戳, 格林威治时间点起总秒数基础必选定时器 tc_iot_hal_sleep_ms 睡眠挂起一定时长, 单位 :ms 基础必选定时器 tc_iot_hal_timer_init 初始化或重置定时器基础必选定时器 tc_iot_hal_timer_is_expired 判断定时器是否已经过期基础必选定时器 tc_iot_hal_timer_countdown_ms 设定定时器时延, 单位 :ms 基础必选定时器 tc_iot_hal_timer_countdown_second 设定定时器时延, 单位 :s 基础必选定时器 tc_iot_hal_timer_left_ms 检查定时器剩余时长, 单位 :ms 基础必选随机数 tc_iot_hal_srandom 设置随机数种子值基础必选随机数 tc_iot_hal_random 获取随机数基础必选网络功能 ( 二选一或全选 ) 根据实际连接方式选择, 如是否走 MQTT over TLS 加密, 是否通过 HTTPS 接口获取 Token 等, 选择性实现 TCP 或 TLS 相关接口 TCP 功能分类函数名说明是否可选 TCP 连接 tc_iot_hal_net_init 初始化网络连接数据可选, 非加密直连时实现 TCP 连接 tc_iot_hal_net_connect 连接服务端可选, 非加密直连时实现 TCP 连接 tc_iot_hal_net_is_connected 判断当前是否已成功建立网络连接可选, 非加密直连时实现第 20 共 28 页

21 功能分类函数名说明是否可选 TCP 连接 tc_iot_hal_net_write 发送数据到网络对端可选, 非加密直连时实现 TCP 连接 tc_iot_hal_net_read 接收网络对端发送的数据可选, 非加密直连时实现 TCP 连接 tc_iot_hal_net_disconnect 断开网络连接可选, 非加密直连时实现 TCP 连接 tc_iot_hal_net_destroy 释放网络相关资源可选, 非加密直连时实现 TLS 功能分类函数名说明是否可选 TLS 连接 tc_iot_hal_tls_init 初始化 TLS 连接数据可选, 基于 TLS 加密通讯时实现 TLS 连接 tc_iot_hal_tls_connect 连接 TLS 服务端并进行相关握手及认证可选, 基于 TLS 加密通讯时实现 TLS 连接 tc_iot_hal_tls_is_connected 判断当前是否已成功建立 TLS 连接可选, 基于 TLS 加密通讯时实现 TLS 连接 tc_iot_hal_tls_write 发送数据到 TLS 对端 TLS 连接 tc_iot_hal_tls_read 接收 TLS 对端发送的数据 TLS 连接 tc_iot_hal_tls_disconnect 断开 TLS 连接 TLS 连接 tc_iot_hal_tls_destroy 释放 TLS 相关资源可选, 基于 TLS 加密通讯时实现可选, 基于 TLS 加密通讯时实现可选, 基于 TLS 加密通讯时实现可选, 基于 TLS 加密通讯时实现第 21 共 28 页

规则引擎概述最近更新时间 :2018-08-27 15:21:38 介绍规则引擎在传统软件行业中是一种嵌入在应用程序中的组件, 实现了将业务决策从应用程序代码中分离出来, 并使用预定义的语义模块编写业务决策接受数据输入, 解释业务规则, 并根据业务规则做出业务决策而物联网数据量巨大业务多样, 为了更好地处理数据和适应业务发展, 需要简单高效地提供数据处理, 解释业务的规则引擎

22 规则引擎概述最近更新时间 : :21:38 介绍规则引擎在传统软件行业中是一种嵌入在应用程序中的组件, 实现了将业务决策从应用程序代码中分离出来, 并使用预定义的语义模块编写业务决策接受数据输入, 解释业务规则, 并根据业务规则做出业务决策而物联网数据量巨大业务多样, 为了更好地处理数据和适应业务发展, 需要简单高效地提供数据处理, 解释业务的规则引擎构成规则引擎类由规则与行为构成, 规则定义如何处理数据, 使用 SQL 语句, 表达了从哪些 topic 中, 在何种情况下, 如何处理消息数据行为则定义了处理好的数据进行怎样的操作, 如转发给其他 topic, 可以被其他设备订阅, 或转发至其他云产品中注意设备消息需要为 JSON 格式, 否则无法对消息进行处理创建规则登录腾讯云物联网套件控制台, 选择规则引擎页, 单击创建规则创建成功的规则默认状态是禁用, 在规则管理页面选择是否启用该规则注意 : 启用状态下无法编辑规则第 22 共 28 页

23 第 23 共 28 页

24 规则最近更新时间 : :47:39 规则引擎的规则部分定义了如何提取数据规则使用类 SQL 语句, 如果接收到的消息符合设定的 topic, 且 conditions 条件满足, 就触发规则, 示例如下 : SELECT fields FROM "topic" WHERE conditions 例子 :SELECT temperature as t,deviceid FROM horse_monitor/thermometer/get WHERE deviceid="123" AND temperature > 30 假设设备 (test1) 的消息 playload 为 { "deviceid":123, "location":45, "temperature":25, "targetdevice": ccc, "arr":[{d:1},{d:2}], "msg":{ a:55, b: 222, c:{a:88} } } Fields 字段使用 JSON 表达式形式引用, 支持数组, 同时可以支持一些函数, 包括 math 类的基本函数, 以及一些获取 topic 分段信息等其他函数示例 :SELECT msg.c.a a1,localtion a2,".arr[1].d" a3 此时对应提取的是 :a1=88,a2=45,a3=2 当前支持的函数列表, 后续会支持更多的函数函数名 topic(number) 函数说明返回 topic 分段信息, 比如这个 topic:/abc/de,topic() 返回 "/abc/de",topic(1) 返回 "abc",topic(2) 返回 "de" 第 24 共 28 页

函数名函数说明 upper(string) lower(string) 返回大写字符串返回小写字符串 concat(string1, string2) mod(n, m) rand() 字符串连接, 比如 concat(deviceid, a ) 返回 n%m 的余数返回 [0~1] 之间的随机数 Topic 字段 Topic 支持通配符 +: 代表本级所有类目, 例如 topic 为

25 函数名函数说明 upper(string) lower(string) 返回大写字符串返回小写字符串 concat(string1, string2) mod(n, m) rand() 字符串连接, 比如 concat(deviceid, a ) 返回 n%m 的余数返回 [0~1] 之间的随机数 Topic 字段 Topic 支持通配符 +: 代表本级所有类目, 例如 topic 为 /productid/+/update #: 这个通配符必须出现在最后一个类目, 代表本级及下级所有类目例如 Topic 为 /productid/#, 不仅可以代表 /productid/device1/update, 也可以代表 /productid/device1/update/error Condition 字段可以支持引用 JSON, 示例 :where temperature > 30 编辑规则选择规则的管理页面第 25 共 28 页

26 单击选择数据的编辑, 完成 Fileds 字段,Topic,Condition 的编辑与修改第 26 共 28 页

27 行为最近更新时间 : :08:59 规则引擎的行为代表了对于处理好的数据可以做怎样的操作, 当前支持转发至其他 Topic 或者转发至第三方 API 转发其他 Topic 时可以使用 ${xxx} 引用上下文值, 例如提取时 select a.b targetdevice from productid/+/update, 行为定义 Topic 时, 可以引用 targetdevice, 例如转发到 productid/${targetdevice}/get 转发至第三方 API 时需正确填写第三方 API 的 URL 转发其他 Topic 用户定义转发至哪个 Topic 上面转发至第三方 API 第 27 共 28 页

28 用户定义第三方 API 的地址以及端口, 如 < 第 28 共 28 页

Domain Management产品文档

Domain Management产品文档腾讯云Content Delivery Network Domain Management 产品文档版权声明 2015-2016 腾讯云版权所有本文档著作权归腾讯云单独所有未经腾讯云事先书面许可任何主体不得以任何形式复制修改抄袭传播全部或部分本文档内容商标声明及其它腾讯云服务相关的商标均为腾讯云计算北京有限责任公司及其关联公司所有本文档涉及的第三方主体的商标依法由权利人所有