Add instructions.
This commit is contained in:
parent
395d30e35e
commit
9c8eada5d9
|
@ -0,0 +1,46 @@
|
|||
EPD model EPD define (EPD=)
|
||||
1.64inch e-Paper (G) _1in64g
|
||||
2.36inch e-Paper (G) _2in36g
|
||||
3inch e-Paper (G) _3in0g
|
||||
4.37inch e-Paper (G) _4in37g
|
||||
7.3inch e-Paper (G) _7in3g
|
||||
1.54inch e-Paper (V2) _1in54V2
|
||||
1.54inch e-Paper (B) (V2) _1in54bV2
|
||||
1.54inch e-Paper (C) _1in54c
|
||||
2.66inch e-Paper _2in66
|
||||
2.66inch e-Paper (B) _2in66b
|
||||
2.7inch e-Paper _2in7
|
||||
2.7inch e-Paper (V2) _2in7V2
|
||||
2.9inch e-Paper (V2) _2in9V2
|
||||
2.9inch e-Paper (B)/(C) _2in9bc
|
||||
2.9inch e-Paper (B) (V3) _2in9bV3
|
||||
2.9inch e-Paper (D) _2in9d
|
||||
2.9inch e-Paper (V3) _2in13V3
|
||||
2.13inch e-Paper (B)/(C) _2in13bc
|
||||
2.13inch e-Paper (B) (V3) _2in13bV3
|
||||
2.13inch e-Paper (B) (V4) _2in13bV4
|
||||
2.13inch e-Paper (D) _2in13d
|
||||
3.52inch e-Paper _3in52
|
||||
3.7inch e-Paper _3in7
|
||||
4.01inch e-Paper (F) _4in01f
|
||||
4.2inch e-Paper _4in2
|
||||
4.2inch e-Paper (V2 _4in2V2
|
||||
4.2inch e-Paper (B)/(C) _4in2bc
|
||||
4.2inch e-Paper (B) (V2) _4in2bV2
|
||||
5.65inch e-Paper (F) _5in65f
|
||||
5.83inch e-Paper (V2) _5in83V2
|
||||
5.83inch e-Paper (B)/(C) _5in83bc
|
||||
5.83inch e-Paper (B) (V2) _5in83bV2
|
||||
7.5inch e-Paper (V2) _7in5V2
|
||||
7.5inch e-Paper (B)/(C) _7in5bc
|
||||
7.5inch e-Paper (B) (V2) _7in5bV2
|
||||
|
||||
Add EPD define at compile time, for example:
|
||||
# modle is 7.5inch e-Paper (B) (V2)
|
||||
sudo make clean
|
||||
sudo make -j4 EPD=_7in5bV2
|
||||
|
||||
编译的时候加上 EPD define,例如:
|
||||
# 屏幕型号为 7.5inch e-Paper (B) (V2)
|
||||
sudo make clean
|
||||
sudo make -j4 EPD=_7in5bV2
|
|
@ -4,8 +4,8 @@
|
|||
* | Function : Help with use
|
||||
* | Info :
|
||||
*----------------
|
||||
* | This version: V1.1
|
||||
* | Date : 2019-07-31
|
||||
* | This version: V1.2
|
||||
* | Date : 2022-09-20
|
||||
* | Info : 在这里提供一个中文版本的使用文档,以便你的快速使用
|
||||
******************************************************************************/
|
||||
这个文件是帮助您使用本例程。
|
||||
|
@ -29,24 +29,24 @@ BUSY -> 24
|
|||
|
||||
3.基本使用:
|
||||
由于本工程是一个综合工程,对于使用而言,你可能需要阅读以下内容:
|
||||
你可以在main.c中的19行到43行看到已经进行了注释的19个函数,
|
||||
请注意你购买的是哪一款的墨水屏。
|
||||
你可以在main.c中看到许多测试函数和宏定义设置,在编译时指定屏幕对应的宏定义可以直接编译对应的测试程序。
|
||||
请注意你购买的是哪一款的墨水屏。具体的对应关系可以查阅我们的Wiki和list.txt文件。
|
||||
栗子1:
|
||||
如果你购买的5.83inch e-paper,那么你应该把对应的39行代码的注释去掉,即:
|
||||
// EPD_5in83_test();
|
||||
修改成:
|
||||
EPD_5in83_test();
|
||||
如果你购买的3.7inch e-paper (V1),那么你应该在编译时加上 EPD=_3in7
|
||||
sudo make clean
|
||||
sudo make -j4 EPD=_3in7
|
||||
栗子2:
|
||||
如果你购买的2.9inch e-paper (B),由于2.9寸的B型和C型是公用的驱动代码,
|
||||
那么你应该把对应的28行代码的注释去掉,即:
|
||||
// EPD_2in9bc_test();
|
||||
修改成:
|
||||
EPD_2in9bc_test();
|
||||
注意:对于EPD_1in54_V2_test()和EPD_2in13_V2_test()请注意你的屏幕背面是否贴有V2标识。
|
||||
如果你购买的2.9inch e-paper (B) (V1),由于2.9寸的B型和C型是公用的驱动代码,那么你应该在编译时加上 EPD=_2in9bc
|
||||
sudo make clean
|
||||
sudo make -j4 EPD=_2in9bc
|
||||
栗子3:
|
||||
如果你购买的是7.5inch e-Paper (V2),那么你应该在编译时加上 EPD=_7in5V2
|
||||
sudo make clean
|
||||
sudo make -j4 EPD=_7in5V2
|
||||
|
||||
然后你需要执行:make,编译程序,会生成可执行文件:epd
|
||||
然后会生成可执行文件:epd
|
||||
运行:sudo ./epd
|
||||
如果修改了程序,需要执行:make clear,然后重新make。
|
||||
如果修改了程序,需要执行:make clear,然后重新make。
|
||||
|
||||
4.目录结构(选读):
|
||||
如果你经常使用我们的产品,对我们的程序目录结构会十分熟悉,关于具体的函数的我们有一份
|
||||
|
|
|
@ -4,8 +4,8 @@
|
|||
* | Function : Help with use
|
||||
* | Info :
|
||||
*----------------
|
||||
* | This version: V1.0
|
||||
* | Date : 2019-07-31
|
||||
* | This version: V1.2
|
||||
* | Date : 2022-09-20
|
||||
* | Info : Here is an English version of the documentation for your quick use.
|
||||
******************************************************************************/
|
||||
This file is to help you use this routine.
|
||||
|
@ -31,30 +31,25 @@ BUSY -> 24
|
|||
|
||||
3. Basic use:
|
||||
Since this project is a comprehensive project, you may need to read the following for use:
|
||||
You can see the 19 functions that have been annotated in lines 19 through 43 of main.c.
|
||||
Please note which ink screen you purchased.
|
||||
Chestnut 1:
|
||||
If you purchased 5.83inch e-paper, then you should remove the comment for the corresponding 39 lines of code, ie:
|
||||
// EPD_5in83_test();
|
||||
changed to:
|
||||
EPD_5in83_test();
|
||||
Chestnut 2:
|
||||
If you buy a 2.9inch e-paper (B), since the 2.9-inch Type B and Type C are common driver codes,
|
||||
Then you should remove the comment for the corresponding 28 lines of code, ie:
|
||||
// EPD_2in9bc_test();
|
||||
changed to:
|
||||
EPD_2in9bc_test();
|
||||
Note: For EPD_1in54_V2_test() and EPD_2in13_V2_test(), please note that the V2 logo is attached to the back of your screen.
|
||||
You can see many test functions and macro definition Settings in main.c.
|
||||
Specifying the macro definition for the EPD at compile time can directly compile the corresponding test program.
|
||||
Please pay attention to which type of ink screen you buy. For detailed correspondence, see our Wiki and list.txt file.
|
||||
Example 1:
|
||||
If you buy 3.7inch e-paper (V1) then you should add EPD=_3in7 at compile time
|
||||
sudo make clean
|
||||
sudo make -j4 EPD=_3in7
|
||||
Example 2:
|
||||
If you buy a 2.9-inch e-paper (B) (V1), you should add EPD= 2IN9bc at compile time since the 2.9-inch type B and Type C are common driver code
|
||||
sudo make clean
|
||||
sudo make -j4 EPD=_2in9bc
|
||||
Example 3:
|
||||
If you buy a 7.5-inch e-paper (V2), you should add EPD=_7in5V2 at compile time
|
||||
sudo make clean
|
||||
sudo make -j4 EPD=_7in5V2
|
||||
|
||||
Then you need to execute:
|
||||
make
|
||||
compile the program, will generate the executable file: epd
|
||||
Run:
|
||||
sudo ./epd
|
||||
If you modify the program, you need to execute:
|
||||
make clear
|
||||
then:
|
||||
make
|
||||
An executable file is then generated: epd
|
||||
Run: sudo ./epd
|
||||
If you modify the program, you need to run: make clear, and then make again.
|
||||
|
||||
4. Directory structure (selection):
|
||||
If you use our products frequently, we will be very familiar with our program directory structure. We have a copy of the specific function.
|
||||
|
|
Loading…
Reference in New Issue