Report State Dashboard

This is a dashboard that developers can use to help them debug their smart home actions. It will obtain data from the HomeGraph and present it to you, allowing you to verify the data that is stored in it.

The app can be installed to Google App Engine or any Java Web Server.

Make sure to follow this guide to get a service account key

You can add a Giphy API key to giphy.service.ts to get animated images for each device type. Otherwise, a basic icon will show shown.

Setup

Run mvn compile. This will compile both the Java project and the web frontend.

Build client (separately)

First you need to build the web frontend that you will interact with:

cd src/main/ngapp
npm install
npm run build
# Built files will be added in src/main/webapp

Build and deploy server

Using Google App Engine

To set up your instance:

Use the Google Cloud Console to create a new App Engine application
1. When prompted, select the region where you want your App Engine application located.
Download and install the Google Cloud SDK if you haven't already
Download and install Maven if you haven't already
Configure the gcloud command-line environment:

gcloud init
gcloud auth application-default login

Install the App Engine component

gcloud components install app-engine-java

Verify that you are using the latest version of the Google Cloud SDK

gcloud components update

Deploy the sample with mvn appengine:deploy
1. It will be available at http://<your-project-id>.appspot.com
2. You can stream logs from the command line by running: gcloud app logs tail -s default

Note: You may have connectivity issues if you try to run the sample locally

Read the documentation on App Engine to learn more.

Other Java Web Servers

To install on any other Java Web Server:

mvn clean package

Deploy the war artifact from target/

To run locally:

mvn clean package spring-boot:repackage

Then run java -jar target/[artifact_name].war

References & Issues

Questions? Go to StackOverflow, Assistant Developer Community on Reddit or Support.
For bugs, please report an issue on Github.
Actions on Google Documentation

Make Contributions

Please read and follow the steps in the CONTRIBUTING.md.

License

See LICENSE.

Terms

Your use of this sample is subject to, and by using or downloading the sample files you agree to comply with, the Google APIs Terms of Service.

actions-on-google/smart-home-dashboard