SDK da Thread Network para Android

Mantenha tudo organizado com as coleções Salve e categorize o conteúdo com base nas suas preferências.

O SDK da Thread Network oferece funcionalidade semelhante a um conjunto de chaves digitais, permitindo que seus apps Android compartilhem credenciais de rede do Thread com o Google Play Services. Isso permite que seus apps configurem qualquer dispositivo Thread de qualquer ecossistema de casa inteligente, sem expor diretamente credenciais e dados do usuário.

Com apenas algumas chamadas de API, você pode:

  1. Solicite as credenciais preferidas da rede Thread do Google Play Services.
  2. Configure novos roteadores de borda e adicione as credenciais de rede Thread ao Google Play Services.
  3. Se você já tiver roteadores de borda em campo, verifique se eles estão na rede preferencial e migre-os, se necessário.

Há várias jornadas de desenvolvedor e usuário a serem consideradas. Abordaremos a maioria destes guias, junto com outros recursos importantes e o uso recomendado.

Terminologia e conceitos principais de API

Antes de começar, é útil entender os seguintes termos:

  • Credenciais da rede Thread: blob binário de TLVs Thread que codifica o nome de rede, a chave de rede e outras propriedades exigidas por um dispositivo Thread para se conectar a uma determinada rede Thread.

  • Preferências da rede de linhas de execução preferencial:as credenciais da rede Thread selecionadas automaticamente, que podem ser compartilhadas com apps de diferentes fornecedores usando a API getPreferredCredentials.

  • ID do agente de borda: um ID globalmente exclusivo de 16 bytes para um dispositivo de roteador de borda de linha de execução. Esse ID é criado e gerenciado por fornecedores de roteadores de borda.

  • App de configuração do roteador de borda do Thread: este é o app Android que configura novos dispositivos de roteador da borda do Thread e adiciona as credenciais da rede do Thread ao Google Play Services. O app é o proprietário autorizado das credenciais adicionadas e tem acesso sem custo financeiro a elas.

Muitas das APIs Thread Network retornam uma Task que é concluída de forma assíncrona. Você pode usar addOnSuccessListener e addOnFailureListener para registrar callbacks para receber o resultado. Para saber mais, consulte a documentação de Tarefas.

Propriedade e manutenção de credenciais

O app que adiciona as credenciais da rede Thread se torna o proprietário das credenciais e tem permissões completas de acesso às credenciais. Se você tentar acessar as credenciais adicionadas por outros apps, receberá um erro PERMISSION_DENIED.

Como proprietário do app, recomendamos que você mantenha as credenciais armazenadas no Google Play Services atualizadas quando a rede do roteador de borda do Thread for atualizada. Isso significa a adição de credenciais quando necessário, a atualização de credenciais quando as credenciais da rede Thread do roteador de borda mudam e a remoção de credenciais quando o Roteador de borda do Thread é removido ou redefinido para a configuração original.

Descoberta de agentes de borda

As credenciais precisam ser salvas com um ID de agente de borda. Confira se o app de configuração do roteador de borda do Thread é capaz de determinar os IDs do agente de borda dos roteadores de borda do Thread.

Os roteadores de borda do Thread precisam usar mDNS para anunciar informações da rede Thread, incluindo o nome da rede, Extended Pan ID e Border Agent ID. Os valores txt correspondentes para esses atributos são nn, xp e id, respectivamente.

Para redes com roteadores de borda do Google, o Google Play Services recebe automaticamente as credenciais de rede do Thread do Google para uso.

Integrar o SDK ao seu app Android

Para começar, siga estas etapas:

  1. Siga as instruções fornecidas em Configurar o Google Play Services.

  2. Adicione a dependência do Google Play Services ao arquivo build.gradle:

    implementation 'com.google.android.gms:play-services-threadnetwork:16.0.0-beta02'
    
  3. Opcional:defina uma classe de dados BorderAgent para armazenar informações do roteador de borda. Usaremos esses dados ao longo deste guia:

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

Em seguida, vamos ver as etapas recomendadas para adicionar e gerenciar as credenciais preferenciais.

Novas configurações do roteador de borda

Antes de criar uma nova rede para novos roteadores de borda, é importante usar as credenciais de rede preferenciais primeiro. Isso garante que os dispositivos Thread sejam conectados a uma única rede Thread quando possível.

Uma chamada para getPreferredCredentials inicia uma atividade, solicitando que os usuários permitam a solicitação de rede. Se as credenciais de rede tiverem sido armazenadas no conjunto de chaves digital do SDK do Thread, elas serão retornadas ao app.

Pedir credenciais

Para solicitar as credenciais preferenciais ao usuário:

  1. Declare um ActivityLauncher:

    private lateinit var preferredCredentialsLauncher: ActivityResultLauncher<IntentSenderRequest>
    
  2. Processe o resultado da atividade, retornado 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. Chame preferredCredentials e inicie a atividade:

    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}]") }
    }
    

Criar uma nova rede Thread

Se não houver credenciais de rede de linhas de execução preferenciais disponíveis na rede de linhas de execução de um usuário, você poderá usar a API addCredentials para adicionar credenciais ao Google Play Services. Para fazer isso, você precisará criar um ThreadBorderAgent e também fornecer um objeto ThreadNetworkCredentials.

Para criar uma rede aleatória, chame o newRandomizeBuilder:

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

Para especificar o nome da rede Thread:

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

Adicionar credenciais

Para disponibilizar as credenciais de rede da Thread para outros fornecedores de Thread, precisamos adicioná-las ao Google Play Services. Antes de adicionarmos novas credenciais, também precisamos saber a que dispositivo de roteador de borda essa rede Thread pertence.

Neste exemplo, vamos criar um ThreadBorderAgent com base em um ID do agente de borda e transmitir as novas credenciais da rede Thread que você acabou de criar:

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}]") }
}

Detectar e migrar roteadores de borda em campo

Se você tiver roteadores de borda em campo, use isPreferredCredentials para determinar se eles pertencem à rede preferencial. Essa API não solicita permissão ao usuário e verifica as credenciais do roteador de borda em relação ao que está armazenado no Google Play Services.

isPreferredCredentails retorna 0 para não correspondência e 1 para correspondência, como um tipo de dados Int. Use IsPreferredCredentialsResult para verificar os resultados.

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

Para usar isPreferredCredentials, primeiro você precisa criar um objeto ThreadNetworkCredentials. Há várias maneiras de instanciar ThreadNetworkCredentials. Nas próximas etapas, veremos essas opções.

Credenciais da rede Thread por conjunto de dados operacional

Em alguns casos, o roteador de borda do Thread já está configurado com uma rede Thread, e você quer adicionar essa rede do Thread ao Google Play Services para compartilhá-la com outros fornecedores. Você pode criar uma instância de ThreadNetworkCredential com base em uma lista bruta de conjunto de dados operacional operacional de Thread VTL:

  1. Converta o conjunto de dados operacional em um ByteArray. Exemplo:

    val activeDataset =
          "0e080000000000010000000300000f35060004001fffe0020833333333...".dsToByteArray()
    
    fun String.dsToByteArray(): ByteArray {
      return chunked(2).map { it.toInt(16).toByte() }.toByteArray()
    }
    
  2. Use fromActiveOperationalDataset para criar o ThreadNetworkCredentials. Se a operação for bem-sucedida, você conseguirá o nome da rede da Thread, o canal e outras informações da rede. Para ver uma lista completa de propriedades, consulte ThreadNetworkCredentials.

    val threadNetworkCredentials =
        ThreadNetworkCredentials.fromActiveOperationalDataset(activeDataset)
    Log.d(
        "threadNetworkCredentials",
        threadNetworkCredentials.channel.toString() + " - " + threadNetworkCredentials.networkName)
    
  3. Chame a API isPreferredCredentials e transmita o 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}]") }
    

Credenciais da rede Thread por agente de borda

Um código do agente de borda identifica exclusivamente um dispositivo de roteador de borda. Para usar a API getCredentialsByBorderAgent, primeiro você precisará criar um objeto ThreadBorderAgent e transmitir o ID do agente de borda.

Depois de criar o objeto ThreadBorderAgent, chame getCredentialsByBorderAgent. Caso as credenciais tenham sido salvas, verifique se elas são preferidas.

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}]") }
}

Credenciais da rede Thread por ID de movimentação estendida

De forma semelhante a getPreferredCredentials, você também pode solicitar ao usuário credenciais de um roteador de borda com roteador de borda. O getCredentialsByExtendedPanId retorna um IntentSender, e o resultado da atividade contém um objeto ThreadNetworkCredentials quando o usuário aprova.

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}]") }
}

Remover credenciais

Quando o dispositivo de roteador de borda for removido da casa ou da redefinição para a configuração original, você precisará remover a rede Thread do Google Play Services.

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 saber mais sobre o SDK Thread Network, consulte a Referência da API.