إضافة أجهزة Matter جديدة إلى منزل

تستخدِم واجهات برمجة التطبيقات Home APIs لنظام التشغيل iOS مركز Matter لتشغيل جهاز على بنية. أثناء عملية الإعداد، يُرسِل التطبيق أمرًا إلى حزمة تطوير البرامج (SDK) ثم إلى المحور.

لتشغيل جهاز Matter:

  1. أرسِل إشعارًا إلى Home APIs iOS SDK للاستعداد Matter لطلبات التفويض مع structure.prepareForMatterCommissioning(). سيؤدي هذا الأمر إلى تنفيذ ما يلي:

    • تأكَّد من منح الإذن.
    • تأكَّد من أنّ المحور متصل بالإنترنت ويمكن الوصول إليه.
    • تأكَّد من عدم وجود جلسة تفعيل أخرى نشطة ومستمرة.
    do {
      try await structure.prepareForMatterCommissioning()
    } catch {
      Logger.error("Failed to prepare for Matter Commissioning: \(error).")
      return
    }
    
  2. أنشئ طلبًا مع MatterAddDeviceRequest() لبدء عملية الدعم من خلال Matter في Apple.

    let topology = MatterAddDeviceRequest.Topology(
      ecosystemName: "Google Home",
      homes: [MatterAddDeviceRequest.Home(displayName: structure.name)]
    )
    
    let request = MatterAddDeviceRequest(topology: topology)
    
  3. نفِّذ الطلب باستخدام perform(). إذا حدث خطأ، يمكنك إلغاء طلب تفويض الإصدار مع structure.cancelMatterCommissioning().

    do {
      Logger.info("Starting MatterAddDeviceRequest.")
      try await request.perform()
      Logger.info("Successfully completed MatterAddDeviceRequest.")
      let commissionedDeviceIDs = try structure.completeMatterCommissioning()
      Logger.info("Commissioned device IDs: \(commissionedDeviceIDs).")
    } catch let error {
      structure.cancelMatterCommissioning()
      Logger.error("Failed to complete MatterAddDeviceRequest: \(error).")
    }
    
  4. أنشئ App Group ID في Apple Developer Console للسماح للتطبيق بالتواصل مع إضافة MatterAddDevice عند تفعيل الجهاز.

    ستحتاج أيضًا إلى تعديل معرّف حِزمة التطبيق وملفّات ملفّات الإعداد لاستخدام معرّف المجموعة هذا.

  5. عند الإعداد، عليك ضبط مثيل Home لاستخدام معرّف المجموعة.

    func application(_ application: UIApplication, didFinishLaunchingWithOptions
    launchOptions: [UIApplication.LaunchOptionsKey : Any]? = nil) -> Bool {
      Home.configure {
        $0.sharedAppGroup = "group.com.sample.app.commissioning"
      }
    
      return true
    }
    
  6. تنفيذ إضافة تطبيق iOS Matter من Apple

    يعرض الرمز النموذجي مثالاً على تنفيذ فئة فرعية من MatterAddDeviceExtensionRequestHandler API من Apple.

    على الأقل، أضِف GoogleHomeMatterCommissionerSDK Framework إلى استهداف الإضافة واستبدِل ثلاث طرق لاستدعاء واجهات برمجة التطبيقات Google Home platformHomeMatterCommissioner.

    • commissionDevice
    • rooms
    • configureDevice
    import MatterSupport
    import GoogleHomeMatterCommissionerSDK
    import OSLog
    
    final class RequestHandler: MatterAddDeviceExtensionRequestHandler {
      // The App Group ID defined by the application to share information between the extension and main app.
      private static var appGroup = "group.com.sample.app.commissioning"
    
      ...
    
      // MARK: - Home API commissioning handlers
    
      /// Commissions a device to the Google Home ecosystem.
      /// - Parameters:
      ///   - home: The home that the device will be added to
      ///   - onboardingPayload: The payload to be sent to the Matter Commissioning SDK to commission the device.
      ///   - commissioningID: An identifier not used by the Home API SDK.
      override func commissionDevice(in home: MatterAddDeviceRequest.Home?, onboardingPayload: String, commissioningID: UUID) async throws {
        Logger.info("Commission Matter device with payload: '\(onboardingPayload)'.")
    
        var onboardingPayloadForHub = onboardingPayload
        let homeMatterCommissioner = try HomeMatterCommissioner(appGroup: RequestHandler.appGroup)
        try await homeMatterCommissioner.commissionMatterDevice(
        onboardingPayload: onboardingPayloadForHub)
      }
    
      /// Obtains rooms from the Home Ecosystem to present to the user during the commissioning flow.
      /// - Parameter home: The home that the device will be added to.
      /// - Returns: A list of rooms if obtained from the Google Home ecosystem or an empty list if there was an error in getting them.
      override func rooms(in home: MatterAddDeviceRequest.Home?) async -> [MatterAddDeviceRequest.Room] {
        do {
          let homeMatterCommissioner = try HomeMatterCommissioner(appGroup: RequestHandler.appGroup)
          let fetchedRooms = try homeMatterCommissioner.fetchRooms()
          Logger.info("Returning \(fetchedRooms.count) fetched rooms.")
          return fetchedRooms
        } catch {
          Logger.info("Failed to fetch rooms with error: \(error).")
          return []
        }
      }
    
      /// Pushes the device's configurations to the Google Home Ecosystem.
      /// - Parameters:
      ///   - name: The friendly name the user chose to set on the device.
      ///   - room: The room identifier that the user chose to put the device in.
      override func configureDevice(named name: String, in room: MatterAddDeviceRequest.Room?) async {
        Logger.info("Configure Device name: '\(name)', room: \(room?.displayName ?? "").")
        do {
          let homeMatterCommissioner = try HomeMatterCommissioner(appGroup: RequestHandler.appGroup)
          await homeMatterCommissioner.configureMatterDevice(
            deviceName: name, roomName: room?.displayName)
        } catch {
          Logger.info("Configure Device failed with error: \(error).")
        }
      }
    }