Contrôler les appareils externes

Sous Android 11 et les versions ultérieures, la fonctionnalité d'accès rapide aux commandes de contrôle des appareils permet aux utilisateurs d'afficher et de contrôler rapidement les appareils externes tels que les lumières, les thermostats et les caméras en trois interactions à partir d'un lanceur d'applications par défaut. Le fabricant de l'appareil choisit le lanceur d'applications à utiliser. Les agrégateurs d'appareils (Google Home, par exemple) et les applications de fournisseurs tiers peuvent fournir des appareils à afficher dans cet espace. Cette page vous explique comment afficher les commandes de l'appareil dans cet espace et les associer à votre application de contrôle.

Figure 1. Espace de contrôle des appareils dans l'UI Android.

Pour ajouter cette prise en charge, créez et déclarez un ControlsProviderService. Créez les commandes compatibles avec votre application en fonction de types de commandes prédéfinis, puis créez des éditeurs pour ces commandes.

Interface utilisateur

Les appareils s'affichent sous Commandes de contrôle des appareils sous forme de widgets basés sur des modèles. Cinq widgets de contrôle des appareils sont disponibles, comme illustré dans la figure suivante :

Activer/Désactiver le widget pour les commandes des appareils
Activer/Désactiver
Widget à bascule avec curseur
Activer/Désactiver avec le curseur
Widget de curseur de plage pour les commandes de l'appareil
Portée (ne peut pas être activée ni désactivée)
Widget de contrôle d'activation/désactivation sans état
Bouton bascule sans état
Widget du panneau de température en état fermé
Panneau de température (fermé)
Figure 2. Collection de widgets basés sur des modèles.

Appuyez de manière prolongée sur un widget pour accéder à l'application et bénéficier d'un contrôle plus précis. Vous pouvez personnaliser l'icône et la couleur de chaque widget, mais pour une expérience utilisateur optimale, utilisez l'icône et la couleur par défaut si l'ensemble par défaut correspond à l'appareil.

Widget du panneau de température ouvert
Figure 3 : Ouvrez le widget du panneau de température.

Créer le service

Cette section explique comment créer le fichier ControlsProviderService. Ce service indique à l'UI du système Android que votre application contient des commandes de l'appareil qui doivent être affichées dans la section Commandes de l'appareil de l'UI Android.

L'API ControlsProviderService suppose que vous êtes familiarisé avec les flux réactifs, tels qu'ils sont définis dans le projet GitHub Reactive Streams et implémentés dans les interfaces Java 9 Flow. L'API s'appuie sur les concepts suivants :

  • Éditeur : votre application est l'éditeur.
  • Abonné : l'UI du système est l'abonné et peut demander un certain nombre de commandes à l'éditeur.
  • Abonnement : période pendant laquelle l'éditeur peut envoyer des mises à jour à l'UI du système. L'éditeur ou l'abonné peuvent fermer cette fenêtre.

Déclarer le service

Votre application doit déclarer un service, tel que MyCustomControlService, dans son fichier manifeste d'application.

Le service doit inclure un filtre d'intent pour ControlsProviderService. Ce filtre permet aux applications d'ajouter des commandes à l'UI système.

Vous avez également besoin d'un label qui s'affiche dans les commandes de l'interface utilisateur du système.

L'exemple suivant montre comment déclarer un service :

<service
    android:name="MyCustomControlService"
    android:label="My Custom Controls"
    android:permission="android.permission.BIND_CONTROLS"
    android:exported="true"
    >
    <intent-filter>
      <action android:name="android.service.controls.ControlsProviderService" />
    </intent-filter>
</service>

Ensuite, créez un fichier Kotlin nommé MyCustomControlService.kt et faites-le étendre ControlsProviderService :

class MyCustomControlService : ControlsProviderService() {
    // ...
}

Sélectionnez le type de contrôle approprié.

L'API fournit des méthodes de création pour créer les contrôles. Pour remplir le générateur, déterminez l'appareil que vous souhaitez contrôler et la façon dont l'utilisateur interagit avec lui. Procédez comme suit :

  1. Sélectionnez le type d'appareil que représente le contrôle. La classe DeviceTypes est une énumération de tous les appareils compatibles. Le type est utilisé pour déterminer les icônes et les couleurs de l'appareil dans l'UI.
  2. Déterminez le nom visible par l'utilisateur, l'emplacement de l'appareil (par exemple, la cuisine) et les autres éléments textuels de l'UI associés au contrôle.
  3. Choisissez le modèle le mieux adapté pour favoriser l'interaction des utilisateurs. Un ControlTemplate est attribué aux contrôles à partir de l'application. Ce modèle affiche directement l'état du contrôle à l'utilisateur, ainsi que les méthodes de saisie disponibles, c'est-à-dire ControlAction. Le tableau suivant présente certains des modèles disponibles et les actions qu'ils prennent en charge :
Modèle Action Description
ControlTemplate.getNoTemplateObject() None L'application peut l'utiliser pour transmettre des informations sur le contrôle, mais l'utilisateur ne peut pas interagir avec.
ToggleTemplate BooleanAction Représente un contrôle qui peut être activé ou désactivé. L'objet BooleanAction contient un champ qui change pour représenter le nouvel état demandé lorsque l'utilisateur appuie sur le bouton de commande.
RangeTemplate FloatAction Représente un widget de curseur avec des valeurs min., max. et de pas spécifiées. Lorsque l'utilisateur interagit avec le curseur, renvoyez un nouvel objet FloatAction à l'application avec la valeur mise à jour.
ToggleRangeTemplate BooleanAction, FloatAction Ce modèle combine les ToggleTemplate et les RangeTemplate. Il est compatible avec les événements tactiles et un curseur, par exemple pour contrôler les lumières à intensité variable.
TemperatureControlTemplate ModeAction, BooleanAction, FloatAction En plus d'encapsuler les actions précédentes, ce modèle permet à l'utilisateur de définir un mode, tel que "Chauffage", "Climatisation", "Chauffage/Climatisation", "Éco" ou "Désactivé".
StatelessTemplate CommandAction Utilisé pour indiquer un contrôle qui fournit une capacité tactile, mais dont l'état ne peut pas être déterminé, comme une télécommande de télévision infrarouge. Vous pouvez utiliser ce modèle pour définir une routine ou une macro, qui est une agrégation de changements de contrôle et d'état.

Grâce à ces informations, vous pouvez créer le contrôle :

Par exemple, pour contrôler une ampoule connectée et un thermostat, ajoutez les constantes suivantes à votre MyCustomControlService :

private const val LIGHT_ID = 1234
private const val LIGHT_TITLE = "My fancy light"
private const val LIGHT_TYPE = DeviceTypes.TYPE_LIGHT
private const val THERMOSTAT_ID = 5678
private const val THERMOSTAT_TITLE = "My fancy thermostat"
private const val THERMOSTAT_TYPE = DeviceTypes.TYPE_THERMOSTAT

class MyCustomControlService : ControlsProviderService() {
    // ...
}

Créer des éditeurs pour les contrôles

Une fois le contrôle créé, il a besoin d'un éditeur. L'éditeur informe l'UI système de l'existence du contrôle. La classe ControlsProviderService comporte deux méthodes d'éditeur que vous devez remplacer dans le code de votre application :

  • createPublisherForAllAvailable : crée un Publisher pour tous les contrôles disponibles dans votre application. Utilisez Control.StatelessBuilder pour créer des objets Control pour cet éditeur.
  • createPublisherFor : crée un Publisher pour une liste de commandes données, identifiées par leurs identifiants de chaîne. Utilisez Control.StatefulBuilder pour créer ces objets Control, car l'éditeur doit attribuer un état à chaque commande.

Créer l'éditeur

Lorsque votre application publie pour la première fois des commandes dans l'UI système, elle ne connaît pas l'état de chaque commande. L'obtention de l'état peut être une opération longue impliquant de nombreux sauts dans le réseau du fournisseur d'appareils. Utilisez la méthode createPublisherForAllAvailable pour annoncer les commandes disponibles au système. Cette méthode utilise la classe de compilateur Control.StatelessBuilder, car l'état de chaque contrôle est inconnu.

Une fois les commandes affichées dans l'interface utilisateur Android, les utilisateurs peuvent sélectionner leurs commandes favorites.

Pour utiliser des coroutines Kotlin afin de créer un ControlsProviderService, ajoutez une nouvelle dépendance à votre build.gradle :

Groovy

dependencies {
    implementation "org.jetbrains.kotlinx:kotlinx-coroutines-jdk9:1.6.4"
}

Kotlin

dependencies {
    implementation("org.jetbrains.kotlinx:kotlinx-coroutines-jdk9:1.6.4")
}

Après avoir synchronisé vos fichiers Gradle, ajoutez l'extrait suivant à votre fichier Service pour implémenter createPublisherForAllAvailable :

class MyCustomControlService : ControlsProviderService() {

    override fun createPublisherForAllAvailable(): Flow.Publisher<Control> =
        flowPublish {
            send(createStatelessControl(LIGHT_ID, LIGHT_TITLE, LIGHT_TYPE))
            send(createStatelessControl(THERMOSTAT_ID, THERMOSTAT_TITLE, THERMOSTAT_TYPE))
        }

    private fun createStatelessControl(id: Int, title: String, type: Int): Control {
        val intent = Intent(this, MainActivity::class.java)
            .putExtra(EXTRA_MESSAGE, title)
            .addFlags(Intent.FLAG_ACTIVITY_NEW_TASK)
        val action = PendingIntent.getActivity(
            this,
            id,
            intent,
            PendingIntent.FLAG_UPDATE_CURRENT or PendingIntent.FLAG_IMMUTABLE,
        )

        return Control.StatelessBuilder(id.toString(), action)
            .setTitle(title)
            .setDeviceType(type)
            .build()
    }

    override fun createPublisherFor(controlIds: List<String>): Flow.Publisher<Control> {
        TODO()
    }

    override fun performControlAction(
        controlId: String,
        action: ControlAction,
        consumer: Consumer<Int>,
    ) {
        TODO()
    }
}

Balayez l'écran vers le bas pour ouvrir le menu système, puis recherchez le bouton Commandes de l'appareil, comme illustré sur la figure 4 :

Interface utilisateur système pour les commandes de l'appareil
Figure 4 : Commandes de contrôle des appareils dans le menu système.

En appuyant sur Commandes de l'appareil, vous accédez à un deuxième écran sur lequel vous pouvez sélectionner votre application. Une fois votre application sélectionnée, vous voyez comment l'extrait précédent crée un menu système personnalisé affichant vos nouvelles commandes, comme illustré à la figure 5 :

Menu système affichant une commande d'éclairage et de thermostat
Figure 5 : Commandes d'éclairage et de thermostat à ajouter.

Implémentez maintenant la méthode createPublisherFor en ajoutant les éléments suivants à votre Service :

private val job = SupervisorJob()
private val scope = CoroutineScope(Dispatchers.IO + job)
private val controlFlows = mutableMapOf<String, MutableSharedFlow<Control>>()

private var toggleState = false
private var rangeState = 18f

override fun createPublisherFor(controlIds: List<String>): Flow.Publisher<Control> {
    val flow = MutableSharedFlow<Control>(replay = 2, extraBufferCapacity = 2)

    controlIds.forEach { controlFlows[it] = flow }

    scope.launch {
        delay(1000) // Retrieving the toggle state.
        flow.tryEmit(createLight())

        delay(1000) // Retrieving the range state.
        flow.tryEmit(createThermostat())
    }
    return flow.asPublisher()
}

private fun createLight() = createStatefulControl(
    LIGHT_ID,
    LIGHT_TITLE,
    LIGHT_TYPE,
    toggleState,
    ToggleTemplate(
        LIGHT_ID.toString(),
        ControlButton(
            toggleState,
            toggleState.toString().uppercase(Locale.getDefault()),
        ),
    ),
)

private fun createThermostat() = createStatefulControl(
    THERMOSTAT_ID,
    THERMOSTAT_TITLE,
    THERMOSTAT_TYPE,
    rangeState,
    RangeTemplate(
        THERMOSTAT_ID.toString(),
        15f,
        25f,
        rangeState,
        0.1f,
        "%1.1f",
    ),
)

private fun <T> createStatefulControl(
    id: Int,
    title: String,
    type: Int,
    state: T,
    template: ControlTemplate,
): Control {
    val intent = Intent(this, MainActivity::class.java)
        .putExtra(EXTRA_MESSAGE, "$title $state")
        .addFlags(Intent.FLAG_ACTIVITY_NEW_TASK)
    val action = PendingIntent.getActivity(
        this,
        id,
        intent,
        PendingIntent.FLAG_UPDATE_CURRENT or PendingIntent.FLAG_IMMUTABLE,
    )

    return Control.StatefulBuilder(id.toString(), action)
        .setTitle(title)
        .setDeviceType(type)
        .setStatus(Control.STATUS_OK)
        .setControlTemplate(template)
        .build()
}

override fun onDestroy() {
    super.onDestroy()
    job.cancel()
}

Dans cet exemple, la méthode createPublisherFor contient une fausse implémentation de ce que votre application doit faire : communiquer avec votre appareil pour récupérer son état et émettre cet état vers le système.

La méthode createPublisherFor utilise des coroutines et des flux Kotlin pour répondre à l'API Reactive Streams requise en procédant comme suit :

  1. Crée un objet Flow.
  2. Patientez une seconde.
  3. Crée et émet l'état de l'ampoule connectée.
  4. Patientez une seconde de plus.
  5. Crée et émet l'état du thermostat.

Gérer les actions

La méthode performControlAction signale quand l'utilisateur interagit avec un contrôle publié. Le type de ControlAction envoyé détermine l'action. Effectuez l'action appropriée pour la commande donnée, puis mettez à jour l'état de l'appareil dans l'UI Android.

Pour compléter l'exemple, ajoutez les éléments suivants à votre Service :

override fun performControlAction(
    controlId: String,
    action: ControlAction,
    consumer: Consumer<Int>,
) {
    controlFlows[controlId]?.let { flow ->
        when (controlId) {
            LIGHT_ID.toString() -> {
                consumer.accept(ControlAction.RESPONSE_OK)
                if (action is BooleanAction) toggleState = action.newState
                flow.tryEmit(createLight())
            }
            THERMOSTAT_ID.toString() -> {
                consumer.accept(ControlAction.RESPONSE_OK)
                if (action is FloatAction) rangeState = action.newValue
                flow.tryEmit(createThermostat())
            }
            else -> consumer.accept(ControlAction.RESPONSE_FAIL)
        }
    } ?: consumer.accept(ControlAction.RESPONSE_FAIL)
}

Exécutez l'application, accédez au menu Contrôle de l'appareil et consultez les commandes de votre éclairage et de votre thermostat.

Commandes affichant une lumière et un thermostat
Figure 6 : Commandes pour les lumières et le thermostat.