Homeware una API para Google Home

Homeware es una API para Google Home diseñada para que de una vez por todas puedas conectar tus dispositivos y circuitos a Google Home y Google Assitant de la forma correcta, sin usar IFTTT.

Homeware es una API y para hacerla funcionar debemos desplegarla.

El despliegue es el proceso por el cual ponemos en funcionamiento nuestra propia copia de Homeware y la configuramos para funcionar con nuestros datos.

Desplegar HomeWare

El proceso para desplegar HomeWare es tedioso, pero, para no te pierdas, lo vamos a realizar juntos.

Antes de comenzar debes tener en cuenta que HomeWare es una REST API que se despliega como un proyecto de Firebase, una plataforma de Google, y que para llevarlo a cabo necesitas una cuenta de Google. Debes usar siempre la misma cuenta, con independencia de en que dispositivo, plataforma o sitio web te encuentres durante el proceso de despliegue.

Control de la Actividad – Dando permisos

El control de actividad de Google nos permite controlar que tareas puede realizar Google con nuestra cuenta y que datos tiene permitido almacenar. Para poder usar HomeWare tenemos que asegurarnos de que están activos varios permisos con estos pasos:

2 Activar el apartado Actividad en la web y en aplicaciones

3 Activar el apartado Información de tus dispositivos

4 Activar el apartado Actividad de Voz y Audio

Actions on Google – Creando un proyecto

Todo el proceso de control de Google Home se basa en un proyecto que debemos crear en Actions on Google. Este proyecto sirve para configurar cómo y por donde se debe comunicar Google con la API de HomeWare. Sigue los siguientes pasos para que todo vaya como la seda.

2 SeleccionarNew project.

3 Elegir un nombre para el proyecto.

Para evitar problemas, es preferible que el proyecto se llame Home.

4 Seleccionar la categoría Home control.

5 Seleccionar Smart home.

6 Seleccionar Develop del menú superior y posteriormente Invocation del menú izquierdo.

7 Escribir Home como nombre de Display y hacer clic en el botón Save.

¡Ya hemos creado el proyecto de Actions on Google! Los proyectos en Google Cloud se identifican con un ‘ID de proyecto’. Este sirve para identificarlo en todas las plataformas y conocer la URL del proyecto. Debemos seguir los siguiente pasos para averiguar cual es el ID de proyecto.

8 Ir a la Consola de Firebase.

9 Seleccionar el proyecto Home.

10 Hacer clic en el engranaje que aparece en la parte superior del menú lateral.

11 Apuntar el ID de proyecto que aparece en pantalla para usarlo más adelante.

Habilitar HomeGraph – La API de Google

1 Abrir la consola de Google Cloud y seleccionar el nombre del proyecto con el desplegable que aparece en la barra superior de la página.

2 Ve a la sección de Credenciales en el menú APIs & Services del menú lateral izquierdo.

3 Hacer clic en Crear credenciales.

4 Selecciona API key.

Apunta la API key que ha generado Google ya que la necesitaremos más adelante.

Firebase CLI – Run it locally

Para poder trabajar con el código de la API y desplegarlo a Firebase necesitamos disponer de las herramientas adecuadas instaladas en el ordenador. Las siguientes instrucciones son para sistemas operativos basados en Linux. Si usas otro, no olvides que puedes recurrir a la documentación de Firebase para ver la forma correcta de hacerlo.

1 Abrir un terminal y ejecutar:

npm -g install firebase-tools

2 Verificar la instalación con:

firebase --version

3 Iniciar sesión con la cuenta de Google:

firebase login

4 Descargar o clonar el repositorio de HomeWare.

5 Entrar en el directorio API y ejecuta:

firebase use --add

6 Seleccionar el ID de proyecto y seguir las instrucciones.

7 Ir a la carpeta Functions e instalar las dependencias.

npm install

8 Crear las siguientes variables de entorno ejecutando:

firebase functions:config:set system.api-key="[API_key]" 

firebase functions:config:set system.api-uri="https://us-central1-[id].cloudfunctions.net"

Asegúrate de configurar las variables con los parámetros de tu proyecto.

• [API_key] es el API key que nos proporcionó Google desde su consola
• [id] es el ID de proyecto que obtuvimos del proyecto de Google Actions

9 Vuelve al directorio API y despliega la API

firebase deploy

Puedes entrar en https://[id].firebaseapp.com para verificar que el despliegue se ha realizado con éxito. Al entrar deberías ver un mensaje de bienvenida.

Base de datos de la API

1 Entrar en la consola de Firebase.

2 Seleccionar Database desde la sección Develop del menú lateral izquierdo.

3 Crear una nueva base de datos.

4 Habilitar tanto la configuración lectura como la de escritura.

5 Seleccionar Importar JSON desde el menú con 3 puntos verticales de la parte superior derecha.

6 Subir el archivo JSON que se encuentra en la carpeta Database del repositorio.

Configurar el proyecto en Google Actions

Llegados a este punto solo nos queda configurar el proyecto de Google Actions que creamos al principio. Gracias al proceso de configuración le indicaremos a Google donde está nuestra API y como tiene que comunicarse con ella.

1 Ir a la consola de Actions on Google y seleccionar el proyecto adecuado.

2 Ir a la sección Develop del menú superior y seleccionar Actions en el menú de la izquierda.

3 Indicar la URL de fullfilment usando el ID de tu proyecto.

https://us-central1-[id].cloudfunctions.net/smarthome

4 Clic en Save.

5 Ir a la sección Account linking del menú de la izquierda.

6 Marcar No, I only want to allow account creation on my website y clic en Save

7 Seleccionar OAuth y Authorization code y a a continuación hacer clic en Next.

8 Configurar la información de cliente como en la siguiente tabla y hacer clic en Next. Asegúrate de usar los datos de tu proyecto.

9 Habilitar Google to transmit clientID and secret via HTTP basic auth header en Configure your Client y clic en Next.

10 Escribir lo siguiente en el cuadro Testing instrucions y hacer clic en Save.

No authentication needed

11 Ir al simulador en la sección Test del menú superior.

12 Seleccionar START TESTING.

Llegados a este punto lo tenemos todo desplegado y preparado para funcionar.

Enlazar la cuenta en la aplicación Google Home

Aún nos queda por realizar un último paso crucial para el funcionamiento y consiste en conectar la aplicación de Google Home que debes instalar en tu Smartphone con el proyecto.

1 Abrir la aplicación Google Home en el Smartphone.

2 Seleccionar Añadir.

3 Clic en Nuevo dispositivo.

4 Seleccionar Funciona con Google.

5 Marca la opción similar a [Test] Home.

¡Lo tenemos! Ya está todo configurado. Si todo ha ido bien al volver a la página principal de la aplicación Google Home debe aparecer una bombilla inteligente (ficticia por ahora) llamada Bulb.

Desplegar el CMS

El CMS o Content Managment System es una aplicación web que nos permite crear dispositivos y modificar sus propiedades. Todo esto sin necesidad de manipular la base de datos de manera manual. ¡Con colores todo es más bonito!

1 Dirigirse a la Consola de Firebase

2 Hacer clic en el engranaje que aparece en la parte superior del menú lateral.

3 Apuntar la API Key que aparece en pantalla.

4 En la carpeta public que se encuentra en la carpeta API del proyecto, modificar todos los archivos JS para incluir el ID de proyecto y la API Key.

5 Volver a la carpeta API y ejecuta en el terminal:

firebase deploy --only hosting

Cambia [id] por el ID de tu proyecto en https://[id].firebaseapp.com/cms/  y dirígete a esa dirección para acceder al CMS. Debe aparecer una página de login en la cual introducir un usuario y una contraseña. Estas credenciales aún no están creadas, así que: ¡vamos allá!

6 Volver a la Consola de Firebase

7 Seleccionar la opción Authentication que se encuentra en el menú izquierdo.

8 En la pestaña SIGN-IN METHOD habilitar la opción Email/Password usando el icono del lápiz.

9 Volver a la pestaña USERS y crear un nuevo usuario.

Crear un dispositivo

Llegados a este punto, lo tenemos todo desplegado y solo nos queda crear nuestros propios dispositivos. ¡El límite está en cómo controles los electrones que te rodean!

1. Crear el dispositivo desde el CMS.
2. Preparar el ESP8266 y programarlo con alguno de los códigos de ejemplo.
3. ¡A volar!

En este vídeo repasamos cómo realizar los pasos anteriores convirtiendo un ESP8266 en una bombilla inteligente, ya que controlamos desde Google Home tanto su brillo como su estado de activación.

¿Alguna duda?¿Alguna idea? Compártela en los comentarios.