Skip to content

Latest commit

 

History

History
162 lines (121 loc) · 7.66 KB

USAGE.md

File metadata and controls

162 lines (121 loc) · 7.66 KB
layout title source description
documentation
Google Assistant
Google Assistant is Google's virtual personal assistant and uses Actions on Google as the platform for "Actions" (software applications) to extend the functionality of the Google Assistant.

Google Assistant Action

Google Assistant is Google’s virtual personal assistant and uses Actions on Google as the platform for "Actions" (software applications) to extend the functionality of the Google Assistant. Users engage Google Assistant in conversation to get things done, like controlling their devices and things at home. You can use the officially certified openHAB Action for Google Assistant to easily manage and control your smart home by conversational experiences between you and your openHAB smart home powered by voiced commands.

This guide describes step by step how to use the openHAB Google Assistant Smart Home Action. The openHAB Action links your openHAB setup through the myopenHAB.org cloud service to the Google Assistant platform (for technical insights, please refer to this guide to read more about setup options and development information).

With the Action you can voice control your openHAB items and it supports lights, plugs, switches and thermostats. The openHAB Action comes with multiple language support like English, German or French language.

General Configuration Instructions

Requirements

Item configuration

In openHAB 2 Items are exposed via tags. Currently the following Tags are supported (also depending on Googles API capabilities):

  • ["Lighting"]

  • ["Switchable"]

  • ["Scene"]

  • ["Outlet"]

  • ["Thermostat"]

  • ["CurrentTemperature"] as part of Thermostat or standalone.

  • ["CurrentHumidity"] as part of Thermostat.

  • ["TargetTemperature"] as part of Thermostat.

  • ["homekit:HeatingCoolingMode"] as part of Thermostat.

    Switch KitchenLights "Kitchen Lights" <light> (gKitchen) [ "Switchable" ]
Dimmer BedroomLights "Bedroom Lights" <light> (gBedroom) [ "Lighting" ]
Color LivingroomLights "Livingroom Lights" <light> (gLivingroom) [ "Lighting" ]
Switch SceneMovie "Scene Movie" (gLivingroom) [ "Scene" ]
Switch CristmasTree "Cristmas Tree" (gLivingroom) [ "Outlet" ]

//Standalone Thermostat Sensor (just reports current ambient temperature)
Number HK_SF_Bedroom_Temp "Bedroom Temperature [%.1f]" [ "CurrentTemperature", "Fahrenheit"]

//Thermostat Setup (Google requires a mode, even if you manually set it up in Openhab)
Group g_HK_Basement_TSTAT "Basement Thermostat" [ "Thermostat", "Fahrenheit" ]
  Number HK_Basement_Mode "Basement Heating/Cooling Mode" (g_HK_Basement_TSTAT) [ "homekit:HeatingCoolingMode" ]
  Number HK_Basement_Temp "Basement Temperature" (g_HK_Basement_TSTAT) [ "CurrentTemperature" ]
  Number HK_Basement_Temp "Basement Humidity" (g_HK_Basement_TSTAT) [ "CurrentHumidity" ]
  Number HK_Basement_Setpoint "Basement Setpoint" (g_HK_Basement_TSTAT) [ "TargetTemperature" ]

Item labels are not mandatory in openhab, but for the Google Assistant Action they are absolutely necessary!

It is the "label text" (e.g. "Kitchen Lights" for example above) and not the item's name that will be available to you via vocal commands or in the Google Home app, so make it unique and easy to say!

NOTA : tags are not (yet?) available via paperUI. Either you create your items via ".items" files, or you can:

  • assign tags via REST api :
curl -X PUT --header “Content-Type: application/json” --header “Accept: application/json” “http://localhost:8080/rest/items/[itemname]/tags/Lighting
  • assign tags via console :
smarthome:items addTag MickTest Lighting

Notes Regarding Thermostat Items:

  • Thermostat requires a group to be properly setup with Google Assistant, default format is Celsius.
  • There must be at least 3 elements:
    • (Mandatory) Mode: Number (Zwave THERMOSTAT_MODE Format) or String (off, heat, cool, on).
    • (Mandatory) Current Temperature: Number.
    • (Mandatory) Target Temperature: Number.
    • (Optional) Current Humidity: Number.
  • If your thermostat does not have a mode, you should create one and manually assign a value (e.g. heat, cool, on, etc.) to have proper functionality.
  • See also HomeKit Addon for further formatting details.

Setup & Usage on Google Assistant App

  • Make sure Google Play Services is up to date.
  • Visit "Google Home" app entry in Google Play Store on Android.
  • Set up the voice-activated speaker, Pixel, or Android phone (version 6+) with the same account.
  • Make sure you're the correct user.
  • Start the updated Google Home app on your phone.
  • Go to the settings part: Account > Settings.

openHAB Google App

  • Go to the home control part: Assistant > Home control.

openHAB Google App

  • Press the + button.

openHAB Google App

  • Select openHAB.

openHAB Google App

  • Login at myopenhab.org with your username and password.

openHAB Google App

  • Allow Google access to your account.

openHAB Google App openHAB Google App

  • You will now be able to see your previously tagged items and devices. Assign them to a room. Press Done.

openHAB Google App openHAB Google App

  • You can now control those devices from the Google Assistant.

openHAB Google App openHAB Google App

Example Voice Commands

Here are some example voice commands:

  • Turn on Office Lights.
  • Dim/Brighten Office Lights (increments 15%).
  • Set Office Lights to 35%.
  • Turn off Pool Waterfall.
  • Turn on House Fan.
  • Turn on Home Theater Scene.
  • Set Basement Thermostat to 15 degrees.
  • What is the current Basement Thermostat Temperature?

Frequently Asked Question

My New items did not appear in the Google Home app.

  • Say: Hey Google, sync my devices.

I'm not able to connect OpenHAB to Google Home.

  • Check, recheck and after that check again your items!
  • The items that you want to expose to Google Assistant should have the right tags.
  • The items that you want to expose to Google Assistant must have a item label! Item Definition and Syntax
  • If you expose thermostats make sure than you have:
    • A group item with the tag [ "Thermostat" ]
    • A number or string item with the tag [ "homekit:HeatingCoolingMode" ]
    • A number item with the tag [ "CurrentTemperature" ]
    • A number ityem with the tag [ "TargetTemperature" ]
    Group g_HK_Basement_TSTAT "Basement Thermostat" [ "Thermostat", "Fahrenheit" ]
  Number HK_Basement_Mode "Basement Heating/Cooling Mode" (g_HK_Basement_TSTAT) [ "homekit:HeatingCoolingMode" ]
  Number HK_Basement_Temp "Basement Temperature" (g_HK_Basement_TSTAT) [ "CurrentTemperature" ]
  Number HK_Basement_Setpoint "Basement Setpoint" (g_HK_Basement_TSTAT) [ "TargetTemperature" ]
  • If none of the above solutions works for you:
    • Remove all the tags.
    • Make a new .item file with 1 item to expose.
    Switch TestLight "Test Light" [ "Switchable" ]
    • Relink your account.