eink-weather-display 项目安装与使用教程

1. 项目的目录结构及介绍

eink-weather-display/
├── docs/
│   └── ...  # 项目文档文件
├── github/
│   └── workflows/
│       └── ...  # GitHub Actions 工作流配置文件
├── output/
│   └── ...  # 生成的输出文件
├── rasp/
│   └── ...  # Raspberry Pi 相关代码
├── render/
│   └── ...  # 渲染相关代码
├── .gitignore
├── LICENSE
├── README.md
└── random-notes.md

目录结构介绍

• docs/: 存放项目的文档文件，包括使用说明、安装指南等。
• github/workflows/: 存放 GitHub Actions 的工作流配置文件，用于自动化部署和测试。
• output/: 存放项目生成的输出文件，如渲染后的 PNG 图片。
• rasp/: 存放 Raspberry Pi 相关的代码，负责从指定 URL 下载 PNG 文件并渲染到 E-Ink 显示屏上。
• render/: 存放渲染相关的代码，负责生成包含天气预报信息的 HTML 文件，并将其渲染为 PNG 图片。
• .gitignore: Git 忽略文件，指定哪些文件或目录不需要被 Git 管理。
• LICENSE: 项目许可证文件，本项目使用 Apache-2.0 许可证。
• README.md: 项目的主 README 文件，包含项目的概述、安装和使用说明。
• random-notes.md: 存放项目的随机笔记，可能包含开发过程中的临时记录或想法。

2. 项目的启动文件介绍

2.1 render/index.js

render/index.js 是渲染部分的主要启动文件。它负责生成包含天气预报信息的 HTML 文件，并将其渲染为 PNG 图片。该文件通过 Google Cloud Function 暴露为一个 HTTP 端点，供 Raspberry Pi 设备调用。

2.2 rasp/main.py

rasp/main.py 是 Raspberry Pi 部分的主要启动文件。它负责从指定 URL 下载 PNG 文件，并将其渲染到 E-Ink 显示屏上。该文件在 Raspberry Pi 设备上运行，负责与硬件交互。

3. 项目的配置文件介绍

3.1 .env

.env 文件是项目的配置文件，用于存储环境变量。该文件通常包含 API 密钥、数据库连接字符串等敏感信息。在项目中，.env 文件用于配置 Google Cloud Function 和 Raspberry Pi 的环境变量。

3.2 github/workflows/deploy.yml

github/workflows/deploy.yml 是 GitHub Actions 的工作流配置文件，用于自动化部署。该文件定义了在代码推送到 GitHub 仓库时，如何自动部署到 Google Cloud Function。

3.3 rasp/config.py

rasp/config.py 是 Raspberry Pi 部分的配置文件，用于存储与硬件相关的配置信息。该文件可能包含 E-Ink 显示屏的分辨率、刷新频率等配置。

通过以上模块的介绍，您可以更好地理解 eink-weather-display 项目的结构和使用方法。希望本教程对您有所帮助！