Application exemple Android pour les API Home

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

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 à celle-ci peuvent ne pas fonctionner correctement avec le SDK des API Home.

  Télécharger Android Studio

• Débogueur Android (adb).

  Installez adb.

  Pour ce faire, utilisez le gestionnaire de SDK.

Pour tester les API Home, vous aurez 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 connectée à ce compte de développement.
• Un réseau Wi-Fi.
• Pour accéder aux appareils Matter et les contrôler, vous avez également besoin d'un hub Google compatible avec les API Home. Pour en savoir plus, consultez Connectivité sur Android .

• Vous devez disposer d'au moins un appareil compatible dans la maison. Si cet appareil (ou tout autre appareil que vous souhaitez tester) utilise Thread, le hub doit également être un routeur de bordure Thread. L'application exemple Android est compatible avec les types d'appareils et les traits suivants :

  • Température des couleurs (allumer et éteindre, luminosité)
  • Capteur de contact (état booléen)
  • Lumière à intensité variable (allumée/éteinte, luminosité)
  • Lumière à spectre de couleurs étendu (allumée/éteinte, luminosité)
  • Switch générique
  • Capteur de présence (détection de présence)
  • Allumer/Éteindre la lumière (allumer et éteindre, luminosité)
  • Interrupteur marche/arrêt
  • Module de prise Marche/Arrêt (marche et arrêt)
  • Capteur Marche/Arrêt

Télécharger le code source

Le code source de l'exemple d'application 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 pour Android 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 Android 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 vous connecter à Google Home Developers.

Connectez-vous dès maintenant !

Développer l'application

1. Ouvrez Android Studio, puis ouvrez le dossier du projet google-home-api-sample-app-android qui a été cloné sur votre machine locale.

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 terminer la compilation Gradle.

3. Connectez votre ordinateur à un téléphone Android physique à l'aide d'un câble USB et activez ADB dans les options pour les développeurs. Assurez-vous que Android Studio peut se connecter au téléphone Android via ADB.

4. Modifiez le nom du package de l'application exemple en lui attribuant un nouveau nom qui n'a jamais été enregistré auparavant, 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. Saisissez le nouveau nom, puis cliquez sur Refactor (Refactoriser).
   6. Modifiez le fichier build.gradle.kts en remplaçant android namespace et applicationId par le nouveau nom du package.

5. Une fois toutes les bibliothèques requises téléchargées et la synchronisation Gradle terminée, cliquez sur le bouton Run (Exécuter) pour compiler et exécuter l'application. Lorsque l'application s'exécute correctement sur votre téléphone, la page principale de l'application exemple s'affiche.

Créer un certificat de signature

Lorsque vous exécutez ou déboguez une application dans Android Studio, un certificat de débogage destiné au développement et au débogage est automatiquement généré. Pour en savoir plus, consultez Android Studio : signer votre build de débogage.

1. 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 obtenir une explication complète, consultez Android Studio : signer votre version de débogage.

   Connectez votre appareil mobile à votre machine locale. Android Studio liste vos appareils connectés par numéro de modèle. Sélectionnez votre appareil dans la liste, puis cliquez sur Exécuter le projet. Cette commande compile et installe l'application exemple sur votre appareil mobile.

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

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

2. Obtenez l'empreinte SHA-1 de votre certificat de débogage en suivant les instructions détaillées dans Gérer les clients OAuth / Types d'application / Applications natives / Android sur le site d'aide de la console Google Cloud.

Configurer le consentement OAuth

1. Dans la console Google Cloud, accédez au tableau de bord du sélecteur de 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é l'écran d'autorisation pour ce projet Google Cloud, le bouton Configurer l'écran d'autorisation 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 d'autorisation 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. Cliquez sur Audience, puis sur le bouton + AJOUTER DES UTILISATEURS.
   6. Saisissez l'adresse e-mail de votre utilisateur de test, puis cliquez sur le bouton SAVE (ENREGISTRER).
   7. Cliquez sur Enregistrer et continuer. Le volet 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 Configurer votre écran de consentement OAuth sur le site d'aide de la console Google Cloud. Veillez à ajouter au moins un utilisateur test avant de continuer.

Configurer les identifiants OAuth

1. Enregistrez l'application exemple pour OAuth 2.0 et créez des identifiants OAuth en suivant les instructions fournies dans 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.

Exécuter l'application

1. Une fois votre appareil mobile connecté à votre ordinateur local, cliquez de nouveau sur 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 Home API Sample App.