# EPD_mpy_efont

**Repository Path**: dotnfc/EPD_mpy_efont

## Basic Information

- **Project Name**: EPD_mpy_efont
- **Description**: 为 mpy 提供 TTF, PCF 点阵字体支持，以及 jpg, png 图片显示支持。

- **Primary Language**: C
- **License**: MIT
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2023-09-10
- **Last Updated**: 2024-01-27

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Micropython 模块 eFont

中文 | [English](README.md)

## 索引
- [Micropython 模块 eFont](#micropython-模块-efont)
  - [索引](#索引)
  - [1. 目录结构](#1-目录结构)
  - [2. 模块的 API](#2-模块的-api)
  - [3. 字体转换](#3-字体转换)
    - [3.1 ttf 转小字库](#31-ttf-转小字库)
    - [3.2 压缩的 pcf 文件](#32-压缩的-pcf-文件)
  - [4. 文件系统](#4-文件系统)
    - [4.1 创建 examples 目录的 vfs 镜像](#41-创建-examples-目录的-vfs-镜像)
    - [4.2 写入镜像](#42-写入镜像)
    - [4.3 测试 vfs 文件系统](#43-测试-vfs-文件系统)
  - [5. 编译 efont](#5-编译-efont)
  - [6. 如何运行脚本](#6-如何运行脚本)
  - [7. 内置库](#7-内置库)
  - [参考](#参考)


此模块为 mpy 提供 TTF, PCF 点阵字体支持，以及 jpg, png 图片显示支持。

## 1. 目录结构

- [docs/](docs/) -- 相关描述文档
- [examples/](examples/) -- 实例代码，以及 efont 模块的代码补全脚本
- [micropython/](micropython/) -- microropython 官方源码
- [mod_efont/](mod_efont/) -- 模块实现
- [tools/](tools/) -- 工具脚本

## 2. 模块的 API
> [docs/api.md](docs/api.md) 

## 3. 字体转换
efont 采用了 FreeType2，所以可以支持：

### 3.1 ttf 转小字库
使用 python fonttools 的 [pyftsubset 工具](https://fonttools.readthedocs.io/en/latest/subset/index.html)
```shell
pyftsubset fonts\SimYou3D.ttf --text-file=chardict.txt  --output-file=simyou-lite.ttf
```

### 3.2 压缩的 pcf 文件
X 系统中的 bdf 文件的压缩格式是 pcf，一般能小一半。为便于在 ESP32 环境下使用，还可以进一步压缩 pcf 文件，请使用 [EPD_bdf2pcf](https://github.com/dotnfc/EPD_bdf2pcf) 进行转换。

examples/font/ 已携带两款开源的文泉驿点阵字体。

## 4. 文件系统
目标 ESP32 S3 平台(N8R2) 的内建 Flash 8MB，有 5.5MB 可用于图片、文档、字体等资源，参见 [Partition 文件](mod_efont/boards/EFORE_S3/partitions-8MiB.csv)，以下方法可用于制作此分区的镜像，供写入目标芯片。

### 4.1 创建 examples 目录的 vfs 镜像
> 工具的原始工程 https://github.com/labplus-cn/mkfatfs

```
wget -O ~/.local/bin/mkfatfs https://github.com/labplus-cn/mkfatfs/releases/download/v2.0.1/mkfatfs_linux_x86 
```

其中 -s 后面的参数最好与 partiton 中 vfs 分区的大小一致

```ps
> mkfatfs -c ./examples -t fatfs -s 4194304 efore_s3_vfs.bin 
```

### 4.2 写入镜像
```ps
--- wsl2 shell ---
> esptool.py  --before default_reset --after hard_reset --chip esp32s3 --baud 921600 --port /dev/ttyACM0 write_flash -z 0x290000 efore_s3_vfs.bin

--- windows ps ---
> esptool  --before default_reset --after hard_reset --chip esp32s3 --baud 921600 --port com6 write_flash -z 0x290000 efore_s3_vfs.bin
```

### 4.3 测试 vfs 文件系统
```python
>>> import os
>>> os.listdir()
```

## 5. 编译 efont
请参考 [build_CN.md](docs/build_CN.md)

## 6. 如何运行脚本
请参考 [脚本的运行](https://docs.micropython.org/en/latest/pyboard/tutorial/script.html)。 目标板上的 main.py 是一个入口脚本，启动后就直接运行。除非我们要求目标板进入了 repl 模式。

在 PC 端，我们可以用 mpremote, rshell 等工具，运行交互式终端，运行脚本，管理 vfs 文件和目录等。

对于脚本开发，[RT-Thread Micropython IDE for VSCode](https://marketplace.visualstudio.com/items?itemName=RT-Thread.rt-thread-micropython) 不错。

对于 unix port，默认 heap 可能不足以运行 10.2' 的例子，可以这样:

```shell
mpy -X heapsize=8m page/uiDay.py
```

## 7. 内置库
- [MicroDot](https://github.com/miguelgrinberg/microdot) 
  
  “The impossibly small web framework for Python and MicroPython”
- [aioble](https://github.com/micropython/micropython-lib/tree/master/micropython/bluetooth/aioble)
   
  This library provides an object-oriented, asyncio-based wrapper for MicroPython's bluetooth API.
  
## 参考
- https://github.com/takkaO/OpenFontRender [FT2 封装接口]
- https://github.com/kikuchan/pngle [png 支持]
- http://elm-chan.org/fsw/tjpgd/00index.html [jpg 支持]
- https://github.com/russhughes/s3lcd [图形接口]
- https://github.com/qwd/Icons [qWeather-Icons.ttf 来源]
- https://github.com/coinkite/mpy-qr [qrcode]
- https://github.com/jwygoda/mpy-qr [qrcode for mpy 1.20]
- Chinese Zodiac Signs Icons by StevyG

<hr>

*2023/09/09* | *2023/12/31*