Dashboard Card SDK Integration

Revision History

1. Overview

This document describes how to integrate the Dashboard Card SDK and quickly enable the home homepage, room layout, and card rendering capabilities in the host project.

2. Prerequisites

1. Complete Preparation
2. Complete Environment Build

3. Features

3.1 Core Capabilities

The Dashboard Card SDK provides Aqara-style UI components and allows third-party apps to directly access the following capabilities:

1. Home, room, and device card list and layout capabilities
2. Aggregated display of scenes and service entries
3. UI extension capabilities such as multilingual support and theming
4. Integration with the host routing system through ARouter

3.2 SDK Size

Note: 48MB is the estimated maximum incremental size when the host app and SDK dependencies do not overlap at all. In practice, the actual increase is usually smaller.

3.3 Supported Scope

See the Dashboard Card List for details.

4. Integration

4.1 Open the Android Studio Project

Use Android Studio to open the project that will integrate the SDK.

4.2 Edit build.gradle in the app Module

dependencies {
    implementation "com.lumi.external:core:2.2.3"

    // Home Configuration SDK
    implementation "com.lumi.module.homeconfiguration:home:6.1.5"

    // Home Card SDK
    implementation "com.lumi.module.homecard:card:6.1.4"

    // Position SDK for home switching
    implementation "com.lumi.module.position:position:3.1.40"
}

4.3 Initialization

Refer to Environment Build and make sure that:

1. Basic libraries such as external core have been initialized
2. ARouter, account, and multilingual dependencies are ready
3. Business login and device data preparation are completed

5. Code Obfuscation

# If ARouter rules have not been configured globally, you can use the following rules
-keep class com.alibaba.android.arouter.routes.** { *; }
-keep interface com.alibaba.android.arouter.facade.template.IProvider
-keep class * implements com.alibaba.android.arouter.facade.template.IProvider { *; }
-keep class * implements com.alibaba.android.arouter.facade.template.ISyringe { *; }

If the project already has a unified obfuscation configuration, only the Dashboard Card related SDK rules need to be added.