# airmaster_reference_projects

**Repository Path**: openLuat/airmaster-reference-projects

## Basic Information

- **Project Name**: airmaster_reference_projects
- **Description**: airmaster上的开源参考项目
- **Primary Language**: Lua
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2026-11-05
- **Last Updated**: 2026-11-06

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# airMaster 案例库

本仓库收录可独立导入的 airMaster 项目。用户在案例库中选择案例、确认名称后，将完整项目导入到自己的工作区，再继续开发。

## 目录

```text
official/       官方参考案例
community/      用户分享案例
scripts/        清单生成和校验工具
catalog.json    自动生成的案例索引
```

每个案例具有 `case.json`、`README.md`、`AGENTS.md`、`projects/` 和 `resources/`。`projects/` 保存可继续开发的源码，`resources/` 保存硬件资料、固件说明和来源记录。

## 当前案例

| 案例 | 硬件 | 内容 |
| --- | --- | --- |
| [Air8607 工业场景 UI 演示](official/air8607-ui-demo/README.md) | Air8607、Air1603、1024×600 RGB 屏、GT911 | 官方 Lua 工程、五个 UI 演示场景、原理图和板面位号图 |

## 维护与校验

官方维护者通过 Git 更新 `official/`。用户在 `community/` 提交分享项目，通过 PR 审核后发布。具体步骤见 [贡献说明](CONTRIBUTING.md)。

安装 Node.js 22 或更高版本后，在仓库根目录执行以下命令。工具仅使用 Node.js 内置模块。

```sh
node scripts/build-catalog.mjs
node scripts/build-catalog.mjs --check
```

第一条命令生成索引，第二条检查索引是否与当前文件一致。内容版本由文件路径与 SHA-256 确定，维护者编辑案例后重新生成索引即可。

手动验证导入时，将单个案例目录中的内容打包为 ZIP，使 `AGENTS.md`、`projects/` 和 `resources/` 位于归档根目录，再使用 airMaster 的项目导入功能。每次导入会创建独立的新项目。

## 索引格式

`catalog.json` 的 `schemaVersion` 当前为 `1`，`cases` 数组中的每项包含案例描述、`official/community` 来源、仓库相对目录、内容 `revision`、文件数、总字节数和文件摘要清单。索引中的路径使用 `/`。`revision` 为整个案例文件清单的 SHA-256，资料变更会产生新的版本。

本格式是案例库的初版约定，后续由 airMaster 1.7.1 的契约与两端同步实现对齐。

## 许可

仓库维护工具使用 [Apache-2.0](LICENSE)。各案例声明自身的源码许可，引用资料的来源与权利说明随案例提供。