E-Ink 日历项目教程

E-Ink 日历项目教程

eink-calendarA very easy, almost zero-configuration, ESP8266/ESP32 E-ink calendar. Caution: UNMAINTAINED Please use CalEPD / Cale-idf项目地址:https://gitcode.com/gh_mirrors/ein/eink-calendar

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

eink-calendar/
├── config/
│   ├── config.json
│   └── settings.py
├── src/
│   ├── main.py
│   ├── calendar.py
│   └── utils.py
├── README.md
└── requirements.txt

• config/: 包含项目的配置文件。
  • config.json: 主要的配置文件，包含日历的设置和API密钥。
  • settings.py: 用于加载和处理配置文件的Python脚本。
• src/: 包含项目的主要源代码。
  • main.py: 项目的启动文件。
  • calendar.py: 处理日历事件的逻辑。
  • utils.py: 包含一些辅助函数和工具。
• README.md: 项目的说明文档。
• requirements.txt: 项目依赖的Python包列表。

2. 项目的启动文件介绍

main.py 是项目的启动文件，负责初始化配置、加载日历事件并显示在E-Ink屏幕上。以下是主要功能：

import config.settings as settings
from src.calendar import Calendar
from src.utils import load_events

def main():
    # 加载配置
    config = settings.load_config()
    
    # 加载日历事件
    events = load_events(config)
    
    # 初始化日历对象
    calendar = Calendar(config, events)
    
    # 显示日历
    calendar.display()

if __name__ == "__main__":
    main()

3. 项目的配置文件介绍

config.json 是项目的主要配置文件，包含以下内容：

{
    "api_key": "your_google_calendar_api_key",
    "calendar_id": "your_calendar_id",
    "display_settings": {
        "width": 640,
        "height": 384,
        "rotation": 90
    }
}

• api_key: Google Calendar API的密钥。
• calendar_id: 要显示的Google Calendar的ID。
• display_settings: E-Ink屏幕的显示设置，包括宽度、高度和旋转角度。

settings.py 用于加载和处理配置文件：

import json

def load_config():
    with open('config/config.json', 'r') as f:
        config = json.load(f)
    return config

这个脚本从 config.json 文件中读取配置，并返回一个包含配置的字典。

eink-calendarA very easy, almost zero-configuration, ESP8266/ESP32 E-ink calendar. Caution: UNMAINTAINED Please use CalEPD / Cale-idf项目地址:https://gitcode.com/gh_mirrors/ein/eink-calendar