71 lines
2.4 KiB
Markdown
71 lines
2.4 KiB
Markdown
# AISU SI-M1 Face SDK
|
|
|
|
`xin.aisu.si-m1.face` is a Unity UPM package for the AISU SI-M1 face recognition module. This public package is distributed as compiled DLLs and does not include SDK source code.
|
|
|
|
## 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 |
|
|
| Default Settings Path | `Assets/AISU/SI-M1 Face SDK/FaceSdkSettings.asset` |
|
|
|
|
## Install
|
|
|
|
Add the package through Unity Package Manager using a Git URL, or add it to `Packages/manifest.json`:
|
|
|
|
```json
|
|
"xin.aisu.si-m1.face": "https://github.com/your-org/si-m1-face-package.git#v0.1.0"
|
|
```
|
|
|
|
For local validation:
|
|
|
|
```json
|
|
"xin.aisu.si-m1.face": "file:D:/Workspaces/SDK/si-m1-face-package"
|
|
```
|
|
|
|
## Quick Start
|
|
|
|
1. Open `AISU/SI-M1 Face SDK/Settings` and create or load `FaceSdkSettings`.
|
|
2. Set serial port, baud rate, mock mode, and logging options.
|
|
3. Open `AISU/SI-M1 Face SDK/Create Manager GameObject` to create a `FaceModuleManager` in the current scene.
|
|
4. Reference the manager from your own scripts and call the SDK services.
|
|
|
|
```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);
|
|
}
|
|
}
|
|
```
|
|
|
|
## Documentation
|
|
|
|
| Document | Description |
|
|
|---|---|
|
|
| [SDK_QuickStart.md](Documentation~/SDK_QuickStart.md) | Installation, settings, manager creation, minimal call flow |
|
|
| [SDK_Configuration.md](Documentation~/SDK_Configuration.md) | `FaceSdkSettings`, editor panel, mock mode, serial parameters |
|
|
| [SDK_API_Reference.md](Documentation~/SDK_API_Reference.md) | Public namespaces, manager, events, services, models, callback API |
|
|
| [SDK_Mock_And_Testing.md](Documentation~/SDK_Mock_And_Testing.md) | Mock behavior and validation guidance |
|
|
|
|
## Public Package Notes
|
|
|
|
- This package does not include SDK source files.
|
|
- This package does not include `.pdb` debug symbols.
|
|
- Demo and test source files are not included in this DLL-only release.
|
|
- If you need sample source or internal tests, use the private development SDK repository.
|