Einem Zuhause neue Matter-Geräte hinzufügen

Die Home APIs für iOS verwenden einen Matter Hub, um ein Gerät in einem Fabric in Betrieb zu nehmen. Während der Inbetriebnahme sendet die App einen Befehl an das SDK und dann an den Hub.

Xcode-Projektkonfiguration

Bevor Sie die Commissioning API implementieren, müssen Sie Ihren Xcode-Targets die erforderlichen Funktionen, Berechtigungen und Info.plist-Attribute hinzufügen:

Berechtigungen

Fügen Sie die folgenden Einträge in die .entitlements-Dateien Ihres Haupt-App-Targets und Ihrer Erweiterung ein:

  • Verwaltung von Anmeldedaten für Thread-Netzwerke:

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

    Wenn Sie diese Berechtigung in einem verteilten Build verwenden möchten, müssen Sie ein Formular für die Berechtigungsanfrage bei Apple einreichen. Apple verlangt, dass Sie Ihre Mitgliedschaft in der Thread Group nachweisen und bestätigen, dass Ihr Thread Border Router von der Thread Group zertifiziert ist.

  • WLAN-Informationen:

    <key>com.apple.developer.networking.wifi-info</key>
<true/>

  • App-Gruppen: Fügen Sie eine freigegebene App-Gruppe hinzu, damit Ihre Haupt-App und die Matter Erweiterung zum Hinzufügen von Geräten kommunizieren können (z. B. group.com.yourdomain.appgroupname). Diese ID wird vom Entwickler in der Apple Developer Console erstellt und registriert und muss mit der App-Gruppe übereinstimmen, die in den Target-Funktionen in Xcode konfiguriert ist. Das Google Home SDK verwendet diese ID in beiden Targets, um den Inbetriebnahmestatus, die Fabric-Anmeldedaten und die Raumlisten mithilfe eines freigegebenen UserDefaults-Containers automatisch zu synchronisieren.

Keychain-Freigabe (optional)

Wenn Ihre App-Erweiterung Anmeldedaten oder Zugriffstokens abrufen muss, die von der Haupt-App mit UserInfo.authorizationToken() gespeichert wurden, müssen Sie eine freigegebene Keychain-Zugriffsgruppe für die Targets Ihrer Haupt-App und Ihrer App-Erweiterung in der Berechtigungs-Plist konfigurieren:

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

Info.plist-Attribute

Fügen Sie die folgenden Beschreibungsschlüssel in die Info.plist Ihres Haupt-App-Targets ein:

  • Beschreibung der Standortnutzung:

    <key>NSLocationWhenInUseUsageDescription</key>
<string>Your custom message explaining why location access is needed to read the current Wi-Fi SSID</string>

  • Bonjour-Dienste: Fügen Sie unter NSBonjourServices die Dienste ein, die für die lokale Matter und Thread-Erkennung erforderlich sind:

    <key>NSBonjourServices</key>
<array>
    <string>_matter._tcp</string>
    <string>_matterc._udp</string>
    <string>_matterd._udp</string>
    <string>_meshcop._udp</string>
</array>

  • Beschreibung der lokalen Netzwerknutzung: Fügen Sie den Schlüssel NSLocalNetworkUsageDescription mit einer Nachricht hinzu, in der die Berechtigungen für die lokale Netzwerkermittlung erläutert werden.

Gerät in Betrieb nehmen

So nehmen Sie ein Matter Gerät in Betrieb:

  1. Benachrichtigen Sie das Home APIs iOS SDK, um es auf Matter Inbetriebnahmeanfragen mit structure.prepareForMatterCommissioning() vorzubereiten. Mit diesem Befehl wird Folgendes ausgeführt:

    • Prüfen, ob die Berechtigung erteilt wurde.
    • Prüfen, ob der Hub online und erreichbar ist.
    • Prüfen, ob keine andere aktive Inbetriebnahmesitzung läuft.
    do {
  try await structure.prepareForMatterCommissioning()
} catch {
  // Failed to prepare for Matter Commissioning
  return
}

  2. Erstellen Sie mit MatterAddDeviceRequest() eine Anfrage, um den Support-Ablauf von Apple zu starten.Matter

    let topology = MatterAddDeviceRequest.Topology(
  ecosystemName: "Google Home",
  homes: [MatterAddDeviceRequest.Home(displayName: structure.name)]
)

let request = MatterAddDeviceRequest(topology: topology)

  3. Führen Sie die Anfrage mit perform() aus. Wenn ein Fehler auftritt, brechen Sie die Inbetriebnahmeanfrage mit structure.cancelMatterCommissioning() ab.

    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. Erstellen Sie in der Apple Developer Console eine App Group ID, damit die App bei der Inbetriebnahme des Geräts mit der Erweiterung MatterAddDevice kommunizieren kann.

    Sie müssen auch den Paket-Identifikator Ihrer Anwendung und die Bereitstellungsprofile aktualisieren, um diese Gruppen-ID zu verwenden.

  5. Konfigurieren Sie beim Initialisieren die Home-Instanz so, dass sie die Gruppen-ID verwendet.

    func application(_ application: UIApplication, didFinishLaunchingWithOptions
launchOptions: [UIApplication.LaunchOptionsKey : Any]? = nil) -> Bool {
  Home.configure {
    $0.sharedAppGroup = "group.com.sample.app.commissioning"
  }

  return true
}

  6. Implementieren Sie die iOS Matter App Extension von Apple.

    Der Beispielcode zeigt ein Beispiel für die Implementierung einer Unterklasse der API von Apple MatterAddDeviceExtensionRequestHandler.

    Fügen Sie dem Erweiterungsziel mindestens das GoogleHomeMatterCommissionerSDK Framework hinzu und überschreiben Sie drei Methoden, um die Google Home platformHomeMatterCommissioner APIs aufzurufen.

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