راهنمای دستگاه رهیاب مرزی برای Android

توسعه‌دهندگان برنامه Android می‌توانند از Home APIs برای مدیریت Thread Border Router (TBR) استفاده کنند.

GoogleBorderRouterDevice بااستفاده از دو ویژگی اصلی دستگاه پیاده‌سازی می‌شود: ThreadNetworkCapabilities، که ویژگی‌های فقط‌خواندنی برای بررسی ویژگی‌های border router ارائه می‌دهد، و ThreadNetworkManagement، که فرمان‌های چرخه حیات شبکه و هم‌رسانی اطلاعات کاربری را بااستفاده از «کلید پیش‌هم‌رسانی‌شده زودگذر برای کمیسیونر» (ePSKc) مدیریت می‌کند. خط‌مشی‌های دسترسی به اینترنت در سطح ساختار بااستفاده از ویژگی ThreadNetworkSettings مدیریت می‌شود.

همیشه قبل‌از استفاده از هر ویژگی یا تلاش برای به‌روزرسانی مشخصه‌ها، پشتیبانی از مشخصه و فرمان را برای دستگاه بررسی کنید. برای اطلاعات بیشتر، به کنترل دستگاه‌ها در Android مراجعه کنید.

نوع دستگاه Home APIs ویژگی‌ها برنامه نمونه Kotlin مورد استفاده

رهیاب مرزی

GoogleBorderRouterDevice

home.matter.6006.types.0161

ویژگی‌های الزامی
     google ThreadNetworkCapabilities
     google ThreadNetworkManagement

رهیاب مرزی

دریافت اطلاعات پایه درباره دستگاه

   در برنامه نمونه برای Android پیاده‌سازی شده است   

ویژگی BasicInformation شامل اطلاعاتی مثل نام فروشنده، شناسه فروشنده، شناسه محصول، نام محصول (شامل اطلاعات مدل)، و نسخه نرم‌افزار دستگاه است:

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

بررسی قابلیت‌های رهیاب مرزی

می‌توانید قابلیت‌های فقط خواندنی border router را (مانند پشتیبانی ePSKc و پیکربندی تنظیمات «دسترسی به اینترنت») بااستفاده از مشخصه ThreadNetworkCapabilities بررسی کنید.

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

مدیریت کردن هم‌رسانی اطلاعات کاربری Thread‏ (ePSKc)

هم‌رسانی اطلاعات کاربری Thread بااستفاده از «کلید پیش‌هم‌رسانی‌شده زودگذر برای کمیسیونر» (ePSKc) انجام می‌شود. حالت ePSKc گذرکلید موقت و ایمنی تولید می‌کند که دستگاه‌های خارجی یا کمیسیونرها می‌توانند از آن برای دریافت ایمن مجموعه داده‌های شبکه Thread استفاده کنند.

فعال کردن حالت ePSKc

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

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

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

مشاهده رویدادهای غیرفعال‌سازی ePSKc

TBRs emit events when an ePSKc session ends (for example, because the key was used, the session expired, or it was manually cancelled).

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

می‌توانید به TBR فرمان دهید تا با ارائه TLVهای «مجموعه داده‌های عملیاتی» فعال، به شبکه Thread جدیدی بپیوندد، یا به آن فرمان دهید تا شبکه فعلی‌اش را ترک کند.

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

پیکربندی دسترسی به اینترنت در سطح ساختار

مشخصه ThreadNetworkSettings مشخصه‌ای به‌روزرسانی‌شدنی است که به Structure (نشان‌دهنده خانه یا ساختمان) متصل است. به توسعه‌دهندگان اجازه می‌دهد تا خط‌مشی دسترسی به اینترنت در سراسر ساختار را برای TBR پیکربندی کنند.

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