设备配网 UI 业务包

智能生活设备配网 UI 业务包的功能涵盖了目前常见的 Wi-Fi 设备、Zigbee 设备、蓝牙设备，并且支持二维码扫码的设备，例如 GPRS 和 NB-IoT 设备。业务包主要实现不同类型的设备配网前置操作引导，和具体入网激活。

功能概述

Wi-Fi 设备配网

支持 Wi-Fi 智能设备入网连接云服务，Wi-Fi 设备配网主要有快连模式和热点模式两种，其中智能摄像机（IPC）设备支持扫二维码方式配网。

名词	说明
Wi-Fi 快连配网	又称快连模式。大致流程如下： App 把配网数据包打包到 802.11 数据包的指定区域中，发送到周围环境。 智能设备的 Wi-Fi 模组处于混杂模式下，监听捕获网络中的所有报文。 Wi-Fi 模组按照约定的协议数据格式，解析出 App 发出配网信息包。
Wi-Fi 热点配网	又称热点模式，手机作为 STA（STAtion）连接智能设备的热点，双方建立一个 Socket 连接，通过约定端口交互数据。
IPC 扫码配网	IPC 设备通过扫描 App 上的二维码，来获取配网数据信息。

Zigbee 设备配网

支持 Zigbee 网关和子设备配网：

名词	说明
Zigbee 网关	融合 Zigbee 网络中协调器和 Wi-Fi 功能的设备，负责 Zigbee 网络的组建及数据信息存储。
Zigbee 子设备	Zigbee 网络中的路由或者终端设备，负责数据转发或者终端控制响应。

蓝牙设备配网

涂鸦蓝牙有以下几种技术方案：

名词	说明
蓝牙单点	蓝牙设备与手机一对一连接单点设备（蓝牙或蓝牙 LE）。
蓝牙 Mesh	蓝牙技术联盟发布的蓝牙拓扑通信。
涂鸦 Mesh	涂鸦自研的蓝牙拓扑通信，使用场景与蓝牙 Mesh 产品相同。
双模设备	一些多协议设备也会使用到蓝牙技术，例如同时具备 Wi-Fi 能力和蓝牙能力的 双模设备。

扫码配网设备

扫码配网设备上电后即连接了涂鸦的云服务，App 通过扫描设备上的二维码让设备在云端激活绑定。这个二维码必须是涂鸦支持的二维码规则，具体接入方式可咨询您的涂鸦客户经理。

名词	说明
GPRS 设备	采用 GPRS 通信技术接入网络连接云服务的智能设备。
NB-IoT 设备	采用窄带物联网（NarrowBand-Internet of Things）技术的智能设备。

自动发现配网

融合涂鸦智能通用配网技术实现，为用户提供一套快捷配网的功能。

接入组件

在工程的 Podfile 文件中添加配网业务包组件，并执行 pod update 命令：

source 'https://github.com/tuya/tuya-private-specs.git'
source 'https://cdn.cocoapods.org/'
platform :ios, '11.0'

target 'your_target_name' do
  # 添加配网业务包
  pod 'TuyaSmartActivatorBizBundle'
end

NSLocationAlwaysAndWhenInUseUsageDescription
NSLocationAlwaysUsageDescription
NSLocationWhenInUseUsageDescription

二维码扫码功能需要系统相机权限，需要在 info.plist 中添加以下声明：

NSCameraUsageDescription

自定义配置

蓝牙配网功能

配网业务包支持 Wi-Fi、蓝牙等类型的设备配网，其中蓝牙配网为可选项。

• 如果当前 App 不需要蓝牙配网功能，只需要将自定义 ty_custom_config.json 中的 needBle 属性设置为 false 即可。

• 如果当前 App 需要蓝牙配网功能，首先您需要在项目的 info.plist 文件中添加蓝牙权限的声明，设置 ty_custom_config.json 中的 needBle 属性设置为 true，然后需要在项目中添加以下依赖：

  系统权限

  NSBluetoothAlwaysUsageDescription
  NSBluetoothPeripheralUsageDescription
  

  配置项

  {
  	"config": {
  		"appId": 123,
  		"tyAppKey": "xxxxxxxxxxxx",
  		"appScheme": "tuyaSmart",
  		"hotspotPrefixs": ["SmartLife"],
  		"needBle": true // 设置为 true 则表示支持蓝牙设备的配网
  	},
  "colors":{
  		"themeColor": "#FF5A28",
  	}
  }
  

  依赖

  pod 'TYBLEInterfaceImpl'
  pod 'TYBLEMeshInterfaceImpl'
  pod 'TYBLEHomeManager'
  pod 'TuyaSmartBLEKit'
  pod 'TuyaSmartBLEMeshKit'
  

热点名称设置

• 涂鸦设备热点前缀默认为 SmartLife。

• 若当前设备的热点前缀名称已修改，则需要在 ty_custom_config.json 文件中设置 hotspotPrefixs 属性，设置为当前设备的热点前缀。

  {
  	"config": {
  		"appId": 123,
  		"tyAppKey": "xxxxxxxxxxxx",
  		"appScheme": "tuyaSmart",
  		"hotspotPrefixs": ["SL"], // 表示修改支持的设备热点前缀为 SL
  		"needBle": true
  	},
  "colors":{
  		"themeColor": "#FF5A28",
  	}
  }
  

服务协议

提供服务

配网业务包实现 TYActivatorProtocol 协议以提供服务，在 TYModuleServices 组件中查看 TYActivatorProtocol.h，协议文件内容为：

#ifndef TYActivatorProtocol_h
#define TYActivatorProtocol_h

typedef NS_ENUM(NSUInteger, TYActivatorCompletionNode) {
    TYActivatorCompletionNodeNormal
};

@class TuyaSmartHome;

@protocol TYActivatorProtocol <NSObject>

/**
 * Start config
 * Goto device config list view
 */
- (void)gotoCategoryViewController;

/**
 *  Obtain device information after each device connection
 *  @param node completion node, default TYActivatorCompletionNodeNormal
 *  @param custionJump default false, set true for process not need to jump to de device panel
 */
- (void)activatorCompletion:(TYActivatorCompletionNode)node customJump:(BOOL)customJump completionBlock:(void (^)(NSArray * _Nullable deviceList))callback;

@end
#endif /* TYActivatorProtocol_h */

若您需要自定义配网品类或产品列表返回，则需要实现 TYActivatorExternalExtensionProtocol 提供的协议方法。

TYActivatorExternalExtensionProtocol

/**
 *  Back action form category View Controller
 *  Need to implement when additional operations are needed
 */
- (BOOL)categoryViewControllerCustomBackAction;

依赖服务

配网业务包正常运行需要依赖 TYSmartHomeDataProtocol 这个协议提供的方法，以提供配网所需当前家庭信息。调用业务包之前需要实现该依赖协议。

/**
 获取当前的家庭，当前没有家庭的时候，返回 nil。

 @return TuyaSmartHome
 */
- (TuyaSmartHome *)getCurrentHome;

使用指南

注意事项

• 任何接口调用之前，务必确认用户已登录。

• 调用配网业务包逻辑前，要先实现 TYSmartHomeDataProtocol 中的协议方法getCurrentHome。

  Objective-C 示例

  #import <TuyaSmartBizCore/TuyaSmartBizCore.h>
  #import <TYModuleServices/TYSmartHomeDataProtocol.h>
  
  - (void)initCurrentHome {
  	// 注册要实现的协议
  	[[TuyaSmartBizCore sharedInstance] registerService:@protocol(TYSmartHomeDataProtocol) withInstance:self];
  }
  
  // 实现对应的协议方法
  - (TuyaSmartHome *)getCurrentHome {
  	TuyaSmartHome *home = [TuyaSmartHome homeWithHomeId:@"当前家庭 id"];
  	return home;
  }
  

  Swift 示例

  import TuyaSmartDeviceKit
  
  class TYActivatorTest: NSObject,TYSmartHomeDataProtocol{
  
  	func test() {
  		TuyaSmartBizCore.sharedInstance().registerService(TYSmartHomeDataProtocol.self, withInstance: self)
  	}
  
  	func getCurrentHome() -> TuyaSmartHome! {
  		let home = TuyaSmartHome.init(homeId: 111)
  		return home
  	}
  
  }
  

进入配网

Objective-C 示例

#import <TuyaSmartBizCore/TuyaSmartBizCore.h>
#import <TYModuleServices/TYActivatorProtocol.h>

- (void)gotoDeviceConfig {
    id<TYActivatorProtocol> impl = [[TuyaSmartBizCore sharedInstance] serviceOfProtocol:@protocol(TYActivatorProtocol)];
    [impl gotoCategoryViewController];

    // 获取配网结果
    [impl activatorCompletion:TYActivatorCompletionNodeNormal customJump:NO completionBlock:^(NSArray * _Nullable deviceList) {
        NSLog(@"deviceList: %@",deviceList);
    }];
}

Swift 示例

let impl = TuyaSmartBizCore.sharedInstance().service(of: TYActivatorProtocol.self) as? TYActivatorProtocol
impl?.gotoCategoryViewController()

impl?.activatorCompletion(TYActivatorCompletionNodeNormal, customJump: false, completionBlock: { (evIdList:[Any]?) in
            print(devIdList ?? [])
        })

返回自定义配网品类

Objective-C 示例

#import <TuyaSmartBizCore/TuyaSmartBizCore.h>
#import <TYModuleServices/TYActivatorExternalExtensionProtocol.h>

- (void)initCurrentHome {
    // 注册要实现的协议
    [[TuyaSmartBizCore sharedInstance] registerService:@protocol(TYActivatorExternalExtensionProtocol) withInstance:self];
}

// 实现对应的协议方法
- (BOOL)categoryViewControllerCustomBackAction {
    [self.navigationController popToRootViewControllerAnimated:YES];
    return YES;
}

Swift 示例

class TYActivatorTest: NSObject,TYActivatorExternalExtensionProtocol{

    func test() {
 TuyaSmartBizCore.sharedInstance().registerService(TYActivatorExternalExtensionProtocol.self, withInstance: self)
    }

    func categoryViewControllerCustomBackAction() -> Bool {
        self.navigationController?.popToRootViewController(animated: true)
        return true;
    }

}