# AISU SI-M1 Face SDK

`xin.aisu.si-m1.face` 是面向 AISU SI-M1 人脸识别模组的 Unity UPM 包。公开发布包以编译后的 DLL 形式提供，不包含 SDK 源码、Demo 源码、测试源码或调试符号。

English documentation: [README.md](README.md).

## 包信息

| 项目 | 值 |
|---|---|
| Package Name | `xin.aisu.si-m1.face` |
| Display Name | `AISU SI-M1 Face SDK` |
| Version | `0.1.4` |
| Runtime Assembly | `Aisu.SIM1.Face.Runtime.dll` |
| Editor Assembly | `Aisu.SIM1.Face.Editor.dll` |
| Unity Version | `2021.3` 或更高 |
| 用户项目配置资产 | 导入项目中的 `Assets/AISU/SI-M1 Face SDK/FaceSdkSettings.asset` |

## 安装

在 Unity Package Manager 中使用以下 Git URL 导入：

```text
https://git.aisu.xin/aisu-sdk/si-m1-face-package.git#v0.1.4
```

或写入 `Packages/manifest.json`：

```json
"xin.aisu.si-m1.face": "https://git.aisu.xin/aisu-sdk/si-m1-face-package.git#v0.1.4"
```

Unity 对 Git URL 包可能会在 `Library/PackageCache` 中显示为 `xin.aisu.si-m1.face@<commit-hash>`。这是 Git 包的正常行为；包版本仍由 `package.json` 中的 `version` 字段定义。

## 快速开始

1. 打开 `AISU/SI-M1 Face SDK/Settings`，创建或加载 `FaceSdkSettings`。
2. 配置串口号、波特率、Mock 模式和日志选项。
3. 打开 `AISU/SI-M1 Face SDK/Create Manager GameObject`，在当前场景中创建 `FaceModuleManager`。
4. 在业务脚本中引用该 Manager 并调用 SDK 服务。

```csharp
using Aisu.SIM1.Face.Core;
using UnityEngine;

public sealed class FaceExample : MonoBehaviour
{
    [SerializeField] private FaceModuleManager manager;

    private async void Start()
    {
        manager.Open();
        await manager.WaitReadyAsync();

        var version = await manager.Basic.GetVersionAsync();
        Debug.Log("SI-M1 version: " + version);
    }
}
```

## 文档

| English | 中文 |
|---|---|
| [Quick Start](Documentation~/SDK_QuickStart.md) | [快速开始](Documentation~/SDK_QuickStart.zh-CN.md) |
| [Configuration](Documentation~/SDK_Configuration.md) | [配置说明](Documentation~/SDK_Configuration.zh-CN.md) |
| [API Reference](Documentation~/SDK_API_Reference.md) | [API 参考](Documentation~/SDK_API_Reference.zh-CN.md) |
| [License Request](Documentation~/SDK_License_Request.md) | [授权申请](Documentation~/SDK_License_Request.zh-CN.md) |
| [Mock and Testing](Documentation~/SDK_Mock_And_Testing.md) | [Mock 与测试](Documentation~/SDK_Mock_And_Testing.zh-CN.md) |
| [Demo UI Notice](Documentation~/README_UI.md) | [Demo UI 说明](Documentation~/README_UI.zh-CN.md) |

## 公开包范围

- 不包含 SDK 源码。
- 不包含 `.pdb` 调试符号。
- 不包含 Demo 和测试源码。
- DLL-only 公开版本不包含可导入的 `Samples~`。
- 示例源码和内部验证测试保留在私有开发 SDK 仓库中。