Depuración de la página principal local

1. Antes de comenzar

Las integraciones de casa inteligente permiten a Asistente de Google controlar los dispositivos conectados en los hogares de los usuarios. Para crear una Acción de casa inteligente, debes proporcionar un extremo de webhook de Cloud capaz de controlar intents de casa inteligente. Por ejemplo, cuando un usuario dice "Hey Google, enciende las luces", Asistente envía el comando a tu entrega de nube para actualizar el estado del dispositivo.

El SDK de Local Home mejora la integración de tu casa inteligente ya que agrega una ruta de acceso local para enrutar intents de casa inteligente directamente a un dispositivo Google Home, lo que mejora la confiabilidad y reduce la latencia al procesar comandos de los usuarios. Te permite implementar y escribir una app de entrega local en TypeScript o JavaScript que identifica dispositivos y ejecuta comandos en cualquier bocina inteligente de Google Home o en una pantalla inteligente Google Nest. Luego, tu app se comunica directamente con los dispositivos inteligentes existentes de los usuarios mediante la red de área local mediante protocolos estándar existentes para completar los comandos.

La depuración de Acciones para casas inteligentes es un paso fundamental para compilar tus Acciones con calidad de producción. Sin embargo, es desafiante y demanda mucho tiempo sin herramientas informativas y fáciles de usar de solución de problemas y pruebas. Para facilitar la depuración de Acciones para casas inteligentes, encontrarás las Métricas, Logging y el Conjunto de pruebas para casas inteligentes de Google Cloud Platform (GCP) que te ayudarán a identificar y resolver los problemas relacionados con tus Acciones.

Requisitos previos

• Guía para desarrolladores sobre Cómo crear una Acción de casa inteligente
• Ejecuta el codelab Habilita la entrega local para acciones de casa inteligente.

Qué compilarás

En este codelab, compilarás una entrega local para Acciones de casa inteligente, la conectarás al Asistente y, luego, depurarás la app de Casa local a través del paquete de pruebas para casas inteligentes. Métricas y Logging de Google Cloud Platform (GCP).

Qué aprenderás

• Cómo usar las métricas de GCP y Logging para identificar y resolver problemas de producción
• Cómo usar el paquete de pruebas para identificar problemas funcionales y de API
• Cómo usar las herramientas para desarrolladores de Chrome mientras desarrollas tu app de Home local

Requisitos

• La versión más reciente de Google Chrome
• Un dispositivo iOS o Android con la app de Google Home instalada
• Una bocina inteligente Google Home o una pantalla inteligente Google Nest
• Node.js versión 10.16 o posterior
• Una Cuenta de Google
• Una cuenta de facturación de Google Cloud

2. Ejecuta la app de la lavadora

Obtén el código fuente

Haz clic en el siguiente vínculo para descargar la muestra de este codelab en tu máquina de desarrollo:

file_downloadDescarga el código fuente

O bien, puedes clonar el repositorio de GitHub desde la línea de comandos.

$ git clone https://github.com/google-home/smarthome-debug-local.git

Acerca del proyecto

La app de partida contiene subdirectorios y Cloud Functions similares al codelab Habilita la entrega local para acciones de casa inteligente. Pero en lugar de app-start, tenemos app-faulty aquí. Comenzaremos con una app de inicio local que funcione, pero no tan bien.

Cómo conectarse a Firebase

Usaremos el mismo proyecto que creaste en el codelab Habilita la entrega local para acciones de casa inteligente, pero implementaremos los archivos descargados en este codelab.

Navega al directorio app-faulty y, luego, configura Firebase CLI con el proyecto de acciones creado en el codelab Habilita la entrega local para acciones de casa inteligente:

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

Cómo implementar en Firebase

Navega a la carpeta app-faulty/functions y, luego, instala todas las dependencias necesarias con npm:

$ cd functions
$ npm install

Nota: Si ves el siguiente mensaje, puedes ignorarlo y continuar. La advertencia se debe a algunas dependencias más antiguas. Puedes encontrar más detalles aquí.

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

Navega al directorio app-faulty/local/ y ejecuta los siguientes comandos para descargar el compilador de TypeScript y compilar la app:

$ cd ../local
$ npm install
$ npm run build

Esta acción, compila la fuente index.ts (TypeScript) y coloca el siguiente contenido en el directorio app-faulty/public/local-home/:

• bundle.js: Salida de JavaScript compilada que contiene la app y las dependencias locales.
• index.html: Página de hosting local que se usa para publicar la app a fin de realizar pruebas en el dispositivo.

Ahora que ya instalaste las dependencias y configuraste tu proyecto, tienes todo listo para ejecutar la app por primera vez.

$ firebase deploy

Este es el resultado que debería ver en la consola:

...

✔ Deploy complete!

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

Este comando implementa una app web, junto con varias Cloud Functions para Firebase.

Actualiza HomeGraph

Abre la URL de Hosting en tu navegador (https://<project-id>.web.app) para ver la aplicación web. En la IU web, haz clic en el botón Refresh para actualizar HomeGraph a través de Request Sync con los metadatos más recientes del dispositivo de la app de la lavadora defectuosa:

Abre la app de Google Home y verifica que puedas ver el dispositivo de la lavadora con un nombre nuevo, "Lavadora defectuosa". Recuerda asignar el dispositivo a una habitación que tenga un dispositivo Nest.

3. Inicia la lavadora inteligente

Si ejecutaste el codelab Habilita la entrega local para acciones de casa inteligente, ya deberías haber iniciado la lavadora inteligente virtual. Si se detiene, recuerda reiniciar el dispositivo virtual.

Enciende el dispositivo

Ve al directorio virtual-device/ y ejecuta la secuencia de comandos del dispositivo. Para ello, pasa los parámetros de configuración como argumentos:

$ cd ../../virtual-device
$ npm install
$ npm start -- \
  --deviceId=deviceid123 --projectId=<project-id> \
  --discoveryPortOut=3311 --discoveryPacket=HelloLocalHomeSDK

Verifica que la secuencia de comandos del dispositivo se ejecute con los parámetros esperados:

(...): UDP Server listening on 3311
(...): Device listening on port 3388
(...): Report State successful

4. Prueba la app de Local Home

Envía comandos por voz al dispositivo Google Home mediante comandos por voz, como los siguientes:

"Hey Google, enciende la lavadora".

"Hey Google, inicia mi lavadora".

"Hey Google, fuerza local".

"Hey Google, detén la lavadora".

Notarás que Asistente de Google responde con el mensaje "Lo siento, parece que la lavadora con fallas no está disponible en este momento". cuando intentas controlar la lavadora después de “forzar localmente”.

Esto significa que no se puede acceder al dispositivo a través de una ruta local. Funcionó antes de emitir "Hey Google, forzar la ubicación local" porque volveremos a usar la ruta de la nube cuando no se pueda acceder al dispositivo a través de una ruta local. Sin embargo, después de “forzar la ubicación local”, se inhabilita la opción de volver a la ruta de la nube.

Para descubrir cuál es el problema, usemos las herramientas que tenemos: Métricas y Logging de Google Cloud Platform (GCP), y Herramientas para desarrolladores de Chrome.

5. Cómo depurar la app de Home local

En la siguiente sección, usarás las herramientas que proporciona Google para averiguar por qué no se puede acceder al dispositivo a través de la ruta local. Puedes usar las Herramientas para desarrolladores de Google Chrome para conectarte al dispositivo Google Home, ver los registros de la consola y depurar la app de Local Home. También puedes enviar registros personalizados a Cloud Logging para que estés al tanto de los errores principales que encuentran los usuarios en la app de Local Home.

Cómo conectar las Herramientas para desarrolladores de Chrome

Para conectar el depurador a tu app de entrega local, sigue estos pasos:

1. Asegúrate de haber vinculado tu dispositivo Google Home a un usuario con permiso para acceder al proyecto de la Consola de Actions.
2. Reinicia tu dispositivo Google Home, lo que te permite obtener la URL del código HTML y la configuración de análisis que se coloca en la Consola de Actions.
3. Inicia Chrome en tu máquina de desarrollo.
4. Abre una nueva pestaña de Chrome e ingresa chrome://inspect en el campo de dirección a fin de iniciar el inspector.

Deberías ver una lista de dispositivos en la página y la URL de tu app debería aparecer debajo del nombre de tu dispositivo Google Home.

Cómo iniciar el inspector

Haz clic en Inspeccionar debajo de la URL de tu app para iniciar las Herramientas para desarrolladores de Chrome. Selecciona la pestaña Console y verifica que puedas ver el contenido del intent IDENTIFY impreso por tu app de TypeScript.

Este resultado significa que el controlador IDENTIFY se activó correctamente, pero el verificationId que se muestra en IdentifyResponse no coincide con ninguno de los dispositivos de tu HomeGraph. Agreguemos algunos registros personalizados para descubrir por qué.

Agrega registros personalizados

Aunque el SDK de Local Home muestra un error DEVICE_VERIFICATION_FAILED, no es muy útil para encontrar la causa raíz. Agreguemos algunos registros personalizados para asegurarnos de que estamos leyendo y procesando los datos del análisis correctamente y ten en cuenta que, si rechazamos la promesa con un error, el mensaje de error también se enviará a Cloud Logging.

local/index.ts

identifyHandler(request: IntentFlow.IdentifyRequest):
    Promise<IntentFlow.IdentifyResponse> {
  console.log("IDENTIFY intent: " + JSON.stringify(request, null, 2));

  const scanData = request.inputs[0].payload.device.udpScanData;
  if (!scanData) {
    const err = new IntentFlow.HandlerError(request.requestId,
        'invalid_request', 'Invalid scan data');
    return Promise.reject(err);
  }

  // In this codelab, the scan data contains only local device id.
  // Is there something wrong here?
  const localDeviceId = Buffer.from(scanData.data);
  console.log(`IDENTIFY handler: received local device id
      ${localDeviceId}`);

  // Add custom logs
  if (!localDeviceId.toString().match(/^deviceid[0-9]{3}$/gi)) {
    const err = new IntentFlow.HandlerError(request.requestId,
        'invalid_device', 'Invalid device id from scan data ' +
        localDeviceId);
    return Promise.reject(err);
  }

  const response: IntentFlow.IdentifyResponse = {
    intent: Intents.IDENTIFY,
    requestId: request.requestId,
    payload: {
      device: {
        id: 'washer',
        verificationId: localDeviceId.toString(),
      }
    }
  };
  console.log("IDENTIFY response: " + JSON.stringify(response, null, 2));

  return Promise.resolve(response);
}

Además, cambia la versión de la app de inicio local para que podamos identificar si estamos usando la versión correcta.

local/index.ts

const localHomeSdk = new App('1.0.1');

Después de agregar los registros personalizados, debes volver a compilar la app y volver a implementarla en Firebase.

$ cd ../app-faulty/local
$ npm run build
$ firebase deploy --only hosting

Ahora, reinicia el dispositivo Google Home para que pueda cargar la app de Home local actualizada. Para saber si el dispositivo Google Home usa la versión esperada, consulta los registros de la consola en las Herramientas para desarrolladores de Chrome.

Accede a Cloud Logging

Veamos cómo usar Cloud Logging para encontrar los errores. Para acceder a Cloud Logging en tu proyecto, haz lo siguiente:

1. En la consola de Cloud Platform, ve a la página Proyectos.
2. Selecciona tu proyecto de casa inteligente.
3. En Operaciones, selecciona Logging > Explorador de registros.

El acceso a los datos de registro se administra a través de Identity and Access Management (IAM) para los usuarios de tu proyecto de Actions. Para obtener más detalles sobre los roles y permisos de los datos de registro, consulta Control de acceso de Cloud Logging.

Usa filtros avanzados

Sabemos que se producen errores en el intent IDENTIFY, ya que la ruta local no funciona porque no se puede identificar el dispositivo local. Sin embargo, queremos saber exactamente cuál es el problema, así que primero filtremos los errores que ocurren en el controlador IDENTIFY.

Haz clic en el botón de activación Mostrar consulta. Debería convertirse en un cuadro del Compilador de consultas. Ingresa jsonPayload.intent="IDENTIFY" en el cuadro Compilador de consultas y haz clic en el botón Ejecutar consulta.

Como resultado, obtendrás todos los registros de errores que se muestran en el controlador IDENTIFY. A continuación, expande el último error. Encontrarás el errorCode y el debugString que acabas de configurar cuando rechazas la promesa en el controlador IDENTIFY.

A partir del elemento debugString, podemos ver que el ID de dispositivo local no está en el formato esperado. La app de Local Home espera obtener el ID del dispositivo local como una cadena que comienza con deviceid seguida de 3 dígitos, pero el ID del dispositivo local es una cadena hexadecimal.

Cómo corregir el error

Si volvemos al código fuente en el que analizamos el ID de dispositivo local a partir de los datos de análisis, notamos que no proporcionamos la codificación cuando convertimos la cadena en bytes. Los datos del análisis se reciben como una cadena hexadecimal, por lo que debes pasar hex como la codificación de caracteres cuando llames a Buffer.from().

local/index.ts

identifyHandler(request: IntentFlow.IdentifyRequest):
    Promise<IntentFlow.IdentifyResponse> {
  console.log("IDENTIFY intent: " + JSON.stringify(request, null, 2));

  const scanData = request.inputs[0].payload.device.udpScanData;
  if (!scanData) {
    const err = new IntentFlow.HandlerError(request.requestId,
        'invalid_request', 'Invalid scan data');
    return Promise.reject(err);
  }

  // In this codelab, the scan data contains only local device id.
  const localDeviceId = Buffer.from(scanData.data, 'hex');
  console.log(`IDENTIFY handler: received local device id
      ${localDeviceId}`);

  if (!localDeviceId.toString().match(/^deviceid[0-9]{3}$/gi)) {
    const err = new IntentFlow.HandlerError(request.requestId,
      'invalid_device', 'Invalid device id from scan data ' +
      localDeviceId);
    return Promise.reject(err);
  }

  const response: IntentFlow.IdentifyResponse = {
    intent: Intents.IDENTIFY,
    requestId: request.requestId,
    payload: {
      device: {
        id: 'washer',
        verificationId: localDeviceId.toString(),
      }
    }
  };
  console.log("IDENTIFY response: " + JSON.stringify(response, null, 2));

  return Promise.resolve(response);
}

Además, cambia la versión de la app de inicio local para que podamos identificar si estamos usando la versión correcta.

local/index.ts

const localHomeSdk = new App('1.0.2');

Después de corregir el error, compila la app y vuelve a implementarla en Firebase. En la herramienta app-faulty/local, ejecuta el siguiente comando:

$ npm run build
$ firebase deploy --only hosting

Prueba tu corrección

Después de la implementación, reinicia el dispositivo Google Home para que pueda cargar la app de Home local actualizada. Asegúrate de que la versión de la app de inicio local sea 1.0.2. Esta vez, no deberías ver errores en la consola de Herramientas para desarrolladores de Chrome.

Ahora puedes volver a intentar enviar comandos al dispositivo.

"Hey Google, fuerza local".

"Hey Google, detén la lavadora".

"Hey Google, enciende la lavadora".

…

"Hey Google, forzar la configuración predeterminada".

6. Ejecuta el paquete de pruebas para la casa inteligente

Después de verificar el dispositivo con los controles de tacto en la app de Google Home o con comandos por voz, puedes usar el Paquete de pruebas para casa inteligente automatizado para validar los casos de uso según los tipos de dispositivo y las características asociadas con tu Acción. El paquete de pruebas ejecuta una serie de pruebas para detectar problemas en tu acción y muestra mensajes informativos sobre los casos de prueba fallidos para acelerar la depuración antes de sumergirte en los registros de eventos.

Ejecuta el paquete de pruebas para la casa inteligente

Sigue estas instrucciones para probar la Acción de tu casa inteligente con el paquete de pruebas:

1. En el navegador web, abre el Paquete de pruebas para casa inteligente.
2. Accede a Google con el botón de la esquina superior derecha. Esto permite que el paquete de pruebas envíe los comandos directamente a Asistente de Google.
3. En el campo ID del proyecto, ingresa el ID del proyecto de tu Acción de casa inteligente. Luego, haz clic en SIGUIENTE para continuar.
4. En el paso Configuración de pruebas, deberías ver la lavadora defectuosa en la sección Dispositivos y bandejas.
5. Inhabilita la opción Test Request Sync, ya que la app de la lavadora de muestra no tiene una IU para agregar, quitar o cambiar el nombre de la lavadora. En un sistema de producción, debes activar Solicitar sincronización cada vez que el usuario agregue, quite o cambie el nombre de los dispositivos.
6. Deja habilitada la opción SDK de Local Home, ya que probaremos las rutas de acceso local y en la nube.
7. Haz clic en Siguiente: Entorno de pruebas para comenzar a ejecutar la prueba.

Cuando se hayan completado las pruebas, notarás que fallan las pruebas Pause/Resume en la ruta local, mientras que las pruebas Pause/Resume en la ruta de acceso de la nube se aprueban.

Analizar mensaje de error

Observa con más detalle los mensajes de error de los casos de prueba fallidos. Te dicen cuál es el estado esperado para esa prueba y cuál fue el estado real. En este caso, para "Pause the Washer", el estado esperado es isPaused: true, pero en el estado real, obtuvimos isPaused: false. Del mismo modo, para "Pause the Washer", el estado esperado es isPaused: true, pero en el estado real, obtuvimos isPaused: false.

En los mensajes de error, que se ve como en la ruta de acceso local, estamos configurando el estado isPaused de forma inversa.

Identifica y corrige el error

Busquemos el código fuente donde la app de Local Home envía el comando de ejecución al dispositivo. getDataCommand() es la función que llama el executeHandler() para establecer payload en el comando de ejecución que se envía al dispositivo.

local/index.ts

getDataForCommand(command: string, params: IWasherParams): unknown {
    switch (command) {
        case 'action.devices.commands.OnOff':
            return {
                on: params.on ? true : false
            };
        case 'action.devices.commands.StartStop':
            return {
                isRunning: params.start ? true : false
            };
        case 'action.devices.commands.PauseUnpause':
            return {
                // Is there something wrong here?
                isPaused: params.pause ? false : true
            };
        default:
            console.error('Unknown command', command);
            return {};
    }
}

De hecho, estamos estableciendo isPause en el estado inverso. Se debe establecer en true cuando params.pause sea true y, de lo contrario, false. Corrijamos eso.

local/index.ts

getDataForCommand(command: string, params: IWasherParams): unknown {
    switch (command) {
        case 'action.devices.commands.OnOff':
            return {
                on: params.on ? true : false
            };
        case 'action.devices.commands.StartStop':
            return {
                isRunning: params.start ? true : false
            };
        case 'action.devices.commands.PauseUnpause':
            return {
                isPaused: params.pause ? true : false
            };
        default:
            console.error('Unknown command', command);
            return {};
    }
}

Cambia la versión de la app de Home local para que podamos identificar si estamos usando la versión correcta.

local/index.ts

const localHomeSdk = new App('1.0.3');

Recuerda compilar la app nuevamente y volver a implementarla en Firebase. En la herramienta app-faulty/local, ejecuta el siguiente comando:

$ npm run build
$ firebase deploy --only hosting

Ahora, reinicia el dispositivo Google Home para que pueda cargar la app de Home local actualizada. Asegúrate de que la versión de la app de Home local sea 1.0.3.

Prueba tu corrección

Ahora, vuelve a ejecutar el paquete de pruebas para casas inteligentes con los mismos parámetros de configuración y verás que todos los casos de prueba fueron aprobados.

7. Felicitaciones

¡Felicitaciones! Aprendiste a solucionar problemas de una app de Home local con el paquete de pruebas para casas inteligentes y Cloud Logging.

Más información

Puedes intentar hacer lo siguiente:

• Agrega más características compatibles a tu dispositivo y pruébalas con el paquete de pruebas.
• Agregar más registros personalizados en cada uno de los controladores de intents y verlos en Cloud Logging.
• Crea paneles, configura alertas y accede a los datos de métricas de manera programática para obtener métricas de uso útiles sobre tu acción.

También puedes obtener más información sobre cómo probar y enviar una Acción para su revisión, incluido el proceso de certificación para publicar tu Acción para los usuarios.