Beispiel-App für Smart-Home-APIs für Android

Die Beispielanwendung zeigt die grundlegenden Funktionen der Google Home APIs.

Vorbereitung

Zum Erstellen, Installieren und Testen der App müssen einige Voraussetzungen erfüllt sein:

  • Android Studio, Version 2024.2.1 („Ladybug“) oder höher. Ältere Versionen funktionieren möglicherweise nicht richtig mit dem Home APIs SDK.

    Android Studio herunterladen

  • Der Android-Debugger (adb)

    Installieren Sie adb.

    Das geht mit dem SDK Manager.

Für den Test der Home APIs benötigen Sie Folgendes:

  • Ein Android-Gerät mit Android 10 oder höher, das mit einem Google-Konto eingerichtet ist, das Sie für die Entwicklung verwenden möchten. Achten Sie darauf, dass eine aktuelle Version der Android Studio installiert ist und Sie mit diesem Entwicklungskonto angemeldet sind.
  • Ein WLAN.
  • Ein Google-Hub, der die Home APIs unterstützt.

  • Mindestens ein unterstütztes Gerät im Zuhause. Wenn dieses Gerät (oder ein anderes, das Sie testen möchten) Thread verwendet, muss der Hub auch ein Thread-Border-Router sein. Die folgenden Gerätetypen und -merkmale werden von der Android-Beispiel-App unterstützt:

    • Farbtemperatur des Lichts (Ein- und Ausschalten, Helligkeit)
    • Kontaktsensor (boolescher Status)
    • Dimmbares Licht (Ein- und Ausschalten, Helligkeit)
    • Farbiges Licht (ein- und ausschalten, Helligkeit)
    • Generischer Schalter
    • Anwesenheitssensor (Anwesenheitserkennung)
    • Ein-/Aus-Licht (Ein- und Ausschalten, Helligkeit)
    • Ein-/Aus-Lichtschalter
    • Ein-/Aus-Stecker (Ein und Aus)
    • Ein-/Aus-Sensor

  1. Rufen Sie in der Google Cloud Console das Dashboard für die Projektauswahl auf und wählen Sie das Projekt aus, mit dem Sie OAuth-Anmeldedaten erstellen möchten.
  2. Rufen Sie die Seite APIs und Dienste auf und klicken Sie im Navigationsmenü auf Anmeldedaten.

  3. Wenn Sie den Einwilligungsbildschirm für dieses Google Cloud-Projekt noch nicht konfiguriert haben, wird die Schaltfläche Zustimmungsbildschirm konfigurieren angezeigt. Konfigurieren Sie in diesem Fall den Zustimmungsbildschirm mithilfe der folgenden Schritte. Fahren Sie andernfalls mit dem nächsten Abschnitt fort.

    1. Klicken Sie auf Zustimmungsbildschirm konfigurieren. Die Seite OAuth-Zustimmungsbildschirm wird angezeigt.
    2. Wählen Sie je nach Anwendungsfall Intern oder Extern aus und klicken Sie dann auf Erstellen. Der Bereich OAuth-Zustimmungsbildschirm wird angezeigt.
    3. Geben Sie auf der Seite mit den App-Informationen die Informationen gemäß der Anleitung auf dem Bildschirm ein und klicken Sie dann auf Speichern und fortfahren. Der Bereich Bereiche wird angezeigt.
    4. Sie müssen keine Bereiche hinzufügen. Klicken Sie daher auf Speichern und fortfahren. Der Bereich Testnutzer wird angezeigt.
    5. Wenn Sie Nutzer hinzufügen möchten, 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 gewähren.
    6. Fügen Sie im leeren Feld eine oder mehrere E-Mail-Adressen von Google-Konten hinzu und klicken Sie dann auf Hinzufügen.
    7. Klicken Sie auf Speichern und fortfahren. Der Bereich Summary (Zusammenfassung) wird angezeigt.
    8. Überprüfen Sie die Informationen auf dem OAuth-Zustimmungsbildschirm und klicken Sie dann auf Zurück zum Dashboard.

Ausführliche Informationen finden Sie in der Google Cloud Console-Hilfe unter OAuth-Zustimmungsbildschirm einrichten.

Quellcode herunterladen

Der Quellcode für die Beispielanwendung ist auf GitHub verfügbar.

Rufen Sie den Speicherort auf, an dem Sie das Projekt speichern möchten, und klonen Sie es dann:

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

SDK einrichten

Die Home APIs in dieser offenen Betaversion sind noch nicht Teil der Standardbibliotheken, die Google für die Entwicklung zur Verfügung stellt. Wenn Sie Anwendungen mit den Home APIs entwickeln möchten, müssen Sie die Bibliotheken lokal herunterladen und hosten.

Wenn Sie das Android SDK für Home APIs herunterladen möchten, müssen Sie zuerst in Google Home Developers angemeldet sein.

Melde dich jetzt an.

Erstellen und ausführen

  1. Öffnen Sie Android Studio und dann den Projektordner google-home-api-sample-app-android, der auf Ihren lokalen Computer geklont wurde.
  2. Bei der Ersteinrichtung kann es bis zu 10 Minuten dauern, bis Android Studio alle Projektabhängigkeiten heruntergeladen und der Gradle-Build abgeschlossen ist.
    • Wenn bei diesem Schritt ein Fehler auftritt, z. B. Gradle Sync Failed, klicken Sie auf Noch einmal versuchen, um die Synchronisierung noch einmal zu starten.
  3. Ändern Sie den Paketnamen der Beispiel-App in einen neuen, der noch nicht registriert wurde, z. B. einen, der auf dem Namen Ihrer Organisation basiert:
    1. Öffnen Sie das Projekt.
    2. Maximieren Sie die Quellenhierarchie.
    3. Wählen Sie den Teil des Pakets aus, den Sie ändern möchten, also com.example.
    4. Klicken Sie mit der rechten Maustaste auf das Paket und wählen Sie Umstrukturieren > Umbenennen… aus.
    5. Klicken Sie auf Alle Verzeichnisse.
    6. Geben Sie den neuen Namen ein und klicken Sie auf Umstrukturieren.
    7. Bearbeiten Sie die Datei build.gradle.kts und ändern Sie android namespace und applicationId in den neuen Paketnamen.
    8. Bearbeiten Sie die Datei AndroidManifest.xml und ändern Sie das Paket überall dort, wo es in der Datei vorkommt, in den neuen Paketnamen.

  4. Generieren Sie einen OAuth-Schlüssel, indem Sie die App in Android Studio ausführen. Wenn Sie eine App in Android Studio ausführen oder beheben, generiert Android Studio automatisch einen OAuth-Schlüssel für die Entwicklung und Fehlerbehebung. Eine vollständige Erklärung finden Sie unter Android Studio: Debug-Build signieren.

    Verbinden Sie Ihr Mobilgerät mit Ihrem lokalen Computer. Auf Android Studio werden Ihre verbundenen Geräte nach Modellnummer aufgeführt. Wählen Sie Ihr Gerät aus der Liste aus und klicken Sie auf Projekt ausführen. Dadurch wird die Beispiel-App erstellt und auf Ihrem Mobilgerät installiert.

    Eine ausführliche Anleitung finden Sie auf der Website für Android-Entwickler unter Apps auf einem Hardwaregerät ausführen.

    Beenden Sie jetzt die laufende App.

  5. Rufen Sie den SHA-1-Fingerabdruck des OAuth-Zertifikats ab. Folgen Sie dazu der Anleitung unter OAuth 2.0 einrichten / Native Anwendungen / Android auf der Hilfeseite der Google Cloud Console.

  6. Registrieren Sie die Beispiel-App für OAuth 2.0 und erstellen Sie OAuth-Anmeldedaten. Folgen Sie dazu der Anleitung unter OAuth 2.0 einrichten.

    1. Geben Sie den Anwendungstyp an, also native/Android-App.
    2. Fügen Sie dem OAuth-Client den SHA-1-Fingerabdruck hinzu. Folgen Sie dazu der Anleitung unter OAuth 2.0 einrichten / Native Anwendungen / Android in der Google Cloud Console-Hilfe. Sie sollten den SHA-1-Schlüssel während des gesamten Entwicklungsprozesses aus dem Standardschlüssel von Android Studio generieren.
    3. Fügen Sie Testnutzer hinzu. Testnutzer haben die Berechtigung, Berechtigungen in der Beispiel-App zu gewähren.

  7. Klicken Sie, während Ihr Mobilgerät mit Ihrem lokalen Computer verbunden ist, noch einmal auf Projekt ausführen, um die Beispiel-App auf Ihrem Mobilgerät auszuführen.

Nach der Installation ist die App auf Ihrem Mobilgerät als Home API Sample App verfügbar.