Inkplate Arduino 库使用教程-优快云博客

Inkplate Arduino 库使用教程

Inkplate-Arduino-library Inkplate family Arduino library. The easiest way to add e-paper to your project. 项目地址: https://gitcode.com/gh_mirrors/in/Inkplate-Arduino-library

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

Inkplate-Arduino-library/
├── examples/
│   ├── Inkplate10_Basic_Demo/
│   ├── Inkplate6_Basic_Demo/
│   ├── Inkplate6_Touch_Demo/
│   └── ...
├── src/
│   ├── Inkplate.cpp
│   ├── Inkplate.h
│   ├── Display.cpp
│   ├── Display.h
│   └── ...
├── library.properties
├── README.md
└── LICENSE

examples/: 包含多个示例项目，每个子目录对应一个具体的示例，如 Inkplate10_Basic_Demo 和 Inkplate6_Basic_Demo。
src/: 包含库的核心源代码文件，如 Inkplate.cpp 和 Inkplate.h，以及其他相关的源文件。
library.properties: 库的元数据文件，包含库的名称、版本、作者等信息。
README.md: 项目的说明文件，通常包含项目的简介、安装方法、使用说明等。
LICENSE: 项目的许可证文件，说明项目的开源许可类型。

2. 项目的启动文件介绍

在 examples/ 目录下，每个示例项目都有一个 main.cpp 或 main.ino 文件，这是项目的启动文件。以 Inkplate6_Basic_Demo 为例：

#include "Inkplate.h"

Inkplate display(INKPLATE_1BIT);

void setup() {
    display.begin();
    display.clearDisplay();
    display.display();
}

void loop() {
    // 主循环代码
}

#include "Inkplate.h": 引入 Inkplate 库的头文件。
Inkplate display(INKPLATE_1BIT);: 创建 Inkplate 对象，并指定显示模式。
setup(): 初始化代码，通常用于设置显示器和其他硬件。
loop(): 主循环代码，程序会在这里不断执行。

3. 项目的配置文件介绍

library.properties 是库的配置文件，包含库的基本信息：

name=Inkplate
version=1.0.0
author=Soldered Electronics
maintainer=Soldered Electronics
sentence=Arduino library for Inkplate e-paper displays.
paragraph=This library allows you to control Inkplate e-paper displays using Arduino.
category=Display
url=https://github.com/SolderedElectronics/Inkplate-Arduino-library
architectures=*

name: 库的名称。
version: 库的版本号。
author: 库的作者。
maintainer: 库的维护者。
sentence: 库的简短描述。
paragraph: 库的详细描述。
category: 库的分类。
url: 库的源代码仓库地址。
architectures: 支持的架构，* 表示支持所有架构。