Google Home Playground

The Google Home Playground is a web application that allows you to simulate a smart home project by simulating a virtual home with configurable device types and traits. The Home playground allows you to create virtual devices, modify the device attributes and states, view these devices in Home Graph, and import or export device configurations.

Complete account linking

To use Google Home Playground, you must first link the tool to your account. Open Google Home app on your phone, and complete account linking as following:

  1. Click the plus (+) icon at the top left corner.
  2. Select Set up device > Works with Google.
  3. Search for the Action titled Google Home Playground.
  4. Select the Action, and Google Home app will direct you to the sign-in page. Click Sign in with Google and select your account to sign in.
  5. Click the Authorize button to authorize account linking.
This figure shows the Google Home app account linking flow for
            connecting Google Home Playground.

Once you complete account linking, a set of default virtual devices will show on Google Home app for you to interact with.

This figure shows the default device list that populates when a user
            successfully links the Google Home Playground to their account.

Sign in

Launch Home playground by clicking the button below:

Launch Playground

Click Sign in with Google. Make sure to sign in with the same account you used in the Google Home app to complete account linking.

This figure shows the initial state of the Google Home Playground,
            and highlights the sign-in button in the upper right-hand corner.

After you sign in, Home playground will show the virtual devices stored in Home Graph.

This figure shows the device list, device info, and log area of the
            default view of Google Home Playground.

The web UI contains 3 panels from left to right:

  • Device list shows all your virtual devices. You can select a certain virtual device to view its information, and create or remove virtual devices via this panel.
  • Device info presents the selected virtual device’s information, including basic information, supported traits, trait attributes and states. You can also edit this information on the panel.
  • Log area displays the interaction logs between Home playground and Home Graph. You can expand the logs to inspect the request and response payloads for troubleshooting.

View virtual device info

On the Device list panel, select the virtual device to view. The Device Info panel will show its information in Home Graph, categorized into four tabs:

  • Basic information: top-level properties of the device, including device type, id, and name.
  • Traits: supported traits of the device.
  • Attributes: trait-specific attributes of the device.
  • States: all device states.

Edit virtual device info

Besides viewing a virtual device’s information, you can also directly edit its information stored in Home Graph via the Device info panel.

Modify supported traits

  1. Select the Traits tab; click the Edit button.
  2. In the pop-up panel, you can see the device's currently supported traits, and available traits to add. Use the arrow (→/←) buttons to add/remove supported traits for the device.
  3. When you've finished updating the supported traits, click Save, and the updated traits will be applied to Home Graph.
  4. You can view these trait updates in the Log area.
This figure shows the UX tool for adding or deleting supported
            traits on a selected device in the Google Home Playground.

Modify device attributes

  1. Select the Basic Information/Attributes tab, and edit the attribute for the traits supported by the device.
  2. Once you've finished editing, press Enter and your attribute changes will be applied to Home Graph.
  3. You can view these updated attributes in the Log area.

Modify device states

  1. Select the States tab and edit the state directly. The state changes will be applied to Home Graph.
  2. You can view these state modifications in the Log area.

Create a new virtual device

  1. On the Device list panel, click Add a device.
  2. In the pop-up panel, select the device type and input the device name for your new device. Alternatively, you can select a predefined set of devices to add.
  3. Once you complete all the steps, the new device will be added to Home Graph.
This figure shows the UX tool for adding a new device type in
            Google Home Playground.

Remove a virtual device

  1. On the Device list panel, hover over the device to remove until the trash can icon appears. Click the trash can() icon.
  2. Confirm the device removal in the pop-up alert.
  3. Once you confirm the device's removal, the device will be removed from Home Graph.

Import and Export virtual devices

For troubleshooting or reproducing issues, you can export your virtual devices with their states to a file, and share with others the file to import and replicate your virtual devices.

This figure shows the UX tool for importing and exporting virtual
            devices in Google Home Playground.

Export virtual devices to a file

  1. Click the Export button.
  2. Enter the file name you want to export, and click Ok
  3. Once you've input the file name, the browser will download the file of exported virtual devices.

Import virtual devices from a file

  1. Click the Import button.
  2. Select the file you want to import, and click Ok
  3. Once you confirm the file to import, Home playground will import virtual devices with states from the file, and update the imported devices’ information and states in Home Graph.

Inspect interaction logs

When you interact with the virtual devices, Home playground automatically applies your change to Home Graph. The interactions with Home Graph are recorded to the Log area panel, where you can expand each entry to inspect the Home Graph API request and response payloads.

Each log entry is a JSON array, containing elements of the following structure:

{
  "uri": string,
  "request": object,
  "response": object
}
Fields Type Description
uri string URL of the Home Graph API call.
request object Request body of the Home Graph API call. See the reference documentation for the format of each method.
response object Response body of the Home Graph API call. See the reference documentation for the format of each method.

View supported device types and traits

The question mark (?) button in the top right corner will display the current device type and trait list supported by Home playground.

This figure shows the UX tool for adding a new device type in
            Google Home Playground.