Device Pairing (iOS)

The Commercial Lighting App SDK empowers smart devices to be paired through routers or gateways. The typical pairing mode is Wi-Fi Easy Connect (EZ). In this mode, the SDK gets the pairing token from the cloud and enables the app to broadcast the pairing information. The router ID, password, and pairing token are published. Then, the smart device receives the pairing information and starts the activation process. The activated device is connected to both the app and the cloud. Now, you have kicked off your journey with smart control in the cloud.

Functional description

Device pairing supports the following features:

• Wi-Fi device pairing
  • Wi-Fi Easy Connect mode, also known as the EZ mode
  • Access point (AP), also known as the hotspot mode
• Wired device pairing
• Sub-device pairing

Terms

The following table lists specific terms and definitions that are used in this topic. For more information, see Glossary.

Functional description

Version compatibility

iOS 14

Starting from iOS 14, when users perform device pairing or control over a local area network (LAN), the local network privacy setting dialog box is triggered.

• The app can send data to the LAN only after users tap OK.
• Otherwise, if users tap Don’t Allow, the app cannot access the LAN.

Currently, Apple does not provide APIs to process this privacy setting. We recommend that you guide users to allow the app to access LAN data when features that require LAN connection cannot work. Specifically, go to Settings, choose Privacy > Local Network, and then allow the app to access the LAN.

iOS 13

Starting from iOS 13, if users do not allow the app to access location data, when the Wi-Fi feature is enabled, [ThingSmartActivator currentWifiSSID] cannot get a valid Wi-Fi service set identifier (SSID) or basic service set identifier (BSSID). In this case, iOS returns the following default values:

• SSID: WLAN or Wi-Fi. WLAN is returned for users in mainland China.
• BSSID: "00:00:00:00:00:00"

If the Wi-Fi feature cannot be used as expected, the following troubleshooting methods are recommended:

1. Check whether the app can access location data.
2. If the returned BSSID is 00:00:00:00:00:00, it is the default system value. Then, you can guide users to manually enter the Wi-Fi name.

Get the SSID of the connected Wi-Fi network

API description

/// Get the SSID of the current Wi-Fi asynchronously.
/// @see ThingSmartActivator::currentWifiSSID
/// @param success Called when the task finishes successfully. ThingSuccessString will be returned.
/// @param failure Called when the task is interrupted by an error.
+ (void)getSSID:(ThingSuccessString)success
        failure:(ThingFailureError)failure;

Sample code

Objective-C:

[ThingSmartActivator getSSID:^(NSString *result) {
    } failure:^(NSError *error) {
    }];

Swift:

ThingSmartActivator.getSSID { (_: String?)  in
        } failure: { (Error) in
        }