Merge branch 'current' into esphome-migrate-bluetooth-n-mediaplayer-pages
2
Gemfile
@ -20,7 +20,7 @@ group :jekyll_plugins do
|
|||||||
end
|
end
|
||||||
|
|
||||||
gem 'sinatra', '3.0.6'
|
gem 'sinatra', '3.0.6'
|
||||||
gem 'nokogiri', '1.14.3'
|
gem 'nokogiri', '1.15.0'
|
||||||
|
|
||||||
# Windows and JRuby does not include zoneinfo files, so bundle the tzinfo-data gem
|
# Windows and JRuby does not include zoneinfo files, so bundle the tzinfo-data gem
|
||||||
# and associated library
|
# and associated library
|
||||||
|
@ -72,8 +72,8 @@ GEM
|
|||||||
multi_json (1.15.0)
|
multi_json (1.15.0)
|
||||||
mustermann (3.0.0)
|
mustermann (3.0.0)
|
||||||
ruby2_keywords (~> 0.0.1)
|
ruby2_keywords (~> 0.0.1)
|
||||||
nokogiri (1.14.3)
|
nokogiri (1.15.0)
|
||||||
mini_portile2 (~> 2.8.0)
|
mini_portile2 (~> 2.8.2)
|
||||||
racc (~> 1.4)
|
racc (~> 1.4)
|
||||||
pathutil (0.16.2)
|
pathutil (0.16.2)
|
||||||
forwardable-extended (~> 2.6)
|
forwardable-extended (~> 2.6)
|
||||||
@ -87,7 +87,7 @@ GEM
|
|||||||
rb-inotify (0.10.1)
|
rb-inotify (0.10.1)
|
||||||
ffi (~> 1.0)
|
ffi (~> 1.0)
|
||||||
rexml (3.2.5)
|
rexml (3.2.5)
|
||||||
rouge (4.1.0)
|
rouge (4.1.1)
|
||||||
ruby2_keywords (0.0.5)
|
ruby2_keywords (0.0.5)
|
||||||
safe_yaml (1.0.5)
|
safe_yaml (1.0.5)
|
||||||
sass (3.4.25)
|
sass (3.4.25)
|
||||||
@ -129,7 +129,7 @@ DEPENDENCIES
|
|||||||
jekyll-paginate (= 1.1.0)
|
jekyll-paginate (= 1.1.0)
|
||||||
jekyll-sitemap (= 1.4.0)
|
jekyll-sitemap (= 1.4.0)
|
||||||
jekyll-toc (= 0.18.0)
|
jekyll-toc (= 0.18.0)
|
||||||
nokogiri (= 1.14.3)
|
nokogiri (= 1.15.0)
|
||||||
rake (= 13.0.6)
|
rake (= 13.0.6)
|
||||||
sass-globbing (= 1.1.5)
|
sass-globbing (= 1.1.5)
|
||||||
sassc (= 2.1.0)
|
sassc (= 2.1.0)
|
||||||
|
@ -110,8 +110,8 @@ social:
|
|||||||
# Home Assistant release details
|
# Home Assistant release details
|
||||||
current_major_version: 2023
|
current_major_version: 2023
|
||||||
current_minor_version: 5
|
current_minor_version: 5
|
||||||
current_patch_version: 2
|
current_patch_version: 3
|
||||||
date_released: 2023-05-05
|
date_released: 2023-05-14
|
||||||
|
|
||||||
# Either # or the anchor link to latest release notes in the blog post.
|
# Either # or the anchor link to latest release notes in the blog post.
|
||||||
# Must be prefixed with a # and have double quotes around it.
|
# Must be prefixed with a # and have double quotes around it.
|
||||||
|
@ -72,6 +72,8 @@
|
|||||||
Conditions are an optional part of an automation that will prevent an
|
Conditions are an optional part of an automation that will prevent an
|
||||||
action from firing if they are not met.
|
action from firing if they are not met.
|
||||||
link: /docs/scripts/conditions/
|
link: /docs/scripts/conditions/
|
||||||
|
aliases:
|
||||||
|
- conditions
|
||||||
|
|
||||||
- term: Cover
|
- term: Cover
|
||||||
definition: >-
|
definition: >-
|
||||||
@ -282,6 +284,19 @@
|
|||||||
other integrations.
|
other integrations.
|
||||||
link: /docs/configuration/platform_options/
|
link: /docs/configuration/platform_options/
|
||||||
|
|
||||||
|
- term: Reload
|
||||||
|
definition: >-
|
||||||
|
Updates Home Assistant configuration files. Changes are normally
|
||||||
|
automatically updated. However, when changes are made outside of the UI
|
||||||
|
and at a file level, Home Assistant is not aware of these changes and
|
||||||
|
requires the configuration file(s) to be reloaded to pick up any changes
|
||||||
|
made by going to **Settings** > **System** > **Restart Home Assistant**
|
||||||
|
(top right) > **Quick reload**. More granular reload options are available
|
||||||
|
in *YAML configuration reloading* section in **Developer tools** > **YAML**.
|
||||||
|
excerpt: >
|
||||||
|
Updates Home Assistant configuration files. Changes are normally
|
||||||
|
automatically updated.
|
||||||
|
|
||||||
- term: Scene
|
- term: Scene
|
||||||
definition: >-
|
definition: >-
|
||||||
Scenes capture the states you want certain entities to be. For example,
|
Scenes capture the states you want certain entities to be. For example,
|
||||||
@ -335,8 +350,9 @@
|
|||||||
A service carries out one specific task, for example: turn on the light in the
|
A service carries out one specific task, for example: turn on the light in the
|
||||||
living room. A service has targets and data and can be called by actions, a
|
living room. A service has targets and data and can be called by actions, a
|
||||||
dashboard, or via voice command.
|
dashboard, or via voice command.
|
||||||
|
|
||||||
link: /docs/scripts/service-calls/
|
link: /docs/scripts/service-calls/
|
||||||
|
aliases:
|
||||||
|
- services
|
||||||
|
|
||||||
- term: State
|
- term: State
|
||||||
definition: |-
|
definition: |-
|
||||||
|
@ -49,8 +49,8 @@
|
|||||||
<li>{% active_link /docs/assist/voice_remote_expose_devices/ Exposing devices to your voice assistant %}</li>
|
<li>{% active_link /docs/assist/voice_remote_expose_devices/ Exposing devices to your voice assistant %}</li>
|
||||||
<li>{% active_link /docs/assist/voice_remote_local_assistant/ Configuring a local assistant %}</li>
|
<li>{% active_link /docs/assist/voice_remote_local_assistant/ Configuring a local assistant %}</li>
|
||||||
<li>{% active_link /docs/assist/troubleshooting/ Troubleshooting Assist %}</li>
|
<li>{% active_link /docs/assist/troubleshooting/ Troubleshooting Assist %}</li>
|
||||||
<li>{% active_link /projects/worlds-most-private-voice-assistant/ Tutorial: World's most private voice assistant %}</li>
|
|
||||||
<li>{% active_link /docs/assist/voice_remote_local_assistant/ Configuring a local assistant %}</li>
|
<li>{% active_link /docs/assist/voice_remote_local_assistant/ Configuring a local assistant %}</li>
|
||||||
|
<li>{% active_link /projects/worlds-most-private-voice-assistant/ Tutorial: World's most private voice assistant %}</li>
|
||||||
<li>{% active_link /projects/thirteen-usd-voice-remote/ Tutorial: $13 voice remote %}
|
<li>{% active_link /projects/thirteen-usd-voice-remote/ Tutorial: $13 voice remote %}
|
||||||
</li>
|
</li>
|
||||||
</ul>
|
</ul>
|
||||||
|
@ -10,8 +10,7 @@ interface, by using this My button:
|
|||||||
|
|
||||||
{% if include.discovery or page.ha_dhcp or page.ha_homekit or page.ha_ssdp or page.ha_zeroconf or page.ha_mqtt %}
|
{% if include.discovery or page.ha_dhcp or page.ha_homekit or page.ha_ssdp or page.ha_zeroconf or page.ha_mqtt %}
|
||||||
{{ name }} can be auto-discovered by Home Assistant. If an instance was found,
|
{{ name }} can be auto-discovered by Home Assistant. If an instance was found,
|
||||||
it will be shown as _"Discovered"_, which you can select to set it up right
|
it will be shown as **Discovered**. You can then set it up right away.
|
||||||
away.
|
|
||||||
{% endif %}
|
{% endif %}
|
||||||
|
|
||||||
{% details "Manual configuration steps" %}
|
{% details "Manual configuration steps" %}
|
||||||
@ -24,17 +23,17 @@ manually:
|
|||||||
{% endif %}
|
{% endif %}
|
||||||
|
|
||||||
- Browse to your Home Assistant instance.
|
- Browse to your Home Assistant instance.
|
||||||
- In the sidebar click on _**{% my config icon %}**_.
|
- In the sidebar, select **{% my config icon %}**.
|
||||||
- From the configuration menu select: _**{% my integrations %}**_.
|
- From the configuration menu, select **{% my integrations %}**.
|
||||||
{% if page.ha_integration_type == 'helper' %}
|
{% if page.ha_integration_type == 'helper' %}
|
||||||
- In top of the screen click the tab: _**{% my helpers %}**_.
|
- In top of the screen, select the tab: **{% my helpers %}**.
|
||||||
- In the bottom right, click on the
|
- In the bottom right, select the
|
||||||
_**{% my config_flow_start icon domain=domain title="Create helper" %}**_ button.
|
**{% my config_flow_start icon domain=domain title="Create helper" %}** button.
|
||||||
{% else %}
|
{% else %}
|
||||||
- In the bottom right, click on the
|
- In the bottom right, select the
|
||||||
_**{% my config_flow_start icon domain=domain %}**_ button.
|
**{% my config_flow_start icon domain=domain %}** button.
|
||||||
{% endif %}
|
{% endif %}
|
||||||
- From the list, search and select _**"{{ name }}"**_.
|
- From the list, search and select **{{ name }}**.
|
||||||
- Follow the instruction on screen to complete the set up.
|
- Follow the instructions on screen to complete the setup.
|
||||||
|
|
||||||
{% enddetails %}
|
{% enddetails %}
|
||||||
|
@ -17,7 +17,11 @@ ha_platforms:
|
|||||||
ha_integration_type: device
|
ha_integration_type: device
|
||||||
---
|
---
|
||||||
|
|
||||||
The Android TV Remote integration allows you to control an Android TV device by sending [commands](https://github.com/tronikos/androidtvremote2/blob/main/TvKeys.txt) and launching apps. For this to work the Android TV device needs to have [Android TV Remote Service](https://play.google.com/store/apps/details?id=com.google.android.tv.remote.service) which is pre-installed on most devices.
|
The Android TV Remote integration allows you to control an Android TV device by sending [commands](https://github.com/tronikos/androidtvremote2/blob/main/TvKeys.txt) and launching apps. For this to work, the Android TV device needs to have [Android TV Remote Service](https://play.google.com/store/apps/details?id=com.google.android.tv.remote.service) which is pre-installed on most devices.
|
||||||
|
|
||||||
|
For a quick introduction on how to get started with Android TV Remote, check out this video:
|
||||||
|
|
||||||
|
<lite-youtube videoid="htbnf5YxAuw" videotitle="Android TV Remote Integration with Home Assistant"></lite-youtube>
|
||||||
|
|
||||||
{% include integrations/config_flow.md %}
|
{% include integrations/config_flow.md %}
|
||||||
|
|
||||||
@ -30,10 +34,10 @@ The entity has the `current_activity` attribute that shows the current foregroun
|
|||||||
|
|
||||||
You can use the `remote.turn_off`, `remote.turn_on`, `remote.toggle`, and `remote.send_command` services from the [remote](/integrations/remote/) platform.
|
You can use the `remote.turn_off`, `remote.turn_on`, `remote.toggle`, and `remote.send_command` services from the [remote](/integrations/remote/) platform.
|
||||||
|
|
||||||
For a list of the most common commands you can send to the Android TV via `remote.send_command` see: [TvKeys](https://github.com/tronikos/androidtvremote2/blob/main/TvKeys.txt).
|
For a list of the most common commands that you can send to the Android TV via `remote.send_command`, see: [TvKeys](https://github.com/tronikos/androidtvremote2/blob/main/TvKeys.txt).
|
||||||
For a full list see [here](https://github.com/tronikos/androidtvremote2/blob/main/src/androidtvremote2/remotemessage.proto#L90).
|
For a full list, see [here](https://github.com/tronikos/androidtvremote2/blob/main/src/androidtvremote2/remotemessage.proto#L90).
|
||||||
|
|
||||||
If `activity` is specified in `remote.turn_on` it will open the specified URL in the associated app.
|
If `activity` is specified in `remote.turn_on`, it will open the specified URL in the associated app.
|
||||||
|
|
||||||
Examples of URLs to pass as activity for some popular apps:
|
Examples of URLs to pass as activity for some popular apps:
|
||||||
|
|
||||||
|
@ -15,7 +15,7 @@ ha_platforms:
|
|||||||
ha_integration_type: integration
|
ha_integration_type: integration
|
||||||
---
|
---
|
||||||
|
|
||||||
The `arcam_fmj` integration allows you to control [Arcam FMJ Receivers](https://www.arcam.co.uk/range/fmj.htm) from Home Assistant.
|
The `arcam_fmj` integration allows you to control [Arcam Receivers and Processors](https://www.arcam.co.uk/range/fmj.htm) from Home Assistant.
|
||||||
|
|
||||||
Supported devices:
|
Supported devices:
|
||||||
|
|
||||||
@ -41,7 +41,7 @@ Supported devices:
|
|||||||
- SA 30
|
- SA 30
|
||||||
- SR 250
|
- SR 250
|
||||||
|
|
||||||
This integration may also work with JBL and AudioControl receivers and processors as they share the same firmware as Arcam.
|
This integration may also work with [JBL](https://www.jblsynthesis.com/products/electronics/) and [AudioControl](https://www.audiocontrol.com/home-audio/) receivers and processors as they share the same firmware as Arcam.
|
||||||
|
|
||||||
- SDP-55/58
|
- SDP-55/58
|
||||||
|
|
||||||
@ -49,7 +49,11 @@ This integration may also work with JBL and AudioControl receivers and processor
|
|||||||
|
|
||||||
## Power state
|
## Power state
|
||||||
|
|
||||||
Arcam FMJ receivers turn off their network port when in standby, the component will try to reconnect to the receiver every 5 seconds. This means powering on the first zone is not possible over the built-in network connection. Two options for complete power control exists: IR or Serial gateway.
|
Arcam receivers turn off their network port when in standby, the component will try to reconnect to the receiver every 5 seconds. This means powering on the first zone is not possible over the built-in network connection.
|
||||||
|
|
||||||
|
Note: Some newer models offer the ability to configure the device to keep the network port active when in standby mode. This can be found under **HDMI Settings** > **HDMI Bypass & IP**. Enabling **HDMI & IP On** will allow full power control from Home Assistant.
|
||||||
|
|
||||||
|
Two other options for complete power control exists: IR or Serial gateway.
|
||||||
|
|
||||||
### IR command
|
### IR command
|
||||||
|
|
||||||
|
@ -36,12 +36,10 @@ state over the other. This is set by the binary sensor's device class.
|
|||||||
|
|
||||||
Here are a few examples of this representation in the UI:
|
Here are a few examples of this representation in the UI:
|
||||||
|
|
||||||
<p class='img'>
|

|
||||||
<img src='/images/screenshots/binary_sensor_classes_icons.png' />
|
|
||||||
Example of various device classes icons in `on` and `off` state. The on image
|
Example of various device classes icons in `on` and `off` state. The on image
|
||||||
in this example has `state_color: true` specified in the Entities card
|
in this example has `state_color: true` specified in the Entities card
|
||||||
configuration to receive the icon coloring.
|
configuration to receive the icon coloring.
|
||||||
</p>
|
|
||||||
|
|
||||||
The full list of supported binary sensor device classes is below
|
The full list of supported binary sensor device classes is below
|
||||||
*(note: these may also be modified in the [customizing section](/docs/configuration/customizing-devices)).*
|
*(note: these may also be modified in the [customizing section](/docs/configuration/customizing-devices)).*
|
||||||
|
@ -15,7 +15,7 @@ Home Assistant can give you an interface to control covers such as rollershutter
|
|||||||
|
|
||||||
## Device Class
|
## Device Class
|
||||||
|
|
||||||
The way these sensors are displayed in the frontend can be modified in the [customize section](/docs/configuration/customizing-devices/). The following device classes are supported for covers:
|
The way these {% term sensors %} are displayed in the {% term frontend %} can be modified in the [customize section](/docs/configuration/customizing-devices/). The following device classes are supported for covers:
|
||||||
|
|
||||||
- **None**: Generic cover. This is the default and doesn't need to be set.
|
- **None**: Generic cover. This is the default and doesn't need to be set.
|
||||||
- **awning**: Control of an awning, such as an exterior retractable window, door, or patio cover.
|
- **awning**: Control of an awning, such as an exterior retractable window, door, or patio cover.
|
||||||
@ -31,7 +31,8 @@ The way these sensors are displayed in the frontend can be modified in the [cust
|
|||||||
|
|
||||||
Here are a few examples of this representation in the UI:
|
Here are a few examples of this representation in the UI:
|
||||||
|
|
||||||
<p class='img'><img src='/images/screenshots/cover_classes_icons.png' />Example of various device classes icons in `open` and `closed` state. The open image in this example has `state_color: true` specified in the Entities card configuration to receive the icon coloring.</p>
|

|
||||||
|
Example of various device classes icons in `open` and `closed` state. The open image in this example has `state_color: true` specified in the Entities card configuration to receive the icon coloring.
|
||||||
|
|
||||||
## Services
|
## Services
|
||||||
|
|
||||||
@ -43,6 +44,19 @@ Available services: `cover.open_cover`, `cover.close_cover`, `cover.stop_cover`,
|
|||||||
| ---------------------- | -------- | ----------- |
|
| ---------------------- | -------- | ----------- |
|
||||||
| `entity_id` | yes | String or list of strings that point at `entity_id`'s of covers. Use `entity_id: all` to target all.
|
| `entity_id` | yes | String or list of strings that point at `entity_id`'s of covers. Use `entity_id: all` to target all.
|
||||||
|
|
||||||
|
#### Automation example
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
automation:
|
||||||
|
trigger:
|
||||||
|
platform: time
|
||||||
|
at: "07:15:00"
|
||||||
|
action:
|
||||||
|
- service: cover.open_cover
|
||||||
|
target:
|
||||||
|
entity_id: cover.demo
|
||||||
|
```
|
||||||
|
|
||||||
### Service `cover.set_cover_position`
|
### Service `cover.set_cover_position`
|
||||||
|
|
||||||
Set cover position of one or multiple covers.
|
Set cover position of one or multiple covers.
|
||||||
|
@ -35,27 +35,25 @@ The name you give your application on the [Discord My Apps page](https://discord
|
|||||||
|
|
||||||
### Setting up the bot
|
### Setting up the bot
|
||||||
|
|
||||||
Bots can send messages to servers and users or attach locally available images. To add the bot to a server you are an admin on use the **Application ID** you noted above, found on the [Discord My Apps page](https://discordapp.com/developers/applications/me).
|
Bots can send messages to servers and users or attach locally available images. To add the bot to a server you are an admin on, use the **Application ID** you noted above, found on the [Discord My Apps page](https://discordapp.com/developers/applications/me).
|
||||||
|
|
||||||
<p class='img'>
|

|
||||||
<img src='/images/screenshots/discord-bot.png' />
|
|
||||||
</p>
|
|
||||||
|
|
||||||
Now use the Discord Authorization page with the **Application ID** of your [application](https://discordapp.com/developers/docs/topics/oauth2#bots).
|
Next, decide what permissions your bot will have within your server. Under the 'Bot' section, select the permissions you want to grant and copy the permissions integer from the bottom field.
|
||||||
|
|
||||||
`https://discordapp.com/api/oauth2/authorize?client_id=[APPLICATION_ID]&scope=bot&permissions=0`
|

|
||||||
|
|
||||||
<p class='img'>
|
Now use the Discord Authorization page with the **Application ID** of your [application](https://discordapp.com/developers/docs/topics/oauth2#bots) and the **Permissions Integer**.
|
||||||
<img src='/images/screenshots/discord-auth.png' />
|
|
||||||
</p>
|
`https://discordapp.com/api/oauth2/authorize?client_id=[APPLICATION_ID]&scope=bot&permissions=[PERMISSIONS_INTEGER]`
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
Wait for the confirmation which should say "Authorized".
|
Wait for the confirmation which should say "Authorized".
|
||||||
|
|
||||||
Once the bot has been added to your server, get the channel ID of the channel you want the bot to operate in. In The Discord application go to **Settings** > **Advanced** > **Enable Developer Mode**.
|
Once the bot has been added to your server, get the channel ID of the channel you want the bot to operate in. In The Discord application go to **Settings** > **Advanced** > **Enable Developer Mode**.
|
||||||
|
|
||||||
<p class='img'>
|

|
||||||
<img src='/images/screenshots/discord-api.png' />
|
|
||||||
</p>
|
|
||||||
|
|
||||||
Right click channel name and copy the channel ID (**Copy ID**).
|
Right click channel name and copy the channel ID (**Copy ID**).
|
||||||
|
|
||||||
|
@ -269,6 +269,7 @@ entity_config:
|
|||||||
Currently, the following domains are available to be used with Google Assistant, listed with their default types:
|
Currently, the following domains are available to be used with Google Assistant, listed with their default types:
|
||||||
|
|
||||||
- alarm_control_panel (arm/disarm)
|
- alarm_control_panel (arm/disarm)
|
||||||
|
- button (scene)
|
||||||
- camera (streaming, requires compatible camera)
|
- camera (streaming, requires compatible camera)
|
||||||
- group (on/off)
|
- group (on/off)
|
||||||
- input_boolean (on/off)
|
- input_boolean (on/off)
|
||||||
|
@ -27,26 +27,26 @@ If you have already set up the correct credentials, you can do step 1 and then s
|
|||||||
{% details "Generate Client ID and Client Secret" %}
|
{% details "Generate Client ID and Client Secret" %}
|
||||||
|
|
||||||
This section explains how to generate a Client ID and Client Secret on
|
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?project=home-assistant-17698).
|
[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?project=home-assistant-17698)
|
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 click continue.
|
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 click 'Go to credentials'
|
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)
|
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**.
|
5. Click on the field on the left of the screen, **OAuth Consent Screen**.
|
||||||
6. Select **External** and **Create**.
|
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*.
|
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, click the drop-down box and select your email address.
|
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).
|
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 click **Save and Continue**. You don't have to fill out anything else, or it may enable additional review.
|
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 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. 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. Click **OAuth consent screen** again and set *Publish Status* to **Production** otherwise your credentials will expire every 7 days.
|
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.
|
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*.
|
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").
|
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.
|
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 these shortly. Once you have noted these strings, click **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*, 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. 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.
|
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 %}
|
{% enddetails %}
|
||||||
|
|
||||||
@ -60,11 +60,11 @@ The integration setup will next give you instructions to enter the [Application
|
|||||||
|
|
||||||
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.
|
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**.
|
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, please refer to [My Home Assistant](/integrations/my). If everything looks good, click **Link Account**.
|
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.
|
5. You may close the window, and return back to Home Assistant where you should see a **Success!** message from Home Assistant.
|
||||||
|
|
||||||
{% enddetails %}
|
{% enddetails %}
|
||||||
|
|
||||||
|
@ -129,6 +129,11 @@ duration:
|
|||||||
|
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
|
### Video Tutorial
|
||||||
|
This video tutorial explains how you can use history stats. It also shows how you can create a daily bar chart graph to visualize things such as occupancy, or how long the lights are on in a particular room.
|
||||||
|
|
||||||
|
<lite-youtube videoid="BMlU4SynQBY" videotitle="How To Master Graphs to Monitor Occupancy and Device Usage in Home Assistant" posterquality="maxresdefault"></lite-youtube>
|
||||||
|
|
||||||
### Examples
|
### Examples
|
||||||
|
|
||||||
Here are some examples of periods you could work with, and what to write in your `configuration.yaml`:
|
Here are some examples of periods you could work with, and what to write in your `configuration.yaml`:
|
||||||
|
@ -117,7 +117,6 @@ template:
|
|||||||
Date: "{{ trigger.event.data['date'] }}"
|
Date: "{{ trigger.event.data['date'] }}"
|
||||||
Subject: "{{ trigger.event.data['subject'] }}"
|
Subject: "{{ trigger.event.data['subject'] }}"
|
||||||
To: "{{ trigger.event.data['headers']['Delivered-To'][0] }}"
|
To: "{{ trigger.event.data['headers']['Delivered-To'][0] }}"
|
||||||
Subject: "{{ trigger.event.data['headers']['Subject'][0] }}"
|
|
||||||
Return_Path: "{{ trigger.event.data['headers']['Return-Path'][0] }}"
|
Return_Path: "{{ trigger.event.data['headers']['Return-Path'][0] }}"
|
||||||
Received-first: "{{ trigger.event.data['headers']['Received'][0] }}"
|
Received-first: "{{ trigger.event.data['headers']['Received'][0] }}"
|
||||||
Received-last: "{{ trigger.event.data['headers']['Received'][-1] }}"
|
Received-last: "{{ trigger.event.data['headers']['Received'][-1] }}"
|
||||||
|
@ -14,14 +14,14 @@ ha_integration_type: helper
|
|||||||
|
|
||||||
The Input Boolean helper integration allows you to define boolean values that
|
The Input Boolean helper integration allows you to define boolean values that
|
||||||
can be controlled via the user interface and can be used within conditions of
|
can be controlled via the user interface and can be used within conditions of
|
||||||
an automation. This can for example be used to disable or enable certain
|
an {% term automation %}. This can for example be used to disable or enable certain
|
||||||
automations by using them in their conditions.
|
automations by using them in their {% term conditions %}.
|
||||||
|
|
||||||
## Configuration
|
## Configuration
|
||||||
|
|
||||||
The preferred way to configure input boolean helpers is via the user interface,
|
The preferred way to configure input boolean helpers is via the user interface,
|
||||||
in which they are known as Toggle Helpers. To add one, go to
|
in which they are known as Toggle Helpers. To add one, go to
|
||||||
**{% my helpers title="Settings -> Devices & Services -> Helpers" %}** and click the add button;
|
**{% my helpers title="Settings > Devices & Services > Helpers" %}** and click the add button;
|
||||||
next choose the **{% my config_flow_start domain=input_boolean title="Toggle" %}** option.
|
next choose the **{% my config_flow_start domain=input_boolean title="Toggle" %}** option.
|
||||||
|
|
||||||
To be able to add **Helpers** via the user interface you should have
|
To be able to add **Helpers** via the user interface you should have
|
||||||
@ -32,14 +32,6 @@ then you can use the UI.
|
|||||||
|
|
||||||
Input booleans can also be configured via `configuration.yaml`:
|
Input booleans can also be configured via `configuration.yaml`:
|
||||||
|
|
||||||
```yaml
|
|
||||||
# Example configuration.yaml entry
|
|
||||||
input_boolean:
|
|
||||||
notify_home:
|
|
||||||
name: Notify when someone arrives home
|
|
||||||
icon: mdi:car
|
|
||||||
```
|
|
||||||
|
|
||||||
{% configuration %}
|
{% configuration %}
|
||||||
input_boolean:
|
input_boolean:
|
||||||
description: Alias for the input. Multiple entries are allowed.
|
description: Alias for the input. Multiple entries are allowed.
|
||||||
@ -61,9 +53,17 @@ input_boolean:
|
|||||||
type: icon
|
type: icon
|
||||||
{% endconfiguration %}
|
{% endconfiguration %}
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
# Example configuration.yaml entry
|
||||||
|
input_boolean:
|
||||||
|
notify_home:
|
||||||
|
name: Notify when someone arrives home
|
||||||
|
icon: mdi:car
|
||||||
|
```
|
||||||
|
|
||||||
## Services
|
## Services
|
||||||
|
|
||||||
This integration provides the following services to modify the state of the
|
This integration provides the following {% term services %} to modify the state of the
|
||||||
`input_boolean` and a service to reload the configuration without restarting
|
`input_boolean` and a service to reload the configuration without restarting
|
||||||
Home Assistant itself.
|
Home Assistant itself.
|
||||||
|
|
||||||
@ -105,7 +105,7 @@ automation:
|
|||||||
|
|
||||||
You can also set or change the status of an `input_boolean` by using
|
You can also set or change the status of an `input_boolean` by using
|
||||||
`input_boolean.turn_on`, `input_boolean.turn_off` or `input_boolean.toggle` in
|
`input_boolean.turn_on`, `input_boolean.turn_off` or `input_boolean.toggle` in
|
||||||
your automations.
|
your automation action.
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
service: input_boolean.turn_on
|
service: input_boolean.turn_on
|
||||||
|
@ -67,7 +67,7 @@ pull_mode:
|
|||||||
default: "`UP`"
|
default: "`UP`"
|
||||||
{% endconfiguration %}
|
{% endconfiguration %}
|
||||||
|
|
||||||
For more details about the GPIO layout, visit the Wikipedia [article](https://en.wikipedia.org/wiki/Raspberry_Pi#GPIO_connector) about the Raspberry Pi.
|
For more details about the GPIO layout, visit the Wikipedia [article](https://en.wikipedia.org/wiki/Raspberry_Pi#J8_header_and_general_purpose_input-output_(GPIO)) about the Raspberry Pi.
|
||||||
|
|
||||||
## Switch
|
## Switch
|
||||||
|
|
||||||
@ -106,7 +106,7 @@ invert_logic:
|
|||||||
type: boolean
|
type: boolean
|
||||||
{% endconfiguration %}
|
{% endconfiguration %}
|
||||||
|
|
||||||
For more details about the GPIO layout, visit the Wikipedia [article](https://en.wikipedia.org/wiki/Raspberry_Pi#GPIO_connector) about the Raspberry Pi.
|
For more details about the GPIO layout, visit the Wikipedia [article](https://en.wikipedia.org/wiki/Raspberry_Pi#J8_header_and_general_purpose_input-output_(GPIO)) about the Raspberry Pi.
|
||||||
|
|
||||||
<div class='note warning'>
|
<div class='note warning'>
|
||||||
Note that a pin managed by Home Assistant is expected to be exclusive to Home Assistant.
|
Note that a pin managed by Home Assistant is expected to be exclusive to Home Assistant.
|
||||||
@ -126,4 +126,4 @@ switch:
|
|||||||
|
|
||||||
### Troubleshooting
|
### Troubleshooting
|
||||||
|
|
||||||
If you receive an error such as `gpiozero.exc.BadPinFactory: Unable to load any default pin factory!` try changing the pinfactory from `pigpio` to `mock`, this addresses a [known issue](https://www.raspberrypi.org/forums/viewtopic.php?p=1417922).
|
If you receive an error such as `gpiozero.exc.BadPinFactory: Unable to load any default pin factory!` try changing the pinfactory from `pigpio` to `mock`, this addresses a [known issue](https://forums.raspberrypi.com/viewtopic.php?p=1417922).
|
||||||
|
@ -182,6 +182,7 @@ The following models have been tested and confirmed to work:
|
|||||||
- RLC-522
|
- RLC-522
|
||||||
- RLC-810A
|
- RLC-810A
|
||||||
- RLC-811A
|
- RLC-811A
|
||||||
|
- RLC-81PA
|
||||||
- RLC-820A
|
- RLC-820A
|
||||||
- RLC-822A
|
- RLC-822A
|
||||||
- RLC-823A
|
- RLC-823A
|
||||||
@ -190,6 +191,7 @@ The following models have been tested and confirmed to work:
|
|||||||
- RLN8-410 NVR
|
- RLN8-410 NVR
|
||||||
- RLN16-410 NVR
|
- RLN16-410 NVR
|
||||||
- RLN36 NVR
|
- RLN36 NVR
|
||||||
|
- Reolink Duo 2 WiFi
|
||||||
- Reolink Duo Floodlight PoE
|
- Reolink Duo Floodlight PoE
|
||||||
- Reolink TrackMix PoE
|
- Reolink TrackMix PoE
|
||||||
- Reolink Video Doorbell (PoE and Wi-Fi)
|
- Reolink Video Doorbell (PoE and Wi-Fi)
|
||||||
|
@ -17,10 +17,30 @@ ha_platforms:
|
|||||||
ha_integration_type: integration
|
ha_integration_type: integration
|
||||||
---
|
---
|
||||||
|
|
||||||
The Roborock integration allows you to control your [Roborock](https://us.roborock.com/pages/robot-vacuum-cleaner) vacuum while continuing to use the Roborock app.
|
The Roborock integration allows you to control your [Roborock](https://us.roborock.com/pages/robot-vacuum-cleaner) vacuum while using the Roborock app.
|
||||||
|
|
||||||
In contrast to [Xiaomi Miio](/integrations/xiaomi_miio/) integration, this integration provides more complete support but requires cloud access to set up and device configuration using the Roborock app.
|
This integration requires a cloud connection to set up the device, but it communicates with the device entirely over your home network.
|
||||||
|
|
||||||
Once you log in with your Roborock account, the integration will automatically discover your Roborock devices and get the needed information to communicate locally with them. Please ensure your Home Assistant instance can communicate with the local IP of your device. We recommend setting a static IP for your Roborock Vacuum to help prevent future issues.
|
Once you log in with your Roborock account, the integration will automatically discover your Roborock devices and get the needed information to communicate locally with them. Please ensure your Home Assistant instance can communicate with the local IP of your device. We recommend setting a static IP for your Roborock Vacuum to help prevent future issues.
|
||||||
|
|
||||||
{% include integrations/config_flow.md %}
|
{% include integrations/config_flow.md %}
|
||||||
|
|
||||||
|
## FAQ
|
||||||
|
|
||||||
|
### Can I use the Mi home app with this integration?
|
||||||
|
No. This integration requires information from your Roborock app to set up and uses Roborock's protocols to communicate with your device. You must have your vacuum synced to the Roborock app.
|
||||||
|
|
||||||
|
### Can I block internet access for this device?
|
||||||
|
As of right now - no. When the vacuum is disconnected from the internet, it will attempt to disconnect itself from Wi-Fi and reconnect itself until it can reach the Roborock servers. We are looking for the best way to handle this and see what can be blocked while still allowing the vacuum to function.
|
||||||
|
|
||||||
|
### What devices are supported?
|
||||||
|
If you can add your device to the Roborock app - it is supported. However, some older vacuums like the Roborock S5 must be connected using the Mi Home app and can be set up in Home Assistant through the [Xiaomi Miio](/integrations/xiaomi_miio/) integration.
|
||||||
|
|
||||||
|
### What features will you support?
|
||||||
|
We are working on adding a lot of features to the core integration. We have reverse-engineered over 100 commands. The following are some of the functionalities we plan to add to Home Assistant Core. We ask that you are patient with us as we add them.
|
||||||
|
- Selective room cleaning
|
||||||
|
- Dock controls
|
||||||
|
- Manual vacuum remote control
|
||||||
|
- Status information such as errors, clean time, consumables, etc.
|
||||||
|
- Viewing the camera
|
||||||
|
- Viewing the map
|
||||||
|
@ -147,6 +147,11 @@ You need to pass a `scene_id` in lowercase and with underscores instead of space
|
|||||||
|
|
||||||
If the scene was previously created by `scene.create`, it will be overwritten. If the scene was created by YAML, nothing happens but a warning in your log files.
|
If the scene was previously created by `scene.create`, it will be overwritten. If the scene was created by YAML, nothing happens but a warning in your log files.
|
||||||
|
|
||||||
|
### Video Tutorial
|
||||||
|
This video tutorial explains how scenes work and how you can utilize scenes on the fly.
|
||||||
|
|
||||||
|
<lite-youtube videoid="JW9PC6ptXcM" videotitle="Scenes on Steroids in Home Assistant - How To - Tutorial" posterquality="maxresdefault"></lite-youtube>
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
# Example automation using entities
|
# Example automation using entities
|
||||||
automation:
|
automation:
|
||||||
@ -205,3 +210,4 @@ The following example turns off some entities as soon as a window opens. The sta
|
|||||||
target:
|
target:
|
||||||
entity_id: scene.before
|
entity_id: scene.before
|
||||||
```
|
```
|
||||||
|
|
||||||
|
@ -18,39 +18,113 @@ ha_integration_type: service
|
|||||||
|
|
||||||
The `slack` platform allows you to deliver notifications from Home Assistant to [Slack](https://slack.com/).
|
The `slack` platform allows you to deliver notifications from Home Assistant to [Slack](https://slack.com/).
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
|
|
||||||
## Setup
|
## Setup
|
||||||
|
|
||||||
### Bot posting as you
|
### Slack App
|
||||||
|
|
||||||
1. Create a [new app](https://api.slack.com/apps) under your Slack.com account.
|
1. Create a [new app](https://api.slack.com/apps) under your Slack.com account.
|
||||||
2. Click the `OAuth & Permissions` link in the sidebar, under the Features heading.
|
2. Click the `OAuth & Permissions` link in the sidebar, under the Features heading.
|
||||||
3. In the Scopes section, add the `chat:write` and `dnd:read` scopes and select `Send messages as user`. Many errors can occur if these options are not set correctly.
|
|
||||||
|
Find `Features/OAuth and Permissions/Scopes/Bot Token Scopes`
|
||||||
|
|
||||||
|
3. Add the `chat:write` and `dnd:read` scopes
|
||||||
|
- To modify your Slack bot's username and icon, additionally add the `chat:write.customize` OAuth scope
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
4. Scroll up to `OAuth Tokens & Redirect URLs` and click `Install to Workspace`.
|
4. Scroll up to `OAuth Tokens & Redirect URLs` and click `Install to Workspace`.
|
||||||
5. Copy your `OAuth Access Token` and put that key into the config flow.
|
|
||||||
|
|
||||||
<div class='note'>
|
In `Features/OAuth and Permissions/OAuth Tokens for Your Workspace`:
|
||||||
|
|
||||||
There is an app credential Verification Token on the Basic Settings of your app. This is **not** the API key you want.
|
5. Copy the Bot User OAuth Token. Use this as 'API Key' when setting up in Home Assistant
|
||||||
|
|
||||||
</div>
|

|
||||||
|
|
||||||
### Bot posting as its own user
|
|
||||||
|
|
||||||
It is also possible to use Slack bots as users. Just create a new bot at https://[YOUR_TEAM].slack.com/apps/build/custom-integration and use the provided token for that. You can add an icon from the frontend for Home Assistant and give the bot a meaningful name.
|
Ensure that the bot user is added to the channel in which you want it to post.
|
||||||
|
In Slack, tag the bot user in a message, then add it to the channel.
|
||||||
|
|
||||||
Don't forget to invite the bot to the room where you want to get the notifications.
|
|
||||||
|
#### Sample App Manifest
|
||||||
|
|
||||||
|
You can easily create a bot with all the permissions needed from an App Manifest.
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
display_information:
|
||||||
|
name: Home Notifications
|
||||||
|
features:
|
||||||
|
bot_user:
|
||||||
|
display_name: Home Notifications
|
||||||
|
always_online: false
|
||||||
|
oauth_config:
|
||||||
|
scopes:
|
||||||
|
bot:
|
||||||
|
- incoming-webhook
|
||||||
|
- chat:write
|
||||||
|
- dnd:read
|
||||||
|
- chat:write.customize
|
||||||
|
settings:
|
||||||
|
org_deploy_enabled: false
|
||||||
|
socket_mode_enabled: false
|
||||||
|
token_rotation_enabled: false
|
||||||
|
```
|
||||||
|
|
||||||
|
### Integration Setup
|
||||||
|
|
||||||
|
When installing the integration, use these settings:
|
||||||
|
|
||||||
|
API Key: `xoxb-abc-def`
|
||||||
|
- Bot User OAuth Token (from step 5 above)
|
||||||
|
|
||||||
|
Default Channel: `#channel`
|
||||||
|
- Channel name that bot will post to if a channel is not supplied when called
|
||||||
|
|
||||||
|
Icon/Username:
|
||||||
|
- optional - if you want to have a custom name/icon for the bot user not already set in Slack
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
|
## Usage
|
||||||
|
|
||||||
|
### Sending Messages
|
||||||
|
|
||||||
|
One of the easiest ways to send a message, is to create a script. You can paste in YAML and make changes in the GUI.
|
||||||
|
|
||||||
|
You can call this script as a service.
|
||||||
|
|
||||||
|
1. Go to Home Assistant Settings > Automations and Scenes > Scripts > Add Script
|
||||||
|
2. Click the three dots in the top right, and pick 'Edit in YAML'. Paste in the contents below.
|
||||||
|
3. Change `YOUR_SLACK_TEAM` to the team name `(*.slack.com)`
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
alias: "Notify: Slack Notification Template"
|
||||||
|
sequence:
|
||||||
|
- service: notify.YOUR_SLACK_TEAM
|
||||||
|
data:
|
||||||
|
message: Fallback Text
|
||||||
|
target: "#test-channel"
|
||||||
|
title: Reminder
|
||||||
|
data:
|
||||||
|
blocks:
|
||||||
|
- type: section
|
||||||
|
text:
|
||||||
|
type: mrkdwn
|
||||||
|
text: >-
|
||||||
|
This is a mrkdwn section block *this is bold*, and ~this is
|
||||||
|
crossed out~, and <https://google.com|this is a link>
|
||||||
|
mode: single
|
||||||
|
```
|
||||||
|
|
||||||
|
Update the blocks array with valid Slack blocks. The easiest way to create this is using [Slack Block Kit Builder](https://app.slack.com/block-kit-builder)
|
||||||
|
|
||||||
|
Create a duplicate of this script to use for different messages, and different channels (the door was opened in #security, the light was left on on #lights, etc).
|
||||||
|
|
||||||
### Icons
|
### Icons
|
||||||
|
|
||||||
Slack uses the standard emoji sets used [here](https://www.webpagefx.com/tools/emoji-cheat-sheet/). Alternatively a publicly accessible URL may be used.
|
Slack uses the standard emoji sets used [here](https://slack.com/intl/en-gb/help/articles/202931348-Use-emoji-and-reactions#add-emoji-to-your-messages). Alternatively a publicly accessible URL may be used.
|
||||||
|
|
||||||
<div class='note'>
|
|
||||||
|
|
||||||
In order to modify your Slack bot's username and icon, you must ensure your Slack app has the `chat:write.customize` OAuth scope. See [the Slack API documentation](https://api.slack.com/methods/chat.postMessage#authorship) for more information.
|
|
||||||
|
|
||||||
The added `notify` service will be named after the chat server the app is installed on. For example, a server named "Slack Chat" wil display as `notify.slack_chat`.
|
|
||||||
|
|
||||||
</div>
|
|
||||||
|
|
||||||
{% include integrations/config_flow.md %}
|
{% include integrations/config_flow.md %}
|
||||||
|
|
||||||
|
@ -29,7 +29,7 @@ ha_platforms:
|
|||||||
ha_integration_type: integration
|
ha_integration_type: integration
|
||||||
---
|
---
|
||||||
|
|
||||||
The SleepIQ integration lets you integrate your SleepNumber Bed via [SleepIQ by SleepNumber](https://www.sleepnumber.com/sleepiq-sleep-tracker).
|
The SleepIQ integration lets you integrate your SleepNumber Bed via [SleepIQ by SleepNumber](https://www.sleepnumber.com/pages/sleepiq-sleep-tracker).
|
||||||
|
|
||||||
There is currently support for the following platforms within Home Assistant:
|
There is currently support for the following platforms within Home Assistant:
|
||||||
|
|
||||||
|
@ -25,10 +25,8 @@ The Ukraine Alarm integration uses the siren.pp.ua API - public wrapper for [Ukr
|
|||||||
|
|
||||||
Siren check interval is set to 10 seconds to avoid overloading the API and still be able to react fast enough.
|
Siren check interval is set to 10 seconds to avoid overloading the API and still be able to react fast enough.
|
||||||
|
|
||||||
## Setup
|
|
||||||
|
|
||||||
{% include integrations/config_flow.md %}
|
{% include integrations/config_flow.md %}
|
||||||
|
|
||||||
## Limitations
|
## Limitations
|
||||||
|
|
||||||
You can add up to 5 regions for monitoring to don't hit API rate limit.
|
You can monitor up to 5 regions to not hit the API rate limit.
|
||||||
|
@ -1,6 +1,6 @@
|
|||||||
---
|
---
|
||||||
title: Waze Travel Time
|
title: Waze Travel Time
|
||||||
description: Instructions on how to add Waze travel time to Home Assistant.
|
description: Instructions on how to add Waze Travel Time to Home Assistant.
|
||||||
ha_category:
|
ha_category:
|
||||||
- Transport
|
- Transport
|
||||||
ha_iot_class: Cloud Polling
|
ha_iot_class: Cloud Polling
|
||||||
@ -21,19 +21,19 @@ The `waze_travel_time` sensor provides travel time from the [Waze](https://www.w
|
|||||||
Notes:
|
Notes:
|
||||||
|
|
||||||
- If a unit system is not specified, the integration will use the unit system configured on your Home Assistant instance.
|
- If a unit system is not specified, the integration will use the unit system configured on your Home Assistant instance.
|
||||||
- Origin and Destination can be the address or the GPS coordinates of the location (GPS coordinates have to be separated by a comma). You can also enter an entity id which provides this information in its state, an entity id with latitude and longitude attributes, or zone friendly name (case sensitive).
|
- **Origin** and **Destination** can be the address or the GPS coordinates of the location. For coordinates, use the following format: `52.5200, 13.4050`. Make sure the coordinates are separated by a comma. They must not include letters. You can also enter an entity id which provides this information in its state, an entity id with latitude and longitude attributes, or zone friendly name (case sensitive).
|
||||||
- The string inputs for `Substring *` allow you to force the integration to use a particular route or avoid a particular route in its time travel calculation. These inputs are case insensitive matched against the description of the route.
|
- The string inputs for `Substring *` allow you to force the integration to use a particular route or avoid a particular route in its time travel calculation. These inputs are case insensitive and matched against the description of the route.
|
||||||
- When using the `Avoid Toll Roads?`, `Avoid Subscription Roads?` and `Avoid Ferries?` options be aware that Waze will sometimes still route you over toll roads or ferries if a valid vignette/subscription is assumed. Default behavior is that Waze will route you over roads having subscription options, so best is to set both `Avoid Toll Roads?` and `Avoid Subscription Roads?` or `Avoid Ferries?` if needed and experiment to ensure the desired outcome.
|
- When using the `Avoid Toll Roads?`, `Avoid Subscription Roads?` and `Avoid Ferries?` options, be aware that Waze will sometimes still route you over toll roads or ferries if a valid vignette/subscription is assumed. Default behavior is that Waze will route you over roads having subscription options. It is therefor best is to set both `Avoid Toll Roads?` and `Avoid Subscription Roads?` or `Avoid Ferries?` if needed and experiment to ensure the desired outcome.
|
||||||
|
|
||||||
## Manual Polling
|
## Manual Polling
|
||||||
|
|
||||||
Some users want more control over polling intervals. To use more granular polling, you can disable automated polling from the entry on the Integration page. Go to the Integrtaion page, select the entry, click on the vertical 3 dots, and then select System Options to turn off or on polling. Afterwards to manually trigger a polling request, call the [`homeassistant.update_entity` service](/integrations/homeassistant/#service-homeassistantupdate_entity) as needed, either manually or via automations.
|
Some users want more control over polling intervals. To use more granular polling, you can disable automated polling. Go to {% my integrations title="**Settings** > **Devices & Services**" %}, and on the **Waze Travel Time** integration, select the 3 dots. Then, select **System options** and toggle the button to disable polling. To manually trigger a polling request, call the [`homeassistant.update_entity` service](/integrations/homeassistant/#service-homeassistantupdate_entity) as needed, either manually or via automations.
|
||||||
|
|
||||||
## Example using dynamic destination
|
## Example using dynamic destination
|
||||||
|
|
||||||
Using the flexible option to set a sensor value to the `Destination`, you can setup a single Waze integration that will calculate travel time to multiple optional locations on demand.
|
Using the flexible option to set a sensor value to the `Destination`, you can setup a single Waze integration that will calculate travel time to multiple optional locations on demand.
|
||||||
|
|
||||||
In the following example, the `Input Select` is converted into an address which is used to modify the destination for Waze route calculation from `device_tracker.myphone` location (It takes a few minutes for the value to update due to the interval of Waze data fetching).
|
In the following example, the `Input Select` is converted into an address which is used to modify the destination for the Waze route calculation from the `device_tracker.myphone` location. It takes a few minutes for the value to update due to the interval of Waze data fetching.
|
||||||
|
|
||||||
{% raw %}
|
{% raw %}
|
||||||
|
|
||||||
@ -68,7 +68,7 @@ template:
|
|||||||
|
|
||||||
#### Tracking entity to entity
|
#### Tracking entity to entity
|
||||||
|
|
||||||
In this example we use a device_tracker entity ID as the origin and the sensor created above as the destination.
|
In this example, we use a device_tracker entity ID as the origin and the sensor created above as the destination.
|
||||||
|
|
||||||
- Name: "Me to some destination"
|
- Name: "Me to some destination"
|
||||||
- Origin: `device_tracker.myphone`
|
- Origin: `device_tracker.myphone`
|
||||||
@ -105,5 +105,5 @@ In this example we are using the entity ID of a zone as the origin and the frien
|
|||||||
## Using the live map in an iFrame
|
## Using the live map in an iFrame
|
||||||
|
|
||||||
If you plan to use [Waze's live map](https://developers.google.com/waze/iframe/)
|
If you plan to use [Waze's live map](https://developers.google.com/waze/iframe/)
|
||||||
in a dashboard [iframe](/dashboards/iframe/) then use
|
in a dashboard [iframe](/dashboards/iframe/), then use
|
||||||
[https://embed.waze.com/iframe](https://embed.waze.com/iframe) and not the live map URL itself.
|
[https://embed.waze.com/iframe](https://embed.waze.com/iframe) and not the live map URL itself.
|
||||||
|
@ -387,21 +387,6 @@ To add a new device:
|
|||||||
1. Reset your Zigbee devices according to the device instructions provided by the manufacturer (e.g., turn on/off lights up to 10 times, switches usually have a reset button/pin). It might take a few seconds for the devices to appear. You can click on **Show logs** for more verbose output.
|
1. Reset your Zigbee devices according to the device instructions provided by the manufacturer (e.g., turn on/off lights up to 10 times, switches usually have a reset button/pin). It might take a few seconds for the devices to appear. You can click on **Show logs** for more verbose output.
|
||||||
1. Once the device is found, it will appear on that page and will be automatically added to your devices. You can optionally change its name and add it to an area (you can change this later). You can search again to add another device, or you can go back to the list of added devices.
|
1. Once the device is found, it will appear on that page and will be automatically added to your devices. You can optionally change its name and add it to an area (you can change this later). You can search again to add another device, or you can go back to the list of added devices.
|
||||||
|
|
||||||
### Best practices to avoid pairing/connection difficulties
|
|
||||||
|
|
||||||
Verify that you try to follow recommended best practices to avoid pairing and/or connection issues:
|
|
||||||
|
|
||||||
- If possible try to pair your Zigbee devices in their intended final location, (and not pair it next to the Zigbee coordinator and then need to move it after).
|
|
||||||
- Pairing a Zigbee device next to the Zigbee coordinator and then moving it later can result in dropped/lost connections or other issues.
|
|
||||||
- If the device you want to add is not brand new and as such never paired before then you always have to make sure to first manually reset the device to its factory default settings before you will be able to add/pair it.
|
|
||||||
- Some battery-operated Zigbee devices are known to have problems with pairing if they have Low battery voltage.
|
|
||||||
- Some people have reported replacing the battery on their newly received Xiaomi/Aqara devices solved pairing issues.
|
|
||||||
- Check that you have enough Zigbee router devices (also known as Zigbee signal repeaters or range extenders) and if you do not have any, invest and add some mains-powered devices that will work as Zigbee routers.
|
|
||||||
- Aim to start out with mains-powered devices before adding battery-operated devices as a "weak" Zigbee network mesh (e.g., the device is too far from the Zigbee coordinator or a Zigbee router) may prevent some devices from being paired. Zigbee router devices are also needed to increase the maximum of devices that can be connected to your Zigbee mesh network.
|
|
||||||
- Note that some Zigbee devices are not fully compatible with all brands of Zigbee router devices. Xiaomi/Aqara devices are for example known not to work with Zigbee router devices from Centralite, General Electrics, Iris, Ledvance/OSRAM, LIGHTIFY/Sylvania, Orvibo, PEQ, Securifi, and SmartThings/Samsung. Better results can usually be achieved by using mains-powered devices IKEA and Nue/3A Home or dedicated DIY routing devices based on Texas Instruments CC253x/CC26x2 and XBee Series 2/3 Zigbee radios.
|
|
||||||
- Be patient as the pairing of some Zigbee devices may require multiple attempts and you may sometimes need to try again and again.
|
|
||||||
- Some devices, like example those from Xiaomi/Aqara, are known to not be 100% compliant with the standard Zigbee specifications and may therefore require many paring attempts over 10-20 minutes or longer.
|
|
||||||
|
|
||||||
### Using router devices
|
### Using router devices
|
||||||
|
|
||||||
You use routers to increase the number of Zigbee devices that can be used in a network. The total number of Zigbee devices that you have on a Zigbee network depends on a few things, but you should know that Zigbee coordinator hardware and firmware only plays a larger role in Zigbee networks with a lot of devices. More important is how many directly connected devices ("direct children") versus how many routers are connected to your Zigbee coordinator. Zigpy library which ZHA uses has an upper limit. This is 32 direct children, but if your Zigbee coordinator hardware is powerful enough then you can still have hundreds of Zigbee devices connected through routers.
|
You use routers to increase the number of Zigbee devices that can be used in a network. The total number of Zigbee devices that you have on a Zigbee network depends on a few things, but you should know that Zigbee coordinator hardware and firmware only plays a larger role in Zigbee networks with a lot of devices. More important is how many directly connected devices ("direct children") versus how many routers are connected to your Zigbee coordinator. Zigpy library which ZHA uses has an upper limit. This is 32 direct children, but if your Zigbee coordinator hardware is powerful enough then you can still have hundreds of Zigbee devices connected through routers.
|
||||||
@ -460,6 +445,23 @@ Home Assistant's ZHA integration already supports most standard device types out
|
|||||||
|
|
||||||
The few devices that will, for example, not join/pair properly or, while joined/paired, do not present all attributes in the ZHA integration likely deviate from the Zigbee specifications set by the [CSA (Connectivity Standards Alliance)](https://csa-iot.org/all-solutions/zigbee/). These devices may therefore require the creation of a bug report by a device owner, supplying debug logs. The device owner may need to actively assist in troubleshooting by providing the information developers need to create custom ZHA Device Handlers.
|
The few devices that will, for example, not join/pair properly or, while joined/paired, do not present all attributes in the ZHA integration likely deviate from the Zigbee specifications set by the [CSA (Connectivity Standards Alliance)](https://csa-iot.org/all-solutions/zigbee/). These devices may therefore require the creation of a bug report by a device owner, supplying debug logs. The device owner may need to actively assist in troubleshooting by providing the information developers need to create custom ZHA Device Handlers.
|
||||||
|
|
||||||
|
### Best practices to avoid pairing/connection difficulties
|
||||||
|
|
||||||
|
If you are having problems pairing a device to then ZHA integratuon then it is recommomended to verify that you try to follow recommended best practices to avoid pairing and/or connection issues:
|
||||||
|
|
||||||
|
- Check that your setup and environment are optimized to avoid interference.
|
||||||
|
- As interference avoidance is an extremely important topic on its own, please read and follow the tips in the separate section below about Zigbee interference avoidance and network range/coverage optimization.
|
||||||
|
- Check that you have enough Zigbee router devices (also known as Zigbee signal repeaters or range extenders) and if you do not have any, invest and add some mains-powered devices that will work as Zigbee routers.
|
||||||
|
- Aim to start out with mains-powered devices before adding battery-operated devices as a "weak" Zigbee network mesh (e.g., the device is too far from the Zigbee coordinator or a Zigbee router) may prevent some devices from being paired. Zigbee router devices are also needed to increase the maximum of devices that can be connected to your Zigbee mesh network.
|
||||||
|
- Note that some Zigbee devices are not fully compatible with all brands of Zigbee router devices. Xiaomi/Aqara devices are for example known not to work with Zigbee router devices from Centralite, General Electrics, Iris, Ledvance/OSRAM, LIGHTIFY/Sylvania, Orvibo, PEQ, Securifi, and SmartThings/Samsung. Better results can usually be achieved by using mains-powered devices IKEA and Nue/3A Home or dedicated DIY routing devices based on Texas Instruments CC253x/CC26x2 and XBee Series 2/3 Zigbee radios.
|
||||||
|
- If possible try to pair your Zigbee devices in their intended final location, (and not pair it next to the Zigbee coordinator and then need to move it after).
|
||||||
|
- Pairing a Zigbee device next to the Zigbee coordinator and then moving it later can result in dropped/lost connections or other issues.
|
||||||
|
- If the device you want to add is not brand new and as such never paired before then you always have to make sure to first manually reset the device to its factory default settings before you will be able to add/pair it.
|
||||||
|
- Some battery-operated Zigbee devices are known to have problems with pairing if they have Low battery voltage.
|
||||||
|
- Some people have reported replacing the battery on their newly received Xiaomi/Aqara devices solved pairing issues.
|
||||||
|
- Be patient as the pairing of some Zigbee devices may require multiple attempts and you may sometimes need to try again and again.
|
||||||
|
- Some devices, like example those from Xiaomi/Aqara, are known to not be 100% compliant with the standard Zigbee specifications and may therefore require many paring attempts over 10-20 minutes or longer.
|
||||||
|
|
||||||
### Zigbee interference avoidance and network range/coverage optimization
|
### Zigbee interference avoidance and network range/coverage optimization
|
||||||
|
|
||||||
Sources of interference for radios can lead to transmission/reception loss or connection problems and show symptoms such as errors/failures when sending and receiving Zigbee messages/signals that can cause significant degradation in performance or even prevent devices from communicating at all. Below are some basic but essential tips for getting a good setup starting point to achieve better signal quality, improved coverage, and extended range.
|
Sources of interference for radios can lead to transmission/reception loss or connection problems and show symptoms such as errors/failures when sending and receiving Zigbee messages/signals that can cause significant degradation in performance or even prevent devices from communicating at all. Below are some basic but essential tips for getting a good setup starting point to achieve better signal quality, improved coverage, and extended range.
|
||||||
|
@ -49,6 +49,7 @@ Enjoy the release!
|
|||||||
- [Integrations now available to set up from the UI](#integrations-now-available-to-set-up-from-the-ui)
|
- [Integrations now available to set up from the UI](#integrations-now-available-to-set-up-from-the-ui)
|
||||||
- [Release 2023.5.1 - May 4](#release-202351---may-4)
|
- [Release 2023.5.1 - May 4](#release-202351---may-4)
|
||||||
- [Release 2023.5.2 - May 5](#release-202352---may-5)
|
- [Release 2023.5.2 - May 5](#release-202352---may-5)
|
||||||
|
- [Release 2023.5.3 - May 14](#release-202353---may-14)
|
||||||
- [Need help? Join the community!](#need-help-join-the-community)
|
- [Need help? Join the community!](#need-help-join-the-community)
|
||||||
- [Breaking Changes](#breaking-changes)
|
- [Breaking Changes](#breaking-changes)
|
||||||
- [Farewell to the following](#farewell-to-the-following)
|
- [Farewell to the following](#farewell-to-the-following)
|
||||||
@ -406,6 +407,138 @@ The following integrations are now available via the Home Assistant UI:
|
|||||||
[transmission docs]: /integrations/transmission/
|
[transmission docs]: /integrations/transmission/
|
||||||
[zha docs]: /integrations/zha/
|
[zha docs]: /integrations/zha/
|
||||||
|
|
||||||
|
## Release 2023.5.3 - May 14
|
||||||
|
|
||||||
|
- Roborock continue on failed mqtt disconnect ([@Lash-L] - [#92502]) ([roborock docs])
|
||||||
|
- Bump bimmer_connected to 0.13.3 ([@rikroe] - [#92648]) ([bmw_connected_drive docs])
|
||||||
|
- Fix parallel_updates being acquired too late for entity executor jobs ([@bdraco] - [#92681])
|
||||||
|
- Always request at least one zone for multi-zone LIFX devices ([@bdraco] - [#92683]) ([lifx docs])
|
||||||
|
- Fix onvif reauth when device returns a http 401/403 error ([@bdraco] - [#92690]) ([onvif docs])
|
||||||
|
- Bump `aionotion` to 2023.05.1 ([@bachya] - [#92697]) ([notion docs])
|
||||||
|
- Bump pyoverkiz to 1.7.8 ([@iMicknl] - [#92702]) ([overkiz docs])
|
||||||
|
- Bump aiowebostv to 0.3.3 to fix Python 3.11 support ([@thecode] - [#92736]) ([webostv docs])
|
||||||
|
- Update deprecated functions in SIA ([@eavanvalkenburg] - [#92737]) ([sia docs])
|
||||||
|
- Bump aioesphomeapi to 3.7.4 to fix proxied BLE connections not retrying right away on error ([@bdraco] - [#92741]) ([esphome docs])
|
||||||
|
- Increase timeout to 30 seconds for Mazda integration ([@bdr99] - [#92744]) ([mazda docs])
|
||||||
|
- Fix zwave_js services example data ([@karwosts] - [#92748]) ([zwave_js docs])
|
||||||
|
- Bump asyncsleepiq to 1.3.5 ([@kbickar] - [#92759]) ([sleepiq docs])
|
||||||
|
- Update aioairzone to v0.5.3 ([@Noltari] - [#92780]) ([airzone docs])
|
||||||
|
- Fix race in Alexa async_enable_proactive_mode ([@emontnemery] - [#92785]) ([alexa docs])
|
||||||
|
- Fix Airzone Auto operation mode ([@Noltari] - [#92796]) ([airzone docs])
|
||||||
|
- Update aioairzone to v0.5.5 ([@Noltari] - [#92812]) ([airzone docs])
|
||||||
|
- Don't try to restore unavailable nor unknown states ([@dgomes] - [#92825]) ([integration docs])
|
||||||
|
- Bump sonos-websocket to 0.1.1 ([@jjlawren] - [#92834]) ([sonos docs])
|
||||||
|
- Allow "no" to match "nb" in language util ([@synesthesiam] - [#92862])
|
||||||
|
- Bump ZHA dependencies ([@puddly] - [#92870]) ([zha docs])
|
||||||
|
- Add ONVIF services to diagnostics ([@bdraco] - [#92878]) ([onvif docs])
|
||||||
|
- Bump UPB integration library to 0.5.4 ([@gwww] - [#92879]) ([upb docs])
|
||||||
|
- Bump bluetooth-auto-recovery to 1.2.0 ([@bdraco] - [#92893]) ([bluetooth docs])
|
||||||
|
- Fix already_configured string in workday ([@gjohansson-ST] - [#92901]) ([workday docs])
|
||||||
|
- Fix uptime sensor deviation detection in Fritz!Tools ([@mib1185] - [#92907]) ([fritz docs])
|
||||||
|
- Bump volvooncall to 0.10.3 to fix sensor type error ([@decompil3d] - [#92913]) ([volvooncall docs])
|
||||||
|
- Bump eternalegypt to 0.0.16 ([@tkdrob] - [#92919]) ([netgear_lte docs])
|
||||||
|
- Bump python-vehicle to 1.0.1 ([@joostlek] - [#92933]) ([rdw docs])
|
||||||
|
- Fix remove of device when surveillance station is not used in Synology DSM ([@mib1185] - [#92957]) ([synology_dsm docs])
|
||||||
|
- Bump reolink-aio to 0.5.15 ([@starkillerOG] - [#92979]) ([reolink docs])
|
||||||
|
- Bump bellows to 0.35.5 to fix Aqara Zigbee connectivity issue ([@puddly] - [#92999]) ([zha docs])
|
||||||
|
- Disable cleanup_closed for aiohttp.TCPConnector with cpython 3.11.1+ ([@bdraco] - [#93013])
|
||||||
|
- Fix sslv2/sslv3 with unverified connections ([@bdraco] - [#93037])
|
||||||
|
- Fix a series of bugs due to Notion API changes ([@bachya] - [#93039]) ([notion docs])
|
||||||
|
|
||||||
|
[#92422]: https://github.com/home-assistant/core/pull/92422
|
||||||
|
[#92502]: https://github.com/home-assistant/core/pull/92502
|
||||||
|
[#92513]: https://github.com/home-assistant/core/pull/92513
|
||||||
|
[#92610]: https://github.com/home-assistant/core/pull/92610
|
||||||
|
[#92648]: https://github.com/home-assistant/core/pull/92648
|
||||||
|
[#92681]: https://github.com/home-assistant/core/pull/92681
|
||||||
|
[#92683]: https://github.com/home-assistant/core/pull/92683
|
||||||
|
[#92690]: https://github.com/home-assistant/core/pull/92690
|
||||||
|
[#92697]: https://github.com/home-assistant/core/pull/92697
|
||||||
|
[#92702]: https://github.com/home-assistant/core/pull/92702
|
||||||
|
[#92736]: https://github.com/home-assistant/core/pull/92736
|
||||||
|
[#92737]: https://github.com/home-assistant/core/pull/92737
|
||||||
|
[#92741]: https://github.com/home-assistant/core/pull/92741
|
||||||
|
[#92744]: https://github.com/home-assistant/core/pull/92744
|
||||||
|
[#92748]: https://github.com/home-assistant/core/pull/92748
|
||||||
|
[#92759]: https://github.com/home-assistant/core/pull/92759
|
||||||
|
[#92780]: https://github.com/home-assistant/core/pull/92780
|
||||||
|
[#92785]: https://github.com/home-assistant/core/pull/92785
|
||||||
|
[#92796]: https://github.com/home-assistant/core/pull/92796
|
||||||
|
[#92812]: https://github.com/home-assistant/core/pull/92812
|
||||||
|
[#92825]: https://github.com/home-assistant/core/pull/92825
|
||||||
|
[#92834]: https://github.com/home-assistant/core/pull/92834
|
||||||
|
[#92862]: https://github.com/home-assistant/core/pull/92862
|
||||||
|
[#92870]: https://github.com/home-assistant/core/pull/92870
|
||||||
|
[#92878]: https://github.com/home-assistant/core/pull/92878
|
||||||
|
[#92879]: https://github.com/home-assistant/core/pull/92879
|
||||||
|
[#92893]: https://github.com/home-assistant/core/pull/92893
|
||||||
|
[#92901]: https://github.com/home-assistant/core/pull/92901
|
||||||
|
[#92907]: https://github.com/home-assistant/core/pull/92907
|
||||||
|
[#92913]: https://github.com/home-assistant/core/pull/92913
|
||||||
|
[#92919]: https://github.com/home-assistant/core/pull/92919
|
||||||
|
[#92933]: https://github.com/home-assistant/core/pull/92933
|
||||||
|
[#92957]: https://github.com/home-assistant/core/pull/92957
|
||||||
|
[#92979]: https://github.com/home-assistant/core/pull/92979
|
||||||
|
[#92999]: https://github.com/home-assistant/core/pull/92999
|
||||||
|
[#93013]: https://github.com/home-assistant/core/pull/93013
|
||||||
|
[#93037]: https://github.com/home-assistant/core/pull/93037
|
||||||
|
[#93039]: https://github.com/home-assistant/core/pull/93039
|
||||||
|
[@Lash-L]: https://github.com/Lash-L
|
||||||
|
[@Noltari]: https://github.com/Noltari
|
||||||
|
[@bachya]: https://github.com/bachya
|
||||||
|
[@balloob]: https://github.com/balloob
|
||||||
|
[@bdr99]: https://github.com/bdr99
|
||||||
|
[@bdraco]: https://github.com/bdraco
|
||||||
|
[@decompil3d]: https://github.com/decompil3d
|
||||||
|
[@dgomes]: https://github.com/dgomes
|
||||||
|
[@eavanvalkenburg]: https://github.com/eavanvalkenburg
|
||||||
|
[@emontnemery]: https://github.com/emontnemery
|
||||||
|
[@frenck]: https://github.com/frenck
|
||||||
|
[@gjohansson-ST]: https://github.com/gjohansson-ST
|
||||||
|
[@gwww]: https://github.com/gwww
|
||||||
|
[@iMicknl]: https://github.com/iMicknl
|
||||||
|
[@jjlawren]: https://github.com/jjlawren
|
||||||
|
[@joostlek]: https://github.com/joostlek
|
||||||
|
[@karwosts]: https://github.com/karwosts
|
||||||
|
[@kbickar]: https://github.com/kbickar
|
||||||
|
[@mib1185]: https://github.com/mib1185
|
||||||
|
[@puddly]: https://github.com/puddly
|
||||||
|
[@rikroe]: https://github.com/rikroe
|
||||||
|
[@starkillerOG]: https://github.com/starkillerOG
|
||||||
|
[@synesthesiam]: https://github.com/synesthesiam
|
||||||
|
[@thecode]: https://github.com/thecode
|
||||||
|
[@tkdrob]: https://github.com/tkdrob
|
||||||
|
[accuweather docs]: /integrations/accuweather/
|
||||||
|
[advantage_air docs]: /integrations/advantage_air/
|
||||||
|
[airzone docs]: /integrations/airzone/
|
||||||
|
[alexa docs]: /integrations/alexa/
|
||||||
|
[bluetooth docs]: /integrations/bluetooth/
|
||||||
|
[bmw_connected_drive docs]: /integrations/bmw_connected_drive/
|
||||||
|
[cloud docs]: /integrations/cloud/
|
||||||
|
[esphome docs]: /integrations/esphome/
|
||||||
|
[fritz docs]: /integrations/fritz/
|
||||||
|
[frontend docs]: /integrations/frontend/
|
||||||
|
[integration docs]: /integrations/integration/
|
||||||
|
[lifx docs]: /integrations/lifx/
|
||||||
|
[mazda docs]: /integrations/mazda/
|
||||||
|
[netgear_lte docs]: /integrations/netgear_lte/
|
||||||
|
[notion docs]: /integrations/notion/
|
||||||
|
[onvif docs]: /integrations/onvif/
|
||||||
|
[overkiz docs]: /integrations/overkiz/
|
||||||
|
[rdw docs]: /integrations/rdw/
|
||||||
|
[reolink docs]: /integrations/reolink/
|
||||||
|
[roborock docs]: /integrations/roborock/
|
||||||
|
[sia docs]: /integrations/sia/
|
||||||
|
[sleepiq docs]: /integrations/sleepiq/
|
||||||
|
[sonos docs]: /integrations/sonos/
|
||||||
|
[synology_dsm docs]: /integrations/synology_dsm/
|
||||||
|
[upb docs]: /integrations/upb/
|
||||||
|
[volvooncall docs]: /integrations/volvooncall/
|
||||||
|
[webostv docs]: /integrations/webostv/
|
||||||
|
[workday docs]: /integrations/workday/
|
||||||
|
[zha docs]: /integrations/zha/
|
||||||
|
[zwave_js docs]: /integrations/zwave_js/
|
||||||
|
|
||||||
## Need help? Join the community!
|
## Need help? Join the community!
|
||||||
|
|
||||||
Home Assistant has a great community of users who are all more than willing
|
Home Assistant has a great community of users who are all more than willing
|
||||||
|
BIN
source/images/installation/rpi-ha.gif
Normal file
After Width: | Height: | Size: 625 KiB |
Before Width: | Height: | Size: 79 KiB After Width: | Height: | Size: 220 KiB |
BIN
source/images/integrations/slack/bot-token-scopes.png
Normal file
After Width: | Height: | Size: 150 KiB |
BIN
source/images/integrations/slack/oauth-tokens-for-workspace.png
Normal file
After Width: | Height: | Size: 187 KiB |
BIN
source/images/integrations/slack/slack-integration-setup.png
Normal file
After Width: | Height: | Size: 93 KiB |
BIN
source/images/integrations/slack/slack-message.png
Normal file
After Width: | Height: | Size: 40 KiB |
BIN
source/images/screenshots/discord-bot-permissions.png
Normal file
After Width: | Height: | Size: 133 KiB |
@ -22,7 +22,7 @@ We will need a few things to get started with installing Home Assistant. Links b
|
|||||||
|
|
||||||
- [Raspberry Pi 4](https://amzn.to/2S0Gcl1) (Raspberry Pi 3 is ok too, if you have one laying around). Raspberry Pi are currently hard to come by, use [RPilocator](https://rpilocator.com/?cat=PI4) to find official distributors with stock.
|
- [Raspberry Pi 4](https://amzn.to/2S0Gcl1) (Raspberry Pi 3 is ok too, if you have one laying around). Raspberry Pi are currently hard to come by, use [RPilocator](https://rpilocator.com/?cat=PI4) to find official distributors with stock.
|
||||||
- [Power Supply for Raspberry Pi 4](https://amzn.to/2ReZ2Vq) or [Power Supply for Raspberry Pi 3](https://amzn.to/2R8yG7h)
|
- [Power Supply for Raspberry Pi 4](https://amzn.to/2ReZ2Vq) or [Power Supply for Raspberry Pi 3](https://amzn.to/2R8yG7h)
|
||||||
- [Micro SD Card](https://amzn.to/2X0Z2di). Ideally get one that is [Application Class 2](https://www.sdcard.org/developers/overview/application/index.html) as they handle small I/O much more consistently than cards not optimized to host applications. A 32 GB or bigger card is recommended.
|
- [Micro SD Card](https://amzn.to/2X0Z2di). Ideally get one that is [Application Class 2](https://www.sdcard.org/developers/overview/application/index.html) as they handle small I/O much more consistently than cards not optimized to host applications. A 32 GB or bigger card is recommended.
|
||||||
- SD Card reader. This is already part of most laptops, but you can purchase a [standalone USB adapter](https://amzn.to/2WWxntY) if you don't have one. The brand doesn't matter, just pick the cheapest.
|
- SD Card reader. This is already part of most laptops, but you can purchase a [standalone USB adapter](https://amzn.to/2WWxntY) if you don't have one. The brand doesn't matter, just pick the cheapest.
|
||||||
- [Ethernet cable](https://amzn.com/dp/B00N2VISLW). Required for installation. After installation, Home Assistant can work with Wi-Fi, but an Ethernet connection is more reliable and highly recommended.
|
- [Ethernet cable](https://amzn.com/dp/B00N2VISLW). Required for installation. After installation, Home Assistant can work with Wi-Fi, but an Ethernet connection is more reliable and highly recommended.
|
||||||
|
|
||||||
@ -34,15 +34,15 @@ If Raspberry Pi Imager is not supported by your platform, you can use [Balena Et
|
|||||||
|
|
||||||
### Write the image to your SD card
|
### Write the image to your SD card
|
||||||
|
|
||||||
1. Install the Raspberry Pi Imager on your computer as described under [https://www.raspberrypi.com/software/](https://www.raspberrypi.com/software/).
|
1. Download and install the Raspberry Pi Imager on your computer as described under [https://www.raspberrypi.com/software/](https://www.raspberrypi.com/software/).
|
||||||

|

|
||||||
1. Open the Raspberry Pi Imager.
|
1. Open the Raspberry Pi Imager.
|
||||||

|

|
||||||
1. Choose the operating system:
|
1. Choose the operating system:
|
||||||

|
|
||||||
1. Select **Choose OS**.
|
1. Select **Choose OS**.
|
||||||
1. Select **Home assistants and home automation**.
|
1. Select **Other specific-purpose OS** > **Home assistants and home automation** > **Home Assistant**.
|
||||||
1. Choose the Home Assistant OS that matches your hardware (RPi 3 or RPi 4).
|
1. Choose the Home Assistant OS that matches your hardware (RPi 3 or RPi 4).
|
||||||
|

|
||||||
1. Choose the storage:
|
1. Choose the storage:
|
||||||
1. Insert the SD card into the computer. Note: the contents of the card will be overwritten.
|
1. Insert the SD card into the computer. Note: the contents of the card will be overwritten.
|
||||||
1. Select your SD card.
|
1. Select your SD card.
|
||||||
|
@ -29,6 +29,7 @@ Before you can use this device with Home Assistant, you need to install a bit of
|
|||||||
|
|
||||||
<script type="module" src="https://unpkg.com/esp-web-tools@9/dist/web/install-button.js?module"></script>
|
<script type="module" src="https://unpkg.com/esp-web-tools@9/dist/web/install-button.js?module"></script>
|
||||||
<esp-web-install-button manifest="https://firmware.esphome.io/voice-assistant/m5stack-atom-echo/manifest.json"></esp-web-install-button>
|
<esp-web-install-button manifest="https://firmware.esphome.io/voice-assistant/m5stack-atom-echo/manifest.json"></esp-web-install-button>
|
||||||
|
* **For advanced users**: The configuration file is available on [GitHub](https://github.com/esphome/media-players/blob/main/m5stack-atom-echo.yaml).
|
||||||
|
|
||||||
1. Connect the ATOM Echo to your computer.
|
1. Connect the ATOM Echo to your computer.
|
||||||
* In the popup window, view the available ports.
|
* In the popup window, view the available ports.
|
||||||
@ -45,19 +46,19 @@ Before you can use this device with Home Assistant, you need to install a bit of
|
|||||||
* When prompted, select your network from the list and enter the credentials to your 2.4 GHz Wi-Fi network.
|
* When prompted, select your network from the list and enter the credentials to your 2.4 GHz Wi-Fi network.
|
||||||
* Select **Connect**.
|
* Select **Connect**.
|
||||||
* The ATOM Echo now joined your network. Select **Add to Home Assistant**.
|
* The ATOM Echo now joined your network. Select **Add to Home Assistant**.
|
||||||
4. This opens the **My** link to Home Assistant.
|
1. This opens the **My** link to Home Assistant.
|
||||||
* If you have not used My Home Assistant before, you will need to configure it. If your Home Assistant URL is not accessible on `http://homeassistant.local:8123`, replace it with the URL to your Home Assistant instance.
|
* If you have not used My Home Assistant before, you will need to configure it. If your Home Assistant URL is not accessible on `http://homeassistant.local:8123`, replace it with the URL to your Home Assistant instance.
|
||||||
* Open the link.
|
* Open the link.
|
||||||

|

|
||||||
5. Select **OK**.
|
1. Select **OK**.
|
||||||
|
|
||||||

|

|
||||||
6. To add the newly discovered device, select the ATOM Echo from the list.
|
1. To add the newly discovered device, select the ATOM Echo from the list.
|
||||||
* Add your ATOM Echo to a room and select **Finish**.
|
* Add your ATOM Echo to a room and select **Finish**.
|
||||||
7. You should now see a new **M5Stack Atom Echo** integration.
|
1. You should now see a new **M5Stack Atom Echo** integration.
|
||||||

|

|
||||||
* Your ATOM Echo is connected to Home Assistant over Wi-Fi. You can now move it to any place in your home with a USB power supply.
|
* Your ATOM Echo is connected to Home Assistant over Wi-Fi. You can now move it to any place in your home with a USB power supply.
|
||||||
8. Congratulations! You can now voice control Home Assistant using a button with build-in microphone. Now give some commands.
|
1. Congratulations! You can now voice control Home Assistant using a button with build-in microphone. Now give some commands.
|
||||||
|
|
||||||
## Controlling Home Assistant over the ATOM Echo
|
## Controlling Home Assistant over the ATOM Echo
|
||||||
|
|
||||||
|