• Home
  • Annotate
  • current directory
Name Date Size #Lines LOC

..29-Oct-2021-

example/29-Oct-2021-

include/29-Oct-2021-

internal/29-Oct-2021-

src/29-Oct-2021-

README.md A D29-Oct-20215 KiB147111

package.yaml A D29-Oct-20214.1 KiB

README.md

1@page uagent uagent
2
3[更正文档](https://gitee.com/alios-things/uagent/edit/master/README.md)      [贡献说明](https://help.aliyun.com/document_detail/302301.html)
4
5# 概述
6uagent是AliOS Things的模块，支持其他客户模块(ulog，cli，ota，uND)将其服务注册到其中。 从云(面向维护平台)的服务调用可以通过uagent调用设备的服务，uagent还可以帮助客户模块发送信息，以帮助显示其工作状态。
7
8## 版权信息
9> Apache license v2.0
10
11## 目录结构
12```tree
13uagent/
14├── doc
15│   └──README.md
16├── example
17│   └──uagent_example.c
18├── include
19│   ├── uagent_config.h
20│   ├── uagent_type.h
21│   └── uagent.h
22├── internal
23│   └── uagent_inner_api.h
24├── src
25│   ├── uagent_comm_mqtt.c
26│   ├── uagent_core.c
27│   ├── uagent_send.c
28│   └── uagent_utility.c
29└── package.yaml
30```
31
32## 依赖组件
33* linksdk
34
35# 常用配置
36
37# API说明
38@ref uagent_init
39@ref uagent_mqtt_client_set
40@ref uagent_ext_comm_start
41@ref uagent_register
42@ref uagent_unregister
43@ref uagent_request_service
44@ref uagent_send
45
46
47# 使用示例
48组件使用示例相关的代码下载、编译和固件烧录均依赖AliOS Things配套的开发工具，所以首先需要参考[《AliOS Things集成开发环境使用说明之搭建开发环境》](https://help.aliyun.com/document_detail/302378.html)，下载安装。
49待开发环境搭建完成后，可以按照以下步骤进行示例的测试。
50
51## 步骤1 创建或打开工程
52
53**打开已有工程**
54
55如果用于测试的案例工程已存在，可参考[《AliOS Things集成开发环境使用说明之打开工程》](https://help.aliyun.com/document_detail/302381.html)打开已有工程。
56
57**创建新的工程**
58
59组件的示例代码可以通过编译链接到AliOS Things的任意案例（solution）来运行，这里选择helloworld_demo案例。helloworld_demo案例相关的源代码下载可参考[《AliOS Things集成开发环境使用说明之创建工程》](https://help.aliyun.com/document_detail/302379.html)。
60
61## 步骤2 添加组件
62
63案例下载完成后，需要在helloworld_demo组件的package.yaml中添加对组件的依赖：
64
65> linkitsdk_dmeo solutions的package.yaml中添加依赖组件uagent组件
66```yaml
67depends:                                       # 该组件依赖其他的组件
68  - linksdk: master
69  - haas100: master
70  - mbedtls: master
71  - netmgr: master
72  - uagent: master   #添加uagent组件
73```
74## 步骤3 下载组件
75
76在已安装了  的开发环境工具栏中，选择Terminal -> New Terminal启动终端，并且默认工作路径为当前工程的workspace，此时在终端命令行中输入：
77
78```shell
79
80aos install uagent
81
82```
83
84上述命令执行成功后，组件源码则被下载到了./components/uagent路径中。
85
86## 步骤4 添加示例
87
88> uagent组件的package.yaml中添加[example示例代码](https://gitee.com/alios-things/uagent/tree/master/example)：
89```yaml
90source_file:
91  - "src/uagent_comm_mqtt.c"
92  - "src/uagent_core.c"
93  - "src/uagent_send.c"
94  - "src/uagent_utility.c"
95  - "example/uagent_example.c"
96```
97
98>在data_model_basic_demo.c中修改三元组信息为阿里云物联网平台创建的设备信息
99```c
100    /* TODO: 替换为自己设备的三元组 */
101    char *product_key       = "a1jMbw3BI9t";
102    char *device_name       = "HAAS100SDFASDFAS";
103    char *device_secret     = "61eda487b3ffcfa7d08eae012e40ba28";
104```
105
106>在data_model_basic_demo.c中添加uagent设置mqtthandle，在连接上阿里云物联网平台(MQTT)后添加
107```c
108    uagent_mqtt_client_set(mqtt_handle); //设置uagent用于连接mqtt的handle，必须在linksdk连接上云后设置
109    uagent_ext_comm_start(product_key, device_name);  //设置uagent的PK与DN，与linksdk中的pk，dn一致
110    /* 主循环进入休眠 */
111    while (1) {
112        aos_msleep(1000);
113    }
114```
115
116## 步骤5 编译固件
117
118在示例代码已经添加至组件的配置文件，并且helloworld_demo已添加了对该组件的依赖后，就可以编译helloworld_demo案例来生成固件了，具体编译方法可参考[《AliOS Things集成开发环境使用说明之编译固件》](https://help.aliyun.com/document_detail/302384.html)。
119
120## 步骤6 烧录固件
121
122helloworld_demo案例的固件生成后，可参考[《AliOS Things集成开发环境使用说明之烧录固件》](https://help.aliyun.com/document_detail/302383.html)来烧录固件。
123
124## 步骤7 打开串口
125
126固件烧录完成后，可以通过串口查看示例的运行结果，打开串口的具体方法可参考[《AliOS Things集成开发环境使用说明之查看日志》](https://help.aliyun.com/document_detail/302382.html)。
127
128当串口终端打开成功后，可在串口中输入help来查看已添加的测试命令。
129
130## 步骤8 测试示例
131
132**CLI命令行输入：**
133>连接网络
134```sh
135netmgr -t wifi -c <wifi_ssid> <wifi_pwd>
136```
137> CLI关键日志：
138```sh
139[49.030][LK-0313] MQTT connect success in 202 ms
140```
141**CLI命令行输入：**
142> uagent测试cli
143```sh
144uagent_example
145```
146# FAQ
147