Application exemple Android pour les API Home

L'application exemple présente les fonctionnalités de base des API Google Home.

Prérequis

Pour compiler, installer et tester l'application, vous devez remplir quelques conditions préalables:

  • Android Studio, version 2024.2.1 ("Ladybug") ou ultérieure. Notez que les versions antérieures à cette date risquent de ne pas fonctionner correctement avec le SDK des API Home.

    Télécharger Android Studio

  • Le débogueur Android (adb).

    Installez adb.

    Pour ce faire, utilisez le SDK Manager.

Pour tester les API Home, vous avez besoin des éléments suivants:

  • Un appareil Android équipé d'Android 10 ou version ultérieure configuré avec un compte Google que vous prévoyez d'utiliser pour le développement. Assurez-vous qu'une version à jour de Android Studio est installée et que vous êtes connecté avec ce compte de développement.
  • Un réseau Wi-Fi
  • Un hub Google compatible avec les API Home.

  • Au moins un appareil compatible dans la maison Si cet appareil (ou tout autre que vous souhaitez tester) utilise Thread, le hub doit également être un routeur de bordure Thread. Les types et caractéristiques d'appareils suivants sont compatibles avec l'application exemple Android:

    • Voyant de température des couleurs (allumé et éteint, luminosité)
    • Capteur de contact (état booléen)
    • Lumière réglable (allumer et éteindre, luminosité)
    • Lumière de couleur étendue (marche/arrêt, luminosité)
    • Commutateur générique
    • Capteur de présence (détection de présence)
    • Lumière Marche/Arrêt (allumer et éteindre, luminosité)
    • Interrupteur marche/arrêt
    • Unité de plug-in Marche/Arrêt (marche et arrêt)
    • Capteur Marche/Arrêt

  1. Dans la console Google Cloud, accédez au tableau de bord de sélection du projet, puis sélectionnez le projet que vous souhaitez utiliser pour créer des identifiants OAuth.
  2. Accédez à la page API et services, puis cliquez sur Identifiants dans le menu de navigation.

  3. Si vous n'avez pas encore configuré votre écran de consentement pour ce projet Google Cloud, le bouton Configurer l'écran de consentement s'affiche. Dans ce cas, configurez votre écran de consentement en suivant la procédure ci-dessous. Sinon, passez à la section suivante.

    1. Cliquez sur Configurer l'écran d'autorisation. La page Écran de consentement OAuth s'affiche.
    2. Selon votre cas d'utilisation, sélectionnez Interne ou Externe, puis cliquez sur Créer. Le volet Écran de consentement OAuth s'affiche.
    3. Saisissez les informations sur la page Informations sur l'application en suivant les instructions à l'écran, puis cliquez sur Enregistrer et continuer. Le volet Champs d'application s'affiche.
    4. Vous n'avez pas besoin d'ajouter de champs d'application. Cliquez donc sur Enregistrer et continuer. Le volet Utilisateurs de test s'affiche.
    5. Si vous souhaitez ajouter des utilisateurs pour tester l'accès à votre application, cliquez sur Ajouter des utilisateurs. Le volet Ajouter des utilisateurs s'affiche. Les utilisateurs tests ont le droit d'accorder des autorisations dans votre application.
    6. Dans le champ vide, ajoutez une ou plusieurs adresses e-mail de compte Google, puis cliquez sur Ajouter.
    7. Cliquez sur Enregistrer et continuer. Le volet Summary (Récapitulatif) s'affiche.
    8. Vérifiez les informations de votre écran de consentement OAuth, puis cliquez sur Retour au tableau de bord.

Pour en savoir plus, consultez la page d'aide de la Google Cloud Console Configurer votre écran de consentement OAuth.

Télécharger le code source

Le code source de l'application exemple est disponible sur GitHub.

Accédez à l'emplacement où vous souhaitez enregistrer le projet, puis clonez-le:

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

Configurez le SDK

Les API Home de cette version bêta ouverte ne font pas encore partie des bibliothèques standards fournies par Google pour le développement. Pour développer des applications avec les API Home, vous devez télécharger et héberger les bibliothèques en local.

Pour télécharger le SDK Android des API Home, vous devez d'abord être connecté à Google Home Developers.

Se connecter

Compiler et exécuter

  1. Ouvrez Android Studio, puis le dossier de projet google-home-api-sample-app-android cloné sur votre ordinateur local.
  2. Lors de la première configuration, Android Studio peut prendre jusqu'à 10 minutes pour télécharger toutes les dépendances du projet et effectuer la compilation Gradle.
    • Si une erreur s'affiche à cette étape, par exemple Gradle Sync Failed, cliquez sur Réessayer pour relancer la synchronisation.
  3. Remplacez le nom de package de l'application exemple par un autre qui n'a jamais été enregistré, par exemple un nom basé sur celui de votre organisation :
    1. Ouvrez le projet.
    2. Développez la hiérarchie des sources.
    3. Sélectionnez la partie du package que vous souhaitez modifier, c'est-à-dire com.example.
    4. Effectuez un clic droit sur le package, puis sélectionnez Refactor > Rename (Refactoriser > Renommer).
    5. Cliquez sur Tous les répertoires.
    6. Saisissez le nouveau nom, puis cliquez sur Refactor (Refactoriser).
    7. Modifiez le fichier build.gradle.kts en remplaçant android namespace et applicationId par le nouveau nom du package.
    8. Modifiez le fichier AndroidManifest.xml et remplacez le package par le nouveau nom de package partout où il apparaît dans le fichier.

  4. Générez un certificat de signature d'application de débogage en exécutant l'application dans Android Studio. Lorsque vous exécutez ou déboguez une application dans Android Studio, Android Studio génère automatiquement un certificat de signature d'application destiné au développement et au débogage. Pour une explication complète, consultez Android Studio: signer votre version de débogage.

    Connectez votre appareil mobile à votre ordinateur local. Android Studio affiche vos appareils connectés par numéro de modèle. Sélectionnez votre appareil dans la liste, puis cliquez sur Exécuter le projet. L'application exemple est ainsi créée et installée sur votre appareil mobile.

    Pour obtenir des instructions plus détaillées, consultez Exécuter des applications sur un appareil matériel sur le site des développeurs Android.

    Arrêtez maintenant l'application en cours d'exécution.

  5. Obtenez l'empreinte SHA-1 de votre certificat de débogage en suivant les instructions détaillées dans la section Configurer OAuth 2.0 / Applications natives / Android sur le site d'aide de la console Google Cloud.

  6. Enregistrez l'application exemple pour OAuth 2.0 et créez des identifiants OAuth en suivant les instructions fournies dans la section Configurer OAuth 2.0.

    1. Indiquez le type d'application, qui est application native/Android.
    2. Ajoutez l'empreinte SHA-1 au client OAuth en suivant les instructions de la section Configurer OAuth 2.0 / Applications natives / Android sur le site d'aide de la console Google Cloud. Vous devez générer la clé SHA-1 à partir de la clé Android Studio par défaut tout au long du processus de développement.
    3. Ajoutez des utilisateurs tests. Les utilisateurs tests ont le droit d'accorder des autorisations dans l'application exemple.

  7. Une fois votre appareil mobile connecté à votre ordinateur local, cliquez à nouveau sur Run project (Exécuter le projet) pour exécuter l'application exemple sur votre appareil mobile.

Une fois installée, l'application est disponible sur votre appareil mobile sous le nom Application exemple de l'API Home.