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