EPF 项目使用与配置指南

EPF 项目使用与配置指南

EPF epaper photo frame 项目地址: https://gitcode.com/gh_mirrors/epf1/EPF

1. 项目目录结构及介绍

EPF 项目目录结构如下：

EPF/
├── Arduino/
│   ├── epd7in3e.ino
│   └── ...
├── CAD/
│   └── ...
├── Dockerfile
├── LICENSE
├── README.md
├── app.py
├── cpy.pyx
├── cpy.so
├── requirements.txt
└── templates/
    └── ...

• Arduino/: 包含 ESP32-C6 开发板的 Arduino 代码，主要用于控制 E Ink 显示屏。
• CAD/: 存储与项目相关的 CAD 文件。
• Dockerfile: 用于构建 Docker 容器的配置文件。
• LICENSE: 项目使用的许可文件，本项目采用 MIT 许可。
• README.md: 项目说明文件，包含项目的基本信息和使用说明。
• app.py: 项目的主要 Python 脚本，负责处理图片和与 ESP32 通信。
• cpy.pyx: 使用 Cython 编写的 Python 扩展模块，用于加速图片处理。
• cpy.so: 编译后的 Cython 模块。
• requirements.txt: 项目依赖的 Python 包列表。
• templates/: 存储项目使用的 HTML 模板文件。

2. 项目的启动文件介绍

项目的启动文件是 app.py。该文件负责初始化 Flask 应用程序，设置路由，处理 HTTP 请求，以及与 ESP32 设备进行通信。

以下是 app.py 的核心部分代码结构：

from flask import Flask, request, send_file
import ...  # 导入必要的库

app = Flask(__name__)

@app.route('/')
def index():
    # 处理首页请求
    ...

@app.route('/update', methods=['POST'])
def update_photo():
    # 处理图片更新请求
    ...

@app.route('/config', methods=['GET', 'POST'])
def configure():
    # 处理配置请求
    ...

if __name__ == '__main__':
    app.run(host='0.0.0.0', port=5000)

3. 项目的配置文件介绍

项目的配置主要通过 Docker 容器的环境变量来进行。在 docker run 命令中，可以通过 -e 参数设置环境变量。

例如，设置 Immich API 密钥的命令如下：

docker run --name epf -e IMMICH-API-KEY='your-immich-api-key' -d -p <replace-port>:5000 jwchen119/epf

此外，项目还可能使用 config.yaml 文件进行配置，但根据项目的最新说明，配置可以直接通过网页进行，因此 config.yaml 文件可能不再需要。

配置文件可能包含以下内容：

immich:
  album: testAlbme
  rotation: 270
  url: http://192.168.100.36:2283
  enhanced: 1.5
  contrast: 1.2

这些配置项分别表示 Immich 的专辑名称、图片旋转角度、Immich 服务器 URL、颜色饱和度增强级别和对比度增强级别。

EPF epaper photo frame 项目地址: https://gitcode.com/gh_mirrors/epf1/EPF