1@page ili9341 ili9341
2
3[更正文档](https://gitee.com/alios-things/ili9341/edit/master/README.md)      [贡献说明](https://help.aliyun.com/document_detail/302301.html)
4
5# 概述
6LCD (Liquid Crystal Display) 即液晶显示器。AliOS Things 提供了多款LCD组件供开发者使用，适配了目前应用最多的LCD模块。
7组件支持以下功能：
8- LCD 绘制简单几何图形
9- LCD 基于 fbdev组件 (frame buffer) 和 udisplay组件 对接更高层的图形库如 LVGL 或 SDL
10- 支持接入多块 LCD
11
12## 版权信息
13> Apache license v2.0
14
15## 目录结构
16```tree
17├── src
18│   ├── ili9341.c                # ili9341驱动组件实现
19│   └── ili9341_fb.c             # ili9341驱动注册到fbdev的函数实现
20├── include
21│   ├── ili9341.h
22│   └── ili9341_fb.h             # ili9341驱动注册到fbdev的函数头文件
23├── example
24│   └── ili9341_example.c        # 测试代码
25├── package.yaml                # 编译配置文件
26└── README.md                   # 组件使用文档
27```
28
29## 依赖组件
30* base
31* vfs
32* spi
33* gpio
34
35# 常用配置
36``` c
37typedef struct _ili9341_dev_t
38{
39    int spi_port;       // 屏幕使用的SPI口
40    int spi_freq;       // SPI的驱动频率
41    int gpio_dc_id;     // D/C引脚对应开发板的PIN脚
42    int gpio_reset_id;  // ResetT引脚对应开发板的PIN脚
43    int gpio_bgl_id;    // BackGroundLight引脚对应开发板的PIN脚 对于部分开发板 可以直接接入VCC代表背光常亮
44
45    int spi_fd;
46    int gpio_fd;
47} ili9341_dev_t;
48```
49
50# API说明
51## ili9341硬件初始化
52```C
53int ili9341_hw_init(ili9341_dev_t *ili9341_dev)
54```
55
56|args                                    |description|
57|:-----                                  |:----|
58|ili9341_dev                              |ili9341设备结构体 注意以指针形式访问|
59
60## ili9341硬件去初始化
61```C
62int ili9341_hw_uninit(ili9341_dev_t *ili9341_dev)
63```
64
65|args                                    |description|
66|:-----                                  |:----|
67|ili9341_dev                              |ili9341设备结构体 注意以指针形式访问|
68
69## ili9341绘画像素点
70```C
71void ili9341_draw_pixel(ili9341_dev_t ili9341_dev, uint16_t x, uint16_t y, uint16_t color)
72```
73
74|args                                    |description|
75|:-----                                  |:----|
76|ili9341_dev                              |ili9341设备结构体|
77|x, y                                    |像素点相对屏幕坐标|
78|color                                   |画笔颜色 (如白色 0xffff)|
79
80
81## ili9341区域绘画
82```C
83void ili9341_draw_area(ili9341_dev_t ili9341_dev, uint16_t x, uint16_t y, uint16_t width, uint16_t height, uint8_t *frame)
84```
85
86|args                                    |description|
87|:-----                                  |:----|
88|ili9341_dev                              |ili9341设备结构体|
89|x, y                                    |区域左上角相对屏幕坐标|
90|width, height                           |区域宽高|
91|frame                                   |绘画内容|
92
93## ili9341绘画矩形
94```C
95void ili9341_draw_rect(ili9341_dev_t ili9341_dev, uint16_t x, uint16_t y, uint16_t width, uint16_t height, uint16_t color)
96```
97
98|args                                    |description|
99|:-----                                  |:----|
100|ili9341_dev                              |ili9341设备结构体|
101|x, y                                    |矩形左上角相对屏幕坐标|
102|width, height                           |矩形宽高|
103|color                                   |画笔颜色 (如白色 0xffff)|
104
105## ili9341全屏填充
106```C
107void        ili9341_draw_frame(ili9341_dev_t ili9341_dev, uint8_t *frame)
108```
109
110|args                                    |description|
111|:-----                                  |:----|
112|ili9341_dev                              |ili9341设备结构体|
113|frame                                   |待填充数据，构建frame时需根据屏幕分辨率来确定大小|
114
115# 使用示例
116组件使用示例相关的代码下载、编译和固件烧录均依赖AliOS Things配套的开发工具，所以首先需要参考[《AliOS Things集成开发环境使用说明之搭建开发环境》](https://help.aliyun.com/document_detail/302378.html)，下载安装。
117待开发环境搭建完成后，可以按照以下步骤进行示例的测试。
118
119## 步骤1 创建或打开工程
120
121**打开已有工程**
122
123如果用于测试的案例工程已存在，可参考[《AliOS Things集成开发环境使用说明之打开工程》](https://help.aliyun.com/document_detail/302381.html)打开已有工程。
124
125**创建新的工程**
126
127组件的示例代码可以通过编译链接到AliOS Things的任意案例（solution）来运行，这里选择helloworld_demo案例。helloworld_demo案例相关的源代码下载可参考[《AliOS Things集成开发环境使用说明之创建工程》](https://help.aliyun.com/document_detail/302379.html)。
128
129## 步骤2 添加ili9341组件
130> helloworld_demo组件的package.yaml中添加
131```sh
132depends:
133  - ili9341: master # helloworld_demo中引入ili9341组件
134```
135
136## 步骤3 下载组件
137
138在已安装了  的开发环境工具栏中，选择Terminal -> New Terminal启动终端，并且默认工作路径为当前工程的workspace，此时在终端命令行中输入：
139
140```shell
141
142aos install ili9341
143
144```
145
146上述命令执行成功后，组件源码则被下载到了./components/drivers/external_device路径中。
147
148
149## 步骤4 添加示例代码
150> 向ili9341组件的package.yaml中添加example
151```sh
152source_file:
153  - "src/*.c"
154  - "example/ili9341_example.c" # add ili9341_example.c
155```
156
157## 步骤5 编译固件
158
159在示例代码已经添加至组件的配置文件，并且helloworld_demo已添加了对该组件的依赖后，就可以编译helloworld_demo案例来生成固件了，具体编译方法可参考[《AliOS Things集成开发环境使用说明之编译固件》](https://help.aliyun.com/document_detail/302384.html)。
160
161## 步骤6 烧录固件
162
163helloworld_demo案例的固件生成后，可参考[《AliOS Things集成开发环境使用说明之烧录固件》](https://help.aliyun.com/document_detail/302383.html)来烧录固件。
164
165## 步骤7 打开串口
166
167固件烧录完成后，可以通过串口查看示例的运行结果，打开串口的具体方法可参考[《AliOS Things集成开发环境使用说明之查看日志》](https://help.aliyun.com/document_detail/302382.html)。
168
169当串口终端打开成功后，可在串口中输入help来查看已添加的测试命令。
170
171## 步骤8 ili9341示例测试
172> CLI命令行输入(初始化屏幕)：
173```sh
174ili9341_hw_init_example
175```
176> CLI命令行输入(随机在屏幕上画矩形)
177
178```sh
179ili9341_draw_ract_example 0x0000
180```
181注： 0x0000 是 RGB565 的颜色设置
182
183> CLI日志：
184```sh
185drawing rectangle at 233 55 183 159 in color 1AC1
186```
187