Cette page a été traduite par l'API Cloud Translation.

Présentation de Wi-Fi Aware

Les fonctionnalités Wi-Fi Aware permettent aux appareils équipés d'Android 8.0 (niveau d'API 26) ou version ultérieure de se détecter et de s'y connecter directement, sans aucun autre type de connectivité. Wi-Fi Aware est également connu sous le nom de Neighbor Awareness Networking (NAN).

La mise en réseau Wi-Fi Aware consiste à former des clusters avec des appareils voisins ou à créer un cluster si l'appareil est le premier d'une zone. Ce comportement de clustering s'applique à l'ensemble de l'appareil et est géré par le service système Wi-Fi Aware. Les applications n'ont aucun contrôle sur ce comportement. Les applications utilisent les API Wi-Fi Aware pour communiquer avec le service système Wi-Fi Aware, qui gère le matériel Wi-Fi Aware sur l'appareil.

Les API Wi-Fi Aware permettent aux applications d'effectuer les opérations suivantes:

Découvrir d'autres appareils:l'API dispose d'un mécanisme permettant de trouver d'autres appareils à proximité. Le processus commence lorsqu'un appareil publie un ou plusieurs services visibles. Ensuite, lorsqu'un appareil s'abonne à un ou plusieurs services et entre dans la plage Wi-Fi de l'éditeur, l'abonné reçoit une notification indiquant qu'un éditeur correspondant a été découvert. Une fois que l'abonné a découvert un éditeur, il peut envoyer un court message ou établir une connexion réseau avec l'appareil détecté. Les appareils peuvent être à la fois des éditeurs et des abonnés.
Créez une connexion réseau:une fois que deux appareils se sont découverts, ils peuvent créer une connexion réseau Wi-Fi Aware bidirectionnelle sans point d'accès.

Les connexions réseau Wi-Fi Aware offrent des débits plus élevés sur de longues distances que les connexions Bluetooth. Ces types de connexions sont utiles pour les applications qui partagent de grandes quantités de données entre les utilisateurs, telles que les applications de partage de photos.

Améliorations apportées à Android 13 (niveau d'API 33)

Sur les appareils équipés d'Android 13 (niveau d'API 33) ou version ultérieure compatibles avec le mode de communication instantanée, les applications peuvent utiliser les méthodes PublishConfig.Builder.setInstantCommunicationModeEnabled() et SubscribeConfig.Builder.setInstantCommunicationModeEnabled() afin d'activer ou de désactiver le mode de communication instantanée pour une session de découverte d'éditeur ou d'abonné. Le mode de communication instantanée accélère l'échange de messages, la détection de services et tout chemin de données configuré dans le cadre d'une session de découverte d'éditeur ou d'abonné. Pour déterminer si un appareil est compatible avec le mode Communication instantanée, utilisez la méthode isInstantCommunicationModeSupported().

Améliorations apportées à Android 12 (niveau d'API 31)

Android 12 (niveau d'API 31) ajoute quelques améliorations à Wi-Fi Aware:

Sur les appareils équipés d'Android 12 (niveau d'API 31) ou version ultérieure, vous pouvez utiliser le rappel onServiceLost() pour être averti lorsque votre application a perdu un service détecté, car le service s'arrête ou se trouve hors de portée.
La configuration des chemins de données Wi-Fi Aware a été simplifiée. Les versions antérieures utilisaient la messagerie L2 pour fournir l'adresse MAC de l'initiateur, ce qui entraînait une latence. Sur les appareils équipés d'Android 12 ou version ultérieure, le répondeur (serveur) peut être configuré pour accepter n'importe quel pair, c'est-à-dire qu'il n'a pas besoin de connaître l'adresse MAC de l'initiateur à l'avance. Cela accélère le lancement de chemins de données et active plusieurs liaisons point à point avec une seule requête réseau.
Les applications exécutées sous Android 12 ou version ultérieure peuvent utiliser la méthode WifiAwareManager.getAvailableAwareResources() pour obtenir le nombre de chemins de données actuellement disponibles, ainsi que pour publier des sessions et s'abonner à des sessions. Cela peut aider l'application à déterminer s'il y a suffisamment de ressources disponibles pour exécuter la fonctionnalité souhaitée.

Configuration initiale

Pour configurer votre application afin d'utiliser la détection et la mise en réseau Wi-Fi Aware, procédez comme suit:

Demandez les autorisations suivantes dans le fichier manifeste de votre application:

<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" />

Vérifiez si l'appareil est compatible avec Wi-Fi Aware à l'aide de l'API PackageManager, comme indiqué ci-dessous:

Kotlin

context.packageManager.hasSystemFeature(PackageManager.FEATURE_WIFI_AWARE)

Java

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

Vérifiez si Wi-Fi Aware est actuellement disponible. Wi-Fi Aware peut exister sur l'appareil, mais il est possible qu'il ne soit pas disponible actuellement, car l'utilisateur a désactivé le Wi-Fi ou la localisation. En fonction de leurs fonctionnalités matérielles et de leur micrologiciel, certains appareils peuvent ne pas être compatibles avec Wi-Fi Aware si le Wi-Fi Direct, SoftAP ou le partage de connexion est utilisé. Pour vérifier si Wi-Fi Aware est actuellement disponible, appelez isAvailable().

La disponibilité de Wi-Fi Aware peut changer à tout moment. Votre application doit enregistrer un BroadcastReceiver pour recevoir ACTION_WIFI_AWARE_STATE_CHANGED, qui est envoyé chaque fois que la disponibilité change. Lorsque votre application reçoit l'intent de diffusion, elle doit supprimer toutes les sessions existantes (en partant du principe que le service Wi-Fi Aware a été interrompu), puis vérifier l'état actuel de disponibilité et ajuster son comportement en conséquence. Par exemple :
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);
```

Pour en savoir plus, consultez la section Diffusions.

Obtenir une session

Pour commencer à utiliser Wi-Fi Aware, votre application doit obtenir un WifiAwareSession en appelant attach(). Cette méthode permet d'effectuer les opérations suivantes:

Active le matériel Wi-Fi Aware.
Joint ou forme un cluster Wi-Fi Aware.
Il crée une session Wi-Fi Aware avec un espace de noms unique qui fait office de conteneur pour toutes les sessions de découverte qui y sont créées.

Si l'application est correctement associée, le système exécute le rappel onAttached(). Ce rappel fournit un objet WifiAwareSession que votre application doit utiliser pour toutes les opérations de session supplémentaires. Une application peut utiliser la session pour publier un service ou pour s'abonner à un service.

Votre application ne doit appeler attach() qu'une seule fois. Si votre application appelle attach() plusieurs fois, elle reçoit une session différente pour chaque appel, chacun avec son propre espace de noms. Cela peut être utile dans des scénarios complexes, mais doit généralement être évité.

Publier un service

Pour rendre un service visible, appelez la méthode publish(), qui utilise les paramètres suivants:

PublishConfig spécifie le nom du service et d'autres propriétés de configuration, telles que le filtre de correspondance.
DiscoverySessionCallback spécifie les actions à exécuter lorsque des événements se produisent, par exemple lorsque l'abonné reçoit un message.

Exemple :

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);

Si la publication aboutit, la méthode de rappel onPublishStarted() est appelée.

Après la publication, lorsque les appareils exécutant les applications d'abonnés correspondantes se déplacent vers la plage Wi-Fi de l'appareil publié, les abonnés découvrent le service. Lorsqu'un abonné découvre un éditeur, celui-ci ne reçoit pas de notification. Toutefois, s'il envoie un message à l'éditeur, l'éditeur reçoit une notification. Dans ce cas, la méthode de rappel onMessageReceived() est appelée. Vous pouvez utiliser l'argument PeerHandle de cette méthode pour renvoyer un message à l'abonné ou pour créer une connexion avec celui-ci.

Pour arrêter de publier le service, appelez DiscoverySession.close(). Les sessions de découverte sont associées à leur WifiAwareSession parent. Si la session parente est fermée, les sessions de découverte associées le sont également. Bien que les objets supprimés soient également fermés, le système ne garantit pas la fermeture des sessions hors du champ d'application. Nous vous recommandons donc d'appeler explicitement les méthodes close().

S'abonner à un service

Pour vous abonner à un service, appelez la méthode subscribe(), qui utilise les paramètres suivants:

SubscribeConfig spécifie le nom du service auquel s'abonner, ainsi que d'autres propriétés de configuration, telles que le filtre de correspondance.
DiscoverySessionCallback spécifie les actions à exécuter lorsque des événements se produisent, par exemple lorsqu'un éditeur est découvert.

Exemple :

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);

Si l'opération d'abonnement aboutit, le système appelle le rappel onSubscribeStarted() dans votre application. Étant donné que vous pouvez utiliser l'argument SubscribeDiscoverySession dans le rappel pour communiquer avec un éditeur une fois que votre application en a identifié un, vous devez enregistrer cette référence. Vous pouvez mettre à jour la session d'abonnement à tout moment en appelant updateSubscribe() sur la session de découverte.

À ce stade, votre abonnement attend que les éditeurs correspondants se trouvent à portée d'un réseau Wi-Fi. Dans ce cas, le système exécute la méthode de rappel onServiceDiscovered(). Vous pouvez utiliser l'argument PeerHandle de ce rappel pour envoyer un message ou créer une connexion à cet éditeur.

Pour arrêter de vous abonner à un service, appelez DiscoverySession.close(). Les sessions de découverte sont associées à leur WifiAwareSession parent. Si la session parente est fermée, les sessions de découverte associées le sont également. Bien que les objets supprimés soient également fermés, le système ne garantit pas la fermeture des sessions hors du champ d'application. Nous vous recommandons donc d'appeler explicitement les méthodes close().

Envoie un message

Pour envoyer un message à un autre appareil, vous avez besoin des objets suivants:

Une DiscoverySession. Cet objet vous permet d'appeler sendMessage(). Votre application obtient une DiscoverySession en publiant un service ou en s'abonnant à un service.
Le paramètre PeerHandle de l'autre appareil, pour acheminer le message Votre application obtient le PeerHandle d'un autre appareil de l'une des deux manières suivantes:
- Votre application publie un service et reçoit un message d'un abonné. Votre application obtient le PeerHandle de l'abonné à partir du rappel onMessageReceived().
- Votre application s'abonne à un service. Ensuite, lorsqu'elle trouve un éditeur correspondant, votre application obtient l'PeerHandle de l'éditeur à partir du rappel onServiceDiscovered().

Pour envoyer un message, appelez sendMessage(). Les rappels suivants peuvent ensuite se produire:

Une fois le message reçu par le pair, le système appelle le rappel onMessageSendSucceeded() dans l'application d'envoi.
Lorsque le pair reçoit un message, le système appelle le rappel onMessageReceived() dans l'application réceptrice.

Bien que le PeerHandle soit requis pour communiquer avec les pairs, vous ne devez pas vous en servir comme identifiant permanent des pairs. Les identifiants de niveau supérieur peuvent être utilisés par l'application, qui sont intégrés dans le service de découverte lui-même ou dans les messages ultérieurs. Vous pouvez intégrer un identifiant au service de découverte avec la méthode setMatchFilter() ou setServiceSpecificInfo() de PublishConfig ou SubscribeConfig. La méthode setMatchFilter() affecte la découverte, tandis que la méthode setServiceSpecificInfo() n'affecte pas la découverte.

L'intégration d'un identifiant dans un message implique la modification du tableau d'octets du message pour inclure un identifiant (par exemple, pour les deux premiers octets).

Créer une connexion

Wi-Fi Aware est compatible avec la mise en réseau client-serveur entre deux appareils Wi-Fi Aware.

Pour configurer la connexion client-serveur:

Utilisez la détection Wi-Fi Aware pour publier un service (sur le serveur) et vous abonner à un service (sur le client).
Une fois que l'abonné a découvert l'éditeur, envoyez un message de l'abonné à l'éditeur.

Démarrez un ServerSocket sur l'appareil de l'éditeur, puis définissez ou obtenez son port:

Kotlin

val ss = ServerSocket(0)
val port = ss.localPort

Java

ServerSocket ss = new ServerSocket(0);
int port = ss.getLocalPort();

Utilisez ConnectivityManager pour demander un réseau Wi-Fi Aware sur l'éditeur à l'aide d'un WifiAwareNetworkSpecifier, en spécifiant la session de découverte et l'PeerHandle de l'abonné, que vous avez obtenus à partir du message transmis par l'abonné:

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);

Une fois que l'éditeur demande un réseau, il doit envoyer un message à l'abonné.
Une fois que l'abonné a reçu le message de l'éditeur, demandez un réseau Wi-Fi Aware sur lui en utilisant la même méthode que sur le site de l'éditeur. Ne spécifiez pas de port lorsque vous créez le NetworkSpecifier. Les méthodes de rappel appropriées sont appelées lorsque la connexion réseau est disponible, modifiée ou perdue.

Une fois que la méthode onAvailable() est appelée sur l'abonné, un objet Network est disponible, avec lequel vous pouvez ouvrir un Socket pour communiquer avec le ServerSocket sur l'éditeur, mais vous devez connaître l'adresse IPv6 et le port de ServerSocket. Vous les obtenez à partir de l'objet NetworkCapabilities fourni dans le rappel onCapabilitiesChanged():

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);

Lorsque vous avez terminé de configurer la connexion réseau, appelez unregisterNetworkCallback().

Remarque :La création d'une requête réseau et la spécification des fonctionnalités réseau requises ne sont pas spécifiques à l'API Wi-Fi Aware. Pour en savoir plus sur l'utilisation des requêtes réseau, consultez ConnectivityManager.

Comparaison des applications similaires et détection de la position

Un appareil doté de la localisation DAR via le Wi-Fi peut mesurer directement la distance par rapport aux pairs et utiliser ces informations pour limiter la détection de services Wi-Fi Aware.

L'API Wi-Fi RTT permet d'étendre la portée directe à un pair Wi-Fi Aware à l'aide de son adresse MAC ou de son PeerHandle.

La détection Wi-Fi Aware peut être limitée de manière à ne découvrir que les services situés dans une zone de géorepérage spécifique. Par exemple, vous pouvez configurer une zone de géorepérage permettant la découverte d'un appareil publiant un service "Aware_File_Share_Service_Name" situé entre 3 mètres (3 000 mm) et 10 mètres (10 000 mm) au maximum.

Pour activer le géorepérage, l'éditeur et l'abonné doivent tous deux prendre les mesures suivantes:

L'éditeur doit activer les plages sur le service publié à l'aide de setRangingEnabled(true).

Si l'éditeur n'active pas la mesure des distances, toutes les contraintes de géorepérage spécifiées par l'abonné sont ignorées et une découverte normale est effectuée, en ignorant la distance.
L'abonné doit spécifier une zone de géorepérage en utilisant une combinaison de setMinDistanceMm et setMaxDistanceMm.

Pour l'une ou l'autre des valeurs, une distance non spécifiée n'implique aucune limite. Seule la distance maximale implique une distance minimale de 0. Seule la distance minimale n'implique pas de maximum.

Lorsqu'un service pair est découvert dans une zone de géorepérage, le rappel onServiceDiscoveredWithinRange est déclenché, et indique la distance mesurée par rapport au pair. L'API de DAR Wi-Fi direct peut ensuite être appelée si nécessaire pour mesurer des distances à des moments ultérieurs.