1@page oled oled
2
3[更正文档](https://gitee.com/alios-things/sh1106/edit/master/README.md)      [贡献说明](https://help.aliyun.com/document_detail/302301.html)
4
5# 概述
6OLED,即有机发光二极管(Organic Light-Emitting Diode)。OLED 由于同时具备自发光,不需背光源、对比度高、厚度薄、视角广、反应速度快、可用于挠曲性面板、使用温度范围广、构造及制程较简单等优异之特性。
7与LCD相比,LCD需要背光,同样的显示,OLED 效果要来得好一些,OLED分辨率可以做到很高。
8本组件是为1.3寸OLED屏驱动IC-SSD1106(与0.96寸OLED稍有不同,SSD1306),SSD1106点阵132*64,SSD1306点阵128*64,都是8页的显存,SSD1106每页132字节,SSD1306每页128字节。
9下面看一下其对应关系(SSD1106 1.3寸OLED为例)
10![](https://img.alicdn.com/imgextra/i2/O1CN01mlGbcq1LHXFq3FGkJ_!!6000000001274-2-tps-1362-656.png)
11与HaaS100的连接
12![](https://img.alicdn.com/imgextra/i3/O1CN01RRxCJH1zqsS4JH5zh_!!6000000006766-2-tps-1118-582.png)
13## 版权信息
14
15
16> Apache license v2.0
17
18
19
20## 目录结构
21
22
23```tree
24├── src
25│   └── sh1106.c          # 基于sh1106 OLED组件服务
26├── include
27│   ├── front.h           # 字模库文件。
28│   ├── icon.h            # 声卡pcm设备驱动,例如录音、播放等。
29│   ├── sh1106.h          # 基于sh1106 OLED组件服务API。
30│   └── sh1106_hdconfig.h # sh1106硬件相关配置
31├── package.yaml          # 编译配置文件
32└── example
33    └── sh1106_example.c  # oled显示测试代码
34```
35
36
37## 依赖组件
38
39
40- rhino
41
42
43
44# 常用配置
45
46
47系统中相关配置已有默认值,如需修改配置,统一在sh1106_hdconfig.h修改,具体如下:
48
49
50> 选择访问sh1106芯片的模式,设置为1,支持软件模拟SPI;设置为0,支持硬件SPI访问:
51
52
53
54```yaml
55#define USE_SOFT_SPI 1
56```
57
58
59> 选择是否支持录屏功能,设置为0,录屏功能关闭;设置为1,录屏功能打开:
60
61
62
63```c
64#define RECORD_SCREEN   0
65```
66
67
68> 是否支持fb框架,设置为0,不支持fb框架,支持输出显示;设置为1,支持fb框架:
69
70```c
71#define FB_FRAME_EN     0
72```
73# API说明
74
75> sh1106初始化API接口
76
77```c
78uint8_t sh1106_init(void);
79```
80> sh1106 OLED屏幕显示API接口
81> (x,y)是显示的坐标,*p是字符串的首地址,size是字符点集大小(12/16/24) ,mode(0-反显 1-正显)
82
83```c
84void sh1106_show_string(uint8_t x, uint8_t y, const uint8_t *p, uint8_t size, uint8_t mode);
85```
86# 使用示例
87
88
89组件使用示例相关的代码下载、编译和固件烧录均依赖AliOS Things配套的开发工具,所以首先需要参考[《AliOS Things集成开发环境使用说明之搭建开发环境》](https://help.aliyun.com/document_detail/302378.html),下载安装。
90待开发环境搭建完成后,可以按照以下步骤进行示例的测试。
91
92## 步骤1 创建或打开工程
93
94**打开已有工程**
95
96如果用于测试的案例工程已存在,可参考[《AliOS Things集成开发环境使用说明之打开工程》](https://help.aliyun.com/document_detail/302381.html)打开已有工程。
97
98**创建新的工程**
99
100组件的示例代码可以通过编译链接到AliOS Things的任意案例(solution)来运行,这里选择helloworld_demo案例。helloworld_demo案例相关的源代码下载可参考[《AliOS Things集成开发环境使用说明之创建工程》](https://help.aliyun.com/document_detail/302379.html)101
102## 步骤2 app中添加sh1106组件
103
104> helloworld_demo组件的package.yaml中添加
105
106```yaml
107depends:
108  - sh1106: master # helloworld_demo中引入sh1106组件
109```
110
111## 步骤3 下载组件
112
113在已安装了  的开发环境工具栏中,选择Terminal -> New Terminal启动终端,并且默认工作路径为当前工程的workspace,此时在终端命令行中输入:
114
115```shell
116
117aos install sh1106
118
119```
120
121上述命令执行成功后,组件源码则被下载到了./components/drivers/external_device路径中。
122
123
124## 步骤4 添加示例代码
125
126> sh1106组件的package.yaml中添加example示例代码
127
128```yaml
129source_file:
130  - src/sh1106.c
131  - example/sh1106_example.c
132```
133
134## 步骤5 编译固件
135
136在示例代码已经添加至组件的配置文件,并且helloworld_demo已添加了对该组件的依赖后,就可以编译helloworld_demo案例来生成固件了,具体编译方法可参考[《AliOS Things集成开发环境使用说明之编译固件》](https://help.aliyun.com/document_detail/302384.html)137
138## 步骤6 烧录固件
139
140helloworld_demo案例的固件生成后,可参考[《AliOS Things集成开发环境使用说明之烧录固件》](https://help.aliyun.com/document_detail/302383.html)来烧录固件。
141
142## 步骤7 打开串口
143
144固件烧录完成后,可以通过串口查看示例的运行结果,打开串口的具体方法可参考[《AliOS Things集成开发环境使用说明之查看日志》](https://help.aliyun.com/document_detail/302382.html)145
146当串口终端打开成功后,可在串口中输入help来查看已添加的测试命令。
147
148
149## 步骤8 SH1106示例测试
150
151> CLI命令行输入:
152
153```sh
154sh1106_init  # 默认初始化sh1106
155```
156
157> CLI关键日志:
158
159```sh
160sh1106 init test begin ...
161open gpio success, fd:513
162sh1106 init test end !!!
163```
164
165> CLI命令行输入:
166
167```sh
168sh1106_display # 在oled信息屏上显示测试
169```
170
171> CLI关键日志:
172
173```sh
174sh1106 display test begin ...
175sh1106 display test end !!!
176```
177# FAQ
178
179Q1: 本组件只适合sh1106芯片吗?
180答:是的,由于不同的硬件环境,不同的OLED驱动,配置的寄存器是不一样的,所以本组件是根据sh1106驱动芯片特性打造出的组件,所以只适合sh1106芯片。如果,其他的oled驱动芯片,建议参考sh1106_init()的实现。
181