https://github.com/taeukkang/google-home-push

Send Push Notifications to your Google Home device
https://github.com/taeukkang/google-home-push

google-cast google-home push push-notifications

Last synced: 2 months ago
JSON representation

Send Push Notifications to your Google Home device

• Host: GitHub
• URL: https://github.com/taeukkang/google-home-push
• Owner: taeukkang
• License: mit
• Created: 2018-01-21T11:43:42.000Z (almost 7 years ago)
• Default Branch: master
• Last Pushed: 2023-08-16T01:56:27.000Z (over 1 year ago)
• Last Synced: 2024-04-24T11:14:41.156Z (9 months ago)
• Topics: google-cast, google-home, push, push-notifications
• Language: JavaScript
• Homepage:
• Size: 35.2 KB
• Stars: 52
• Watchers: 2
• Forks: 11
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
# google-home-push

Send push notifications to your Google Home device.

## Installation

```

$ npm install --save google-home-push

```

## Usage

```js

const GoogleHome = require("google-home-push");

// Pass the name or IP address of your device

const myHome = new GoogleHome("192.168.0.5");

myHome.speak("Hello world!");

myHome.push("https://example.com/music.mp3");

```

## Example

### Using different languages

```js

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](https://cloud.google.com/translate/docs/languages). The default is set as English.

## API

### new GoogleHome(deviceIdentifier, [options])

Creates an `instantce` of GoogleHome.

#### deviceIdentifier

Type: `string`

Accepts valid IP addresses or device name.

#### options

Type: `Object`

| Property | Type | Default | Description |

| --- | --- | --- | ---|

| language | string | `en` | Default language that would be used by the `.speak()` function |

| speed | number | 1 | Default speed that would be used by the `.speak()` function |

| timeout | number | `5000` | Duration 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](https://cloud.google.com/translate/docs/languages).

### .push(url)

#### url

Type: `string`

A valid media URL that would be cast

## License

[MIT](https://github.com/taeukme/google-home-push/blob/master/LICENSE.md)