Skip to content

Commit

Permalink
update Readme.md
Browse files Browse the repository at this point in the history
  • Loading branch information
puboy7 committed Apr 2, 2024
1 parent fc442aa commit 0bed10e
Show file tree
Hide file tree
Showing 2 changed files with 38 additions and 3 deletions.
14 changes: 13 additions & 1 deletion README.MD
Original file line number Diff line number Diff line change
Expand Up @@ -10,10 +10,21 @@ You can use the [T5-4.7 & T5-4.7 Plus Online Documentation](https://t5-47-t5-47-

## Quick Start

### PlatformIO Quick Start (Recommended)
- Use vscode to open the target sample directory. To open the demo sample, you need to right-click LiltGo-EPD47/examples/demo and use vscode to open it
- Select the target type according to the board type, the current default environment is' T5_4_7Inc_Plus', the user can modify 'default_envs' in' platformio.ini '
- Click the (✔) symbol in the bottom left corner to compile
- Connect the circuit board to the USB port of the computer
- Click (→) to upload firmware
- Click (plug symbol) to monitor serial port output
- If it can't write, or the USB device keeps flashing, please check the **FAQ**

### Arduino IDE Quick Start
- Install the [Arduino IDE](https://www.arduino.cc/en/Main/Software). Note: Later instructions may not work if you use Arduino via Flatpak.
- Install the latest [espressif/arduino-esp32](https://github.com/espressif/arduino-esp32) package in the IDE, version >= 1.05
- Download a zipfile from github using the "Download ZIP" button and install it using the IDE ("Sketch" -> "Include Library" -> "Add .ZIP Library...", OR:
- Clone this git repository into your sketchbook/libraries folder. For more info, see https://www.arduino.cc/en/Guide/Libraries
- Development Board version 3.0.0 is not suitable. Please download a version earlier than 3.0.0
- Choose `ESP32 Dev S3 Module` for the board
- Tools -> PSRAM -> `Enable` ->`OPI``
- ("File" -> "Examples" -> "LilyGoEPD47" -> "demo") in the Arduino IDE
Expand All @@ -22,7 +33,7 @@ You can use the [T5-4.7 & T5-4.7 Plus Online Documentation](https://t5-47-t5-47-

## Required

[arduino-esp32](https://github.com/espressif/arduino-esp32) needs to be upgraded to `2.0.3` version to support `ESP32-S3`.
[arduino-esp32](https://github.com/espressif/arduino-esp32) needs to be upgrade to '2.0.3' to '2.0.14' to support 'ESP32-S3'.

To upgrade the existing development environment, please refer to the following methods:

Expand Down Expand Up @@ -61,6 +72,7 @@ $ git submodule update
If the port cannot be found when uploading the program or the USB has been used for other functions, the port does not appear.
Please enter the upload mode manually.


![product](images/product.jpg)

1. Connect the board via the USB cable
Expand Down
27 changes: 25 additions & 2 deletions README_CN.MD
Original file line number Diff line number Diff line change
Expand Up @@ -10,17 +10,29 @@

## 快速开始

### PlatformIO Quick Start (Recommended)
- 使用vscode打开目标示例的目录,如要打开demo示例需要先打开`LiltGo-EPD47/examples/demo`右键使用vscode打开
- 根据板类型选择目标类型,目前默认环境为`T5_4_7Inc_Plus`,用户可以在`platformio.ini`中进行修改`[platformio]`中的`default_envs`
- 点击左下角的(✔)符号进行编译
- 将电路板连接到计算机的USB接口
- 点击(→)上传固件
- 点击(插头符号)监控串口输出
- 如果无法写入,或者USB设备一直闪烁,请查看 **FAQ**


### Arduino IDE Quick Start
- 在github中点击"Download ZIP",下载完成后,在Arduino 菜单栏中选择 项目 -> 加载库 -> 添加.ZIP库
关于更多详细说明请参考 https://www.arduino.cc/en/Guide/Libraries
- 开发板版本3.0.0版本暂不适配,请下载3.0.0以下的版本
- 板子选择`ESP32 Dev Module`
- 工具 -> PSRAM -> Enable
- 工具 -> PSRAM -> OPI PSRAM
- 在Arduino IDE (文件->示例程序->LilyGoEPD47->demo) 选择示例
- 选择正确的端口,然后点击上传
- 图片与文字生成请看[脚本使用说明](./scripts/README.MD)

## 必备

需要将 [arduino-esp32](https://github.com/espressif/arduino-esp32) 升级到 `2.0.3` 版本,才支持 `ESP32-S3`
需要将 [arduino-esp32](https://github.com/espressif/arduino-esp32) 升级到 `2.0.3` 版本至`2.0.14`,才支持 `ESP32-S3`

升级现有的开发环境,可以参考以下方法:

Expand Down Expand Up @@ -54,3 +66,14 @@ $ git submodule update

请上传 [examples/screen_repair](./examples/screen_repair),尝试消除残影。
它不是100%能消除残影。

4.
单板使用USB作为JTAG上传端口。在USB_CDC_ON_BOOT上打印串口信息时,需要打开配置。如果在上传程序时找不到该端口,或者该USB已被用于其他功能,则该端口不会显示。请手动进入上传模式。

![product](images/product.jpg)

1. 通过USB线连接单板
2. 长按BOOT(IO0)键,在仍按BOOT(IO0)键的同时,按RST
3. 释放RST
4. 松开BOOT(IO0)按钮
5. 上传固件

0 comments on commit 0bed10e

Please sign in to comment.