1@page sntp sntp
2
3[更正文档](https://gitee.com/alios-things/sntp/edit/master/README.md)      [贡献说明](https://help.aliyun.com/document_detail/302301.html)
4
5# 概述
6
7简单网络时间协议（Simple Network Time Protocol），由NTP发展而来，为联网设备提供了一种同步网络时间的方式。AliOS Things为用户提供了sntp获取的接口，开发者在联网后，可方便获取网络时间。
8
9## 版权信息
10
11> Apache license v2.0
12
13## 目录结构
14
15```tree
16├── example
17│   └── sntp_example.c # sntp使用示例代码
18├── include
19│   └── sntp
20│       └── sntp.h     # sntp头文件
21├── package.yaml       # 编译配置文件
22├── README.md          # README文档
23└── src
24    └── sntp.c         # sntp核心实现代码
25```
26## 依赖组件
27
28* lwip
29
30# 常用配置
31
32```c
33// sntp.h
34
35SNTP端口号：
36#define SNTP_PORT                     123
37
38SNTP是否支持多服务器，以及服务器的个数
39#define SNTP_SUPPORT_MULTIPLE_SERVERS 1
40#if SNTP_SUPPORT_MULTIPLE_SERVERS
41#define SNTP_MAX_SERVERS              3
42#endif
43
44SNTP接收超时时间
45#define SNTP_RECV_TIMEOUT             3000 /* ms */
46
47SNTP重传时的接收超时
48#define SNTP_RETRY_TIMEOUT            SNTP_RECV_TIMEOUT
49
50SNTP最大重传次数
51#define SNTP_RETRY_TIMES              3
52
53SNTP服务器地址
54#define SNTP_SERVER_ADDRESS          "pool.ntp.org"
55```
56
57# API说明
58
59- 参考 [sntp_api](https://g.alicdn.com/alios-things-3.3/doc/group__sntp__api.html)
60
61## 发送获取sntp请求
62
63```C
64int sntp_request(void *arg)
65```
66
67| args | description        |
68| :--- | :----------------- |
69| arg  | 用户数据结构体指针 |
70
71## 获取sntp请求结果
72
73```C
74sntp_time *sntp_obtain_time(void)
75```
76
77| args | description |
78| :--- | :---------- |
79| void | NA          |
80
81# 使用示例
82
83组件使用示例相关的代码下载、编译和固件烧录均依赖AliOS Things配套的开发工具，所以首先需要参考[《AliOS Things集成开发环境使用说明之搭建开发环境》](https://help.aliyun.com/document_detail/302378.html)，下载安装。
84待开发环境搭建完成后，可以按照以下步骤进行示例的测试。
85
86## 步骤1 创建或打开工程
87
88**打开已有工程**
89
90如果用于测试的案例工程已存在，可参考[《AliOS Things集成开发环境使用说明之打开工程》](https://help.aliyun.com/document_detail/302381.html)打开已有工程。
91
92**创建新的工程**
93
94组件的示例代码可以通过编译链接到AliOS Things的任意案例（solution）来运行，这里选择helloworld_demo案例。helloworld_demo案例相关的源代码下载可参考[《AliOS Things集成开发环境使用说明之创建工程》](https://help.aliyun.com/document_detail/302379.html)。
95
96## 步骤2 添加组件
97
98案例下载完成后，需要在helloworld_demo组件的package.yaml中添加对组件的依赖：
99```yaml
100depends:
101  - sntp: master
102```
103
104## 步骤3 下载组件
105
106在已安装了  的开发环境工具栏中，选择Terminal -> New Terminal启动终端，并且默认工作路径为当前工程的workspace，此时在终端命令行中输入：
107
108```shell
109
110aos install sntp
111
112```
113
114上述命令执行成功后，组件源码则被下载到了./components/sntp路径中。
115
116## 步骤4 添加示例
117
118> sntp组件的package.yaml中添加[example示例代码](https://gitee.com/alios-things/sntp/tree/master/example)：
119```yaml
120source_file:
121    - src/*.c
122    - example/*.c
123```
124
125## 步骤5 编译固件
126
127在示例代码已经添加至组件的配置文件，并且helloworld_demo已添加了对该组件的依赖后，就可以编译helloworld_demo案例来生成固件了，具体编译方法可参考[《AliOS Things集成开发环境使用说明之编译固件》](https://help.aliyun.com/document_detail/302384.html)。
128
129## 步骤6 烧录固件
130
131helloworld_demo案例的固件生成后，可参考[《AliOS Things集成开发环境使用说明之烧录固件》](https://help.aliyun.com/document_detail/302383.html)来烧录固件。
132
133## 步骤7 打开串口
134
135固件烧录完成后，可以通过串口查看示例的运行结果，打开串口的具体方法可参考[《AliOS Things集成开发环境使用说明之查看日志》](https://help.aliyun.com/document_detail/302382.html)。
136
137当串口终端打开成功后，可在串口中输入help来查看已添加的测试命令。
138
139## 步骤8 测试示例
140
141> CLI命令行输入：
142```sh
143sntp_example
144```
145**关键日志**
146> CLI日志：
147
148```sh
149sntp test
15021-3-19: week: 5, 17:59:20
151```
152# 注意事项
153
154使用sntp服务，需要先连接网络
155
156# FAQ
157
158- NA
159