配网SDK(含UI)集成

一、概述

本文主要介绍配网 SDK 支持的配网类型、依赖组成,以及如何集成配网 SDK(含 UI)。

二、前提条件

  1. 确认完成准备工作
  2. 确认完成环境搭建

三、功能特性

3.1 主体功能

配网 SDK(含 UI)主要提供将 Aqara 设备配置上路由器并完成云端激活的能力,配网流程使用 Aqara 设计风格的 UI 页面呈现。

3.2 支持入网类型

入网类型 是否支持 说明
MagicPair配网 支持 详情查看MagicPair配网
Wi-Fi Ap配网 支持 详情查看Wi-Fi配网
以太网有线配网 支持 详情查看以太网有线配网
蓝牙配网 支持 详情查看蓝牙配网
Zigbee子设备配网 不支持 第三方 App 使用接口实现,详情查看Zigbee子设备配网
Matter 配网 不支持 请使用Matter垂直品类SDK,详情查看Matter垂直品类
摄像机配网 不支持 请使用摄像机垂直品类SDK,详情查看摄像机垂直品类
门锁配网 不支持 请使用门锁垂直品类SDK,详情查看门锁垂直品类

3.3 支持的设备清单

请查看配网SDK支持设备清单

四、集成

4.1 打开 Android Studio 项目

4.2 编辑app目录下build.gradle

在完成环境搭建后,补充配网相关依赖:

dependencies {
    // Core / CommonUI(环境搭建中已引入)
    implementation 'com.lumi.external:core:2.2.62'
    implementation 'com.lumi.commonui:ui:1.5.33'

    // 配网 SDK(含 UI)
    implementation 'com.lumi.module.access:access:3.5.82'
    implementation 'com.lumi.module.smart_connect:connect:4.0.37'
    implementation 'com.lumi.module:scanQR:1.0.14'
    implementation 'com.lumi.module:devicekit:1.0.23'
    implementation 'com.lumi.api:thread:1.0.21'
}

若同时集成扫码与红外等模块,可能出现 zxing 冲突,可按需排除:

configurations.configureEach {
    exclude group: 'com.google.zxing', module: 'core'
}

4.3 初始化

参见环境搭建-统一初始化

配网前请确保已正确配置:

  • positionInfo(家庭 / 位置 ID)
  • coapServer(与当前服务地区匹配的设备入网域名)
  • country / area / supportDeviceArea(建议先确定 country 再反查,参见地区对照表

五、使用

5.1 跳转到指定设备配网页

统一初始化完成后,可通过 LumiAccessSDKManager 拉起指定设备型号的配网 UI:

Kotlin

LumiAccessSDKManager.getInstance().gotoAccessConfigModule(
    this,
    "lumi.gateway.agl008", // deviceModel,参见支持设备清单
    object : LumiResultCallBack {
        override fun fail(errorCode: Int?, errorMessage: String?) {
            // 配网失败
        }

        override fun success(activity: WeakReference<Activity>, message: String?) {
            // 配网成功。成功后可在合适时机关闭配网页:
            activity.get()?.finish()
        }
    }
)

Java

LumiAccessSDKManager.getInstance().gotoAccessConfigModule(
        this,
        "lumi.gateway.agl008",
        new LumiResultCallBack() {
            @Override
            public void fail(@Nullable Integer errorCode, @Nullable String errorMessage) {
                // 配网失败
            }

            @Override
            public void success(@NonNull WeakReference<Activity> activity, @Nullable String message) {
                // 配网成功。成功后可在合适时机关闭配网页:
                Activity page = activity.get();
                if (page != null) {
                    page.finish();
                }
            }
        }
);

参数说明

字段 数据类型 说明 获取渠道
deviceModel String 设备模型值 参见配网SDK支持设备清单
lumi LogoCopyright © 2023 深圳绿米联创科技有限公司 all right reserved,powered by Gitbook文档修改时间: 2026-08-11 17:06:15

results matching ""

    No results matching ""