diff --git a/Gemfile b/Gemfile index 2bacd210cee..decf007f7d8 100644 --- a/Gemfile +++ b/Gemfile @@ -3,7 +3,7 @@ source 'https://rubygems.org' ruby '> 2.5.0' group :development do - gem 'rake', '13.0.6' + gem 'rake', '13.1.0' gem 'jekyll', '4.3.2' gem 'compass', '1.0.3' gem 'sass-globbing', '1.1.5' diff --git a/Gemfile.lock b/Gemfile.lock index 28832acd75e..3b5b225e7be 100644 --- a/Gemfile.lock +++ b/Gemfile.lock @@ -81,7 +81,7 @@ GEM rack (2.2.8) rack-protection (3.1.0) rack (~> 2.2, >= 2.2.4) - rake (13.0.6) + rake (13.1.0) rb-fsevent (0.11.2) rb-inotify (0.10.1) ffi (~> 1.0) @@ -129,7 +129,7 @@ DEPENDENCIES jekyll-sitemap (= 1.4.0) jekyll-toc (= 0.18.0) nokogiri (= 1.15.4) - rake (= 13.0.6) + rake (= 13.1.0) sass-globbing (= 1.1.5) sassc (= 2.1.0) sinatra (= 3.1.0) diff --git a/_config.yml b/_config.yml index f908742490d..fff9158df7f 100644 --- a/_config.yml +++ b/_config.yml @@ -221,13 +221,6 @@ installation: - name: "Raspberry Pi 3" key: "rpi3-64" - tinkerboard: - board: ASUS Tinkerboard - installation_media: "eMMC module or SD card" - variants: - - name: "ASUS Tinkerboard" - key: "tinker" - generic-x86-64: board: Generic x86-64 installation_media: "storage device" diff --git a/source/_includes/asides/voice_navigation.html b/source/_includes/asides/voice_navigation.html index 9637726c1fe..94db543939d 100644 --- a/source/_includes/asides/voice_navigation.html +++ b/source/_includes/asides/voice_navigation.html @@ -6,20 +6,22 @@
-

Voice assistants

+

{% active_link /voice_control/ Voice assistants %}

diff --git a/source/_includes/installation/operating_system.md b/source/_includes/installation/operating_system.md index 8cb94d2838f..4284aed2fe3 100644 --- a/source/_includes/installation/operating_system.md +++ b/source/_includes/installation/operating_system.md @@ -17,16 +17,15 @@ To get started, we suggest the ODROID N2+, the board that powers our [Home Assis If unavailable, we also recommend the [ODROID C4](https://ameridroid.com/products/odroid-c4?ref=eeb6nfw07e). -Home Assistant bundles (US market): +Home Assistant bundles (US market): -The bundles come with Home Assistant pre-installed. +The bundles come with Home Assistant pre-installed. - [ODROID N2+: 2 GB RAM / 16 GB eMMC](https://ameridroid.com/products/odroid-n2-home-assistant-blue-bundle-limited-edition?variant=44748729286935?ref=eeb6nfw07e) - [ODROID N2+: 4 GB RAM / 64 GB eMMC](https://ameridroid.com/products/odroid-n2-home-assistant-blue-bundle-limited-edition?variant=44748729221399?ref=eeb6nfw07e) - ODROID M1: 4 GB RAM / 256 GB NVMe / [16 GB µSD](https://ameridroid.com/products/odroid-n2-home-assistant-blue-bundle-limited-edition?variant=44929573028119?ref=eeb6nfw07e) or [16 GB eMMC](https://ameridroid.com/products/odroid-n2-home-assistant-blue-bundle-limited-edition?variant=44994940567831?ref=eeb6nfw07e) - ODROID M1: 8 GB RAM / 256 GB NVMe / [16 GB µSD](https://ameridroid.com/products/odroid-n2-home-assistant-blue-bundle-limited-edition?variant=44929573093655?ref=eeb6nfw07e) or [16 GB eMMC](https://ameridroid.com/products/odroid-n2-home-assistant-blue-bundle-limited-edition?variant=44994940633367?ref=eeb6nfw07e) - [ODROID M1: 8 GB RAM / 1 TB NVMe / 64 GB eMMC ](https://ameridroid.com/products/odroid-n2-home-assistant-blue-bundle-limited-edition?variant=44994940698903?ref=eeb6nfw07e) -- ODROID XU4: 2 GB RAM / [32 GB µSD](https://ameridroid.com/products/odroid-n2-home-assistant-blue-bundle-limited-edition?variant=44748729352471?ref=eeb6nfw07e) or [16 GB eMMC](https://ameridroid.com/products/odroid-n2-home-assistant-blue-bundle-limited-edition?variant=44748782305559?ref=eeb6nfw07e) Variants without pre-installed Home Assistant: @@ -43,16 +42,6 @@ Variants without pre-installed Home Assistant: {% endif %} -{% if page.installation_type == 'tinkerboard' %} - -### Suggested hardware - -We will need a few things to get started with installing Home Assistant. The links below lead to Amazon US. If you’re not in the US, you should be able to find it in web stores in your country. - -- [Asus Tinkerboard S](https://amzn.to/3fFIcbI) - -{% endif %} - {% if page.installation_type == 'generic-x86-64' %}
diff --git a/source/_includes/integrations/google_api.md b/source/_includes/integrations/google_api.md new file mode 100644 index 00000000000..d0f9732fdc5 --- /dev/null +++ b/source/_includes/integrations/google_api.md @@ -0,0 +1,9 @@ +{% capture name %}{{ include.name | default: page.title }}{% endcapture %} +{% capture domain %}{{ include.domain | default: page.ha_domain }}{% endcapture %} +{% capture google_dev_console_link %}{{ include.google_dev_console_link | default: page.google_dev_console_link }}{% endcapture %} +{% capture api %}{{ include.api | default: page.api }}{% endcapture %} +{% capture api_link %}{{ include.api_link | default: page.api_link }}{% endcapture %} + + +1. Go the Google Developers Console [{{ api }}]({{ api_link }}) {% if page.api2 %} and [{{ page.api2 }}]({{ page.api2_link }}) {% endif %}. +2. Confirm the project and **Enable** the API. diff --git a/source/_includes/integrations/google_client_secret.md b/source/_includes/integrations/google_client_secret.md new file mode 100644 index 00000000000..594c3b93d57 --- /dev/null +++ b/source/_includes/integrations/google_client_secret.md @@ -0,0 +1,54 @@ +{% capture name %}{{ include.name | default: page.title }}{% endcapture %} +{% capture domain %}{{ include.domain | default: page.ha_domain }}{% endcapture %} +{% capture google_dev_console_link %}{{ include.google_dev_console_link | default: page.google_dev_console_link }}{% endcapture %} +{% capture api %}{{ include.api | default: page.api }}{% endcapture %} +{% capture api_link %}{{ include.api_link | default: page.api_link }}{% endcapture %} + + +### Scenario 1: You already have credentials + +In this case, all you need to do is enable the API: + +1. Go the Google Developers Console [{{ api }}]({{ api_link }}) {% if page.api2 %} and [{{ page.api2 }}]({{ page.api2_link }}) {% endif %}. +2. Confirm the project and **Enable** the API. +3. Continue with the steps described in the [Configuration](#configuration) section. +### Scenario 2: You do not have credentials set up yet + +In this case, you need to generate a client secret first: + +{% details "To generate client ID and client secret" %} + +This section explains how to generate a client ID and client secret on +[Google Developers Console]({{ google_dev_console_link }}). + +1. First, go to the Google Developers Console to enable [{{ api }}]({{ api_link }}) {% if page.api2 %} and [{{ page.api2 }}]({{ page.api2_link }}) {% endif %}. +2. Select **Create project**, enter a project name and select **Create**. +3. **Enable** the {{ api }} and select **Create credentials**. +4. Navigate to **APIs & Services** (left sidebar) > [Credentials](https://console.cloud.google.com/apis/credentials). +5. In the left sidebar, select **OAuth consent screen**. + - Select **External** and **Create**. + - Set the **App name** (the name of the application asking for consent) to anything you want, e.g., *Home Assistant*. +6. You then need to select a **Support email**. + - From the dropdown menu, select your email address. +7. Under **Developer contact information**, enter your email address (the same as above is fine). +8. Scroll to the bottom and select **Save and continue**. + - You don't have to fill out anything else, or it may enable additional review. +9. You will then be automatically taken to the **Scopes** page. + - You do not need to add any scopes here. Select **Save and continue** to move to the **Test users** page. + - You do not need to add anything to the **Test users** page. Select **Save and continue**, which will take you to the **Summary** page. + - Select **Back to dashboard**. +10. Select **OAuth consent screen** again and under **Publishing status**, select **Publish app**. + - Otherwise your credentials will expire every 7 days. +11. Make sure **Publishing status** is set to **In production**. +12. In the left sidebar, select **Credentials**, then select **Create credentials** (at the top of the screen), then select **OAuth client ID**. +13. Set the **Application type** to **Web application** and give this credential set a name (like "Home Assistant Credentials"). +14. Add `https://my.home-assistant.io/redirect/oauth` to **Authorized redirect URIs** then select **Create**. + - This is not a placeholder. It is the URI that must be used. +15. You will then be presented with a pop-up saying **OAuth client created**, showing **Your client ID** and **Your client secret**. + - Make a note of these (for example, copy and paste them into a text editor), as you will need them shortly. + - Once you have noted these strings, select **OK**. + - If you need to find these credentials again at any point, then navigate to **APIs & Services** > **Credentials**, and you will see **Home Assistant Credentials** (or whatever you named them in the previous step) under **OAuth 2.0 Client IDs**. + - To view both the **Client ID** and **Client secret**, select the pencil icon. This will take you to the settings page for these credentials, and the information will be on the right-hand side of the page. +16. Congratulations! You are now the keeper of a client secret. Guard it in your treasure box. + +{% enddetails %} \ No newline at end of file diff --git a/source/_includes/integrations/google_oauth.md b/source/_includes/integrations/google_oauth.md new file mode 100644 index 00000000000..25bf0cef1a4 --- /dev/null +++ b/source/_includes/integrations/google_oauth.md @@ -0,0 +1,22 @@ +{% capture name %}{{ include.name | default: page.title }}{% endcapture %} +{% capture domain %}{{ include.domain | default: page.ha_domain }}{% endcapture %} +{% capture google_dev_console_link %}{{ include.google_dev_console_link | default: page.google_dev_console_link }}{% endcapture %} +{% capture api %}{{ include.api | default: page.api }}{% endcapture %} +{% capture api_link %}{{ include.api_link | default: page.api_link }}{% endcapture %} +{% capture title %}{{ include.title | default: page.title }}{% endcapture %} + +The integration setup will next give you instructions to enter the [Application Credentials](/integrations/application_credentials/) (OAuth Client ID and Client Secret) and authorize Home Assistant to connect to {{ title }}. + +{% details "OAuth and device authorization steps" %} + +1. Continue through the steps of selecting the account you want to authorize. + +2. **NOTE**: You may get a message telling you that the app has not been verified and you will need to acknowledge that in order to proceed. + +3. You can now see the details of what you are authorizing Home Assistant to access with two options at the bottom. Select **Continue**. + +4. The page will now display **Link account to Home Assistant?**, note **Your instance URL**. If this is not correct, refer to [My Home Assistant](/integrations/my). If everything looks good, select **Link Account**. + +5. You may close the window, and return back to Home Assistant where you should see a **Success!** message from Home Assistant. + +{% enddetails %} diff --git a/source/_integrations/counter.markdown b/source/_integrations/counter.markdown index 4d9490eb930..485d936fa53 100644 --- a/source/_integrations/counter.markdown +++ b/source/_integrations/counter.markdown @@ -17,8 +17,8 @@ The Counter integration allows one to count occurrences fired by automations. ## Configuration The preferred way to configure counter helpers is via the user interface. To add one, go to -**{% my helpers title="Settings -> Devices & Services -> Helpers" %}** and click the add button; -next choose the **{% my config_flow_start domain=counter title="Counter" %}** option. +**{% my helpers title="Settings > Devices & Services > Helpers" %}** and click the add button; +next choose the **{% my config_flow_start domain=page.ha_domain title=page.title %}** option. To be able to add **Helpers** via the user interface you should have `default_config:` in your `configuration.yaml`, it should already be there by @@ -77,7 +77,7 @@ counter: Pick an icon that from [Material Design Icons](https://pictogrammers.com/library/mdi/) to use for your input and prefix the name with `mdi:`. For example `mdi:car`, `mdi:ambulance` or `mdi:motorbike`. -### Restore State +### Restore state This integration will automatically restore the state it had prior to Home Assistant stopping as long as your entity has `restore` set to `true`, which is the default. To disable this feature, set `restore` to `false`. diff --git a/source/_integrations/google.markdown b/source/_integrations/google.markdown index bfbcfff0458..55de84c37da 100644 --- a/source/_integrations/google.markdown +++ b/source/_integrations/google.markdown @@ -26,10 +26,10 @@ You need to configure developer credentials to allow Home Assistant to access yo This section explains how to generate a Client ID and Client Secret on [Google Developers Console](https://console.developers.google.com/start/api?id=calendar). -1. First go to the [Google Developers Console](https://console.developers.google.com/start/api?id=calendar) +1. First go to the [Google Developers Console](https://console.developers.google.com/start/api?id=calendar). 2. The wizard will ask you to choose a project to manage your application. Select a project and click continue. 3. Verify that your calendar API was enabled and click 'Go to credentials' -4. Navigate to APIs & Services (left sidebar) > [Credentials](https://console.cloud.google.com/apis/credentials) +4. Navigate to APIs & Services (left sidebar) > [Credentials](https://console.cloud.google.com/apis/credentials). 5. Click on the field on the left of the screen, **OAuth Consent Screen**. 6. Select **External** and **Create**. 7. Set the *App Name* (the name of the application asking for consent) to anything you want e.g. *Home Assistant*. @@ -49,7 +49,6 @@ This section explains how to generate a Client ID and Client Secret on The integration setup will next give you instructions to enter the [Application Credentials](/integrations/application_credentials/) (OAuth Client ID and Client Secret) and authorize Home Assistant to access your account and Calendars. - {% details "OAuth and Device Authorization steps" %} 1. The first step shows a link and a code. diff --git a/source/_integrations/google_assistant_sdk.markdown b/source/_integrations/google_assistant_sdk.markdown index 661c85dbb04..14f716ef07f 100644 --- a/source/_integrations/google_assistant_sdk.markdown +++ b/source/_integrations/google_assistant_sdk.markdown @@ -13,6 +13,9 @@ ha_integration_type: service ha_platforms: - notify ha_quality_scale: platinum +google_dev_console_link: https://console.developers.google.com/apis/api/embeddedassistant.googleapis.com/overview +api: Google Assistant API +api_link: https://console.developers.google.com/apis/api/embeddedassistant.googleapis.com/overview --- The Google Assistant SDK integration allows Home Assistant to interact with Google Assistant. If you want to use Google Assistant (for example, from your phone or Google Home device) to interact with your Home Assistant managed devices, then you want the [Google Assistant](/integrations/google_assistant) integration. @@ -42,33 +45,9 @@ This integration allows: ## Prerequisites You need to configure developer credentials to allow Home Assistant to access your Google Account. -These credentials are the same as the ones for [Nest](/integrations/nest) or [Google Sheets](/integrations/google_sheets). -If you have already set up credentials, you can do step 1 and then skip to step 13 on the below instructions. +These credentials are the same as the ones for [Nest](/integrations/nest) or [Google Sheets](/integrations/google_sheets), [YouTube](/integrations/youtube), and [Google Mail](/integrations/google_mail). -{% details "Generate Client ID and Client Secret" %} - -This section explains how to generate a Client ID and Client Secret on -[Google Developers Console](https://console.developers.google.com/apis/api/embeddedassistant.googleapis.com/overview). - -1. First go to the Google Developers Console to enable [Google Assistant API](https://console.developers.google.com/apis/api/embeddedassistant.googleapis.com/overview) -2. Select an existing project or create a new one from the dropdown menu in the upper left corner. -3. Click to enable this API. -4. Click on the field on the left of the screen, **OAuth Consent Screen**. -5. Select **External** and **Create**. -6. Set the _App Name_ (the name of the application asking for consent) to anything you want e.g. _Home Assistant_. -7. You then need to select a _Support email_. To do this, simply click the drop down box and select your email address. -8. You finally need to complete the section: _Developer contact information_. To do this, simply enter your email address (same as above is fine). -9. Scroll to the bottom and click **Save and Continue**. Don't have to fill out anything else or it may enable additional review. -10. You will then be automatically taken to the Scopes page. You do not need to add any scopes here so click Save and Continue to move to the Optional info page. You do not need to add anything to the Optional info page so click Save and Continue which will take you to the Summary page. Click Back to Dashboard. -11. Click **OAuth consent screen** again and set _Publish Status_ to **Production** otherwise your credentials will expire every 7 days. -12. Make sure **Publishing status** is set to production. -13. Click **Credentials** in the menu on the left hand side of the screen, then click **Create credentials** (at the top of the screen), then select _OAuth client ID_. -14. Set the Application type to _Web application_ and give this credential set a name (like "Home Assistant Credentials"). -15. Add https://my.home-assistant.io/redirect/oauth to _Authorized redirect URIs_ then click **Create**. -16. You will then be presented with a pop-up saying _OAuth client created_ showing _Your Client ID_ and _Your Client Secret_. Make a note of these (for example, copy and paste them into a text editor) as you will need these shortly. Once you have noted these strings, click **OK**. If you need to find these credentials again at any point then simply navigate to _APIs & Services > Credentials_ and you will see _Home Assistant Credentials_ (or whatever you named them in the previous step) under _OAuth 2.0 Client IDs_. To view both the _Client ID_ and _Client secret_, click on the pencil icon, this will take you to the settings page for these credentials and the information will be on the right hand side of the page. -17. Double check that the _Google Assistant API_ has been automatically enabled. To do this, select **Library** from the menu, then search for _Google Assistant API_. If it is enabled you will see _API Enabled_ with a green tick next to it. If it is not enabled, then enable it. - -{% enddetails %} +{% include integrations/google_client_secret.md %} {% include integrations/config_flow.md %} @@ -109,6 +88,7 @@ The easiest way to check if the integration is working is to check [My Google Ac - Routines don't work. - Broadcast doesn't work with IPv6. - Broadcast to specific rooms often doesn't work for non-English languages. + - Commands that need to verify your identity through voice match do not work. ## Configuration diff --git a/source/_integrations/google_mail.markdown b/source/_integrations/google_mail.markdown index 68c47c637ad..d7d9c1b00d0 100644 --- a/source/_integrations/google_mail.markdown +++ b/source/_integrations/google_mail.markdown @@ -13,6 +13,9 @@ ha_platforms: ha_codeowners: - '@tkdrob' ha_integration_type: service +google_dev_console_link: https://console.cloud.google.com/apis/library/gmail.googleapis.com +api: Gmail API +api_link: https://console.cloud.google.com/apis/library/gmail.googleapis.com --- The Google Mail integration allows you to connect your [Google Mail](https://mail.google.com) to Home Assistant. The integration adds a service to allow you to set an email auto-response for when you go on vacation. A `notify` service is also added, allowing you to draft or send emails in plain text. @@ -20,53 +23,14 @@ The Google Mail integration allows you to connect your [Google Mail](https://mai ## Prerequisites You need to configure developer credentials to allow Home Assistant to access your Google Account. -These credentials are the same as the ones for [Nest](/integrations/nest) and [Google Sheets](/integrations/google_sheets). +These credentials are the same as the ones for [Nest](/integrations/nest) and [Google Sheets](/integrations/google_sheets) and [YouTube](/integrations/youtube). These are not the same as the one for [Google Calendar](/integrations/google). -If you have already set up the correct credentials, you can do step 1 and then skip to step 13 on the below instructions. -{% details "Generate Client ID and Client Secret" %} - -This section explains how to generate a Client ID and Client Secret on -[Google Developers Console](https://console.cloud.google.com/apis/library/gmail.googleapis.com). - -1. First, go to the Google Developers Console to enable [Gmail API](https://console.cloud.google.com/apis/library/gmail.googleapis.com) -2. The wizard will ask you to choose a project to manage your application. Select a project and select **Continue**. -3. Verify that your Gmail API was enabled and select **Go to credentials**. -4. Navigate to **APIs & Services** (left sidebar) > [Credentials](https://console.cloud.google.com/apis/credentials) -5. Click on the field on the left of the screen, **OAuth Consent Screen**. -6. Select **External** and **Create**. -7. Set the **App Name** (the name of the application asking for consent) to anything you want, e.g., *Home Assistant*. -8. You then need to select a **Support email**. To do this, from the dropdown menu, select your email address. -9. You finally need to complete the section: **Developer contact information**. To do this, enter your email address (the same as above is fine). -10. Scroll to the bottom and select **Save and Continue**. You don't have to fill out anything else, or it may enable additional review. -11. You will then be automatically taken to the **Scopes** page. You do not need to add any scopes here, so select **Save and Continue** to move to the **Optional info** page. You do not need to add anything to the **Optional info** page, so select **Save and Continue**, which will take you to the **Summary** page. Select **Back to Dashboard**. -12. Select **OAuth consent screen** again and set *Publish Status* to **Production**. Otherwise your credentials will expire every 7 days. -13. Make sure **Publishing status** is set to production. -14. Select **Credentials** in the menu on the left-hand side of the screen, then select **Create credentials** (at the top of the screen), then select **OAuth client ID**. -15. Set the Application type to *Web application* and give this credential set a name (like "Home Assistant Credentials"). -16. Add `https://my.home-assistant.io/redirect/oauth` to **Authorized redirect URIs** then select **Create**. This is not a placeholder and is the URI that must be used. -17. You will then be presented with a pop-up saying **OAuth client created** showing **Your Client ID** and **Your Client Secret**. Make a note of these (for example, copy and paste them into a text editor), as you will need them shortly. Once you have noted these strings, select **OK**. If you need to find these credentials again at any point, then navigate to **APIs & Services** > **Credentials**, and you will see **Home Assistant Credentials** (or whatever you named them in the previous step) under **OAuth 2.0 Client IDs**. To view both the **Client ID** and **Client secret**, select the pencil icon. This will take you to the settings page for these credentials, and the information will be on the right-hand side of the page. -18. Double-check that the **Gmail API** has been automatically enabled. To do this, select **Library** from the menu, then search for **Gmail API**. If it is enabled, you will see **API Enabled** with a green tick next to it. If it is not enabled, then enable it. - -{% enddetails %} +{% include integrations/google_client_secret.md %} {% include integrations/config_flow.md %} -The integration setup will next give you instructions to enter the [Application Credentials](/integrations/application_credentials/) (OAuth Client ID and Client Secret) and authorize Home Assistant to access your Google Mail. - -{% details "OAuth and Device Authorization steps" %} - -1. Continue through the steps of selecting the account you want to authorize. - -2. **NOTE**: You may get a message telling you that the app has not been verified and you will need to acknowledge that in order to proceed. - -3. You can now see the details of what you are authorizing Home Assistant to access with two options at the bottom. Select **Continue**. - -4. The page will now display **Link account to Home Assistant?**, note **Your instance URL**. If this is not correct, refer to [My Home Assistant](/integrations/my). If everything looks good, select **Link Account**. - -5. You may close the window, and return back to Home Assistant where you should see a **Success!** message from Home Assistant. - -{% enddetails %} +{% include integrations/google_oauth.md %} ## Troubleshooting diff --git a/source/_integrations/google_sheets.markdown b/source/_integrations/google_sheets.markdown index 074a7480d86..1c1c5aa6733 100644 --- a/source/_integrations/google_sheets.markdown +++ b/source/_integrations/google_sheets.markdown @@ -10,6 +10,11 @@ ha_domain: google_sheets ha_codeowners: - '@tkdrob' ha_integration_type: service +google_dev_console_link: https://console.developers.google.com/start/api?id=drive +api: Google Drive API +api_link: https://console.developers.google.com/start/api?id=drive +api2: Google Sheets API +api2_link: https://console.cloud.google.com/apis/enableflow?apiid=sheets.googleapis.com --- The Google Sheets integration allows you to connect your [Google Drive](https://drive.google.com) to Home Assistant. The integration adds a service to allow you to append rows to a Sheets document. The idea is that you can store data on there for further processing. When you set up a config entry, your drive will have a new sheet called Home Assistant. You can then rename this to whatever you like. @@ -20,59 +25,21 @@ The integration currently only has access to that one document that is created d ## Prerequisites You need to configure developer credentials to allow Home Assistant to access your Google Account. -These credentials are the same as the ones for [Nest](/integrations/nest), [YouTube](/integrations/youtube) and [Google Mail](/integrations/google_mail). +These credentials are the same as the ones for [Nest](/integrations/nest), [YouTube](/integrations/youtube), and [Google Mail](/integrations/google_mail). These are not the same as the one for [Google Calendar](/integrations/google). -If you have already set up the correct credentials, you can do step 1 and then skip to step 13 on the below instructions. -{% details "Generate Client ID and Client Secret" %} - -This section explains how to generate a Client ID and Client Secret on -[Google Developers Console](https://console.developers.google.com/start/api?id=drive). - -1. First go to the Google Developers Console to enable [Google Drive API](https://console.developers.google.com/start/api?id=drive) and [Google Sheets API](https://console.cloud.google.com/apis/enableflow?apiid=sheets.googleapis.com) -2. The wizard will ask you to choose a project to manage your application. Select a project and click continue. -3. Verify that your drive API was enabled and click 'Go to credentials' -4. Navigate to APIs & Services (left sidebar) > [Credentials](https://console.cloud.google.com/apis/credentials) -5. Click on the field on the left of the screen, **OAuth Consent Screen**. -6. Select **External** and **Create**. -7. Set the *App Name* (the name of the application asking for consent) to anything you want e.g. *Home Assistant*. -8. You then need to select a *Support email*. To do this, simply click the drop down box and select your email address. -9. You finally need to complete the section: *Developer contact information*. To do this, simply enter your email address (same as above is fine). -10. Scroll to the bottom and click **Save and Continue**. Don't have to fill out anything else or it may enable additional review. -11. You will then be automatically taken to the Scopes page. You do not need to add any scopes here so click Save and Continue to move to the Optional info page. You do not need to add anything to the Optional info page so click Save and Continue which will take you to the Summary page. Click Back to Dashboard. -12. Click **OAuth consent screen** again and set *Publish Status* to **Production** otherwise your credentials will expire every 7 days. -13. Make sure **Publishing status** is set to production. -14. Click **Credentials** in the menu on the left hand side of the screen, then click **Create credentials** (at the top of the screen), then select *OAuth client ID*. -15. Set the Application type to *Web application* and give this credential set a name (like "Home Assistant Credentials"). -16. Add https://my.home-assistant.io/redirect/oauth to *Authorized redirect URIs* then click **Create**. This is not a placeholder and is the URI that must be used. -17. You will then be presented with a pop-up saying *OAuth client created* showing *Your Client ID* and *Your Client Secret*. Make a note of these (for example, copy and paste them into a text editor) as you will need these shortly. Once you have noted these strings, click **OK**. If you need to find these credentials again at any point then simply navigate to *APIs & Services > Credentials* and you will see *Home Assistant Credentials* (or whatever you named them in the previous step) under *OAuth 2.0 Client IDs*. To view both the *Client ID* and *Client secret*, click on the pencil icon, this will take you to the settings page for these credentials and the information will be on the right hand side of the page. -18. Double check that the *Google Drive API* has been automatically enabled. To do this, select **Library** from the menu, then search for *Google Drive API*. If it is enabled you will see *API Enabled* with a green tick next to it. If it is not enabled, then enable it. - -{% enddetails %} +{% include integrations/google_client_secret.md %} {% include integrations/config_flow.md %} -The integration setup will next give you instructions to enter the [Application Credentials](/integrations/application_credentials/) (OAuth Client ID and Client Secret) and authorize Home Assistant to access your Google Sheets. - -{% details "OAuth and Device Authorization steps" %} - -1. Continue through the steps of selecting the account you want to authorize. - -2. **NOTE**: You may get a message telling you that the app has not been verified and you will need to acknowledge that in order to proceed. - -3. You can now see the details of what you are authorizing Home Assistant to access with two options at the bottom. Click **Continue**. - -4. The page will now display *Link account to Home Assistant?*, note *Your instance URL*. If this is not correct, please refer to [My Home Assistant](/integrations/my). If everything looks good, click **Link Account**. - -5. You may close the window, and return back to Home Assistant where you should see a *Success!* message from Home Assistant. - -{% enddetails %} +{% include integrations/google_oauth.md %} ## Troubleshooting If you have an error with your credentials you can delete them in the [Application Credentials](/integrations/application_credentials/) user interface. -### Video Tutorial +### Video tutorial + This video tutorial explains how to set up the Google Sheets integration and how you can add data from Home Assistant to a Google Sheet. diff --git a/source/_integrations/input_number.markdown b/source/_integrations/input_number.markdown index 7992d51b596..9a92150dd7f 100644 --- a/source/_integrations/input_number.markdown +++ b/source/_integrations/input_number.markdown @@ -14,7 +14,7 @@ ha_integration_type: helper The `input_number` integration allows the user to define values that can be controlled via the frontend and can be used within conditions of automation. The frontend can display a slider, or a numeric input box. Changes to the slider or numeric input box generate state events. These state events can be utilized as `automation` triggers as well. -The preferred way to configure an input number is via the user interface at **{% my helpers title="Settings > Devices & Services > Helpers" %}**. Click the add button and then choose the **{% my config_flow_start domain=input_number title="Number" %}** option. +The preferred way to configure an input number is via the user interface at **{% my helpers title="Settings > Devices & Services > Helpers" %}**. Click the add button and then choose the **{% my config_flow_start domain="input_number" title="Number" %}** option. To be able to add **Helpers** via the user interface you should have `default_config:` in your `configuration.yaml`, it should already be there by default unless you removed it. If you removed `default_config:` from you configuration, you must add `input_number:` to your `configuration.yaml` first, then you can use the UI. diff --git a/source/_integrations/nest.markdown b/source/_integrations/nest.markdown index 9bf568cb51c..e2ce891c18b 100644 --- a/source/_integrations/nest.markdown +++ b/source/_integrations/nest.markdown @@ -322,9 +322,40 @@ This feature is enabled by the following permissions: - *Allow Home Assistant to know when there's a camera event* - *Allow Home Assistant to know when there's a doorbell event* -- *Other permissions in the Nest or Google Home apps*. +- *Other permissions and notification settings in the Nest or Google Home apps*.
+### Google Home App Notification Settings + +The Google Home App Notifications settings control not only which notifications are sent to your phone, +but also what gets published to the Pub/Sub feed. + +For example, if you enable *Away-only notifications*, Home Assistant will only receive events when your phone is away from home. + +Another thing that may not be intuitive, is that seeing the event in your device history does not mean it was published to the feed. +However, if you are getting push notifications, the settings are likely working. + +Note: The exact settings and effect they have on the feed may vary by camera model or app version. + + +If you are still not getting notifications, you can read this [troubleshooting guide from Google] +(https://support.google.com/googlenest/answer/9230439#zippy=%2Cyour-camera-detected-something-but-you-didnt-get-a-camera-alert) + + +{% details "Google Home App Notification Settings" %} + + +| Google Home App Setting | Notes | +| ------------------------ | :-----------------------------------------------------------------------------------: | +| Notifications: Push | Required for any detection event to be published | +| Notifications: Away-Only | Events will only be published when a user is detected as away from home | +| Seen: Motion | Required for `Motion` events to be published | +| Seen: Person | Required for `Person` events to be published | + +![Screenshot of Google Home App Notification Settings](/images/integrations/nest/google_home_notification_settings.png) + +{% enddetails %} + ## Media Source The Nest [Media Source](/integrations/media_source) platform allows you to browse clips for recent camera events. Home Assistant is not intended to be a Network Video Recorder (NVR) platform, however, basic support for capturing recent events is supported. @@ -575,6 +606,8 @@ logger: - It is recommended to let Home Assistant create the Pub/Sub subscription for you. However, if you would like more control you can enter a `subscriber_id` in the configuration. See [Subscribe to Events](https://developers.google.com/nest/device-access/subscribe-to-events) for more instructions on how to manually create a subscription and use the full subscription name in the Home Assistant configuration e.g. `projects/gcp-project-name/subscriptions/subscription-id` +- *Not receiving camera motion and person events*: assuming the integration is correctly configured (for example, the oauth and SDM API are set up correctly, you can see camera streams, and permissions are correctly set in [Partner Connections Manager](https://nestservices.google.com/partnerconnections)): If you are then still not seeing events, it's possible you need to adjust the Google Home App settings. Refer to the [Cameras: Automation: Google Home App Settings](#google-home-app-settings) for details. + # Works With Nest API
diff --git a/source/_integrations/vodafone_station.markdown b/source/_integrations/vodafone_station.markdown index bcd6268da59..7020d34ab4e 100644 --- a/source/_integrations/vodafone_station.markdown +++ b/source/_integrations/vodafone_station.markdown @@ -19,6 +19,10 @@ ha_integration_type: integration The Vodafone Station integration allows you to control your [Vodafone Station](https://www.vodafone.it/privati/area-supporto/assistenza-dispositivi/vodafone-station.html) based router. +
+The integration supports only Sercomm models so far. +
+ There is support for the following platform types within Home Assistant: - **Device tracker** - presence detection by looking at connected devices. @@ -41,7 +45,7 @@ To change the settings, go to {% my integrations title="**Settings** > **Devices ### Tested models -This integration was tested against the following models: +This integration was tested against the following models from Sercomm: -- Vodafone Power Station -- Vodafone WiFi 6 Station +- Vodafone Power Station (SHG3000) +- Vodafone WiFi 6 Station (RHG3006) diff --git a/source/_integrations/wake_on_lan.markdown b/source/_integrations/wake_on_lan.markdown index b1b87bc3c39..9c1db398cb8 100644 --- a/source/_integrations/wake_on_lan.markdown +++ b/source/_integrations/wake_on_lan.markdown @@ -35,7 +35,7 @@ Available services: `send_magic_packet`. #### Service `wake_on_lan.send_magic_packet` -Send a _magic packet_ to wake up a device with 'Wake-On-LAN' capabilities. +Send a _magic packet_ to wake up a device with 'Wake on LAN' capabilities. | Service data attribute | Optional | Description | |---------------------------|----------|---------------------------------------------------------| @@ -52,13 +52,13 @@ Sample service data: ```
-This usually only works if the Target Device is connected to the same network. Routing the WakeOnLan packet to a different subnet requires a special configuration on your router or may not be possible. -The Service to Route the packet is most likely named "IP Helper" which may support WakeOnLan, but not all Routers support this. +This usually only works if the target device is connected to the same network. Routing the magic packet to a different subnet requires a special configuration on your router or may not be possible. +The service to route the packet is most likely named "IP Helper". It may support Wake on LAN, but not all routers support this.
## Switch -The `wake_on_lan` (WOL) switch platform allows you to turn on a [WOL](https://en.wikipedia.org/wiki/Wake-on-LAN) enabled computer. +The `wake_on_lan` (WOL) switch integration allows you to turn on a [WOL](https://en.wikipedia.org/wiki/Wake-on-LAN) enabled computer. ### Switch configuration @@ -133,3 +133,36 @@ switch: shell_command: turn_off_TARGET: "ssh hass@TARGET sudo pm-suspend" ``` + +## Helper button with automation + +A switch defined with the `wake_on_lan` platform will render in the UI with both 'on' and 'off' clickable actions. If you don't intend to use the `turn_off` functionality, then using a virtual button & automation will look cleaner and less confusing. It will only have one action. + +1. First, define a new helper button. + - Go to **{% my helpers title="Settings > Devices & Services > Helpers" %}** and select the **+ Create helper** button. Choose **Button** and give it a name. A button named "Wake PC" will render like this: + + ![image](https://github.com/home-assistant/home-assistant.io/assets/252209/10e468a0-45c8-4ee7-b69d-596db3845b14) + +2. Then, create a new automation. Go to **{% my automations title="Settings > Automations & scenes" %}** and select **+ Create Automation**. + - The trigger will be on `State` and the entity will be the button you created. + - Continuing your example, the trigger YAML will look like this: + + ```yaml + platform: state + entity_id: + - input_button.wake_pc + ``` + +3. For the action, select **Call service** and choose **Wake on LAN: Send magic packet**. +4. Type in the target MAC address. + - Do not change the broadcast port unless you've configured your device to listen to a different port. + - Continuing our example, the action YAML looks like this: + + ```yaml + service: wake_on_lan.send_magic_packet + data: + broadcast_port: 9 + mac: 00:11:22:33:44:55 + ``` + +5. Save the automation. Now, when you activate `PRESS` on the helper button in the UI, Home Assistant will send a wake packet to the configured MAC. diff --git a/source/_integrations/waqi.markdown b/source/_integrations/waqi.markdown index 80f4e750057..ed6c7d7ed37 100644 --- a/source/_integrations/waqi.markdown +++ b/source/_integrations/waqi.markdown @@ -31,4 +31,7 @@ The value reported is an overall AQ index for the location. The values of the in | 101 - 150 | **Unhealthy for Sensitive Groups** | Members of sensitive groups may experience health effects. The general public is not likely to be affected | | 151 - 200 | **Unhealthy** | Everyone may begin to experience health effects; members of sensitive groups may experience more serious health effects | | 201 - 300 | **Very unhealthy** | Health warnings of emergency conditions. The entire population is more likely to be affected | -| 301+ | **Hazardous** | Health alert: everyone may experience more serious health effects | +| 301+ | **Hazardous** | Health alert: everyone may experience more serious health effects + + +Further information about AQI can be found [on the EPA's AirNOW website](https://www.airnow.gov/aqi/aqi-basics/). diff --git a/source/_integrations/youtube.markdown b/source/_integrations/youtube.markdown index b60d23f9d43..e6fa9358edc 100644 --- a/source/_integrations/youtube.markdown +++ b/source/_integrations/youtube.markdown @@ -13,6 +13,9 @@ ha_platforms: - diagnostics - sensor ha_integration_type: service +google_dev_console_link: https://console.cloud.google.com/apis/library/youtube.googleapis.com +api: YouTube Data API v3 +api_link: https://console.cloud.google.com/apis/library/youtube.googleapis.com?project=home-assistant-17698 --- The YouTube integration allows you to connect YouTube channels to Home Assistant. @@ -23,53 +26,14 @@ For every channel you add, it will create sensors for: ## Prerequisites To be able to configure the integration, you need to have a YouTube channel. -How to create one can be found [here](https://support.google.com/youtube/answer/1646861). +To learn how to create one, refer to the [YouTube documentation](https://support.google.com/youtube/answer/1646861). You need to configure developer credentials to allow Home Assistant to access your Google Account. These credentials are the same as the ones for [Nest](/integrations/nest), [Google Mail](/integrations/google_mail) and [Google Sheets](/integrations/google_sheets). These are not the same as the one for [Google Calendar](/integrations/google). -If you have already set up the correct credentials, you can do step 1 and then skip to step 13 on the below instructions. -{% details "Generate Client ID and Client Secret" %} - -This section explains how to generate a Client ID and Client Secret on -[Google Developers Console](https://console.cloud.google.com/apis/library/youtube.googleapis.com). - -1. First, go to the Google Developers Console to enable the [YouTube Data API v3](https://console.cloud.google.com/apis/library/youtube.googleapis.com?project=home-assistant-17698) -2. The wizard will ask you to choose a project to manage your application. Select a project and select **Continue**. -3. Verify that your YouTube Data API v3 was enabled and select **Go to credentials**. -4. Navigate to **APIs & Services** (left sidebar) > [Credentials](https://console.cloud.google.com/apis/credentials) -5. Click on the field on the left of the screen, **OAuth Consent Screen**. -6. Select **External** and **Create**. -7. Set the **App Name** (the name of the application asking for consent) to anything you want, e.g., *Home Assistant*. -8. You then need to select a **Support email**. To do this, from the dropdown menu, select your email address. -9. You finally need to complete the section: **Developer contact information**. To do this, enter your email address (the same as above is fine). -10. Scroll to the bottom and select **Save and Continue**. You don't have to fill out anything else, or it may enable additional review. -11. You will then be automatically taken to the **Scopes** page. You do not need to add any scopes here, so select **Save and Continue** to move to the **Optional info** page. You do not need to add anything to the **Optional info** page, so select **Save and Continue**, which will take you to the **Summary** page. Select **Back to Dashboard**. -12. Select **OAuth consent screen** again and set *Publish Status* to **Production**. Otherwise your credentials will expire every 7 days. -13. Make sure **Publishing status** is set to production. -14. Select **Credentials** in the menu on the left-hand side of the screen, then select **Create credentials** (at the top of the screen), then select **OAuth client ID**. -15. Set the Application type to **Web application** and give this credential set a name (like "Home Assistant Credentials"). -16. Add `https://my.home-assistant.io/redirect/oauth` to **Authorized redirect URIs** then select **Create**. This is not a placeholder and is the URI that must be used. -17. You will then be presented with a pop-up saying **OAuth client created** showing **Your Client ID** and **Your Client Secret**. Make a note of these (for example, copy and paste them into a text editor), as you will need them shortly. Once you have noted these strings, select **OK**. If you need to find these credentials again at any point, then navigate to **APIs & Services** > **Credentials**, and you will see **Home Assistant Credentials** (or whatever you named them in the previous step) under **OAuth 2.0 Client IDs**. To view both the **Client ID** and **Client secret**, select the pencil icon. This will take you to the settings page for these credentials, and the information will be on the right-hand side of the page. -18. Double-check that the **YouTube Data API v3** has been automatically enabled. To do this, select **Library** from the menu, then search for **YouTube Data API v3**. If it is enabled, you will see **API Enabled** with a green tick next to it. If it is not enabled, then enable it. - -{% enddetails %} +{% include integrations/google_client_secret.md %} {% include integrations/config_flow.md %} -The integration setup will next give you instructions to enter the [Application Credentials](/integrations/application_credentials/) (OAuth Client ID and Client Secret) and authorize Home Assistant to connect to YouTube. - -{% details "OAuth and Device Authorization steps" %} - -1. Continue through the steps of selecting the account you want to authorize. - -2. **NOTE**: You may get a message telling you that the app has not been verified and you will need to acknowledge that in order to proceed. - -3. You can now see the details of what you are authorizing Home Assistant to access with two options at the bottom. Select **Continue**. - -4. The page will now display **Link account to Home Assistant?**, note **Your instance URL**. If this is not correct, refer to [My Home Assistant](/integrations/my). If everything looks good, select **Link Account**. - -5. You may close the window, and return back to Home Assistant where you should see a **Success!** message from Home Assistant. - -{% enddetails %} +{% include integrations/google_oauth.md %} diff --git a/source/_layouts/post.html b/source/_layouts/post.html index 0a61f1f3c02..13c1891201c 100644 --- a/source/_layouts/post.html +++ b/source/_layouts/post.html @@ -10,7 +10,7 @@ is_post: true
-{% if page.comments == true %} +{% if page.comments == true and site.netlify.branch == "current" %}