https://github.com/circuit/circuit-google-assistant

Google Assistant integration with Circuit
https://github.com/circuit/circuit-google-assistant

circuit google-assistant google-home webrtc

Last synced: about 2 months ago
JSON representation

Google Assistant integration with Circuit

• Host: GitHub
• URL: https://github.com/circuit/circuit-google-assistant
• Owner: circuit
• Created: 2017-02-15T03:55:21.000Z (almost 8 years ago)
• Default Branch: master
• Last Pushed: 2023-03-04T02:58:00.000Z (almost 2 years ago)
• Last Synced: 2024-04-11T15:42:23.584Z (10 months ago)
• Topics: circuit, google-assistant, google-home, webrtc
• Language: JavaScript
• Size: 1.22 MB
• Stars: 13
• Watchers: 12
• Forks: 4
• Open Issues: 6
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Circuit Virtual Assistant

Integration between Circuit and Google Home (Google Virtual Assistant). Google Conversation Actions are built using DialogFlow. The exported DialogFlow agent is available as `circuit-va.zip`.

You don't need a Google Home. [Google Assistant](https://assistant.google.com/) also works on any Android and even iOS phone, the [web simulator](https://developers.google.com/actions/tools/web-simulator).

## How it works

Google Assistant listens for and Invocation Name (e.g. Unify Circuit) to start the app and listens for commands. Once a match to an intent is found, the intent can either be handled on DialogFlow directly or by this node application via webhooks. The first time you launch the "Circuit Communicator", account linking is done via OAuth.

## Available in Google Assistant Store

Current version in store only works with circuitsandbox.net system.

https://assistant.google.com/services/a/uid/000000b54b860f99?hl=en

## Resources

 - https://developers.google.com/actions

 - https://dialogflow.com/

 - https://circuit.github.io/

 - https://circuitsandbox.net/sdk/

## Getting Started

### Configuration

Copy `config.json.template` as `config.json` and enter your credentials. You can request Circuit credentials at https://circuit.github.io/.

```json

// Get your own credentials at https://circuit.github.io

{

  "oauth": {

    "client_id": "",

    "domain": "circuitsandbox.net"

  }

}

```

### Run the node app

The node app needs to be publicly accessible for Google Home to call your webhooks. That means to either host the app (heroku, aws, google cloud, etc) or a much better solution for development is [ngrok](https://ngrok.com/).  The webhook url then needs to be entered on DialogFlow's fullfillment page.

```bash

    git clone https://github.com/yourcircuit/circuit-google-assistant.git

    cd circuit-google-assistant

    npm install

    npm start

```

### Screenshots