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 se connecter directement les uns aux autres sans aucun autre type de connectivité entre eux. Wi-Fi Aware est également appelé Neighbor Awareness Networking (NAN).

La mise en réseau Wi-Fi Aware fonctionne en formant des clusters avec les appareils voisins ou en créant un cluster si l'appareil est le premier dans 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 ne contrôlent pas le comportement du clustering. 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 détectables. Ensuite, lorsqu'un appareil s'abonne à un ou plusieurs services et se trouve dans la zone Wi-Fi de l'éditeur, l'abonné reçoit une notification indiquant qu'un éditeur correspondant a été détecté. 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 éditeurs et abonnés.

  • Créer 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, comme 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() pour activer ou 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 de communication instantanée, utilisez la méthode isInstantCommunicationModeSupported().

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

Android 12 (niveau d'API 31) apporte quelques améliorations à la technologie 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 alerté lorsque votre application a perdu un service découvert en raison de l'arrêt du service ou de son déplacement hors de portée.
  • La configuration des chemins de données Wi-Fi Aware a été simplifiée. Les versions précédentes utilisaient la messagerie L2 pour fournir l'adresse MAC de l'initiateur, ce qui introduisait 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 la mise en service du datapath et permet de créer plusieurs liaisons point à point avec une seule requête réseau.
  • Les applications exécutées sur Android 12 ou version ultérieure peuvent utiliser la méthode WifiAwareManager.getAvailableAwareResources() pour obtenir le nombre de chemins de données actuellement disponibles, publier des sessions et s'abonner à des sessions. Cela peut aider l'application à déterminer si suffisamment de ressources sont 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:

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

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

    Kotlin

    context.packageManager.hasSystemFeature(PackageManager.FEATURE_WIFI_AWARE)

    Java

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

  3. 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. Selon leurs fonctionnalités matérielles et logicielles, certains appareils peuvent ne pas être compatibles avec Wi-Fi Aware si Wi-Fi Direct, SoftAP ou le partage de connexion sont utilisés. 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. 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.
  • Crée une session Wi-Fi Aware avec un espace de noms unique qui sert de conteneur à toutes les sessions de découverte créées en son sein.

Si l'application s'associe correctement, 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 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, chacune 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 détectable, 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 réussit, 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 aucune notification. Toutefois, si l'abonné envoie un message à l'éditeur, celui-ci 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 envoyer un message à l'abonné ou pour créer une connexion avec lui.

Pour arrêter la publication du service, appelez DiscoverySession.close(). Les sessions de découverte sont associées à leur WifiAwareSession parent. Si la session parente est fermée, ses 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 le moment où les sessions hors du champ d'application sont fermées. 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étecté.

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 avec cet éditeur.

Pour vous désabonner d'un service, appelez DiscoverySession.close(). Les sessions de découverte sont associées à leur WifiAwareSession parent. Si la session parente est fermée, ses 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 le moment où les sessions hors du champ d'application sont fermées. Nous vous recommandons donc d'appeler explicitement les méthodes close().

Envoyer un message

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

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

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

Bien que le PeerHandle soit nécessaire pour communiquer avec les pairs, vous ne devez pas vous y fier comme identifiant permanent des pairs. L'application peut utiliser des identifiants de niveau supérieur, intégrés au service de découverte lui-même ou dans des 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() a une incidence sur la visibilité, contrairement à la méthode setServiceSpecificInfo().

L'intégration d'un identifiant dans un message implique de modifier le tableau d'octets du message pour inclure un identifiant (par exemple, en tant que premier couple d'octets).

Créer une connexion

Wi-Fi Aware prend en charge la mise en réseau client-serveur entre deux appareils Wi-Fi Aware.

Pour configurer la connexion client-serveur:

  1. Utilisez la détection Wi-Fi Aware pour publier un service (sur le serveur) et vous abonner à un service (sur le client).

  2. Une fois que l'abonné a découvert l'éditeur, envoyez un message de l'abonné à l'éditeur.

  3. Démarrez un ServerSocket sur l'appareil de l'éditeur et 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();

  4. 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 le 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);

  5. Une fois que l'éditeur a demandé un réseau, il doit envoyer un message à l'abonné.

  6. Une fois que l'abonné a reçu le message de l'éditeur, demandez un réseau Wi-Fi Aware sur l'abonné en utilisant la même méthode que sur 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.

  7. Une fois la méthode onAvailable() 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 du 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);

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

Évaluation de la portée des pairs et découverte basée sur la position

Un appareil doté de fonctionnalités de localisation Wi-Fi RTT peut mesurer directement la distance avec les pairs et utiliser ces informations pour contraindre la détection de services Wi-Fi Aware.

L'API Wi-Fi RTT permet de mesurer la distance directe avec 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 à la découverte de services dans une zone géographique 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 à l'aide d'une combinaison des méthodes 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. Spécifier uniquement la distance minimale n'implique pas de valeur maximale.

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 RTT Wi-Fi directe peut ensuite être appelée si nécessaire pour mesurer la distance à un autre moment.