Skip to content

Commit f5790f3

Browse files
lbuquelbuque
committed
docs: update qspi panel and spi panel docment
Signed-off-by: lbuque <1102390310@qq.com>
1 parent adfcaa5 commit f5790f3

File tree

11 files changed

+190
-8
lines changed

11 files changed

+190
-8
lines changed

‎README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -36,10 +36,10 @@ Supported boards：
3636

3737
| Driver IC | Hardware SPI | Software SPI | Hardware QSPI | I8080 | DPI(RGB) |
3838
| --------- | ---------------- | ---------------- | ---------------- | ---------------- | ---------------- |
39-
| ESP32 | [![alt text][1]] | [![alt text][4]] | [![alt text][1]] | [![alt text][1]] | [![alt text][2]] |
40-
| ESP32-C3 | [![alt text][3]] | [![alt text][4]] | [![alt text][3]] | [![alt text][2]] | [![alt text][2]] |
41-
| ESP32-S2 | [![alt text][3]] | [![alt text][4]] | [![alt text][3]] | [![alt text][3]] | [![alt text][2]] |
42-
| ESP32-S3 | [![alt text][1]] | [![alt text][4]] | [![alt text][1]] | [![alt text][1]] | [![alt text][1]] |
39+
| ESP32 | ![alt text][1] | ![alt text][4] | ![alt text][1] | ![alt text][1] | ![alt text][2] |
40+
| ESP32-C3 | ![alt text][3] | ![alt text][4] | ![alt text][3] | ![alt text][2] | ![alt text][2] |
41+
| ESP32-S2 | ![alt text][3] | ![alt text][4] | ![alt text][3] | ![alt text][3] | ![alt text][2] |
42+
| ESP32-S3 | ![alt text][1] | ![alt text][4] | ![alt text][1] | ![alt text][1] | ![alt text][1] |
4343

4444
[1]: https://camo.githubusercontent.com/bd5f5f82b920744ff961517942e99a46699fee58737cd9b31bf56e5ca41b781b/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f2d737570706f727465642d677265656e
4545
[2]: https://img.shields.io/badge/-not%20support-lightgrey

‎docs/en/api-reference/lcd.I8080.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,6 @@ Methods
4141
- cmd - The specific LCD command
4242
- param - Buffer that holds the RGB color data
4343

44-
.. method:: deinit()
44+
.. method:: I8080.deinit()
4545

4646
Destroys the Intel 8080 bus object.

‎docs/en/api-reference/lcd.QSPIPanel.rst

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
class QSPIPanel -- SPI Interfaced LCD
2+
=====================================
3+
4+
The QSPIPanel class implements the general control and access interface of the SPI serial bus, and can interact with the LCD driver chip through it.
5+
6+
Constructors
7+
------------
8+
9+
.. class:: QSPIPanel(spi: machine.SPI, data: tuple, command: Pin, cs: Pin=None, pclk: int=10000000, width: int=240, height: int=240, swap_color_bytes: bool=False, cmd_bits: int=8, param_bits: int=8)
10+
11+
Create an QSPIPanel object.
12+
13+
These parameters are:
14+
15+
- ``spi``: SPI object
16+
- ``data``: Pins used for data lines
17+
- ``command``: Pins used for data lines
18+
- ``cs``: Pin used for CS line, set to None if it’s not used
19+
- ``pclk``: Frequency of pixel clock
20+
- ``width``: Horizontal resolution, i.e. the number of pixels in a line
21+
- ``height``: Vertical resolution, i.e. the number of lines in the frame
22+
- ``swap_color_bytes``: Swap adjacent two color bytes
23+
- ``cmd_bits``: Bit-width of LCD command
24+
- ``param_bits``: Bit-width of LCD parameter
25+
26+
Methods
27+
-------
28+
29+
.. method:: QSPIPanel.tx_param(cmd: int, param: bytes=None)
30+
31+
Transmit LCD command and corresponding parameters.
32+
33+
- cmd - The specific LCD command
34+
- param - Buffer that holds the command specific parameters
35+
36+
.. method:: QSPIPanel.tx_color(cmd: int, color: bytes=None)
37+
38+
Transmit LCD RGB data.
39+
40+
- cmd - The specific LCD command
41+
- param - Buffer that holds the RGB color data
42+
43+
.. method:: QSPIPanel.deinit()
44+
45+
Destroys QSPIPanel object.

‎docs/en/api-reference/lcd.SPIPanel.rst

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
class SPIPanel -- SPI Interfaced LCD
2+
=====================================
3+
4+
The SPIPanel class implements the general control and access interface of the SPI serial bus, and can interact with the LCD driver chip through it.
5+
6+
Constructors
7+
------------
8+
9+
.. class:: SPIPanel(spi: machine.SPI, command: Pin, cs: Pin=None, pclk: int=10000000, width: int=240, height: int=240, swap_color_bytes: bool=False, cmd_bits: int=8, param_bits: int=8)
10+
11+
Create an SPIPanel object.
12+
13+
These parameters are:
14+
15+
- ``spi``: SPI object
16+
- ``command``: Pins used for data lines
17+
- ``cs``: Pin used for CS line, set to None if it’s not used
18+
- ``pclk``: Frequency of pixel clock
19+
- ``width``: Horizontal resolution, i.e. the number of pixels in a line
20+
- ``height``: Vertical resolution, i.e. the number of lines in the frame
21+
- ``swap_color_bytes``: Swap adjacent two color bytes
22+
- ``cmd_bits``: Bit-width of LCD command
23+
- ``param_bits``: Bit-width of LCD parameter
24+
25+
Methods
26+
-------
27+
28+
.. method:: SPIPanel.tx_param(cmd: int, param: bytes=None)
29+
30+
Transmit LCD command and corresponding parameters.
31+
32+
- cmd - The specific LCD command
33+
- param - Buffer that holds the command specific parameters
34+
35+
.. method:: SPIPanel.tx_color(cmd: int, color: bytes=None)
36+
37+
Transmit LCD RGB data.
38+
39+
- cmd - The specific LCD command
40+
- param - Buffer that holds the RGB color data
41+
42+
.. method:: SPIPanel.deinit()
43+
44+
Destroys SPIPanel object.

‎docs/en/api-reference/lcd.ST7735.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -112,7 +112,7 @@ Methods
112112

113113
Deinitialize the LCD panel.
114114

115-
.. method:: ST7735。rotation(r: int)
115+
.. method:: ST7735.rotation(r: int)
116116

117117
Set the rotates the logical display in a counter-clockwise direction.
118118

‎docs/en/api-reference/lcd.ST7789.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -112,7 +112,7 @@ Methods
112112

113113
Deinitialize the LCD panel.
114114

115-
.. method:: ST7789。rotation(r: int)
115+
.. method:: ST7789.rotation(r: int)
116116

117117
Set the rotates the logical display in a counter-clockwise direction.
118118

‎docs/en/api-reference/lcd.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,8 @@ Classes
1414
.. toctree::
1515
:maxdepth: 1
1616

17+
lcd.SPIPanel.rst
18+
lcd.QSPIPanel.rst
1719
lcd.I8080.rst
1820
lcd.RGB.rst
1921
lcd.ST7789.rst

‎docs/zh_CN/api-reference/lcd.I8080.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,6 @@ Methods
4141
- cmd - 具体的 LCD 命令
4242
- param - 保存 RGB 颜色数据的缓冲区
4343

44-
.. method:: deinit()
44+
.. method:: I8080.deinit()
4545

4646
销毁 Intel 8080总线对象。

‎docs/zh_CN/api-reference/lcd.QSPIPanel.rst

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
class QSPIPanel -- QSPI Interfaced LCD
2+
=======================================
3+
4+
QSPIPanel 类实现了 QSPI 串行行总线的通用控制和访问接口，可以通过它和LCD驱动芯片进行交互。
5+
6+
Constructors
7+
------------
8+
9+
.. class:: QSPIPanel(spi: machine.SPI, data: tuple, command: Pin, cs: Pin=None, pclk: int=10000000, width: int=240, height: int=240, swap_color_bytes: bool=False, cmd_bits: int=8, param_bits: int=8)
10+
11+
创建一个 QSPIPanel 的对象。
12+
13+
这些参数是：
14+
15+
- ``spi``: SPI 对象
16+
- ``data``: 用于数据线的引脚对象元组
17+
- ``command``: 用于 D/C 线的引脚对象
18+
- ``cs``: 用于 CS 线的引脚对象，如果不使用则设置为 None
19+
- ``pclk``: 像素时钟频率
20+
- ``width``: 水平分辨率，即一行中的像素数
21+
- ``height``: 垂直分辨率，即帧中的行数
22+
- ``swap_color_bytes``: 交换相邻的两个颜色字节
23+
- ``cmd_bits``: LCD 命令的位宽
24+
- ``param_bits``: LCD参数位宽
25+
26+
Methods
27+
-------
28+
29+
.. method:: QSPIPanel.tx_param(cmd: int, param: bytes=None)
30+
31+
发送 LCD 命令和相应的参数。
32+
33+
- cmd - 具体的 LCD 命令
34+
- param - 保存命令特定参数的缓冲区，如果命令不需要参数，则不需要传入
35+
36+
.. method:: QSPIPanel.tx_color(cmd: int, color: bytes=None)
37+
38+
发送 LCD RGB 数据。
39+
40+
- cmd - 具体的 LCD 命令
41+
- param - 保存 RGB 颜色数据的缓冲区
42+
43+
.. method:: QSPIPanel.deinit()
44+
45+
销毁 QSPIPanel 对象。

‎docs/zh_CN/api-reference/lcd.SPIPanel.rst

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
class SPIPanel -- SPI Interfaced LCD
2+
=====================================
3+
4+
SPIPanel 类实现了 SPI 串行行总线的通用控制和访问接口，可以通过它和LCD驱动芯片进行交互。
5+
6+
Constructors
7+
------------
8+
9+
.. class:: SPIPanel(spi: machine.SPI, command: Pin, cs: Pin=None, pclk: int=10000000, width: int=240, height: int=240, swap_color_bytes: bool=False, cmd_bits: int=8, param_bits: int=8)
10+
11+
创建一个 SPIPanel 的对象。
12+
13+
这些参数是：
14+
15+
- ``spi``: SPI 对象
16+
- ``command``: 用于 D/C 线的引脚对象
17+
- ``cs``: 用于 CS 线的引脚对象，如果不使用则设置为 None
18+
- ``pclk``: 像素时钟频率
19+
- ``width``: 水平分辨率，即一行中的像素数
20+
- ``height``: 垂直分辨率，即帧中的行数
21+
- ``swap_color_bytes``: 交换相邻的两个颜色字节
22+
- ``cmd_bits``: LCD 命令的位宽
23+
- ``param_bits``: LCD参数位宽
24+
25+
Methods
26+
-------
27+
28+
.. method:: SPIPanel.tx_param(cmd: int, param: bytes=None)
29+
30+
发送 LCD 命令和相应的参数。
31+
32+
- cmd - 具体的 LCD 命令
33+
- param - 保存命令特定参数的缓冲区，如果命令不需要参数，则不需要传入
34+
35+
.. method:: SPIPanel.tx_color(cmd: int, color: bytes=None)
36+
37+
发送 LCD RGB 数据。
38+
39+
- cmd - 具体的 LCD 命令
40+
- param - 保存 RGB 颜色数据的缓冲区
41+
42+
.. method:: SPIPanel.deinit()
43+
44+
销毁 SPIPanel 对象。

0 commit comments

Comments
 (0)