1.1.2 • Published 5 years ago

google-home-push-ts v1.1.2

Weekly downloads
1
License
MIT
Repository
github
Last release
5 years ago

google-home-push

Send push notifications to your Google Home device. Based entirely on https://github.com/taeukme/google-home-push. Just moved to Typescript and made it fully async/await compatible.

Installation

$ npm install --save google-home-push-ts

Usage

import { GoogleHome } from 'google-home-push-ts'

// Pass the name or IP address of your device
const myHome = new GoogleHome("192.168.0.5");

await myHome.speak("Hello world!");
await myHome.push("https://example.com/music.mp3");

Example

Using different languages

let options = {
    language: "ko"
};

const myHome = new GoogleHome("192.168.0.5", options);
myHome.speak("안녕하세요!");           // Will speak in Korean as it follows the options
myHome.speak("Bonjour!", "fr");     // Will speak in French as the optional language argument is passed

Pass the language option from the following list. The default is set as English.

API

new GoogleHome(deviceIdentifier, options)

Creates an instance of GoogleHome.

deviceIdentifier

Type: string

Accepts valid IP addresses or device name.

options

Type: Object

PropertyTypeDefaultDescription
languagestringenDefault language that would be used by the .speak() function
accentstringenDefault accent that would be used by the .speak() function
timeoutnumber5000Duration for device searching in milliseconds

.speak(message, language)

message

Type: string

Text that would be notified using the Google TTS

language

Type: string

Language that would be used to TTS the message. If one is not passed, then it would fall back to one set in the options. Pass the language option from the following list.

.push(url)

url

Type: string

A valid media URL that would be cast

License

MIT