Wi-Fi Aware 機能により、Android 8.0(API レベル 26)以降を搭載したデバイスは、他のタイプの接続を介さずに、相互に直接検出して接続できます。Wi-Fi Aware は、Neighbor Awareness Networking(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" />デバイスが Wi-Fi Aware に対応しているかどうかを
PackageManagerAPI で確認します。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 デバイス間のクライアント サーバー ネットワークをサポートします。
クライアント サーバー接続の設定手順は次のとおりです。
サブスクライバーがパブリッシャーを検出したら、サブスクライバーからパブリッシャーにメッセージを送信します。
パブリッシャー デバイスで
ServerSocketを起動し、そのポートを設定または取得します。Kotlin
val ss = ServerSocket(0) val port = ss.localPortJava
ServerSocket ss = new ServerSocket(0); int port = ss.getLocalPort();ConnectivityManagerを使用して、WifiAwareNetworkSpecifierを使用してパブリッシャーに Wi-Fi Aware ネットワークをリクエストします。このとき、ディスカバリ セッションと、サブスクライバーから送信されたメッセージから取得したサブスクライバーの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) { ... } }; connMgr.requestNetwork(myNetworkRequest, callback);パブリッシャーがネットワークをリクエストしたら、サブスクライバーにメッセージを送信します。
サブスクライバーがパブリッシャーからメッセージを受信したら、パブリッシャーと同じ方法を使用して、サブスクライバーで Wi-Fi Aware ネットワークをリクエストします。
NetworkSpecifierの作成時にポートを指定しないでください。ネットワーク接続が利用可能、変更、または失われたときに、適切なコールバック メソッドが呼び出されます。サブスクライバーで
onAvailable()メソッドが呼び出されると、Networkオブジェクトが使用可能になり、Socketを開いてパブリッシャーのServerSocketと通信できます。ただし、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 RTT 位置情報機能を備えたデバイスは、ピアとの距離を直接測定し、この情報を使用して Wi-Fi Aware サービス ディスカバリを制限できます。
Wi-Fi RTT API を使用すると、MAC アドレスまたは PeerHandle を使用して、Wi-Fi Aware ピアとの直接的な距離測定を行うことができます。
Wi-Fi Aware ディスカバリは、特定のジオフェンス内のサービスのみを検出するように制限できます。たとえば、Aware_File_Share_Service_Name サービスを公開しているデバイスを検出できるジオフェンスを設定できます。このデバイスは、3 メートル(3,000 mm として指定)以上、10 メートル(10,000 mm として指定)以下にあります。
ジオフェンスを有効にするには、パブリッシャーとサブスクライバーの両方で対応する必要があります。
パブリッシャーは、
setRangingEnabled(true)を使用して、公開サービスでレンジングを有効にする必要があります。パブリッシャーがレンジングを有効にしていない場合、サブスクライバーが指定したジオフェンス制約は無視され、距離を無視して通常の検出が行われます。
サブスクライバーは、
setMinDistanceMm()とsetMaxDistanceMm()の組み合わせを使用してジオフェンスを指定する必要があります。どちらの値でも、距離が指定されていない場合は制限がないことを意味します。最大距離のみを指定すると、最小距離は 0 になります。最小距離のみを指定すると、最大距離は指定されません。
ジオフェンス内でピアサービスが検出されると、onServiceDiscoveredWithinRange コールバックがトリガーされ、ピアまでの測定距離が提供されます。その後、必要に応じて直接 Wi-Fi RTT API を呼び出して、後で距離を測定できます。