si-m1-face-package/Documentation~/SDK_License_Request.md

74 lines
2.2 KiB
Markdown

# SI-M1 Face SDK License Request
This public DLL-only package requires a project-specific license file for real serial-port runtime usage. Mock mode does not require a license.
## License File Path
Place the license file at:
```text
Assets/StreamingAssets/si-m1_face.dat
```
The SDK reads this file through `Application.streamingAssetsPath`.
## Required Unity Binding Parameters
Provide these values from the Unity project that will run the SDK:
| Field | Unity Source |
|---|---|
| `identifier` | `Application.identifier` |
| `companyName` | `Application.companyName` |
| `productName` | `Application.productName` |
| `version` | `Application.version` |
| `unityVersion` | `Application.unityVersion` |
If any of these values changes, the existing license becomes invalid and a new license is required.
## Parameter Probe
Add this temporary script to the customer project and copy the Console output when requesting a license:
```csharp
using UnityEngine;
public sealed class FaceLicenseParameterPrinter : MonoBehaviour
{
private void Awake()
{
Debug.Log("identifier=" + Application.identifier);
Debug.Log("companyName=" + Application.companyName);
Debug.Log("productName=" + Application.productName);
Debug.Log("version=" + Application.version);
Debug.Log("unityVersion=" + Application.unityVersion);
}
}
```
## Request Information
Provide:
| Item | Example |
|---|---|
| Customer name | `customer-a` |
| Project name | `Face App` |
| Unity binding parameters | See above |
| License start time | `2026-08-10T00:00:00+08:00` |
| License expiry time | `2027-08-10T00:00:00+08:00` |
| Licensed features | `SerialRuntime,Basic,Verify,Enroll` |
License times use Beijing time and must use `yyyy-MM-ddTHH:mm:ss+08:00`.
## Common Failures
| Symptom | Cause |
|---|---|
| License file missing | `si-m1_face.dat` is not under `Assets/StreamingAssets` |
| Binding mismatch | One of the Unity binding parameters changed |
| Expired | Current Beijing time is after `expireAt` |
| Not yet valid | Current Beijing time is before `issuedAt` |
| Feature denied | The license does not include the requested SDK feature |
| Invalid signature | The file was modified or does not match this SDK build |