Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/hiromaily/go-google-home
It makes Google Home speak something by both command line and web server and is same to google-home-notifier.
https://github.com/hiromaily/go-google-home
go golang google-home
Last synced: about 2 months ago
JSON representation
It makes Google Home speak something by both command line and web server and is same to google-home-notifier.
- Host: GitHub
- URL: https://github.com/hiromaily/go-google-home
- Owner: hiromaily
- License: mit
- Created: 2018-01-20T16:38:40.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2023-11-23T02:36:18.000Z (about 1 year ago)
- Last Synced: 2024-06-20T14:21:14.487Z (7 months ago)
- Topics: go, golang, google-home
- Language: Go
- Homepage:
- Size: 21.3 MB
- Stars: 6
- Watchers: 3
- Forks: 2
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# go-google-home
[](https://travis-ci.org/hiromaily/go-google-home)
[](https://goreportcard.com/report/github.com/hiromaily/go-google-home)
[](https://codebeat.co/projects/github-com-hiromaily-go-google-home-master)
[](https://www.codacy.com/app/hiromaily2/go-google-home?utm_source=github.com&utm_medium=referral&utm_content=hiromaily/go-google-home&utm_campaign=Badge_Grade)
[](https://raw.githubusercontent.com/hiromaily/go-goa/master/LICENSE)
It makes Google Home spoken something and is inspired by [google-home-notifier](https://github.com/noelportugal/google-home-notifier).
There are 3 modes.
- speak message
- play sound data
- run as server mode then http request with messages can be handled to speak
### Note
- Google Home device should be in same local network with installed machine
- Google Home device IP address would be detected automatically. So it's not necessarily to specify device IP address.
## Requirements
- Golang 1.15+
- [direnv](https://github.com/direnv/direnv) for MacOS user under development
- [Ngrok](https://github.com/inconshreveable/ngrok) if you want to access installed machine from outside
## Installation
### for MacOS user
```
$ brew install hiromaily/tap/go-google-home
# config file is installed in /usr/local/etc/google-home/gh.toml
# modify `gh.toml` if settings wanna be changed
# run
$ gh speak -msg "Hi guys, thank you for using. Have fun."
```
## subcommand
| subcommand | | example |
| ------------ | -------------------------------------------------- | ------------------------------ |
| speak | speak message on google home | gh speak -msg "hello guys" |
| play | play sound data on google home | gh play -url xxxxx.mp3 |
| server | run web server to handle http request with message | gh server -port 8888 |
## basic command line option
| options | | type | example |
| -------------- | ------------------------------------------ | -------| ---------------------------- |
| toml | TOML file path | string | -toml ./configs/default.toml |
| addr | specify address of Google Homee | string | -addr xxx.xxx.xxx.xxx:8009 |
| lang | spoken language, default is english | string | -lang en |
| v | show version | bool | -v |
## environment variable for development
environment variable `GO_GOOGLE_HOME_CONF` is used as default config path
## example
```
# saying something in English
$ gh speak -msg "Thank you."
# saying something in Japanese
$ gh -lang ja speak -msg "ありがとうございます"
# saying something in Dutch
$ gh -lang nl speak -msg "Dank je"
# saying something in German
$ gh -lang de speak -msg "Danke."
# saying something in French
$ gh -lang fr speak -msg "Merci."
# playing music
$ gh play -url "https://github.com/hiromaily/go-google-home/raw/master/assets/music/bensound-dubstep.mp3"
# using specific IP address of Google Home.
$ gh -addr "10.0.0.1:8009" -msg "It reaches to specific IP address."
```
## example as server
```
# server mode
$ gh server -port 8888
# then post message to server by HTTPie
$ http POST http://localhost:8080/speak text="It's sunny day today."
```
## [WIP] send messages from Slack channel by integration
### setup Google Apps Script
1. create http endpoint from Slack using [Google Apps Script](https://developers.google.com/apps-script/guides/web)
- script is [server.gs](https://github.com/hiromaily/go-google-home/blob/master/scripts/google_apps_script/server.gs)
2. deploy it and get endpoint URL
### setup Slack
1. create new App `google-home `from [slack apps](https://api.slack.com/apps) on your slack workspace
2. use [Slack Events API](https://api.slack.com/apis/connections/events-api)
## How to access to local server from outside easily?
Use [Ngrok](https://github.com/inconshreveable/ngrok)
#### Install on Mac
```
$ brew install --cask ngrok
```
```
# If you use 8080 port for that local server.
$ ngrok http 8080
```