SDK Quick Start

This public UPM package is distributed as compiled DLLs and does not include SDK source code, Demo source code, or test source code.

1. Install

Add the package through Unity Package Manager, or add it to Packages/manifest.json:

"xin.aisu.si-m1.face": "https://github.com/your-org/si-m1-face-package.git#v0.1.0"

For local validation:

"xin.aisu.si-m1.face": "file:D:/Workspaces/SDK/si-m1-face-package"

2. Create Settings

Open Unity menu:

AISU/SI-M1 Face SDK/Settings

The tool creates or loads the default settings asset:

Assets/AISU/SI-M1 Face SDK/FaceSdkSettings.asset

Configure serial port, baud rate, mock mode, and logging options.

3. Create Manager

Open Unity menu:

AISU/SI-M1 Face SDK/Create Manager GameObject

Keep one FaceModuleManager in the scene to avoid duplicate serial connections and duplicate event dispatch.

4. Minimal Code

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);
    }
}

5. Runtime Modes

Scenario	Recommended Setting
Editor UI integration without hardware	`Use Mock In Editor = true`
Editor with real serial hardware	`Use Mock In Editor = false`, configure editor serial parameters
Windows Player	`Transport Mode = SerialPort` or `Auto`, configure runtime serial parameters

Notes

This DLL-only release does not include importable Demo samples.
Demo source and EditMode test source remain in the private development SDK repository.

1.8 KiB Raw Blame History