Bir eve yeni Matter cihazları ekleme

iOS için Home API'leri, bir cihazı bir kumaşa bağlamak için Matter hub'ı kullanır. Devreye alma sırasında uygulama, SDK'ya ve ardından hub'a bir komut gönderir.

Matter cihazı devreye almak için:

  1. structure.prepareForMatterCommissioning() ile Matter kullanıma sunma isteklerine hazırlanması için Home APIs iOS SDK'ü bilgilendirin. Bu komutla şunları yapmış olursunuz:

    • İznin verildiğini doğrulayın.
    • Merkezin internete bağlı ve erişilebilir olduğundan emin olun.
    • Devam eden başka bir etkin devreye alma oturumu olmadığından emin olun.
    do {
      try await structure.prepareForMatterCommissioning()
    } catch {
      Logger.error("Failed to prepare for Matter Commissioning: \(error).")
      return
    }
    
  2. Apple'ın Matter destek akışını başlatmak için MatterAddDeviceRequest() ile bir istek oluşturun.

    let topology = MatterAddDeviceRequest.Topology(
      ecosystemName: "Google Home",
      homes: [MatterAddDeviceRequest.Home(displayName: structure.name)]
    )
    
    let request = MatterAddDeviceRequest(topology: topology)
    
  3. İsteği perform() ile gerçekleştirin. Hata oluşursa structure.cancelMatterCommissioning() ile birlikte etkinleştirme isteğini iptal edin.

    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. Uygulamanın cihazı devreye alırken MatterAddDevice uzantısıyla iletişim kurmasına izin vermek için Apple Developer Console'da bir App Group ID oluşturun.

    Bu grup kimliğini kullanmak için uygulama paketi tanımlayıcınızı ve temel hazırlama profillerinizi de güncellemeniz gerekir.

  5. İlk başlatırken Home örneğini grup tanımlayıcısını kullanacak şekilde yapılandırın.

    func application(_ application: UIApplication, didFinishLaunchingWithOptions
    launchOptions: [UIApplication.LaunchOptionsKey : Any]? = nil) -> Bool {
      Home.configure {
        $0.sharedAppGroup = "group.com.sample.app.commissioning"
      }
    
      return true
    }
    
  6. Apple'ın iOS Matter uygulama uzantısını uygulayın.

    Örnek kodda, Apple'ın MatterAddDeviceExtensionRequestHandler API alt sınıfının uygulanması örneği gösterilmektedir.

    En azından GoogleHomeMatterCommissionerSDK Framework'i uzantı hedefine ekleyin ve Google Home platformHomeMatterCommissioner API'lerini çağırmak için üç yöntemi geçersiz kılın.

    • 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).")
        }
      }
    }