Google Home IDE for VS Code

Google Home IDE, a Visual Studio Code extension (VSIX), is designed and created for Google Home Platform developers. This extension gives you access to Google Assistant Simulator, Cloud Logging, and other tools to simplify your smart home development process.

Google Home IDE for VS Code

Google Home IDE Features

Google Assistant Simulator

To test whether your smart home devices work properly with the Google Home ecosystem, you can interact with Google Assistant Simulator at any time without leaving VS Code.

Similar to the existing Assistant Simulator provided in the Actions Console, Google Assistant Simulator enables you to easily control your devices by typing your queries, for example, "Turn on the light." Inside VS Code, Google Assistant responds back with text messages based on your commands, for example, "Alright, turning on the light."

Test with Google Assistant Simulator

View Cloud Logging

Cloud Logging provides debugging information and key metrics to give you insights into your Action's usage. To simplify development, the Google Home IDE shows real-time Google Cloud Logging messages right next to your code during troubleshooting.

Select Cloud Logging Project Key

Download Google Home IDE

  1. Download and install Visual Studio Code (VS Code).

    Download VS Code

  2. Download Google Home IDE. Unzip the downloaded file to extract the VSIX file.

    Download Google Home IDE

Install Google Home IDE

You can install Google Home IDE from the command line or from VS Code.

Install from command line

To install from the command line, use --install-extension:

code --install-extension google-home-ide.vsix

Install from VS Code

If you'd like to install from VS Code, complete the following steps:

  1. Launch VS Code.
  2. Choose one of the following installation options.

    • Click Extensions from the Activity Bar. On the EXTENSIONS menu, click more options, then Install from VSIX....

      Install Google Home IDE from Extensions
    • Click Run a Command... from the Welcome page, or click View, then Command Palette.... In the Command Palette, type Install from VSIX.

      Install Google Home IDE from Command Palette
  3. When prompted, select the VSIX file that you downloaded and unzipped in the previous step.

For more information, refer to Microsoft's Extension Marketplace documentation.

Set up Google Home IDE

Once you've installed Google Home IDE and reloaded VS Code, you'll need to complete the following steps before you can use Google Assistant Simulator and view Cloud Logging:

Sign in with Google

You can sign in to your developer account from the Google Home IDE, authorizing VS Code to communicate with Google Assistant Simulator on your behalf.

  1. Click the Google Home icon on the Activity Bar to open Google Home IDE.

    Google Home IDE icon
  2. Click Sign in with Google to launch your browser.

    VS Code Google Sign in
  3. Choose the account that is linked with your smart home devices.

  4. On the Sign in with Google authorization page, click Allow.

  5. Copy your authorization code.

  6. Paste the code into the Google Home IDE Authorization code field, then click Enter.

    VS Code Google Sign in

Create Service Account Key

Google Home IDE uses Service Accounts to get access to cloud features of your smart home projects. To view Cloud logs of your projects in Google Home IDE, you'll need to create a service account from Google Cloud Platform and add the corresponding account key to the IDE.

  1. In Google Cloud Platform, select your project from the list.
  2. In the Google Cloud menu, click IAM & Admin, then select Service Accounts. Click + CREATE SERVICE ACCOUNT.
  3. Input Service account details, for example, Service Account for Google Home IDE and click CREATE AND CONTINUE.
  4. Add the Logs Viewer role to this service account and click DONE.
  5. Back on the Service Accounts page, in the Actions menu for the service account that you just created, select Manage keys.
  6. From the ADD KEY menu, select Create new key. Next, select Key type: JSON and click CREATE. The key automatically downloads to your device.

For help and additional resources, refer to Creating and managing service accounts and Cloud Logging documentation.

Add Service Account key to Google Home IDE

  1. Open Google Home IDE in VS Code.
  2. Click PROJECT SELECTION, then click Select Cloud Logging Project Key.

    Select Cloud Logging Project Key button
  3. Select the path to the project key that you downloaded in the previous step. You can add multiple keys and select the one you want to use for loading Cloud Logging.

    Add Cloud Logging Project Key
    Select Cloud Logging Project Key

Use Google Home IDE

View Developer Resources

In QUICK ACCESS, click Resources to open the Resources page, where you can find helpful information for your development with Google Home Ecosystem.

Resources for Google Home Ecosystem

Use Google Assistant Simulator

To open Google Assistant Simulator in VS Code, click GOOGLE ASSISTANT SIMULATOR on the Side Bar. In the Message box, type your query and press Enter.

You can view Google Assistant Simulator responses, and click the button after your query to Resend it.

Use Google Assistant Simulator

Click more options, then Clear History to clear your smart home queries and responses.

Use Google Assistant Simulator

View Cloud Logging

To open the Cloud Logging page in VS Code, choose from the following options:

  • Click Cloud Logging from QUICK ACCESS.

    Use Cloud Logging
  • Select the cloud project from PROJECT SELECTION on the Side Bar.

Once your logs are loaded, click any record to expand the full JSON payload.

View Cloud Logging

Send feedback

To submit your thoughts or feedback on how we can improve the development experience with Google Home IDE, choose from the following options:

  • On the Side Bar, click the feedback icon from GOOGLE SIGN IN.

    Use Google Assistant Simulator
  • We've also provided a feedback icon on the Resources page.