Cómo controlar dispositivos externos

En Android 11 y versiones posteriores, la función Controles de dispositivos de Acceso rápido permite a los usuarios ver y controlar rápidamente dispositivos externos, como luces, termostatos y cámaras, desde una interfaz de usuario con tres interacciones desde un selector predeterminado. El OEM del dispositivo elige qué selector usar. Los agregadores de dispositivos (por ejemplo, Google Home) y las apps de proveedores externos pueden proporcionar dispositivos para mostrar en este espacio. En esta página, se muestra cómo mostrar los controles del dispositivo en este espacio y vincularlos a tu app de control.

Para agregar esta compatibilidad, crea y declara un ControlsProviderService. Crea los controles que tu app admite según los tipos de controles predefinidos y luego crea publicadores para estos controles.

Interfaz de usuario

Se muestran los dispositivos en Controles de dispositivos como widgets con plantilla. Hay cinco widgets de control de dispositivos disponibles, como se muestra en la siguiente figura:

Si mantienes presionado un widget, accederás a la app para obtener un mayor control. Puedes personalizar el ícono y el color de cada widget; pero, para obtener la mejor experiencia del usuario, usa el ícono y el color predeterminados si el conjunto predeterminado coincide con el dispositivo.

Cómo crear el servicio

En esta sección, se muestra cómo crear el ControlsProviderService. Este servicio le indica a la IU del sistema Android que tu app contiene controles de dispositivos que deben mostrarse en el área Controles de dispositivos de la IU de Android.

La API de ControlsProviderService asume que conoces el funcionamiento de las transmisiones reactivas, como se define en el proyecto de GitHub sobre transmisiones reactivas y se implementa en las interfaces de Java 9 Flow. La API se basa en los siguientes conceptos:

• Publicador: Tu aplicación es el publicador.
• Suscriptor: La IU del sistema es el suscriptor y puede solicitar varios controles al publicador.
• Suscripción: Es el período durante el cual el publicador puede enviar actualizaciones a la IU del sistema. El publicador o el suscriptor pueden cerrar esta ventana.

Cómo declarar el servicio

Tu app debe declarar un servicio, como MyCustomControlService, en su manifiesto de la app.

El servicio debe incluir un filtro de intents para ControlsProviderService. Este filtro permite que las aplicaciones aporten controles a la IU del sistema.

También necesitas un label que se muestre en los controles de la IU del sistema.

En el siguiente ejemplo, se muestra cómo declarar un servicio:

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

A continuación, crea un nuevo archivo de Kotlin llamado MyCustomControlService.kt y haz que extienda ControlsProviderService:

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

Cómo seleccionar el tipo de control correcto

La API proporciona métodos de compilación para crear los controles. Si quieres propagar el compilador, determina el dispositivo que deseas controlar y el modo en que el usuario interactúa con él. Completa los pasos siguientes:

1. Elige el tipo de dispositivo que el control represente. La clase DeviceTypes es una enumeración de todos los dispositivos admitidos. Se usa el tipo para determinar los íconos y los colores del dispositivo en la IU.
2. Determina el nombre que verá el usuario, la ubicación del dispositivo (por ejemplo, la cocina) y otros elementos de texto de la IU asociados con el control.
3. Elige la mejor plantilla para admitir la interacción del usuario. La aplicación asigna un ControlTemplate a los controles. Esta plantilla muestra directamente el estado del control al usuario, así como los métodos de entrada disponibles, es decir, el ControlAction. En la siguiente tabla, se describen algunas de las plantillas disponibles y las acciones que admiten:

Con esta información, puedes crear el control:

• Usa la clase de compilador Control.StatelessBuilder cuando se desconozca el estado del control.
• Usa la clase de compilador Control.StatefulBuilder cuando se conozca el estado del control.

Por ejemplo, para controlar una lámpara inteligente y un termostato, agrega las siguientes constantes a tu 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() {
    // ...
}
MyCustomControlService.kt

Cómo crear publicadores para los controles

Después de crear el control, este necesita un publicador. El publicador informa a la IU del sistema que hay un control. La clase ControlsProviderService tiene dos métodos de publicador que debes anular en el código de tu aplicación:

• createPublisherForAllAvailable: Crea un Publisher para todos los controles disponibles en tu app. Usa Control.StatelessBuilder para compilar objetos Control para este publicador.
• createPublisherFor: Crea un Publisher para una lista de controles determinados, reconocidos por sus identificadores de cadena. Usa Control.StatefulBuilder para compilar estos objetos Control, ya que el editor debe asignar un estado a cada control.

Cómo crear el publicador

Cuando tu app publica controles por primera vez en la IU del sistema, no conoce el estado de cada control. Obtener el estado puede ser una operación lenta que implique muchos saltos en la red del proveedor de dispositivos. Usa el método createPublisherForAllAvailable para anunciar los controles disponibles al sistema. Este método usa la clase de compilador Control.StatelessBuilder, ya que se desconoce el estado de cada control.

Una vez que los controles aparecen en la IU de Android, los usuarios pueden seleccionar sus controles favoritos.

Para usar corrutinas de Kotlin y crear un ControlsProviderService, agrega una nueva dependencia a tu build.gradle:

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

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

Después de sincronizar tus archivos de Gradle, agrega el siguiente fragmento a tu Service para implementar 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()
    }
}
MyCustomControlService.kt

Desliza el dedo hacia abajo en el menú del sistema y busca el botón Controles del dispositivo, que se muestra en la figura 4:

Si presionas Controles del dispositivo, se te redireccionará a una segunda pantalla en la que podrás seleccionar tu app. Una vez que la selecciones, verás cómo el fragmento anterior crea un menú del sistema personalizado que muestra los nuevos controles, como se muestra en la figura 5:

Ahora, implementa el método createPublisherFor y agrega lo siguiente a tu 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()
}
MyCustomControlService.kt

En este ejemplo, el método createPublisherFor contiene una implementación falsa de lo que debe hacer tu app: comunicarse con tu dispositivo para recuperar su estado y emitir ese estado al sistema.

El método createPublisherFor usa corrutinas y flujos de Kotlin para satisfacer la API de Reactive Streams requerida de la siguiente manera:

1. Crea un Flow.
2. Espera un segundo.
3. Crea y emite el estado de la lámpara inteligente.
4. Espera otro segundo.
5. Crea y emite el estado del termostato.

Cómo controlar acciones

El método performControlAction indica cuándo el usuario interactúa con un control publicado. El tipo de ControlAction que se envía determina la acción. Realiza la acción adecuada para el control específico y, luego, actualiza el estado del dispositivo en la IU de Android.

Para completar el ejemplo, agrega lo siguiente a tu 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)
}
MyCustomControlService.kt

Ejecuta la app, accede al menú Controles del dispositivo y consulta los controles de la luz y el termostato.