SDK de red de Thread para Android

Organiza tus páginas con colecciones Guarda y categoriza el contenido según tus preferencias.

El SDK de Thread Network proporciona una funcionalidad similar a un llavero digital, lo que permite que tus apps para Android compartan credenciales de red de Thread con los Servicios de Google Play. Esto permite que tus apps configuren cualquier dispositivo Thread desde cualquier ecosistema de casa inteligente, sin exponer las credenciales y los datos del usuario directamente.

Con solo unas pocas llamadas a la API, puedes hacer lo siguiente:

  1. Solicita credenciales de red de Thread preferidas de los Servicios de Google Play.
  2. Configura routers perimetrales nuevos y agrega tus credenciales de red de Thread a los Servicios de Google Play.
  3. Si ya tienes routers fronterizos en el campo, puedes verificar si están en la red preferida y migrarlos si es necesario.

Hay varios recorridos del usuario y del desarrollador que se deben considerar. En esta guía, abordaremos la mayoría de ellas, junto con otras funciones clave y el uso recomendado.

Terminología clave y conceptos de la API

Antes de comenzar, te recomendamos comprender los siguientes términos:

  • Credenciales de red de Thread: BLOB binario de TLV de Thread que codifica el nombre de la red de Thread, la clave de red y otras propiedades que requiere un dispositivo Thread para unirse a una red Thread determinada.

  • Credenciales de red de Thread preferidas: Son las credenciales de red de Thread seleccionadas automáticamente que se pueden compartir con apps de diferentes proveedores mediante la API de getPreferredCredentials.

  • ID del agente de borde: Un ID único global de 16 bytes para un dispositivo de router de borde de Thread Existen proveedores de router fronterizo que crean y administran este ID.

  • App de configuración del router de borde de Thread: Esta es tu app para Android que configura nuevos dispositivos de router de borde de Thread y agrega las credenciales de la red de Thread a los Servicios de Google Play. Tu app es la propietaria autorizada de las credenciales agregadas y tiene acceso gratuito a las credenciales.

Muchas de las API de Thread Network muestran una Task que se completa de forma asíncrona. Puedes usar addOnSuccessListener y addOnFailureListener para registrar devoluciones de llamada a fin de recibir el resultado. Para obtener más información, consulta la documentación de Tarea.

Propiedad y mantenimiento de las credenciales

La app que agrega las credenciales de la red de Thread se convierte en la propietaria de las credenciales, y tiene permisos completos para acceder a las credenciales. Si intentas acceder a las credenciales que agregaron otras apps, recibirás un error PERMISSION_DENIED.

Como propietario de la app, se recomienda que mantengas las credenciales almacenadas en los Servicios de Google Play actualizadas cuando se actualice la red del router de borde de Thread. Esto significa agregar credenciales cuando sea necesario, actualizar las credenciales cuando cambie el credenciales de la red de Thread del router de borde y quitarlas cuando se quite el router de borde de Thread o se restablezca la configuración de fábrica.

Descubrimiento del agente de borde

Las credenciales deben guardarse con un ID de agente de borde. Deberás asegurarte de que tu app de Configuración del router de borde de Thread pueda determinar los ID de agente de borde de tus routers de borde de Thread.

Los routers de borde de Thread deben usar mDNS para anunciar información de la red de Thread, incluidos el nombre de la red, el ID de desplazamiento lateral extendido y el ID del agente de borde. Los valores txt correspondientes para estos atributos son nn, xp y id, respectivamente.

En el caso de las redes con routers perimetrales de Google, los Servicios de Google Play obtienen automáticamente las credenciales de red de Google Thread para su uso.

Integra el SDK en tu app para Android

Para comenzar, sigue estos pasos:

  1. Sigue las instrucciones que se proporcionan en Configura los Servicios de Google Play.

  2. Agrega la dependencia de los Servicios de Google Play a tu archivo build.gradle:

    implementation 'com.google.android.gms:play-services-threadnetwork:16.0.0-beta01'
    
  3. Opcional: Define un data class de BorderAgent para almacenar la información del router de borde. En esta guía, usaremos los siguientes datos:

    data class BorderAgentInfo(
      // Network Name max 16 len
      val networkName: String = "",
      val extPanId: ByteArray = ByteArray(16),
      val borderAgentId: ByteArray = ByteArray(16),
      ...
    )
    

A continuación, veremos los pasos recomendados para agregar y administrar credenciales preferidas.

Nuevas configuraciones de routers fronterizos

Antes de crear una red nueva para routers nuevos, es importante que primero uses las credenciales de red preferidas. De esta manera, se garantiza que los dispositivos Thread estén conectados a una sola red Thread cuando sea posible.

Una llamada a getPreferredCredentials inicia una actividad para que los usuarios permitan la solicitud de red. Si se almacenaron las credenciales de red en el llavero digital del SDK de Thread, se devuelven las credenciales a tu app.

Solicitar credenciales

Para solicitar al usuario las credenciales preferidas, haz lo siguiente:

  1. Declara un ActivityLauncher:

    private lateinit var preferredCredentialsLauncher: ActivityResultLauncher<IntentSenderRequest>
    
  2. Controla el resultado de actividad, que se muestra como ThreadNetworkCredentials:

    preferredCredentialsLauncher =
     registerForActivityResult(
       StartIntentSenderForResult()
     ) { result: ActivityResult ->
       if (result.resultCode == RESULT_OK) {
         val threadNetworkCredentials = ThreadNetworkCredentials.fromIntentSenderResultData(result.data!!)
         Log.d("debug", threadNetworkCredentials.networkName)
       } else {
         Log.d("debug", "User denied request.")
       }
     }
    
  3. Llama a preferredCredentials e inicia la actividad:

    private fun getPreferredThreadNetworkCredentials() {
      ThreadNetwork.getClient(this)
        .preferredCredentials
      .addOnSuccessListener { intentSenderResult ->
        intentSenderResult.intentSender?.let {
          preferredCredentialsLauncher.launch(IntentSenderRequest.Builder(it).build())
          } ?: Log.d("debug", "No preferred credentials found.")
        }
      .addOnFailureListener { e: Exception -> Log.d(TAG, "ERROR: [${e}]") }
    }
    

Crear una nueva red Thread

Si no hay credenciales de red Thread preferidas disponibles en una red Thread de usuario, puedes usar la API de addCredentials para agregar credenciales a los Servicios de Google Play. Para ello, tendrás que crear un ThreadBorderAgent y también proporcionar un objeto ThreadNetworkCredentials.

Para crear una red aleatoria, llama a newRandomizeBuilder:

val threadCredentials = ThreadNetworkCredentials.newRandomizedBuilder().build()

Para especificar el nombre de red de Thread, sigue estos pasos:

val threadCredentials = ThreadNetworkCredentials.newRandomizedBuilder()
  .setNetworkName("ThreadNetworkSDK")
  .build()

Agregar credenciales

A fin de que tus credenciales de red de Thread estén disponibles para otros proveedores de este servicio, debemos agregarlas a los servicios de Google Play. Para poder agregar nuestras credenciales nuevas, también debemos saber a qué dispositivo de router de borde pertenece esta red Thread.

En este ejemplo, crearemos una ThreadBorderAgent a partir de un ID de agente de borde y pasarás las nuevas credenciales de red de Thread que acabas de crear:

private fun addCredentials(borderAgentInfo: BorderAgentInfo, credentialsToBeAdded: ThreadNetworkCredentials) {

  val threadBorderAgent = ThreadBorderAgent.newBuilder(borderAgentInfo.borderAgentId).build()
  Log.d("debug", "border router id:" + threadBorderAgent.id)

  ThreadNetwork.getClient(this)
    .addCredentials(threadBorderAgent, credentialsToBeAdded)
      .addOnSuccessListener {
        Log.d("debug", "Credentials added.")
      }
      .addOnFailureListener { e: Exception -> Log.d(TAG, "ERROR: [${e}]") }
}

Detecta y migra routers de borde en campo

Si actualmente tienes routers fronterizos en el campo, puedes usar isPreferredCredentials para determinar si estos pertenecen a la red preferida. Esta API no le solicita permiso al usuario y compara las credenciales de routers fronterizas con lo que se almacena en los Servicios de Google Play.

isPreferredCredentails muestra 0 para coincidencias y 1 para coincidencias, como un tipo de datos Int. Puedes usar IsPreferredCredentialsResult para verificar tus resultados.

public @interface IsPreferredCredentialsResult {
    int PREFERRED_CREDENTIALS_NOT_FOUND = -1;
    int PREFERRED_CREDENTIALS_NOT_MATCHED = 0;
    int PREFERRED_CREDENTIALS_MATCHED = 1;
}

Para usar isPreferredCredentials, primero debes crear un objeto ThreadNetworkCredentials. Existen varias maneras de crear una instancia de ThreadNetworkCredentials. En los próximos pasos, revisaremos estas opciones.

Credenciales de la red de subprocesos por conjunto de datos operativo

En algunos casos, el router de borde de Thread está configurado con una red de Thread y quieres agregarla a los Servicios de Google Play para compartirla con otros proveedores. Puedes crear una instancia de ThreadNetworkCredential a partir de una lista TLV de conjunto de datos operativos activos de Thread:

  1. Convertir el conjunto de datos operativo en ByteArray Por ejemplo:

    val activeDataset =
          "0e080000000000010000000300000f35060004001fffe0020833333333...".dsToByteArray()
    
    fun String.dsToByteArray(): ByteArray {
      return chunked(2).map { it.toInt(16).toByte() }.toByteArray()
    }
    
  2. Usa fromActiveOperationalDataset para crear la ThreadNetworkCredentials. Cuando se complete correctamente, podrás obtener el nombre de la red de Thread, el canal y otra información. Para obtener una lista completa de propiedades, consulta ThreadNetworkCredentials.

    val threadNetworkCredentials =
        ThreadNetworkCredentials.fromActiveOperationalDataset(activeDataset)
    Log.d(
        "threadNetworkCredentials",
        threadNetworkCredentials.channel.toString() + " - " + threadNetworkCredentials.networkName)
    
  3. Llama a la API de isPreferredCredentials y pasa ThreadNetworkCredentials.

    ThreadNetwork.getClient(this)
    .isPreferredCredentials(threadNetworkCredentials)
    .addOnSuccessListener { result ->
      when (result) {
        IsPreferredCredentialsResult.PREFERRED_CREDENTIALS_NOT_MATCHED ->
            Log.d("isPreferredCredentials", "Credentials not matched.")
        IsPreferredCredentialsResult.PREFERRED_CREDENTIALS_MATCHED ->
            Log.d("isPreferredCredentials", "Credentials matched.")
      }
    }
    .addOnFailureListener { e: Exception -> Log.d("isPreferredCredentials", "ERROR: [${e}]") }
    

Credenciales de la red de subprocesos que crea el agente de borde

Un ID de agente de borde identifica de forma única un dispositivo de router de borde. Para usar la API de getCredentialsByBorderAgent, primero debes crear un objeto ThreadBorderAgent y pasar el ID del agente de borde.

Una vez que hayas creado el objeto ThreadBorderAgent, llama a getCredentialsByBorderAgent. Si se guardaron las credenciales, verifica si se prefieren.

private fun isPreferredThreadNetworkByBorderAgent(borderAgentInfo: BorderAgentInfo) {

  val threadBorderAgent = ThreadBorderAgent.newBuilder(borderAgentInfo.borderAgentId).build()
  Log.d("debug", "border router id:" + threadBorderAgent.id)

  var isPreferred = IsPreferredCredentialsResult.PREFERRED_CREDENTIALS_NOT_FOUND
  var borderAgentCredentials: ThreadNetworkCredentials?
  val taskByBorderAgent = ThreadNetwork.getClient(this)
  taskByBorderAgent
      .getCredentialsByBorderAgent(threadBorderAgent)
      .addOnSuccessListener { result: ThreadNetworkCredentialsResult ->
        borderAgentCredentials = result.credentials
        result.credentials?.let {
          taskByBorderAgent.isPreferredCredentials(it).addOnSuccessListener { result ->
            isPreferred = result
          }
        }
      }
      .addOnFailureListener { e: Exception -> Log.d(TAG, "ERROR: [${e}]") }
}

Credenciales de la red de subprocesos por ID de desplazamiento extendido

De manera similar a getPreferredCredentials, también puedes solicitarle al usuario las credenciales de un ID de desplazamiento extendido de un router de borde. El getCredentialsByExtendedPanId muestra un IntentSender, y el resultado de la actividad contiene un objeto ThreadNetworkCredentials cuando el usuario lo aprueba.

private fun getCredentialsByExtPanId(borderAgentInfo: BorderAgentInfo) {
  ThreadNetwork.getClient(this)
    .getCredentialsByExtendedPanId(borderAgentInfo.extPanId)
    .addOnSuccessListener { intentSenderResult ->
      intentSenderResult.intentSender?.let {
        preferredCredentialsLauncher.launch(IntentSenderRequest.Builder(it).build())
      }
        ?: Log.d("debug", "No credentials found.")
    }
    .addOnFailureListener { e: Exception -> Log.d(TAG, "ERROR: [${e}]") }
}

Quitar credenciales

Cuando se quita el dispositivo del router fronterizo de tu casa o el restablecimiento de la configuración de fábrica, debes quitar su red Thread de los Servicios de Google Play.

private fun removeCredentials(borderAgentInfo: BorderAgentInfo) {

  val threadBorderAgent = ThreadBorderAgent.newBuilder(borderAgentInfo.borderAgentId).build()
  Log.d("debug", "border router id:" + threadBorderAgent.id)

  ThreadNetwork.getClient(this)
      .removeCredentials(threadBorderAgent)
      .addOnSuccessListener { Log.d("debug", "Credentials removed.") }
      .addOnFailureListener { e: Exception -> Log.d(TAG, "ERROR: [${e}]") }
}

Recursos

Para obtener más información sobre el SDK de Thread Network, consulta la referencia de la API.