AccessorySetupKitについて

AccessorySetupKitについて

AccessorySetupKitを使用して、アクセサリのセットアップ体験を向上させましょう。BluetoothまたはWi-Fiアクセサリの画像が挿入された美しいペアリングダイアログが表示されるため、設定アプリに切り替える必要がありません。特定のアプリのみをアクセサリとペアリングして、プライバシーを強化する方法を確認しましょう。既存のアクセサリを移行して、AccessorySetupKitで管理できるようにする方法も解説します。

リソース
ダウンロード

こんにちは AppleのBluetoothチームのYixinです
今日は AccessorySetupKitによるアクセサリセットアップ体験の向上について説明します最初に概要を説明し
APIについて掘り下げたうえでサンプルアプリを作成していきます
最後にアクセサリーピッカーでアクセサリを見栄えよく表示する方法を紹介します
では概要から始めましょう
アクセサリは私たちの生活に非常に重要なものとなっています健康状態をモニタリングするフィットネストラッカーからアートを形にするクリエイティブツールまで様々なものがあります iOS 18とiPadOS 18にはアクセサリのセットアップ体験をさらに向上させるための機能が追加されています
今回導入されたAccessorySetupKitは Bluetooth/Wi-Fi対応のアクセサリを効率的かつプライバシーに配慮した方法で設定および管理するためのまったく新しいフレームワークです
APIを呼び出すだけで新たに導入されたアクセサリピッカーが開きアプリとペアリングできる周辺のアクセサリが表示されますこのピッカーにはアクセサリを表す忠実度の高い独自のアートワークとわかりやすい名前が表示されます
1回タップするだけでアクセサリが安全にアプリとペアリングされすぐに使える状態になりますアクセサリが対応していればこの1回のタップでアクセサリから BluetoothとWi-Fiの両方にアクセスできるようになります
アプリでは引き続きCoreBluetooth APIと NetworkExtension APIを使用してアクセサリと通信できます
> の新しいには AccessorySetupKitによって管理されるすべてのアクセサリが表示されます各アクセサリの詳細ページでは製品の画像表示名ハードウェア名により簡単にアクセサリを識別できます
ユーザーはアクセサリ名を変更したりペアリング対象アプリのアクセスを切り替えたりシステムから削除したりできます
新しいデザインのアクセサリページはアクセサリが対応しているテクノロジーに応じて Bluetooth設定と Wi-Fi設定でも確認できます
iOS 18/iPadOS 18では AccessorySetupKitは Bluetoothと Wi-Fi対応のアクセサリをサポートしますその仕組みを確認しましょうまず従来のアプリでのアクセサリの設定方法と AccessorySetupKitとの違いを確認します
これまでアプリは Bluetoothの使用許可をリクエストしてアクセサリを検出し接続していました
アクセサリがブロードキャストしている Wi-Fiネットワークに参加するには別途許可を求める必要がありました
さらにBluetoothペアリングも要求する必要がありましたこれに対して AccessorySetupKitではデベロッパとユーザー両方の負担が軽減されます 1回タップするだけでアクセサリがアプリとペアリングされ BluetoothとWi-Fi両方でアプリからアクセサリにアクセスできるようになります新しいアクセサリピッカーでは何を許可するのかをユーザーがこれまで以上に簡単に確認できますアクセサリのわかりやすい名前と製品画像に加えアクセサリが無線で広告するハードウェア名も表示されるためタップして設定を開始する前に正しいアクセサリかどうかを確認できますこれを実現しているのが AccessorySetupKitのプライバシーに配慮したデザインです
アプリの前面に表示されるアクセサリピッカーは別のプロセスで実行されますアプリは検出ルールとアセットをピッカープロセスに送信しますこれらのルールにはBluetoothとWi-Fi両方のインターフェイスを含めることができるため 1つの設定フローでアクセサリとの通信に必要なすべてのアクセス許可を取得できます
アクセサリが検出されるとそれがピッカーに表示され 1回タップするだけでアプリとペアリングできます
ここまでがAccessorySetupKitの概要です次はAPIを見ていきましょうここではデジタルサイコロを扱うアプリを作成しますサイコロで出た目をBluetoothで同期しますこのサンプルプロジェクトはダウンロードすることもできますこのアプリではCoreBluetoothを使用してデジタルサイコロをシミュレーションしますサンプルアプリはCoreBluetoothに接続して Bluetooth GATTサービスにサブスクライブします
AccessorySetupKitを使用するにはアプリのInfo.plistにエントリを追加します AccessorySetupKit - Supportsの下に Bluetoothを追加しますこれによりサンプルアプリがサイコロとやり取りできるようになります Wi-Fiもこの配列でサポートされています次にアクセサリを検出するためのルールを追加します Bluetooth Services、Wi-Fi SSID またはCompany Identifiersですこのサイコロは2色ありますそれぞれ広告するサービスUUIDが異なるため Bluetooth Servicesの下に 2つのUUIDを追加しますアプリでアクセサリを使用するには 3つの手順を実行しますアクセサリの検出アクセサリの使用の認可アクセサリとの通信ですこのうち検出と認可は AccessorySetupKitで対応できますが通信についてはこれまでのバージョンのiOSと同様に CoreBluetoothとNetworkExtensionで処理します
AccessorySetupKitで最初に使用するクラスは ASAccessorySessionです
これはアクセサリピッカーの表示イベントの通知アクセサリの管理を担う中心的なオブジェクトです
ASAccessorySessionにピッカーを表示するよう要求するには ASPickerDisplayItemオブジェクトの配列を指定します
ASPickerDisplayItemではアクセサリの名前と画像および検出記述子を定義してスキャン方法を指定します
これにより ASAccessorySessionで showPickerを呼び出してピッカープロセスで検出と認可を開始できます設定が完了するとアプリはセッションオブジェクトを介して ASAccessoryEventを受け取りますこのイベントには新しく追加されたアクセサリとアプリがやり取りする際に必要となる情報が含まれています
コードを見てみましょう
先ほど説明したようにまずASAccessorySessionを作成します
このセッションは DispatchQueueでアクティブ化されそこでAPI呼び出しを実行しますまたアプリがセッションからのイベントの処理に使用するeventHandlerを指定します
セッションアクセサリまたはピッカーに関する更新情報があると ASAccessoryEventがイベントハンドラに渡されますイベントには様々な種類があり eventTypeを確認することで識別できます activatedイベントをセッションから accessoriesプロパティを読み取ることでアクセサリに対してクエリを実行したり新しい設定プロセスを開始するための信号として使用しますイベントの処理については後ほど詳しく説明します次に設定プロセスを開始する方法を見てみましょうピッカーの表示項目を作成してアクセサリピッカーを呼び出します
表示項目を作成するには製品名製品画像検出記述子が必要です ASDiscoveryDescriptorクラスでは必要なすべての検出ルールを 1つの複合オブジェクトにまとめることができますシステムはスキャン結果とディスクリプタ内のすべてのルールを照合し対象とするアクセサリを絞り込みます ASDiscoveryDescriptorは柔軟性が高く BluetoothサービスUUIDや Wi-Fi SSIDなど多数のカスタマイズ可能なフィールドがあります詳しくはdeveloper.apple.comのドキュメントをご覧ください
サイコロを検出するには検出記述子で bluetoothServiceUUIDをサイコロによってアドバタイズされる GATTサービスUUIDとして設定する必要があります
ピンクのサイコロとブルーのサイコロでは色によってアドバタイズされるサービスUUIDが異なるため色ごとのサービスUUIDを使用してそれぞれの検出記述子を作成する必要があります
次にサイコロの2色のバリエーションの表示項目を作成するため名前画像対応する検出記述子を渡しますこれにより 2色のバリエーションが別々のアクセサリとして識別されます
ASPickerDisplayItemには他にもプロパティがありそれらを使用して設定環境をカスタマイズできます詳細はドキュメントをご覧ください最後にこのサンプルアプリにボタンを1つ追加しますこのボタンはアクティブ化されたセッションでshowPickerを呼び出しピンクとブルーのサイコロ用に作成した表示項目を渡しますこの時点でアクセサリピッカーが表示され検出と設定のプロセスが開始されますやってみましょう
デスク上のiPhoneはピンクのサイコロをシミュレートしていますサンプルアプリでボタンをタップするとアクセサリピッカーがアプリの前面に表示されますピンクのサイコロがすぐに検出され表示されますシミュレーション用の別のiPhoneでブルーのサイコロをオンにするとそれが検出されて画面の端にアニメーションの一部が表示されますピッカーに水平方向のカルーセルが作成され複数のアクセサリが整然と表示されます左右にスワイプして今回設定するサイコロを選択できますどちらの色も可愛いのですがやはりピンクは魅力的ですピンクのサイコロを設定しましょう接続中になり・・・完了ですこれでピンクのサイコロをアプリで使えるようになりましたあっという間です
アクセサリピッカーにはBluetooth ペアリング用の様々なUIが表示されますアクセサリでより安全なペアリング手法が必要な場合は数字の比較やパスキーの入力などを使用できますピンクのサイコロが設定できたら次は何でしょうか
アクセサリの使用準備ができるとアプリは accessoryAddedイベントを受け取りますこのイベントのaccessoryプロパティを読み取ることで新しく設定したサイコロを表す ASAccessoryオブジェクトを取得します他のイベントには accessoryChangedなどがありますこれは表示名などアクセサリのプロパティが変更された場合に送信されますアクセサリのプロパティはで変更できます accessoryRemovedが送信されるのはユーザーまたはアプリによってアクセサリがシステムから削除された場合です
ASAccessoryクラスは物理的なアクセサリを表しますここにはアクセサリの認可状態表示名検出記述子が含まれますまた CBPeripheralのBluetooth識別子や Wi-Fiネットワークをブロードキャストする場合のWi-Fi SSIDなどすべてのネットワークインターフェイスも含まれます accessoryAddedイベントの ASAccessoryオブジェクトにより CoreBluetoothを使用して Bluetooth周辺機器に接続できます
いつものように CBCentralManagerを作成します Info.plistでAccessorySetupKitのサポートを宣言しているため従来バージョンのiOSとは異なりユーザーはBluetoothの使用の許可を求められません
CBCentralManagerの状態が poweredOnになるのはアプリでアクセサリがペアリングされている場合だけですここではピンクのサイコロが AccessorySetupKitとペアリングされていますピンクのサイコロのBluetooth 周辺機器を取得するには bluetoothIdentifierを使用しますもちろんいつでもセントラルマネージャのスキャンAPIを使用して周辺機器をスキャンできますスキャン結果で返されるのはアプリとペアリングされているアクセサリのみです次に周辺機器と接続します接続したらその周辺機器の GATTサービスを検索して読み取りと更新通知の受け取りができるようにします
アプリからBluetoothアクセサリに初めて接続する場合は developer.apple.comにある CoreBluetoothのドキュメントをご覧くださいそれでは新しく設定したピンクのサイコロに接続してみましょう
サンプルアプリからサイコロシミュレータに接続できますシミュレータアプリを起動して動かしてみましょう
いいですねサイコロの結果はリアルタイムでサンプルアプリに同期されます AccessorySetupKitを使ってアクセサリを設定し既存のネットワークAPIを使って接続する方法を説明しましたしかしアプリが既に Bluetooth使用の認可を受けており AccessorySetupKitなしで既存のアクセサリを管理できるとしたら？そのアクセス許可モデルから AccessorySetupKitのきめ細かいモデルにアプリを移行するにはどうすればよいでしょうか
既存のアクセサリの Bluetooth周辺機器識別子またはWi-Fi SSIDを使用して ASMigrationDisplayItemのインスタンスを作成できますこれはASPickerDisplayItemのサブクラスとなります showPickerの呼び出しでこれらの移行項目を引数として渡し既存のアクセサリをアップグレードして AccessorySetupKitで管理されるようにし新しいアクセサリの設定に表示されるようにします showPickerの呼び出しに移行項目のみが含まれていた場合アプリの前面に情報ページが表示され移行についてユーザーに通知されます移行項目とともに移行対象でないその他の表示項目も渡すことにした場合新しいアクセサリが検出されて設定される場合のみ移行が行われます
このような方法で既存のアクセサリを移行して AccessorySetupKitで管理されるようにします今日のセッションのまとめに入る前にアクセサリの設定環境を向上させるうえで本当に役立つデザインに関する推奨事項をいくつか紹介します
アクセサリピッカーには 180x120ポイントの大きさのコンテナボックスがありそこに製品画像が表示されます倍率にかかわらず画面上に鮮明に表示されるように画像のピクセル解像度が十分であることを確認しましょう
アセットの表示はライトモードとダークモードの両方でテストしますどちらのモードでも適切に表示されるように画像の背景は透明にする必要があります
画像の周囲に透明な境界線を付けますシステムで画像全体のサイズをコンテナボックスに合わせる際透明な境界線の幅が広いほど画面上に表示されるアクセサリのサイズが小さくなります透明な境界線を調整しパディングとして利用することでピッカーのUIで画像が最適なサイズで表示されるようにします
ユーザーがアクセサリを設定する際アクセサリピッカーによってアプリのUIが一部見えなくなることに留意してください設定中見えない可能性のあるUIを更新しないようにします pickerDidPresentと pickerDidDismissイベントを検知してピッカーの表示と消去を追跡できます
もう1つ重要なこととして showPicker APIはいつでも呼び出すことができますが想定外のピッカーが表示されることのないようにピッカーの表示前に新しいアクセサリの追加に関する十分な背景情報をユーザーに提示することをお勧めしますまた可能であれば showPickerの呼び出しをボタンにバインドして設定画面は必ずユーザーの操作によって表示されるようにします
最後に今日のセッションの重要ポイントをいくつか振り返りましょう AccessorySetupKitはBluetoothとWi-Fi対応アクセサリを設定するための斬新な方法です 1回タップするだけで BluetoothとWi-Fiの両方でアプリからアクセサリにアクセスできますユーザーがそのアプリに初めて触れる重要なタイミングで余計な負担が生じるのを回避できます
使用するには AccessorySetupKitの項目をアプリのInfo.plistに追加します ASAccessorySessionを作成してアクティブ化されるのを待ちタスクを開始します検出するアクセサリごとに ASPickerDisplayItemを作成しますアクセサリピッカーを表示して設定のプロセスを開始しイベントに適切に対応しますアプリで既にシステムアクセスを利用して既存のアクセサリを管理している場合は ASMigrationDisplayItemを使用してアクセサリをAccessorySetupKitに移行しますアセットのデザインに注意を払いできる限り最適な形でアクセサリがピッカーに表示されるようにします
ご視聴ありがとうございました

import AccessorySetupKit

// Create a session
var session = ASAccessorySession()

// Activate session with event handler
session.activate(on: DispatchQueue.main, eventHandler: handleSessionEvent(event:))

// Handle event
func handleSessionEvent(event: ASAccessoryEvent) {  
    switch event.eventType {
    case .activated:
        print("Session is activated and ready to use")
        print(session.accessories)
    default:
        print("Received event type \(event.eventType)")
    }
}

7:23 - Create picker display items

// Create descriptor for pink dice
let pinkDescriptor = ASDiscoveryDescriptor()
pinkDescriptor.bluetoothServiceUUID = pinkUUID
// Create descriptor for blue dice
let blueDescriptor = ASDiscoveryDescriptor()
blueDescriptor.bluetoothServiceUUID = blueUUID

// Create picker display items
let pinkDisplayItem = ASPickerDisplayItem(
    name: "Pink Dice",
    productImage: UIImage(named: "pink")!,
    descriptor: pinkDescriptor
)
let blueDisplayItem = ASPickerDisplayItem(
    name: "Blue Dice",
    productImage: UIImage(named: "blue")!,
    descriptor: blueDescriptor
)

8:10 - Show picker

// Invoke accessory picker
Button {
    session.showPicker(for: [pinkDisplayItem, blueDisplayItem]) { error in
        if let error {
            // Handle error
        }
    }
} label: {
    Text("Add Dice")
}

9:26 - Handle events

// Handle event
func handleSessionEvent(event: ASAccessoryEvent) {  
    switch event.eventType {

    case .accessoryAdded:
        let newDice: ASAccessory = event.accessory!

    case .accessoryChanged:
        print("Accessory properties changed")

    case .accessoryRemoved:
        print("Accessory removed from system")

    default:
        print("Received event with type: \(event.eventType)")
    }
}

10:22 - Communicate with accessory

// Connect to accessory using CoreBluetooth
let central = CBCentralManager(delegate: self, queue: nil)

func centralManagerDidUpdateState(_ central: CBCentralManager) {
    switch central.state {
    case .poweredOn:
       // state will only be updated to poweredOn when you have paired accessories
        let peripheral = central.retrievePeripherals(withIdentifiers: [newDice.bluetoothIdentifier]).first
        central.connect(peripheral)
    default:
        print("Received event type \(event.eventType)")
    }
}

func centralManager(_ central: CBCentralManager, didConnect peripheral: CBPeripheral) {
    peripheral.delegate = self
    peripheral.discoverServices(pinkUUID)
}

11:58 - Migrate existing accessories

// Create migration items
let pinkMigration = ASMigrationDisplayItem(name: "Pink Dice", productImage: UIImage(named: "pink")!, descriptor: pinkDescriptor)
pinkMigration.peripheralIdentifier = pinkPeripheral.identifier

// Present picker with migration items
session.showPicker(for: [pinkMigration]) { error in
    if let error {
        // Handle error
    }
}

特定のトピックをお探しの場合は、上にトピックを入力すると、関連するトピックにすばやく移動できます。

クエリの送信中にエラーが発生しました。インターネット接続を確認して、もう一度お試しください。

リソース