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

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

لتكليف جهاز Matter، يُرجى اتّباع الخطوات التالية:

1. إشعار Home APIs iOS SDK بالاستعداد لـ Matter طلبات التكليف باستخدام structure.prepareForMatterCommissioning(). سينفّذ هذا الأمر ما يلي:

   • التحقّق من منح الإذن
   • التأكّد من أنّ المركز متصل بالإنترنت ويمكن الوصول إليه
   • التأكّد من عدم وجود جلسة تكليف نشطة أخرى قيد التقدّم

   do {
     try await structure.prepareForMatterCommissioning()
   } catch {
     // Failed to prepare for Matter Commissioning
     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 {
     // 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. إنشاء 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 من Apple.

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

   • 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
       }
     }
   }