homebridge-gsh
Version:
Google Smart Home
140 lines (94 loc) • 6.41 kB
Markdown
<p align="center">
<img src="https://raw.githubusercontent.com/homebridge/branding/master/logos/homebridge-color-round-stylized.png" height="140"><br>
<img src="https://user-images.githubusercontent.com/3979615/62948974-ba97f180-be28-11e9-8aef-d2a1d2f37cee.png" width="150">
</p>
# Homebridge to Google Smart Home
[](https://www.npmjs.com/package/homebridge-gsh)
[](https://www.npmjs.com/package/homebridge-gsh)
[](https://discord.gg/cFFBuvp)
[](https://github.com/homebridge/homebridge/wiki/Verified-Plugins)
[](https://paypal.me/oznu)
</span>
<!-- # Homebridge to Google Smart Home
[](https://www.npmjs.com/package/homebridge-gsh)
[](https://www.npmjs.com/package/homebridge-gsh)
[](https://discord.gg/cFFBuvp)
[](https://github.com/homebridge/homebridge/wiki/Verified-Plugins)
[](https://paypal.me/oznu) -->
Control your supported [Homebridge](https://github.com/nfarina/homebridge) accessories from any Google Home speaker or the Google Home mobile app. Inspired by [homebridge-alexa](https://github.com/NorthernMan54/homebridge-alexa).
- [Supported Device Types](#supported-device-types)
- [Installation Instructions](#installation-instructions)
- [Configuration](#configuration)
- [Known Issues](#known-issues)
- [Troubleshooting](#troubleshooting)
- [Credits](#credits)
- [License](#license)
- [Sponsors](#sponsors)
## Supported Device Types
- Switch
- Outlet
- Light Bulb
- On / Off
- Brightness
- Color (Hue/Saturation)
- Fan (On / Off)
- Fan v2 (On / Off)
- Window
- Window Coverings
- Door
- Garage Door (2FA required)
- Thermostat / Heater Cooler
- Television (On / Off)
- Lock Mechanism (2FA required)
- Security System (2FA required)
- Temperature Sensor
- Humidity Sensor
_Note: Google Smart Home does not currently support all "sensor" devices such as Motion Sensors or Occupancy Sensors etc._
## Installation Instructions
#### Option 1: Install via Homebridge Config UI X:
Search for "Google Home" in [homebridge-config-ui-x](https://github.com/oznu/homebridge-config-ui-x) and install `homebridge-gsh`.
#### Option 2: Manually Install:
```
sudo npm install -g homebridge-gsh
```
## Configuration
To configure `homebridge-gsh` you must also be running [homebridge-config-ui-x](https://github.com/oznu/homebridge-config-ui-x).
1. Navigate to the Plugins page in [homebridge-config-ui-x](https://github.com/oznu/homebridge-config-ui-x).
2. Click the **Settings** button for the Google Smart Home plugin.
3. Click the **Link Account** button.
4. Sign in with your Google or GitHub account.
5. Your account is now linked.
6. Restart Homebridge for the changes to take effect.
7. Add the [Homebridge Action](https://assistant.google.com/services/a/uid/000000b558f0d5d1?hl=en) using the Google Home mobile app. [See Wiki](https://github.com/oznu/homebridge-gsh/wiki#add-homebridge-to-google-home-app) for detailed instructions.
### Enabling Accessory Control
Homebridge must be running in insecure mode to allow accessory control via this plugin. See [Enabling Accessory Control](https://github.com/oznu/homebridge-config-ui-x/wiki/Enabling-Accessory-Control) for instructions.
### Multiple Homebridge Instances
This plugin **must** only be configured on one Homebridge instance on your network as the plugin will discover all your other Homebridge instances and be able to control them. For this to work:
- all instances must be running [in insecure mode](https://github.com/oznu/homebridge-config-ui-x/wiki/Enabling-Accessory-Control)
- all instances must have the same PIN defined in the `config.json`
## Known Issues
1. Only one Homebridge instance can be linked to an account (even across different local networks). You will experience unintended results if you try and link more than one instance to the same account.
## Troubleshooting
#### 1. Errors during installation
Make sure you installed the package with `sudo` flag. Most installation errors can be fixed by removing the plugin and reinstalling:
```shell
# cleanup
sudo npm uninstall -g homebridge-gsh
# reinstall
sudo npm install -g homebridge-gsh
```
#### 2. Cannot control accessories
See [Enabling Accessory Control](https://github.com/oznu/homebridge-config-ui-x/wiki/Enabling-Accessory-Control) and [Multiple Homebridge Instances](#multiple-homebridge-instances).
#### 3. Ask on Discord
Join the [Official Homebridge Discord](https://discord.gg/cFFBuvp) community and ask in the [#homebridge-gsh](https://discord.gg/cFFBuvp) channel.
## Contributing
Please see [CONTRIBUTING.md](CONTRIBUTING.md).
## Credits
- [NorthernMan54](https://github.com/NorthernMan54) - developer of the [Hap-Node-Client](https://github.com/NorthernMan54/Hap-Node-Client) module which is used by this plugin.
## License
Copyright (C) 2019 oznu
This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the [GNU General Public License](./LICENSE) for more details.
## Sponsors
<a width="150" height="50" href="https://auth0.com/?utm_source=oss&utm_medium=gp&utm_campaign=oss" target="_blank" alt="Single Sign On & Token Based Authentication - Auth0"><img width="150" height="50" alt="JWT Auth for open source projects" src="https://cdn.auth0.com/oss/badges/a0-badge-dark.png"/></a>