快速集成

更新时间:2023-05-31 03:33:05下载pdf

本文介绍了如何集成涂鸦智慧居住 App SDK 到您的安卓工程中。

准备工作

  • 请确保您已经完成了 准备工作
  • 如果您还未安装 Android Studio,请访问 安卓官网 下载安装。
  • 如需要运行 Demo,请使用最新版 Android Studio(Android Studio Arctic Fox | 2020.3.1 Patch 3 Build #AI-203.7717.56.2031.7784292, built on October 1, 2021 Runtime version: 11.0.10+0-b96-7249189 aarch64),并将 Gradle 版本提升至 7.0 以上。同时 Demo 使用 Jetpack Compose 开发,请参考官方文档配置相关开发环境。

集成 SDK

第一步:创建 Android 工程

在 Android Studio 中新建工程。

第二步:配置 build.gradle 文件

在安卓项目的 build.gradle 文件里,添加集成准备中下载的 dependencies 依赖库。

android {
    defaultConfig {
        ndk {
            abiFilters "armeabi-v7a", "arm64-v8a"
        }
    }
    android.packagingOptions {
        //libc++_shared.so 库依赖重复,用这个方法去重
        pickFirst 'lib/arm64-v8a/libc++_shared.so'
        pickFirst 'lib/armeabi-v7a/libc++_shared.so'
        pickFirst 'lib/x86/libc++_shared.so'
        pickFirst 'lib/x86_64/libc++_shared.so'
    }
}
dependencies {
    implementation 'com.alibaba:fastjson:1.1.67.android'
    implementation 'com.tuya.smart:smartResidenceSDK:1.2.0'
    api 'com.tuya.smart:tuyasmart:3.34.5'

}

在根目录的 build.gradle 文件,中增加 SDK Maven 仓库地址,进行仓库配置。

repositories {
    maven {url "https://maven-other.tuya.com/repository/maven-releases/"}
}

第三步:集成安全图片和设置 Appkey 和 AppSecret

  1. 涂鸦 IoT 开发平台,找到您创建的 SDK。

  2. 获取密钥 中,单击 下载安全图片 > 安全图片下载 下载安全图片。

    快速集成
  3. 将下载的安全图片命名为 t_s.bmp,放置到工程目录的 assets 文件夹下。

    快速集成
  4. 返回安卓项目,在 AndroidManifest.xml 文件里配置 appkey 和 appSecret,在配置相应的权限等。

    <meta-data
    android:name="TUYA_SMART_APPKEY"
    android:value="应用 Appkey" />
    <meta-data
    android:name="TUYA_SMART_SECRET"
    android:value="应用密钥 AppSecret" />
    

第四步:混淆配置

proguard-rules.pro 文件配置相应混淆配置。

#fastJson
-keep class com.alibaba.fastjson.**{*;}
-dontwarn com.alibaba.fastjson.**

#mqtt
-keep class com.tuya.smart.mqttclient.mqttv3.** { *; }
-dontwarn com.tuya.smart.mqttclient.mqttv3.**

#OkHttp3
-keep class okhttp3.** { *; }
-keep interface okhttp3.** { *; }
-dontwarn okhttp3.**

-keep class okio.** { *; }
-dontwarn okio.**

-keep class com.tuya.**{*;}
-dontwarn com.tuya.**

第五步:初始化 SDK

您需要在 Application 的主线程中初始化 SDK,确保所有进程都能初始化。示例代码如下:

public class TuyaSmartApp extends Application {
    @Override
    public void onCreate() {
        super.onCreate();
        TuyaSdk.init(this);
    }
}

appKeyappSecret 可以配置在 AndroidManifest.xml 文件里,也可以在初始化代码里初始化。

TuyaSdk.init(Application application, String appkey, String appSerect)

第六步:开启或关闭日志

  • 在 debug 模式下,您可以开启 SDK 的日志开关,查看更多的日志信息,帮助您快速定位问题。

  • 在 release 模式下,建议关闭日志开关。

    TuyaSdk.setDebugMode(true);
    

运行 Demo App

在完成快速集成 SDK 后,您将获取到 SDK 使用的 AppKeyAppSecret、安全图片信息。集成 SDK 时请确认 AppKeyAppSecret、安全图片是否与平台上的信息一致,任意一个不匹配会导致 SDK 无法使用。详细操作,请参考 第三步:集成安全图片和设置 Appkey 和 AppSecret

Demo App 演示了 App SDK 的开发流程。在开发 App 之前,建议您先按照以下流程完成 Demo App 的操作。

Demo App 介绍

Demo App 主要包括:

  • 站点管理功能
  • 通行管理功能
  • 个人信息展示

Demo 示意图

快速集成

更多详情,请参考 https://github.com/tuya/tuya-residence-android-sdk-sample Github 项目。

运行 Demo

  1. 替换 app 目录下 build.gradle 文件中的 applicationId 为您的应用包名。

  2. 确认您已经完成了 第三步:集成安全图片和设置 Appkey 和 AppSecret

  3. 然后单击运行,运行 Demo。

故障排查:API 接口请求提示签名错误

  • 问题现象:运行 Demo 时提示以下错误:

    {
        "success": false,
        "errorCode" : "SING_VALIDATE_FALED",
        "status" : "error",
        "errorMsg" : "Permission Verification Failed",
        "t" : 1583208740059
    }
    
  • 解决方法

    • 请检查您的 AppKey、AppSecret 和 安全图片是否正确配置。
    • 安全图片是否放在正确目录,文件名是否为 t_s.bmp