MicroPython nano-gui 技术文档

MicroPython nano-gui 技术文档

1. 安装指南

1.1 快速安装

1.1.1 使用 mpremote 安装

首先，确保你已经安装了 mpremote 工具。你可以通过以下命令安装：

$ pip3 install mpremote

然后，克隆项目仓库到你的本地计算机：

$ git clone https://github.com/peterhinch/micropython-nano-gui
$ cd micropython-nano-gui

接下来，使用 mpremote 挂载当前目录到 MicroPython 设备：

$ mpremote mount .

这将提供一个 REPL 环境。你可以运行一个演示程序来测试安装：

>>> import gui.demos.aclock

1.1.2 使用 mip 安装

如果你的硬件支持网络连接，你可以使用 mip 工具来安装整个 GUI：

>>> import mip
>>> mip.install("github:peterhinch/micropython-nano-gui")

2. 项目使用说明

2.1 项目简介

MicroPython nano-gui 是一个基于 FrameBuffer 类的轻量级图形用户界面（GUI）库。它适用于多种 MicroPython 主机和显示设备，支持多种显示技术，包括小尺寸的彩色和单色 OLED、彩色 TFT、ePaper 和 Sharp 单元。

2.2 快速启动

你可以通过 mpremote 工具快速启动项目，无需实际安装。只需挂载项目目录并运行演示程序即可。

2.3 性能提升

项目支持 asyncio，可以在低功耗设备上有效工作。只有当用户进行操作时，程序才会更新屏幕，这大大减少了对 CPU 的需求。

3. 项目API使用文档

3.1 应用初始化

3.1.1 用户定义颜色

用户可以自定义颜色，以适应不同的显示需求。

3.1.2 单色显示

对于单色显示，特别是 ePaper 显示，有一些特殊的注意事项。

3.1.3 显示更新机制

项目采用事件驱动的设计，只有当用户进行操作时，程序才会更新屏幕。

3.1.4 ePaper 显示

ePaper 显示有一些新的发展，项目对此进行了支持。

3.2 Label 类

Label 类用于在屏幕的任意位置动态显示文本。

3.3 Meter 类

Meter 类用于显示垂直面板仪表。

3.4 LED 类

LED 类用于显示任意颜色的虚拟 LED。

3.5 Dial 和 Pointer 类

Dial 和 Pointer 类用于显示时钟或指南针风格的指针。

3.6 Scale 类

Scale 类用于显示具有广泛动态范围的线性显示。

3.7 Textbox 类

Textbox 类用于显示滚动文本。

4. 项目安装方式

4.1 文件和依赖

4.1.1 核心文件

项目包含多个核心文件，用于支持不同的显示设备和功能。

4.1.2 演示脚本

项目提供了多个演示脚本，帮助用户快速了解和使用项目功能。

4.1.3 字体

项目支持多种字体，用户可以根据需要选择和使用。

4.1.4 硬件设置示例

项目提供了多个硬件设置示例，帮助用户配置硬件环境。

4.2 依赖

项目依赖于 FrameBuffer 类，确保你的 MicroPython 环境支持此功能。

4.3 验证硬件配置

项目提供了验证硬件配置的工具和方法，确保硬件环境正确配置。

通过以上文档，用户可以快速了解和使用 MicroPython nano-gui 项目，实现轻量级图形用户界面的开发。