1@page rx8130ce rx8130ce
2
3[更正文档](https://gitee.com/alios-things/rx8130ce/edit/master/README.md)      [贡献说明](https://help.aliyun.com/document_detail/302301.html)
4
5# 概述
6
7RX8130CE是一颗RTC芯片，基于I2C总线进行通信，其内建了32.768KHZ的晶振，功能完备，HaaS100的板上就使用了这颗。本文档描述了该芯片的驱动详情，包括目录结构，依赖情况，API，使用等情况，供用户参考。
8组件支持以下功能：
9
10- rx8130ce初始化
11- 设置时间
12- 读取时间
13
14## 版权信息
15
16> Apache license v2.0
17
18## 目录结构
19
20```tree
21├── example
22│   └── rx8130ce_example.c
23├── include
24│   └── rx8130ce.h
25├── internal
26│   └── rtcif.h
27├── package.yaml
28├── README.md
29└── src
30    ├── rtcif.c
31    └── rx8130ce.c
32```
33
34## 依赖组件
35
36- base
37- vfs
38- pca9544
39
40
41# 常用配置
42
43# API说明
44
45```c
46/*********************************************************
47 * @fun    rx8130ce_init
48 * @breif  rx8130ce initialization
49 * @param  none
50 * @rtn    0 : on success, EIO : error
51 *********************************************************/
52int rx8130ce_init(void);
53
54/*********************************************************
55 * @fun    rx8130ce_set_time
56 * @param[in]  buf      the pointer for rx8130ce time
57 * @param[in]  len      the length of time
58 * @rtn    0 : on success, EIO : error
59 *********************************************************/
60int rx8130ce_set_time(const void *buf, uint8_t len);
61
62/*********************************************************
63 * @fun    rx8130ce_get_time
64 * @param[in]  buf      the pointer for rx8130ce time
65 * @param[in]  len      the length of time
66 * @rtn    0 : on success, EIO : error
67 *********************************************************/
68int rx8130ce_get_time(void *buf, uint8_t len);
69```
70
71# 使用示例
72
73组件使用示例相关的代码下载、编译和固件烧录均依赖AliOS Things配套的开发工具，所以首先需要参考[《AliOS Things集成开发环境使用说明之搭建开发环境》](https://help.aliyun.com/document_detail/302378.html)，下载安装。
74待开发环境搭建完成后，可以按照以下步骤进行示例的测试。
75
76## 步骤1 创建或打开工程
77
78**打开已有工程**
79
80如果用于测试的案例工程已存在，可参考[《AliOS Things集成开发环境使用说明之打开工程》](https://help.aliyun.com/document_detail/302381.html)打开已有工程。
81
82**创建新的工程**
83
84组件的示例代码可以通过编译链接到AliOS Things的任意案例（solution）来运行，这里选择helloworld_demo案例。helloworld_demo案例相关的源代码下载可参考[《AliOS Things集成开发环境使用说明之创建工程》](https://help.aliyun.com/document_detail/302379.html)。
85
86## 步骤2 添加rx8130ce组件
87
88> helloworld_demo组件的package.yaml中添加
89
90```bash
91depends:
92  - rx8130ce: master # helloworld_demo中引入rx8130ce组件
93```
94
95## 步骤3 下载组件
96
97在已安装了  的开发环境工具栏中，选择Terminal -> New Terminal启动终端，并且默认工作路径为当前工程的workspace，此时在终端命令行中输入：
98
99```shell
100
101aos install rx8130ce
102
103```
104
105上述命令执行成功后，组件源码则被下载到了./components/drivers/external_device路径中。
106
107## 步骤4 添加示例代码
108
109> 向rx8130ce组件的package.yaml中添加example
110
111```bash
112source_file:
113  - "src/*.c"
114  - "example/rx8130ce_example.c" # add rx8130ce_example.c
115```
116
117## 步骤5 编译固件
118
119在示例代码已经添加至组件的配置文件，并且helloworld_demo已添加了对该组件的依赖后，就可以编译helloworld_demo案例来生成固件了，具体编译方法可参考[《AliOS Things集成开发环境使用说明之编译固件》](https://help.aliyun.com/document_detail/302384.html)。
120
121## 步骤6 烧录固件
122
123helloworld_demo案例的固件生成后，可参考[《AliOS Things集成开发环境使用说明之烧录固件》](https://help.aliyun.com/document_detail/302383.html)来烧录固件。
124
125## 步骤7 打开串口
126
127固件烧录完成后，可以通过串口查看示例的运行结果，打开串口的具体方法可参考[《AliOS Things集成开发环境使用说明之查看日志》](https://help.aliyun.com/document_detail/302382.html)。
128
129当串口终端打开成功后，可在串口中输入help来查看已添加的测试命令。
130
131## 步骤8 RX8130CE示例测试
132
133> CLI命令行输入：
134
135```bash
136rx8130ce_example
137```
138
139> CLI日志：
140
141```bash
142rx8130ce comp test success!
143```
144