1@page netmgr netmgr
2
3[更正文档](https://gitee.com/alios-things/netmgr/edit/master/README.md)      [贡献说明](https://help.aliyun.com/document_detail/302301.html)
4
5# 概述
6
7Netmgr是AliOS Things为支持不同的网络连接芯片类型和多元的应用场景，提供的一套完善的网络管理框架，包括网络接入管理、连接设备管理等功能。
8
9## 版权信息
10
11> Apache license v2.0
12
13## 目录结构
14
15```tree
16├── example
17│   └── netmgr_example.c           # netmgr示例代码
18├── include
19│   ├── netmgr.h                   # netmgr对外头文件
20│   └── netmgr_wifi.h              # netmgr wifi相关的头文件
21├── include_inner                  # netmgr内部使用的头文件
22│   ├── netmgr_conn.h
23│   ├── netmgr_service.h
24│   └── string_convert.h
25├── package.yaml                   # netmgr编译配置文件
26├── README.md                      # README文档
27└── src                            # netmgr核心实现代码
28    ├── netmgr_conn.c              # 连接管理
29    ├── netmgr_eth.c               # 以太网网络管理
30    ├── netmgr_gprs.c              # GPRS网络管理
31    ├── netmgr_nbiot.c             # NBIoT网络管理
32    ├── netmgr_service.c           # netmgr服务管理
33    ├── netmgr_wifi.c              # wifi网络管理
34    └── string_convert.c           # 字符转换
35```
36## 依赖组件
37
38* drivers
39* osal_aos
40* uservice
41* sntp
42* posix
43
44# 常用配置
45
46系统中相关配置已有默认值，可以在yaml中**def_config**节点修改，具体如下：
47> 是否上报激活信息
48```yaml
49def_config:
50  AOS_COMP_ACTIVATION: y
51```
52# API说明
53
54- 参考 [netmgr_api](https://g.alicdn.com/alios-things-3.3/doc/group__netmgr__api.html)
55
56# 使用示例
57
58组件使用示例相关的代码下载、编译和固件烧录均依赖AliOS Things配套的开发工具，所以首先需要参考[《AliOS Things集成开发环境使用说明之搭建开发环境》](https://help.aliyun.com/document_detail/302378.html)，下载安装。
59待开发环境搭建完成后，可以按照以下步骤进行示例的测试。
60
61## 步骤1 创建或打开工程
62
63**打开已有工程**
64
65如果用于测试的案例工程已存在，可参考[《AliOS Things集成开发环境使用说明之打开工程》](https://help.aliyun.com/document_detail/302381.html)打开已有工程。
66
67**创建新的工程**
68
69组件的示例代码可以通过编译链接到AliOS Things的任意案例（solution）来运行，这里选择helloworld_demo案例。helloworld_demo案例相关的源代码下载可参考[《AliOS Things集成开发环境使用说明之创建工程》](https://help.aliyun.com/document_detail/302379.html)。
70
71## 步骤2 添加组件
72
73案例下载完成后，需要在helloworld_demo组件的package.yaml中添加对组件的依赖：
74```sh
75depends:
76  - netmgr: master
77```
78## 步骤3 下载组件
79
80在已安装了  的开发环境工具栏中，选择Terminal -> New Terminal启动终端，并且默认工作路径为当前工程的workspace，此时在终端命令行中输入：
81
82```shell
83
84aos install netmgr
85
86```
87
88上述命令执行成功后，组件源码则被下载到了./components/netmgr路径中。
89
90## 步骤4 添加示例
91
92> netmgr组件的package.yaml中添加[example示例代码](https://gitee.com/alios-things/netmgr/tree/master/example)：
93
94```sh
95source_file:
96  - src/netmgr_service.c
97  - src/netmgr_wifi.c
98  - src/netmgr_conn.c
99  - src/string_convert.c
100  - activation/*.c ? <AOS_COMP_ACTIVATION>
101  - example/*.c
102```
103
104## 步骤5 编译固件
105
106在示例代码已经添加至组件的配置文件，并且helloworld_demo已添加了对该组件的依赖后，就可以编译helloworld_demo案例来生成固件了，具体编译方法可参考[《AliOS Things集成开发环境使用说明之编译固件》](https://help.aliyun.com/document_detail/302384.html)。
107
108## 步骤6 烧录固件
109
110helloworld_demo案例的固件生成后，可参考[《AliOS Things集成开发环境使用说明之烧录固件》](https://help.aliyun.com/document_detail/302383.html)来烧录固件。
111
112## 步骤7 打开串口
113
114固件烧录完成后，可以通过串口查看示例的运行结果，打开串口的具体方法可参考[《AliOS Things集成开发环境使用说明之查看日志》](https://help.aliyun.com/document_detail/302382.html)。
115
116当串口终端打开成功后，可在串口中输入help来查看已添加的测试命令。
117
118## 步骤8 测试示例
119
120> CLI命令行输入netmgr_example，初始化netmgr服务
121```sh
122netmgr_example
123```
124> CLI命令行连路由器：输入netmgr -t wifi -c wifi_ssid(根据情况输入自己的wifi名) wifi_password(输入wifi密码)
125```sh
126netmgr -t wifi -c HUAWEI_AP abcdefg1234
127```
128> CLI命令行起AP热点：输入netmgr -t wifi -z svr_ip(AP IP地址) gw_ip(网关IP地址) netmask_ip(子网掩码) wifi_ssid(根据情况输入自己的wifi名) wifi_password(输入wifi密码) beacon_interval(信标间隔时槽)
129```sh
130netmgr -t wifi -z 192.168.0.1 192.168.0.1 255.255.255.0 ipc_route 12345678 10
131```
132
133**关键日志**
134> CLI日志：
135
136```sh
137netmgr test
138```
139```sh
140Got IP
141```
142
143# 注意事项
144
145- netmgr对系统的event service有依赖，需要在调用netmgr_service_init前，先调用event_service_init函数。
146
147# FAQ
148
149- NA
150