orphe-core-insole - v0.4.0
    Preparing search index...

    Interface DeviceProfile<TFields, TCommands>

    デバイス固有差分(CORE / INSOLE)の注入点。 OrpheCoreInsole はこの interface だけに依存し、接続シーケンスとパースを委譲する。

    interface DeviceProfile<
        TFields extends object = SensorFieldMap,
        TCommands = unknown,
    > {
        defaultNotificationType: string;
        kind: string;
        begin(context: BeginContext): Promise<unknown>;
        characteristics(): Record<string, CharacteristicId>;
        commands?(io: GattIo): TCommands;
        modes?(): DeviceMode[];
        parse(uuid: string, data: DataView): Partial<TFields>[] | null;
        parseAdvertisement?(event: unknown): Partial<TFields> | null;
        requestDeviceOptions(): BleRequestDeviceOptions;
        resolveDevice?(
            name: string | null,
            log?: (message: string, detail?: unknown) => void,
        ): void;
        storageKey(id: number): string;
    }

    Type Parameters

    Implemented by

    Index
    defaultNotificationType: string

    begin() の type 省略時に使う notification type

    kind: string

    'core' | 'insole' など

    • 接続シーケンス。transport の read/write/startNotify だけで記述する。 resolve = 成功(値は begin() の戻り値になる)/ reject = 失敗。 自動再接続時にも同じシーケンスが再実行される。

      Parameters

      Returns Promise<unknown>

    • デバイス固有コマンド(LED・姿勢リセット・ストリーミングモード切替など)を作る。 io には OrpheCoreInsole.transport が渡される。OrpheCoreInsole.commands から使う。

      Parameters

      Returns TCommands

    • このデバイスが提供しうる取得モードの一覧(FW による絞り込み前)。 未実装なら FW によるモード制限を行わない。

      Returns DeviceMode[]

    • 通知パケットをパースする。対象外の uuid や不正パケットは null を返す。 返したサンプル列(TFields の部分集合)は SampleEmitter へそのまま配送される。

      Parameters

      • uuid: string
      • data: DataView

      Returns Partial<TFields>[] | null

    • advertisementreceived のイベントをフィールドに解釈する(INSOLE は status)。 対象外なら null。OrpheCoreInsole.watchAdvertisements の監視中に呼ばれる。

      Parameters

      • event: unknown

      Returns Partial<TFields> | null

    • begin() でデバイスを選んだ直後、接続シーケンスより先に呼ばれる(name は advertise 名。取れなければ null)。 デバイス名で振る舞いを変えるプロファイル(autoProfile)が実装する。

      Parameters

      • name: string | null
      • Optionallog: (message: string, detail?: unknown) => void

      Returns void

    • デバイス記憶の localStorage キー(スロット id ごとに一意)

      Parameters

      • id: number

      Returns string