OneBitDisplay 项目使用教程

OneBitDisplay 项目使用教程

OneBitDisplayA full featured Arduino display library for 1-bit per pixel OLED, LCD and e-paper displays项目地址:https://gitcode.com/gh_mirrors/on/OneBitDisplay

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

OneBitDisplay 项目的目录结构如下：

OneBitDisplay/
├── examples/
│   ├── linux/
│   └── src/
├── LICENSE
├── README.md
├── demo.jpg
├── fonts_opt.jpg
├── library.properties
├── notes.txt
├── sharp_lcd.jpg
└── src/
    ├── OneBitDisplay.cpp
    ├── OneBitDisplay.h
    └── fonts/
        ├── font6x8.h
        ├── font8x8.h
        ├── font12x16.h
        ├── font16x16.h
        └── font16x32.h

目录介绍

• examples/: 包含项目示例代码，分为 linux/ 和 src/ 两个子目录。
• LICENSE: 项目的许可证文件。
• README.md: 项目的主文档，包含项目介绍、使用方法等。
• demo.jpg: 演示图片。
• fonts_opt.jpg: 字体优化图片。
• library.properties: Arduino 库的属性文件。
• notes.txt: 项目笔记。
• sharp_lcd.jpg: Sharp LCD 图片。
• src/: 包含项目的源代码文件，包括 OneBitDisplay.cpp 和 OneBitDisplay.h，以及字体文件夹 fonts/。

2. 项目的启动文件介绍

项目的启动文件主要是 src/OneBitDisplay.cpp 和 src/OneBitDisplay.h。

OneBitDisplay.h

这是头文件，定义了库的主要接口和数据结构。它包含了以下主要内容：

• 类 OneBitDisplay 的声明。
• 各种函数原型的声明，如初始化函数、绘图函数等。
• 常量和宏定义。

OneBitDisplay.cpp

这是实现文件，包含了 OneBitDisplay.h 中声明的函数的具体实现。它包含了以下主要内容：

• 类 OneBitDisplay 的构造函数和析构函数。
• 各种初始化函数、绘图函数、文本处理函数的实现。
• I2C 和 SPI 通信的实现。

3. 项目的配置文件介绍

项目的配置文件主要是 library.properties。

library.properties

这是一个属性文件，用于描述 Arduino 库的元数据。它包含了以下主要内容：

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

通过这些配置，Arduino IDE 可以正确识别和管理这个库。

---

以上是 OneBitDisplay 项目的目录结构、启动文件和配置文件的介绍。希望这份教程能帮助你更好地理解和使用这个项目。

OneBitDisplayA full featured Arduino display library for 1-bit per pixel OLED, LCD and e-paper displays项目地址:https://gitcode.com/gh_mirrors/on/OneBitDisplay