iOS-Beispiel-App erstellen

Diese iOS-Beispielanwendung verwendet die Google Home APIs. In diesem Leitfaden erfahren Sie, wie Sie die App zum ersten Mal erstellen und ausführen.

Vorbereitung

Achten Sie darauf, dass Sie die Mindestanforderungen für die Verwendung der Home APIs für iOS erfüllen.

Zum Erstellen und Installieren der Beispiel-App benötigen Sie einen Computer mit Xcode Version 15.3 oder höher.

Xcode herunterladen

Zum Testen der App benötigen Sie Folgendes:

  1. Ein Google-Konto.
  2. Eine Apple-ID, die im Apple Developer Program registriert ist, um Konfigurationsdateien für physische Geräte zu generieren. Wenn die Registrierung noch nicht erfolgt ist, fallen zusätzliche Kosten an und es kann bis zu 48 Stunden dauern, bis sie abgeschlossen ist.
  3. Ein iOS-Gerät (kein Simulator) mit iOS 16.4 oder höher, das mit dem Testkonto eingerichtet ist.
  4. Ein WLAN
  5. Ein Google-Hub, der die Home APIs unterstützt.
  6. Ein Thread-Border-Router, wenn Ihr Gerät Thread benötigt und Ihr Hub diese Funktion nicht bietet.
  7. Mindestens ein unterstützter Gerätetyp.

Für die Entwicklung benötigen Sie einen Mac, der die folgenden Anforderungen erfüllt:

  • macOS Sonoma oder höher
  • Xcode 15.3 oder höher

Apple-Bereitstellungskonfigurationsdateien erstellen

Zuerst muss für eine App die Funktion App Attest aktiviert sein. Daher kann sie nicht auf Simulatorgeräten bereitgestellt werden. Dazu müssen Sie ein Bereitstellungsprofil mit der Berechtigung App Attest erstellen.

Außerdem müssen App-Gruppen für die Kommunikation zwischen der App und der MatterExtension aktiviert sein. Dazu müssen Sie eine App-Gruppen-ID registrieren.

Weitere Informationen finden Sie unter der Apple-Seite zu Bereitstellungsprofilen: Bereitstellungsprofil für die Entwicklung erstellen.

Im Folgenden werden die Mindestanforderungen für die Bereitstellung einer App beschrieben:

  1. Erstellen Sie eine App-Gruppen-ID für Ihre App, damit sie mit der MatterExtension kommunizieren kann.
    1. Melden Sie sich im Apple Developer Portal an.
    2. Fügen Sie eine App-Gruppen-ID hinzu. Sie kann beispielsweise so formatiert sein: group.com.company.commissioning.
  2. Registrieren Sie Ihr Testgerät im Entwickler konto.

  3. Erstellen Sie ein Profil für Ihr App-Ziel.

    1. Legen Sie einen App-Paket-Identifikator für Ihre App fest. Der Identifikator muss eindeutig und beschreibend sein. Sie kann beispielsweise als formatiert sein com.company.HomeApiSample. Diese ID wird im Rest dieses Abschnitts verwendet.
    2. Registrieren Sie Ihre App-ID. Fügen Sie bei Aufforderung die Funktionen App Attest und App-Gruppen hinzu.

    3. Bearbeiten Sie die neu erstellte App-ID und konfigurieren Sie die Funktion App-Gruppen , um die registrierte App-Gruppen-ID hinzuzufügen.

    4. Erstellen Sie ein Bereitstellungsprofil für die Entwicklung Ihrer App. Verknüpfen Sie es mit Ihrer neu erstellten App-ID und den ausgewählten Testgeräten. Sie benötigen ein Entwicklerzertifikat, um die App zu signieren.

  4. Erstellen Sie ein Profil für Ihr MatterExtension-Ziel.

    1. Legen Sie eine App-Paket-ID für Ihre MatterExtension fest. Die ID sollte von der App-ID abgeleitet werden. Sie kann beispielsweise so formatiert sein: com.company.HomeApiSample.MatterExtension.
    2. Registrieren Sie Ihre App-ID. Fügen Sie bei Aufforderung die Funktion App-Gruppe hinzu.
    3. Bearbeiten Sie die neu erstellte App-ID und konfigurieren Sie die Funktion App-Gruppen , um die registrierte App-Gruppen-ID hinzuzufügen, die Sie in den vorherigen Schritten erstellt haben.
    4. Erstellen Sie ein Bereitstellungsprofil für die Entwicklung für MatterExtension.

OAuth-Client-ID generieren und Home APIs aktivieren

Ihre App benötigt eine OAuth-Client-ID, um sich beim Authentifizierungs-Backend von Google zu identifizieren. Für iOS und Apps muss der Anwendungstyp der OAuth-Client-ID als iOS konfiguriert sein. Die App ruft auch die Home API auf. Damit diese Funktion aktiviert werden kann, muss die API in dem Google Cloud Projekt aktiviert sein.

OAuth-Client-ID generieren

  1. Rufen Sie in der Google Cloud Console das Dashboard der Projektauswahl auf und wählen Sie das Projekt aus, mit dem Sie OAuth-Anmeldedaten erstellen möchten.
  2. Rufen Sie die Seite „APIs & Dienste“ auf, indem Sie links oben auf das Menü > Alle Produkte ansehen > APIs & Dienste klicken.
  3. Klicken Sie im Navigationsmenü auf Anmeldedaten.

  4. Wenn Sie den Zustimmungsbildschirm für dieses Google Cloud-Projekt noch nicht konfiguriert haben, wird die Schaltfläche Zustimmungsbildschirm konfigurieren angezeigt. Konfigurieren Sie in diesem Fall den Zustimmungsbildschirm mit der folgenden Anleitung. Wenn Ihr OAuth Zustimmungsbildschirm bereits konfiguriert wurde und der Veröffentlichungsstatus Testen lautet, müssen die Testkonten, die Sie verwenden möchten, der Gruppe Testnutzer hinzugefügt werden. Fahren Sie andernfalls mit dem nächsten Schritt fort.

    1. Wählen Sie je nach Anwendungsfall Intern oder Extern aus und klicken Sie dann auf Erstellen. Der Bereich OAuth-Zustimmungsbildschirm wird angezeigt.
    2. Geben Sie auf der Seite App-Informationen die Informationen gemäß der Anleitung auf dem Bildschirm ein und klicken Sie dann auf Speichern und fortfahren. Der Bereich „Bereiche“ wird angezeigt.
    3. Sie müssen keine Bereiche hinzufügen. Klicken Sie also auf Speichern und fortfahren. Der Bereich Testnutzer wird angezeigt.
    4. Wenn Sie einen internen Zustimmungsbildschirm erstellt haben, müssen Sie Nutzer hinzufügen, um den Zugriff auf Ihre App zu testen. Klicken Sie auf Nutzer hinzufügen. Der Bereich Nutzer hinzufügen wird angezeigt. Testnutzer haben die Berechtigung, Berechtigungen in Ihrer App zu erteilen. Fügen Sie im leeren Feld eine oder mehrere E-Mail-Adressen des Google-Kontos hinzu und klicken Sie dann auf Hinzufügen.
    5. Klicken Sie auf Speichern und fortfahren. Der Bereich Zusammenfassung wird angezeigt.
    6. Prüfen Sie die Informationen auf dem OAuth-Zustimmungsbildschirm und klicken Sie dann auf Zurück zum Dashboard.

  5. Klicken Sie im Menü auf der linken Seite auf Anmeldedaten, um Ihre OAuth-Client-ID zu erstellen.

    OAuth-Zustimmungsbildschirm einrichten

    1. Klicken Sie auf die Schaltfläche ANMELDEDATEN ERSTELLEN und wählen Sie OAuth-Client-ID aus.
      1. Wählen Sie unter Anwendungstyp die Option iOS aus.
    2. Geben Sie die Paket-ID mit Ihrer App-ID und der Apple Entwickler Team-ID ein. Die anderen Felder sind optional und können leer gelassen werden.
    3. Klicken Sie auf ERSTELLEN und notieren Sie sich die erstellte Client-ID oder PLIST HERUNTERLADEN. Diese wird später verwendet, um die Funktion für den Berechtigungsablauf zu aktivieren. Weitere Informationen finden Sie im Abschnitt Autorisierungsanmeldedaten erstellen.

Home APIs aktivieren

Aktivieren Sie den Zugriff auf die Home APIs.

  1. Klicken Sie auf dem Tab APIs & Dienste auf Aktivierte APIs & Dienste.
  2. Klicken Sie oben auf der Seite auf APIs UND DIENSTE AKTIVIEREN.
  3. Suchen Sie nach HOME API und wählen Sie sie aus.
  4. Klicken Sie auf der Detailseite Home API auf AKTIVIEREN.

Quellcode herunterladen

Der Quell code für die Beispiel-App ist auf GitHub verfügbar.

Gehen Sie zu dem Speicherort, an dem Sie das Projekt speichern möchten, und klonen Sie es:

git clone https://github.com/google-home/google-home-api-sample-app-ios.git

Wenn Sie das Projekt in Xcode laden möchten, klicken Sie auf Datei > Öffnen und wählen Sie GoogleHomeAPISampleIOS.xcodeproj im Stammverzeichnis des geklonten Repositorys aus.

SDK in das Projekt einbinden

Für die Erstellung des Beispiel-App-Projekts sind einige zusätzliche Informationen erforderlich. Dazu gehört das lokale Hinzufügen der SDK-Framework-Dateien, das Ausfüllen der ID-Informationen für Ihr Entwicklerkonto und das Ausfüllen Ihrer OAuth-Client-ID.

App erstellen

Sie müssen in Google Home Developers angemeldet sein, um das Home APIs iOS SDK herunterladen zu können.

Jetzt anmelden

Konfigurieren Sie Ihr Xcode-Projekt für die Beispiel-App:

  1. Entpacken Sie das heruntergeladene SDK in das Verzeichnis ThirdParty/GoogleHomeSDK relativ zum Stammverzeichnis des Projekts.
  2. Konfigurieren Sie die Entwickler- und OAuth-Client-IDs:
    1. Suchen Sie im Navigationsbereich nach dem Ordner GoogleHomeAPISampleIOS und öffnen Sie die Datei Info.plist zur Bearbeitung.

  3. Geben Sie in der Datei Info.plist die OAuth Client-ID in GIDClientID ein (siehe Abschnitt OAuth Zustimmung einrichten), die Cloud-Projektnummer für Ihr Cloud-Projekt und die GIDTeamID mit der Apple-Team-ID des Entwicklerkontos, das während der OAuth-Registrierung verwendet wurde.

  4. Funktion „App Attest“ hinzufügen:

    1. Wählen Sie im Xcode-Navigationsbereich die Projektdatei GoogleHomeAPISampleIOS aus, um die Projektkonfiguration zu bearbeiten.
    2. Klicken Sie oben auf den Tab Signieren und Funktionen und wählen Sie links unter „TARGETS“ das Ziel GoogleHomeAPISampleIOS aus.
    3. Klicken Sie direkt unter dem Tab „Signieren und Funktionen“ auf + Funktion und suchen Sie nach App Attest.
    4. Klicken Sie auf App Attest , um die Funktion hinzuzufügen. Wenn diese Funktion in der Suche nicht angezeigt wird, wurde sie möglicherweise bereits dem Projekt hinzugefügt.

  5. Fügen Sie die Funktion App-Gruppen hinzu.

    App-Gruppen hinzufügen

    1. Gehen Sie zum Projekt GoogleHomeAPISampleIOS > Ziel GoogleHomeAPISampleIOS.
    2. Klicken Sie auf Signieren und Funktionen > + Funktion.
    3. Wählen Sie die Funktion App-Gruppen aus.
    4. Klicken Sie unter App-Gruppen auf das Pluszeichen und fügen Sie die App-Gruppen-ID für Ihre App hinzu, die Sie im Apple Developer Portal hinzugefügt haben.
    5. Wiederholen Sie diese Schritte für das Ziel MatterAddDeviceExtension , um es den App-Gruppen hinzuzufügen.

  6. Paket-Identifikator aktualisieren

    1. Damit Sie die Beispiel-App mit Ihren Entwicklerzertifikaten und Bereitstellungsprofilen auf Hardware ausführen und bereitstellen können, müssen Sie eine eindeutige Paket-ID angeben. Dies sollte dieselbe ID sein, die mit Ihren OAuth-Client-Anmeldedaten verknüpft ist (siehe oben).
    2. Wählen Sie im Xcode-Navigationsbereich die Projektdatei GoogleHomeAPISampleIOS aus, um die Projektkonfiguration zu bearbeiten.
    3. Klicken Sie oben auf den Tab Signieren und Funktionen und wählen Sie links unter „TARGETS“ das Ziel GoogleHomeAPISampleIOS aus.
    4. Wählen Sie im Bereich Signieren das Feld „Paket-ID“ aus und geben Sie die eindeutige ID für die Anwendung ein.
    5. Wählen Sie das Bereitstellungsprofil aus, das mit diesem Paket verknüpft ist, oder installieren Sie es. Es muss die erforderlichen Berechtigungen enthalten.
    6. Wiederholen Sie diese Schritte für das Ziel MatterAddDeviceExtension, um den Paket-Identifikator für die Erweiterung einzugeben und das registrierte Bereitstellungsprofil zu importieren.

  7. Aktualisieren Sie die registrierte App-Gruppen-ID im Code.

    1. Die Anwendung muss die SDK-Instanz konfigurieren, um die App-Gruppen-ID für Funktionen wie die Geräteinrichtung zu verwenden. Aktualisieren Sie die App, um die im Apple Developer Portal registrierte App-Gruppen-ID zu verwenden. Suchen Sie dazu nach dem String HOME_API_TODO_ADD_APP_GROUP und ersetzen Sie jede Instanz damit.

    Diese Konfigurationen werden in den folgenden Dateien vorgenommen:

    • GoogleHomeAPISampleIOS.swift, wenn das SDK initialisiert wird.
    • RequestHandler.swift
    • CommissioningManager.swift