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

..29-Oct-2021-

example/29-Oct-2021-

include/29-Oct-2021-

internal/29-Oct-2021-

src/29-Oct-2021-

README.md A D29-Oct-20213.8 KiB11376

package.yaml A D29-Oct-20213.9 KiB

README.md

1@page ramfs ramfs
2
3# 概述
4ramfs是AliOS Things提供的基于RAM不依赖flash驱动的可读可写的文件系统。和ROMFS的区别在于ROMFS为只读，RAMFS可读写。
5主要特性包括：
6- 不依赖flash设备和驱动
7- 可读写创建文件等
8- 掉电不保存
9
10## 版权信息
11> Apache license v2.0
12
13## 目录结构
14```tree
15├── src
16│   ├── ramfs_adapt.c # ramfs和内核的对接层
17│   ├── ramfs.c       # ramfs核心代码
18│   └── ramfs_vfs.c   # ramfs和vfs对接层
19├── package.yaml      # 编译配置文件
20├── example           # 示例代码
21├── include           # 对外头文件
22│   └── ramfs.h
23└── internal          # 内部头文件
24```
25
26## 依赖组件
27* osal_aos
28
29# 常用配置
30无
31
32# API说明
33- 参考 [ramfs_aos_api](https://g.alicdn.com/alios-things-3.3/doc/group__ramfs__aos__api.html)
34注：ramfs本身只提供注册去注册接口；其他文件操作接口统一使用vfs接口/posix接口。
35
36# 使用示例
37组件使用示例相关的代码下载、编译和固件烧录均依赖AliOS Things配套的开发工具，所以首先需要参考[《AliOS Things集成开发环境使用说明之搭建开发环境》](https://help.aliyun.com/document_detail/302378.html)，下载安装。
38待开发环境搭建完成后，可以按照以下步骤进行示例的测试。
39
40## 步骤1 创建或打开工程
41
42**打开已有工程**
43
44如果用于测试的案例工程已存在，可参考[《AliOS Things集成开发环境使用说明之打开工程》](https://help.aliyun.com/document_detail/302381.html)打开已有工程。
45
46**创建新的工程**
47
48组件的示例代码可以通过编译链接到AliOS Things的任意案例（solution）来运行，这里选择helloworld_demo案例。helloworld_demo案例相关的源代码下载可参考[《AliOS Things集成开发环境使用说明之创建工程》](https://help.aliyun.com/document_detail/302379.html)。
49
50## 步骤2 添加组件
51
52案例下载完成后，需要在helloworld_demo组件的package.yaml中添加对组件的依赖：
53```yaml
54depends:
55  - ramfs: master # helloworld_demo中引入ramfs组件
56```
57
58## 步骤3 下载组件
59
60在已安装了  的开发环境工具栏中，选择Terminal -> New Terminal启动终端，并且默认工作路径为当前工程的workspace，此时在终端命令行中输入：
61
62```shell
63
64aos install ramfs
65
66```
67
68上述命令执行成功后，组件源码则被下载到了./components/ramfs路径中。
69
70## 步骤4 添加示例
71
72> ramfs组件的package.yaml中添加example
73```yaml
74source_file:
75  - example/*.c
76```
77
78## 步骤5 编译固件
79
80在示例代码已经添加至组件的配置文件，并且helloworld_demo已添加了对该组件的依赖后，就可以编译helloworld_demo案例来生成固件了，具体编译方法可参考[《AliOS Things集成开发环境使用说明之编译固件》](https://help.aliyun.com/document_detail/302384.html)。
81
82## 步骤6 烧录固件
83
84helloworld_demo案例的固件生成后，可参考[《AliOS Things集成开发环境使用说明之烧录固件》](https://help.aliyun.com/document_detail/302383.html)来烧录固件。
85
86## 步骤7 打开串口
87
88固件烧录完成后，可以通过串口查看示例的运行结果，打开串口的具体方法可参考[《AliOS Things集成开发环境使用说明之查看日志》](https://help.aliyun.com/document_detail/302382.html)。
89
90当串口终端打开成功后，可在串口中输入help来查看已添加的测试命令。
91
92## 步骤8 测试示例
93
94> CLI命令行输入：
95```sh
96ramfs_example
97```
98
99**关键日志**
100> CLI日志：
101```sh
102ramfs: fd test success!
103ramfs comp test success!
104```
105
106# 注意事项
107ramfs_register是ramfs的初始化接口，用户可自定义根路径，默认为"/RAMFS"；
108ramfs需要对接vfs使用，对外统一使用标准的open/read/write/close接口；
109
110# FAQ
111
112
113