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

..29-Oct-2021-

example/29-Oct-2021-

include/29-Oct-2021-

src/29-Oct-2021-

README.md A D29-Oct-20215.3 KiB166109

package.yaml A D29-Oct-20214 KiB

README.md

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