E Ink 魔法日历项目安装与使用指南

E Ink 魔法日历项目安装与使用指南

MagInkCalE-Ink Magic Calendar that automatically syncs to Google Calendar and runs off a battery powered Raspberry Pi Zero项目地址:https://gitcode.com/gh_mirrors/ma/MagInkCal

项目概述

本指南将引导您了解并设置由 speedyg0nz 开发的 E-Ink Magic Calendar，该项目利用电池供电（通过 PiSugar2）的 Raspberry Pi Zero WH，从 Google 日历中获取事件，格式化布局后推送到 Waveshare 的 12.48英寸三色E Ink 显示器上。

1. 目录结构及介绍

项目的目录结构如下所示：

MagInkCal/
├── config.json            # 配置文件，用于定制化设置
├── gitignore              # Git 忽略文件列表
├── LICENSE                # 许可证文件，遵循 Apache-2.0 协议
├── README.md              # 项目简介及快速入门指南
├── gcal.py                # 负责与 Google Calendar 交互的脚本
├── maginkcal.py           # 主程序入口，负责整个应用的运行逻辑
└── ...                    # 可能包含其他辅助文件或依赖

• config.json: 包含了项目运行所需的配置信息，比如Google API的密钥、刷新时间间隔等。
• gitignore: 指定了在提交到Git仓库时应忽略的文件类型。
• LICENSE: 说明项目使用的许可协议，确保合法合规地使用代码。
• README.md: 提供了项目的基本信息、安装步骤和快速使用的说明。
• gcal.py: 处理与Google Calendar同步的具体逻辑。
• maginkcal.py: 这是项目的主要执行文件，控制整个魔法日历的运行流程。

2. 项目的启动文件介绍

maginkcal.py 是项目的启动点，它集成了一系列功能，包括但不限于与配置文件的交互、调用日历同步脚本(gcal.py)、以及驱动E Ink显示器进行显示更新。当您准备好运行魔法日历时，主要是执行这个脚本。通过修改配置文件和运行此脚本，您可以实现与Google日历的自动同步，并按设定的时间间隔自动刷新日历显示。

3. 项目的配置文件介绍

config.json 文件是项目的配置中心，关键参数包括但不限于：

• google_api_credentials: Google API的认证文件路径，用于授权访问您的Google Calendar。
• calendar_id: 要同步的Google日历ID。
• inky_display: 针对Waveshare E Ink显示器的相关配置，如尺寸和颜色模式。
• refresh_time: 使用PiSugar2设置的设备自动唤醒并刷新日历的时间间隔。
• 其他可能包括屏幕显示偏好、日期格式等个性化设置。

确保在运行项目之前，仔细调整该文件中的设置以匹配您的实际需求和环境配置。

结论

通过上述步骤，您可以顺利配置和运行E Ink Magic Calendar项目，享受一个自定义且自动同步的电子日历体验。记得在实施前仔细阅读项目主页上的最新说明和潜在的依赖项安装指导，确保所有必要的Python库已正确安装。

MagInkCalE-Ink Magic Calendar that automatically syncs to Google Calendar and runs off a battery powered Raspberry Pi Zero项目地址:https://gitcode.com/gh_mirrors/ma/MagInkCal