mirror of
https://github.com/home-assistant/home-assistant.io.git
synced 2025-07-23 17:27:19 +00:00
Merge branch 'current' into next
This commit is contained in:
Franck Nijhof
commit
61461ee4af
4
.github/workflows/test.yml
vendored
4
.github/workflows/test.yml
vendored
@ -8,7 +8,7 @@ jobs:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- name: Check out files from GitHub
|
||||
uses: actions/checkout@v4.1.0
|
||||
uses: actions/checkout@v4.1.1
|
||||
- name: Setting up Node.js
|
||||
uses: actions/setup-node@v3.8.1
|
||||
with:
|
||||
@ -25,7 +25,7 @@ jobs:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- name: Check out files from GitHub
|
||||
uses: actions/checkout@v4.1.0
|
||||
uses: actions/checkout@v4.1.1
|
||||
- name: Setting up Node.js
|
||||
uses: actions/setup-node@v3.8.1
|
||||
with:
|
||||
|
||||
@ -429,7 +429,6 @@ source/_integrations/martec.markdown @starkillerOG
|
||||
source/_integrations/mastodon.markdown @fabaff
|
||||
source/_integrations/matrix.markdown @PaarthShah
|
||||
source/_integrations/matter.markdown @home-assistant/matter
|
||||
source/_integrations/mazda.markdown @bdr99
|
||||
source/_integrations/meater.markdown @Sotolotl @emontnemery
|
||||
source/_integrations/medcom_ble.markdown @elafargue
|
||||
source/_integrations/media_extractor.markdown @joostlek
|
||||
|
||||
@ -67,7 +67,7 @@ GEM
|
||||
rb-fsevent (~> 0.10, >= 0.10.3)
|
||||
rb-inotify (~> 0.9, >= 0.9.10)
|
||||
mercenary (0.4.0)
|
||||
mini_portile2 (2.8.4)
|
||||
mini_portile2 (2.8.5)
|
||||
multi_json (1.15.0)
|
||||
mustermann (3.0.0)
|
||||
ruby2_keywords (~> 0.0.1)
|
||||
|
||||
@ -110,8 +110,8 @@ social:
|
||||
# Home Assistant release details
|
||||
current_major_version: 2023
|
||||
current_minor_version: 10
|
||||
current_patch_version: 1
|
||||
date_released: 2023-10-06
|
||||
current_patch_version: 5
|
||||
date_released: 2023-10-22
|
||||
|
||||
# Either # or the anchor link to latest release notes in the blog post.
|
||||
# Must be prefixed with a # and have double quotes around it.
|
||||
|
||||
@ -136,7 +136,7 @@ header .grid {
|
||||
background: $site-background;
|
||||
box-shadow: inset 0px 5px $navigation-color;
|
||||
color: $navigation-color;
|
||||
padding-bottom: 22px;
|
||||
padding-bottom: 32px;
|
||||
}
|
||||
|
||||
.toggle {
|
||||
|
||||
@ -239,6 +239,18 @@
|
||||
Home Assistant OS, the Home Assistant Operating System, is an embedded,
|
||||
minimalistic, operating system designed to run the Home Assistant ecosystem.
|
||||
|
||||
- term: Host
|
||||
definition: >-
|
||||
A device that can communicate with other devices on a network. During setup and configuration,
|
||||
an input requesting a **Host** typically refers to a device's network address so that
|
||||
Home Assistant can attempt to connect to it. This may be in the form of a hostname, URL,
|
||||
IP address or some other type of network identifier.
|
||||
excerpt: >-
|
||||
A device that can communicate with other devices on a network.
|
||||
link: https://en.wikipedia.org/wiki/Host_(network)
|
||||
aliases:
|
||||
- hosts
|
||||
|
||||
- term: Integration
|
||||
definition: >-
|
||||
Integrations connect and integrates Home Assistant with devices, services,
|
||||
|
||||
@ -159,8 +159,9 @@ blueprint:
|
||||
name: Motion Sensor
|
||||
selector:
|
||||
entity:
|
||||
domain: binary_sensor
|
||||
filter:
|
||||
device_class: motion
|
||||
domain: binary_sensor
|
||||
light_target:
|
||||
name: Light
|
||||
selector:
|
||||
|
||||
@ -4,4 +4,4 @@ description: "found character '\t' that cannot start any token"
|
||||
ha_category: Usage
|
||||
---
|
||||
|
||||
This error means that you used a tab, rather than two spaces. Replace the tab with spaces.
|
||||
This error means you used tabs rather than two spaces in one of your YAML configuration files. Replace the tabs with spaces.
|
||||
|
||||
@ -7,7 +7,7 @@
|
||||
<li><a href='/getting-started/'>Get started with Home Assistant</a></li>
|
||||
<li><a href='https://demo.home-assistant.io'>Try the online demo</a></li>
|
||||
<li><a href='https://building.open-home.io/#/portal'>Join our newsletter</a></li>
|
||||
<li><a href="https://twitter.com/Home_Assistant">Follow Home Assistant on Twitter</a></li>
|
||||
<li><a href="https://twitter.com/Home_Assistant">Follow Home Assistant on X</a></li>
|
||||
{% comment %}
|
||||
<li>
|
||||
Subscribe to the Home Assistant Newsletter
|
||||
|
||||
@ -74,19 +74,4 @@
|
||||
<a href="https://github.com/home-assistant/core/issues?q=is%3Aissue+is%3Aopen+label%3A%22integration%3A+{{ domain }}%22" target="_blank"><i class="icon-bug"></i> View known issues</a>
|
||||
</div>
|
||||
{%- endif -%}
|
||||
|
||||
|
||||
{%- if page.ha_category.first -%}
|
||||
<div class='section'>
|
||||
<h1 class="title delta">Categories</h1>
|
||||
<ul class='divided'>
|
||||
{%- for category in page.ha_category -%}
|
||||
<li>
|
||||
<a href='/integrations/#{{ category | slugify }}'>{{ category }}</a>
|
||||
</li>
|
||||
{%- endfor -%}
|
||||
</ul>
|
||||
</div>
|
||||
{%- endif -%}
|
||||
|
||||
</section>
|
||||
|
||||
@ -28,7 +28,8 @@
|
||||
<h1 class="title delta">Projects</h1>
|
||||
<ul class="divided sidebar-menu">
|
||||
<li>{% active_link /voice_control/worlds-most-private-voice-assistant/ Tutorial: World's most private voice assistant %}</li>
|
||||
<li>{% active_link /voice_control/thirteen-usd-voice-remote/ Tutorial: $13 voice remote %}</li>
|
||||
<li>{% active_link /voice_control/thirteen-usd-voice-remote/ Tutorial: $13 voice assistant %}</li>
|
||||
<li>{% active_link /voice_control/create_wake_word/ Tutorial: Create your own wake word %}</li>
|
||||
<li>{% active_link /voice_control/assist_daily_summary/ Tutorial: Your daily summary by Assist %}</li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
@ -33,7 +33,7 @@ sudo apt-get upgrade -y
|
||||
Install the dependencies:
|
||||
|
||||
```bash
|
||||
sudo apt-get install -y python3 python3-dev python3-venv python3-pip bluez libffi-dev libssl-dev libjpeg-dev zlib1g-dev autoconf build-essential libopenjp2-7 libtiff5 libturbojpeg0-dev tzdata ffmpeg liblapack3 liblapack-dev libatlas-base-dev
|
||||
sudo apt-get install -y python3 python3-dev python3-venv python3-pip bluez libffi-dev libssl-dev libjpeg-dev zlib1g-dev autoconf build-essential libopenjp2-7 libtiff6 libturbojpeg0-dev tzdata ffmpeg liblapack3 liblapack-dev libatlas-base-dev
|
||||
```
|
||||
|
||||
The above-listed dependencies might differ or missing, depending on your system or personal use of Home Assistant.
|
||||
|
||||
@ -40,7 +40,7 @@
|
||||
<a href="/dashboards/">Dashboards</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="/voice_control/">Voice control</a>
|
||||
<a href="/voice_control/">Voice assistant</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
|
||||
@ -47,6 +47,21 @@
|
||||
</section>
|
||||
{%- endunless -%}
|
||||
{% endif %}
|
||||
|
||||
{%- if page.ha_category.first -%}
|
||||
<section class="aside-module grid__item one-whole lap-one-half">
|
||||
<div class='section'>
|
||||
<h1 class="title delta">Categories</h1>
|
||||
<ul class='divided'>
|
||||
{%- for category in page.ha_category -%}
|
||||
<li>
|
||||
<a href='/integrations/#{{ category | slugify }}'>{{ category }}</a>
|
||||
</li>
|
||||
{%- endfor -%}
|
||||
</ul>
|
||||
</div>
|
||||
</section>
|
||||
{%- endif -%}
|
||||
</div>
|
||||
<script type="text/javascript">
|
||||
// Some sidebars are longer than the screen so they can't be locked.
|
||||
|
||||
@ -18,7 +18,7 @@ Amazon Alexa provides a Smart Home API for richer home automation control withou
|
||||
|
||||
It takes considerable effort to configure. Your Home Assistant instance must be accessible from the Internet, and you need to create an Amazon Developer account and an Amazon Web Services (AWS) account. An easier solution is to use [Home Assistant Cloud](/integrations/cloud/).
|
||||
|
||||
The [Emulated Hue integration](/integrations/emulated-hue) provides a simpler alternative to use utterances such as _"Alexa, turn on the kitchen light"_. However, it has some limitations since everything looks like a light bulb.
|
||||
The [Emulated Hue integration][emulated-hue-integration] provides a simpler alternative to use utterances such as _"Alexa, turn on the kitchen light"_. However, it has some limitations since everything looks like a light bulb.
|
||||
|
||||
<div class='note'>
|
||||
|
||||
@ -241,16 +241,16 @@ Alexa needs to link your Amazon account to your Home Assistant account. Therefor
|
||||
Note: you must use a valid/trusted SSL certificate for account linking to work. Self signed certificates will not work, but you can use a free Let's Encrypt certificate.
|
||||
</div>
|
||||
|
||||
- `Client ID`:
|
||||
- `Client ID`:
|
||||
- `https://pitangui.amazon.com/` if you are in US
|
||||
- `https://layla.amazon.com/` if you are in EU
|
||||
- `https://alexa.amazon.co.jp/` if you are in JP and AU (not verified yet)
|
||||
|
||||
The trailing slash is important here.
|
||||
|
||||
- `Client Secret`: input anything you like, Home Assistant does not check this field
|
||||
- `Your Authentication Scheme`: make sure you selected *Credentials in request body*. Home Assistant does not support *HTTP Basic*.
|
||||
- `Scope`: Click `+ Add scope` and input `smart_home`, Home Assistant is not using it yet, we may use it in the future when we allow more fine-grained access control.
|
||||
- `Client Secret`: input anything you like, Home Assistant does not check this field
|
||||
- `Your Authentication Scheme`: make sure you selected *Credentials in request body*. Home Assistant does not support *HTTP Basic*.
|
||||
- `Scope`: Click `+ Add scope` and input `smart_home`, Home Assistant is not using it yet, we may use it in the future when we allow more fine-grained access control.
|
||||
- You can leave `Domain List` and `Default Access Token Expiration Time` as empty.
|
||||
|
||||
<p class='img'>
|
||||
@ -317,9 +317,9 @@ alexa:
|
||||
endpoint:
|
||||
description: >-
|
||||
To enable proactive events, you send a message to the Alexa event gateway, send it to the event endpoint that aligns with the geographic availability of your smart home skill. Following is the list of endpoints and the regions they cover. See [Proactive Events](#proactive-events) for more information.
|
||||
* North America: `https://api.amazonalexa.com/v3/events`
|
||||
* Europe: `https://api.eu.amazonalexa.com/v3/events`
|
||||
* Far East: `https://api.fe.amazonalexa.com/v3/events`
|
||||
- North America: `https://api.amazonalexa.com/v3/events`
|
||||
- Europe: `https://api.eu.amazonalexa.com/v3/events`
|
||||
- Far East: `https://api.fe.amazonalexa.com/v3/events`
|
||||
required: false
|
||||
type: string
|
||||
client_id:
|
||||
@ -412,7 +412,7 @@ See [List of Capability Interfaces and Supported Locales][alexa-supported-locale
|
||||
The `endpoint`, `client_id` and `client_secret` are optional, and are only required if you want to enable Alexa's proactive mode (i.e., "Send Alexa Events" enabled). Please note the following if you want to enable proactive mode:
|
||||
|
||||
- There are different endpoint URLs, depending on the region of your skill. Please check the available endpoints at <https://developer.amazon.com/docs/smarthome/send-events.html#endpoints>
|
||||
- The `client_id` and `client_secret` are not the ones used by the skill that have been set up using "Login with Amazon" (in the [Alexa Developer Console][amazon-dev-console]: Build > Account Linking), but rather from the "Alexa Skill Messaging" (in the Alexa Developer Console: Build > Permissions > Alexa Skill Messaging). To get them, you need to enable the "Send Alexa Events" permission.
|
||||
- The `client_id` and `client_secret` are not the ones used by the skill that have been set up using "Login with Amazon" (in the [Alexa Developer Console][alexa-dev-console]: Build > Account Linking), but rather from the "Alexa Skill Messaging" (in the Alexa Developer Console: Build > Permissions > Alexa Skill Messaging). To get them, you need to enable the "Send Alexa Events" permission.
|
||||
- If the "Send Alexa Events" permission was not enabled previously, you need to unlink and relink the skill using the Alexa App, or else Home Assistant will show the following error: "Token invalid and no refresh token available. Also, you need to restart your Home Assistant after each disabling/enabling the skill in Alexa."
|
||||
|
||||
### Configure Filter <!-- omit in toc -->
|
||||
@ -456,72 +456,59 @@ See [Alexa Display Categories][alexa-display-categories] for a complete list
|
||||
|
||||
Home Assistant supports the following integrations through Alexa using a Smart Home Skill. For Home Assistant Cloud Users, documentation can be found [here](https://www.nabucasa.com/config/amazon_alexa/).
|
||||
|
||||
The following integrations are currently supported:
|
||||
The following platforms are currently supported:
|
||||
|
||||
- [Requirements](#requirements)
|
||||
- [Create an Amazon Alexa Smart Home Skill](#create-an-amazon-alexa-smart-home-skill)
|
||||
- [Create an AWS Lambda Function](#create-an-aws-lambda-function)
|
||||
- [Create an IAM Role for Lambda](#create-an-iam-role-for-lambda)
|
||||
- [Add Code to the Lambda Function](#add-code-to-the-lambda-function)
|
||||
- [Test the Lambda Function](#test-the-lambda-function)
|
||||
- [Configure the Smart Home Service Endpoint](#configure-the-smart-home-service-endpoint)
|
||||
- [Account Linking](#account-linking)
|
||||
- [Alexa Smart Home Integration Configuration](#alexa-smart-home-integration-configuration)
|
||||
- [Supported Platforms](#supported-platforms)
|
||||
- [Alarm Control Panel](#alarm-control-panel)
|
||||
- [Alarm Control Panel](#alarm-control-panel)
|
||||
- [Arming](#arming)
|
||||
- [Disarming](#disarming)
|
||||
- [Alert, Automation, Group](#alert-automation-group)
|
||||
- [Binary Sensor](#binary-sensor)
|
||||
- [Alert, Automation, Group](#alert-automation-group)
|
||||
- [Binary Sensor](#binary-sensor)
|
||||
- [Routines](#routines)
|
||||
- [Button, Input Button](#button-input-button)
|
||||
- [Button, Input Button](#button-input-button)
|
||||
- [Routines](#routines-1)
|
||||
- [Doorbell Announcement with binary\_sensor](#doorbell-announcement-with-binary_sensor)
|
||||
- [Presence Detection with Binary Sensor](#presence-detection-with-binary-sensor)
|
||||
- [Camera](#camera)
|
||||
- [Climate](#climate)
|
||||
- [Camera](#camera)
|
||||
- [Climate](#climate)
|
||||
- [Set Thermostat Temperature](#set-thermostat-temperature)
|
||||
- [Thermostat Mode](#thermostat-mode)
|
||||
- [Cover](#cover)
|
||||
- [Cover](#cover)
|
||||
- [Open/Close/Raise/Lower](#opencloseraiselower)
|
||||
- [Set Cover Position](#set-cover-position)
|
||||
- [Set Cover Tilt](#set-cover-tilt)
|
||||
- [Garage Doors](#garage-doors)
|
||||
- [Event entities](#event-entities)
|
||||
- [Event entities](#event-entities)
|
||||
- [Doorbell Events](#doorbell-events)
|
||||
- [Fan](#fan)
|
||||
- [Fan](#fan)
|
||||
- [Fan Speed](#fan-speed)
|
||||
- [Fan Preset Mode](#fan-preset-mode)
|
||||
- [Fan Direction](#fan-direction)
|
||||
- [Fan Oscillation](#fan-oscillation)
|
||||
- [Humidifier](#humidifier)
|
||||
- [Humidifier](#humidifier)
|
||||
- [Humidifier target humidity](#humidifier-target-humidity)
|
||||
- [Humidifier Mode](#humidifier-mode)
|
||||
- [Image Processing](#image-processing)
|
||||
- [Image Processing](#image-processing)
|
||||
- [Presence Detection Notification](#presence-detection-notification)
|
||||
- [Input Number and Number](#input-number-and-number)
|
||||
- [Light](#light)
|
||||
- [Input Number and Number](#input-number-and-number)
|
||||
- [Light](#light)
|
||||
- [Brightness](#brightness)
|
||||
- [Color Temperature](#color-temperature)
|
||||
- [Color](#color)
|
||||
- [Lock](#lock)
|
||||
- [Lock](#lock)
|
||||
- [Unlocking](#unlocking)
|
||||
- [Media Player](#media-player)
|
||||
- [Media Player](#media-player)
|
||||
- [Change Channel](#change-channel)
|
||||
- [Speaker Volume](#speaker-volume)
|
||||
- [Equalizer Mode](#equalizer-mode)
|
||||
- [Inputs](#inputs)
|
||||
- [Playback State](#playback-state)
|
||||
- [Scene](#scene)
|
||||
- [Script](#script)
|
||||
- [Sensor](#sensor)
|
||||
- [Switch, Input Boolean](#switch-input-boolean)
|
||||
- [Scene](#scene)
|
||||
- [Script](#script)
|
||||
- [Sensor](#sensor)
|
||||
- [Switch, Input Boolean](#switch-input-boolean)
|
||||
- [Routines](#routines-2)
|
||||
- [Timer](#timer)
|
||||
- [Vacuum](#vacuum)
|
||||
- [Alexa Web-Based App](#alexa-web-based-app)
|
||||
- [Troubleshooting](#troubleshooting)
|
||||
- [Debugging](#debugging)
|
||||
- [Timer](#timer)
|
||||
- [Vacuum](#vacuum)
|
||||
|
||||
### Alarm Control Panel
|
||||
|
||||
|
||||
@ -18,7 +18,7 @@ This platform allows you to detect presence by looking at connected devices to a
|
||||
This is one of the routers provided by:
|
||||
|
||||
- [Ziggo](https://www.ziggo.nl/), a cable operator in the Netherlands, to their customers as the Ziggo Connectbox.
|
||||
- [Virgin Media](https://www.virginmedia.com/), a cable operator in the United Kingdom, to their customers as the Hub 3.
|
||||
- [Virgin Media](https://www.virginmedia.com/), a cable operator in the United Kingdom and Ireland, to their customers as the Hub 3.
|
||||
|
||||
<div class='note warning'>
|
||||
The router prevents the admin user from logging in twice. This can cause problems with accessing the router's configuration pages while this platform is active.
|
||||
|
||||
@ -102,7 +102,22 @@ Note that it is not necessary to provide the full device information in each mes
|
||||
- Discovery payload:
|
||||
|
||||
```json
|
||||
{"automation_type":"trigger","type":"action","subtype":"arrow_left_click","payload":"arrow_left_click","topic":"zigbee2mqtt/0x90fd9ffffedf1266/action","device":{"identifiers":["zigbee2mqtt_0x90fd9ffffedf1266"],"name":"0x90fd9ffffedf1266","sw_version":"Zigbee2MQTT 1.14.0","model":"TRADFRI remote control (E1524/E1810)","manufacturer":"IKEA"}}
|
||||
{
|
||||
"automation_type": "trigger",
|
||||
"type": "action",
|
||||
"subtype": "arrow_left_click",
|
||||
"payload": "arrow_left_click",
|
||||
"topic": "zigbee2mqtt/0x90fd9ffffedf1266/action",
|
||||
"device": {
|
||||
"identifiers": [
|
||||
"zigbee2mqtt_0x90fd9ffffedf1266"
|
||||
],
|
||||
"name": "0x90fd9ffffedf1266",
|
||||
"sw_version": "Zigbee2MQTT 1.14.0",
|
||||
"model": "TRADFRI remote control (E1524/E1810)",
|
||||
"manufacturer": "IKEA"
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
- Trigger topic: `zigbee2mqtt/0x90fd9ffffedf1266/action`
|
||||
@ -114,7 +129,18 @@ Note that it is not necessary to provide the full device information in each mes
|
||||
- Discovery payload:
|
||||
|
||||
```json
|
||||
{"automation_type":"trigger","type":"action","subtype":"arrow_right_click","payload":"arrow_right_click","topic":"zigbee2mqtt/0x90fd9ffffedf1266/action","device":{"identifiers":["zigbee2mqtt_0x90fd9ffffedf1266"]}}
|
||||
{
|
||||
"automation_type": "trigger",
|
||||
"type": "action",
|
||||
"subtype": "arrow_right_click",
|
||||
"payload": "arrow_right_click",
|
||||
"topic": "zigbee2mqtt/0x90fd9ffffedf1266/action",
|
||||
"device": {
|
||||
"identifiers": [
|
||||
"zigbee2mqtt_0x90fd9ffffedf1266"
|
||||
]
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
- Trigger topic: `zigbee2mqtt/0x90fd9ffffedf1266/action`
|
||||
|
||||
@ -553,3 +553,18 @@ Speak a word. The list of words is defined in the ElkM1 ASCII Protocol documenta
|
||||
| ---------------------- | -------- | ----------- |
|
||||
| `word` | no | Word to speak.
|
||||
| `prefix` | yes | Prefix to identify panel when multiple panels configured.
|
||||
|
||||
## Debugging
|
||||
Debug logs are often required to solve an issue. Follow the instructions on [Enabling debug logging](/docs/configuration/troubleshooting/#enabling-debug-logging).
|
||||
|
||||
Sometimes, for example, a problem can occur while starting Home Assistant. In this case, follow these instructions.
|
||||
Add the following to your `configuration.yaml` file in your Home Assistant `config` directory:
|
||||
|
||||
```yaml
|
||||
logger:
|
||||
logs:
|
||||
elkm1_lib: debug
|
||||
homeassistant.components.elkm1: debug
|
||||
```
|
||||
|
||||
After updating your configuration file, restart Home Assistant. The debug logs will be in the file `homeassistant.log` in the `config` directory.
|
||||
|
||||
@ -61,3 +61,6 @@ When the mode entity is set to standard, you can simply set the state of the rel
|
||||
|
||||
### Battery Level
|
||||
When the relay mode is set to battery level, the relays will turn on and off based on the remaining battery level of your Encharge batteries. Two number entities are available to control the cutoff and restore levels for the relays. When the battery level drops below the cutoff level, the relays will turn off. When the battery level rises above the restore level, the relays will turn back on.
|
||||
|
||||
## Polling Interval
|
||||
The default polling interval is 60 seconds. To customize the polling interval, refer to [defining a custom polling interval](/common-tasks/general/#defining-a-custom-polling-interval). Specify the envoy device as a target of the service using the `+ choose device` button. Updating the envoy will also update the related devices like the inverters; there is no need to split them into separate entities or add all inverter devices. When using multiple Envoys, add them as targets or create separate custom polling intervals as needed.
|
||||
|
||||
@ -71,7 +71,7 @@ Parameters:
|
||||
- **eventId** (*Optional*): The event the user is checking in to.
|
||||
- **shout** (*Optional*): A message about your check-in. The maximum length of this field is 140 characters.
|
||||
- **mentions** (*Optional*): Mentions in your check-in. This parameter is a semicolon-delimited list of mentions. A single mention is of the form "start,end,userid", where start is the index of the first character in the shout representing the mention, end is the index of the first character in the shout after the mention, and userid is the userid of the user being mentioned. If userid is prefixed with "fbu-", this indicates a Facebook userid that is being mention. Character indices in shouts are 0-based.
|
||||
- **broadcast** (*Optional*): "Who to broadcast this check-in to. Accepts a comma-delimited list of values: private (off the grid) or public (share with friends), Facebook share on Facebook, Twitter share on Twitter, followers share with followers (celebrity mode users only), If no valid value is found, the default is public."
|
||||
- **broadcast** (*Optional*): "Who to broadcast this check-in to. Accepts a comma-delimited list of values: private (off the grid) or public (share with friends), Facebook share on Facebook, X share on X, followers share with followers (celebrity mode users only), If no valid value is found, the default is public."
|
||||
- **ll** (*Optional*): Latitude and longitude of the user's location. Only specify this field if you have a GPS or other device reported location for the user at the time of check-in.
|
||||
- **llAcc** (*Optional*): Accuracy of the user's latitude and longitude, in meters.
|
||||
- **alt** (*Optional*): Altitude of the user's location, in meters.
|
||||
|
||||
@ -14,15 +14,13 @@ ha_platforms:
|
||||
ha_integration_type: integration
|
||||
---
|
||||
|
||||
The `here_travel_time` sensor provides travel time from the [HERE Routing API](https://developer.here.com/documentation/routing-api/dev_guide/index.html).
|
||||
The `here_travel_time` sensor provides travel time from the [HERE Routing API](https://www.here.com/docs/bundle/routing-api-developer-guide-v8/page/README.html).
|
||||
|
||||
## Setup
|
||||
|
||||
You need to register for an API key (REST & XYZ HUB API/CLI) by following the instructions [here](https://developer.here.com/tutorials/getting-here-credentials/).
|
||||
You need to register for an API key by following the instructions in the [API Developer Guide](https://www.here.com/docs/bundle/routing-api-developer-guide-v8/page/topics/send-request.html).
|
||||
|
||||
HERE offers a Freemium Plan which includes 250,000 free Transactions per month. For the Routing API, one transaction equals one request with one starting point (no multi stop). If you are not [updating sensors on demand](#updating-sensors-on-demand-using-automation) you can track 28 routes without exceeding the limit. More information can be found [here](https://knowledge.here.com/csm_kb?id=public_kb_csm_details&number=KB0016433)
|
||||
|
||||
By default HERE will deactivate your account if you exceed the free Transaction limit for the month. You can add payment details to re-enable your account as described [here](https://knowledge.here.com/csm_kb?id=public_kb_csm_details&number=KB0016434)
|
||||
HERE offers a Limited Plan which includes 1000 free transactions per day. If you are not [updating sensors on demand](#updating-sensors-on-demand-using-automation), you can track 3 routes without exceeding the limit. You can provide payment details to increase this to 5000 free transactions per day. More information can be found [on the pricing page](https://www.here.com/get-started/pricing)
|
||||
|
||||
{% include integrations/config_flow.md %}
|
||||
|
||||
|
||||
@ -128,6 +128,20 @@ The following sensors are available in the library:
|
||||
Setting values change less often, therefore these sensors are only polled every 5 minutes.
|
||||
</div>
|
||||
|
||||
#### Battery Strategy
|
||||
|
||||
This sensor is on by default, which maps to the "Automatically" mode in the Kostal Plenticore Plus documentation. This mode is recommended for regions with little snowfall.
|
||||
|
||||
Turning this sensor off maps to the "Automatically economical" mode. Consequently, the inverter controls the battery charging automatically but switches the battery off when there is insufficient PV energy to charge the battery for longer periods. This mode is recommended for regions with a lot of snowfall.
|
||||
|
||||
#### Battery Smart Control
|
||||
|
||||
The Battery Smart Control sensor appears as a select field labeled "Battery Charging / Usage Mode" with three options:
|
||||
|
||||
- **None**: the battery is loaded immediately when there is PV energy spare.
|
||||
- **Battery:SmartBatteryControl:Enable**: the battery loading optimizes grid feed-in and battery loading. This setting is recommended when the grid feed-in is limited to, for example, 70% of the Plenticore Plus peak power.
|
||||
- **Battery:TimeControl:Enable**: battery charging/discharging can be configured flexibly at different times (tariff periods). Detailed settings must be done on the web frontend of the Kostal Plenticore Plus inverter. This option activates the time-controlled battery usage mode.
|
||||
|
||||
## Number
|
||||
|
||||
The following Number entities are available. The values could also be change from Home Assistant.
|
||||
|
||||
@ -1,120 +0,0 @@
|
||||
---
|
||||
title: Mazda Connected Services
|
||||
description: Instructions on how to integrate your Connected Services capable Mazda vehicle with Home Assistant.
|
||||
ha_release: '2021.3'
|
||||
ha_category:
|
||||
- Binary Sensor
|
||||
- Button
|
||||
- Car
|
||||
- Climate
|
||||
- Lock
|
||||
- Presence Detection
|
||||
- Sensor
|
||||
- Switch
|
||||
ha_iot_class: Cloud Polling
|
||||
ha_quality_scale: platinum
|
||||
ha_config_flow: true
|
||||
ha_codeowners:
|
||||
- '@bdr99'
|
||||
ha_domain: mazda
|
||||
ha_platforms:
|
||||
- binary_sensor
|
||||
- button
|
||||
- climate
|
||||
- device_tracker
|
||||
- diagnostics
|
||||
- lock
|
||||
- sensor
|
||||
- switch
|
||||
ha_integration_type: integration
|
||||
---
|
||||
|
||||
The Mazda Connected Services integration allows you to control and retrieve data from a Mazda vehicle. In order to use this integration, you must first register your vehicle using the MyMazda app ([iOS](https://apps.apple.com/app/mymazda/id451886367)/[Android](https://play.google.com/store/apps/details?id=com.interrait.mymazda)).
|
||||
|
||||
This integration requires an active Mazda Connected Services subscription and a compatible vehicle. The following Mazda vehicles are Mazda Connected Services capable:
|
||||
|
||||
- CX-30: 2020+
|
||||
- CX-5: 2021+
|
||||
- CX-50: 2023+
|
||||
- CX-60: 2022+
|
||||
- CX-9: 2021+
|
||||
- Mazda3: 2019+
|
||||
- MX-30: 2020+
|
||||
|
||||
{% include integrations/config_flow.md %}
|
||||
|
||||
<div class='note warning'>
|
||||
The MyMazda API only allows one active session at a time. Therefore, if you use the same account with both Home Assistant and the MyMazda mobile app, you may experience issues ("Multiple devices detected" notifications, session expired warnings, etc.) To fix this, you can create a secondary MyMazda account, and share your vehicle with the secondary account. Log in to the mobile app using the primary account and select Menu > MyMazda > My Vehicle > Drivers > Manage Drivers > Invite Driver. When finished, log into the secondary account with Home Assistant.
|
||||
</div>
|
||||
|
||||
## Platforms
|
||||
|
||||
### Button
|
||||
|
||||
Button entities are available to perform the following actions:
|
||||
|
||||
- Start engine (engine can only be started 2 consecutive times; to reset this counter, the vehicle must be driven)
|
||||
- Stop engine (only works if the engine was started remotely)
|
||||
- Turn on hazard lights (lights will flash briefly and then turn off)
|
||||
- Turn off hazard lights (if they have been manually turned on from inside the vehicle - lights will turn back on if a door is opened)
|
||||
|
||||
Additionally, the following button entity is available for electric vehicles:
|
||||
|
||||
- Refresh vehicle status (only refreshes electric vehicle-related information)
|
||||
|
||||
### Sensor
|
||||
|
||||
The following sensor entities are available:
|
||||
- Fuel remaining (only for gas vehicles)
|
||||
- Fuel distance remaining (only for gas vehicles)
|
||||
- Odometer
|
||||
- Tire pressure (not available for CX-5 and CX-9 models)
|
||||
- Charge level (only for electric vehicles)
|
||||
- Remaining range (only for electric vehicles)
|
||||
|
||||
### Binary sensor
|
||||
|
||||
The following binary sensor entities are available:
|
||||
- Doors (open/closed, individual entities for each door)
|
||||
- Trunk (open/closed)
|
||||
- Hood (open/closed)
|
||||
- Plugged in (plugged in/unplugged, only for electric vehicles)
|
||||
|
||||
### Device tracker
|
||||
|
||||
Tracks the current location of the vehicle. This will generally update when the vehicle is switched off.
|
||||
|
||||
### Lock
|
||||
|
||||
Displays the current door lock status of the vehicle, and locks/unlocks the doors of the vehicle.
|
||||
|
||||
<div class='note info'>
|
||||
The "Automatic Re-Lock" feature will automatically re-lock the doors if they are not opened shortly after being unlocked. This applies regardless of whether you are using the key, or unlocking the doors remotely using Home Assistant or the MyMazda app.
|
||||
</div>
|
||||
|
||||
### Switch
|
||||
|
||||
For electric vehicles, a "charging" switch entity will be created, which allows viewing and controlling the charging state of the vehicle battery.
|
||||
|
||||
### Climate
|
||||
|
||||
For electric vehicles, a climate entity will be created that allows controlling the vehicle's HVAC system. This includes turning the HVAC system on and off, setting a target temperature, and turning the front and rear defrosters on and off.
|
||||
|
||||
## Services
|
||||
|
||||
This integration provides a single service:
|
||||
|
||||
### Service `mazda.send_poi`
|
||||
|
||||
Send a GPS location to the vehicle's navigation system as a POI (Point of Interest). Requires a navigation SD card installed in the vehicle.
|
||||
|
||||
| Service Data Attribute | Required | Description |
|
||||
| ---------------------- | -------- | ----------- |
|
||||
| `device_id` | yes | The device ID of the vehicle to send the GPS location to |
|
||||
| `latitude` | yes | The latitude of the location to send. |
|
||||
| `longitude` | yes | The longitude of the location to send. |
|
||||
| `poi_name` | yes | A friendly name for the location. |
|
||||
|
||||
## Disclaimer
|
||||
|
||||
This integration is not affiliated with or endorsed by Mazda.
|
||||
@ -1,6 +1,6 @@
|
||||
---
|
||||
title: motionEye
|
||||
description: Instructions on how to integrate MotionEye into Home Assistant.
|
||||
description: Instructions on how to integrate motionEye into Home Assistant.
|
||||
ha_category:
|
||||
- Camera
|
||||
- Media Source
|
||||
@ -54,7 +54,7 @@ Configure motionEye webhooks to report events to Home Assistant:
|
||||
description: Whether or not motionEye webhooks should be configured to callback into Home Assistant. If this option is disabled, no motion detected or file stored events will be generated unless the webhooks are manually configured.
|
||||
Overwrite unrecognized webhooks:
|
||||
description: Whether or not to overwrite webhooks that are already configured and are not recognized as belonging to this integration (webhooks are deemed to belong to this integration if they contain `src=hass-motioneye` in the query string).
|
||||
Steam URL template:
|
||||
Stream URL template:
|
||||
description: A [jinja2](https://jinja.palletsprojects.com/) template that is used to override the standard MJPEG stream URL (e.g. for use with reverse proxies). See [Camera MJPEG Streams](#streams) below. This option is only shown to users who have [advanced mode](https://www.home-assistant.io/blog/2019/07/17/release-96/#advanced-mode) enabled.
|
||||
{% endconfiguration_basic %}
|
||||
|
||||
@ -89,7 +89,7 @@ Example:
|
||||
|
||||
##### Stream URL Template
|
||||
|
||||
For advanced usecases, this behavior can be changed with the [Steam URL
|
||||
For advanced usecases, this behavior can be changed with the [Stream URL
|
||||
template](#options) option. When set, this string will override the default
|
||||
stream address that is derived from the default behavior described above. This
|
||||
option supports [jinja2 templates](https://jinja.palletsprojects.com/) and has
|
||||
@ -241,7 +241,7 @@ Note: This is a thin wrapper on the [`motioneye.action` call](#action).
|
||||
|
||||
### motioneye.action
|
||||
|
||||
Trigger a motionEye action (see [MotionEye Action Buttons](https://github.com/ccrisan/motioneye/wiki/Action-Buttons)).
|
||||
Trigger a motionEye action (see [motionEye Action Buttons](https://github.com/ccrisan/motioneye/wiki/Action-Buttons)).
|
||||
|
||||
Parameters:
|
||||
|
||||
|
||||
@ -48,7 +48,7 @@ MQTT (aka MQ Telemetry Transport) is a machine-to-machine or "Internet of Things
|
||||
|
||||
Your first step to get MQTT and Home Assistant working is to choose a broker.
|
||||
|
||||
## Choose a MQTT broker
|
||||
## Choose an MQTT broker
|
||||
|
||||
### Run your own
|
||||
|
||||
@ -202,7 +202,7 @@ For every configured MQTT entity Home Assistant automatically assigns a unique `
|
||||
If the `object_id` option is set, then this will be used to generate the `entity_id`.
|
||||
If, for example, we have configured a `sensor`, and we have set `object_id` to `test`, then Home Assistant will try to assign `sensor.test` as `entity_id`, but if this `entity_id` already exits it will append it with a suffix to make it unique, for example, `sensor.test_2`.
|
||||
|
||||
This means any MQTT entity which is part of a device will [automatically have it's `friendly_name` attribute prefixed with the device name](https://developers.home-assistant.io/docs/core/entity/#has_entity_name-true-mandatory-for-new-integrations)
|
||||
This means any MQTT entity which is part of a device will [automatically have its `friendly_name` attribute prefixed with the device name](https://developers.home-assistant.io/docs/core/entity/#has_entity_name-true-mandatory-for-new-integrations)
|
||||
|
||||
Unnamed `binary_sensor`, `button`, `number` and `sensor` entities will now be named by their device class instead of being named "MQTT binary sensor" etc.
|
||||
It's allowed to set an MQTT entity's name to `None` (use `null` in YAML) to mark it as the main feature of a device.
|
||||
@ -277,7 +277,7 @@ In the value of configuration variables ending with `_topic`, `~` will be replac
|
||||
|
||||
Configuration variable names in the discovery payload may be abbreviated to conserve memory when sending a discovery message from memory constrained devices.
|
||||
|
||||
It is encouraged to add additional information about the origin that supplies MQTT entities via MQTT discovery by adding the `origin` option (can abbreviated to `o`) to the discovery payload. Note that these options also support abbreviations. Information of the origin will be logged to the core event log when an item is discovered or updated.
|
||||
It is encouraged to add additional information about the origin that supplies MQTT entities via MQTT discovery by adding the `origin` option (can be abbreviated to `o`) to the discovery payload. Note that these options also support abbreviations. Information of the origin will be logged to the core event log when an item is discovered or updated.
|
||||
|
||||
{% configuration_basic %}
|
||||
name:
|
||||
@ -619,12 +619,40 @@ A motion detection device which can be represented by a [binary sensor](/integra
|
||||
|
||||
- Configuration topic: `homeassistant/binary_sensor/garden/config`
|
||||
- State topic: `homeassistant/binary_sensor/garden/state`
|
||||
- Configuration payload with derived device name: `{"name": null, "device_class": "motion", "state_topic": "homeassistant/binary_sensor/garden/state", "unique_id": "motion01ad", "device": {"identifiers": ["01ad"], "name": "Garden" }}`
|
||||
- Configuration payload with derived device name:
|
||||
```json
|
||||
{
|
||||
"name":null,
|
||||
"device_class":"motion",
|
||||
"state_topic":"homeassistant/binary_sensor/garden/state",
|
||||
"unique_id":"motion01ad",
|
||||
"device":{
|
||||
"identifiers":[
|
||||
"01ad"
|
||||
],
|
||||
"name":"Garden"
|
||||
}
|
||||
}
|
||||
```
|
||||
- Retain: The -r switch is added to retain the configuration topic in the broker. Without this, the sensor will not be available after Home Assistant restarts.
|
||||
|
||||
It is also a good idea to add a `unique_id` to allow changes to the entity and a `device` mapping so we can group all sensors of a device together. We can set "name" to `null` if we want to inherit the device name for the entity. If we set an entity name, the `friendly_name` will be a combination of the device and entity name. If `name` is left away and a `device_class` is set, the entity name part will be derived from the `device_class`.
|
||||
|
||||
- Example configuration payload with no name set and derived `device_class` name: `{"device_class": "motion", "state_topic": "homeassistant/binary_sensor/garden/state", "unique_id": "motion01ad", "device": {"identifiers": ["01ad"], "name": "Garden" }}`
|
||||
- Example configuration payload with no name set and derived `device_class` name:
|
||||
```json
|
||||
{
|
||||
"name":null,
|
||||
"device_class":"motion",
|
||||
"state_topic":"homeassistant/binary_sensor/garden/state",
|
||||
"unique_id":"motion01ad",
|
||||
"device":{
|
||||
"identifiers":[
|
||||
"01ad"
|
||||
],
|
||||
"name":"Garden"
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
If no name is set, a default name will be set by MQTT ([see the MQTT platform documentation](#mqtt-discovery)).
|
||||
|
||||
@ -653,10 +681,46 @@ For more details please refer to the [MQTT testing section](/integrations/mqtt/#
|
||||
Setting up a sensor with multiple measurement values requires multiple consecutive configuration topic submissions.
|
||||
|
||||
- Configuration topic no1: `homeassistant/sensor/sensorBedroomT/config`
|
||||
- Configuration payload no1: `{"device_class": "temperature", "state_topic": "homeassistant/sensor/sensorBedroom/state", "unit_of_measurement": "°C", "value_template": "{% raw %}{{ value_json.temperature}}{% endraw %}","unique_id": "temp01ae", "device": {"identifiers": ["bedroom01ae"], "name": "Bedroom" }}`
|
||||
- Configuration payload no1:
|
||||
```json
|
||||
{
|
||||
"device_class":"temperature",
|
||||
"state_topic":"homeassistant/sensor/sensorBedroom/state",
|
||||
"unit_of_measurement":"°C",
|
||||
"value_template":"{% raw %}{{ value_json.temperature}}{% endraw %}",
|
||||
"unique_id":"temp01ae",
|
||||
"device":{
|
||||
"identifiers":[
|
||||
"bedroom01ae"
|
||||
],
|
||||
"name":"Bedroom"
|
||||
}
|
||||
}
|
||||
```
|
||||
- Configuration topic no2: `homeassistant/sensor/sensorBedroomH/config`
|
||||
- Configuration payload no2: `{"device_class": "humidity", "state_topic": "homeassistant/sensor/sensorBedroom/state", "unit_of_measurement": "%", "value_template": "{% raw %}{{ value_json.humidity}}{% endraw %}","unique_id": "hum01ae", "device": {"identifiers": ["bedroom01ae"], "name": "Bedroom" } }`
|
||||
- Common state payload: `{ "temperature": 23.20, "humidity": 43.70 }`
|
||||
- Configuration payload no2:
|
||||
```json
|
||||
{
|
||||
"device_class":"humidity",
|
||||
"state_topic":"homeassistant/sensor/sensorBedroom/state",
|
||||
"unit_of_measurement":"%",
|
||||
"value_template":"{% raw %}{{ value_json.humidity}}{% endraw %}",
|
||||
"unique_id":"hum01ae",
|
||||
"device":{
|
||||
"identifiers":[
|
||||
"bedroom01ae"
|
||||
],
|
||||
"name":"Bedroom"
|
||||
}
|
||||
}
|
||||
```
|
||||
- Common state payload:
|
||||
```json
|
||||
{
|
||||
"temperature":23.20,
|
||||
"humidity":43.70
|
||||
}
|
||||
```
|
||||
|
||||
#### Entities with command topics
|
||||
|
||||
@ -665,7 +729,21 @@ Setting up a light, switch etc. is similar but requires a `command_topic` as men
|
||||
- Configuration topic: `homeassistant/switch/irrigation/config`
|
||||
- State topic: `homeassistant/switch/irrigation/state`
|
||||
- Command topic: `homeassistant/switch/irrigation/set`
|
||||
- Payload: `{"name": "Irrigation", "command_topic": "homeassistant/switch/irrigation/set", "state_topic": "homeassistant/switch/irrigation/state", "unique_id": "irr01ad", "device": {"identifiers": ["garden01ad"], "name": "Garden" }}`
|
||||
- Payload:
|
||||
```json
|
||||
{
|
||||
"name":"Irrigation",
|
||||
"command_topic":"homeassistant/switch/irrigation/set",
|
||||
"state_topic":"homeassistant/switch/irrigation/state",
|
||||
"unique_id":"irr01ad",
|
||||
"device":{
|
||||
"identifiers":[
|
||||
"garden01ad"
|
||||
],
|
||||
"name":"Garden"
|
||||
}
|
||||
}
|
||||
```
|
||||
- Retain: The -r switch is added to retain the configuration topic in the broker. Without this, the sensor will not be available after Home Assistant restarts.
|
||||
|
||||
```bash
|
||||
@ -686,7 +764,15 @@ Setting up a switch using topic prefix and abbreviated configuration variable na
|
||||
- Configuration topic: `homeassistant/switch/irrigation/config`
|
||||
- Command topic: `homeassistant/switch/irrigation/set`
|
||||
- State topic: `homeassistant/switch/irrigation/state`
|
||||
- Configuration payload: `{"~": "homeassistant/switch/irrigation", "name": "garden", "cmd_t": "~/set", "stat_t": "~/state"}`
|
||||
- Configuration payload:
|
||||
```json
|
||||
{
|
||||
"~":"homeassistant/switch/irrigation",
|
||||
"name":"garden",
|
||||
"cmd_t":"~/set",
|
||||
"stat_t":"~/state"
|
||||
}
|
||||
```
|
||||
|
||||
#### Another example using abbreviations topic name and base topic
|
||||
|
||||
@ -828,7 +914,12 @@ The MQTT notification support is different than for the other [notification](/in
|
||||
**Call Service** section from **Developer Tools** -> **Services** allows you to send MQTT messages. Choose *mqtt.publish* from the list of **Available services:** and enter something like the sample below into the **Service Data** field and hit **CALL SERVICE**.
|
||||
|
||||
```json
|
||||
{"payload": "Test message from HA", "topic": "home/notification", "qos": 0, "retain": 0}
|
||||
{
|
||||
"~":"homeassistant/switch/irrigation",
|
||||
"name":"garden",
|
||||
"cmd_t":"~/set",
|
||||
"stat_t":"~/state"
|
||||
}
|
||||
```
|
||||
|
||||
<p class='img'>
|
||||
|
||||
@ -16,7 +16,15 @@ ha_platforms:
|
||||
ha_integration_type: integration
|
||||
---
|
||||
|
||||
The `nissan_leaf` integration offers integration with the [NissanConnect EV](https://www.nissan.co.uk/dashboard.html) cloud service. NissanConnect EV was previously known as Nissan Carwings. It offers:
|
||||
The `nissan_leaf` integration offers integration with the [NissanConnect EV](https://www.nissan.co.uk/dashboard.html) cloud service. NissanConnect EV was previously known as Nissan Carwings.
|
||||
|
||||
<div class='note info'>
|
||||
|
||||
Please be aware that the `nissan_leaf` integration only works with Nissan vehicles from before 2019. Newer vehicles will not work with this integration.
|
||||
|
||||
</div>
|
||||
|
||||
The integration offers offers:
|
||||
|
||||
- sensors for the battery status, range and charging status.
|
||||
- a switch to start and stop the climate control.
|
||||
|
||||
@ -19,7 +19,7 @@ ha_platforms:
|
||||
ha_integration_type: integration
|
||||
---
|
||||
|
||||
The `opentherm_gw` integration is used to control the [OpenTherm Gateway](http://otgw.tclcode.com/) from Home Assistant.
|
||||
The `opentherm_gw` integration is used to control the [OpenTherm Gateway](https://otgw.tclcode.com/) from Home Assistant.
|
||||
|
||||
The following device types are currently supported within Home Assistant:
|
||||
|
||||
@ -41,7 +41,7 @@ The following configuration options are available:
|
||||
name:
|
||||
description: "The friendly name used for the OpenTherm Gateway and its entities. This is used to generate the display name of the created device and all related entities.<br/>Examples: `Thermostat`, `Living Room`"
|
||||
path or url:
|
||||
description: "Path to the OpenTherm Gateway device as supported by [PySerial](https://pythonhosted.org/pyserial/url_handlers.html). This is usually either a path to a serial device in `/dev/` if the gateway is connected via serial or USB or a URL in the form of `socket://[IP address]:[port]` if it is connected over the network.<br/>Examples: `/dev/ttyUSB0`, `socket://192.168.0.250:7686`"
|
||||
description: "Path to the OpenTherm Gateway device as supported by [PySerial](https://pythonhosted.org/pyserial/url_handlers.html). This is usually either a path to a serial device in `/dev/` if the gateway is connected via serial or USB, or a URL in the form of `socket://[IP address]:[port]` if it is connected over the network.<br/>Examples: `/dev/ttyUSB0`, `socket://192.168.0.250:7686`"
|
||||
id:
|
||||
description: "The `gateway_id` for this OpenTherm Gateway. This is used to identify this specific gateway in service calls and to generate the entity IDs for the entities related to this gateway. The entered value will be slugified, i.e. all spaces and special characters will be converted to underscores and any accents will be removed from their characters. The default value is the slugified version of the `name` given above.<br/>Examples: `thermostat`, `living_room`"
|
||||
{% endconfiguration_basic %}
|
||||
@ -51,12 +51,13 @@ Please make sure no other device or application is connected to the OpenTherm Ga
|
||||
</div>
|
||||
|
||||
<div class='note'>
|
||||
The precision and floor_temperature settings that were supported in configuration.yaml entries have been lost upon import of the configuration.yaml entry into the Integrations panel. You can now configure them as per the following Options paragraph.
|
||||
The precision and floor_temperature settings that were supported in configuration.yaml entries have been lost upon import of the `configuration.yaml` entry into the Integrations panel. You can now configure them as per the following Options paragraph.
|
||||
</div>
|
||||
|
||||
# Options
|
||||
|
||||
The OpenTherm Gateway can be further configured through the integration settings in the web interface
|
||||
The OpenTherm Gateway can be further configured through the integration settings in the web interface.
|
||||
|
||||
The following options are available:
|
||||
{% configuration_basic %}
|
||||
Read Precision:
|
||||
@ -82,8 +83,8 @@ Reset the OpenTherm Gateway.
|
||||
### Service `set_central_heating_ovrd`
|
||||
|
||||
Set the central heating override option on the gateway.
|
||||
When overriding the control setpoint (via a [set_control_setpoint](#service-opentherm_gwset_control_setpoint) service call with a temperature value other than 0), the gateway automatically enables the central heating override to start heating. This service can then be used to control the central heating override status.
|
||||
To return control of the central heating to the thermostat, call the [set_control_setpoint](#service-opentherm_gwset_control_setpoint) service with temperature value 0.
|
||||
When overriding the control setpoint (via a [set_control_setpoint](#service-opentherm_gwset_control_setpoint) service call with a temperature value other than `0`), the gateway automatically enables the central heating override to start heating. This service can then be used to control the central heating override status.
|
||||
To return control of the central heating to the thermostat, call the [set_control_setpoint](#service-opentherm_gwset_control_setpoint) service with temperature value `0`.
|
||||
**You will only need this if you are writing your own software thermostat.**
|
||||
|
||||
| Service data attribute | Optional | Description |
|
||||
@ -137,18 +138,18 @@ small amount of water preheated, this command can influence
|
||||
that.
|
||||
|
||||
| Service data attribute | Optional | Description |
|
||||
| ---------------------- | -------- | ---------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| ---------------------- | -------- | ---------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `gateway_id` | no | The `gateway_id` as specified during configuration. |
|
||||
| `dhw_override` | no | The domestic hot water override state. Value should be 0 or 1 to enable the override in off or on state, or "A" to disable the override. |
|
||||
| `dhw_override` | no | The domestic hot water override state. Value should be `0` or `1` to enable the override in off or on state, or `"A"` to disable the override. |
|
||||
|
||||
### Service `opentherm_gw.set_hot_water_setpoint`
|
||||
|
||||
Set the domestic hot water setpoint on the OpenTherm Gateway. Not all boilers support this feature.
|
||||
|
||||
| Service data attribute | Optional | Description |
|
||||
| ---------------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| ---------------------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `gateway_id` | no | The `gateway_id` as specified during configuration. |
|
||||
| `temperature` | no | The domestic hot water setpoint to set on the gateway. Values between 0 and 90 are accepted, but not all boilers support this range. Check the values of the `slave_dhw_min_setp` and `slave_dhw_max_setp` sensors to see the supported range on your boiler. |
|
||||
| `temperature` | no | The domestic hot water setpoint to set on the gateway. Values between `0` and `90` are accepted, but not all boilers support this range. Check the values of the `slave_dhw_min_setp` and `slave_dhw_max_setp` sensors to see the supported range on your boiler. |
|
||||
|
||||
### Service `opentherm_gw.set_gpio_mode`
|
||||
|
||||
@ -158,7 +159,7 @@ For an explanation of the possible modes, see [GPIO modes](#gpio-modes)
|
||||
| Service data attribute | Optional | Description |
|
||||
| ---------------------- | -------- | --------------------------------------------------- |
|
||||
| `gateway_id` | no | The `gateway_id` as specified during configuration. |
|
||||
| `id` | no | The GPIO ID, `A` or `B`. |
|
||||
| `id` | no | The GPIO ID; `A` or `B`. |
|
||||
| `mode` | no | The GPIO mode to be set. |
|
||||
|
||||
### Service `opentherm_gw.set_led_mode`
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
---
|
||||
title: Raspberry Pi Remote GPIO
|
||||
description: Instructions on how to integrate the GPIO capability of a Remote Raspberry Pi into Home Assistant.
|
||||
description: Instructions on how to integrate the GPIO capability of a remote Raspberry Pi into Home Assistant.
|
||||
ha_category:
|
||||
- Binary Sensor
|
||||
- DIY
|
||||
@ -14,19 +14,19 @@ ha_platforms:
|
||||
ha_integration_type: integration
|
||||
---
|
||||
|
||||
The `rpi_gpio` integration is the base for all related GPIO platforms in Home Assistant. For the platform configurations, please check their corresponding sections.
|
||||
The `remote_rpi_gpio` integration is the base for all related GPIO platforms in Home Assistant. For the platform configurations, please check their corresponding sections.
|
||||
|
||||
The remote Raspberry Pi and the control computer where Home Assistant is running must be prepared to run remote_rpi_gpio, see details [here](https://gpiozero.readthedocs.io/en/stable/remote_gpio.html).
|
||||
The remote Raspberry Pi, and the control computer where Home Assistant is running must be configured to be able to run `remote_rpi_gpio`, see [Configuring Remote GPIO](https://gpiozero.readthedocs.io/en/stable/remote_gpio.html) for more details.
|
||||
|
||||
Note that for virtual environments you may need to set an environment variable when starting the environment to set the pin factory, example:
|
||||
Note that for virtual environments, you may need to set an environment variable when starting the environment to set the pin factory, for example:
|
||||
|
||||
`Environment = GPIOZERO_PIN_FACTORY=pigpio PIGPIO_ADDR=YOUR_RPi_IP_ADDRESS`
|
||||
|
||||
## Binary Sensor
|
||||
|
||||
The `remote_rpi_gpio` binary sensor platform allows you to read sensor values of the GPIOs of a [Remote Raspberry Pi](https://www.raspberrypi.org/).
|
||||
The `remote_rpi_gpio` binary sensor platform allows you to read sensor values of the GPIOs of a remote [Raspberry Pi](https://www.raspberrypi.org/).
|
||||
|
||||
To use your Remote Raspberry Pi's GPIO in your installation, add the following to your `configuration.yaml` file:
|
||||
To use your remote Raspberry Pi's GPIO in your installation, add the following to your [`configuration.yaml`](/docs/configuration/) file:
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
@ -73,7 +73,7 @@ For more details about the GPIO layout, visit the Wikipedia [article](https://en
|
||||
|
||||
The `remote_rpi_gpio` switch platform allows you to control the GPIOs of a [Remote Raspberry Pi](https://www.raspberrypi.org/).
|
||||
|
||||
To use your Remote Raspberry Pi's GPIO in your installation, add the following to your `configuration.yaml` file:
|
||||
To use your remote Raspberry Pi's GPIO in your installation, add the following to your `configuration.yaml` file:
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
@ -112,7 +112,7 @@ For more details about the GPIO layout, visit the Wikipedia [article](https://en
|
||||
Note that a pin managed by Home Assistant is expected to be exclusive to Home Assistant.
|
||||
</div>
|
||||
|
||||
A common question is what does port refer to, this number is the actual GPIO #, not the pin #.
|
||||
A common question is what does port refer to? This number is the actual GPIO #, not the pin #.
|
||||
For example, if you have a relay connected to pin 11 its GPIO # is 17.
|
||||
|
||||
```yaml
|
||||
@ -126,4 +126,4 @@ switch:
|
||||
|
||||
### 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://forums.raspberrypi.com/viewtopic.php?p=1417922).
|
||||
If you receive an error such as `gpiozero.exc.BadPinFactory: Unable to load any default pin factory!` try changing the `GPIOZERO_PIN_FACTORY` environment variable from `pigpio` to `mock`, as this addresses a [known issue](https://forums.raspberrypi.com/viewtopic.php?p=1417922).
|
||||
|
||||
@ -66,7 +66,7 @@ variables:
|
||||
description: The value of the variable. Any YAML is valid. Templates can also be used to pass a value to the variable.
|
||||
type: any
|
||||
fields:
|
||||
description: "Information about the script field parameters; see the [Passing variables to scripts](#passing-variables-to-scripts) section below. Please note: In order for this description to be displayed in the Services tab of the Developer Tools, the script description must be defined as well."
|
||||
description: "Information about the script field parameters; see the [Passing variables to scripts](#passing-variables-to-scripts) section below."
|
||||
required: false
|
||||
default: {}
|
||||
type: map
|
||||
|
||||
@ -90,7 +90,7 @@ contact:
|
||||
required: false
|
||||
type: string
|
||||
twitter:
|
||||
description: Twitter username of the keymaster.
|
||||
description: X username of the keymaster.
|
||||
required: false
|
||||
type: string
|
||||
irc:
|
||||
@ -98,7 +98,7 @@ contact:
|
||||
required: false
|
||||
type: string
|
||||
twitter:
|
||||
description: The Twitter account of the Hackerspace.
|
||||
description: The X account of the Hackerspace.
|
||||
required: false
|
||||
type: string
|
||||
facebook:
|
||||
|
||||
@ -31,12 +31,12 @@ This integration allows you to control [Tasmota](https://tasmota.github.io/docs/
|
||||
- MQTT broker and the [MQTT integration](/integrations/mqtt/) set up in Home Assistant.
|
||||
- Tasmota devices' MQTT setting configured to communicate with the MQTT broker.
|
||||
- Tasmota devices flashed with version 9.2, or later (`tasmota-lite.bin` does not support this integration).
|
||||
- Tasmota devices configured for native discovery (`SetOption19 0`)
|
||||
- Although the Tasmota integration supports custom fulltopic it is strongly suggested to leave fulltopic at its default, Tasmota does not prevent setting an invalid or non-unique fulltopic, for example a fulltopic without the %prefix% or %topic% tokens.
|
||||
- Tasmota devices configured for native discovery (`SetOption19 0`).
|
||||
- Although the Tasmota integration supports custom fulltopic it is strongly suggested to leave fulltopic at its default, Tasmota does not prevent setting an invalid or non-unique fulltopic, for example a fulltopic without the `%prefix%` or `%topic%` tokens.
|
||||
|
||||
## Supported Features
|
||||
|
||||
Tasmota Buttons, Fans, Lights, relays, Sensors, Shutters and Switches are supported.
|
||||
Tasmota Buttons, Fans, Lights, Relays, Sensors, Shutters and Switches are supported.
|
||||
|
||||
- Tasmota Buttons will be added as Home Assistant `automation triggers` when `SetOption73` is enabled. No `binary_sensor` entity will be created. You can find the available `automation triggers` on the device screen. 
|
||||
- Tasmota Lights will be added as Home Assistant `light` entities. Single channel Dimmers, RGB lights, RGB lights with Color Temperature control and RGB lights with White control are supported.
|
||||
@ -44,12 +44,12 @@ Tasmota Buttons, Fans, Lights, relays, Sensors, Shutters and Switches are suppor
|
||||
- Tasmota Sensors will be added as Home Assistant `sensor` entities.
|
||||
- Tasmota Shutters will be added as Home Assistant `cover` entities. Currently only Shutter modes 1 to 4 are supported. Shutter mode 5 and Tuya shutters are not supported.
|
||||
- Tasmota Switches will be added as either Home Assistant `binary_sensor` entities or `automation triggers` depending on the `switchmode` used when `SetOption114` is enabled.
|
||||
- The fan functionality in Tasmota devices with module configured as iFan02 or iFan03 will be added as Home Assistant `fan` entities. Tuya fans are not supported.
|
||||
- The fan functionality in Tasmota devices with module configured as `iFan02` or `iFan03` will be added as Home Assistant `fan` entities. Tuya fans are not supported.
|
||||
- The integration will also create up to eight Status Sensors, each one with a different information. Please note all the Status Sensors are disabled by default.
|
||||
|
||||
|
||||
{% include integrations/config_flow.md %}
|
||||
|
||||
You must also configure each Tasmota device's MQTT settings to communicate with whatever MQTT broker you are using. Enter the broker address under host and enter a username/password combination that allows access to the broker.
|
||||
You must also configure each Tasmota device's MQTT settings to communicate with whatever MQTT broker you are using. Enter the broker address under host, and enter a username/password combination that allows access to the broker.
|
||||
|
||||
If using the Mosquitto Broker add-on for Home Assistant, first create a new Home Assistant user under {% my users title="Settings > People" %}. Then, in Tasmota > Configure MQTT under "Host" enter the address of your Home Assistant instance and under "User" and "Password" enter the Home Assistant user you just created.
|
||||
If using the Mosquitto Broker add-on for Home Assistant, first create a new Home Assistant user under {% my users title="Settings > People" %}. Then, in **Tasmota** > **Configure MQTT** under "Host" enter the address of your Home Assistant instance and under "User" and "Password" enter the Home Assistant user you just created.
|
||||
|
||||
@ -2,7 +2,7 @@
|
||||
title: Trafikverket Camera
|
||||
description: Instructions how to integrate Trafikverket Camera within Home Assistant.
|
||||
ha_category:
|
||||
- Binary sensor
|
||||
- Binary Sensor
|
||||
- Camera
|
||||
- Sensor
|
||||
ha_release: 2023.9
|
||||
|
||||
@ -29,7 +29,7 @@ notify:
|
||||
|
||||
{% configuration %}
|
||||
from_number:
|
||||
description: An [E.164](https://en.wikipedia.org/wiki/E.164) formatted phone number, like +14151234567. See [Twilio's guide to formatting phone numbers](https://www.twilio.com/help/faq/phone-numbers/how-do-i-format-phone-numbers-to-work-internationally) for more information. Alternatively, a sender ID can be used instead of a phone number. The sender ID must be formatted according to Twilio's guidelines. See [Twilio's guide to sender ID](https://support.twilio.com/hc/en-us/articles/223181348-Getting-started-with-Alphanumeric-Sender-ID) for more information. Do keep in mind that not all countries support sender ID. See [Twilio's page of supported countries](https://support.twilio.com/hc/en-us/articles/223133767-International-support-for-Alphanumeric-Sender-ID) for more information.
|
||||
description: An [E.164](https://en.wikipedia.org/wiki/E.164) formatted phone number, like +14151234567. See [Twilio's guide to formatting phone numbers](https://support.twilio.com/hc/en-us/articles/223183008-Formatting-International-Phone-Numbers) for more information. Alternatively, a sender ID can be used instead of a phone number. The sender ID must be formatted according to Twilio's guidelines. See [Twilio's guide to sender ID](https://support.twilio.com/hc/en-us/articles/223181348-Getting-started-with-Alphanumeric-Sender-ID) for more information. Do keep in mind that not all countries support sender ID. See [Twilio's page of supported countries](https://support.twilio.com/hc/en-us/articles/223133767-International-support-for-Alphanumeric-Sender-ID) for more information.
|
||||
required: true
|
||||
type: string
|
||||
name:
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
---
|
||||
title: Twitter
|
||||
description: Instructions on how to add Twitter notifications to Home Assistant.
|
||||
title: X
|
||||
description: Instructions on how to add X notifications to Home Assistant.
|
||||
ha_category:
|
||||
- Notifications
|
||||
ha_release: 0.12
|
||||
@ -11,18 +11,18 @@ ha_platforms:
|
||||
ha_integration_type: integration
|
||||
---
|
||||
|
||||
The `twitter` notification platform uses [Twitter](https://twitter.com) to deliver notifications from Home Assistant.
|
||||
The `twitter` notification platform uses [X](https://twitter.com) to deliver notifications from Home Assistant.
|
||||
|
||||
## Setup
|
||||
|
||||
Make sure you have a developer account registered with Twitter, then go to [Twitter Apps](https://developer.twitter.com/en/portal/dashboard) and create an application. If you don't have a developer account you need to apply for one, it can take some time to get approved.
|
||||
Make sure you have a developer account registered with X, then go to [X Apps](https://developer.twitter.com/en/portal/dashboard) and create an application. If you don't have a developer account you need to apply for one, it can take some time to get approved.
|
||||
|
||||
### App permissions
|
||||
|
||||
If you do not perform this step, your application will only receive read permissions and will not be able to post tweets on behalf of your account on Twitter.
|
||||
If you do not perform this step, your application will only receive read permissions and will not be able to post tweets on behalf of your account on X.
|
||||
|
||||
1. Visit "Settings" of the application.
|
||||
2. Click on `Set up` under "User authentication settings".
|
||||
1. Visit **Settings** of the application.
|
||||
2. Select `Set up` under **User authentication settings**.
|
||||
3. Check the box for `OAuth 1.0a`.
|
||||
4. Set the app permission to `Read and write`.
|
||||
5. Enter a `callback` and `website` URL and click save.
|
||||
@ -31,13 +31,13 @@ It does not matter for the integration what you enter as a callback or website U
|
||||
|
||||
### Generate tokens and secrets
|
||||
|
||||
1. Visit "Keys and tokens" of the application.
|
||||
2. Click on `Regenerate` under "Consumer keys" to get your **Consumer Key** and **Consumer Secret**.
|
||||
3. Click on `Regenerate` under "Access Tokens and Secret" to get your **Access Token** and **Access Token Secret**.
|
||||
1. Visit **Keys and tokens** of the application.
|
||||
2. Select `Regenerate` under **Consumer keys** to get your **Consumer Key** and **Consumer Secret**.
|
||||
3. Select `Regenerate` under **Access Tokens and Secret** to get your **Access Token** and **Access Token Secret**.
|
||||
|
||||
## Configuration
|
||||
|
||||
To add Twitter to your installation, add the following to your `configuration.yaml` file:
|
||||
To add X to your installation, add the following to your `configuration.yaml` file:
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
@ -73,7 +73,7 @@ access_token_secret:
|
||||
required: true
|
||||
type: string
|
||||
username:
|
||||
description: "Twitter handle without `@` or with `@` and quoting for direct messaging."
|
||||
description: "X handle without `@` or with `@` and quoting for direct messaging."
|
||||
required: false
|
||||
type: string
|
||||
{% endconfiguration %}
|
||||
|
||||
@ -56,3 +56,7 @@ Additionally the following diagnostic sensors are available:
|
||||
- Battery voltage
|
||||
- Signal strength
|
||||
- Uptime
|
||||
|
||||
## Networking notes
|
||||
|
||||
This integration relies on the ability of Home Assistant to receive `UDP` traffic on port `50222`. You may run into trouble if you have a more complex network setup utilizing either VLANs or multiple subnets.
|
||||
|
||||
@ -66,8 +66,6 @@ Alternatively, call the `homeassistant.update_entity` service to force the integ
|
||||
|
||||
If the lock does not support push updates via advertisements or you want lock operation to be more responsive, you can enable always connected mode. Always connected will cause the lock to stay connected to Home Assistant via Bluetooth, which will use more battery.
|
||||
|
||||
If the lock does not support push updates via advertisements or you want lock operation to be more responsive, you can enable always connected mode. Always connected will cause the lock to stay connected to Home Assistant via Bluetooth, which will use more battery.
|
||||
|
||||
## Door Sensors
|
||||
|
||||
The lock must be calibrated in the Yale Access App for the door sensors to function correctly. If the door sensor has an unknown state or is not updating, try recalibrating the lock in the app.
|
||||
|
||||
@ -433,7 +433,7 @@ trigger:
|
||||
|
||||
#### Notification Command Class
|
||||
|
||||
These are notification events fired by devices using the Notification command class. The `parameters` attribute in the example below is optional, and when it is included, the keys in the attribute will vary depending on the event.
|
||||
These are notification events fired by devices using the Notification Command Class. The `parameters` attribute in the example below is optional, and when it is included, the keys in the attribute will vary depending on the event.
|
||||
|
||||
```json
|
||||
{
|
||||
@ -454,9 +454,9 @@ These are notification events fired by devices using the Notification command cl
|
||||
|
||||
#### Multilevel Switch Command Class
|
||||
|
||||
These are notification events fired by devices using the Multilevel Switch command class. There are events for start level change and stop level change. These would typically be used in a device like the Aeotec Nano Dimmer with an external switch to respond to long button presses.
|
||||
These are notification events fired by devices using the Multilevel Switch Command Class. There are events for start level change and stop level change. These would typically be used in a device like the Aeotec Nano Dimmer with an external switch to respond to long button presses.
|
||||
|
||||
##### Start Level Change
|
||||
##### Start level change
|
||||
|
||||
```json
|
||||
{
|
||||
@ -473,7 +473,7 @@ These are notification events fired by devices using the Multilevel Switch comma
|
||||
},
|
||||
```
|
||||
|
||||
##### Stop Level Change
|
||||
##### Stop level change
|
||||
|
||||
```json
|
||||
{
|
||||
@ -492,7 +492,7 @@ These are notification events fired by devices using the Multilevel Switch comma
|
||||
|
||||
#### Entry Control Command Class
|
||||
|
||||
These are notification events fired by devices using the Entry Control command class.
|
||||
These are notification events fired by devices using the Entry Control Command Class.
|
||||
|
||||
```json
|
||||
{
|
||||
@ -614,7 +614,7 @@ trigger:
|
||||
to: "opened"
|
||||
```
|
||||
|
||||
#### Available Trigger Data
|
||||
#### Available trigger data
|
||||
|
||||
In addition to the [standard automation trigger data](/docs/automation/templating/#all), the `zwave_js.value_updated` trigger platform has additional trigger data available for use.
|
||||
|
||||
@ -622,8 +622,8 @@ In addition to the [standard automation trigger data](/docs/automation/templatin
|
||||
| ---------------------------- | ------------------------------------------------------------------------------------------ |
|
||||
| `trigger.device_id` | Device ID for the device in the device registry. |
|
||||
| `trigger.node_id` | Z-Wave node ID. |
|
||||
| `trigger.command_class` | Command class ID. |
|
||||
| `trigger.command_class_name` | Command class name. |
|
||||
| `trigger.command_class` | Command Class ID. |
|
||||
| `trigger.command_class_name` | Command Class name. |
|
||||
| `trigger.property` | Z-Wave Value's property. |
|
||||
| `trigger.property_name` | Z-Wave Value's property name. |
|
||||
| `trigger.property_key` | Z-Wave Value's property key. |
|
||||
@ -662,7 +662,7 @@ trigger:
|
||||
partial_dict_match: true # defaults to false
|
||||
```
|
||||
|
||||
#### Available Trigger Data
|
||||
#### Available trigger data
|
||||
|
||||
In addition to the [standard automation trigger data](/docs/automation/templating/#all), the `zwave_js.event` trigger platform has additional trigger data available for use.
|
||||
|
||||
@ -733,25 +733,23 @@ If you're running full Home Assistant with supervisor, you will be presented wit
|
||||
|
||||
If you're not running the supervisor or you've unchecked the above-mentioned box, you will be asked to enter a WebSocket URL (defaults to ws://localhost:3000). It is very important that you fill in the correct (Docker) IP/hostname here. For example for the Z-Wave JS UI add-on this is `ws://a0d7b954-zwavejs2mqtt:3000`.
|
||||
|
||||
## Frequently Asked Questions
|
||||
|
||||
### Supported Devices and Command Classes
|
||||
## FAQ: Supported devices and Command Classes
|
||||
|
||||
See the [Z-Wave JS device database](https://devices.zwave-js.io/).
|
||||
|
||||
While there is support for the most common devices, some command classes are not yet (fully) implemented in Z-Wave JS. You can track the status [here](https://github.com/zwave-js/node-zwave-js/issues/6).
|
||||
While there is support for the most common devices, some Command Classes are not yet (fully) implemented in Z-Wave JS. You can track the status [here](https://github.com/zwave-js/node-zwave-js/issues/6).
|
||||
|
||||
You can also keep track of the road map for the Z-Wave integration [here](https://github.com/home-assistant-libs/zwave-js-server-python/issues/56).
|
||||
|
||||
### Installation and Configuration
|
||||
## FAQ: Installation and configuration
|
||||
|
||||
#### Which Z-Wave controller should I buy?
|
||||
### Which Z-Wave controller should I buy?
|
||||
|
||||
Z-Wave supports all known 500 and 700 series Z-Wave controllers. If you are just starting out, we recommend that you purchase a 700 series controller (with firmware updated to >=7.17.2).
|
||||
|
||||
For more information, see [Supported Z-Wave dongles](/docs/z-wave/controllers/#supported-z-wave-usb-sticks--hardware-modules)
|
||||
|
||||
#### Why was I (or why was I not) automatically prompted to install Z-Wave?
|
||||
### Why was I (not) automatically prompted to install Z-Wave?
|
||||
|
||||
Some Z-Wave USB sticks can be auto-discovered, which can simplify the Z-Wave setup process. The following devices have been tested with discovery, and offer a quick setup experience; however, these are **not** all of the devices supported by Z-Wave:
|
||||
|
||||
@ -764,15 +762,15 @@ Some Z-Wave USB sticks can be auto-discovered, which can simplify the Z-Wave set
|
||||
|
||||
Additional devices may be discoverable, however only devices that have been confirmed discoverable are listed above.
|
||||
|
||||
#### What happened to Zwavejs2Mqtt or the Z-Wave JS to MQTT add-on?
|
||||
### What happened to Zwavejs2Mqtt or the Z-Wave JS to MQTT add-on?
|
||||
|
||||
Zwavejs2Mqtt was renamed Z-Wave JS UI in September 2022. They are synonymous with no difference between their capabilities.
|
||||
|
||||
#### Can I switch between the Official Z-Wave JS add-on and the Z-Wave JS UI add-on?
|
||||
### Can I switch between the official Z-Wave JS add-on and the Z-Wave JS UI add-on?
|
||||
|
||||
You can, but you cannot run them both at the same time. Only one of them can be active at the same time.
|
||||
|
||||
#### How do I switch between the Official Z-Wave JS add-on and the Z-Wave JS UI add-on?
|
||||
### How do I switch between the official Z-Wave JS add-on and the Z-Wave JS UI add-on?
|
||||
|
||||
Switching does not require renaming your devices.
|
||||
|
||||
@ -788,27 +786,27 @@ Switching does not require renaming your devices.
|
||||
|
||||
6. Enable the Z-Wave integration.
|
||||
|
||||
#### What's the benefit of using Z-Wave JS UI add-on over the official add-on?
|
||||
### What's the benefit of using Z-Wave JS UI add-on over the official add-on?
|
||||
|
||||
The official add-on provides the Z-Wave Server in its bare minimum variant, just enough to serve the Home Assistant integration.
|
||||
|
||||
The Z-Wave JS UI project includes the Z-Wave JS Server for convenience but also provides a Z-Wave Control panel and the ability to serve your Z-Wave network to MQTT. This allows you to use the control panel, and if you so choose, to also use MQTT at the same time. For example, some users may use MQTT to interact with Z-Wave from other devices, while the Home Assistant integration still works (as long as you keep the WS Server enabled in Z-Wave JS UI).
|
||||
The Z-Wave JS UI project includes the Z-Wave JS Server for convenience but also provides a Z-Wave control panel and the ability to serve your Z-Wave network to MQTT. This allows you to use the control panel, and if you so choose, to also use MQTT at the same time. For example, some users may use MQTT to interact with Z-Wave from other devices, while the Home Assistant integration still works (as long as you keep the WS Server enabled in Z-Wave JS UI).
|
||||
|
||||
#### Z-Wave JS UI seems to provide discovery of Home Assistant devices on its own too, now I'm confused
|
||||
### Z-Wave JS UI seems to provide discovery of Home Assistant devices on its own too, now I'm confused
|
||||
|
||||
Correct, the Z-Wave JS UI project existed before Home Assistant had plans to move to the Z-Wave JS Driver. You should use the integration for device discovery and _not_ the MQTT discovery provided by Z-Wave JS UI.
|
||||
|
||||
#### Can I run Z-Wave JS UI only for the control panel and nothing else?
|
||||
### Can I run Z-Wave JS UI only for the control panel and nothing else?
|
||||
|
||||
Sure, in the settings of Z-Wave JS UI, make sure to enable "WS Server" and disable "Gateway".
|
||||
|
||||
#### Should I name my devices in Home Assistant, or in Z-Wave JS UI?
|
||||
### Should I name my devices in Home Assistant, or in Z-Wave JS UI?
|
||||
|
||||
Ultimately, this is a personal decision. If you provide a name or location for a device in the Z-Wave JS UI, that name will be imported into Home Assistant when the integration is reloaded or Home Assistant is restarted. Any entity names, however, will not change if the device has already been set up by Home Assistant. Names set in Z-Wave JS UI _will not_ overwrite changes that have already been made in Home Assistant.
|
||||
|
||||
Names set in Home Assistant will not import into Z-Wave JS UI.
|
||||
|
||||
#### Should I use `Secure Inclusion`?
|
||||
### Should I use `Secure Inclusion`?
|
||||
|
||||
That depends. There are two generations of Z-Wave security, S0, and S2.
|
||||
|
||||
@ -816,13 +814,13 @@ S0 security imposes significant additional traffic on your mesh and is recommend
|
||||
|
||||
S2 security does not impose additional network traffic and provides additional benefits, such as detecting packet corruption. By default, Z-Wave attempts S2 security during inclusion if supported, falling back to S0 security only when necessary.
|
||||
|
||||
#### Where can I see the security keys in the Z-Wave JS add-on?
|
||||
### Where can I see the security keys in the Z-Wave JS add-on?
|
||||
|
||||
After the initial setup of the Z-Wave controller, you can view the security keys in the Z-Wave JS add-on. Go to {% my supervisor_addon addon="core_zwave_js" title="**Settings** > **Add-ons** > **Z-Wave JS**" %} and open the **Configuration** tab. You can now see the three S2 keys and the S0 key. The network security key is a legacy configuration setting, identical to the S0 key.
|
||||
|
||||
### Troubleshooting
|
||||
## FAQ: Troubleshooting topics
|
||||
|
||||
#### I'm having a problem, what should I do first?
|
||||
### I'm having a problem, what to do first?
|
||||
|
||||
_Many_ reported issues result from RF interference caused by the system's USB ports. This can manifest in many ways, including devices that won't include at all, devices that won't include securely, sensors with erroneous values (packets corrupted), delayed control of devices, or no ability to control devices.
|
||||
|
||||
@ -832,17 +830,17 @@ After ensuring you are using an extension cable, rebuild network routes.
|
||||
|
||||
The combination of these two steps corrects a large number of reported difficulties.
|
||||
|
||||
#### I have an Aeotec Gen5 controller, and it isn't detected on my Raspberry Pi 4?
|
||||
### I have an Aeotec Gen5 controller, and it isn't detected on my Raspberry Pi 4?
|
||||
|
||||
The first-generation Gen5 controller has a known bug when plugged into a Pi 4 and possibly other systems. Aeotec released the Gen5+ stick to correct this bug. Gen5 users can plug their sticks into a USB 2.0 hub in order to overcome the issue.
|
||||
|
||||
#### I do not see any entities created for my device in Home Assistant
|
||||
### I do not see any entities created for my device in Home Assistant
|
||||
|
||||
Entities will be created only after the node is ready (the interview is completed). Also, note that some devices (like button remotes) do not create any entities but will only provide events when a button is pressed. See the events section on how to handle those events in your automations.
|
||||
|
||||
If you are certain that your device should have entities and you do not see them (even after a restart of Home Assistant Core), create an issue about your problem on the GitHub issue tracker.
|
||||
|
||||
#### My device does not automatically update its status in HA if I control it manually
|
||||
### My device does not automatically update its status in HA if I control it manually
|
||||
|
||||
Your device might not send automatic status updates to the controller. While the best advice would be to update to recent Z-Wave Plus devices, there is a workaround with active polling (request the status).
|
||||
|
||||
@ -856,13 +854,13 @@ Z-Wave does not automatically poll devices on a regular basis. Polling can quick
|
||||
Polling should only be used as a last resort. You must use it with care and accept the negative impact on your network. Z-Wave is a very low speed network and poll requests can easily flood your network and slow down your commands.
|
||||
</div>
|
||||
|
||||
#### My device is recognized as Unknown Manufacturer and/or some of its functionalities do not work with the Z-Wave integration
|
||||
### My device is recognized as Unknown Manufacturer and/or some functions don't work with the Z-Wave integration
|
||||
|
||||
When your device is not yet fully interviewed, this info will not yet be present. So make sure your device is interviewed at least once.
|
||||
|
||||
If the interview is complete, then the device does not yet have a device file for Z-Wave JS. Unlike other Z-Wave drivers, your device may very well work as intended even without such a file. If your device not fully supported, consider [contributing the device configuration file](https://zwave-js.github.io/node-zwave-js/#/config-files/contributing-files).
|
||||
|
||||
#### How do I get a dump of the current network state?
|
||||
### How do I get a dump of the current network state?
|
||||
|
||||
When trying to determine why something isn't working as you expect, or when reporting an issue with the integration, it is helpful to know what Z-Wave JS sees as the current state of your Z-Wave network. To get a dump of your current network state, follow these steps:
|
||||
|
||||
@ -870,35 +868,35 @@ When trying to determine why something isn't working as you expect, or when repo
|
||||
2. Select the **Z-Wave** integration. Then, select the three dots.
|
||||
3. From he dropdown menu, select **Download diagnostics**.
|
||||
|
||||
#### How do I address interference issues?
|
||||
### How do I address interference issues?
|
||||
|
||||
Many users have reported issues with interference when the USB stick was directly connected to the machine (proximity). If you are having issues, try to use a short USB 2.0 A (male to female) extension cord.
|
||||
|
||||
#### How do I access the Z-Wave logs?
|
||||
### How do I access the Z-Wave logs?
|
||||
|
||||
##### The easy way
|
||||
#### The easy way
|
||||
|
||||
###### Enable Z-Wave JS logging
|
||||
##### Enable Z-Wave JS logging
|
||||
|
||||
1. Go to the Z-Wave integration panel: {% my integration badge domain="zwave_js" %}
|
||||
2. Select `Enable debug logging` on the left-hand side of the screen.
|
||||
|
||||
The log level will be set to `debug` for the integration, library, and optionally the driver (if the driver log level is not already set to `verbose`, `debug`, or `silly`), and all Z-Wave JS logs will be added to the Home Assistant logs.
|
||||
|
||||
###### Disable Z-Wave JS logging
|
||||
##### Disable Z-Wave JS logging
|
||||
|
||||
1. Go to the Z-Wave integration panel: {% my integration badge domain="zwave_js" %}
|
||||
2. Select `Disable debug logging` on the left-hand side of the screen.
|
||||
|
||||
The log level will be reset to its previous value for the integration, library, and driver, and the Home Assistant frontend will automatically send you the Z-Wave logs generated during that time period for download.
|
||||
|
||||
##### The advanced way
|
||||
#### The advanced way
|
||||
|
||||
###### Enable Z-Wave JS logging manually, or via an automation
|
||||
##### Enable Z-Wave JS logging manually, or via an automation
|
||||
|
||||
Set the log level for `zwave_js_server` to `debug`. This can either be done in your `configuration.yaml` in the `logger` section, or using the `logger.set_level` service. When the integration detects that the log level has been set to `debug`, it will also set the Z-Wave JS logs to `debug` if the level isn't already `verbose`, `debug`, or `silly` and will include those logs in the Home Assistant logs. The Z-Wave JS logs can be found under the logger name `zwave_js_server.server`.
|
||||
|
||||
###### Disable Z-Wave JS logging manually, or via an automation
|
||||
##### Disable Z-Wave JS logging manually, or via an automation
|
||||
|
||||
Set the log level for `zwave_js_server` to a level higher than `debug`. This can either be done in your `configuration.yaml` in the `logger` section, or using the `logger.set_level` service. The Z-Wave JS logs will no longer be included in the Home Assistant logs, and if the log level of Z-Wave JS was changed by the integration, it will automatically change back to its original level.
|
||||
|
||||
|
||||
@ -38,7 +38,7 @@ ha_zeroconf: true
|
||||
ha_integration_type: integration
|
||||
---
|
||||
|
||||
This integration allows you to control a Z-Wave network via the [Z-Wave.Me Z-Way](https://z-wave.me/z-way/). It combines the performance and the power of the diagnostics tools built-in Z-Way with the flexibility of Home Assistant. The integration brings all Z-Way devices in Home Assistant (Z-Wave, EnOcean, HTTP based, and others).
|
||||
This integration allows you to control a Z-Wave network via the [Z-Wave.Me Z-Way](https://z-wave.me/z-way/). It combines the performance and the power of the diagnostics tools built-in Z-Way with the flexibility of Home Assistant. The integration brings all Z-Way devices in Home Assistant (Z-Wave, Zigbee, EnOcean, HTTP based, and others).
|
||||
|
||||
{% include integrations/config_flow.md %}
|
||||
|
||||
@ -77,7 +77,7 @@ Example of connecting to Z-Way via remote access find.z-wave.me:
|
||||
</div>
|
||||
|
||||
|
||||
<div class='note warning'>
|
||||
<div class='note info'>
|
||||
|
||||
You can use Z-Wave.Me UI with its enhanced Z-Wave network diagnostics tools together with the Home Assistant UI.
|
||||
|
||||
@ -87,10 +87,11 @@ Example of connecting to Z-Way via remote access find.z-wave.me:
|
||||
|
||||
Z-Wave.Me Z-Way requires Z-Wave.Me hardware:
|
||||
- [RaZberry 7](https://z-wave.me/products/razberry/) and [RaZberry 7 Pro](https://z-wave.me/products/razberry/)
|
||||
- [Wiren Board 7](https://z-wave.me/products/wirenboard-7/)
|
||||
- [Z-Station](https://z-wave.me/products/z-station/)
|
||||
- [Z-Wave & Zigbee mPCIe](https://z-wave.me/products/mpcie/)
|
||||
- [RaZberry](https://z-wave.me/products/razberry-old/)
|
||||
- [UZB1](https://z-wave.me/products/uzb/ )
|
||||
- [RaZberry (old)](https://z-wave.me/products/razberry-old/)
|
||||
- [UZB1](https://z-wave.me/products/uzb/)
|
||||
- [Hub1](https://z-wave.me/products/hub/)
|
||||
- or any other Z-Wave.Me based controller.
|
||||
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
---
|
||||
title: "The Open Home"
|
||||
description: "Our vision for the smart home: privacy, choice and durability."
|
||||
description: "Our vision for the smart home: privacy, choice and sustainability."
|
||||
date: 2021-12-23 00:01:00
|
||||
date_formatted: "December 23, 2021"
|
||||
author: Paulus Schoutsen
|
||||
@ -13,7 +13,9 @@ og_image: /images/blog/2021-12-open-home/social.png
|
||||
|
||||
The Open Home is our vision for the smart home. It defines the values that we put at the heart of every decision we make at Home Assistant. It's woven into our architecture, licensing, community and everything else.
|
||||
|
||||
The Open Home is about **privacy**, **choice** and **durability**.
|
||||
The Open Home is about **privacy**, **choice** and **sustainability**.
|
||||
|
||||
_The original vision used "durability" instead of "sustainability". This value was changed as [part of our 10 year anniversary](https://www.youtube.com/watch?v=EmLV6lJLzSU&t=3651s)._
|
||||
|
||||
_If you prefer video, skip [to the end](#state-of-the-open-home)._
|
||||
|
||||
@ -31,13 +33,15 @@ Devices in your home gather data about itself and their surroundings. Your data.
|
||||
|
||||
**Choice** for the Open Home means that devices need to make the gathered data available through local APIs. This avoids vendor lock-in and allows users to create their own smart home with devices from different manufacturers.
|
||||
|
||||
## Durability
|
||||
## Sustainability
|
||||
|
||||
If there is one thing that technology firms are very good at, it is launching new products. However, maintaining the products and making sure they keep working is an afterthought for most. The result is that vendors can decide to no longer support your device, crippling it's features or even prevent it from working at all.
|
||||
Humans emit CO<sub>2</sub> into the atmosphere, causing the climate to change and the world to heat up. One way we can all help with this is to ensure that our individual energy and waste footprint is as small as possible. Our homes represent a substantial part of this.
|
||||
|
||||
As we install more and more devices in our home, durability is becoming more and more important. We shouldn't have to buy everything new every couple of years because the manufacturer decided to move on.
|
||||
For the Open Home, longevity of a device should not be an afterthought. If there is one thing that technology firms are very good at, it is launching new products. However, maintaining the products and making sure they keep working is an afterthought for most. The result is that vendors can decide to no longer support your device, crippling it's features or even prevent it from working at all.
|
||||
|
||||
**Durability** for the Open Home means that devices are designed and built to keep working. Not just this year, but for the next decade.
|
||||
As we install more and more devices in our home, sustainability is becoming more and more important. We shouldn't have to buy everything new every couple of years because the manufacturer decided to move on.
|
||||
|
||||
**Sustainability** for the Open Home means that devices are designed and built to keep working and use as little energy as possible. Not just this year, but for the next decade. If they outlive their original purpose, they should be able to be reused or repurposed for something else.
|
||||
|
||||
## State of the Open Home
|
||||
|
||||
|
||||
@ -15,7 +15,7 @@ They presented about their research into lowering grid demand by reducing thermo
|
||||
|
||||
<lite-youtube videoid="6ZMXE5PXPqU" videotitle="State of the Open Home 2021" videoStartAt="8042" posterquality="maxresdefault"></lite-youtube>
|
||||
|
||||
With Home Assistant we want every home to be about [privacy, choice and durability](/blog/2021/12/23/the-open-home/) and it's how we built Home Assistant. Because we believe in choice, all data in Home Assistant is accessible and one can extend or built on top of our platform.
|
||||
With Home Assistant we want every home to be about [privacy, choice and sustainability](/blog/2021/12/23/the-open-home/) and it's how we built Home Assistant. Because we believe in choice, all data in Home Assistant is accessible and one can extend or built on top of our platform.
|
||||
|
||||
This architecture made it possible for Prof. Kane to create a custom version of Home Assistant for his research that gathers data about all devices, surveys users based on changes to devices and exports all this data back to their research lab. For this they leverage device integrations, added a custom survey feature to the UI and push notifications from the Home Assistant companion app to draw the user's attention to the surveys.
|
||||
|
||||
|
||||
@ -19,6 +19,7 @@ _**TL;DR**: It is our goal for 2023 to let users control Home Assistant in their
|
||||
- [Year of the Voice - Chapter 1](https://www.home-assistant.io/blog/2023/01/26/year-of-the-voice-chapter-1/) (January 26, 2023)
|
||||
- [Year of the Voice - Chapter 2](/blog/2023/04/27/year-of-the-voice-chapter-2/) (April 27, 2023)
|
||||
- [Year of the Voice - Chapter 3](/blog/2023/07/20/year-of-the-voice-chapter-3/) (July 20, 2023)
|
||||
- [Year of the Voice - Chapter 4](/blog/2023/10/12/year-of-the-voice-chapter-4-wakewords/) (October 12, 2023)
|
||||
|
||||
<hr>
|
||||
|
||||
|
||||
@ -100,7 +100,7 @@ Together with today’s blog post, we’ve pushed a big update to [the SkyConnec
|
||||
|
||||
## SiLabs multi-flasher & SL Web Tools
|
||||
|
||||
It’s our mission to build the Open Home: a smart home that offers privacy, choice, and durability. Part of our efforts is to build tooling that helps other creators to make projects and products to help further the Open Home cause.
|
||||
It’s our mission to build the Open Home: a smart home that offers privacy, choice, and sustainability. Part of our efforts is to build tooling that helps other creators to make projects and products to help further the Open Home cause.
|
||||
|
||||
As part of this effort, two years ago, we built ESP Web Tools. It revolutionized the DIY firmware world by allowing any ESP32/ESP8266 project to offer an easy web installer on their homepage, allowing users to get started directly from their browser. It has been adopted by all the great projects, including [Tasmota], [WLED], and [ESPresense]. Ever since the introduction of ESP Web Tools, we have wanted to expand this to more devices.
|
||||
|
||||
|
||||
@ -127,11 +127,11 @@ The Whisper and Piper add-ons mentioned above are integrated into Home Assistant
|
||||
|
||||
Today we’re launching support for building voice assistants using ESPHome. Connect a microphone to your ESPHome device, and you can control your smart home with your voice. Include a speaker and the smart home will speak back.
|
||||
|
||||
<lite-youtube videoid="w6QxGdxVMJs" videotitle="$13 voice remote for Home Assistant"></lite-youtube>
|
||||
<lite-youtube videoid="w6QxGdxVMJs" videotitle="$13 voice assistant for Home Assistant"></lite-youtube>
|
||||
|
||||
We’ve been focusing on the [M5STACK ATOM Echo][atom-echo] for testing and development. For $13 it comes with a microphone and a speaker in a nice little box. We’ve created a tutorial to turn this device into a voice remote directly from your browser!
|
||||
We’ve been focusing on the [M5STACK ATOM Echo][atom-echo] for testing and development. For $13 it comes with a microphone and a speaker in a nice little box. We’ve created a tutorial to turn this device into a voice assistant directly from your browser!
|
||||
|
||||
[Tutorial: create a $13 voice remote for Home Assistant.](https://www.home-assistant.io/voice_control/thirteen-usd-voice-remote/)
|
||||
[Tutorial: create a $13 voice assistant for Home Assistant.](https://www.home-assistant.io/voice_control/thirteen-usd-voice-remote/)
|
||||
|
||||
[ESPHome Voice Assistant documentation.](https://esphome.io/components/voice_assistant.html)
|
||||
|
||||
|
||||
@ -46,7 +46,6 @@ Starting in Chapter 3, Assist is now natively supported through the [Home Assist
|
||||
Assist on Android is built-in to the Android app and uses the speech-to-text from Home Assistant
|
||||
</p>
|
||||
|
||||
|
||||
Have a [Home Assistant Cloud subscription]? You can now control your smart home via voice from anywhere in the world without giving up your privacy. [Multiple Home Assistant servers are supported], so you can just as easily talk to your parent's house:
|
||||
|
||||
<p class='img'>
|
||||
@ -171,6 +170,7 @@ binary_sensor:
|
||||
else:
|
||||
- voice_assistant.start_continuous:
|
||||
```
|
||||
|
||||
[ESPHome Voice Assistant documentation](https://esphome.io/components/voice_assistant.html#click-to-converse)
|
||||
|
||||
### Silence detection
|
||||
@ -196,7 +196,7 @@ If you want to help fund our work on voice and further development of Home Assis
|
||||
|
||||
After three chapters in the Year of Voice, the message from Home Assistant users and creators is loud and clear: we want a wake word for Assist!
|
||||
|
||||
In Chapter 4, our focus will be on delivering the foundation for wake word detection. As a part of the [Open Home], this foundation will keep in line with our values: privacy, choice, and durability. Stay tuned!
|
||||
In Chapter 4, our focus will be on delivering the foundation for wake word detection. As a part of the [Open Home], this foundation will keep in line with our values: privacy, choice, and sustainability. Stay tuned!
|
||||
|
||||
[Joris Pelgröm]: https://github.com/jpelgrom
|
||||
[Open Home]: https://www.home-assistant.io/blog/2021/12/23/the-open-home/?ref=building.open-home.io
|
||||
|
||||
@ -135,7 +135,7 @@ This is powered by [OpenStreetMap](https://www.openstreetmap.org/) ❤️
|
||||
|
||||
## Add items to your shopping list using Assist
|
||||
|
||||
What if you could ask [Assist](/integrations/assist) to add items to your
|
||||
What if you could ask [Assist] to add items to your
|
||||
Home Assistant [shopping list](/integrations/shopping_list)? Well, now you can!
|
||||
|
||||
> Add milk to my shopping list!
|
||||
@ -259,7 +259,6 @@ noteworthy changes this release:
|
||||
- [UniFi Network] now has controls to turn an UniFi WLAN on and off and added
|
||||
image entities for QR codes for WLAN access. Thanks, [@Kane610]!
|
||||
|
||||
|
||||
[@bdraco]: https://github.com/bdraco
|
||||
[@emontnemery]: https://github.com/emontnemery
|
||||
[@Ernst79]: https://github.com/Ernst79
|
||||
@ -276,6 +275,7 @@ noteworthy changes this release:
|
||||
[UniFi Network]: /integrations/unifi
|
||||
[Xiaomi BLE]: /integrations/xiaomi_ble
|
||||
[Roborock]: /integrations/roborock
|
||||
[Assist]: /voice_control/
|
||||
|
||||
## New integrations
|
||||
|
||||
@ -757,7 +757,6 @@ Your system has been using Python 3.11 for quite some time already.
|
||||
|
||||
{% enddetails %}
|
||||
|
||||
|
||||
{% details "Discovery" %}
|
||||
|
||||
The legacy discovery integration has been removed. This only affects the
|
||||
|
||||
@ -40,6 +40,10 @@ Enjoy the release!
|
||||
- [New integrations](#new-integrations)
|
||||
- [Integrations now available to set up from the UI](#integrations-now-available-to-set-up-from-the-ui)
|
||||
- [Release 2023.10.1 - October 6](#release-2023101---october-6)
|
||||
- [Release 2023.10.2 - October 12](#release-2023102---october-12)
|
||||
- [Release 2023.10.3 - October 13](#release-2023103---october-13)
|
||||
- [Release 2023.10.4 - October 21](#release-2023104---october-21)
|
||||
- [Release 2023.10.5 - October 22](#release-2023105---october-22)
|
||||
- [Need help? Join the community!](#need-help-join-the-community)
|
||||
- [Breaking changes](#breaking-changes)
|
||||
- [All changes](#all-changes)
|
||||
@ -332,6 +336,242 @@ The following integrations are now available via the Home Assistant UI:
|
||||
[@rklomp]: https://github.com/rklomp
|
||||
[@synesthesiam]: https://github.com/synesthesiam
|
||||
|
||||
## Release 2023.10.2 - October 12
|
||||
|
||||
The Mazda integration has been removed from Home Assistant. The library that Home Assistant uses to connect with their services [has been taken offline by Mazda](https://github.com/github/dmca/blob/master/2023/10/2023-10-10-mazda.md).
|
||||
|
||||
- Improve handling of roon media players with fixed and incremental volume ([@pavoni] - [#99819])
|
||||
- Auto-fix common key entry issues during WeatherKit config flow ([@tjhorner] - [#101504])
|
||||
- Improve Ikea Idasen config flow error messages ([@abmantis] - [#101567])
|
||||
- Update pyfronius to 0.7.2 ([@farmio] - [#101571])
|
||||
- Update ha-philipsjs to 3.1.1 ([@elupus] - [#101574])
|
||||
- Update aiohttp to 3.8.6 ([@cdce8p] - [#101590])
|
||||
- Additional fix for rainbird unique id ([@allenporter] - [#101599])
|
||||
- Fix compiling missing statistics losing rows ([@bdraco] - [#101616])
|
||||
- Bump systembridgeconnector to 3.8.4 ([@timmo001] - [#101621])
|
||||
- Update pylutron-caseta to 0.18.3 ([@mdonoughe] - [#101630])
|
||||
- Add additional calendar state alarm debugging ([@allenporter] - [#101631])
|
||||
- Abort config flow when invalid token is received ([@joostlek] - [#101642])
|
||||
- Fix mqtt sensor or binary_sensor state not saved after expiry ([@jbouwh] - [#101670])
|
||||
- Fix Slack type error for file upload ([@tkdrob] - [#101720])
|
||||
- Update eufylife-ble-client to 0.1.8 ([@bdr99] - [#101727])
|
||||
- Add google calendar required feature for create event service ([@allenporter] - [#101741])
|
||||
- Fix Airzone climate double setpoint ([@Noltari] - [#101744])
|
||||
- Bump screenlogicpy to 0.9.2 ([@dieselrabbit] - [#101746])
|
||||
- Fix typo in Ombi translation strings ([@Betacart] - [#101747])
|
||||
- Bump pyDuotecno to 2023.10.0 ([@Cereal2nd] - [#101754])
|
||||
- Subscribe to Withings webhooks outside of coordinator ([@joostlek] - [#101759])
|
||||
- Change BiDirectional Prefix ([@hesselonline] - [#101764])
|
||||
- Bump pyweatherflowudp to 1.4.5 ([@natekspencer] - [#101770])
|
||||
- Bump bimmer_connected to 0.14.1 ([@rikroe] - [#101789])
|
||||
- Bump env_canada to 0.6.0 ([@michaeldavie] - [#101798])
|
||||
- Await set value function in ScreenLogic number entities ([@dieselrabbit] - [#101802])
|
||||
- Update aioqsw to v0.3.5 ([@Noltari] - [#101809])
|
||||
- Dynamic wake word loading for Wyoming ([@synesthesiam] - [#101827])
|
||||
- Close existing UDP server for ESPHome voice assistant ([@synesthesiam] - [#101845])
|
||||
- Remove Mazda integration ([@bdr99] - [#101849])
|
||||
- Bump Python-MyQ to v3.1.13 ([@justinlindh] - [#101852])
|
||||
- Fix translation key in Plugwise ([@joostlek] - [#101862])
|
||||
- Fix SMA incorrect device class ([@rklomp] - [#101866])
|
||||
- Fix mysensors battery level attribute ([@MartinHjelmare] - [#101868])
|
||||
- Fix typo in remember the milk strings ([@Betacart] - [#101869])
|
||||
- Only reload Withings config entry on reauth ([@joostlek] - [#101638])
|
||||
|
||||
[#101386]: https://github.com/home-assistant/core/pull/101386
|
||||
[#101504]: https://github.com/home-assistant/core/pull/101504
|
||||
[#101547]: https://github.com/home-assistant/core/pull/101547
|
||||
[#101567]: https://github.com/home-assistant/core/pull/101567
|
||||
[#101571]: https://github.com/home-assistant/core/pull/101571
|
||||
[#101574]: https://github.com/home-assistant/core/pull/101574
|
||||
[#101590]: https://github.com/home-assistant/core/pull/101590
|
||||
[#101599]: https://github.com/home-assistant/core/pull/101599
|
||||
[#101616]: https://github.com/home-assistant/core/pull/101616
|
||||
[#101621]: https://github.com/home-assistant/core/pull/101621
|
||||
[#101630]: https://github.com/home-assistant/core/pull/101630
|
||||
[#101631]: https://github.com/home-assistant/core/pull/101631
|
||||
[#101638]: https://github.com/home-assistant/core/pull/101638
|
||||
[#101642]: https://github.com/home-assistant/core/pull/101642
|
||||
[#101670]: https://github.com/home-assistant/core/pull/101670
|
||||
[#101720]: https://github.com/home-assistant/core/pull/101720
|
||||
[#101727]: https://github.com/home-assistant/core/pull/101727
|
||||
[#101741]: https://github.com/home-assistant/core/pull/101741
|
||||
[#101744]: https://github.com/home-assistant/core/pull/101744
|
||||
[#101746]: https://github.com/home-assistant/core/pull/101746
|
||||
[#101747]: https://github.com/home-assistant/core/pull/101747
|
||||
[#101754]: https://github.com/home-assistant/core/pull/101754
|
||||
[#101759]: https://github.com/home-assistant/core/pull/101759
|
||||
[#101764]: https://github.com/home-assistant/core/pull/101764
|
||||
[#101770]: https://github.com/home-assistant/core/pull/101770
|
||||
[#101789]: https://github.com/home-assistant/core/pull/101789
|
||||
[#101798]: https://github.com/home-assistant/core/pull/101798
|
||||
[#101802]: https://github.com/home-assistant/core/pull/101802
|
||||
[#101809]: https://github.com/home-assistant/core/pull/101809
|
||||
[#101827]: https://github.com/home-assistant/core/pull/101827
|
||||
[#101845]: https://github.com/home-assistant/core/pull/101845
|
||||
[#101849]: https://github.com/home-assistant/core/pull/101849
|
||||
[#101852]: https://github.com/home-assistant/core/pull/101852
|
||||
[#101862]: https://github.com/home-assistant/core/pull/101862
|
||||
[#101866]: https://github.com/home-assistant/core/pull/101866
|
||||
[#101868]: https://github.com/home-assistant/core/pull/101868
|
||||
[#101869]: https://github.com/home-assistant/core/pull/101869
|
||||
[#99819]: https://github.com/home-assistant/core/pull/99819
|
||||
[@Betacart]: https://github.com/Betacart
|
||||
[@Cereal2nd]: https://github.com/Cereal2nd
|
||||
[@MartinHjelmare]: https://github.com/MartinHjelmare
|
||||
[@Noltari]: https://github.com/Noltari
|
||||
[@abmantis]: https://github.com/abmantis
|
||||
[@allenporter]: https://github.com/allenporter
|
||||
[@bdr99]: https://github.com/bdr99
|
||||
[@bdraco]: https://github.com/bdraco
|
||||
[@cdce8p]: https://github.com/cdce8p
|
||||
[@dieselrabbit]: https://github.com/dieselrabbit
|
||||
[@elupus]: https://github.com/elupus
|
||||
[@farmio]: https://github.com/farmio
|
||||
[@frenck]: https://github.com/frenck
|
||||
[@hesselonline]: https://github.com/hesselonline
|
||||
[@jbouwh]: https://github.com/jbouwh
|
||||
[@joostlek]: https://github.com/joostlek
|
||||
[@justinlindh]: https://github.com/justinlindh
|
||||
[@mdonoughe]: https://github.com/mdonoughe
|
||||
[@michaeldavie]: https://github.com/michaeldavie
|
||||
[@natekspencer]: https://github.com/natekspencer
|
||||
[@pavoni]: https://github.com/pavoni
|
||||
[@rikroe]: https://github.com/rikroe
|
||||
[@rklomp]: https://github.com/rklomp
|
||||
[@synesthesiam]: https://github.com/synesthesiam
|
||||
[@timmo001]: https://github.com/timmo001
|
||||
[@tjhorner]: https://github.com/tjhorner
|
||||
[@tkdrob]: https://github.com/tkdrob
|
||||
|
||||
## Release 2023.10.3 - October 13
|
||||
|
||||
- Downgrade aiohttp to 3.8.5 ([@frenck] - [#101913])
|
||||
- Add missing fan mode in Sensibo ([@gjohansson-ST] - [#101883])
|
||||
- Uncancel task when swallowing CancelledError ([@starkillerOG] - [#101884])
|
||||
- Bump reolink-aio to 0.7.11 ([@starkillerOG] - [#101886])
|
||||
- Fix implicit device name in wiz switch ([@bdraco] - [#101914])
|
||||
|
||||
[#101386]: https://github.com/home-assistant/core/pull/101386
|
||||
[#101547]: https://github.com/home-assistant/core/pull/101547
|
||||
[#101871]: https://github.com/home-assistant/core/pull/101871
|
||||
[#101883]: https://github.com/home-assistant/core/pull/101883
|
||||
[#101884]: https://github.com/home-assistant/core/pull/101884
|
||||
[#101886]: https://github.com/home-assistant/core/pull/101886
|
||||
[#101913]: https://github.com/home-assistant/core/pull/101913
|
||||
[#101914]: https://github.com/home-assistant/core/pull/101914
|
||||
[@bdraco]: https://github.com/bdraco
|
||||
[@frenck]: https://github.com/frenck
|
||||
[@gjohansson-ST]: https://github.com/gjohansson-ST
|
||||
[@starkillerOG]: https://github.com/starkillerOG
|
||||
|
||||
## Release 2023.10.4 - October 21
|
||||
|
||||
- Fix Spotify media position update value ([@Archomeda] - [#100044])
|
||||
- Fix error handling on subscribe when mqtt is not initialized ([@jbouwh] - [#101832])
|
||||
- Bump aioesphomeapi to 17.1.4 ([@bdraco] - [#101897])
|
||||
- Bump aioesphomeapi to 17.1.5 ([@bdraco] - [#101916])
|
||||
- Fix Setpoint in Matter climate platform ([@goloveychuk] - [#101929])
|
||||
- Update zwave issue repair strings ([@raman325] - [#101940])
|
||||
- Bump screenlogicpy to v0.9.3 ([@dieselrabbit] - [#101957])
|
||||
- Bump pynina to 0.3.3 ([@DeerMaximum] - [#101960])
|
||||
- Fix google_maps same last_seen bug ([@pnbruckner] - [#101971])
|
||||
- Bump aioesphomeapi to 17.2.0 ([@bdraco] - [#101981])
|
||||
- Bump aioesphomeapi to 18.0.1 ([@bdraco] - [#102028])
|
||||
- Fix bug in calendar state transitions ([@allenporter] - [#102083])
|
||||
- Call disconnected callbacks from BT ESPHome client ([@abmantis] - [#102084])
|
||||
- Bump aioesphomeapi to 18.0.3 ([@bdraco] - [#102085])
|
||||
- Correct sensor state attribute and device class in Velbus sensors ([@Cereal2nd] - [#102099])
|
||||
- Bump velbusaio to 2023.10.0 ([@Cereal2nd] - [#102100])
|
||||
- Bump zha-quirks to 0.0.105 ([@TheJulianJES] - [#102113])
|
||||
- Fix UniFi client tracker entities being unavailable when away on restart ([@Kane610] - [#102125])
|
||||
- Send events for tts stream start/end ([@jesserockz] - [#102139])
|
||||
- Bump opower to 0.0.36 ([@tronikos] - [#102150])
|
||||
- Explicitly set entity name for VenstarSensor ([@dseven] - [#102158])
|
||||
- Don't warn about unknown pipeline events in ESPHome ([@synesthesiam] - [#102174])
|
||||
- Bump velbusaio to 2023.10.1 ([@Cereal2nd] - [#102178])
|
||||
- Bump aiowaqi to 2.1.0 ([@joostlek] - [#102209])
|
||||
- Handle timeouts on AEMET init ([@Noltari] - [#102289])
|
||||
- Bump pyduotecno to 2023.10.1 ([@Cereal2nd] - [#102344])
|
||||
- Bump ZHA dependencies ([@puddly] - [#102358])
|
||||
- Bump vehicle to 2.0.0 ([@joostlek] - [#102379])
|
||||
- Update aioairzone to v0.6.9 ([@Noltari] - [#102383])
|
||||
- Bump aioesphomeapi to 18.0.6 ([@bdraco] - [#102195])
|
||||
- Bump dbus-fast to 2.12.0 ([@bdraco] - [#102206])
|
||||
- Bump bluetooth-data-tools to 1.13.0 ([@bdraco] - [#102208])
|
||||
- Fix temperature setting for multi-setpoint z-wave device ([@kpine] - [#102395])
|
||||
- Bump aioesphomeapi to 18.0.7 ([@bdraco] - [#102399])
|
||||
|
||||
[#100044]: https://github.com/home-assistant/core/pull/100044
|
||||
[#101386]: https://github.com/home-assistant/core/pull/101386
|
||||
[#101547]: https://github.com/home-assistant/core/pull/101547
|
||||
[#101832]: https://github.com/home-assistant/core/pull/101832
|
||||
[#101871]: https://github.com/home-assistant/core/pull/101871
|
||||
[#101897]: https://github.com/home-assistant/core/pull/101897
|
||||
[#101916]: https://github.com/home-assistant/core/pull/101916
|
||||
[#101929]: https://github.com/home-assistant/core/pull/101929
|
||||
[#101930]: https://github.com/home-assistant/core/pull/101930
|
||||
[#101940]: https://github.com/home-assistant/core/pull/101940
|
||||
[#101957]: https://github.com/home-assistant/core/pull/101957
|
||||
[#101960]: https://github.com/home-assistant/core/pull/101960
|
||||
[#101971]: https://github.com/home-assistant/core/pull/101971
|
||||
[#101981]: https://github.com/home-assistant/core/pull/101981
|
||||
[#102028]: https://github.com/home-assistant/core/pull/102028
|
||||
[#102083]: https://github.com/home-assistant/core/pull/102083
|
||||
[#102084]: https://github.com/home-assistant/core/pull/102084
|
||||
[#102085]: https://github.com/home-assistant/core/pull/102085
|
||||
[#102099]: https://github.com/home-assistant/core/pull/102099
|
||||
[#102100]: https://github.com/home-assistant/core/pull/102100
|
||||
[#102113]: https://github.com/home-assistant/core/pull/102113
|
||||
[#102125]: https://github.com/home-assistant/core/pull/102125
|
||||
[#102139]: https://github.com/home-assistant/core/pull/102139
|
||||
[#102150]: https://github.com/home-assistant/core/pull/102150
|
||||
[#102158]: https://github.com/home-assistant/core/pull/102158
|
||||
[#102174]: https://github.com/home-assistant/core/pull/102174
|
||||
[#102178]: https://github.com/home-assistant/core/pull/102178
|
||||
[#102195]: https://github.com/home-assistant/core/pull/102195
|
||||
[#102206]: https://github.com/home-assistant/core/pull/102206
|
||||
[#102208]: https://github.com/home-assistant/core/pull/102208
|
||||
[#102209]: https://github.com/home-assistant/core/pull/102209
|
||||
[#102289]: https://github.com/home-assistant/core/pull/102289
|
||||
[#102344]: https://github.com/home-assistant/core/pull/102344
|
||||
[#102358]: https://github.com/home-assistant/core/pull/102358
|
||||
[#102379]: https://github.com/home-assistant/core/pull/102379
|
||||
[#102383]: https://github.com/home-assistant/core/pull/102383
|
||||
[#102395]: https://github.com/home-assistant/core/pull/102395
|
||||
[#102399]: https://github.com/home-assistant/core/pull/102399
|
||||
[@Archomeda]: https://github.com/Archomeda
|
||||
[@Cereal2nd]: https://github.com/Cereal2nd
|
||||
[@DeerMaximum]: https://github.com/DeerMaximum
|
||||
[@Kane610]: https://github.com/Kane610
|
||||
[@Noltari]: https://github.com/Noltari
|
||||
[@TheJulianJES]: https://github.com/TheJulianJES
|
||||
[@abmantis]: https://github.com/abmantis
|
||||
[@allenporter]: https://github.com/allenporter
|
||||
[@bdraco]: https://github.com/bdraco
|
||||
[@dieselrabbit]: https://github.com/dieselrabbit
|
||||
[@dseven]: https://github.com/dseven
|
||||
[@frenck]: https://github.com/frenck
|
||||
[@goloveychuk]: https://github.com/goloveychuk
|
||||
[@jbouwh]: https://github.com/jbouwh
|
||||
[@jesserockz]: https://github.com/jesserockz
|
||||
[@joostlek]: https://github.com/joostlek
|
||||
[@kpine]: https://github.com/kpine
|
||||
[@pnbruckner]: https://github.com/pnbruckner
|
||||
[@puddly]: https://github.com/puddly
|
||||
[@raman325]: https://github.com/raman325
|
||||
[@synesthesiam]: https://github.com/synesthesiam
|
||||
[@tronikos]: https://github.com/tronikos
|
||||
|
||||
## Release 2023.10.5 - October 22
|
||||
|
||||
- Downgrade ZHA dependency bellows ([@puddly] - [#102471])
|
||||
- Bump async-upnp-client to 0.36.2 ([@StevenLooman] - [#102472])
|
||||
|
||||
[#102471]: https://github.com/home-assistant/core/pull/102471
|
||||
[#102472]: https://github.com/home-assistant/core/pull/102472
|
||||
[@StevenLooman]: https://github.com/StevenLooman
|
||||
[@puddly]: https://github.com/puddly
|
||||
|
||||
## Need help? Join the community!
|
||||
|
||||
Home Assistant has a great community of users who are all more than willing
|
||||
|
||||
@ -0,0 +1,218 @@
|
||||
---
|
||||
layout: post
|
||||
title: "Year of the Voice - Chapter 4: Wake words"
|
||||
description: "Activate your voice assistant using wake words and learn how to make your own"
|
||||
date: 2023-10-12 00:00:00
|
||||
date_formatted: "October 12, 2023"
|
||||
author: Paulus Schoutsen
|
||||
comments: true
|
||||
categories: Assist
|
||||
og_image: /images/blog/2023-10-12-year-of-the-voice-chapter-4/social.png
|
||||
---
|
||||
|
||||
<p><img src='/images/blog/2023-10-12-year-of-the-voice-chapter-4/social.png' class='no-shadow' /></p>
|
||||
|
||||
This year is Home Assistant’s [Year of the Voice](https://www.home-assistant.io/blog/2022/12/20/year-of-voice/). It is our goal for 2023 to let users control Home Assistant by speaking in their own language.
|
||||
|
||||
We’ve got great news: wake words are finally here! After 4 chapters, we now have the final building block for voice in Home Assistant.
|
||||
|
||||
In [Chapter 1](https://www.home-assistant.io/blog/2023/01/26/year-of-the-voice-chapter-1/), we started with text commands such as “turn on the kitchen light” and “open garage door”. We now [support 56 languages](https://home-assistant.github.io/intents/) and have 188 contributors helping to translate common smart home commands for everyone.
|
||||
|
||||
[Chapter 2](https://www.home-assistant.io/blog/2023/04/27/year-of-the-voice-chapter-2/) introduced audio for voice commands: both speech-to-text and text-to-speech. This included local options for maximum privacy as well as support for Home Assistant Cloud for incredible speed and language coverage. Lastly in [Chapter 3](https://www.home-assistant.io/blog/2023/07/20/year-of-the-voice-chapter-3/), we added the ability to set Home Assistant as your default assistant on Android phones and watches.
|
||||
|
||||
For Chapter 4, we’ve now added wake word processing inside Home Assistant. Wake words are special words or phrases that tell a voice assistant that a command is about to be spoken. Examples are: Hey Google, Hey Siri or Alexa.
|
||||
|
||||
Home Assistant’s wake words are leveraging a new project called [openWakeWord] by David Scripka. This project has real-world accuracy, runs on commodity hardware and anyone can [train a basic model of their own wake word][own-wake-word] in an hour, for free.
|
||||
|
||||
To try wake words today, follow our updated guide to [the $13 voice assistant][13-tutorial].
|
||||
|
||||
<lite-youtube videoid="ziebKt4XLZQ" videotitle="Wake word demonstration on $13 ATOM Echo in Home Assistant"></lite-youtube>
|
||||
|
||||
<lite-youtube videoid="vQ7Hmeume9g" videotitle="Wake word demonstration on ESPHome-based 3D printed droid in Home Assistant"></lite-youtube>
|
||||
|
||||
To watch the video presentation of this blog post, including live demos, check [the recording of our live stream.](https://www.youtube.com/watch?v=YzgYYkOrnhQ)
|
||||
|
||||
<!--more-->
|
||||
|
||||
## Wake words in Home Assistant
|
||||
|
||||
Wake words are hard to build. They are based on AI, there is little room for false positives, and they need to run extremely fast: as fast audio as comes in. You can’t have a voice assistant start listening 5 seconds after a wake word is spoken. Voice satellite hardware generally does not have a lot of computing power so wake word engines need hardware experts to optimise the models to run smoothly.
|
||||
|
||||
We didn’t want to limit ourselves to a single type of hardware, so we decided to change the approach: we do the wake word detection inside Home Assistant. Voice satellite devices will constantly sample current audio in your room for voice. When it detects voice, the satellite will send audio to Home Assistant where it will check if the wake word was said and handle the command that followed it.
|
||||
|
||||
<p class='img'>
|
||||
<img src='/images/blog/2023-10-12-year-of-the-voice-chapter-4/wake-word-architecture.png'>
|
||||
Overview of the wake word architecture
|
||||
</p>
|
||||
|
||||
The advantage of this approach is that any device that streams audio can be turned into a voice satellite, even if it doesn't have enough power to do wake word detection locally. It also allows our developer community to easily experiment with new wake word models as they don’t have to first shrink it to be able to run on a low-powered voice satellite device.
|
||||
|
||||
To try it out, follow our updated tutorial to [create your own $13 voice assistant.][13-tutorial]
|
||||
|
||||
<lite-youtube videoid="ziebKt4XLZQ" videotitle="Wake word demonstration on $13 ATOM Echo in Home Assistant"></lite-youtube>
|
||||
|
||||
There are downsides to this approach. The first is that the quality of the captured audio differs. A speakerphone with multiple microphones and audio processing chips captures voice very cleanly. A device with a single microphone and no post-processing? Not so much. We compensate for poor audio quality with audio post-processing inside Home Assistant and users can use better speech-to-text models to improve accuracy like the one included with Home Assistant Cloud.
|
||||
|
||||
The other downside of this approach is that each satellite requires ongoing resources inside Home Assistant when it’s streaming audio. With our current approach, users can run 5 voice satellites without overwhelming a Raspberry Pi 4 (assuming all satellites are streaming at the same time). To scale up, we’ve updated [the Wyoming protocol][wyoming] to allow users to run wake word detection on an external server.
|
||||
|
||||
_Wyoming is our protocol allowing to run parts of a voice assistant in other programs and/or computers_
|
||||
|
||||
<p class='img'>
|
||||
<img src='/images/blog/2023-10-12-year-of-the-voice-chapter-4/pick-wake-word.png'>
|
||||
Users can pick per configured voice assistant what wake word to listen for
|
||||
</p>
|
||||
|
||||
## openWakeWord
|
||||
|
||||
For the built-in wake words, we rely on [openWakeWord] by David Scripka. It’s a technological marvel that is created with 4 goals in mind:
|
||||
|
||||
- Be fast enough for real-world usage
|
||||
- Be accurate enough for real-world usage
|
||||
- Have a simple model architecture and inference process
|
||||
- Require little to no manual data collection to train new models
|
||||
|
||||
To achieve its goals, openWakeWord is built around an open source audio embedding model trained by Google and fine-tuned using our text-to-speech system [Piper]. Piper is used to generate many thousands of audio clips for each wake word using a unique approach that creates endless variations of different speakers. These audio clips are then augmented to sound as if they were spoken in multiple kinds of rooms, at specific distances from a microphone, and with varying speeds. Finally, the clips are mixed with background noise like music, environmental sounds, and conversation before being fed into the training process to generate the wake word model.
|
||||
|
||||
<p class='img'>
|
||||
<img src='/images/blog/2023-10-12-year-of-the-voice-chapter-4/open-wake-word-architecture.png'>
|
||||
Overview of the openWakeWord training pipeline.
|
||||
</p>
|
||||
|
||||
Home Assistant runs openWakeWord as an add-on and comes with various wake word models by default, including our “Okay Nabu” model. Click the button below to install it.
|
||||
|
||||
{% my supervisor_addon badge addon="core_openwakeword" %}
|
||||
|
||||
Once installed, the add-on will be discovered via the Wyoming integration.
|
||||
|
||||
OpenWakeWord currently only works for English wake words. This is because we lack models of other languages with many different speakers. Similar models for other languages can be trained as more multi-speaker models per language become available.
|
||||
|
||||
_If you’re not running Home Assistant OS, openWakeWord is also available as [a Docker container](https://github.com/rhasspy/wyoming-openwakeword#docker-image). Once the container is running, you will need to add the Wyoming integration and point it at its IP address and port (typically 10400)._
|
||||
|
||||
## Make your own wake word
|
||||
|
||||
What makes openWakeWord unique is its ability to fine tune Google’s model, trained on clips from real voices, with fake voice clips generated by Piper. This makes it possible to create your own wake words without collecting samples from real people (though real samples can improve the outcome).
|
||||
|
||||
David created a Google Collab notebook to create your own openWakeWord model. Enter your desired wake word and an hour later you get your own wake word (using the free computing available to all Google Collab users).
|
||||
|
||||
To get started, see our new ["create your own wake word"-tutorial.][own-wake-word]
|
||||
|
||||
The models generated with the notebook will perform reasonably well. They will not perform as well as the ones bundled with Home Assistant which have received a lot of extensive training.
|
||||
|
||||
<p class='img'>
|
||||
<img src="/images/assist/wake_word_enter_target_word.png">
|
||||
Screenshot of the wake word generation notebook
|
||||
</p>
|
||||
|
||||
## Other wake word engines
|
||||
|
||||
In Home Assistant, we ship our defaults but allow a user to configure each part of their voice assistants. This also applies to our wake words.
|
||||
|
||||
Wake word engines can integrate with Home Assistant by adding them as an integration or run them as a standalone program that communicates with Home Assistant via [the Wyoming protocol][wyoming].
|
||||
|
||||
<p class='img'>
|
||||
<img src='/images/blog/2023-10-12-year-of-the-voice-chapter-4/wake-word-integration.png'>
|
||||
How wake words integrate into Home Assistant
|
||||
</p>
|
||||
|
||||
As an example, we’re also making the Porcupine (v1) wake word engine available. It supports 29 wake words across English, French, Spanish and German, including Computer, Framboise, Manzana and Stachelschwein.
|
||||
|
||||
{% my supervisor_addon badge addon="47701997_porcupine1" repository_url="https://github.com/rhasspy/hassio-addons" %}
|
||||
|
||||
## Reuse and repurpose: different ways to create a voice satellite
|
||||
|
||||
We’re building our voice assistant based on our Open Home vision: a smart home that values privacy, choice and sustainability. Two words that are often mentioned as part of sustainability are reuse and repurpose.
|
||||
|
||||
Since our voice satellite is only responsible for capturing audio, a lot of devices one might have in their “old tech” drawer can be given a new life and purpose as a voice satellite.
|
||||
|
||||
When audio is captured via USB, we recommend using a USB speakerphone because they contain audio processing chips that clean up the audio and enhance voices. They also come with a speaker and look a bit like one expects a voice satellite to look. We had great results in our testing with the [Anker PowerConf S330]. It did require a firmware update before it could be used with Home Assistant.
|
||||
|
||||
_Some USB speakerphones will require a powered USB hub because of power limits on the Raspberry Pi’s USB ports._
|
||||
|
||||
## Turn Home Assistant into a voice satellite
|
||||
|
||||
You can configure your device running Home Assistant to capture audio and turn it into a voice assistant. To do this, you need to plug in a USB microphone or speakerphone and configure the Assist microphone add-on. Your Home Assistant device may need to be rebooted before the microphone is usable.
|
||||
|
||||
{% my supervisor_addon badge addon="47701997_assist_microphone" repository_url="https://github.com/rhasspy/hassio-addons" %}
|
||||
|
||||
<p class='img'>
|
||||
<img src='/images/blog/2023-10-12-year-of-the-voice-chapter-4/assist-microphone-addon.png'>
|
||||
Home Assistant Blue with a speakerphone
|
||||
</p>
|
||||
|
||||
## Turn any ESP32 into a voice satellite using ESPHome
|
||||
|
||||
[ESPHome] is our firmware to allow users to easily create devices for their smart home. In Year of the Voice - Chapter 2, we’ve added support for ESPHome to accept voice commands when a user pushes a button.
|
||||
|
||||
Today, that support is extended to allow any ESP32 device with an i2s microphone to become a voice satellite for Home Assistant.
|
||||
|
||||
<p class='img'>
|
||||
<img src='/images/blog/2023-10-12-year-of-the-voice-chapter-4/ESP32-breadboard.jpeg'>
|
||||
Voice assistant on a breadboard.
|
||||
</p>
|
||||
|
||||
Recommended parts:
|
||||
|
||||
- Microphone: [M5Stack PDM MEMS Microphone Unit (SPM1423)](https://shop.m5stack.com/products/pdm-microphone-unit-spm1423?ref=NabuCasa) or [INMP441 Omnidirectional i2s microphone](https://www.amazon.com/DAOKI-Omnidirectional-Microphone-Interface-Precision/dp/B0821521CV?crid=15LDQX6CCO0TU&keywords=dollatek+INMP441+i2s+microphone&qid=1697133224&sprefix=dollatek+inmp441+i2s+microphone%2Caps%2C53&sr=8-3&linkCode=li2&tag=homeassista0e-20&linkId=387c46c81aea5223b6a2dc46fe30071c&language=en_US&ref_=as_li_ss_il)
|
||||
- DAC/Amp: [MAX98357 I2S 3W Class D Amp DAC](https://www.aliexpress.us/item/3256804094226058.html?algo_pvid=abd6f27c-cf43-4bb7-aad5-59db93afeef2&algo_exp_id=abd6f27c-cf43-4bb7-aad5-59db93afeef2-2&pdp_npi=4@dis!USD!0.75!0.75!!!0.75!!@2101c6e316970730845818417e16ee!12000028612275493!sea!US!171596461!&curPageLogUid=KcAyDJivsXHt)
|
||||
|
||||
[Example configuration](https://github.com/esphome/firmware/blob/main/voice-assistant/m5stack-atom-echo.yaml)
|
||||
|
||||
_This method requires users to have basic experience with configuring ESPHome devices._
|
||||
|
||||
## Turn any old Raspberry Pi into a voice satellite
|
||||
|
||||
We’ve made [homeassistant-satellite](https://github.com/synesthesiam/homeassistant-satellite) available that allows you to connect a USB microphone or speakerphone to an old Raspberry Pi, or any other Linux computer, and turn it into a voice satellite for Home Assistant.
|
||||
|
||||
<lite-youtube videoid="JeyZ4HQARMc" videotitle="Wake word demonstration on Raspberry Pi and custom ESP32 board in Home Assistant"></lite-youtube>
|
||||
|
||||
_While any Linux computer works, we recommend limiting it to ARM-based processors because they use a lot less energy._
|
||||
|
||||
_This method requires users to know how to install applications on a Linux system._
|
||||
|
||||
## Voice office hours for scientists
|
||||
|
||||
We want Home Assistant to be used as a platform for scientists that are developing new wake word, speech-to-text and text-to-speech engines. Working with Home Assistant allows you to try your model as part of a voice assistant in a real world scenario. The Home Assistant community loves new technology and will be great in testing it out and providig feedback.
|
||||
|
||||
Engines can be plugged Home Assistant’s voice pipelines using [the Wyoming protocol][wyoming]. While small, the Wyoming protocol can be tricky to get right for first time integrators. If you’re such a person, reach out to us at [voice@nabucasa.com](mailto:voice@nabucasa.com) and we’ll help you integrate.
|
||||
|
||||
## What's next
|
||||
|
||||
Now that the foundation is in place for all parts of a voice assistant, it will be easier for us to share what we are going to work on next.
|
||||
|
||||
We want to work towards supporting the most common tasks that people use with other voice assistants. This includes support for multiple shopping lists, timers and weather forecasts.
|
||||
|
||||
To improve accuracy, openWakeWord allows further fine-tuning of the model with recordings made by the user via their own voice satellite. We want users to be able to easily record themselves and let Home Assistant create this improved model.
|
||||
|
||||
On the voice satellite side we're going to integrate more advanced audio processing to improve wake word and Speech-to-Text accuracy. We will also do another attempt at getting wake words running inside ESPHome.
|
||||
|
||||
The voice satellite improvements will require more advanced hardware and we're aiming for the ESP32 S3 Box 3. This is the new variant of the now discontinued ESP32 S3 Box (and lite version). Espressif told us that it will be in stock soon.
|
||||
|
||||
If you already have an ESP32 S3 Box variant, you can install [our ESPHome configuration](https://github.com/esphome/firmware/tree/main/voice-assistant) to receive these updates as they come available.
|
||||
|
||||
## That's a wrap!
|
||||
|
||||
We hope that you enjoy the wake words and that you set up voice satellites around your house. Let us know how it goes and share your experience with us.
|
||||
|
||||
See you soon in chapter 5!
|
||||
|
||||
## Thank You
|
||||
|
||||
A big thanks to David Scripka for openWakeWord. Thanks to Jesse Hills for his patience and support while Mike and I explored wake word architectures and help ESPHome fit in. Big thanks to everyone at Nabu Casa who has helped make and review today's content.
|
||||
|
||||
Thank you to the Home Assistant community for subscribing to [Home Assistant Cloud][nabucasa] to support Year of the Voice and development of Home Assistant, ESPHome and other projects in general.
|
||||
|
||||
Thanks to our language leaders for extending the sentence support to all the various languages.
|
||||
|
||||
<p class='img'>
|
||||
<img src='/images/blog/2023-10-12-year-of-the-voice-chapter-4/ha-support.png' alt="Thank you for supporting the Home Assistant project">
|
||||
</p>
|
||||
|
||||
[wyoming]: https://github.com/rhasspy/wyoming
|
||||
[13-tutorial]: /voice_control/thirteen-usd-voice-remote/
|
||||
[openWakeWord]: https://github.com/dscripka/openWakeWord
|
||||
[Piper]: https://github.com/rhasspy/piper/
|
||||
[own-wake-word]: /voice_control/create_wake_word/
|
||||
[my-wake-word-addon]: https://my.home-assistant.io/redirect/supervisor_addon/?addon=core_openwakeword
|
||||
[Anker PowerConf S330]: https://amzn.to/3tzXUhD
|
||||
[ESPHome]: https://esphome.io
|
||||
[nabucasa]: https://www.nabucasa.com
|
||||
@ -0,0 +1,20 @@
|
||||
---
|
||||
layout: post
|
||||
title: "Removal of Mazda Connected Services integration"
|
||||
description: "Why the integration has been removed from Home Assistant in 2023.10.2."
|
||||
date: 2023-10-13 00:00:00
|
||||
date_formatted: "October 13, 2023"
|
||||
author: Paulus Schoutsen
|
||||
comments: true
|
||||
categories: Public-Service-Announcement
|
||||
---
|
||||
|
||||
On October 11, 2023, we were informed that an open-source contributor received a cease and desist letter from Mazda North American Operations (Mazda) regarding his library to connect with Mazda services. This library was used by the Home Assistant integration Mazda Connected Services, which he also maintained. A [DMCA notice](https://github.com/github/dmca/blob/master/2023/10/2023-10-10-mazda.md) was sent to GitHub requesting the removal of all code and forked repositories as well.
|
||||
|
||||
The contributor has complied with the cease and desist letter. The library is no longer available, and the Mazda Connected Services integration has been removed from Home Assistant in the 2023.10.2 patch release of Home Assistant released on October 12, 2023.
|
||||
|
||||
Home Assistant is disappointed that Mazda has decided to take this position. We’re also sad that Mazda’s first recourse was not to reach out to us and the maintainer but to send a cease and desist letter instead.
|
||||
|
||||
We invite Mazda to speak with us about this topic. We would love to have an open and constructive discussion about the potential that a Home Assistant integration has for them and their customers. We genuinely believe there is a common ground between us and Mazda when it comes to enabling the owners of their cars to explore the possibilities of their own data.
|
||||
|
||||
After all, other car manufacturers do see this potential. For example, Tesla has recently released [official API documentation](https://developer.tesla.com/docs/fleet-api) to support third-party apps. Volkswagen Group’s Audi brand has [launched an app store in their cars](https://cariad.technology/de/en/news/stories/launch-application-store-for-volkswagen-group.html) that features the Home Assistant app. We hope Mazda will see this potential, as well.
|
||||
@ -0,0 +1,56 @@
|
||||
---
|
||||
layout: post
|
||||
title: "Home Assistant OS 11: Low-latency scheduler and VM snapshot improvements"
|
||||
description: "Home Assistant OS 11 released with low-latency scheduler enabled and VM snapshot improvements on KVM/Proxmox."
|
||||
date: 2023-10-14 00:00:00
|
||||
date_formatted: "October 14, 2023"
|
||||
author: Stefan Agner
|
||||
comments: true
|
||||
categories:
|
||||
- Announcements
|
||||
---
|
||||
With Home Assistant OS 11, there is no big or flashy feature to highlight. Rather, there are a lot of small improvements and little gems. The increased use of Bluetooth has uncovered quite some issues on Home Assistant OS; some of which we are still working on. One of the main issues in Home Assistant OS 10 was caused by a bug in the processing of Bluetooth advertisements in the Linux kernel’s Bluetooth stack itself. With the help of our community, we managed to reproduce, pinpoint, and provide the necessary hints to the Bluetooth developers. This led to a fix in the Bluetooth stack not only for Home Assistant OS and Supervised users but for the Linux community in general 🎉 (see issue https://github.com/home-assistant/operating-system/issues/2535 for details).
|
||||
|
||||
We’ve also worked on the landing page which is bundled with Home Assistant OS 11. The landing page is visible to the user when starting a fresh installation of Home Assistant OS for the first time. It features the same new look as the Home Assistant Core onboarding flow, and tracks issues during the bootstrapping phase, automatically displaying errors if they occur during that critical setup phase.
|
||||
|
||||
<img src='/images/blog/2023-10-14-home-assistant-os-11/home-assistant-os-11-landing-page.png' alt='Screenshot of the new Home Assistant landing page'>
|
||||
|
||||
The new landing page shipped with Home Assistant OS 11
|
||||
|
||||
This month we at Nabu Casa got a new addition to the Home Assistant OS team: With [Jan Čermák](https://github.com/sairon) joining, we will have more bandwidth to implement new features as well as to tackle issues reported by our community. Welcome Jan!
|
||||
|
||||
And finally: Home Assistant OS 11 will be pre-installed in the next batch of Home Assistant Green 🎉
|
||||
|
||||
Enjoy the latest version of Home Assistant OS!
|
||||
|
||||
Stefan
|
||||
|
||||
<!--more-->
|
||||
|
||||
- [Linux' preemptible kernel configuration](#linux-preemptible-kernel-configuration)
|
||||
- [VM filesystem freeze is being relayed to Home Assistant](#vm-filesystem-freeze-is-being-relayed-to-home-assistant)
|
||||
- [Docker and containerd upgrades](#docker-and-containerd-upgrades)
|
||||
- [More Highlights in Home Assistant OS 11](#more-highlights-in-home-assistant-os-11)
|
||||
|
||||
|
||||
## Linux' preemptible kernel configuration
|
||||
We've applied Linux's preemptible kernel configuration across the board. The result is lower latencies even on busy systems (for example due to slow I/O operations), making your smart home even more responsive.
|
||||
|
||||
## VM filesystem freeze is being relayed to Home Assistant
|
||||
VM filesystem freeze (as triggered by VM snapshots) is a neat feature for more advanced setups based on Proxmox (or other KVM based VMs).
|
||||
Today, Home Assistant's recorder integration uses a database underneath (by default this is SQLite). When Home Assistant takes a backup, the Supervisor notifies the database engine before copying the database files (currently, this is implemented for SQLite and MariaDB). So far, this didn't work for VM filesystem freezes With that notification, the database engine can take the necessary steps to ensure that the database files are in a consistent state before the backup takes place.
|
||||
However, when creating a snapshot using the VM snapshot feature, the database doesn’t know about this, and the snapshot can end up with an inconsistent state of the database. On snapshot restore, the database may or may not be able to recover from that inconsistent state. This can lead to partial or even complete data loss of the recorder data.
|
||||
With Home Assistant OS 11, on Proxmox/KVM-based VMs, when using the snapshot feature, the file system freeze is now relayed to Home Assistant. Home Assistant then uses the same notification mechanism as backups are using. This ensures that VM snapshots are always coherent, making sure rollbacks of your smart home systems are reliable.
|
||||
|
||||
## Docker and containerd Upgrades
|
||||
|
||||
In this release, Home Assistant OS has adopted the latest versions of Docker (v24.0.6) and containerd (v1.7.6), ensuring better performance and container management. We’ve also improved the containerd configuration to drop unnecessary components. With this, containerd uses less CPU and memory resources, ensuring better overall performance.
|
||||
|
||||
## More Highlights in Home Assistant OS 11
|
||||
|
||||
- **Consistent network interface naming**: On Arm-based boards, network names are now enumerated based on the device tree. This means that the first Ethernet device will no longer be named eth0 but end0. The same network configuration used previously is automatically applied to the network interface with the new name.
|
||||
**This can be a breaking change ⚠️**: If you use the name of the Ethernet interface in custom scripts or automation, you'll have to adjust to the new name (as shown in the network settings)!
|
||||
- **Bluetooth improvements**: Updating to a newer version of BlueZ, fix for the Bluetooth LE advertisement stall bug, and optimizing Bluetooth device cache management.
|
||||
- **Improved kernel configuration**: Our improved kernel configuration aims to improve Docker's overlayfs performance, making container operations smoother.
|
||||
- **Support for LED control on Home Assistant Green**: The three LEDs on the front of Home Assistant Green can now be controlled through hardware settings.
|
||||
- **Adjusted development workflow** (my personal favorite, but I might be biased 😉): Our adjusted development workflow allows for more incremental changes and incorporates more automations. This will make it easier for developers to work on and improve Home Assistant OS.
|
||||
@ -0,0 +1,22 @@
|
||||
---
|
||||
layout: post
|
||||
title: "Expected support for Home Assistant OS on the Raspberry Pi 5"
|
||||
description: "Stable support for Home Assistant OS on Raspberry Pi 5 expected end 2023/early 2024"
|
||||
date: 2023-10-17 00:00:00
|
||||
date_formatted: "October 17, 2023"
|
||||
author: Stefan Agner
|
||||
comments: true
|
||||
categories:
|
||||
- Announcements
|
||||
---
|
||||
On September 28, Raspberry Pi surprised the world (and, truthfully, us) by announcing the [Raspberry Pi 5](https://www.raspberrypi.com/news/introducing-raspberry-pi-5/). This new board promises more than twice the speed of the Raspberry Pi 4 and is already available for pre-order. Raspberry Pi expects to ship them to customers by the end of October.
|
||||
|
||||
According to our [analytics](https://analytics.home-assistant.io/), a third of all Home Assistant users currently use the Raspberry Pi 4 as their dedicated Home Assistant system. In fact, Home Assistant OS is the [third-most installed OS](https://rpi-imager-stats.raspberrypi.com/) on Raspberry Pi boards in general. So, we suspect many of you eagerly await the new Raspberry Pi 5 to upgrade your Home Assistant installation. We’re just as excited about this new release as you are, and we will start development for it as soon as we receive our pre-release boards from Raspberry Pi!
|
||||
|
||||
As we have not been part of Raspberry Pi’s beta program, adding support for the Raspberry Pi 5 to Home Assistant OS has not started yet. At this point, it is still hard to estimate how much work it will be, but we want to stress that this is a major task that we want to get right. While beta versions will be released early, we currently do not expect a stable release to come out until the end of this year or early 2024.
|
||||
|
||||
That means you cannot run Home Assistant OS on the Raspberry Pi 5 at launch. [Alternative installation methods](/installation/) that do not use Home Assistant OS are available, but we only recommend those for advanced users. If you currently use Home Assistant OS and have pre-ordered a Raspberry Pi 5, we recommend waiting for a stable release for the Raspberry Pi 5 to come out before moving your installation.
|
||||
|
||||
For owners of Home Assistant Yellow, Raspberry Pi has yet to make any statement about a potential Compute Module 5 based on the Raspberry Pi 5. We can only indicate compatibility with Home Assistant Yellow once they provide information about a new Compute Module and its specifications. We also want to point out that there were 16 months between the release of the Raspberry Pi 4 and the release of the Compute Module 4. For those currently looking for Compute Module 4 to complete their Home Assistant Yellow kits, we are happy to report that Compute Module 4 has become more widely available again, as seen on [rpilocator](https://rpilocator.com/?cat=CM4).
|
||||
|
||||
**Update (Oct 19th)**: We received Raspberry Pi 5 boards earlier this week and are investigating support options for Home Assistant OS now. Thank you to the folks at Raspberry Pi! For those interested in technical discussions about Raspberry Pi 5 support or just would like to follow the progress, we've started a [Raspberry Pi 5 specific thread on GitHub Discussions](https://github.com/home-assistant/operating-system/discussions/2844).
|
||||
@ -0,0 +1,29 @@
|
||||
---
|
||||
layout: post
|
||||
title: "Security audits of Home Assistant"
|
||||
description: "Home Assistant hired Cure53 to do a security audit as part of our regular security assessments. You are safe. No authentication bypasses have been found."
|
||||
date: 2023-10-19 00:00:00
|
||||
date_formatted: "October 19, 2023"
|
||||
author: Paulus Schoutsen & Franck Nijhof
|
||||
comments: true
|
||||
categories:
|
||||
- Announcements
|
||||
---
|
||||
|
||||
_Summary: Home Assistant had two security audits done as part of our regular security assessments. You are safe. No authentication bypasses have been found. We did fix issues related to attackers potentially tricking users to take over their instance. All fixes are included in Home Assistant 2023.9 (released on September 6, 2023) and the latest Home Assistant apps for iOS and Android. Please make sure you’re up-to-date._
|
||||
|
||||
Security is very important to us at Home Assistant and Nabu Casa. Being open source makes it easy to let anyone audit our code—and based on reported issues—people do. However, you also need to hire people to do an actual security audit to ensure that all the important code has been covered.
|
||||
|
||||
Subscribing to [Home Assistant Cloud](https://www.nabucasa.com/) provides funding for the ongoing development and maintenance of Home Assistant, including external security audits. To ensure that our security is top-notch, Nabu Casa hired Cure53 to perform a security audit of critical parts of Home Assistant. [Cure53](https://cure53.de/) is a well-known cybersecurity firm that in the past found vulnerabilities in [Mastodon](https://arstechnica.com/security/2023/07/mastodon-fixes-critical-tootroot-vulnerability-allowing-node-hijacking/) and [Ring products](https://foundation.mozilla.org/en/blog/mozilla-publishes-ring-doorbell-vulnerability-following-amazons-apathy/).
|
||||
|
||||
Cure53 found issues in Home Assistant, 3 of which were marked as “critical” severity. The critical issues would allow an attacker to trick users and steal login credentials. All reported issues have been addressed as part of Home Assistant 2023.9, released on September 6, 2023. No authentication bypass issues have been found. According to Cure53’s report:
|
||||
|
||||
> The quality of the codebase was impressive on the whole, whilst the architecture and frameworks deployed in all relevant application areas resilient design paradigms in general. Frontend security in particular exhibited ample opportunities for hardening, as compounded by the Critical associated risks identified. Nonetheless, once these have been mitigated, an exemplary security posture will certainly be attainable.
|
||||
|
||||
In August, the [GitHub Security Lab](https://securitylab.github.com/) also audited Home Assistant. They found six non-critical issues across Home Assistant Core and our iOS and Android apps. Two of the issues overlapped with Cure53. All reported issues have been fixed and released.
|
||||
|
||||
We want to thank both teams for their audits, reported issues, and keeping our users safe 🙏
|
||||
|
||||
All found issues have been added to [our security page](/security). This page has been updated to include an ongoing timeline of reported issues, who disclosed it, and a link to the issue report on GitHub.
|
||||
|
||||
_If you think you have found a security issue, check out [our security page](/security) on how to report this to Home Assistant._
|
||||
@ -16,6 +16,7 @@ layout: null
|
||||
/feature-requests https://community.home-assistant.io/c/feature-requests
|
||||
/issues https://github.com/home-assistant/core/issues
|
||||
/community https://community.home-assistant.io/
|
||||
/latest-security-alert /security/
|
||||
|
||||
# Link to latest release note
|
||||
/latest-release-notes/ {{ recent_release_post.url }}{{ site.patch_version_notes }} 302!
|
||||
@ -150,24 +151,45 @@ layout: null
|
||||
/components/telegram_bot.webhooks /integrations/telegram_webhooks
|
||||
/components/vacuum.mqtt /integrations/vacuum.mqtt
|
||||
/components/vacuum.template /integrations/vacuum.template
|
||||
/integrations/binary_sensor.group /integrations/group
|
||||
/integrations/binary_sensor.knx /integrations/knx#binary-sensor
|
||||
/integrations/binary_sensor.modbus /integrations/modbus/#configuring-binary-sensor-entities
|
||||
/integrations/binary_sensor.mysensors /integrations/mysensors#binary-sensor
|
||||
/integrations/binary_sensor.template /integrations/template/#binary_sensor
|
||||
/integrations/climate.knx /integrations/knx#climate
|
||||
/integrations/climate.modbus/ /integrations/modbus/#configuring-climate-entities
|
||||
/integrations/climate.mysensors /integrations/mysensors#climate
|
||||
/integrations/cover.command_line /integrations/command_line#Cover
|
||||
/integrations/cover.group /integrations/group
|
||||
/integrations/cover.knx /integrations/knx#cover
|
||||
/integrations/cover.mysensors /integrations/mysensors#cover
|
||||
/integrations/device_tracker.mysensors /integrations/mysensors#device-tracker
|
||||
/integrations/light.mysensors /integrations/mysensors#light
|
||||
/integrations/notify.mysensors /integrations/mysensors#notify
|
||||
/integrations/sensor.mysensors /integrations/mysensors#sensor
|
||||
/integrations/switch.mysensors /integrations/mysensors#switch
|
||||
/integrations/binary_sensor.group /integrations/group
|
||||
/integrations/cover.group /integrations/group
|
||||
/integrations/fan.group /integrations/group
|
||||
/integrations/fan.xiaomi_miio /integrations/xiaomi_miio/#xiaomi-air-purifier-air-humidifier-and-standing-fan
|
||||
/integrations/light.group /integrations/group
|
||||
/integrations/light.knx /integrations/knx#light
|
||||
/integrations/light.mysensors /integrations/mysensors#light
|
||||
/integrations/light.xiaomi_miio /integrations/xiaomi_miio/#xiaomi-philips-light
|
||||
/integrations/media_player.group /integrations/group
|
||||
/integrations/notify.group /integrations/group#notify-groups
|
||||
/integrations/cover.command_line /integrations/command_line#Cover
|
||||
/integrations/notify.command_line /integrations/command_line#Notify
|
||||
/integrations/notify.group /integrations/group#notify-groups
|
||||
/integrations/notify.knx /integrations/knx#notify
|
||||
/integrations/notify.mysensors /integrations/mysensors#notify
|
||||
/integrations/remote.xiaomi_miio /integrations/xiaomi_miio/#xiaomi-ir-remote
|
||||
/integrations/sensor.buienradar /integrations/buienradar/#sensor
|
||||
/integrations/sensor.command_line /integrations/command_line#Sensor
|
||||
/integrations/sensor.knx /integrations/knx#sensor
|
||||
/integrations/sensor.modbus /integrations/modbus/#configuring-sensor-entities
|
||||
/integrations/sensor.mysensors /integrations/mysensors#sensor
|
||||
/integrations/sensor.websocket_api /integrations/websocket_api/#track-current-connections
|
||||
/integrations/sensor.xiaomi_miio /integrations/xiaomi_miio
|
||||
/integrations/switch.command_line /integrations/command_line#Switch
|
||||
/integrations/switch.knx /integrations/knx#switch
|
||||
/integrations/switch.modbus /integrations/modbus/#configuring-switch-entities
|
||||
/integrations/switch.mysensors /integrations/mysensors#switch
|
||||
/integrations/switch.pca /integrations/elv/
|
||||
/integrations/switch.xiaomi_miio /integrations/xiaomi_miio/#xiaomi-smart-wifi-socket-and-smart-power-strip
|
||||
/integrations/vacuum.xiaomi_miio /integrations/xiaomi_miio/#xiaomi-mi-robot-vacuum
|
||||
|
||||
/components/air_pollutants.* /integrations/:splat
|
||||
/components/air_quality.* /integrations/:splat
|
||||
@ -214,6 +236,7 @@ layout: null
|
||||
/integrations/telegram_chatbot /integrations/telegram_bot
|
||||
/integrations/vlc-telnet /integrations/vlc_telnet
|
||||
/integrations/xiaomi /integrations/xiaomi_aqara
|
||||
/integrations/zwave /integrations/zwave_js/
|
||||
|
||||
# Moved documentation
|
||||
/details/database /docs/backend/database
|
||||
@ -467,6 +490,7 @@ layout: null
|
||||
/integrations/dht /more-info/removed-integration 301
|
||||
/integrations/digitalloggers /more-info/removed-integration 301
|
||||
/integrations/duke_energy /more-info/removed-integration 301
|
||||
/integrations/dyson /more-info/removed-integration 301
|
||||
/integrations/edp_redy /more-info/removed-integration 301
|
||||
/integrations/ee_brightbox /more-info/removed-integration 301
|
||||
/integrations/envirophat /more-info/removed-integration 301
|
||||
@ -497,6 +521,7 @@ layout: null
|
||||
/integrations/loopenergy /more-info/removed-integration 301
|
||||
/integrations/lyft /more-info/removed-integration 301
|
||||
/integrations/magicseaweed /more-info/removed-integration 301
|
||||
/integrations/mazda /more-info/removed-integration 301
|
||||
/integrations/mcp23017 /more-info/removed-integration 301
|
||||
/integrations/mhz19 /more-info/removed-integration 301
|
||||
/integrations/miflora /integrations/xiaomi_ble
|
||||
|
||||
@ -41,7 +41,7 @@ The documentation covers beginner to advanced topics around the installation, se
|
||||
<div class='img-container'>
|
||||
<img src='/images/assist/assist-icon.svg' />
|
||||
</div>
|
||||
<div class='title'>Voice control</div>
|
||||
<div class='title'>Voice assistant</div>
|
||||
</a>
|
||||
</div>
|
||||
|
||||
|
||||
@ -46,6 +46,6 @@ In this step, you will create the owner's account of Home Assistant. This accoun
|
||||
|
||||
|
||||
7. Finally, select **Finish**.
|
||||
- Now you're brought to the Home Assistant web interface. If some of your devices were discovered and setup automatically, this default dashboard may already show some of your devices.
|
||||
- Now you're brought to the Home Assistant web interface. If some of your devices were discovered and set up automatically, this default dashboard may already show some of your devices.
|
||||
|
||||
{% include getting-started/next_step.html step="Concepts & Terminology" link="/getting-started/concepts-terminology/" %}
|
||||
|
||||
@ -2432,6 +2432,24 @@ frontpage_image: /images/frontpage/green-frontpage.png
|
||||
</div>
|
||||
</a>
|
||||
|
||||
<a
|
||||
href="https://thepihut.com/products/home-assistant-green"
|
||||
target="_blank"
|
||||
>
|
||||
<div class="distributor">
|
||||
<div>
|
||||
<div>🇬🇧</div>
|
||||
<div>The Pi Hut</div>
|
||||
<div>Located in the United Kingdom</div>
|
||||
</div>
|
||||
<svg width="24" height="24" viewBox="0 0 24 24">
|
||||
<path
|
||||
d="M8.59,16.58L13.17,12L8.59,7.41L10,6L16,12L10,18L8.59,16.58Z"
|
||||
/>
|
||||
</svg>
|
||||
</div>
|
||||
</a>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
@ -9,7 +9,7 @@ There are various ways to get in touch with the Home Assistant community. It doe
|
||||
|
||||
- [Forum][forum]
|
||||
- [Discord Chat Server][discord] for general Home Assistant discussions and questions.
|
||||
- Follow us on [Twitter][twitter], use [@home_assistant][twitter]
|
||||
- Follow us on X, use [@home_assistant][x-twitter]
|
||||
- Join the [Facebook community][facebook]
|
||||
- Join the Reddit in [/r/homeassistant][reddit]
|
||||
|
||||
@ -88,7 +88,7 @@ Don't miss the regular [Home Assistant podcasts](https://hasspodcast.io/).
|
||||
- [Home Assistant – Open Source Python Home Automation Platform](https://www.automatedhome.co.uk/new-products/home-assistant-open-source-python-home-automation-platform.html) - January 2015
|
||||
|
||||
[forum]: https://community.home-assistant.io/
|
||||
[twitter]: https://twitter.com/home_assistant
|
||||
[x-twitter]: https://x.com/home_assistant
|
||||
[facebook]: https://www.facebook.com/homeassistantio
|
||||
[reddit]: https://reddit.com/r/homeassistant
|
||||
[discord]: /join-chat
|
||||
|
||||
@ -27,6 +27,7 @@ Home Assistant is open source software and available under the [Apache 2.0](http
|
||||
- End of 2020, [Home Assistant Blue](/blue/) was launched. The first dedicated smart home hub for Home Assistant. This limited edition is based on an ODROID and known for its blue aluminum case.
|
||||
- In September 2021, [Home Assistant Yellow](/yellow/) was launched. This extendable smart home hub is a custom, open-source design powered by a Raspberry Pi Compute Module 4. Home Assistant Yellow supports both Zigbee and Thread.
|
||||
- End of 2022, [Home Assistant SkyConnect](/skyconnect/) was launched: a USB dongle that provides Zigbee and Thread network support for hubs that do not have this built-in.
|
||||
- In September 2023, [Home Assistant Green](/green/) was launched. This plug-and-play smart home hub is an affordable and the easiest way to get started with Home Assistant.
|
||||
|
||||
## Numbers
|
||||
|
||||
|
||||
Binary file not shown.
|
Before Width: | Height: | Size: 37 KiB After Width: | Height: | Size: 25 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 139 KiB After Width: | Height: | Size: 98 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 18 KiB After Width: | Height: | Size: 20 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 5.9 KiB After Width: | Height: | Size: 7.1 KiB |
BIN
source/images/assist/wake_word_connect_to_hosted_runtime.png
Normal file
BIN
source/images/assist/wake_word_connect_to_hosted_runtime.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 15 KiB |
BIN
source/images/assist/wake_word_disable_on_atom_echo.png
Normal file
BIN
source/images/assist/wake_word_disable_on_atom_echo.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 14 KiB |
BIN
source/images/assist/wake_word_enter_target_word.png
Normal file
BIN
source/images/assist/wake_word_enter_target_word.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 71 KiB |
BIN
source/images/assist/wake_word_listen_demo.png
Normal file
BIN
source/images/assist/wake_word_listen_demo.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 25 KiB |
BIN
source/images/assist/wake_word_press_play_button.png
Normal file
BIN
source/images/assist/wake_word_press_play_button.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 49 KiB |
BIN
source/images/assist/wake_word_runtime_run_all.png
Normal file
BIN
source/images/assist/wake_word_runtime_run_all.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 30 KiB |
BIN
source/images/assist/wake_word_select_assistant.png
Normal file
BIN
source/images/assist/wake_word_select_assistant.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 25 KiB |
BIN
source/images/assist/wake_word_upgrade_to_colab.png
Normal file
BIN
source/images/assist/wake_word_upgrade_to_colab.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 45 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 166 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 302 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 14 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 72 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 22 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 556 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 16 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 33 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 26 KiB |
BIN
source/images/frontpage/assist_wake_word.png
Normal file
BIN
source/images/frontpage/assist_wake_word.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 99 KiB |
@ -6,6 +6,7 @@ is_homepage: true
|
||||
regenerate: true
|
||||
feedback: false
|
||||
---
|
||||
|
||||
{% assign recent_release_post = site.categories['Core'].first %}
|
||||
|
||||
<div class="frontpage">
|
||||
@ -22,7 +23,9 @@ feedback: false
|
||||
>
|
||||
|
||||
<div class="links">
|
||||
<a href="{{ recent_release_post.url }}{{ site.patch_version_notes }}">Release notes</a>
|
||||
<a href="{{ recent_release_post.url }}{{ site.patch_version_notes }}"
|
||||
>Release notes</a
|
||||
>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
@ -30,7 +33,7 @@ feedback: false
|
||||
<h1>Recent Blog Posts</h1>
|
||||
|
||||
{% for post in site.posts limit: 4 %}
|
||||
<li class="post" style="display: grid; font-size: 16px;">
|
||||
<li class="post" style="display: grid; font-size: 16px">
|
||||
<a href="{{ post.url }}">{{ post.title }}</a>
|
||||
<small class="blog-date">{{ post.date_formatted }}</small>
|
||||
</li>
|
||||
@ -61,7 +64,11 @@ feedback: false
|
||||
Use Alexa to control Home Assistant.
|
||||
|
||||
<div class="links">
|
||||
<a href="/cloud/" aria-label="Learn more about use Alexa to control Home Assistant">LEARN MORE</a>
|
||||
<a
|
||||
href="/cloud/"
|
||||
aria-label="Learn more about use Alexa to control Home Assistant"
|
||||
>LEARN MORE</a
|
||||
>
|
||||
</div>
|
||||
</div>
|
||||
<div class="material-card text">
|
||||
@ -69,7 +76,11 @@ feedback: false
|
||||
Use Google Assistant to control Home Assistant.
|
||||
|
||||
<div class="links">
|
||||
<a href="/cloud/" aria-label="Learn more about use Google Assistant to control Home Assistant">LEARN MORE</a>
|
||||
<a
|
||||
href="/cloud/"
|
||||
aria-label="Learn more about use Google Assistant to control Home Assistant"
|
||||
>LEARN MORE</a
|
||||
>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
@ -85,11 +96,40 @@ feedback: false
|
||||
Home Assistant Cast makes every TV a display.
|
||||
</div>
|
||||
</div>
|
||||
<svg viewBox="0 0 24 24"><path d="M8.59,16.58L13.17,12L8.59,7.41L10,6L16,12L10,18L8.59,16.58Z" /></svg>
|
||||
<svg viewBox="0 0 24 24">
|
||||
<path
|
||||
d="M8.59,16.58L13.17,12L8.59,7.41L10,6L16,12L10,18L8.59,16.58Z"
|
||||
/>
|
||||
</svg>
|
||||
</div>
|
||||
</a>
|
||||
</div>
|
||||
<div class="grid__item two-thirds lap-two-thirds palm-one-whole">
|
||||
<a
|
||||
class="material-card picture-promo"
|
||||
href="/blog/2023/10/12/year-of-the-voice-chapter-4-wakewords/"
|
||||
style="
|
||||
background-image: url(/images/frontpage/assist_wake_word.png);
|
||||
background-size: cover;
|
||||
padding-top: 35%;
|
||||
"
|
||||
>
|
||||
<div class="caption">
|
||||
<div class="title">
|
||||
Control your home with Assist
|
||||
<div class="subtitle">
|
||||
Our private, insanely fast, voice assistant running on affordable
|
||||
hardware. Now supporting wake words.
|
||||
</div>
|
||||
</div>
|
||||
<svg viewBox="0 0 24 24">
|
||||
<path
|
||||
d="M8.59,16.58L13.17,12L8.59,7.41L10,6L16,12L10,18L8.59,16.58Z"
|
||||
/>
|
||||
</svg>
|
||||
</div>
|
||||
</a>
|
||||
|
||||
<!-- 10 YEAR HA -->
|
||||
<a
|
||||
href="https://www.youtube.com/watch?v=EmLV6lJLzSU"
|
||||
@ -100,9 +140,9 @@ feedback: false
|
||||
padding-top: 55%;
|
||||
"
|
||||
></a>
|
||||
{% assign pages_by_date = site.pages | sort: "date" | reverse %}
|
||||
{% for page in pages_by_date %}
|
||||
{% if page.layout == "landingpage" and page.frontpage != false %}
|
||||
{% assign pages_by_date = site.pages | sort: "date" | reverse %} {% for
|
||||
page in pages_by_date %} {% if page.layout == "landingpage" and
|
||||
page.frontpage != false %}
|
||||
<a
|
||||
class="material-card picture-promo"
|
||||
href="{{page.url}}"
|
||||
@ -115,15 +155,16 @@ feedback: false
|
||||
<div class="caption">
|
||||
<div class="title">
|
||||
{{page.title}}
|
||||
<div class="subtitle">
|
||||
{{page.description}}
|
||||
<div class="subtitle">{{page.description}}</div>
|
||||
</div>
|
||||
</div>
|
||||
<svg viewBox="0 0 24 24"><path d="M8.59,16.58L13.17,12L8.59,7.41L10,6L16,12L10,18L8.59,16.58Z" /></svg>
|
||||
<svg viewBox="0 0 24 24">
|
||||
<path
|
||||
d="M8.59,16.58L13.17,12L8.59,7.41L10,6L16,12L10,18L8.59,16.58Z"
|
||||
/>
|
||||
</svg>
|
||||
</div>
|
||||
</a>
|
||||
{% endif %}
|
||||
{% endfor %}
|
||||
{% endif %} {% endfor %}
|
||||
<!-- Tutorial: setup private voice assistant over phone -->
|
||||
<a
|
||||
href="/voice_control/worlds-most-private-voice-assistant/"
|
||||
@ -149,7 +190,11 @@ feedback: false
|
||||
Use NFC to bring music to your life or automate the mundane.
|
||||
</div>
|
||||
</div>
|
||||
<svg viewBox="0 0 24 24"><path d="M8.59,16.58L13.17,12L8.59,7.41L10,6L16,12L10,18L8.59,16.58Z" /></svg>
|
||||
<svg viewBox="0 0 24 24">
|
||||
<path
|
||||
d="M8.59,16.58L13.17,12L8.59,7.41L10,6L16,12L10,18L8.59,16.58Z"
|
||||
/>
|
||||
</svg>
|
||||
</div>
|
||||
</a>
|
||||
|
||||
@ -165,7 +210,11 @@ feedback: false
|
||||
Look sharp in blue, black or gray. Wearing a HA t-shirt is okay.
|
||||
</div>
|
||||
</div>
|
||||
<svg viewBox="0 0 24 24"><path d="M8.59,16.58L13.17,12L8.59,7.41L10,6L16,12L10,18L8.59,16.58Z" /></svg>
|
||||
<svg viewBox="0 0 24 24">
|
||||
<path
|
||||
d="M8.59,16.58L13.17,12L8.59,7.41L10,6L16,12L10,18L8.59,16.58Z"
|
||||
/>
|
||||
</svg>
|
||||
</div>
|
||||
</a>
|
||||
</div>
|
||||
@ -186,52 +235,62 @@ feedback: false
|
||||
<div class="material-card">
|
||||
<h1>Home Assistant in the press</h1>
|
||||
|
||||
<a href="https://www.theverge.com/2021/9/16/22678088/home-assistant-amber-smart-home-hub-specs-release-date-price"
|
||||
target="_blank" rel="noopener"
|
||||
><img
|
||||
alt="The Verge logo"
|
||||
src="/images/press/theverge.svg"
|
||||
<a
|
||||
href="https://www.theverge.com/2021/9/16/22678088/home-assistant-amber-smart-home-hub-specs-release-date-price"
|
||||
target="_blank"
|
||||
rel="noopener"
|
||||
><img alt="The Verge logo" src="/images/press/theverge.svg"
|
||||
/></a>
|
||||
|
||||
<a href="https://arstechnica.com/information-technology/2021/03/how-to-achieve-smart-home-nirvana-or-home-automation-without-subscription/"
|
||||
target="_blank" rel="noopener"
|
||||
<a
|
||||
href="https://arstechnica.com/information-technology/2021/03/how-to-achieve-smart-home-nirvana-or-home-automation-without-subscription/"
|
||||
target="_blank"
|
||||
rel="noopener"
|
||||
><img
|
||||
alt="ArsTechnica.com logo"
|
||||
src="/images/press/arstechnica.svg"
|
||||
/></a>
|
||||
|
||||
<a href="https://tweakers.net/reviews/8704/paulus-schoutsen-home-assistant-concurreert-met-alles-wat-via-de-cloud-gaat.html"
|
||||
target="_blank" rel="noopener"
|
||||
><img
|
||||
alt="Tweakers.net logo"
|
||||
src="/images/press/tweakers.png"
|
||||
<a
|
||||
href="https://tweakers.net/reviews/8704/paulus-schoutsen-home-assistant-concurreert-met-alles-wat-via-de-cloud-gaat.html"
|
||||
target="_blank"
|
||||
rel="noopener"
|
||||
><img alt="Tweakers.net logo" src="/images/press/tweakers.png"
|
||||
/></a>
|
||||
|
||||
<a href="https://www.youtube.com/watch?v=x7pSkVarixU"
|
||||
target="_blank" rel="noopener"
|
||||
<a
|
||||
href="https://www.youtube.com/watch?v=x7pSkVarixU"
|
||||
target="_blank"
|
||||
rel="noopener"
|
||||
><img
|
||||
alt="Linus Tech Tips logo"
|
||||
class='square'
|
||||
class="square"
|
||||
src="/images/press/ltt.svg"
|
||||
/></a>
|
||||
|
||||
<a href="https://www.troyhunt.com/iot-unravelled-part-1-its-a-mess-but-then-theres-home-assistant/"
|
||||
target="_blank" rel="noopener"
|
||||
<a
|
||||
href="https://www.troyhunt.com/iot-unravelled-part-1-its-a-mess-but-then-theres-home-assistant/"
|
||||
target="_blank"
|
||||
rel="noopener"
|
||||
><img
|
||||
class='square round'
|
||||
class="square round"
|
||||
alt="Troy Hunt logo"
|
||||
src="/images/press/troyhunt.jpg"
|
||||
/></a>
|
||||
|
||||
<a href="https://www.tomshardware.com/news/raspberry-pi-home-assistant-amber"
|
||||
target="_blank" rel="noopener"
|
||||
<a
|
||||
href="https://www.tomshardware.com/news/raspberry-pi-home-assistant-amber"
|
||||
target="_blank"
|
||||
rel="noopener"
|
||||
><img
|
||||
alt="Tom's Hardware logo"
|
||||
src="/images/press/tomshardware.svg"
|
||||
/></a>
|
||||
|
||||
<a href="https://www.producthunt.com/posts/home-assistant"
|
||||
target="_blank" rel="noopener"
|
||||
<a
|
||||
href="https://www.producthunt.com/posts/home-assistant"
|
||||
target="_blank"
|
||||
rel="noopener"
|
||||
><img
|
||||
alt="ProductHunt.com logo"
|
||||
src="/images/press/producthunt.com.png"
|
||||
@ -239,25 +298,33 @@ feedback: false
|
||||
|
||||
<a
|
||||
href="https://www.linux.com/news/home-assistant-python-approach-home-automation-video"
|
||||
target="_blank" rel="noopener"
|
||||
target="_blank"
|
||||
rel="noopener"
|
||||
><img alt="Linux.com logo" src="/images/press/linux.com.png"
|
||||
/></a>
|
||||
|
||||
<a href="https://opensource.com/article/17/7/home-automation-primer"
|
||||
target="_blank" rel="noopener"
|
||||
<a
|
||||
href="https://opensource.com/article/17/7/home-automation-primer"
|
||||
target="_blank"
|
||||
rel="noopener"
|
||||
><img
|
||||
alt="OpenSource.com logo"
|
||||
src="/images/press/opensource.com.svg"
|
||||
/></a>
|
||||
|
||||
<a href="http://www.linux-magazine.com/Issues/2017/203/Home-Assistant"
|
||||
target="_blank" rel="noopener"
|
||||
><img alt="Linux Magazine logo" src="/images/press/LinuxMagazine.png"
|
||||
<a
|
||||
href="http://www.linux-magazine.com/Issues/2017/203/Home-Assistant"
|
||||
target="_blank"
|
||||
rel="noopener"
|
||||
><img
|
||||
alt="Linux Magazine logo"
|
||||
src="/images/press/LinuxMagazine.png"
|
||||
/></a>
|
||||
|
||||
<a
|
||||
href="https://www.heise.de/ct/ausgabe/2017-26-Hausautomations-Schaltzentrale-Home-Assistant-3909532.html"
|
||||
target="_blank" rel="noopener"
|
||||
target="_blank"
|
||||
rel="noopener"
|
||||
><img alt="Ct logo" src="/images/press/ct.png"
|
||||
/></a>
|
||||
</div>
|
||||
|
||||
@ -62,19 +62,81 @@ As an open source project, Home Assistant cannot offer bounties for security vul
|
||||
|
||||
The following is a list of past security advisories that have been published by the Home Assistant project.
|
||||
|
||||
**2023-10-19: Actions expression injection in `helpers/version/action.yml`**
|
||||
Severity: _Low (This is an internal project)_
|
||||
Detailed information: _[Security advisory](https://github.com/home-assistant/core/security/advisories/GHSA-jff5-5j3g-vhqc)_
|
||||
Discovered by: _[jorgectf](https://github.com/jorgectf), [p-](https://github.com/p-) ([GitHub Security Lab](https://securitylab.github.com/))_
|
||||
Fixed in: _Home Assistant GitHub Actions released on September 5, 2023_
|
||||
|
||||
**2023-10-19: Arbitrary URL load in Android WebView in `MyActivity.kt`**
|
||||
Severity: _High (CVSS: 8.6)_
|
||||
Detailed information: _[Security advisory](https://github.com/home-assistant/core/security/advisories/GHSA-jvpm-q3hq-86rg)_
|
||||
Assigned CVE: _[CVE-2023-41898](https://nvd.nist.gov/vuln/detail/CVE-2023-41898)_
|
||||
Discovered by: _[atorralba](https://github.com/atorralba) ([GitHub Security Lab](https://securitylab.github.com/))_
|
||||
Fixed in: _Home Assistant for Android 2023.9.2_
|
||||
|
||||
**2023-10-19: Partial Server-Side Request Forgery in Core**
|
||||
Severity: _Low_
|
||||
Detailed information: _[Security advisory](https://github.com/home-assistant/core/security/advisories/GHSA-4r74-h49q-rr3h)_
|
||||
Assigned CVE: _[CVE-2023-41899](https://nvd.nist.gov/vuln/detail/CVE-2023-41899)_
|
||||
Discovered by: _[pwntester](https://github.com/pwntester) ([GitHub Security Lab](https://securitylab.github.com/))_
|
||||
Fixed in: _Home Assistant Core 2023.9_
|
||||
|
||||
**2023-10-19: Client-Side Request Forgery in iOS/macOS native Apps**
|
||||
Severity: _High (CVSS: 8.6)_
|
||||
Detailed information: _[Security advisory](https://github.com/home-assistant/core/security/advisories/GHSA-h2jp-7grc-9xpp)_
|
||||
Assigned CVE: _[CVE-2023-44385](https://nvd.nist.gov/vuln/detail/CVE-2023-44385)_
|
||||
Discovered by: _[pwntester](https://github.com/pwntester) ([GitHub Security Lab](https://securitylab.github.com/))_
|
||||
Fixed in: _Home Assistant for iOS 2023.7_
|
||||
|
||||
**2023-10-19: Account takeover via auth_callback login**
|
||||
Severity: _Low_
|
||||
Detailed information: _[Security advisory](https://github.com/home-assistant/core/security/advisories/GHSA-qhhj-7hrc-gqj5)_
|
||||
Assigned CVE: _[CVE-2023-41893](https://nvd.nist.gov/vuln/detail/CVE-2023-41893)_
|
||||
Discovered by: _[Cure53](https://cure53.de/) (Funded by [Nabu Casa](https://www.nabucasa.com/))_
|
||||
Fixed in: _Home Assistant Core 2023.9_
|
||||
|
||||
**2023-10-19: Full takeover via javascript URI in auth_callback login**
|
||||
Severity: _Critical_
|
||||
Detailed information: _[Security advisory](https://github.com/home-assistant/core/security/advisories/GHSA-jvxq-x42r-f7mv)_
|
||||
Assigned CVE: _[CVE-2023-41895](https://nvd.nist.gov/vuln/detail/CVE-2023-41895)_
|
||||
Discovered by: _[Cure53](https://cure53.de/) (Funded by [Nabu Casa](https://www.nabucasa.com/))_
|
||||
Fixed in: _Home Assistant Core 2023.9_
|
||||
|
||||
**2023-10-19: Local-only webhooks externally accessible via SniTun**
|
||||
Severity: _Low_
|
||||
Detailed information: _[Security advisory](https://github.com/home-assistant/core/security/advisories/GHSA-wx3j-3v2j-rf45)_
|
||||
Assigned CVE: _[CVE-2023-41894](https://nvd.nist.gov/vuln/detail/CVE-2023-41894)_
|
||||
Discovered by: _[Cure53](https://cure53.de/) (Funded by [Nabu Casa](https://www.nabucasa.com/))_
|
||||
Fixed in: _Home Assistant Core 2023.9_
|
||||
|
||||
**2023-10-19: Fake WS server installation permits full takeover**
|
||||
Severity: _Critical_
|
||||
Detailed information: _[Security advisory](https://github.com/home-assistant/core/security/advisories/GHSA-cr83-q7r2-7f5q)_
|
||||
Assigned CVE: _[CVE-2023-41896](https://nvd.nist.gov/vuln/detail/CVE-2023-41896)_
|
||||
Discovered by: _[Cure53](https://cure53.de/) (Funded by [Nabu Casa](https://www.nabucasa.com/))_
|
||||
Fixed in: _Home Assistant Core 2023.9 & `home-assistant-js-websocket` 8.2.0 (npm)_
|
||||
|
||||
**2023-10-19: Lack of XFO header allows clickjacking**
|
||||
Severity: _Critical_
|
||||
Detailed information: _[Security advisory](https://github.com/home-assistant/core/security/advisories/GHSA-935v-rmg9-44mw)
|
||||
Assigned CVE: _[CVE-2023-41897](https://nvd.nist.gov/vuln/detail/CVE-2023-41897)_
|
||||
Discovered by: _[Cure53](https://cure53.de/) (Funded by [Nabu Casa](https://www.nabucasa.com/))_
|
||||
Fixed in: _Home Assistant Core 2023.9_
|
||||
|
||||
**2023-03-08: Authentication bypass Supervisor API**
|
||||
Severity: _Critical (CVSS: 10.0)_
|
||||
Detailed information: _[Security advisory](https://github.com/home-assistant/core/security/advisories/GHSA-2j8f-h4mr-qr25)_
|
||||
Assigned CVE: _[CVE-2023-27482](https://nvd.nist.gov/vuln/detail/CVE-2023-27482)_
|
||||
Discovered by: _[Joseph Surin](https://jsur.in/) from [elttam](https://www.elttam.com/)_
|
||||
Fixed in: _Core 2023.3.2, Supervisor 2023.03.3_
|
||||
Fixed in: _Home Assistant Core 2023.3.2, Home Assistant Supervisor 2023.03.3_
|
||||
|
||||
**2017-10-11: Cross-site scripting in Markdown output**
|
||||
Severity: _Medium (CVSS: 6.1)_
|
||||
Detailed information: _[Pull request](https://github.com/home-assistant/frontend/pull/514)_
|
||||
Assigned CVE: _[CVE-2017-16782](https://nvd.nist.gov/vuln/detail/CVE-2017-16782)_
|
||||
Discovered by: _Marcin Teodorczyk from [intive.com](https://intive.com/)_
|
||||
Fixed in: _Core 0.57_
|
||||
Fixed in: _Home Assistant Core 0.57_
|
||||
|
||||
---
|
||||
|
||||
|
||||
@ -27,7 +27,7 @@ There are two versions of the shortcut. The normal shortcut works better with Si
|
||||
|
||||
### Adjusting the language
|
||||
|
||||
Shortcuts triggerd via Siri will always use the same language as Siri is set to. The Assist Button shortcut is meant to be manually triggered and can be configured for any language.
|
||||
Shortcuts triggered via Siri will always use the same language as Siri is set to. The Assist Button shortcut is meant to be manually triggered and can be configured for any language.
|
||||
|
||||
Open the shortcuts app, and edit the Button Assist shortcut. The text in quotes will be shown in the language of your device.
|
||||
|
||||
|
||||
102
source/voice_control/create_wake_word.markdown
Normal file
102
source/voice_control/create_wake_word.markdown
Normal file
@ -0,0 +1,102 @@
|
||||
---
|
||||
title: "Create your own wake word"
|
||||
---
|
||||
|
||||
You can now create your own wake word to use with Home Assistant. The procedure below will guide you to train a model. The model is trained using voice clips generated by our local neural text-to-speech system [Piper](https://github.com/rhasspy/piper).
|
||||
|
||||
_Want to now more about how this all works? Check out the [openWakeWord](https://github.com/dscripka/openWakeWord) project by David Scripka.)_
|
||||
|
||||
Depending on the word, training a model on your own wake word may take a few iterations and a bit of tweaking. This guide will take you through the process step by step.
|
||||
|
||||
## Prerequisites
|
||||
|
||||
- Latest version of Home Assistant, installed with the Home Assistant Operating System
|
||||
- [M5Stack ATOM Echo Development Kit](https://shop.m5stack.com/products/atom-echo-smart-speaker-dev-kit?ref=NabuCasa)
|
||||
- Successfully completed the [$13 voice assistant for Home Assistant](/voice_control/thirteen-usd-voice-remote/) tutorial
|
||||
|
||||
## To create your own wake word
|
||||
|
||||
1. Think of a wake word.
|
||||
- A word or short phrase (3-4 syllables) that is not commonly used so that it does not trigger Assist by mistake.
|
||||
- Currently, only wake words in English are supported.
|
||||
2. Open the [wake word training environment](https://colab.research.google.com/drive/1q1oe2zOyZp7UsB3jJiQ1IFn8z5YfjwEb?usp=sharing#scrollTo=1cbqBebHXjFD).
|
||||
3. In section 1, enter your wake word in the **target_word** field.
|
||||
|
||||
4. In the code section next to the **target_word**, select the play button. The first time this can take up to 30 seconds.
|
||||
- If the play button does not appear, make sure your cursor is placed in the **target_word** field.
|
||||
|
||||
- If it still does not show up, in the top right corner of the document, make sure it says **Connected**.
|
||||
- If it is not connected, select **Connect to a hosted runtime**.
|
||||
|
||||
- **Result**: The pronunciation of your wake word is being created.
|
||||
- Once it is finished, at the bottom of the section, you see an audio file. Listen to it.
|
||||
|
||||
|
||||
5. If the word does not sound correct to you:
|
||||
- Follow the instructions in the document to tweak the spelling of the word and press play again.
|
||||
- The word should sound the way you pronounce it.
|
||||
6. Once you are satisfied with the result, in the menu on top of the screen, select **Runtime** > **Run all**.
|
||||
- This will take around an hour. Feel free to do something else but make sure to leave the browser tab open.
|
||||
|
||||
- **Result**: Once this process is finished, you should have 2 files in your downloads folder:
|
||||
- `.tflite` and `.onnx` files (only `.tflite` is used)
|
||||
|
||||
7. Congratulations! You just applied machine learning to create your own wake word model!
|
||||
- The next step is to add it to Home Assistant.
|
||||
|
||||
## To add your personal wake word to Home Assistant
|
||||
|
||||
1. Make sure you have the [Samba add-on installed](/common-tasks/os/#configuring-access-to-files).
|
||||
2. On your computer, access your Home Assistant server via Samba.
|
||||
- Open the `share` folder and create a new folder `openwakeword` so that you have `/share/openwakeword`.
|
||||
3. Drop your shiny new wake word model file (`.tflite`) into that folder.
|
||||
4. Go to {% my voice_assistants title="**Settings** > **Voice assistants**" %}.
|
||||
- Either create a new assistant and select **Add assistant**.
|
||||
- Or, edit an existing assistant.
|
||||
5. Under **Wake word**, select **openwakeword**.
|
||||
- Then, select your own personal wake word.
|
||||
- If there is no **Wake word** option, make sure you have the add-on installed and successfully completed the [$13 voice assistant for Home Assistant](/voice_control/thirteen-usd-voice-remote/) tutorial.
|
||||
6. Enable this new assistant on your ATOM Echo device.
|
||||
- Go to {% my integrations title="**Settings** > **Devices & Services**" %} and select the **ESPHome** integration.
|
||||
- Under **M5Stack ATOM Echo**, select **1 device**.
|
||||
- Under **Configuration**, make sure **Use wake word** is enabled.
|
||||
- Select the assistant with your wake word.
|
||||
|
||||
|
||||
7. Test your new wake word.
|
||||
- Speak your wake word followed by a command, such as "Turn on the lights in the kitchen".
|
||||
- When the ATOM Echo picks up the wake word, it starts blinking blue.
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
### Troubleshooting wake word recognition
|
||||
|
||||
1. If the ATOM Echo does not start blinking blue when you say the wake word, there are a few things you can try.
|
||||
2. Go to {% my integrations title="**Settings** > **Devices & Services**" %} and select the **ESPHome** integration.
|
||||
- Under **M5Stack ATOM Echo**, select **1 device**.
|
||||
- Under **Controls**, make sure **Use wake word** is enabled.
|
||||
3. If this was not the issue, you may need to tweak the wake word model.
|
||||
- Go back to the [wake word training environment](https://colab.research.google.com/drive/1q1oe2zOyZp7UsB3jJiQ1IFn8z5YfjwEb?usp=sharing#scrollTo=1cbqBebHXjFD).
|
||||
- In section 3 of the document, follow the instructions on tweaking the settings and create a new model.
|
||||
|
||||
### Troubleshooting performance issues of the training environment
|
||||
|
||||
The environment on the Colab space runs on resources offered by Google. They are intended for small-scale, non-commercial personal use. There is no guarantee that resources are available.
|
||||
If many people use this environment at the same time or if the request itself uses a lot of resources, the execution might be very slow or won't run at all.
|
||||
|
||||
It may take 30-60 minutes for the run to complete. This is expected behavior.
|
||||
|
||||
Things you can try if the execution is very slow:
|
||||
|
||||
1. Free of charge solution: This environment has worked for all the wake word models that were trained to create and test this procedure. There is a good chance that it will work for you. If it does not, try training your model another time. Maybe many people are using it right now.
|
||||
2. You can pay for more computing resources: In the top right corner, select the RAM | Disk icon.
|
||||
- Select the link to **Upgrade to Colab Pro**.
|
||||
- Select your price plan and follow the instructions on screen.
|
||||
|
||||
|
||||
## Related topics
|
||||
|
||||
- [$13 voice assistant for Home Assistant](/voice_control/thirteen-usd-voice-remote/)
|
||||
- [wake word training environment](https://colab.research.google.com/drive/1q1oe2zOyZp7UsB3jJiQ1IFn8z5YfjwEb?usp=sharing#scrollTo=1cbqBebHXjFD)
|
||||
- [Samba add-on installed](/common-tasks/os/#configuring-access-to-files)
|
||||
- [openWakeWord](https://github.com/dscripka/openWakeWord)
|
||||
@ -13,7 +13,7 @@ This is the easiest method to get started with custom sentences for automations.
|
||||
If you have not set up voice control yet, set up the hardware first. For instructions, refer to one of the following tutorials:
|
||||
|
||||
- [World's most private voice assistant](/voice_control/worlds-most-private-voice-assistant/): Using a classic landline phone
|
||||
- [$13 voice remote for Home Assistant](/voice_control/thirteen-usd-voice-remote/): Using a button with speaker and mic
|
||||
- [$13 voice assistant for Home Assistant](/voice_control/thirteen-usd-voice-remote/): Using a button with speaker and mic
|
||||
- [Assist for Apple](/voice_control/apple/): Using your iPhone, Mac, or Apple watch
|
||||
- [Assist for Android](/voice_control/android/): Using your Android phone, tablet, or a Wear OS watch
|
||||
|
||||
|
||||
@ -25,4 +25,4 @@ The Assist icon doesn't show up? Make sure the [conversation](/integrations/conv
|
||||
|
||||
_Assist was introduced in Home Assistant 2023.2._
|
||||
|
||||
<lite-youtube videoid="sQ7X7jz1SrA" videotitle="Assist on Apple HomePod"></lite-youtube>
|
||||
<lite-youtube videoid="ziebKt4XLZQ" videotitle="Wake word demo on $13 ATOM Echo in Home Assistant"></lite-youtube>
|
||||
|
||||
@ -1,25 +1,66 @@
|
||||
---
|
||||
title: "$13 voice remote for Home Assistant"
|
||||
title: "$13 voice assistant for Home Assistant"
|
||||
---
|
||||
|
||||
This tutorial will guide you to turn an ATOM Echo into the
|
||||
world's most private voice assistant. Pick up the tiny device to talk to
|
||||
your smart home. Issue commands and get responses!
|
||||
|
||||
<lite-youtube videoid="w6QxGdxVMJs" videotitle="$13 voice remote for Home Assistant
|
||||
<lite-youtube videoid="ziebKt4XLZQ" videotitle="Wake word demo on $13 ATOM Echo in Home Assistant
|
||||
"></lite-youtube>
|
||||
|
||||
## Required material
|
||||
## Prerequisites
|
||||
|
||||
- Home Assistant 2023.5 or later
|
||||
- Home Assistant 2023.10, installed with the Home Assistant Operating System
|
||||
- [Home Assistant Cloud](https://www.nabucasa.com) or a manually configured [Assist Pipeline](/voice_control/voice_remote_local_assistant)
|
||||
- The password to your 2.4 GHz Wi-Fi network
|
||||
- Chrome (or a Chromium-based browser like Edge) on desktop (not Android/iOS)
|
||||
- [M5Stack ATOM Echo Development Kit](https://shop.m5stack.com/products/atom-echo-smart-speaker-dev-kit?ref=NabuCasa)
|
||||
- USB-C cable to connect the ATOM Echo
|
||||
|
||||
## Installing the openWakeWord add-on
|
||||
|
||||
As a first step, you need to install the openWakeWord add on. This must be installed before setting up the ATOM Echo.
|
||||
|
||||
1. Go to {% my supervisor_addon addon="core_openwakeword" title="**Settings** > **Add-ons** > **openWakeWord**" %} and select **Install**.
|
||||
2. Start the add-on.
|
||||
3. Go to {% my integrations title="**Settings** > **Devices & Services**" %}.
|
||||
- Under **Discovered**, you should now see the **Wyoming** integration.
|
||||
- Select **Configure** and **Submit**.
|
||||
- **Result**: You have successfully installed the openWakeWord add-on and Wyoming integration.
|
||||
|
||||
## Adding a wake word to your voice assistant
|
||||
|
||||
1. Go to {% my voice_assistants title="**Settings** > **Voice assistants**" %} and select **Add assistant**.
|
||||
2. Give your assistant a name, for example the wake word you are going to use.
|
||||
3. Select the language you are going to use to speak to Home Assistant.
|
||||
- If the **Text-to-speech** and **Speech-to-text** sections do not provide language selectors, this means you do not have an Assist pipeline set up.
|
||||
- Set up [Home Assistant Cloud](https://www.nabucasa.com) or a manually configured [Assist pipeline](/voice_control/voice_remote_local_assistant).
|
||||
4. Under **Text-to-speech**, select the language and voice you want Home Assistant to use when speaking to you.
|
||||
5. To define the wake word engine, under **Wake word**, select **openwakeword**.
|
||||
- Then, select **ok nabu**.
|
||||
- If you created a new assistant, select **Create**.
|
||||
- If you edited an existing assistant, select **Update**.
|
||||
- **Result**: You now have a voice assistant that listens to a wake word.
|
||||
6. For the first run, it is recommended to use **ok nabu**, just to test the setup.
|
||||
- Once you have it all set up, you can [create your own wake words](/voice_control/create_wake_word/).
|
||||
|
||||
## Installing the software onto the ATOM Echo
|
||||
|
||||
If you have used the ATOM Echo on Home Assistant before and have it installed via ESPHome add-on, you first need to remove its configuration.
|
||||
|
||||
### To delete the ATOM Echo configuration from ESPHome
|
||||
|
||||
1. Go to {% my integrations title="**Settings** > **Devices & Services**" %}, and select the ESPHome integration.
|
||||
- Under **Devices**, next to the **M5Stack Atom Echo a61920** entry, select the three-dots menu.
|
||||
- Select **Delete**.
|
||||
2. Make sure you have [access to the configuration files](/common-tasks/os/#configuring-access-to-files).
|
||||
- If you have never done this before, [install the file editor add-on](/common-tasks/os/#installing-and-using-the-file-editor-add-on).
|
||||
3. Access the config files and open the **esphome** folder.
|
||||
4. If there is a configuration file for the ATOM Echo, delete it.
|
||||
|
||||
### To install the software on your ATOM Echo
|
||||
|
||||
Before you can use this device with Home Assistant, you need to install a bit of software on it.
|
||||
|
||||
1. Make sure this page is opened in a Chromium-based browser on a desktop. It does not work on a tablet or phone.
|
||||
@ -51,36 +92,86 @@ Before you can use this device with Home Assistant, you need to install a bit of
|
||||
5. Select **OK**.
|
||||
|
||||
|
||||
6. To add the newly discovered device, select the ATOM Echo from the list.
|
||||
6. If, at this stage, a dialog opens, prompting you to enter the connection settings of your ESPHome node, it means there is already a configuration set up for that ESPHome device.
|
||||
- Close the dialog and perform the procedure on [deleting the ATOM Echo configuration from ESPHome](/voice_control/thirteen-usd-voice-remote/#to-delete-the-atom-echo-configuration-from-esphome).
|
||||
- Restart Home Assistant.
|
||||
- Then, under {% my integrations title="**Settings** > **Devices & Services**" %}, your ATOM Echo should be discovered.
|
||||
7. To add the newly discovered device, select the ATOM Echo from the list.
|
||||
- Add your ATOM Echo to a room and select **Finish**.
|
||||
7. You should now see the **ESPHome** integration.
|
||||
8. You should now see the **ESPHome** integration.
|
||||
|
||||
8. Select the **ESPHome** integration. Under **Devices**, you should see the **M5Stack Atom Echo** listed.
|
||||
9. Select the **ESPHome** integration. Under **Devices**, you should see the **M5Stack Atom Echo** listed.
|
||||
|
||||
- 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.
|
||||
9. Congratulations! You can now voice control Home Assistant using a button with a built-in microphone. Now give some commands.
|
||||
10. Congratulations! You can now voice control Home Assistant using a button with a built-in microphone. Now give some commands.
|
||||
|
||||
## Controlling Home Assistant over the ATOM Echo
|
||||
|
||||
1. Press the flat button with rounded shape on your ATOM Echo.
|
||||
- The rectangular button on the side is the reset button. Do not press that one.
|
||||
- As soon as you press the button, the LED will light up in blue.
|
||||
- While you are speaking, the blue LED is pulsing.
|
||||
- Once the intent has been processed, the LED lights up in green and Home Assistant confirms the action.
|
||||
1. Say your wake word. For this tutorial, use "OK, Nabu".
|
||||
- Wait for the LED to start blinking in blue.
|
||||
2. Say a [supported voice command](/voice_control/builtin_sentences/). For example, *Turn off the light in the kitchen*.
|
||||
- While you are speaking, the blue LED keeps pulsing.
|
||||
- Once the intent has been processed, the LED lights up in green and Home Assistant confirms the action.
|
||||
- Make sure you’re using the area name exactly as you defined it in Home Assistant.
|
||||
- You can also ask a question, such as
|
||||
- *Is the front door locked?*
|
||||
- *Which lights are on in the living room?*
|
||||
3. Your command is not supported? Add your own commands using [a sentence trigger](/voice_control/custom_sentences/).
|
||||
4. You find ATOM Echo takes to long to start processing your command?
|
||||
4. You find ATOM Echo takes too long to start processing your command?
|
||||
- Adjust the silence detection settings. This setting defines how much silence is needed for Assist to find you're done speaking and it can start processing your command.
|
||||
- Go to {% my integrations title="**Settings** > **Devices & Services**" %} and select the **ESPHome** integration.
|
||||
- Under **M5Stack ATOM Echo**, select **1 device**.
|
||||
|
||||
|
||||
## Disabling wake word and use push-to-talk
|
||||
|
||||
1. If you do not want to use a wake word, but prefer to use the microphone by pressing a button, you can disable the wake word.
|
||||
2. Go to {% my integrations title="**Settings** > **Devices & Services**" %} and select the **ESPHome** integration.
|
||||
- Under **M5Stack ATOM Echo**, select **1 device**.
|
||||
3. Disable **Use wake word**.
|
||||
|
||||
|
||||
4. To start using push-to-talk, press the flat button with rounded shape on your ATOM Echo.
|
||||
- The rectangular button on the side is the reset button. Do not press that one.
|
||||
- As soon as you press the button, the LED will start blinking in blue. If it does not light up, press again.
|
||||
- While you are speaking, the blue LED is pulsing.
|
||||
- Once the intent has been processed, the LED lights up in green and Home Assistant confirms the action.
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
Are things not working as expected?
|
||||
|
||||
- Checkout the [general troubleshooting section for Assist](/voice_control/troubleshooting/).
|
||||
- You think there is a problem with noise or volume? Checkout the procedure below.
|
||||
|
||||
### Tweaking the ATOM Echo configuration
|
||||
|
||||
1. Make sure you have [access to your configuration files](/common-tasks/os/#configuring-access-to-files).
|
||||
2. Edit the general configuration:
|
||||
- Access the `config` folder and open the `configuration.yaml` file.
|
||||
- Enter the following text:
|
||||
```yaml
|
||||
assist_pipeline:
|
||||
debug_recording_dir: /share/assist_pipeline
|
||||
```
|
||||
3. Save the changes and restart Home Assistant.
|
||||
4. Make sure you have the [Samba add-on installed](/common-tasks/os/#configuring-access-to-files).
|
||||
5. On your computer, access your Home Assistant server via Samba.
|
||||
- Navigate to `/share/assist_pipeline`.
|
||||
- For each voice command you gave, you will find a subfolder with the audio file in `.wav` format.
|
||||
6. Listen to the audio file of interest.
|
||||
7. Adjust noise suppression and volume, if needed:
|
||||
- Access the `config` folder and open the `esphome/m5stack-atom-echo-wake-word.yaml` file.
|
||||
- Find the `voice_assistant` section.
|
||||
- If the audio is too noisy, increase the `noise_suppression_level` (max. 4).
|
||||
- If the audio is too quiet, increase either the `auto_gain` (max. 31) or the `volume_multiplier` (no maximum, but a too high value will cause distortion eventually).
|
||||
8. Collecting the debug recordings impacts your disk space.
|
||||
- Once you have found a configuration that works, delete the folder with the audio files.
|
||||
- In the `configuration.yaml` file, delete the `assist_pipeline entry` and restart Home Assistant.
|
||||
|
||||
## Related topics
|
||||
|
||||
- [Create your own wake words](/voice_control/create_wake_word/)
|
||||
- [General troubleshooting section for Assist](/voice_control/troubleshooting/)
|
||||
- [Access to your configuration files](/common-tasks/os/#configuring-access-to-files)
|
||||
- [Using a sentence trigger](/voice_control/custom_sentences/)
|
||||
|
||||
@ -9,7 +9,7 @@ But you can make Assist the default digital assistant and [start it on an Androi
|
||||
|
||||
You can also create your own [custom sentences](/voice_control/custom_sentences/#adding-a-custom-sentence-to-trigger-an-automation) to start an automation. For example, you could say "Clean the floor when I'm gone" to start the vacuum after you left your home zone. For the full list of new features and some videos, head over to the [chapter 3 blog post](/blog/2023/07/20/year-of-the-voice-chapter-3/) or watch the stream.
|
||||
|
||||
<lite-youtube videoid="sXzItFksYFA" videotitle="Year of the Voice CHapter 3"></lite-youtube>
|
||||
<lite-youtube videoid="sXzItFksYFA" videotitle="Year of the Voice Chapter 3"></lite-youtube>
|
||||
|
||||
While the video below does not include these latest changes, it gives a good overview of some of the basics.
|
||||
|
||||
|
||||
@ -10,6 +10,10 @@ The speech-to-text option is [Whisper](https://github.com/openai/whisper). It's
|
||||
|
||||
For text-to-speech we have developed [Piper](https://github.com/rhasspy/piper). Piper is a fast, local neural text-to-speech system that sounds great and is optimized for the Raspberry Pi 4. It supports [many languages](https://rhasspy.github.io/piper-samples/). On a Raspberry Pi, using medium quality models, it can generate 1.6s of voice in a second.
|
||||
|
||||
## Prerequisites
|
||||
|
||||
- Home Assistant Operating System
|
||||
|
||||
## Installing a local Assist pipeline
|
||||
|
||||
For the quickest way to get your local Assist pipeline started, follow these steps:
|
||||
@ -46,6 +50,7 @@ For the quickest way to get your local Assist pipeline started, follow these ste
|
||||
- Under **Speech-to-text**, select **faster-whisper**.
|
||||
- Under **Text-to-speech**, select **piper**.
|
||||
- Depending on your language, you may be able to select different language variants.
|
||||
- If you like, [set up a wake word](/voice_control/create_wake_word/).
|
||||
|
||||
3. That's it. You ensured your voice commands can be processed locally on your device.
|
||||
4. If you haven't done so yet, [expose your devices to Assist](/voice_control/voice_remote_expose_devices/#exposing-your-devices).
|
||||
@ -59,3 +64,10 @@ View some of the options in the video below. Explained by Mike Hansen, creator o
|
||||
<lite-youtube videoid="Tk-pnm7FY7c" videoStartAt="1589" videotitle="Configure your local Assist pipeline for your setup"></lite-youtube>
|
||||
|
||||
The options are also documented in the add-on itself. Go to the {% my supervisor_addon addon="core_whisper" title="**Whisper**" %} or the {% my supervisor_addon addon="core_piper" title="**Piper**" %} add-on and open the **Documentation** page.
|
||||
|
||||
## Related topics
|
||||
|
||||
- [Create your own wake word](/voice_control/create_wake_word/)
|
||||
- [Expose your devices to Assist](/voice_control/voice_remote_expose_devices/#exposing-your-devices)
|
||||
- [Whisper for speech-to-text](https://github.com/openai/whisper)
|
||||
- [Piper for text-to-speech](https://github.com/rhasspy/piper)
|
||||
|
||||
@ -1,5 +1,5 @@
|
||||
---
|
||||
title: "World's Most Private Voice Assistant"
|
||||
title: "World's most private voice assistant"
|
||||
---
|
||||
|
||||
This tutorial will guide you to turn your old landline phone into the
|
||||
@ -104,6 +104,7 @@ You were able to control Home Assistant over the phone but it no longer works. W
|
||||
The [debug information](/voice_control/troubleshooting#view-debug-information) shows no runs.
|
||||
|
||||
**Potential remedy**
|
||||
|
||||
1. Log onto the Grandstream *Device Configuration* software.
|
||||
2. On the **Status** page, check if the **Hook** status changes from **On Hook** to **In Use** after you picked up the phone.
|
||||
|
||||
|
||||
@ -212,7 +212,7 @@ frontpage_image: /images/frontpage/yellow-frontpage.jpg
|
||||
<h1>Buying a Raspberry Pi Compute Module 4 (CM4)</h1>
|
||||
<p>If you bought the Home Assistant Yellow Kit, you need to bring your own Raspberry Pi Compute Module 4.
|
||||
</p>
|
||||
<p>A chip shortage still impacts the availability of the CM4. Our recommendation is to use <a href="https://rpilocator.com/" target="_blank">rpilocator</a>. This website tracks the stock of official Raspberry Pi distributors. Follow them on Twitter and enable push notifications. You will be notified as soon as the bot tweets that products are in stock.
|
||||
<p>A chip shortage still impacts the availability of the CM4. Our recommendation is to use <a href="https://rpilocator.com/" target="_blank">rpilocator</a>. This website tracks the stock of official Raspberry Pi distributors. Follow them on X and enable push notifications. You will be notified as soon as the bot tweets that products are in stock.
|
||||
</p>
|
||||
<p>
|
||||
We recommend purchasing a Raspberry Pi Compute Module 4 with the following characteristics:
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user