si-m1-face-package/README.md

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, demo source code, test source code, or debug symbols.

中文说明见 README.zh-CN.md.

Package Info

Item	Value
Package Name	xin.aisu.si-m1.face
Display Name	AISU SI-M1 Face SDK
Version	0.1.2
Runtime Assembly	Aisu.SIM1.Face.Runtime.dll
Editor Assembly	Aisu.SIM1.Face.Editor.dll
Unity Version	2021.3 or newer
User Settings Asset	Assets/AISU/SI-M1 Face SDK/FaceSdkSettings.asset in the importing Unity project

Install

Add the package through Unity Package Manager using this Git URL:

https://git.aisu.xin/aisu-sdk/si-m1-face-package.git#v0.1.2

Or add it to Packages/manifest.json:

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

Unity may display Git packages as xin.aisu.si-m1.face@<commit-hash> in Library/PackageCache. This is expected for Git URL packages; the package version remains defined by package.json.

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.

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

English	Chinese
Quick Start	快速开始
Configuration	配置说明
API Reference	API 参考
Mock and Testing	Mock 与测试
Demo UI Notice	Demo UI 说明

Public Package Scope

• SDK source files are not included.
• .pdb debug symbols are not included.
• Demo and test source files are not included.
• Importable Samples~ are not included in this DLL-only release.
• Sample source and internal validation tests are maintained in the private development SDK repository.