Cuando los dispositivos o solicitudes no funcionan como se espera, es importante proporcionar un buen manejo de errores y comunicación para tus usuarios a fin de que comprendan lo que sucedió y cómo sea posible. Asegúrate de pensar en posibles situaciones de falla y cómo responderá tu dispositivo: ¿qué sucede si un usuario interrumpe una tarea en curso? ¿Qué sucede si un usuario solicita una acción de un dispositivo mientras está sin conexión? Planificar estos problemas y ayudar a que el usuario se recupere de ellos puede evitarle frustración y crea una experiencia de mayor calidad para tus dispositivos.
En esta guía, se proporcionan algunos ejemplos de respuestas a intents que controlan errores. Consulta Errores y excepciones para revisar los valores errorCode válidos en busca de errores y excepciones.
Ejemplo 1: Respuesta de error para el intent EXECUTE
Un usuario final tiene dos lámparas inteligentes instaladas en la sala de estar. El usuario emite un comando “enciende las luces de la sala de estar” y Google envió un intent EXECUTE a tu URL de entrega. Notaste que los dispositivos del usuario están sin conexión y no se pueden controlar, por lo que la entrega muestra una respuesta EXECUTE con status ERROR y errorCode deviceOffline.
En este ejemplo, se muestra cómo mostrar una respuesta EXECUTE con un errorCode de un dispositivo ligero, como se describió antes:
{
"requestId": "ff36a3cc-ec34-11e6-b1a0-64510650abcf",
"payload": {
"commands": [
{
"ids": [
"light-device-id-1"
],
"status": "ERROR",
"errorCode": "deviceOffline"
},
{
"ids": [
"light-device-id-2"
],
"status": "ERROR",
"errorCode": "deviceOffline"
}
]
}
}
La Google Assistant le solicitará al usuario que "el dispositivo no esté disponible en este momento" después de recibir la respuesta. Recuerda que aún debes enviar el estado sin conexión para dispositivos en estado de informe después de enviar errorCode deviceOffline en la respuesta de EXECUTE.
Ejemplo 2: Excepción sin bloqueo para el intent EXECUTE
Un usuario intenta bloquear su cerradura inteligente en la puerta principal mediante el dispositivo con Assistant. Puedes controlar su bloqueo con éxito, pero notas que la batería del dispositivo está baja, por lo que la entrega muestra una respuesta EXECUTE con status SUCCESS y exceptionCode lowBattery.
En este ejemplo, se muestra cómo enviar una respuesta EXECUTE con un exceptionCode desde un dispositivo de bloqueo como se describió anteriormente:
{
"requestId": "ff36a3cc-ec34-11e6-b1a0-64510650abcf",
"payload": {
"commands": [{
"ids": ["lock-device-id-1"],
"status": "SUCCESS",
"states": {
"on": true,
"online": true,
"isLocked": true,
"isJammed": false,
"exceptionCode": "lowBattery"
}
}]
}
}
El Assistant le pedirá al usuario que "el dispositivo tiene poca batería" después de recibir la respuesta.
Ejemplo 3: Notificaciones proactivas de errores
En algunos casos, puede ser útil alertar a los usuarios sobre un error, en especial para las funciones que esperan completar automáticamente. Para las características que admiten notificaciones proactivas, puedes notificar al usuario de forma proactiva mientras se produce un error si implementaste las notificaciones proactivas smart home.
Una secadora inteligente está funcionando, y alguien abre la puerta antes de que finalice el ciclo.
Puedes llamar al método reportStateAndNotifications de la API de Google Home Graph para enviar una notificación proactiva con un errorCode:
En este ejemplo, se muestra cómo enviar una notificación proactiva con un errorCode desde un dispositivo secador, como se describió antes:
POST https://homegraph.googleapis.com/v1/devices:reportStateAndNotification
{
"requestId": "ff36a3cc-ec34-11e6-b1a0-64510650abcf",
"agentUserId": "agent-user-id",
"eventId": "unique-event-id",
"payload": {
"devices": {
"notifications": {
"dryer-device-id": {
"RunCycle": {
"priority": 0,
"status": "FAILURE",
"errorCode": "deviceDoorOpen"
}
}
},
"states": {
"dryer-device-id": {
"isRunning": false,
"isPaused": true
}
}
}
}
}
El Assistant le solicitará al usuario que "la puerta del dispositivo esté abierta" después de recibir la notificación. Puedes enviar los estados del dispositivo correspondiente junto con las notificaciones en la misma carga útil.
Ejemplo 4: Notificación de seguimiento
Para los comandos de características que admiten notificaciones de seguimiento, puedes enviar una notificación de seguimiento al usuario mientras se produce un error o una excepción, si implementaste smart home notificaciones de seguimiento.
Un usuario ejecuta un comando para cerrar la puerta de su cochera, pero esta se atasca mientras se cierra. Puedes enviar una notificación de seguimiento con un errorCode:
POST https://homegraph.googleapis.com/v1/devices:reportStateAndNotification
{
"requestId": "ff36a3cc-ec34-11e6-b1a0-64510650abcf",
"agentUserId": "agent-user-id",
"eventId": "unique-event-id",
"payload": {
"devices": {
"notifications": {
"door-device-id": {
"LockUnlock": {
"priority": 0,
"followUpResponse": {
"status": "FAILURE",
"errorCode": "deviceJammingDetected",
"followUpToken": "follow-up-token-1"
}
}
}
},
"states": {
"door-device-id": {
"openPercent": 70
}
}
}
}
}
Assistant le solicitará al usuario que "el dispositivo esté atascado" después de recibir la notificación. Puedes enviar los estados del dispositivo correspondiente con notificaciones en la misma carga útil.
Para obtener más información y detalles sobre errorCodes, consulta la documentación de referencia sobre errores y excepciones.