script/turnkey/EinkBook/README.md

   1 # EinkBook-LuatOS
   2
   3 ### 介绍
   4
   5 使用LuatOS-ESP32制作一个电纸书
   6
   7 #### 效果展示
   8
   9 ![](https://cdn.openluat-luatcommunity.openluat.com/images/20220313202435046_IMG_20220310_154336.jpg)
  10
  11 ### 硬件
  12
  13 + 合宙ESP32-C3开发板
  14 + MODEL_1in54 墨水屏
  15
  16 ### 软件
  17
  18 + [LuatOS-ESP32](https://gitee.com/dreamcmi/LuatOS-ESP32/tree/master)
  19 + [GoFrame](https://goframe.org/display/gf)
  20
  21 ### 部署方法
  22
  23 #### 服务端
  24
  25 > 请先自行配置Golang工具链
  26
  27 + 将想要阅读的小说放到`Server\books`目录下（目前仅支持txt格式）
  28 + 开启小说服务端程序
  29
  30 ```bat
  31 cd Server
  32 windows:
  33     ./run.bat
  34 linux or macos:
  35     ./run.sh
  36 ```
  37
  38 #### 电纸书
  39
  40 > 需要解锁ESP32C3的GPIO11，详情参考这里[ESP32C3解锁使用IO11](https://gitee.com/dreamcmi/LuatOS-ESP32/blob/master/doc/VDD_SPI_AS_GPIO.md)
  41
  42 > 注意: 需要使用带有`sarasa_regular_12`字体的固件，本地没有LuatOS-ESP32编译环境可以参考[云编译](https://wiki.luatos.com/develop/compile/Cloud_compilation.html)
  43
  44 使用LuaTools将Scripts目录下所有文件烧录到ESP32-C3模块中
  45
  46 ### 电纸书使用方法
  47
  48 使用BOOT键(GPIO 9)作为功能按键
  49
  50 + 单击：下一个
  51 + 双击：上一个
  52 + 长按：进入/退出