Bienvenue dans le Centre des développeurs Google Home, la nouvelle destination pour apprendre à développer des actions pour la maison connectée. Remarque : Vous continuerez à créer des actions dans la console Actions.

Déboguer la maison connectée

Restez organisé à l'aide des collections Enregistrez et classez les contenus selon vos préférences.

1. Avant de commencer

En tant que développeur de l'Internet des objets (IoT), vous pouvez créer des actions pour la maison connectée qui permettent à vos utilisateurs de contrôler leurs appareils via des commandes tactiles dans l'application Google Home et des commandes vocales avec l'Assistant Google.

A4657871181b5ad2.gif

L'apprentissage des outils de débogage pour les actions de maison connectée est une étape importante pour créer une intégration de qualité de production avec l'Assistant Google. Pour faciliter la surveillance et le débogage, les métriques Google Cloud Platform (GCP), Logging et la suite de tests pour la maison connectée sont disponibles pour vous aider à identifier et à résoudre les problèmes liés à vos actions.

Conditions préalables

Objectifs de l'atelier

Dans cet atelier de programmation, vous allez déployer une action de maison connectée avec deux défauts et la connecter à l'Assistant, puis déboguer les défauts de l'action via Test Suite pour les maisons connectées et les métriques Google Cloud Platform (GCP) et Logging.

Points abordés

  • Identifier et résoudre les problèmes de production à l'aide des métriques et de la journalisation GCP
  • Utiliser la suite Test pour la maison connectée afin d'identifier les problèmes fonctionnels et liés aux API

Ce dont vous avez besoin

2. Exécuter l'application défectueuse

Obtenir le code source

Cliquez sur le lien suivant pour télécharger l'exemple utilisé dans cet atelier de programmation sur votre ordinateur de développement :

Vous pouvez également cloner le dépôt GitHub à partir de la ligne de commande :

$ git clone https://github.com/googlecodelabs/smarthome-debug.git

À propos du projet

L'application de lave-linge contient les sous-répertoires suivants:

Se connecter à Firebase

Ouvrez le terminal sur votre ordinateur de développement. Accédez au répertoire washer-faulty, puis configurez la CLI Firebase avec votre projet Actions créé dans l'atelier de programmation "Connecter des appareils connectés" à l'Assistant Google:

$ cd washer-faulty
$ firebase use <project-id>

Déployer sur Firebase

Accédez au dossier functions et installez toutes les dépendances nécessaires à l'aide de npm..

$ cd functions
$ npm install

Remarque : Si le message ci-dessous s'affiche, vous pouvez ignorer cette étape et continuer. Cet avertissement est dû à des dépendances plus anciennes. Pour en savoir plus, cliquez ici.

found 5 high severity vulnerabilities
  run `npm audit fix` to fix them, or `npm audit` for details

Maintenant que vous avez installé les dépendances et configuré votre projet, vous êtes prêt à déployer l'application de lave-linge défectueux.

$ firebase deploy

La console doit afficher le résultat suivant :

...

✔ Deploy complete!

Project Console: https://console.firebase.google.com/project/<project-id>/overview
Hosting URL: https://<project-id>.firebaseapp.com

Mettre à jour HomeGraph

Ouvrez l'URL d'hébergement dans votre navigateur (https://<project-id>.firebaseapp.com) pour afficher l'application Web. Dans l'UI Web, cliquez sur le bouton Actualiser ae8d3b25777a5e30.png pour mettre à jour HomeGraph via Request Sync avec les dernières métadonnées de l'appareil provenant de l'application de lave-linge défectueux:

6f2b1344179977cf.png

Ouvrez l'application Google Home et vérifiez qu'il s'agit bien du lave-linge Lave-linge défectueux.

e357de6a7faff925.png

3. Tester votre Action

Après avoir déployé votre projet, vérifiez que votre action contrôle le lave-linge.

Tester le lave-linge

Vérifiez la modification de la valeur lorsque vous essayez l'une des commandes vocales suivantes sur votre téléphone:

"Hey Google, allume mon lave-linge."

"Hey Google, démarre mon lave-linge."

"Hey Google, mets mon lave-linge en pause."

"Hey Google, réactive mon lave-linge."

"Hey Google, arrête mon lave-linge."

Vous remarquerez que l'Assistant vous signale qu'il y a un problème par commande vocale lorsque vous mettez en pause / redémarrez le lave-linge:

"Désolé, je n'ai pas pu accéder à <nom à afficher du projet>."

Pour résoudre ce problème, vous devez d'abord obtenir plus d'informations sur l'erreur afin d'en identifier et d'identifier la cause.

Tableau de bord Analytics pour la maison connectée

Le tableau de bord d'analyse de la maison connectée regroupe les graphiques des métriques d'utilisation et de santé concernant votre traitement cloud:

  • Les métriques Utilisation reflètent la tendance d'utilisation de votre action de maison connectée, y compris le nombre d'utilisateurs actifs par jour et le nombre total de requêtes pour votre traitement.
  • Les métriques Santé vous permettent de surveiller les occurrences d'anomalies dans votre action de maison connectée, y compris la latence des requêtes, le pourcentage de réussite et la répartition des erreurs.

Pour identifier la cause de l'erreur, suivez les étapes ci-dessous pour accéder au tableau de bord du projet.

  1. Dans la console Actions, accédez à la page "Projets".
  2. Sélectionnez votre projet de maison connectée.
  3. Sélectionnez l'onglet Analytics, puis cliquez sur Accéder à Google Cloud Platform.

B1735bbe11a7aff8.png

  1. La liste des tableaux de bord de votre projet sur Google Cloud s'affiche. Sélectionnez le tableau de bord Google Home Analytics - Cloud Integration (Intégration Google Cloud - Intégration au cloud).

5edd3751323176dd.png

  1. Faites défiler la page jusqu'au graphique Erreurs de fulfillment Cloud – Répartition de l'état pour afficher les codes d'erreur pour la période sélectionnée.

C468743c20a11c15.png

Le code d'erreur PARTNER_RESPONSE_MISSING_DEVICE fournit un indice sur la cause première. Ensuite, récupérez les journaux d'événements en fonction du code d'erreur pour en savoir plus.

Accéder aux journaux d'événements

Pour en savoir plus sur cette erreur, accédez aux journaux d'événements de vos actions de maison connectée via Cloud Logging.

Ouvrez le menu de navigation dans Google Cloud Platform, puis, sous Opérations, sélectionnez Journaux > Explorateur de journaux pour accéder aux journaux d'événements de votre projet. Vous pouvez également rechercher Explorateur de journaux dans le champ de recherche.

Dans la section Requête, saisissez la requête PARTNER_RESPONSE_MISSING_DEVICE, puis cliquez sur Exécuter la requête. Les journaux correspondant à la requête sont affichés dans la section Résultats de la requête.

747cca0f1249a5a.png

Le journal des erreurs affiche un événement de maison connectée avec des détails d'erreur indiquant:

  • L'action effectuée par l'utilisateur est "reprise du lave-linge" (actionType: "STARTSTOP_UNPAUSE"), correspondant à la dernière commande vocale qui a échoué.
  • Le message de débogage associé est "JSON response does not include device."

Sur la base du message de débogage, vous devriez vérifier pourquoi l'application lave-linge n'inclut pas l'appareil approprié dans la réponse EXECUTE.

Identifier la cause première de l'erreur

Dans functions/index.js, recherchez le gestionnaire EXECUTE (dans le tableau onExecute) qui renvoie l'état de chaque commande et le nouvel état de l'appareil. L'insertion des ID d'appareil dans une réponse EXECUTE dépend de la résolution de la fonction updateDevice:

index.js

app.onExecute(async (body) => {
 ...

 for (const command of intent.payload.commands) {
   for (const device of command.devices) {
     for (const execution of command.execution) {
       executePromises.push(
           updateDevice(execution, device.id)
               .then((data) => {
                 result.ids.push(device.id);
                 Object.assign(result.states, data);
               })
               .catch((e) =>
                 functions.logger.error('EXECUTE',
                     device.id, e.message)));
     }
   }
 }

Vérifiez également que la fonction updateDevice gère les temps de pause et de reprise sur le lave-linge. La chaîne à rechercher pour la commande pause/resume est incorrecte:

index.js

const updateDevice = async (execution, deviceId) => {
 const {params, command} = execution;
 let state; let ref;
 switch (command) {
   ...
   case 'action.devices.commands.PauseUnpausePause':
     state = {isPaused: params.pause};
     if (params.pause) state.isRunning = false;
     ref = firebaseRef.child(deviceId).child('StartStop');
     break;
 }

 return ref.update(state)
     .then(() => state);
};

Corriger l'erreur

Maintenant que vous avez identifié la cause première de l'erreur, vous pouvez corriger la chaîne de la commande de pause / reprise:

index.js

const updateDevice = async (execution, deviceId) => {
 const {params, command} = execution;
 let state; let ref;
 switch (command) {
   ...
   case 'action.devices.commands.PauseUnpause':
     state = {isPaused: params.pause};
     if (params.pause) state.isRunning = false;
     ref = firebaseRef.child(deviceId).child('StartStop');
     break;
 }

 return ref.update(state)
     .then(() => state);
};

Tester votre correctif

Déployez le code mis à jour à l'aide de la CLI Firebase :

firebase deploy --only functions

Si vous essayez de relancer les commandes vocales ci-dessous, vous constaterez que l'Assistant répond correctement dès que vous mettez en pause / redémarrez le lave-linge.

"Hey Google, mets mon lave-linge en pause."

=>

"D'accord, pause du lave-linge."

"Hey Google, réactive mon lave-linge."

=>

"OK, reprise du lave-linge."

Vous pouvez également tester l'état actuel de votre lave-linge en posant des questions.

"Hey Google, est-ce que mon lave-linge est allumé ?"

"Hey Google, est-ce que mon lave-linge est en marche ?"

"Hey Google, quel est le cycle défini sur mon lave-linge ?"

4. Tester votre action avec la suite de tests

En plus des tests manuels, vous pouvez utiliser la suite de test automatisée pour la maison connectée pour valider des cas d'utilisation en fonction des types d'appareils et des caractéristiques associés à votre action. La suite de tests exécute une série de tests pour détecter les problèmes dans votre action et affiche des messages d'information pour les scénarios de test ayant échoué afin d'accélérer votre débogage avant de plonger dans les journaux des événements.

Exécuter la suite de tests pour la maison connectée

Suivez les instructions ci-dessous pour tester votre Action Home par Test Suite:

  1. Dans votre navigateur Web, ouvrez la suite de test pour la maison connectée.
  2. Connectez-vous à Google à l'aide du bouton situé dans l'angle supérieur droit. Cela permet à la suite de tests d'envoyer les commandes directement à l'Assistant Google.
  3. Dans le champ ID du projet, saisissez l'ID de projet de votre action pour la maison connectée. Ensuite, cliquez sur SUIVANT pour continuer.
  4. À l'étape Tester les paramètres, la suite de tests indique le type d'appareil et les caractéristiques du lave-linge.

78ed6a1ebdb581bf.png

  1. Désactivez l'option Tester la synchronisation, car l'exemple d'application de lave-linge ne dispose pas d'une interface utilisateur permettant d'ajouter, de supprimer ou de renommer le lave-linge. Dans un système de production, vous devez déclencher Request Sync chaque fois que l'utilisateur ajoute, supprime ou renomme des appareils.
  2. Cliquez sur SUIVANT pour commencer à exécuter le test.

Une fois l'exécution de la suite de tests terminée, consultez les résultats des scénarios de test. Vous remarquerez que deux scénarios de test ayant échoué sont signalés avec le message d'erreur correspondant:

5838d10631c98ed2.png

Pour résoudre le problème lié à votre action de maison connectée, vous devez d'abord identifier la cause de l'erreur en analysant le message d'erreur.

Analyser le message d'erreur

Afin d'aider les développeurs à identifier l'origine du problème, la suite de tests affiche des messages d'erreur pour chaque scénario de test ayant échoué.

Pour le premier scénario de test ayant échoué ci-dessus,

99e4e5d06965a8a7.png

son message d'erreur indique que la suite de tests attend "isPause": true dans les états indiqués dans votre action de maison connectée, mais les états réels n'incluent que "isPause": false.

En outre, le deuxième message d'erreur du scénario de test ayant échoué indique que les états indiqués dans la réponse QUERY de votre action pour la maison connectée incluent "isPause": true, qui diffère de "isPause": false dans les états signalés:

fdb5124102e3a37.png

En fonction de ces deux messages d'erreur, vous devez ensuite vérifier si vos rapports d'action indiquent isPaused avec la valeur correcte.

Identifier la cause première de l'erreur

Ouvrez functions/index.js, qui contient la fonction reportstate qui intègre les modifications d'état à Home Graph via l'état du rapport. En examinant la charge utile de l'état du rapport, vous constaterez qu'il manque l'état isPaused, qui correspond exactement à ce que la suite de tests a vérifié dans les scénarios de test ayant échoué.

index.js

exports.reportstate = functions.database.ref('{deviceId}').onWrite(
    async (change, context) => {
      ...

      const requestBody = {
        requestId: 'ff36a3cc', /* Any unique ID */
        agentUserId: USER_ID,
        payload: {
          devices: {
            states: {
              /* Report the current state of our washer */
             [context.params.deviceId]: {
                online: true,
                on: snapshot.OnOff.on,
                isRunning: snapshot.StartStop.isRunning,
                currentRunCycle: [{
                  currentCycle: 'rinse',
                  nextCycle: 'spin',
                  lang: 'en',
                }],
                currentTotalRemainingTime: 1212,
                currentCycleRemainingTime: 301,
              },
            },
          },
        },
      };

      const res = await homegraph.devices.reportStateAndNotification({
        requestBody,
      });
      ...
    });

Corriger l'erreur

Maintenant que vous avez identifié la cause première de l'erreur, modifiez functions/index.js en ajoutant l'état isPaused à la charge utile "State Report" :

index.js

exports.reportstate = functions.database.ref('{deviceId}').onWrite(
    async (change, context) => {
      ...

      const requestBody = {
        requestId: 'ff36a3cc', /* Any unique ID */
        agentUserId: USER_ID,
        payload: {
          devices: {
            states: {
              /* Report the current state of our washer */
             [context.params.deviceId]: {
                online: true,
                on: snapshot.OnOff.on,
                isPaused: snapshot.StartStop.isPaused,
                isRunning: snapshot.StartStop.isRunning,
                currentRunCycle: [{
                  currentCycle: 'rinse',
                  nextCycle: 'spin',
                  lang: 'en',
                }],
                currentTotalRemainingTime: 1212,
                currentCycleRemainingTime: 301,
              },
            },
          },
        },
      };
      ...
    });

Tester votre correctif

Déployez le code mis à jour à l'aide de la CLI Firebase :

$ firebase deploy --only functions

Si vous exécutez à nouveau la suite de tests pour maison connectée, vous constaterez que tous les scénarios de test ont réussi.

148837f85d377dd6.png

5. Félicitations !

17d485868a6771bc.png

Félicitations ! Vous avez appris à résoudre les problèmes liés aux actions dans la maison connectée via la suite de tests pour la maison connectée, les métriques et la journalisation GCP.

En savoir plus

En complément de cet atelier de programmation, faites ces exercices et découvrez d'autres ressources :

Vous pouvez également découvrir comment tester et envoyer une action pour examen, y compris le processus de certification permettant de la publier auprès des utilisateurs.