1. Device Detail BizBundle

1.1. Features

• Device information editing (device avatar, room, name)
• Device information query (ID, signal, etc.)
• Alternate network Settings
• Offline reminder function
• Remove device
• Frequently asked questions and feedback (need access to help Center business package)
• Check firmware upgrade (OTA business package is required)

1.2. Biz Bundle integration

1.2.1. Pod integration

Add the business package component to the project's 'Podfile' file and execute the 'pod update' command

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

target 'your_target_name' do
 # Device Detail BizBundle
  pod 'TuyaSmartDeviceDetailBizBundle', '~> 3.22.0'
end

1.2.2. Permission statement

Device business package device avatar upload, use of photo albums and cameras, which will involve some Apple's privacy permission statement.

-Need to add the following permission statement in the project's info.plist:

<!-- Album -->
<key>NSPhotoLibraryUsageDescription</key>
<string>App needs your consent to access the album</string>
<!-- Camera -->
<key>NSCameraUsageDescription</key>
<string>App needs your consent to access the camera</string>

1.2.3. Configuration file

1. Create a new configList.json in the main project (the file already exists, no need to create it)

2. Add in configList.json key: deviceDetail value: the following array

    [
        {
            "type":"header"
        },
        {
            "type": "device_info"
        },
        {
            "type": "net_setting"
        },
        {
            "type":"section_off_line_warn"
        },
        {
            "type":"off_line_warn"
        },
        {
            "type":"section_other"
        },
        {
            "type":"help_and_feedback"
        },
        {
          "type":"check_device_network"
         },
        {
            "type":"check_firmware_update"
        },
        {
            "type":"empty",
            "height":16
        },
        {
            "type":"footer"
        }
    ]
   

3. The content of the configList.json configuration file is roughly as follows

   {
   "deviceDetail": [{"type":"header"} ],
   "Other configuration page key":[]
   }
   

1. Customize device details Note that the order of the items in the deviceDetail array affects the display order of the items on the device detail page. If the item is removed, the device details page sub-function will also be removed accordingly.

1.2.4. Service Agreement

Dependent service (need to be implemented)

1.TYSmartHomeDataProtocol

/**
 To use this API to get the current family, be sure to use the protocol’s ‘updateCurrentHomeId:’ Api when updating the current family id.
 Get the current family, if there is no family, return nil.

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

Objective-C example

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


-(void)initCurrentHome {
    // Register the protocol to be implemented
    [[TuyaSmartBizCore sharedInstance] registerService:@protocol(TYSmartHomeDataProtocol) withInstance:self];
}

// Implement the corresponding protocol method
-(TuyaSmartHome *)getCurrentHome {
    TuyaSmartHome *home = [TuyaSmartHome homeWithHomeId:@"current family id"];
    return home;
}

Swfit example

import TuyaSmartDeviceKit

class TYMessageCenterTest: NSObject,TYSmartHomeDataProtocol{


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

    func getCurrentHome() -> TuyaSmartHome! {
        let home = TuyaSmartHome.init(homeId: 111)
        return home
    }

}

1.2.5. Service Protocol

Dependent service (need to be implemented)

TYSmartHomeDataProtocol

/**
 To use this API to get the current family, be sure to use the protocol’s ‘updateCurrentHomeId:’ Api when updating the current family id.
 Get the current family, if there is no family, return nil.

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

Objective-C example

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


-(void)initCurrentHome {
    // Register the protocol to be implemented
    [[TuyaSmartBizCore sharedInstance] registerService:@protocol(TYSmartHomeDataProtocol) withInstance:self];
}

// Implement the corresponding protocol method
-(TuyaSmartHome *)getCurrentHome {
    TuyaSmartHome *home = [TuyaSmartHome homeWithHomeId:@"current family id"];
    return home;
}

Swfit example

import TuyaSmartDeviceKit

class TYMessageCenterTest: NSObject,TYSmartHomeDataProtocol{


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

    func getCurrentHome() -> TuyaSmartHome! {
        let home = TuyaSmartHome.init(homeId: 111)
        return home
    }

}

Optional function implementation

1. OTA function

Access required: Access OTA Service Package

2. FAQ and feedback function

Access required: Access Help Center Business Package

1.2.6. Provide service (method call)

oc sample code

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

 id<TYDeviceDetailProtocol> impl = [[TuyaSmartBizCore sharedInstance] serviceOfProtocol:@protocol(TYDeviceDetailProtocol)];

 //Jump to the device network detection page
 [impl gotoDeviceDetailNetworkViewControllerWithDeviceId:@"device id"];


  // Jump to the device details page, use push

  //If it is a device, new TuyaSmartDevice
 TuyaSmartDevice * device = [TuyaSmartDevice deviceWithDeviceId:@"device id"]
  [impl gotoDeviceDetailDetailViewControllerWithDevice: device.deviceModel group: nil];
  //If it is a group, new TuyaSmartGroup
 TuyaSmartGroup * group = [TuyaSmartGroup groupWithGroupId:@"group id"]
   [impl gotoDeviceDetailDetailViewControllerWithDevice: nil group: group.deviceModel];

swift sample code

let impl = TuyaSmartBizCore.sharedInstance().service(of: TYDeviceDetailProtocol.self) as? TYDeviceDetailProtocol
//Jump to the device network detection page
impl?.gotoDeviceDetailNetworkViewController(withDeviceId: "Device id")

  // Jump to the device details page, use push

  //If it is a device, new TuyaSmartDevice
  let device = TuyaSmartDevice.init(deviceId: "vdevo160888044089994")
  impl?.gotoDeviceDetailDetailViewController(withDevice: device?.deviceModel, group: nil)
  //If it is a group, new TuyaSmartGroup
  let group = TuyaSmartGroup.init(groupId: "group id")
  impl?.gotoDeviceDetailDetailViewController(withDevice: nil, group: group?.groupModel)

1.2.7. 6. Custom sub-function

1. Configure configList.json

Insert a custom type in the deviceDetail of the configList.json file. Note that the type value must start with "c_" For example: insert "c_test_insert", "c_test_async_insert"

 {"deviceDetail": [
     {
            "type":"c_test_insert"
        },
        {
            "type":"c_test_async_insert"
        },
        {
            "type":"header"
        },
        {
            "type": "device_info"
        },
        {
            "type": "net_setting"
        },
        {
            "type":"section_off_line_warn"
        },
        {
            "type":"off_line_warn"
        },
        {
            "type":"section_other"
        },
        {
            "type":"help_and_feedback"
        },
        {
            "type":"check_device_network"
        },
        {
            "type":"check_firmware_update"
        },
        {
            "type":"empty",
            "height":16
        },
        {
            "type":"footer"
        }
    ]
  ],}

2. Return item data

Interface description: return item data synchronously

  /// Settings-"Synchronous processing of item insertion callbacks. insertDevMenuItemBlock will call back when the device details are refreshed
-(void)insertDevMenuItem:(InsertDevMenuItemBlock) insertDevMenuItemBlock;

//@param type configList.json added type
//@param device device model
//@param group group model. According to whether the group is nil, to judge the device or the group
//@return An object that complies with the TYDeviceDetailCustomMenuModel protocol. Return nil, the item of this type will not be displayed
typedef id<TYDeviceDetailCustomMenuModel> _Nullable (^InsertDevMenuItemBlock)(NSString* _Nonnull type,
                                                                           TuyaSmartDeviceModel* _Nullable device,
                                                                           TuyaSmartGroupModel* _Nullable group);

Interface description: Asynchronous callback item data

  /// Settings-"Asynchronous processing of item insertion callbacks, insertDevMenuItemAsyncBlock will call back when the device details are refreshed
-(void)insertDevMenuItemAsync:(InsertDevMenuItemAsyncBlock) insertDevMenuItemAsyncBlock;

 //Process item insertion asynchronously. When the asynchronous operation ends, call complete(id<TYDeviceDetailCustomMenuMode>), call back the data to the device details, and refresh the list.
typedef void (^InsertDevMenuItemAsyncBlock)(NSString* _Nonnull type,
                                            TuyaSmartDeviceModel* _Nullable device,
                                            TuyaSmartGroupModel* _Nullable group,
                                            InsertDevMenuItemComplete _Nonnull complete);

Sample Code

First step: Create a new Model class first, comply with the TYDeviceDetailCustomMenuModel protocol

oc

  //Customize a class to comply with the TYDeviceDetailCustomMenuModel protocol
 @interface CustomMenuModel: NSObject<TYDeviceDetailCustomMenuModel>
///title
@property (nonatomic,copy) NSString *title;
///Subtitle
@property (nonatomic,copy) NSString *detail;
@end

@implementation CustomMenuModel
@end

swift

class CustomMenuModel: NSObject, TYDeviceDetailCustomMenuModel{
    var title: String?
    var detail: String?
}

Step 2: Set the data callback block

oc

   id<TYDeviceDetailProtocol> impl = [[TuyaSmartBizCore sharedInstance] serviceOfProtocol:@protocol(TYDeviceDetailProtocol)];

        [impl insertDevMenuItem:^ id<TYDeviceDetailCustomMenuModel> (NSString * _Nonnull type, TuyaSmartDeviceModel * _Nonnull device, TuyaSmartGroupModel * _Nonnull group) {
            if ([type isEqualToString:@"c_test_insert"]) {
                CustomMenuModel *model = [CustomMenuModel new];
                if (group) {//Judging whether the device is a group or not according to whether the group is nil
                    model.title = type;
                    model.detail = @"group";
                }else{
                    model.title = type;
                    model.detail = @"device";
                }
                return model;
            }
            return nil;
        }];

        [impl insertDevMenuItemAsync:^(NSString * _Nonnull type, TuyaSmartDeviceModel * _Nonnull device, TuyaSmartGroupModel * _Nonnull group, InsertDevMenuItemComplete _Nonnull complete) {
            if ([type isEqualToString:@"c_test_async_insert"]) {
            //Time-consuming operation
            dispatch_after(dispatch_time(DISPATCH_TIME_NOW, (int64_t)(3 * NSEC_PER_SEC)), dispatch_get_main_queue(), ^{
                CustomMenuModel *model = [CustomMenuModel new];
                if (group) {//Judging whether the device is a group or not according to whether the group is nil
                    model.title = type;
                    model.detail = @"group";
                }else{
                    model.title = type;
                    model.detail = @"device";
                }
                complete(model);
            });
            }

        }];

swift

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

    impl?.insertDevMenuItem({ (type, deviceModel, groupModel) -> TYDeviceDetailCustomMenuModel? in
            if type == "c_test_insert" {//According to whether the group is nil, to determine whether the device or the group
                let model = CustomMenuModel.init()
                if groupModel != nil {
                    model.title = type
                    model.detail = "group"
                }else{
                    model.title = type
                    model.detail = "device"
                }
                return model;
            }
            return nil;
        })

impl?.insertDevMenuItemAsync({ (type, deviceModel, groupModel, complete) in
            if type == "c_test_async_insert" {
                //Time-consuming operation
                DispatchQueue.main.asyncAfter(deadline: .now() + 3) {
                    let model = CustomMenuModel.init()
                    if groupModel != nil {
                        model.title = type
                        model.detail = "group"
                    }else{
                        model.title = type
                        model.detail = "device"
                    }
                    complete(model);
                }
            }
        });

3. Insert item click event processing

oc sample code

      id<TYDeviceDetailProtocol> impl = [[TuyaSmartBizCore sharedInstance] serviceOfProtocol:@protocol(TYDeviceDetailProtocol)];
        [impl clickMenuItem: ^(NSString * _Nonnull type, TuyaSmartDeviceModel * _Nonnull device, TuyaSmartGroupModel * _Nonnull group) {
            NSLog(@"clickItem: type:%@",type);
        }];

swift sample code

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

  impl?.clickMenuItem({ (type, deviceModel, groupModel) in
            print("clickItem: type:"+type);
    })