Door Lock SDK Integration

1. Overview

This article mainly introduces how iOS integrates the door lock SDK.

2. Preconditions

1. Confirm completion of Preparation and Environment Build
2. This article defaults that you have installed Xcode 14 or above, and CocoaPods 1.9.0 or above;

3. Features

3.1 Main function

1. Support Aqara door lock network access.
2. Support Aqara door lock control.

3.2 SDK Size

Note: The above are reference increments after integrating the SDK. The actual increment depends on how much overlap exists with the host app's existing dependencies.

3.3 Support equipment category

See Equipment List

4. Integration

4.1 iOS SDK Directory Structure

LMRnFramework/
├── LMRnFramework.framework      # Door lock RN bridge layer
├── AHRNRuntime.framework        # RN runtime static library
├── hermes.xcframework           # Hermes engine
├── Resources/
│   └── PKGResource/             # Door lock RN plugin resources
└── LMRnFramework.podspec

Contents include:

1. Aqara bridge layer: LMRnFramework.framework
2. RN runtime: AHRNRuntime.framework, hermes.xcframework (provided as static libraries — no need to integrate React Native source code)
3. RN plugin package: Resources/PKGResource directory

4.2 How to use

The door lock SDK is provided via LMRnFramework, with the RN runtime packaged in AHRNRuntime.framework. Local CocoaPods integration is recommended.

Important change: The legacy approach of manually integrating React Native source pods such as React and React-Core is deprecated. Do not add those dependencies.

1. Permission Profile

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

1. NSLocalNetworkUsageDescription — local network lookup permission
2. NSLocationWhenInUseUsageDescription — location permission (required to obtain WiFi name on iOS 13+; iOS 14 requires precise location. If WiFi name still cannot be obtained, handle manually such as prompting user input)
3. NSBluetoothAlwaysUsageDescription — Bluetooth permission

You can quickly add the following configuration in the host project's Info.plist:

<key>NSBonjourServices</key>
<array>
    <string>_aqara._tcp.</string>
</array>
<key>NSLocalNetworkUsageDescription</key>
<string>Need to use local network to discover device information on LAN</string>
<key>NSBluetoothAlwaysUsageDescription</key>
<string>Allow this app to use bluetooth connection</string>

2. Copy SDK

Copy the LMRnFramework folder into your project's AqaraFrameworks directory (same structure as the Demo project).

3. Configure Podfile

The door lock SDK depends on basic libraries. Ensure LMFramework, LMCommonUISwift, LMSwiftCore, and other base SDKs are integrated per Environment Build.

Add the door lock SDK dependency in your Podfile:

pod 'LMRnFramework', :path => './AqaraFrameworks/LMRnFramework'

LMRnFramework automatically brings in the following via its podspec — no manual addition needed:

Run pod install to complete the door lock SDK integration.

5. SDK Usage

For how to use the SDK, please refer to the next document: Door lock SDK usage (iOS).