SDK Quick Start

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

1. Install

Add the package through Unity Package Manager:

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"

2. Create Settings

Open Unity menu:

AISU/SI-M1 Face SDK/Settings

The tool creates or loads this settings asset inside the importing Unity project:

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 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

Git URL packages may appear as xin.aisu.si-m1.face@<commit-hash> in Unity's package cache. This is normal.
This DLL-only release does not include importable demo samples.
Demo source and EditMode test source remain in the private development SDK repository.

2.0 KiB Raw Permalink Blame History