このページは Cloud Translation API によって翻訳されました。

Wi-Fi Aware の概要

Wi-Fi Aware の機能を使用すると、Android 8.0（API レベル 26）以降を搭載しているデバイス間で、他の種類の接続を使用せずにデバイスを検出でき、相互に直接接続できます。Wi-Fi Aware は、近接認識ネットワーキング（NAN）とも呼ばれています。

Wi-Fi Aware ネットワーキングは、隣接するデバイスとクラスタを形成することで、またはそのデバイスがエリア内の最初のデバイスである場合は新しいクラスタを作成することで機能します。このクラスタリング動作はデバイス全体に適用され、Wi-Fi Aware システムサービスによって管理されます。アプリはクラスタリング動作を制御できません。アプリは Wi-Fi Aware API を使用して、デバイスの Wi-Fi Aware ハードウェアを管理する Wi-Fi Aware システムサービスと通信します。

Wi-Fi Aware API を使用すると、アプリで次のオペレーションを実施できます。

他のデバイスを検出する: この API には、近くにある他のデバイスを検出するメカニズムがあります。このプロセスは、1 つのデバイスが 1 つまたは複数の検出可能なサービスを公開すると開始されます。次に、デバイスが 1 つまたは複数のサービスに登録し、パブリッシャーの Wi-Fi 範囲に入ると、一致するパブリッシャーが検出されたという通知がサブスクライバーに届きます。パブリッシャーを検出すると、サブスクライバーは短いメッセージを送信するか、または検出したデバイスとのネットワーク接続を確立できます。デバイスは、同時にパブリッシャーとサブスクライバーの両方になれます。
ネットワーク接続を作成する: 2 つのデバイスが互いを検出した後、アクセスポイントなしで双方向 Wi-Fi Aware ネットワーク接続を作成できます。

Wi-Fi Aware ネットワーク接続は、Bluetooth 接続よりも長距離間で高いスループットをサポートします。このような接続は、写真共有アプリなど、ユーザー間で大量のデータを共有するアプリで役立ちます。

Android 13（API レベル 33）の機能強化

インスタント通信モードをサポートする Android 13（API レベル 33）以降を搭載したデバイスでは、アプリは PublishConfig.Builder.setInstantCommunicationModeEnabled() メソッドと SubscribeConfig.Builder.setInstantCommunicationModeEnabled() メソッドを使用して、パブリッシャーまたはサブスクライバーの検出セッションでインスタント通信モードを有効または無効にできます。インスタント通信モードでは、メッセージ交換、サービス検出、パブリッシャーまたはサブスクライバーの検出セッションの一部として設定されたデータパスが高速化されます。デバイスがインスタント通信モードをサポートしているかどうかを判断するには、isInstantCommunicationModeSupported() メソッドを使用します。

Android 12（API レベル 31）の機能強化

Android 12（API レベル 31）では、Wi-Fi Aware で次の機能強化が行われました。

Android 12（API レベル 31）以降を搭載したデバイスでは、サービスの中断や圏外への移動が原因でアプリが検出済みのサービスを喪失したときに、onServiceLost() コールバックを使用してアラートを受け取ることができます。
Wi-Fi Aware データパスの設定が簡素化されました。以前のバージョンでは L2 メッセージを使用してイニシエータの MAC アドレスを提供していたため、レイテンシが発生していました。Android 12 以降を搭載したデバイスでは、応答側（サーバー）がピアを承認するように構成できます。つまり、イニシエータの MAC アドレスを事前に認識する必要がありません。これにより、データパスの確立が高速化され、1 つのネットワークリクエストのみで複数のポイントツーポイントリンクが有効になります。
Android 12 以降を搭載したデバイスで実行されているアプリは、WifiAwareManager.getAvailableAwareResources() メソッドを使用して、現在使用可能なデータパスの数、パブリッシュセッションの数、サブスクライブセッションの数を取得できます。これにより、目的の機能を実行するのに十分なリソースがあるかどうかをアプリが判断できます。

初期設定

Wi-Fi Aware の検出とネットワークを使用するようにアプリを設定する手順は次のとおりです。

アプリのマニフェストで次の権限をリクエストします。

<uses-permission android:name="android.permission.ACCESS_WIFI_STATE" />
<uses-permission android:name="android.permission.CHANGE_WIFI_STATE" />
<uses-permission android:name="android.permission.CHANGE_NETWORK_STATE" />
<uses-permission android:name="android.permission.INTERNET" />
<!-- If your app targets Android 13 (API level 33)
     or higher, you must declare the NEARBY_WIFI_DEVICES permission. -->
<uses-permission android:name="android.permission.NEARBY_WIFI_DEVICES"
                 <!-- If your app derives location information from
                      Wi-Fi APIs, don't include the "usesPermissionFlags"
                      attribute. -->
                 android:usesPermissionFlags="neverForLocation" />
<uses-permission android:name="android.permission.ACCESS_FINE_LOCATION"
                 <!-- If any feature in your app relies on precise location
                      information, don't include the "maxSdkVersion"
                      attribute. -->
                 android:maxSdkVersion="32" />

次に示すように、デバイスが PackageManager API で Wi-Fi Aware をサポートしているかどうかを確認します。

Kotlin

context.packageManager.hasSystemFeature(PackageManager.FEATURE_WIFI_AWARE)

Java

context.getPackageManager().hasSystemFeature(PackageManager.FEATURE_WIFI_AWARE);

Wi-Fi Aware が現在利用できるかどうかを確認します。デバイスに Wi-Fi Aware があっても、ユーザーが Wi-Fi または位置情報を無効にしているために、現在利用できない場合があります。ハードウェアとファームウェアの機能によっては、Wi-Fi Direct、SoftAP、またはテザリングが使用されている場合、一部のデバイスで Wi-Fi Aware をサポートしないことがあります。Wi-Fi Aware が現在利用できるかどうかを確認するには、isAvailable() を呼び出します。

Wi-Fi Aware を利用できるかどうかは、いつでも変更される可能性があります。アプリで BroadcastReceiver を登録して ACTION_WIFI_AWARE_STATE_CHANGED を受信する必要があります。これは、利用できるかどうかが変更されるたびに送信されます。アプリがブロードキャストインテントを受け取ると、既存のセッションをすべて破棄します（Wi-Fi Aware サービスが中断したと仮定）。その後、現在利用できるかどうかを確認し、それに応じて動作を調整します。例:
Kotlin
```
val wifiAwareManager = context.getSystemService(Context.WIFI_AWARE_SERVICE) as WifiAwareManager?
val filter = IntentFilter(WifiAwareManager.ACTION_WIFI_AWARE_STATE_CHANGED)
val myReceiver = object : BroadcastReceiver() {

    override fun onReceive(context: Context, intent: Intent) {
        // discard current sessions
        if (wifiAwareManager?.isAvailable) {
            ...
        } else {
            ...
        }
    }
}
context.registerReceiver(myReceiver, filter)
```
Java
```
WifiAwareManager wifiAwareManager = 
        (WifiAwareManager)context.getSystemService(Context.WIFI_AWARE_SERVICE)
IntentFilter filter =
        new IntentFilter(WifiAwareManager.ACTION_WIFI_AWARE_STATE_CHANGED);
BroadcastReceiver myReceiver = new BroadcastReceiver() {
    @Override
    public void onReceive(Context context, Intent intent) {
        // discard current sessions
        if (wifiAwareManager.isAvailable()) {
            ...
        } else {
            ...
        }
    }
};
context.registerReceiver(myReceiver, filter);
```

詳細については、ブロードキャストをご覧ください。

セッションを取得する

Wi-Fi Aware の使用を開始するには、アプリで attach() を呼び出して WifiAwareSession を取得する必要があります。このメソッドは次の処理を行います。

Wi-Fi Aware ハードウェアをオンにする。
Wi-Fi Aware クラスタに参加、または Wi-Fi Aware クラスタを形成する。
一意の名前空間を持つ Wi-Fi Aware セッションを作成する。これは、その中で作成されるすべての検出セッションのコンテナとして機能します。

アプリが正常にアタッチすると、システムは onAttached() コールバックを実行します。このコールバックは、今後すべてのセッションオペレーションでアプリが使用する必要のある WifiAwareSession オブジェクトを提供します。アプリは、セッションを使用してサービスを公開するか、サービスに登録します。

アプリは attach() を 1 回だけ呼び出す必要があります。アプリが attach() を複数回呼び出すと、アプリは呼び出しごとに異なるセッションを受け取り、それぞれが独自の名前空間を持つことになります。これは複雑なシナリオでは役立つ可能性がありますが、通常は避けてください。

サービスを公開する

サービスを検出可能にするには、次のパラメータを取る publish() メソッドを呼び出します。

PublishConfig は、サービスの名前と、マッチフィルタなどその他の設定プロパティを指定します。
DiscoverySessionCallback は、サブスクライバーがメッセージを受信したときなど、イベントが発生したときに実行するアクションを指定します。

次の例をご覧ください。

Kotlin

val config: PublishConfig = PublishConfig.Builder()
        .setServiceName(AWARE_FILE_SHARE_SERVICE_NAME)
        .build()
awareSession.publish(config, object : DiscoverySessionCallback() {

    override fun onPublishStarted(session: PublishDiscoverySession) {
        ...
    }

    override fun onMessageReceived(peerHandle: PeerHandle, message: ByteArray) {
        ...
    }
})

Java

PublishConfig config = new PublishConfig.Builder()
    .setServiceName(“Aware_File_Share_Service_Name”)
    .build();

awareSession.publish(config, new DiscoverySessionCallback() {
    @Override
    public void onPublishStarted(PublishDiscoverySession session) {
        ...
    }
    @Override
    public void onMessageReceived(PeerHandle peerHandle, byte[] message) {
        ...
    }
}, null);

公開に成功すると、onPublishStarted() コールバックメソッドが呼び出されます。

公開後、一致するサブスクライバーアプリを実行しているデバイスが、公開中のデバイスの Wi-Fi 範囲内に移動すると、サブスクライバーはサービスを検出します。サブスクライバーがパブリッシャーを検出したとき、パブリッシャーは通知を受信しません。ただし、サブスクライバーがパブリッシャーにメッセージを送信すると、パブリッシャーは通知を受信します。この場合、onMessageReceived() コールバックメソッドが呼び出されます。このメソッドの PeerHandle 引数を使用して、サブスクライバーにメッセージを返信したり、サブスクライバーへの接続を作成したりできます。

サービスの公開を停止するには、DiscoverySession.close() を呼び出します。検出セッションは、その親の WifiAwareSession に関連付けられています。親セッションが閉じられると、関連付けられている検出セッションも閉じられます。破棄されたオブジェクトも閉じられますが、システムはスコープ外のセッションが閉じられるタイミングを保証しないため、close() メソッドを明示的に呼び出すことをおすすめします。

サービスに登録する

サービスに登録するには、次のパラメータを取る subscribe() メソッドを呼び出します。

SubscribeConfig は、登録するサービスの名前と、マッチフィルタなどその他の設定プロパティを指定します。
DiscoverySessionCallback は、パブリッシャーが検出されたときなど、イベントが発生したときに実行するアクションを指定します。

次の例をご覧ください。

Kotlin

val config: SubscribeConfig = SubscribeConfig.Builder()
        .setServiceName(AWARE_FILE_SHARE_SERVICE_NAME)
        .build()
awareSession.subscribe(config, object : DiscoverySessionCallback() {

    override fun onSubscribeStarted(session: SubscribeDiscoverySession) {
        ...
    }

    override fun onServiceDiscovered(
            peerHandle: PeerHandle,
            serviceSpecificInfo: ByteArray,
            matchFilter: List<ByteArray>
    ) {
        ...
    }
}, null)

Java

SubscribeConfig config = new SubscribeConfig.Builder()
    .setServiceName("Aware_File_Share_Service_Name")
    .build();

awareSession.subscribe(config, new DiscoverySessionCallback() {
    @Override
    public void onSubscribeStarted(SubscribeDiscoverySession session) {
        ...
    }

    @Override
    public void onServiceDiscovered(PeerHandle peerHandle,
            byte[] serviceSpecificInfo, List<byte[]> matchFilter) {
        ...
    }
}, null);

登録オペレーションが成功すると、システムはアプリで onSubscribeStarted() コールバックを呼び出します。アプリがパブリッシャーを検出した後に、コールバックで SubscribeDiscoverySession 引数を使用してパブリッシャーと通信できるため、この参照を保存する必要があります。登録セッションは、検出セッションで updateSubscribe() を呼び出すことで、いつでも更新できます。

このとき、登録は一致するパブリッシャーが Wi-Fi 範囲内に入るのを待ちます。この場合、システムは onServiceDiscovered() コールバックメソッドを実行します。このコールバックの PeerHandle 引数を使用して、メッセージを送信したり、パブリッシャーに対する接続を作成したりできます。

サービスへの登録を停止するには、DiscoverySession.close() を呼び出します。検出セッションは、その親の WifiAwareSession に関連付けられています。親セッションが閉じられると、関連付けられている検出セッションも閉じられます。破棄されたオブジェクトも閉じられますが、システムはスコープ外のセッションが閉じられるタイミングを保証しないため、close() メソッドを明示的に呼び出すことをおすすめします。

メッセージを送信する

別のデバイスにメッセージを送信するには、次のオブジェクトが必要です。

DiscoverySession。このオブジェクトを使用すると、sendMessage() を呼び出せます。アプリは、サービスを公開するか、サービスに登録することで、DiscoverySession を取得します。
メッセージをルーティングする、別のデバイスの PeerHandle。アプリは、次の 2 つのうちいずれかの方法で別のデバイスの PeerHandle を取得します。
- アプリがサービスを公開し、サブスクライバーからメッセージを受信します。アプリが onMessageReceived() コールバックからサブスクライバーの PeerHandle を取得します。
- アプリがサービスに登録します。その後、一致するパブリッシャーを検出すると、アプリは onServiceDiscovered() コールバックからパブリッシャーの PeerHandle を取得します。

メッセージを送信するには、sendMessage() を呼び出します。その場合は次のコールバックが発生する可能性があります。

メッセージがピアによって正常に受信されると、システムは、送信アプリで onMessageSendSucceeded() コールバックを呼び出します。
ピアがメッセージを受信すると、システムは、受信アプリで onMessageReceived() コールバックを呼び出します。

PeerHandle はピアと通信するために必要ですが、ピアの永続的な識別子としては使用しないでください。より上位の識別子がアプリケーションで使用され、検出サービス自体または後続のメッセージに埋め込まれます。PublishConfig または SubscribeConfig の setMatchFilter() メソッドまたは setServiceSpecificInfo() メソッドを使用して、識別子を検出サービスに埋め込むことができます。setMatchFilter() メソッドは検出に影響しますが、setServiceSpecificInfo() メソッドは検出に影響しません。

識別子をメッセージに埋め込むことは、識別子を含むようにメッセージのバイト配列を変更することを意味します（たとえば最初の数バイトとして）。

接続を作成する

Wi-Fi Aware は、2 つの Wi-Fi Aware デバイス間のクライアントサーバーネットワークをサポートします。

クライアントサーバー接続の設定手順は次のとおりです。

Wi-Fi Aware 検出を使用して、サービスを公開し（サーバー）、サービスに登録します（クライアント）。
サブスクライバーがパブリッシャーを検出したら、サブスクライバーからパブリッシャーにメッセージを送信します。
パブリッシャーデバイスで ServerSocket を起動し、ポートの設定または取得を行います。
Kotlin
```
val ss = ServerSocket(0)
val port = ss.localPort
```
Java
```
ServerSocket ss = new ServerSocket(0);
int port = ss.getLocalPort();
```

ConnectivityManager を使用してパブリッシャーに Wi-Fi Aware ネットワークをリクエストします。WifiAwareNetworkSpecifier を使用し、また検出セッションと、サブスクライバーによって送信されたメッセージから取得したサブスクライバーの PeerHandle を指定します。

Kotlin

val networkSpecifier = WifiAwareNetworkSpecifier.Builder(discoverySession, peerHandle)
    .setPskPassphrase("somePassword")
    .setPort(port)
    .build()
val myNetworkRequest = NetworkRequest.Builder()
    .addTransportType(NetworkCapabilities.TRANSPORT_WIFI_AWARE)
    .setNetworkSpecifier(networkSpecifier)
    .build()
val callback = object : ConnectivityManager.NetworkCallback() {
    override fun onAvailable(network: Network) {
        ...
    }

    override fun onCapabilitiesChanged(network: Network, networkCapabilities: NetworkCapabilities) {
        ...
    }

    override fun onLost(network: Network) {
        ...
    }
}

connMgr.requestNetwork(myNetworkRequest, callback);

Java

NetworkSpecifier networkSpecifier = new WifiAwareNetworkSpecifier.Builder(discoverySession, peerHandle)
    .setPskPassphrase("somePassword")
    .setPort(port)
    .build();
NetworkRequest myNetworkRequest = new NetworkRequest.Builder()
    .addTransportType(NetworkCapabilities.TRANSPORT_WIFI_AWARE)
    .setNetworkSpecifier(networkSpecifier)
    .build();
ConnectivityManager.NetworkCallback callback = new ConnectivityManager.NetworkCallback() {
    @Override
    public void onAvailable(Network network) {
        ...
    }

    @Override
    public void onCapabilitiesChanged(Network network, NetworkCapabilities networkCapabilities) {
        ...
    }

    @Override
    public void onLost(Network network) {
        ...
    }
};

ConnectivityManager connMgr.requestNetwork(myNetworkRequest, callback);

パブリッシャーがネットワークをリクエストしたら、サブスクライバーにメッセージを送信する必要があります。
サブスクライバーがパブリッシャーからメッセージを受信したら、パブリッシャーと同じ方法でサブスクライバーに Wi-Fi Aware ネットワークをリクエストします。NetworkSpecifier の作成時にポートを指定しないでください。ネットワーク接続が利用可能なとき、変更されたとき、または失われたときに、該当するコールバックメソッドが呼び出されます。

サブスクライバーで onAvailable() メソッドが呼び出されると、パブリッシャーの ServerSocket と通信するために Socket を開くことができる Network オブジェクトが利用可能になります。ただし、ServerSocket の IPv6 アドレスとポートが既知である必要があります。これらは onCapabilitiesChanged() コールバックで提供される NetworkCapabilities オブジェクトから取得します。

Kotlin

val peerAwareInfo = networkCapabilities.transportInfo as WifiAwareNetworkInfo
val peerIpv6 = peerAwareInfo.peerIpv6Addr
val peerPort = peerAwareInfo.port
...
val socket = network.getSocketFactory().createSocket(peerIpv6, peerPort)

Java

WifiAwareNetworkInfo peerAwareInfo = (WifiAwareNetworkInfo) networkCapabilities.getTransportInfo();
Inet6Address peerIpv6 = peerAwareInfo.getPeerIpv6Addr();
int peerPort = peerAwareInfo.getPort();
...
Socket socket = network.getSocketFactory().createSocket(peerIpv6, peerPort);

ネットワーク接続が完了したら、unregisterNetworkCallback() を呼び出します。

注: ネットワークリクエストの作成と必要なネットワーク機能の指定は、Wi-Fi Aware API に固有のものではありません。ネットワークリクエストを行う方法の詳細については、ConnectivityManager をご覧ください。

ピアの距離測定と位置情報に基づく検出

Wi-Fi RTT 位置情報の機能を備えたデバイスでは、ピアとの距離を直接測定し、この情報を使用して Wi-Fi Aware サービスの検出を制限できます。

Wi-Fi RTT API を使用すると、MAC アドレスまたは PeerHandle を使用して、Wi-Fi Aware ピアの距離を直接測定できます。

Wi-Fi Aware 検出は、特定のジオフェンス内のサービスのみを検出するように制限できます。たとえば、3 メートル（3,000 mm として指定）より近くなく、10 m（10,000 mm として指定）より遠くない、"Aware_File_Share_Service_Name" サービスを公開しているデバイスを検出できるようにジオフェンスを設定できます。

ジオフェンスを有効にするには、パブリッシャーとサブスクライバーの両方で対応する必要があります。

パブリッシャーは、setRangingEnabled(true) を使用して、公開されたサービスで距離測定を有効にする必要があります。

パブリッシャーで距離測定を有効にしないと、サブスクライバーによって指定されたジオフェンス制約が無視され、距離を無視して通常の検出が行われます。
サブスクライバーは、setMinDistanceMm と setMaxDistanceMm を組み合わせてジオフェンスを指定する必要があります。

どちらの値でも、距離が指定されていない場合は制限がないことを意味します。最大距離のみを指定すると、最小距離は 0 になります。最小距離のみを指定すると、最大距離は指定されません。

ジオフェンス内でピアサービスが検出されると、ピアとの距離を測定する onServiceDiscoveredWithinRange コールバックがトリガーされます。これにより、必要に応じてダイレクト Wi-Fi RTT API を呼び出し、後で距離を測定できます。