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

    Class OrpheCoreInsole<TFields, TCommands, TProfile>

    orphe-core-insole — ORPHE CORE / ORPHE INSOLE 共通 BLE SDK の公開 API。

    ここに並ぶものだけが互換性を約束する対象。内部部品(プロトコルの codec、 状態機械、キュー等)は各モジュールから直接 import できるが、公開 API ではない。

    Type Parameters

    Index

    フィールド名 → リスナーへサンプルを配送する emitter

    id: number

    スロット番号(記憶デバイスの分離キー)

    profile: TProfile

    デバイス種別の実装(接続シーケンス・パースを担う)。 coreProfile() / insoleProfile() を渡した場合はその型のまま参照できる(ble.profile.device_information など)

    BLE トランスポート(scan / read / write / notify / 再接続)

    • get availableModes(): DeviceMode[]

      接続中の FW で実際に使える取得モードだけを返す。 FW 情報が取れない個体(旧 FW など)は判定できないため絞り込まない。

      Returns DeviceMode[]

    • get commands(): TCommands

      デバイス固有コマンド。CORE は LED・レンジ・姿勢リセットなど(CoreCommands)、 INSOLE はストリーミングモード切替など(InsoleCommands)。 autoProfile では接続して種別が決まるまで使えない(throw する)。

      Returns TCommands

    • get firmware(): FirmwareInfo | null

      接続中デバイスのファームウェア情報。begin() の中で 1 回だけ read してキャッシュする。 未接続、または FW 情報を持たない個体では null。

      Returns FirmwareInfo | null

    • get lastAdvertisement(): Partial<TFields> | null

      最後に受信したアドバタイズをプロファイルが解釈した結果(INSOLE は { status })。未受信なら null

      Returns Partial<TFields> | null

    • get lastBeginType(): string | undefined

      直近の begin() で開始した notification type(type を省略した場合はプロファイルの既定)。 begin() 前は undefined。

      Returns string | undefined

    • get sharedBridgeRole(): SharedBridgeRole | null

      タブ間共有(begin の useSharedBridge: true)での役割。 'primary' は自分が BLE 接続を持って配信中、'secondary' は別タブの接続から受信中。共有していなければ null

      Returns SharedBridgeRole | null

    • 接続してデータ取得を開始する。 シーケンスの中身はプロファイルが定義し、成功時にデバイスを記憶、 autoReconnect 指定時は以後の切断で同じシーケンスが自動再実行される。

      Parameters

      Returns Promise<unknown>

    • GATT 接続中なら true

      Returns boolean

    • 正規化フィールド名('acc' / 'gyro' / 'quat' / 'press' ...)で購読する。 キーとペイロード型はプロファイルの TFields から推論される(補完が効く)。 '*' はサンプル全体。解除関数を返す。

      Type Parameters

      • K extends string

      Parameters

      Returns () => void

    • ライフサイクルイベント('onConnect' / 'onDisconnect' / 'onStartNotify' / 'onError' / 'onReconnectSuccess' など)を購読する。解除関数を返す。 コンストラクタの events と違い、構築後に何個でも足せる(toolkit が作ったインスタンスにも使える)。 購読者はコンストラクタの events より先に呼ばれる。

      Type Parameters

      Parameters

      Returns () => void

    • パース前の生 DataView を購読する(uuid は論理名)。解除関数を返す。 attachLegacyCallbacks の gotData 配送などが使う。

      Parameters

      • listener: (uuid: string, value: DataView) => void

      Returns () => void

    • GET_FW_NAME を read してファームウェア情報を取り直す。 autoProfile のようにデバイス名で振る舞いを決めるプロファイルは、ここで CORE / INSOLE を判別する。 characteristic 未実装・read 失敗・日付未書込はすべて null(例外は投げない)。 デバイスの選択(chooser のキャンセル、別スロットへの割当済み)だけは失敗として reject する。

      Returns Promise<FirmwareInfo | null>

    • タブ間共有だけをやめる(BLE 接続はそのまま)。Primary なら他タブへ切断を知らせる

      Returns void

    • コールバック例外などを onError へ安全に報告する(throw は伝播しない)

      Parameters

      • error: unknown

      Returns void

    • stop() と同じ。切断・記憶クリア・自動再接続解除。タブ間共有も解除する

      Returns void

    • uuid(論理名)の notify を横取りする sink を設定する。FIFO 収録や歩容解析の ように、request/response プロトコルの応答を通常のセンサー配送から切り離して 消費するモジュール用。設定中はその uuid の通知が sink のみに渡る。 解除関数を返す。同じ uuid への多重設定はエラー(横取りの奪い合い事故防止)。

      Parameters

      • uuid: string
      • sink: (value: DataView) => void

      Returns () => void

    • 切断してクリアする。自動再接続も解除される

      Returns void

    • アドバタイズの監視をやめる

      Returns void

    • デバイスの時計を PC 時刻 + 平均往復時間/2 に合わせる。 begin() の中でも自動で行われるので、通常は呼ばなくてよい。

      Parameters

      Returns Promise<SyncTimeResult>

    • 選択中のデバイスのアドバタイズを監視する(接続していなくても受信できる)。 受信は events.onAdvertisement / onEvent('onAdvertisement') と、プロファイルが解釈した フィールド(INSOLE は status: バッテリー・取付位置・FW 版)の on() 配送で届く。 ブラウザやデバイスが対応していなければ false を返す。

      Returns Promise<boolean>

    • Date をデバイスの時刻として書き込む

      Parameters

      • date: Date

      Returns Promise<void>