1. Device Configuration BizBundle

1.1. Features

The business functions cover all the Wi-Fi devices, ZigBee devices, Bluetooth devices, QR code scanning devices (such as GPRS & NB-IOT devices) and other types of devices currently equipped with TuyaSmart APP.

1.1.1. 1. Wi-Fi Devices

Support Wi-Fi smart devices to connect to the cloud service. The Wi-Fi device mainly includes EZ mode and AP mode, among which IPC device also supports the QR code scanning mode

1.1.2. 2. ZigBee Devices

Support ZigBee gateway and sub-device network Configuration

1.1.3. 3. Bluetooth Devices

Tuya Bluetooth has three technical lines, including SingleBLE, SigMesh, TuyaMesh, and dual-mode devices

1.1.4. 4. Scanning Code Network Configuration Devices

This type of device is connected to the Tuya cloud service after being powered on. APP scans the QR code on the device (must be the QR code rule supported by the Tuya cloud service, and supports specific firmware access methods. Consult Tuya Technology-related business and project managers ) and enables device to activate on the Tuya Cloud

1.1.5. 5. Automatic Network Discovery

Integrated with Tuya universal Configuration network technology to provide users with a set of fast Configuration network functions

1.2. Access

Add the bizbundle in the Podfile file, then execute pod update command

source "https://github.com/TuyaInc/TuyaPublicSpecs.git"
source 'https://cdn.cocoapods.org/'

target 'your_target_name' do
  # add device config bizbundle
  pod 'TuyaSmartActivatorBizBundle'
end

Note

The Wi-Fi device Activation process needs to obtain the ssid of the current Wi-Fi , and the project needs to add the following permission statement in info.plist. Then create a CLLocationManager object, and call the requestWhenInUseAuthorization method

NSLocationAlwaysAndWhenInUseUsageDescription
NSLocationAlwaysUsageDescription
NSLocationWhenInUseUsageDescription

The QR code scanning function requires system camera permissions, and the following permission statement needs to be added to info.plist.

NSCameraUsageDescription

1.3. Custom Config

1.3.1. 1. Bluetooth Function

BizBundle supports Wi-Fi, Bluetooth and other types of devices to connect to the network. Set needBle false，when not needed

If you need the Bluetooth function, you need to add the Bluetooth permission declaration in the project's info.Plist file, set the needBle property in ty_custom_config.json to true, and then add the following dependencies to the project:

Permission statement

NSBluetoothAlwaysUsageDescription
NSBluetoothPeripheralUsageDescription

Configuration

{
    "config": {
        "appId": 123,    
        "tyAppKey": "xxxxxxxxxxxx", 
        "appScheme": "tuyaSmart",
        "hotspotPrefixs": ["SmartLife"], 
        "needBle": true // true ,need bluetooth
    },
   "colors":{
        "themeColor": "#FF5A28", 
    }
}

Dependencies

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

1.3.2. 2. Custom Device Hotspot Name Prefix

Tuya Device hotspot name prefix defaults to SmartLife. Can custom hotspot name prefix as your device's through setting hotspotPrefixs in ty_custom_config.json

{
    "config": {
        "appId": 123,    
        "tyAppKey": "xxxxxxxxxxxx", 
        "appScheme": "tuyaSmart",
        "hotspotPrefixs": ["SL"], //  device hotspots name prefix 
        "needBle": true
    },
   "colors":{
        "themeColor": "#FF5A28", 
    }
}

1.4. Service Protocol

1.4.1. Provide Service

BizBundle provide services of TYActivatorProtocol.h in TYModuleServices component as follows:

#ifndef TYActivatorProtocol_h
#define TYActivatorProtocol_h

@class TuyaSmartHome;

@protocol TYActivatorProtocol <NSObject>

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

/**
 *  Obtain device information after each device connection
 */
- (void)getActivatedDeviceListWithCompletion:(void (^)(NSArray *_Nullable devIdList))completion;

@end
#endif /* TYActivatorProtocol_h */

Custom the return operation form device config list View , you need to implement the protocol method provided by TYActivatorExternalExtensionProtocol

TYActivatorExternalExtensionProtocol

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

1.4.2. Dependent Services

BizBundle running depends on the protocol method provided by TYSmartHomeDataProtocol. Before calling the BizBundle method, the following protocol needs to be implemented

TYSmartHomeDataProtocol

Set current home infomation by implementing the following method.

/**
 Get current home info 

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

1.5. Guidance

1.5.1. Attention

1、Make sure that the user is logged in before using any interface

2、Before using bizbundle，must implement the protocol method getCurrentHome in TYSmartHomeDataProtocol

Objective-C

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


- (void)initCurrentHome {
    // register service
    [[TuyaSmartBizCore sharedInstance] registerService:@protocol(TYSmartHomeDataProtocol) withInstance:self];
}

// implementation
- (TuyaSmartHome *)getCurrentHome {
    TuyaSmartHome *home = [TuyaSmartHome homeWithHomeId:@"current home 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
    }

}

1.5.2. Start Config

Objective-C

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


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

    // get result
    [impl activatorCompletion:TYActivatorCompletionNodeNormal customJump:NO completionBlock:^(NSArray * _Nullable deviceList) {
        NSLog(@"deviceList: %@",deviceList);
    }];
}

Swift

let homeImpl = TuyaSmartBizCore.sharedInstance().service(of: TYActivatorProtocol.self) as? TYActivatorProtocol
homeImpl?.goActivatorRootView()

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

1.5.3. Custom the Return Operation Form Category View Controller

Objective-C

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


- (void)initCurrentHome {
  // register service
    [[TuyaSmartBizCore sharedInstance] registerService:@protocol(TYActivatorExternalExtensionProtocol) withInstance:self];
}

// implementation
- (BOOL)categoryViewControllerCustomBackAction {
    [self.navigationController popToRootViewControllerAnimated:YES];
    return YES;
}

Swift

class TYActivatorTest: NSObject,TYActivatorExternalExtensionProtocol{

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

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

}

1.6. Change Log

• 2020.07.02 Add custom return method form device config list View