pborges / gbridge Goto Github PK

Google Home Actions on Google Smart Home integration library

License: MIT License

Go 100.00%

gbridge's Introduction

G Bridge

-- work in progress --

Google smart home lets users control your connected devices through the Google Home app and the Google Assistant, which is available on more than 1 billion devices, like smart speakers, phones, cars, TVs, headphones, watches, and more. To connect your device with the Google Assistant, you need to build a smart home Action. Assistant handles how users trigger your Action (in multiple languages) and provides you with relevant metadata through Home Graph (such as a specific device based on user’s room); all you need to do is respond to the requests in your service.

This libary helps you to create a backend service for your Google Smart Home Action.

This libary is ported from actionssdk-smart-home-nodejs

Philosopy

-- TODO: Explain how this libary is structured.. e.g duck-typing and interfaces usage--

Useful links

Instructions

(these may not be up to date, google changed their process recently)

Create an action.json file

    {
      "actions": [{
        "name": "actions.devices",
        "deviceControl": {
        },
        "fulfillment": {
          "conversationName": "automation"
        }
      }],
      "conversations": {
        "automation" :
        {
          "name": "automation",
          "url": "https://<YOUR URL>/smarthome"
        }
      }
    }

Create a project on https://console.actions.google.com/
Click Use Actions SDK
Use the gActions CLI to run the command given with the 'action.json' file as your Action Package.
Click Okay.
Click ADD under App information.
Give your App some information like an invocation name, some description, and some policy and contact info.
Click Save.
Click Add under Account Linking.
Select Authorization Code for Grant Type.
Under Client Information, enter the client ID and secret from earlier.
The Authorization URL is the hosted URL of your app with '/oauth' as the path, e.g. https://<YOUR URL>/oauth
The Token URL is the hosted URL of your app with '/token' as the path, e.g. https://<YOUR URL>/token
Click TEST DRAFT
Open the Google Home App on your phone and navigate to the Home Control section
Click the 3 dots and go to Manage Accounts
Select your project from the Add New section

Example

Please see /examples/gbridge/ for examples on how to use this libary.

Notes

If you push an update to actions.json, you might have to unlink your account in google home and re-link it for testing to work from your phone
Place this service behind caddy or some other reverse proxy that does LetsEncrypt SSL, or do your own SSL encryption. Google needs your service to be reachable via HTTPs and a valid SSL certificate.

gbridge's People

Contributors

Stargazers

Watchers

Forkers

securingsincity frankfanslc

gbridge's Issues

Proposing Project Logo

Would be nice to have a logo for this project.

Verify all traits are uniquely named

While registering a device the ```TraitName``s need to be unique

Add all supported DeviceTraits

https://developers.google.com/assistant/smarthome/traits

Implement action.devices.QUERY

source the states for the requested devices and respond to QUERY requests

Add all the supported DeviceTypes

https://developers.google.com/assistant/smarthome/guides

Create GoDoc

To improve the usability of this libary, one should create a GoDoc. This could also improve adoption.

Currently all librarys, even the ones from Google are badly documented and hard to understand. Our goal should be to provide a simple and well documented library.

Make SimpleAuthenticationProvider store tokens on disk

Make SimpleAuthenticationProvider store tokens on disk so tokens can survive reboot of the service

https

Hi, it doesn't work, seems it need certificate files for SSL and aouth.

Devices from Example not showing Up

Hey @pborges ,

thank you for creating this libary. I'm currently trying to create a simple Google Actions Skill with it.

However i'm not able to get your example to work. The Action shows up on my Google Home Skill and i can get an Oauth Token from it. But after that, nothing happens. I expected the defined devices to show up in the Google Home App. The gBridge did not log an SYNC Request either.

Would be great if you could take a look at my code. I'm using a ngrok Tunnel for communication between the cloud and my pc.

package main

import (
	"fmt"
	"log"
	"net/http"
	"os"

	"github.com/gorilla/mux"
	"github.com/pborges/gbridge"
)

var addr = ":8081"

func main() {
	log.SetOutput(os.Stdout)
	log.SetFlags(log.LstdFlags | log.Lshortfile)

	r := mux.NewRouter()

	r.NotFoundHandler = http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
		log.Println("UNKKNOWN:", r.RequestURI)
	})

	r.HandleFunc("/", func(w http.ResponseWriter, r *http.Request) {
		log.Println("/")
		fmt.Fprint(w, "gAssistant Translator for S.A.M Online")
	})

	b := gbridge.Bridge{
		ClientId:     "950e4dcfe43dc656bd7caa4f8da05fb0", //as long as this matches the settings "Account linking" on actions console it works
		ClientSecret: "759568585e122274798c900839929486", //as long as this matches the settings "Account linking" on actions console it works
	}

	b.HandleExec(NewLight("1", "Testlampe"), func(dev gbridge.Device, req gbridge.CommandRequest, res *gbridge.CommandResponse) {
		log.Printf("DEBUG: Intent received.")
		log.Printf("Exec Cmd: %+v\n", req)
		res.Status = gbridge.CommandStatusSuccess
		res.States.Online = true
		res.States.On = req.Params.On
		log.Printf("Exec Res: %+v\n", res)
	})

	r.HandleFunc("/oauth", b.HandleOauth)
	r.HandleFunc("/token", b.HandleToken)
	r.HandleFunc("/smarthome", b.HandleSmartHome)
	log.Println("Listening:", addr)
	log.Println(http.ListenAndServe(addr, r))
}

func NewLight(id string, name string) gbridge.Device {
	d := gbridge.Device{
		Id:     id,
		Type:   gbridge.DeviceTypeLight,
		Traits: []gbridge.DeviceTrait{gbridge.DeviceTraitOnOff},
		Name: gbridge.DeviceName{
			DefaultNames: []string{name},
			Name:         name,
			Nicknames:    []string{name},
		},
	}
	return d
}

func NewSwitch(id string, name string) gbridge.Device {
	d := gbridge.Device{
		Id:     id,
		Type:   gbridge.DeviceTypeSwitch,
		Traits: []gbridge.DeviceTrait{gbridge.DeviceTraitOnOff},
		Name: gbridge.DeviceName{
			DefaultNames: []string{name},
			Name:         name,
			Nicknames:    []string{name},
		},
	}
	return d
}

https://blog.golang.org/using-go-modules

gbridge package is getting busy

Move traits/commands to new package

Version 2 API, basically a complete re-write to do this right

When a device is defined, a list of traits this device supports is passed in, when a response comes back it should include a map of the requested traits and their values