Geräteleitfaden für Border-Router für Android

Android-App-Entwickler können die Home APIs verwenden, um einen Thread Border Router (TBR) zu verwalten.

Der GoogleBorderRouterDevice wird mit zwei primären Geräte Traits implementiert: ThreadNetworkCapabilities, das schreibgeschützte Attribute zur Überprüfung von border router Funktionen bietet, und ThreadNetworkManagement, das Befehle für den Netzwerklebenszyklus und die Freigabe von Anmeldedaten mithilfe eines temporären vorinstallierten Schlüssels für den Commissioner (ePSKc) verarbeitet. Internet-Zugriffsrichtlinien auf Strukturebene werden mit dem ThreadNetworkSettings Trait verwaltet.

Prüfen Sie immer, ob ein Gerät Attribute und Befehle unterstützt, bevor Sie Funktionen verwenden oder versuchen, Attribute zu aktualisieren. Weitere Informationen finden Sie unter Geräte auf Android steuern.

Gerätetyp der Home APIs Merkmale Kotlin-Beispiel-App Anwendungsfall

Border-Router

GoogleBorderRouterDevice

home.matter.6006.types.0161

 Erforderliche Traits
     google ThreadNetworkCapabilities
     google ThreadNetworkManagement

 Border-Router

Grundlegende Informationen zu einem Gerät abrufen

   In der Beispiel-App für Android implementiert   

Das BasicInformation Trait enthält Informationen wie den Namen des Anbieters, die Anbieter-ID, die Produkt-ID, den Produktnamen (einschließlich Modellinformationen) und die Softwareversion für ein Gerät:

// Get device basic information. All general information traits are on the RootNodeDevice type.
    device.type(RootNodeDevice).first().standardTraits.basicInformation?.let { basicInformation ->
        println("vendorName ${basicInformation.vendorName}")
        println("vendorId ${basicInformation.vendorId}")
        println("productId ${basicInformation.productId}")
        println("productName ${basicInformation.productName}")
        println("softwareVersion ${basicInformation.softwareVersion}")
    }

Funktionen des Border-Routers prüfen

Mit dem ThreadNetworkCapabilities-Trait können Sie die schreibgeschützten Funktionen eines border router's prüfen , z. B. die ePSKc-Unterstützung und die Konfiguration der Internetzugriffseinstellung.

suspend fun checkBorderRouterCapabilities(device: HomeDevice) {
    // Filter for GoogleBorderRouterDevice device type
    val gtbrDevice = device.type(GoogleBorderRouterDevice).firstOrNull()
    if (gtbrDevice == null) {
        println("Device is not a Google border router.")
        return
    }

    // Retrieve the ThreadNetworkCapabilities trait
    val capabilitiesTrait = gtbrDevice.trait(ThreadNetworkCapabilities)
    if (capabilitiesTrait == null) {
        println("ThreadNetworkCapabilities trait not found on device.")
        return
    }

    val isEpskcSupported = capabilitiesTrait.epskcSupported ?: false
    val internetAccessOption = capabilitiesTrait.internetAccessOption?.name ?: "None"
    val isIasSupported = !internetAccessOption.equals("None", ignoreCase = true)

    println("ePSKc Supported: $isEpskcSupported")
    println("Internet Access Setting Supported: $isIasSupported")
}

Freigabe von Thread-Anmeldedaten verwalten (ePSKc)

Die Freigabe von Thread-Anmeldedaten erfolgt mithilfe eines temporären vorinstallierten Schlüssels für den Commissioner (ePSKc). Im ePSKc-Modus wird ein temporärer, sicherer Passkey generiert, mit dem externe Geräte oder Commissioners das Thread-Netzwerk-Dataset sicher abrufen können.

ePSKc-Modus aktivieren

suspend fun startEpskcSession(device: HomeDevice, durationSeconds: Short): ActivateEpskcModeCommand.Response? {
    val gtbrDevice = device.type(GoogleBorderRouterDevice).firstOrNull()
    val mgmtTrait = gtbrDevice?.trait(ThreadNetworkManagement)

    if (mgmtTrait == null) {
        println("ThreadNetworkManagement trait not found.")
        return null
    }

    return try {
        val response = mgmtTrait.activateEpskcMode(
            optionalArgs = { this.requestedDurationSeconds = durationSeconds }
        )

        println("ePSKc Session Activated!")
        println("Status: ${response.status}")
        println("Ephemeral PSKc: ${response.epskc}")
        println("Valid Duration (s): ${response.validDurationSeconds}")

        response
    } catch (e: Exception) {
        println("Failed to activate ePSKc mode: ${e.message}")
        null
    }
}

ePSKc-Modus deaktivieren

suspend fun stopEpskcSession(device: HomeDevice) {
    val gtbrDevice = device.type(GoogleBorderRouterDevice).firstOrNull()
    val mgmtTrait = gtbrDevice?.trait(ThreadNetworkManagement)

    mgmtTrait?.deactivateEpskcMode()
    println("ePSKc mode deactivated.")
}

Ereignisse zur Deaktivierung von ePSKc beobachten

TBRs senden Ereignisse aus, wenn eine ePSKc-Sitzung beendet wird, z. B. weil der Schlüssel verwendet wurde, die Sitzung abgelaufen ist oder sie manuell beendet wurde.

suspend fun observeEpskcEvents(device: HomeDevice) {
    val gtbrDevice = device.type(GoogleBorderRouterDevice).firstOrNull()
    val mgmtTrait = gtbrDevice?.trait(ThreadNetworkManagement)

    mgmtTrait?.epskcModeDeactivatedEventFlow()?.collect { event ->
        println("ePSKc Session Ended. Reason: ${event.reason}")
        when (event.reason?.name) {
            "KeyUsed" -> println("Key was successfully used to commission a device.")
            "Expired" -> println("Session timed out before the key was used.")
            "Cancelled" -> println("Session was manually cancelled.")
        }
    }
}

Thread-Netzwerkmitgliedschaft verwalten

Sie können einen TBR anweisen, einem neuen Thread-Netzwerk beizutreten, indem Sie die aktiven Operational Dataset TLVs angeben, oder ihn anweisen, das aktuelle Netzwerk zu verlassen.

suspend fun joinNetwork(device: HomeDevice, datasetTlvs: ByteArray) {
    val gtbrDevice = device.type(GoogleBorderRouterDevice).firstOrNull()
    val mgmtTrait = gtbrDevice?.trait(ThreadNetworkManagement)

    try {
        val response = mgmtTrait?.joinNetwork(operationalDatasetTlvs = datasetTlvs)
        println("Join network command sent. Status: ${response?.status}")
    } catch (e: Exception) {
        println("Join network failed: ${e.message}")
    }
}

suspend fun leaveNetwork(device: HomeDevice) {
    val gtbrDevice = device.type(GoogleBorderRouterDevice).firstOrNull()
    val mgmtTrait = gtbrDevice?.trait(ThreadNetworkManagement)

    try {
        mgmtTrait?.leaveNetwork()
        println("Leave network command sent successfully.")
    } catch (e: Exception) {
        println("Leave network failed: ${e.message}")
    }
}

Internetzugriff auf Strukturebene konfigurieren

Das ThreadNetworkSettings-Trait ist ein aktualisierbares Trait, das an eine Structure angehängt ist (die ein Zuhause oder ein Gebäude darstellt). So können Entwickler die strukturweite Internetzugriffsrichtlinie für TBRs konfigurieren.

suspend fun updateStructureInternetAccess(structure: Structure, enableInternetAccess: Boolean) {
    // Retrieve the ThreadNetworkSettings trait for the structure
    val settingsTrait = structure.trait(ThreadNetworkSettings).firstOrNull()
    if (settingsTrait == null) {
        println("ThreadNetworkSettings trait not found on structure.")
        return
    }

    val option = if (enableInternetAccess) {
        InternetAccessOption.InternetAccessOptionAll
    } else {
        InternetAccessOption.InternetAccessOptionNone
    }

    try {
        settingsTrait.update {
            setInternetAccessOption(option)
        }
        println("Successfully updated Thread internet access policy to: ${option.name}")
    } catch (e: Exception) {
        println("Failed to update Thread internet access policy: ${e.message}")
    }
}