MD_Parola 开源项目使用教程

MD_Parola 开源项目使用教程

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

MD_Parola 项目的目录结构如下：

MD_Parola/
├── docs/
├── examples/
├── hardware/
├── media/
│   └── photo/
├── src/
├── .gitattributes
├── .gitignore
├── Doxyfile
├── ISSUE_TEMPLATE.md
├── LICENSE
├── PULL_REQUEST_TEMPLATE.md
├── README.md
├── keywords.txt
└── library.properties

目录介绍：

• docs/: 包含项目的文档文件。
• examples/: 包含项目的示例代码，帮助用户快速上手。
• hardware/: 包含硬件相关的文件和说明。
• media/photo/: 包含项目相关的图片资源。
• src/: 包含项目的源代码文件。
• .gitattributes: Git 属性配置文件。
• .gitignore: Git 忽略文件配置。
• Doxyfile: Doxygen 配置文件，用于生成代码文档。
• ISSUE_TEMPLATE.md: GitHub Issue 模板文件。
• LICENSE: 项目许可证文件，采用 LGPL-2.1 许可证。
• PULL_REQUEST_TEMPLATE.md: GitHub Pull Request 模板文件。
• README.md: 项目的主 README 文件，包含项目的基本介绍和使用说明。
• keywords.txt: Arduino IDE 关键字文件，用于高亮显示代码中的关键字。
• library.properties: Arduino 库属性文件，包含库的基本信息。

2. 项目的启动文件介绍

MD_Parola 项目的启动文件主要是 src/MD_Parola.cpp 和 src/MD_Parola.h。这两个文件是项目的核心实现文件，包含了 LED 矩阵文本显示和滚动效果的实现代码。

src/MD_Parola.cpp

• 功能: 实现了 MD_Parola 库的核心功能，包括文本的滚动、显示参数的控制、动画效果等。
• 使用方法: 用户可以通过包含 MD_Parola.h 头文件，并实例化 MD_Parola 类来使用这些功能。

src/MD_Parola.h

• 功能: 定义了 MD_Parola 库的类和函数接口，用户可以通过这些接口来控制 LED 矩阵的显示效果。
• 使用方法: 在用户的 Arduino 项目中，包含 MD_Parola.h 头文件，并调用相应的函数来实现特定的显示效果。

3. 项目的配置文件介绍

MD_Parola 项目的配置文件主要是 library.properties 和 keywords.txt。

library.properties

• 功能: 包含 Arduino 库的基本信息，如库的名称、版本、作者等。
• 内容示例:

  name=MD_Parola
  version=1.0.0
  author=MajicDesigns
  maintainer=MajicDesigns
  sentence=Library for modular scrolling LED matrix text displays
  paragraph=The Parola software has a dependency on the MD_MAX72xx Arduino library which implements hardware functions of the LED matrix.
  category=Display
  url=https://github.com/MajicDesigns/MD_Parola
  architectures=*
  

keywords.txt

• 功能: 定义了 Arduino IDE 中需要高亮显示的关键字。
• 内容示例:

  MD_Parola	KEYWORD1
  begin	KEYWORD2
  displayClear	KEYWORD2
  displayScroll	KEYWORD2
  

通过这些配置文件，用户可以更好地了解和使用 MD_Parola 项目。