Infinito Nirone 7

白羽の矢を刺すスタイル

AccessorySetupKit でハマったこと - Part 3

うん、「また」なんだ。済まない。 仏の顔もって言うしね、謝って許してもらおうとも思っていない。

でももう三度目なんだよね。ただ多分 Part 4 もある。

CBCentralManager の初期化タイミング

Part 2 で解説した通り、CBCentralManager は AccessorySetupKit にデバイスが追加されたか、あるいはデバイスのマイグレーションが完了したあとで初期化しなければなりません。 この制約をそのまま解釈するならば、2台目以降のデバイスを AccessorySetupKit に登録するケースでも CBCentralManager の初期化を遅らせなければなりません。もし既に CBCentralManager を初期化済みの場合、一度そのインスタンスを破棄する必要があると解釈できます。

自分の手元で次のような構成を用意しいくつかのテストを実施してみました。

  • 構成
    • iOS アプリ(KMP 製のもの、Swift 製のものをそれぞれ用意)
    • 2 台の ESP32

ESP32 にはそれぞれ BLEServer を立ててアドバタイズと簡単なGATT通信のためのセットアップをしています。次のページにある BLEServer のコードを参考にするとよいでしょう(Scan Response を有効にしないと AccessorySetupKit がデバイスを検出しないので、その部分だけ変更が必要です)。

zenn.dev

iOS アプリは ESP32 側に用意した Service UUID をベースに AccessorySetupKit でスキャンをかけるコードを用意します。 ペアリング部分は簡単化するため、ASPickerDisplayItem の setupOption に .confirmAuthorization と .finishInApp を設定し、.accessoryAdded イベントの直後で finishAuthorization を呼ぶようにします。

CBCentralManager を 1 度だけ初期化し、以降は使い回す実装

既にデバイスが AccessorySetupKit にある状態か、1台目のデバイスをペアリングするときに1度だけ CBCentralManager を初期化し、2台目のデバイスをペアリングするときには特に何もせず既に初期化済みの CBCentralManager を使って retrievePeripherals や connectPeripheral を実行する実装です。

KMP のアプリも Swift のアプリも、特に問題なく2台の ESP32 どちらも見つけられ、connectPeripheral もできます。

デバイスの追加時に CBCentralManager を破棄し作り直す実装

この手順が(presumably)あるべきであろう実装です。AccessorySetupKit で showPicker する手前で CBCentralManager を一度破棄し、.accessoryAdded イベントで CBCentralManager を再度初期化します。

Swift 実装のアプリではこの実装でも特に問題なく動作しますが、KMP 実装のアプリではいくつかトラブルが発生します。

CBCentralManager を再度初期化したあと didUpdateState で unsupported と言われる

CBCentralManager の初期化時のオプションで CBCentralManagerOptionRestoreIdentifierKey を指定するとこの状態にハマりやすいです(このオプションなしに AccessorySetupKit を使うケースのほうが稀に思いますが)。

unsupported という state が何を示すかパッと見では分かりづらいですが、この state になった直前の bluetoothd のログを見ると原因が掴めます。このログを見ると restore identifier が重複していることが分かります。

Oct 27 17:09:48.357463 bluetoothd[97] <Error>: Duplicate restore identifier "asksample" from session "com.example.ask_sample.Asksample-central-DAPerAccessory-1994-785" in application "com.example.ask_sample.Asksample"

iOS では CBCentralManager のインスタンスを複数作ることができますが、インスタンスごと固有の CBCentralManagerOptionRestoreIdentifierKey をもたせる必要があります。

次のように KMP のコードで CBCentralManager を破棄する場合でも、上記のエラーにハマる場合があります。

class CompanionPeripheralManager {
  private var cbCentralManager: CBCentralManager? = // どこかで初期化...
  private val session = ASAccessorySession()

  suspend fun startPairing() {
    // 
    cbCentralManager = null

    // ...
    session.showPicker(/* ... */)
  }
}

KMP を使う場合、メモリにあるオブジェクトは2ステップを経て解放されます。はじめに、KMP のガベージコレクションが動くことでヒープからオブジェクトがいなくなります。ここで iOS 側の ARC がオブジェクトへの参照がなくなったことを検知しメモリを解放します。 よって、KMP のガベージコレクションが走るまでは破棄されるべき CBCentralManager がメモリに残ることになります。ガベージコレクションが走るより前に CBCentralManager を作り直すと restoration identifier が重複することになります。

ある程度時間をおいて再度 CBCentralManager を作り直そうとすると正常に作り直せるので、CBCentralManager の初期化に retry を仕込む回避策が考えられますが、果たしてそんなことをしてシステムリソースの無駄遣いになったりしないかと思ってしまうため、これでいいのか自信がありません。 あるいは、CBCentralManager と distinct な restoration identifier を 2 つ用意して、タイミングによってどちらを使うか切り替えながら使う(そうすれば片方が解放を待っている間もう片方を使える)実装も考えられますが、これもやりたいことに対して複雑すぎる気がしてなりません。

究極、KMP を使わず Swift で実装しきるのが最も安全だと思います。

CBCentralManager を再度初期化したあと didUpdateState で poweredOn と言われるのに retrievePeripherals が空配列を返す

なんでかまだわからん。 このとき retrievePeripherals が空配列を返した後、didUpdateState が poweredOff を通知しすぐに poweredOn に戻る。

ASAccessoryEvent の発火タイミング

アプリが裏に回っても ASAccessorySettion が active な間は ASAccessoryEvent がアプリに通知される

ASAccessoryEvent には様々な種類が定義されていて、デバイスの削除や何らかのプロパティの変更もアプリに通知されるようになっています。 iOS ではシステム設定画面からもデバイスの削除や名前の変更ができるようになっていて、ASAccessorySession が生きている限りはシステム設定画面での変更もアプリに通知されます。

ただし、一度アプリプロセスが死んだり ASAccessorySession が invalidated になると、次に activate されるまでは ASAccessoryEvent は通知されません。 ペリフェラルの再接続とちがってシステム設定画面での変更でアプリプロセスが起こされることはないので、アプリ起動時にアプリ自身が知っているデバイスと AccessorySetupKit が知っているデバイスを突合して sync する処理が必要です。

.accessoryChanged イベントはシステム設定画面を開くだけで通知される

他のイベントでも名前通りの解釈はしないほうがよさそうですが、特に .accessoryChanged イベントはシステム設定画面でデバイスの詳細を開くだけで通知されます。 アプリは ASAccessoryEvent の type を見るだけではなく、具体的に何が変わったのかを突き合わせる術を持っておき必要のないイベントは無視するロジックを作っておくほうがよいです。