GxEPD 项目使用教程

GxEPD 项目使用教程

GxEPDA simple E-Paper display library with common base class and separate IO class for Arduino.项目地址:https://gitcode.com/gh_mirrors/gx/GxEPD

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

GxEPD 项目的目录结构如下：

GxEPD/
├── extras/
│   ├── examples/
│   ├── sw_spi/
│   ├── tests/
│   └── README.md
├── src/
│   ├── GxEPD.cpp
│   ├── GxEPD.h
│   ├── GxEPD_Base.cpp
│   ├── GxEPD_Base.h
│   ├── GxEPD_BitmapExample.cpp
│   ├── GxEPD_BitmapExample.h
│   ├── GxEPD_SD_Example.cpp
│   ├── GxEPD_SD_Example.h
│   ├── GxEPD_WiFi_Example.cpp
│   └── GxEPD_WiFi_Example.h
├── examples/
│   ├── GxEPD_BitmapExample/
│   ├── GxEPD_SD_Example/
│   └── GxEPD_WiFi_Example/
├── library.properties
└── README.md

目录结构介绍

• extras/: 包含额外的示例、软件SPI实现和测试文件。

  • examples/: 额外的示例代码。
  • sw_spi/: 软件SPI实现。
  • tests/: 测试文件。
  • README.md: 额外文件的说明文档。

• src/: 项目的主要源代码文件。

  • GxEPD.cpp: 主库文件。
  • GxEPD.h: 主库头文件。
  • GxEPD_Base.cpp: 基础类实现。
  • GxEPD_Base.h: 基础类头文件。
  • GxEPD_BitmapExample.cpp: 位图示例实现。
  • GxEPD_BitmapExample.h: 位图示例头文件。
  • GxEPD_SD_Example.cpp: SD卡示例实现。
  • GxEPD_SD_Example.h: SD卡示例头文件。
  • GxEPD_WiFi_Example.cpp: WiFi示例实现。
  • GxEPD_WiFi_Example.h: WiFi示例头文件。

• examples/: 示例代码。

  • GxEPD_BitmapExample/: 位图示例。
  • GxEPD_SD_Example/: SD卡示例。
  • GxEPD_WiFi_Example/: WiFi示例。

• library.properties: 库的属性文件。

• README.md: 项目的主说明文档。

2. 项目的启动文件介绍

项目的启动文件主要是 GxEPD.h 和 GxEPD.cpp。这两个文件包含了库的主要功能和接口。

GxEPD.h

GxEPD.h 是库的头文件，定义了库的主要类和接口。它包含了以下主要内容：

• 库的版本信息。
• 主要类的声明，如 GxEPD_Base 和 GxEPD。
• 主要接口的声明，如初始化、更新显示等。

GxEPD.cpp

GxEPD.cpp 是库的实现文件，包含了 GxEPD.h 中声明的类的具体实现。它包含了以下主要内容：

• 类的构造函数和析构函数。
• 主要接口的实现，如初始化、更新显示等。

3. 项目的配置文件介绍

项目的配置文件主要是 library.properties。这个文件包含了库的属性信息，用于在 Arduino IDE 中正确识别和使用库。

library.properties

library.properties 文件包含了以下主要内容：

• name: 库的名称。
• version: 库的版本。
• author: 库的作者。
• maintainer: 库的维护者。
• sentence: 库的简短描述。
• paragraph: 库的详细描述。
• category: 库的分类。
• url: 库的下载地址。
• architectures: 库支持的架构。

通过这些配置信息

GxEPDA simple E-Paper display library with common base class and separate IO class for Arduino.项目地址:https://gitcode.com/gh_mirrors/gx/GxEPD