Bir eve yeni Matter cihazları ekleme

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

Xcode proje yapılandırması

   iOS için örnek uygulamada uygulandı   

Commissioning API'yi uygulamadan önce Xcode hedeflerinize gerekli özellikleri, yetkileri ve Info.plist özelliklerini eklediğinizden emin olun:

Yararlanma hakları

Ana uygulama hedefiniz ve uzantınızın .entitlements dosyalarına aşağıdaki girişleri ekleyin:

  • Thread ağ kimlik bilgisi yönetimi:

    <key>com.apple.developer.networking.manage-thread-network-credentials</key>
    <true/>
    

    Bu yetkiyi dağıtılmış bir derlemede kullanmak için Apple'a yetki istek formu göndermeniz gerekir. Apple, Thread Group üyesi olduğunuzu kanıtlamanızı ve Thread Border Router (TBR) uygulamanızın Thread Group tarafından onaylandığını doğrulamanızı zorunlu kılar.

  • Kablosuz ağ bilgileri:

    <key>com.apple.developer.networking.wifi-info</key>
    <true/>
    
  • Uygulama grupları: Ana uygulamanızın ve MatterAdd Device uzantısının iletişim kurmasına izin vermek için paylaşılan bir uygulama grubu ekleyin (ör. group.com.yourdomain.appgroupname). Bu tanımlayıcı, geliştirici tarafından Apple Developer Console'da oluşturulup kaydedilir ve Xcode'daki hedef özelliklerde yapılandırılan uygulama grubuyla eşleşmelidir. Google Home SDK'sı, paylaşılan bir UserDefaults kapsayıcısı kullanarak devreye alma durumunu, yapı kimlik bilgilerini ve oda listelerini otomatik olarak senkronize etmek için her iki hedefte de bu tanımlayıcıyı kullanır.

Anahtar zinciri paylaşımı (isteğe bağlı)

Uygulama uzantınızın, UserInfo.authorizationToken() kullanarak ana uygulama tarafından depolanan kimlik bilgilerini veya erişim jetonlarını alması gerekiyorsa hem ana uygulamanız hem de uygulama uzantısı hedefleriniz için yetkilendirme plist'lerinde paylaşılan bir anahtarlık erişim grubu yapılandırmanız gerekir:

<key>keychain-access-groups</key>
<array>
    <string>$(AppIdentifierPrefix)your.shared.keychain.group</string>
</array>

Info.plist özellikleri

Ana uygulama hedefinizin Info.plist dosyasına aşağıdaki açıklama anahtarlarını ekleyin:

  • Konum kullanımı açıklaması:

    <key>NSLocationWhenInUseUsageDescription</key>
    <string>Your custom message explaining why location access is needed to read the current Wi-Fi SSID</string>
    
  • Bonjour hizmetleri: NSBonjourServices bölümünde, yerel Matter ve Thread keşfi için gereken hizmetleri ekleyin:

    <key>NSBonjourServices</key>
    <array>
        <string>_matter._tcp</string>
        <string>_matterc._udp</string>
        <string>_matterd._udp</string>
        <string>_meshcop._udp</string>
    </array>
    
  • Yerel ağ kullanımı açıklaması: Yerel ağ keşif izinlerini açıklayan bir mesajla NSLocalNetworkUsageDescription anahtarını ekleyin.

Cihazı devreye alma

Matter cihazı devreye almak için:

  1. structure.prepareForMatterCommissioning() ile Matter devreye alma isteklerine hazırlanması için Home APIs iOS SDK adlı kullanıcıyı bilgilendirin. Bu komut şunları yapar:

    • İ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 {
      // Failed to prepare for Matter Commissioning
      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 devreye alma isteğini iptal edin.

    do {
      // Starting MatterAddDeviceRequest.
      try await request.perform()
      // Successfully completed MatterAddDeviceRequest.
      let commissionedDeviceIDs = try structure.completeMatterCommissioning()
      // Commissioned device IDs.
    } catch let error {
      structure.cancelMatterCommissioning()
      // Failed to complete MatterAddDeviceRequest.
    }
    
  4. Cihazı devreye alırken uygulamanın 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 kimliğinizi ve temel hazırlık profillerinizi de güncellemeniz gerekir.

  5. Başlatma sırasında 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 kod, Apple'ın MatterAddDeviceExtensionRequestHandler API'sinin bir alt sınıfının uygulanmasına dair bir örnek gösterir.

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

    • commissionDevice
    • rooms
    • configureDevice
    import MatterSupport
    import GoogleHomeSDK
    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 {
        // Commission Matter device with payload.
    
        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()
          // Returning fetched rooms.
          return fetchedRooms
        } catch {
          // Failed to fetch rooms with 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 {
        // Configure Device name: room
        do {
          let homeMatterCommissioner = try HomeMatterCommissioner(appGroup: RequestHandler.appGroup)
          await homeMatterCommissioner.configureMatterDevice(
            deviceName: name, roomName: room?.displayName)
        } catch {
          // Configure Device failed with error
        }
      }
    }