1@page adc adc
2
3[更正文档](https://gitee.com/alios-things/adc/edit/master/README.md)      [贡献说明](https://help.aliyun.com/document_detail/302301.html)
4
5# 概述
6ADC（Analog-to-Digital Converter），即模拟数字转换器，用于将模拟形式的连续信号转换为数字形式的离散信号的一类设备。典型的ADC设备将模拟信号转换为表示一定比例电压值的数字信号。
7该组件是ADC VFS驱动子系统，给应用或组件提供通过VFS形式（open/close/ioctl）访问ADC控制器驱动对上层提供服务的接口。该组件初始化过程中，会根据hardware/chip/<chip_name>/package.yaml中定义的CONFIG_ADC_NUM来依此创建如下名称的设备节点：
8* /dev/adc0
9* /dev/adc1
10* ...
11* /dev/adc[CONFIG_ADC_NUM - 1]
12
13组件支持以下功能：
14- 从ADC设备读取数据
15
16## 版权信息
17> Apache license v2.0
18
19## 目录结构
20```tree
21adc/
22|-- example
23|   |-- adc_example.c   #ADC示例代码
24|-- include
25|   |-- aos
26|   |   |-- hal
27|   |       |-- adc.h   #ADC HAL API申明
28|   |-- vfsdev
29|       |-- adc_dev.h   #ADC设备API申明
30|-- package.yaml        #编译和配置文件
31|-- README.md           #使用文档
32|-- src
33    |-- adc_dev.c      #ADC设备实现代码
34```
35
36## 依赖组件
37* base     # 最底层核心驱动模型、驱动自动加载机制以及Device VFS core
38* vfs      # VFS API抽象库
39
40# 常用配置
41本组件可以通过CONFIG_ADC_NUM配置对上层提供设备节点的数量，CONFIG_ADC_NUM代表芯片内部的ADC控制器的数量。
42CONFIG_ADC_NUM默认是在hardware/chip/<chip_name>/package.yaml中的**def_config**节点进行配置。
43如果没有定义CONFIG_ADC_NUM，则代码中会定义默认对外输出的设备节点数量。
44> 设备节点数量: 默认4个, 如需修改，在hardware/chip/<chip_name>/package.yaml中修改CONFIG_ADC_NUM配置
45```yaml
46def_config:
47  CONFIG_ADC_NUM: 2
48```
49
50# API说明
51应用可以选择使用ADC VFS API或者原生的AOS ADC API。
52
53- ADC VFS API 参考 [adc_device_api](https://g.alicdn.com/alios-things-3.3/doc/group__adc__device__api.html)
54- AOS ADC API 参考 [aos_adc_app_api](https://g.alicdn.com/alios-things-3.3/doc/group__aos__adc__app.html)
55
56芯片驱动对接
57
58- ADC驱动操作API 参考 [aos_adc_driver_api](https://g.alicdn.com/alios-things-3.3/doc/group__aos__adc__driver.html)
59
60# 使用示例
61
62组件使用示例相关的代码下载、编译和固件烧录均依赖AliOS Things配套的开发工具，所以首先需要参考[《AliOS Things集成开发环境使用说明之搭建开发环境》](https://help.aliyun.com/document_detail/302378.html)，下载安装。
63待开发环境搭建完成后，可以按照以下步骤进行示例的测试。
64
65## 步骤1 创建或打开工程
66
67**打开已有工程**
68
69如果用于测试的案例工程已存在，可参考[《AliOS Things集成开发环境使用说明之打开工程》](https://help.aliyun.com/document_detail/302381.html)打开已有工程。
70
71**创建新的工程**
72
73组件的示例代码可以通过编译链接到AliOS Things的任意案例（solution）来运行，这里选择helloworld_demo案例。helloworld_demo案例相关的源代码下载可参考[《AliOS Things集成开发环境使用说明之创建工程》](https://help.aliyun.com/document_detail/302379.html)。
74
75## 步骤2 添加组件
76
77案例下载完成后，需要在helloworld_demo组件的package.yaml中添加对组件的依赖：
78
79```yaml
80
81depends:
82  - adc: master          # helloworld_demo中引入adc组件
83
84```
85
86## 步骤3 下载组件
87
88在已安装了  的开发环境工具栏中，选择Terminal -> New Terminal启动终端，并且默认工作路径为当前工程的workspace，此时在终端命令行中输入：
89
90```shell
91
92aos install adc
93
94```
95
96上述命令执行成功后，组件源码则被下载到了./components/drivers/peripheral/adc路径中。
97
98## 步骤4 添加示例
99
100在adc组件的package.yaml中添加[example示例代码](https://gitee.com/alios-things/adc/tree/master/example)：
101
102```yaml
103source_file:
104  - "src/*.c"
105  - "example/adc_example.c"
106  - "example/aos_adc_example.c"
107```
108
109## 步骤5 编译固件
110
111在示例代码已经添加至组件的配置文件，并且helloworld_demo已添加了对该组件的依赖后，就可以编译helloworld_demo案例来生成固件了，具体编译方法可参考[《AliOS Things集成开发环境使用说明之编译固件》](https://help.aliyun.com/document_detail/302384.html)。
112
113## 步骤6 烧录固件
114
115helloworld_demo案例的固件生成后，可参考[《AliOS Things集成开发环境使用说明之烧录固件》](https://help.aliyun.com/document_detail/302383.html)来烧录固件。
116
117## 步骤7 打开串口
118
119固件烧录完成后，可以通过串口查看示例的运行结果，打开串口的具体方法可参考[《AliOS Things集成开发环境使用说明之查看日志》](https://help.aliyun.com/document_detail/302382.html)。
120
121当串口终端打开成功后，可在串口中输入help来查看已添加的测试命令。
122
123## 步骤8 测试示例
124
125**CLI命令行输入：**
126```shell
127
128adc_example # 执行adc vfs api 示例
129
130```
131
132> 关键日志：
133```shell
134
135vfs adc test success, ret:0
136
137```
138
139**CLI命令行输入：**
140```shell
141
142aos_adc_example # 执行aos adc api 示例
143
144```
145
146> 关键日志：
147```shell
148
149aos adc example test success!
150
151```
152
153# 注意事项
154无
155
156# FAQ
157无
158