readme_CN.txt 3.9 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586
  1. /*****************************************************************************
  2. * | File : Readme_CN.txt
  3. * | Author : Waveshare team
  4. * | Function : Help with use
  5. * | Info :
  6. *----------------
  7. * | This version: V1.0
  8. * | Date : 2019-06-17
  9. * | Info : 在这里提供一个中文版本的使用文档,以便你的快速使用
  10. ******************************************************************************/
  11. 这个文件是帮助您使用本例程。
  12. 由于我们的墨水屏越来越多,不便于我们的维护,因此把所有的墨水屏程序做成一个工程。
  13. 在这里简略的描述本工程的使用:
  14. 1.基本信息:
  15. 本例程是基于jetson-nano-sd-r32.1-2019-03-18系统镜像而开发的,由于目前的系统是没有硬件SPI的,
  16. 目前采用模拟SPI进行开发的,因此墨水屏的刷新速度较慢;
  17. 本例程是基于Jetson Nano进行开发的,例程均在Jetson Nano上进行了验证;
  18. 本例程使用e-paper Driver HAT模块进行了验证,你可以在工程的Examples\中查看对应的测试例程;
  19. 2.管脚连接:
  20. 管脚连接你可以在\lib\Config目录下查看DEV_Config.h中查看,这里也再重述一次:
  21. EPD => Jetson Nano/RPI(BCM)
  22. VCC -> 3.3
  23. GND -> GND
  24. DIN -> 10(SPI0_MOSI)
  25. CLK -> 11(SPI0_SCK)
  26. CS -> 8(SPI0_CS0)
  27. DC -> 25
  28. RST -> 17
  29. BUSY -> 24
  30. 3.基本使用:
  31. 由于本工程是一个综合工程,对于使用而言,你可能需要阅读以下内容:
  32. 你可以在main.c中的19行到43行看到已经进行了注释的19个函数,
  33. 请注意你购买的是哪一款的墨水屏。
  34. 栗子1:
  35. 如果你购买的5.83inch e-paper,那么你应该把对应的39行代码的注释去掉,即:
  36. // EPD_5in83_test();
  37. 修改成:
  38. EPD_5in83_test();
  39. 栗子2:
  40. 如果你购买的2.9inch e-paper (B),由于2.9寸的B型和C型是公用的驱动代码,
  41. 那么你应该把对应的28行代码的注释去掉,即:
  42. // EPD_2in9bc_test();
  43. 修改成:
  44. EPD_2in9bc_test();
  45. 注意:对于EPD_1in54_V2_test()和EPD_2in13_V2_test()请注意你的屏幕背面是否贴有V2标识。
  46. 然后你需要执行:make,编译程序,会生成可执行文件:epd
  47. 运行:sudo ./epd
  48. 如果修改了程序,需要执行:make clear,然后重新make。
  49. 4.目录结构(选读):
  50. 如果你经常使用我们的产品,对我们的程序目录结构会十分熟悉,关于具体的函数的我们有一份
  51. 函数的API手册,你可以在我们的WIKI上下载或像售后客服索取,这里简单介绍一次:
  52. \lib\Config\:此目录为硬件接口层文件,在DEV_Config.c(.h)可以看到很多定义,包括:
  53. 数据类型;
  54. GPIO;
  55. 读写GPIO;
  56. 延时:注意:此延时函数并未使用示波器测量具体数值,因此会不准;
  57. 模块初始化与退出的处理:
  58. void DEV_Module_Init(void);
  59. void DEV_Module_Exit(void);
  60. 注意:1.这里是处理使用墨水屏前与使用完之后一些GPIO的处理。
  61. 2.对于PCB带有Rev2.1的,DEV_Module_Exit()之后整个模块会进入低功耗,经过测试这个功耗基本为0;
  62. \lib\GUI\:此目录为一些基本的图像处理函数,在GUI_Paint.c(.h)中:
  63. 常用图像处理:创建图形、翻转图形、镜像图形、设置像素点、清屏等;
  64. 常用画图处理:画点、线、框、圆、中文字符、英文字符、数字等;
  65. 常用时间显示:提供一个常用的显示时间函数;
  66. 常用显示图片:提供一个显示位图的函数;
  67. \lib\Fonts\:为一些常用的字体:
  68. Ascii:
  69. font8: 5*8
  70. font12: 7*12
  71. font16: 11*16
  72. font20: 14*20
  73. font24: 17*24
  74. 中文:
  75. font12CN: 16*21
  76. font24CN: 32*41
  77. \lib\e-paper\:此目录下为墨水屏驱动函数;
  78. Examples\:此目录下为墨水屏的测试程序,你可在其中看到具体的使用方法;