IOS Device Pairing SDK (HomeKit Certified Devices)

This SDK includes the logical part and UI interface of Aqara device network distribution; the iOS version that the SDK depends on cannot be lower than 11.0
Compiler environment: XCode14.0 or above
Language: Object-C

Integrated SDK

1.Environment Build

The Device Pairing SDK needs to use the permission functions of HomeKit and Wi-Fi, and the host project needs to add the following Capability:

1. Homeikit
2. Wireless Accessory Configuration

2.Permission Profile

The SDK needs to apply to iOS for the following system permissions:

1.NSHomeKitUsageDescription Access to HomeKit 2.NSCameraUsageDescription Camera access permission (scan the QR code on the device for network configuration) 3.NSLocalNetworkUsageDescription Local network search authority (Device Pairing by LAN) 4.NSLocationWhenInUseUsageDescription Use geographic location permission (mobile phone obtains WiFi name, iOS 13 needs to confirm that the App has enabled the location permission. iOS 14 needs to confirm that the App has enabled the precise location permission. If the WiFi name is still not obtained after the above configuration, the developer needs to deal with it separately, such as Manually enter the WiFi name).

  1. NSBluetoothAlwaysUsageDescription Obtain Bluetooth permission (Device Pairing by Bluetooth)
  2. NSBonjourServicesUse the mDNS service to discover Greenmi devices, and set the service name "_aqara._tcp."

You can quickly add the following configuration in the info.plist file of the host project:

<plist version="1.0">
   <string>Allows the app to use the camera to add accessories</string>
   <string>Allow this App to control HomeKit-enabled devices</string>
   <string>Need to use local network to discover device information on LAN</string>
   <string>Need your location information to provide better service</string>
   <string>Allow this app to use bluetooth connection</string>

4.Import SDK

The following SDK needs to be imported in the host project:

  1. LMAppleHomeConnect.framework HomeKit-related API packaging SDK
  2. LMFramework.framework Basic SDK, basic configuration of Aqara, macro definition and encapsulation of general logic


  1. LMFramework.bundle Aqara multilingual files

5.Sequence Diagram and Description

HomeKit device pairing flow chart

Reference header file #import <LMAppleHomeConnect/LMAppleHomeConnect.h>

Get HomeKit permissions at the right time:

- (void)requestHomeKitAuthroization:(void (^)(NSError *error))completion;
Interface 1
- (void)getHomekitHomes:(void (^)(NSArray<HMHome *> * _Nullable homeList, NSError *error))compleiton;
Return value Description
homeList HomeKit Home List

This interface will return the home information list under HomeKit in the closure. If the data returned by the interface is empty, it may be due to the following reasons:

  1. Check if the AppleID has enabled keychain permissions.
  2. Open Apple's Home APP to see if there is family data.
Interface 2
- (void)addAccessoryWithHome:(HMHome *)home settingDoneCompletion:(void (^)(NSArray <HMAccessory *> *accessoryList, NSError *error))completion;
Parameter Description
home The Home object of HomeKit

Calling this interface will pop up the HomeKit configuration window:


After the method closure returns HMAccessory object data, initiate a bindkey request to AIoT.

Request 3

Obtain bindkey request from AIoT:


Request example:

 "positionId":  "real2.550691449629310976",
 "appUrl": ""

Return data: |Name|Type |Remark| |----|----|---| |bindKey|string|Network access using bindKey| |controlUnitId|string|Parameters returned by the miot device connected to the network|

Return example:

    "code": 0,
    "requestId": "",
    "message": "Success",
    "result": {
        "bindKey": "HVFLFgHgPy56X"

**For details, please refer to the Aqara Developer Platform Interface Documentation.

Interface 4
- (void)bindAccessory:(HMAccessory *)accessory countryDomain:(NSString *)countryDomain bindKey:(NSString *)bindKey compeltion:(void (^)(NSError *error))completion;
Parameter Description
accessory HomeKit's HMAccessory object
countryDomain CoAPServer address
bindKey The binding key requested from the private cloud
Request 5

Polling the request result to AIoT:


Request data

Parameter name Is it necessary Remark
bindKey No BindKey Random code (priority parameter, choose one of the two)
did No Device id

Return data

Name Type Is it necessary Defaults Remark
code integer Must 0-success, 1-binding, 2-illegal 616 The device model does not support (can be used for cross-order reminder)

Return example:

    "code": 0,
    "requestId": "",
    "message": "Success",
    "result": {
        "code": 0

For details, please refer to the Aqara Developer Platform Interface Documentation.

Copyright © 2023 Lumi United Technology Co., Ltd. all right reserved,powered by GitbookFile Modify: 2024-04-24 15:18:24

results matching ""

    No results matching ""