Skip to content

Latest commit

 

History

History
107 lines (80 loc) · 4.29 KB

README.md

File metadata and controls

107 lines (80 loc) · 4.29 KB
Raw

GOOGLE HOME FOR LOXONE

npm Download License

This project allow you to control your Loxone Server from your Google Home.

Requirements

To use this plugin, you have to create your own SmartHome project in google : https://developers.google.com/assistant/smarthome/develop/create

Set up an OAuth 2.0 server

We suggest to use the free oauth 2.0 server : OAuth0

  1. Create an account or login
  2. Create a new application (Eg : Google Home)
  3. In Allowed Callback URLs section, add https://oauth-redirect.googleusercontent.com/r/YOUR_GOOGLE_PROJECTNAME

### Create an Actions on Google developer project

  1. Use your Oauth0 App ClientId et ClientSecret, created before, in the Account Linking Section Account Linking
  2. In the Fulfillment section, use the google-home-loxone url (Eg : http://YOUR_IP:3000/smarthome). It must be accessible from the cloud.

Request State Config

The Report State feature allows a cloud integration to proactively provide the current state of devices to the Home Graph without a QUERY request. This is done securely through JWT (JSON web tokens).

  1. Navigate to the Google Cloud Console API Manager for your project id.
  2. Enable the HomeGraph API. This will be used to request a new sync and to report the state back to the HomeGraph.
  3. Click Credentials
  4. Click 'Create credentials'
  5. Click 'Service Account'
  6. Create a new service account by folling steps (without specific role)
  7. Edit the service account and add a new JSON key
  8. Download the key and save it in your home directory ~/.google-home-loxone/jwt.json

How to start

Installation

Two options are available. Use the docker image (recommanded)

docker run -p 3000:3000 -v ./jwt.json:/root/.google-home-loxone/jwt.json -v ./config.json:/root/.google-home-loxone/config.json -e GHL_VERBOSE=true --name google-home-loxone -d rtrompier/google-home-loxone:latest

or install the plugin through npm or download the files from here.

$ sudo npm install -g google-home-loxone --unsafe-perm

Or update to latest version when already installed:

$ sudo npm update -g google-home-loxone --unsafe-perm

Configuration

Create a config.json file (usually in ~/.google-home-loxone) to allow the plugin to connect to your loxone server

{
  "loxone": {
    "protocol": "http",
    "url": "LOXONE_IP", // Your loxone IP or hostname
    "user": "LOXONE_USER, // Your loxone username
    "password": "LOXONE_PASSWORD" // Your loxone password
  },
  "oAuthUrl": "https://rtrompier.eu.auth0.com", // Your oAuthUrl provided by Oauth0
  "authorizedEmails": [
    "remy.trompier@gmail.com" // The emails of the users will be allowed to call your server
  ],
  "agentUserId": "loxone-12345", // The name of your app
  "log": true // Activate verbose mode
}

Start

$ google-home-loxone

To see all options you can start with help arguments:

$ google-home-loxone --help

You can pass the following params :

  • port The port used by the google-home-loxone server
  • jwt The path of your jwt.json file, created in Google Cloud Console
  • config The path of your config.json file, to configure the application

Weather

If you don't want pay for Loxone Meteo service, you can connect your Loxone Server to the weather information from Netatmo Weather Station near of you. You can find all station here : https://weathermap.netatmo.com/

You just have to start this server, and plug your Loxone Server on it.

  1. Follow the instruction to configure it, and start.
  2. You can retrieve weather informations by calling : http://YOUR_SERVER:3000/weather
  3. You can now configure your loxone server, to parse result and get weather informations for free.