77 lines
2.9 KiB
Markdown
77 lines
2.9 KiB
Markdown
# AISU SI-M1 Face SDK
|
|
|
|
`xin.aisu.si-m1.face` is a Unity SDK for AISU SI-M1 face recognition modules. It provides serial communication, packet parsing, module lifecycle management, face verification, face enrollment, user management, image capture, QR code, UVC parameters, mock transport, and sample scenes.
|
|
|
|
中文说明见 [README.zh-CN.md](README.zh-CN.md)。
|
|
|
|
## Package Info
|
|
|
|
| Item | Value |
|
|
|---|---|
|
|
| Package Name | `xin.aisu.si-m1.face` |
|
|
| Display Name | `AISU SI-M1 Face SDK` |
|
|
| Runtime Assembly | `Aisu.SIM1.Face.Runtime.dll` |
|
|
| Editor Assembly | `Aisu.SIM1.Face.Editor.dll` |
|
|
| Unity Version | `2021.3` or newer |
|
|
| Settings Asset | `Assets/Resources/AISU/SI-M1 Face SDK/FaceSdkSettings.asset` |
|
|
|
|
## Quick Start
|
|
|
|
1. Open `AISU/SI-M1 Face SDK/Settings`.
|
|
2. Configure serial port, baud rate, mock mode, auto verify, and logging options.
|
|
3. Add one `FaceModuleManager` to the scene and bind the settings asset.
|
|
4. Call SDK services through `FaceModuleManager`.
|
|
|
|
```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);
|
|
}
|
|
|
|
private void OnApplicationQuit()
|
|
{
|
|
manager?.Close();
|
|
}
|
|
}
|
|
```
|
|
|
|
## Samples
|
|
|
|
Open `AISU/SI-M1 Face SDK/Settings` and click `Import Demos`, then open the imported scenes under `Assets/Samples`.
|
|
|
|
```text
|
|
Assets/Samples/AISU SI-M1 Face SDK/SIM1FaceDemo/Scenes/FaceModuleDemo.unity
|
|
Assets/Samples/AISU SI-M1 Face SDK/FaceDetectionDemo/Scenes/FaceDetectionDemo.unity
|
|
```
|
|
|
|
Do not open sample scenes directly from `Packages/xin.aisu.si-m1.face/Samples`, because Git UPM package contents are read-only in Unity.
|
|
|
|
Use `SI-M1 Face Demo` for full SDK command testing. Use `Face Detection Demo` for a compact camera, serial, enrollment, verification, and user-list workflow.
|
|
|
|
## Documentation
|
|
|
|
| English | Chinese |
|
|
|---|---|
|
|
| [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) |
|
|
| [Mock and Testing](Documentation~/SDK_Mock_And_Testing.md) | [Mock 与测试](Documentation~/SDK_Mock_And_Testing.zh-CN.md) |
|
|
| [Demo UI](Documentation~/README_UI.md) | [Demo UI](Documentation~/README_UI.zh-CN.md) |
|
|
|
|
## Runtime Notes
|
|
|
|
- Keep one `FaceModuleManager` in each scene.
|
|
- Use `Close()` or `CloseAsync()` when leaving a scene or quitting the app.
|
|
- When auto verify is enabled, use `StopFaceOperationAsync()` before enrollment, user management, QR scan, image capture, or other exclusive operations.
|