mirror of
https://github.com/home-assistant/home-assistant.io.git
synced 2025-07-16 05:46:52 +00:00
Merge branch 'current' into next
This commit is contained in:
Franck Nijhof
commit
d33c77d2e4
2
Gemfile
2
Gemfile
@ -12,7 +12,7 @@ group :development do
|
||||
gem 'sassc', '2.1.0'
|
||||
gem 'sass-embedded', '1.89.0'
|
||||
gem 'rubocop', '1.75.7'
|
||||
gem 'ruby-lsp', '0.23.21'
|
||||
gem 'ruby-lsp', '0.23.23'
|
||||
gem 'rackup', '2.2.1'
|
||||
end
|
||||
|
||||
|
||||
10
Gemfile.lock
10
Gemfile.lock
@ -70,7 +70,7 @@ GEM
|
||||
nokogiri (~> 1.12)
|
||||
jekyll-watch (2.2.1)
|
||||
listen (~> 3.0)
|
||||
json (2.12.0)
|
||||
json (2.12.2)
|
||||
kramdown (2.5.1)
|
||||
rexml (>= 3.3.9)
|
||||
kramdown-parser-gfm (1.1.0)
|
||||
@ -133,10 +133,10 @@ GEM
|
||||
rubocop-ast (1.44.1)
|
||||
parser (>= 3.3.7.2)
|
||||
prism (~> 1.4)
|
||||
ruby-lsp (0.23.21)
|
||||
ruby-lsp (0.23.23)
|
||||
language_server-protocol (~> 3.17.0)
|
||||
prism (>= 1.2, < 2.0)
|
||||
rbs (>= 3, < 4)
|
||||
rbs (>= 3, < 5)
|
||||
sorbet-runtime (>= 0.5.10782)
|
||||
ruby-progressbar (1.13.0)
|
||||
ruby2_keywords (0.0.5)
|
||||
@ -159,7 +159,7 @@ GEM
|
||||
rack-protection (= 4.1.1)
|
||||
rack-session (>= 2.0.0, < 3)
|
||||
tilt (~> 2.0)
|
||||
sorbet-runtime (0.5.12124)
|
||||
sorbet-runtime (0.5.12130)
|
||||
stringex (2.8.6)
|
||||
terminal-table (3.0.2)
|
||||
unicode-display_width (>= 1.1.1, < 3)
|
||||
@ -186,7 +186,7 @@ DEPENDENCIES
|
||||
rackup (= 2.2.1)
|
||||
rake (= 13.2.1)
|
||||
rubocop (= 1.75.7)
|
||||
ruby-lsp (= 0.23.21)
|
||||
ruby-lsp (= 0.23.23)
|
||||
sass-embedded (= 1.89.0)
|
||||
sass-globbing (= 1.1.5)
|
||||
sassc (= 2.1.0)
|
||||
|
||||
@ -83,8 +83,7 @@ The output of this selector is a list of actions. For example:
|
||||
|
||||
## Add-on selector
|
||||
|
||||
This can only be used on an installation with a Supervisor. For installations
|
||||
that do not have that, an error will be displayed.
|
||||
This can only be used on a {% term "Home Assistant Operating System" %} installation. For {% term "Home Assistant Container" %} installations, an error will be displayed.
|
||||
|
||||
The add-on selector allows the user to input an add-on slug.
|
||||
On the user interface, it will list all installed add-ons and use the slug of the
|
||||
@ -276,8 +275,8 @@ assist_pipeline:
|
||||
|
||||
## Backup location selector
|
||||
|
||||
This can only be used on an installation with a Supervisor (Operating System or
|
||||
Supervised). For installations of type {% term "Home Assistant Core" %} or {% term "Home Assistant Container" %}, an error
|
||||
This can only be used on an installation with a {% term "Home Assistant Operating System" %}. For {% term "Home Assistant Container" %} installations, an error
|
||||
|
||||
will be displayed.
|
||||
|
||||
The backup location selector shows a list of places a backup could go, depending
|
||||
|
||||
@ -51,20 +51,12 @@ When you start splitting your configuration into multiple files, you might end u
|
||||
- A `secrets.yaml` located in the same folder as the {% term YAML %} file referencing the secret,
|
||||
- next, parent folders will be searched for a `secrets.yaml` file with the secret, stopping at the folder with the main {% term "`configuration.yaml`" %}.
|
||||
|
||||
To see where secrets are being loaded from, you can either add an option to your `secrets.yaml` file or use the `check_config` script. The latter is only available for {% term "Home Assistant Core" %} installations given it's available through [`hass`](/docs/tools/hass/).
|
||||
To see where secrets are being loaded from, you can add an option to your `secrets.yaml` file.
|
||||
|
||||
*Option 1*: Print where secrets are retrieved from to the Home Assistant log by adding the following to `secrets.yaml`:
|
||||
Print where secrets are retrieved from to the Home Assistant log by adding the following to `secrets.yaml`:
|
||||
|
||||
```yaml
|
||||
logger: debug
|
||||
```
|
||||
|
||||
This will not print the actual secret's value to the log.
|
||||
|
||||
*Option 2*: For Home Assistant Core installations, you can also view where secrets are retrieved from and the contents of all `secrets.yaml` files using the [`check_config` script](/docs/tools/check_config/) from the command line:
|
||||
|
||||
```bash
|
||||
hass --script check_config --secrets
|
||||
```
|
||||
|
||||
This will print all your secrets.
|
||||
|
||||
@ -229,8 +229,6 @@ If you have many configuration files, Home Assistant provides a CLI that allows
|
||||
|
||||
- [Operating System](/common-tasks/os/#configuration-check)
|
||||
- [Container](/common-tasks/container/#configuration-check)
|
||||
- [Core](/common-tasks/core/#configuration-check)
|
||||
- [Supervised](/common-tasks/supervised/#configuration-check)
|
||||
|
||||
## Advanced usage
|
||||
|
||||
|
||||
@ -26,8 +26,6 @@ One of the most common problems with Home Assistant is an invalid {% term "`conf
|
||||
- Home Assistant provides a CLI that allows you to see how it interprets them, each installation type has its own section in the common-tasks about this:
|
||||
- [Operating System](/common-tasks/os/#configuration-check)
|
||||
- [Container](/common-tasks/container/#configuration-check)
|
||||
- [Core](/common-tasks/core/#configuration-check)
|
||||
- [Supervised](/common-tasks/supervised/#configuration-check)
|
||||
|
||||
- The configuration files, including {% term "`configuration.yaml`" %} must be UTF-8 encoded. If you see error like `'utf-8' codec can't decode byte`, edit the offending configuration and re-save it as UTF-8.
|
||||
- You can verify your configuration's {% term YAML %} structure using [this online YAML parser](https://yaml-online-parser.appspot.com/) or [YAML Validator](https://codebeautify.org/yaml-validator/).
|
||||
|
||||
@ -50,7 +50,7 @@ If you are the owner or have administrator, there are different methods to reset
|
||||
- [Reset an owner's password when logged out](#to-reset-an-owners-password-via-console)
|
||||
- [reset a user's password, via the container command line](#to-reset-a-users-password-via-the-container-command-line)
|
||||
|
||||
#### To reset a password while still logged in (including Supervised)
|
||||
#### To reset a password while still logged in
|
||||
|
||||
The method used to reset a password depends on your user rights:
|
||||
|
||||
@ -118,7 +118,7 @@ If you lose the password associated with the owner account and the steps above d
|
||||
- If you have a Home Assistant Green, [reset the Green](https://support.nabucasa.com/hc/en-us/articles/25161225495837).
|
||||
- If you have a Home Assistant Yellow, [reset the Yellow](https://support.nabucasa.com/hc/en-us/articles/25463622043165).
|
||||
|
||||
## Recovering data for Home Assistant (including Supervised)
|
||||
## Recovering data for Home Assistant
|
||||
|
||||
Unless your SD card/data is corrupted, you can still get to your files or troubleshoot further.
|
||||
There are a few routes:
|
||||
|
||||
@ -73,7 +73,7 @@ Firmware can be upgraded using the below directions:
|
||||
If you are just starting out, we recommend that you purchase a 700 series controller or a Raspberry Pi module. The 700 series controllers are the more recent version (when compared to the 500 series). The 700 series controllers support SmartStart, which allows you to add a device by scanning a QR code.
|
||||
|
||||
{% tip %}
|
||||
If you're using Home Assistant OS, Supervised, or Container, it's recommended to use a USB stick, not a module. Passing a module through Docker is more complicated than passing a USB stick through.
|
||||
It's recommended to use a USB stick, not a module. Passing a module through Docker is more complicated than passing a USB stick through.
|
||||
{% endtip %}
|
||||
|
||||
## Stick alternatives
|
||||
@ -107,8 +107,7 @@ On Raspberry Pi 3 and 4, you need to disable the on-board Bluetooth since the bo
|
||||
|
||||
For both processes below you will need to insert your SD card into your PC and open the configuration file with your favorite text editor.
|
||||
|
||||
- If you are using {% term "Home Assistant Operating System" %}, once you mounted the disk, you will see the `config.txt` directly in the root directory.
|
||||
- If you are using {% term "Home Assistant Supervised" %}, the config file is stored in the boot folder: `/boot/config.txt`.
|
||||
- Once you mounted the disk, you will see the `config.txt` directly in the root directory.
|
||||
|
||||
#### Raspberry Pi 5 procedure
|
||||
|
||||
|
||||
@ -9,6 +9,4 @@ When an integration does not show up, many different things can be the case. Bef
|
||||
If you have incorrect entries in your configuration files you can use the CLI script to check your configuration, each installation type has its own section in the common-tasks about this:
|
||||
|
||||
- [Operating System](/common-tasks/os/#configuration-check)
|
||||
- [Container](/common-tasks/container/#configuration-check)
|
||||
- [Core](/common-tasks/core/#configuration-check)
|
||||
- [Supervised](/common-tasks/supervised/#configuration-check)
|
||||
- [Container](/common-tasks/container/#configuration-check)
|
||||
@ -5,8 +5,6 @@
|
||||
<li>{% active_link /common-tasks/general/ Installation independent %}</li>
|
||||
<li>{% active_link /common-tasks/os/ Home Assistant Operating System %}</li>
|
||||
<li>{% active_link /common-tasks/container/ Home Assistant Container %}</li>
|
||||
<li>{% active_link /common-tasks/core/ Home Assistant Core %}</li>
|
||||
<li>{% active_link /common-tasks/supervised/ Home Assistant Supervised %}</li>
|
||||
</ul>
|
||||
</div>
|
||||
</section>
|
||||
|
||||
@ -192,8 +192,6 @@
|
||||
<li>{% active_link /common-tasks/general/ Installation independent %}</li>
|
||||
<li>{% active_link /common-tasks/os/ Home Assistant Operating System %}</li>
|
||||
<li>{% active_link /common-tasks/container/ Home Assistant Container %}</li>
|
||||
<li>{% active_link /common-tasks/core/ Home Assistant Core %}</li>
|
||||
<li>{% active_link /common-tasks/supervised/ Home Assistant Supervised %}</li>
|
||||
<li>{% active_link /docs/troubleshooting_general/ General troubleshooting %}</li>
|
||||
</ul>
|
||||
{% endif %}
|
||||
|
||||
@ -2,7 +2,7 @@
|
||||
|
||||
If you would like to test next release before anyone else, you can install the beta version.
|
||||
|
||||
{% if page.installation == "os" or page.installation == "supervised" %}
|
||||
{% if page.installation == "os" %}
|
||||
|
||||
{% tabbed_block %}
|
||||
|
||||
@ -53,28 +53,5 @@ docker pull {{ site.installation.container }}:beta
|
||||
|
||||
**[You then need to recreate the container with the new image.](/installation/linux#install-home-assistant-container)**
|
||||
|
||||
{% elsif page.installation == "core" %}
|
||||
|
||||
1. Stop the Home Assistant service.
|
||||
|
||||
2. Switch to the user that is running Home Assistant.
|
||||
|
||||
```bash
|
||||
sudo -u homeassistant -H -s
|
||||
```
|
||||
|
||||
3. Activate the virtual environment that Home Assistant is running in.
|
||||
|
||||
```bash
|
||||
source /srv/homeassistant/bin/activate
|
||||
```
|
||||
|
||||
4. Download and install the beta version.
|
||||
|
||||
```bash
|
||||
pip3 install --pre --upgrade homeassistant
|
||||
```
|
||||
|
||||
5. When that is complete, start the service again for it to use the new files.
|
||||
|
||||
{% endif %}
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
## Configuration check
|
||||
|
||||
{% if page.installation == "os" or page.installation == "supervised" %}
|
||||
{% if page.installation == "os" %}
|
||||
|
||||
After changing configuration or automation files, check if the configuration is valid before restarting Home Assistant Core.
|
||||
|
||||
@ -56,54 +56,4 @@ You can get help from the command line using:
|
||||
docker exec homeassistant python -m homeassistant --script check_config --help
|
||||
```
|
||||
|
||||
{% elsif page.installation == "core" %}
|
||||
|
||||
After changing configuration files, check if the configuration is valid before restarting Home Assistant Core.
|
||||
|
||||
1. Switch to the user that is running Home Assistant.
|
||||
|
||||
```bash
|
||||
sudo -u homeassistant -H -s
|
||||
```
|
||||
|
||||
2. Activate the virtual environment that Home Assistant is running in.
|
||||
|
||||
```bash
|
||||
source /srv/homeassistant/bin/activate
|
||||
```
|
||||
|
||||
3. Run the configuration check.
|
||||
|
||||
Run the full check:
|
||||
|
||||
```bash
|
||||
hass --script check_config
|
||||
```
|
||||
|
||||
Listing all loaded files:
|
||||
|
||||
```bash
|
||||
hass --script check_config --files
|
||||
```
|
||||
|
||||
Viewing a integration’s configuration ([`light`](/integrations/light) in this example):
|
||||
|
||||
```bash
|
||||
hass --script check_config --info light
|
||||
```
|
||||
|
||||
Or all integrations’ configuration
|
||||
|
||||
```bash
|
||||
hass --script check_config --info all
|
||||
```
|
||||
|
||||
You can get help from the command line using:
|
||||
|
||||
```bash
|
||||
hass --script check_config --help
|
||||
```
|
||||
|
||||
4. When that is complete, restart the service for it to use the new files.
|
||||
|
||||
{% endif %}
|
||||
|
||||
@ -6,7 +6,7 @@ If you want to stay on the bleeding-edge Home Assistant Core development branch,
|
||||
The `dev` branch is likely to be unstable. Potential consequences include loss of data and instance corruption.
|
||||
{% endcaution %}
|
||||
|
||||
{% if page.installation == "os" or page.installation == "supervised" %}
|
||||
{% if page.installation == "os" %}
|
||||
|
||||
1. Join the dev channel.
|
||||
|
||||
@ -36,28 +36,4 @@ docker pull {{ site.installation.container }}:dev
|
||||
|
||||
**[You then need to recreate the container with the new image.](/installation/linux#install-home-assistant-container)**
|
||||
|
||||
{% elsif page.installation == "core" %}
|
||||
|
||||
1. Stop the Home Assistant service.
|
||||
|
||||
2. Switch to the user that is running Home Assistant.
|
||||
|
||||
```bash
|
||||
sudo -u homeassistant -H -s
|
||||
```
|
||||
|
||||
3. Activate the virtual environment that Home Assistant is running in.
|
||||
|
||||
```bash
|
||||
source /srv/homeassistant/bin/activate
|
||||
```
|
||||
|
||||
4. Download and install the version you want.
|
||||
|
||||
```bash
|
||||
pip3 install --upgrade git+https://github.com/home-assistant/core.git@dev
|
||||
```
|
||||
|
||||
5. When that is complete, start the service again for it to use the new files.
|
||||
|
||||
{% endif %}
|
||||
|
||||
@ -2,7 +2,7 @@
|
||||
|
||||
{% assign current_version = site.current_major_version | append: "." | append: site.current_minor_version | append: "." | append: site.current_patch_version %}
|
||||
|
||||
{% if page.installation != "os" and page.installation != "supervised" %}
|
||||
{% if page.installation != "os" %}
|
||||
|
||||
To see which version your system is running, go to {% my info title="**Settings** > **About**" %}.
|
||||
|
||||
@ -10,7 +10,7 @@ In the event that a Home Assistant Core version doesn't play well with your hard
|
||||
|
||||
{% endif %}
|
||||
|
||||
{% if page.installation == "os" or page.installation == "supervised" %}
|
||||
{% if page.installation == "os"%}
|
||||
|
||||
To upgrade to a specific version, you can use the CLI. The example below shows how to upgrade to `{{current_version}}`.
|
||||
|
||||
@ -30,28 +30,4 @@ docker pull {{ site.installation.container }}:{{current_version}}
|
||||
|
||||
**[You then need to recreate the container with the new image.](/installation/linux#install-home-assistant-container)**
|
||||
|
||||
{% elsif page.installation == "core" %}
|
||||
|
||||
1. Stop the Home Assistant service.
|
||||
|
||||
2. Switch to the user that is running Home Assistant.
|
||||
|
||||
```bash
|
||||
sudo -u homeassistant -H -s
|
||||
```
|
||||
|
||||
3. Activate the virtual environment that Home Assistant is running in.
|
||||
|
||||
```bash
|
||||
source /srv/homeassistant/bin/activate
|
||||
```
|
||||
|
||||
4. Download and install the version you want.
|
||||
|
||||
```bash
|
||||
pip3 install homeassistant=={{current_version}}
|
||||
```
|
||||
|
||||
5. When that is complete start the service again for it to use the new files.
|
||||
|
||||
{% endif %}
|
||||
|
||||
@ -3,85 +3,60 @@ Best practice for updating Home Assistant Core:
|
||||
1. [Back up your installation](/common-tasks/general/#backups) and store the backup and the [backup emergency kit](/more-info/backup-emergency-kit/) somewhere safe.
|
||||
- This ensures that you can [restore your installation from backup](/common-tasks/general/#restoring-a-backup) if needed.
|
||||
2. Check the release notes for backward-incompatible changes on [Home Assistant release notes](/blog/categories/core/). Be sure to check all release notes between the version you are running and the one you are upgrading to. Use the search function in your browser (`CTRL + f` / `CMD + f`) and search for **Backward-incompatible changes**.
|
||||
3. Update Home Assistant.
|
||||
4. Review persistent notifications and log to see if there are any issues with your configuration that need to be addressed.
|
||||
3. To update Home Assistant Core, choose one of the following options.
|
||||
|
||||
{% if page.installation == "os" or page.installation == "supervised" %}
|
||||
{% if page.installation == "os" %}
|
||||
|
||||
To update Home Assistant Core when you run Home Assistant {{ page.installation_name }} you have 2 options.
|
||||
{% tabbed_block %}
|
||||
|
||||
{% tabbed_block %}
|
||||
- title: Using the UI
|
||||
content: |
|
||||
|
||||
- title: Using the UI
|
||||
content: |
|
||||
1. Open your Home Assistant UI.
|
||||
2. Navigate to the **Settings** panel.
|
||||
3. On the top you will be presented with an update notification.
|
||||
- **Troubleshooting**: If you do not see that notification:
|
||||
- In the top right corner, select the three dots {% icon "mdi:dots-vertical" %} menu and select **Check for updates**.
|
||||
- Go to {% my updates title="**System** > **Updates**" %}.
|
||||
- Select the update notification.
|
||||
- Select the cogwheel {% icon "mdi:cog-outline" %}, then set **Visible** to active.
|
||||
|
||||
1. Open your Home Assistant UI.
|
||||
2. Navigate to the **Settings** panel.
|
||||
3. On the top you will be presented with an update notification.
|
||||
- **Troubleshooting**: If you do not see that notification:
|
||||
- In the top right corner, select the three dots {% icon "mdi:dots-vertical" %} menu and select **Check for updates**.
|
||||
- Go to {% my updates title="**System** > **Updates**" %}.
|
||||
- Select the update notification.
|
||||
- Select the cogwheel {% icon "mdi:cog-outline" %}, then set **Visible** to active.
|
||||
- title: Using the CLI
|
||||
content: |
|
||||
|
||||
- title: Using the CLI
|
||||
content: |
|
||||
```bash
|
||||
ha core update --backup
|
||||
```
|
||||
|
||||
```bash
|
||||
ha core update --backup
|
||||
```
|
||||
_The_ `--backup` _flag here ensures that you have a partial backup of your current setup in case you need to downgrade._
|
||||
|
||||
_The_ `--backup` _flag here ensures that you have a partial backup of your current setup incase you need to downgrade._
|
||||
|
||||
{% endtabbed_block %}
|
||||
{% endtabbed_block %}
|
||||
|
||||
{% elsif page.installation == "container" %}
|
||||
|
||||
{% tabbed_block %}
|
||||
{% tabbed_block %}
|
||||
|
||||
- title: Docker CLI
|
||||
content: |
|
||||
- title: Docker CLI
|
||||
content: |
|
||||
|
||||
**First start with pulling the new container.**
|
||||
**First start with pulling the new container.**
|
||||
|
||||
```bash
|
||||
docker pull {{ site.installation.container }}:stable
|
||||
```
|
||||
```bash
|
||||
docker pull {{ site.installation.container }}:stable
|
||||
```
|
||||
|
||||
**[You then need to recreate the container with the new image.](/installation/linux#install-home-assistant-container)**
|
||||
**[You then need to recreate the container with the new image.](/installation/linux#install-home-assistant-container)**
|
||||
|
||||
- title: Docker Compose
|
||||
content: |
|
||||
- title: Docker Compose
|
||||
content: |
|
||||
|
||||
```bash
|
||||
docker compose pull homeassistant
|
||||
docker compose up -d
|
||||
```
|
||||
```bash
|
||||
docker compose pull homeassistant
|
||||
docker compose up -d
|
||||
```
|
||||
|
||||
{% endtabbed_block %}
|
||||
|
||||
{% elsif page.installation == "core" %}
|
||||
|
||||
1. Stop the Home Assistant service.
|
||||
|
||||
2. Switch to the user that is running Home Assistant
|
||||
|
||||
```bash
|
||||
sudo -u homeassistant -H -s
|
||||
```
|
||||
|
||||
3. Activate the virtual environment that Home Assistant is running in
|
||||
|
||||
```bash
|
||||
source /srv/homeassistant/bin/activate
|
||||
```
|
||||
|
||||
4. Download and install the new version
|
||||
|
||||
```bash
|
||||
pip3 install --upgrade homeassistant
|
||||
```
|
||||
|
||||
5. When that is complete start the service again for it to use the new files.
|
||||
{% endtabbed_block %}
|
||||
|
||||
{% endif %}
|
||||
|
||||
4. Check if there are any repair issues and check the logs to see if there are any issues with your configuration that need to be addressed.
|
||||
|
||||
@ -73,7 +73,6 @@ The steps would be:
|
||||
- Install "Container Station" package on your Qnap NAS
|
||||
- Launch Container Station and move to "Create Container"-section
|
||||
- Search image "homeassistant/home-assistant" with Docker Hub and click on "Install"
|
||||
Make attention to CPU architecture of your NAS. For ARM CPU types the correct image is "homeassistant/armhf-homeassistant"
|
||||
- Choose "stable" version and click next
|
||||
- Choose a container-name you want (e.g., "homeassistant")
|
||||
- Click on "Advanced Settings"
|
||||
|
||||
@ -1,101 +0,0 @@
|
||||
## Install Home Assistant Core
|
||||
|
||||
{% if page.installation_type == 'windows' %}
|
||||
### Install WSL
|
||||
|
||||
To install {% term "Home Assistant Core" %} on Windows, you will need to use the Windows Subsystem for Linux (WSL). Follow the [WSL installation instructions](https://docs.microsoft.com/windows/wsl/install-win10) and install Ubuntu from the Windows Store.
|
||||
|
||||
As an alternative, Home Assistant OS can be installed in a Linux guest VM. Running {% term "Home Assistant Core" %} directly on Windows is not supported.
|
||||
{% endif %}
|
||||
|
||||
{% caution %}
|
||||
This is an advanced installation process, and some steps might differ on your system. Considering the nature of this installation type, we assume you can handle subtle differences between this document and the system configuration you are using. When in doubt, please consider one of the [other installation methods](/installation/), as they might be a better fit instead.
|
||||
{% endcaution %}
|
||||
|
||||
### Prerequisites
|
||||
|
||||
This guide assumes that you already have an operating system setup and have installed Python {{site.installation.versions.python}} (including the package `python3-dev`) or newer.
|
||||
|
||||
### Install dependencies
|
||||
|
||||
Before you start, make sure your system is fully updated, all packages in this guide are installed with `apt`, if your OS does not have that, look for alternatives.
|
||||
|
||||
```bash
|
||||
sudo apt-get update
|
||||
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 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.
|
||||
|
||||
### Create an account
|
||||
|
||||
Add an account for Home Assistant Core called `homeassistant`.
|
||||
Since this account is only for running Home Assistant Core the extra arguments of `-rm` is added to create a system account and create a home directory.
|
||||
{%- if site.installation.types[page.installation_type].board %}
|
||||
The arguments `-G dialout,gpio,i2c` adds the user to the `dialout`, `gpio` and the `i2c` group. The first is required for using Z-Wave and Zigbee controllers, while the second is required to communicate with GPIO.
|
||||
|
||||
```bash
|
||||
sudo useradd -rm homeassistant -G dialout,gpio,i2c
|
||||
```
|
||||
|
||||
{% else %}
|
||||
|
||||
```bash
|
||||
sudo useradd -rm homeassistant
|
||||
```
|
||||
|
||||
{% endif %}
|
||||
|
||||
### Create the virtual environment
|
||||
|
||||
First we will create a directory for the installation of Home Assistant Core and change the owner to the `homeassistant` account.
|
||||
|
||||
```bash
|
||||
sudo mkdir /srv/homeassistant
|
||||
sudo chown homeassistant:homeassistant /srv/homeassistant
|
||||
```
|
||||
|
||||
Next up is to create and change to a virtual environment for Home Assistant Core. This will be done as the `homeassistant` account.
|
||||
|
||||
```bash
|
||||
sudo -u homeassistant -H -s
|
||||
cd /srv/homeassistant
|
||||
python3 -m venv .
|
||||
source bin/activate
|
||||
```
|
||||
|
||||
Once you have activated the virtual environment (notice the prompt change to `(homeassistant) homeassistant@raspberrypi:/srv/homeassistant $`) you will need to run the following command to install a required Python package.
|
||||
|
||||
```bash
|
||||
python3 -m pip install wheel
|
||||
```
|
||||
|
||||
Once you have installed the required Python package, it is now time to install Home Assistant Core!
|
||||
|
||||
```bash
|
||||
pip3 install homeassistant=={{ site.current_major_version }}.{{ site.current_minor_version }}.{{ site.current_patch_version }}
|
||||
```
|
||||
|
||||
**Troubleshooting**: If you do not see the above version of Home Assistant package in your environment, make sure you have the correct Python version installed, as defined under the [Prerequisites](#prerequisites).
|
||||
|
||||
Start Home Assistant Core for the first time. This will complete the installation for you, automatically creating the `.homeassistant` configuration directory in the `/home/homeassistant` directory, and installing any basic dependencies.
|
||||
|
||||
```bash
|
||||
hass
|
||||
```
|
||||
|
||||
You can now reach your installation via the web interface on `http://homeassistant.local:8123`.
|
||||
|
||||
If this address doesn't work you may also try `http://localhost:8123` or `http://X.X.X.X:8123` (replace X.X.X.X with your machines’ IP address).
|
||||
|
||||
{% note %}
|
||||
|
||||
When you run the `hass` command for the first time, it will download, install and cache the necessary libraries/dependencies. This procedure may take anywhere between 5 to 10 minutes. During that time, you may get a **site cannot be reached** error when accessing the web interface. This will only happen the first time. Subsequent restarts will be much faster.
|
||||
|
||||
{% endnote %}
|
||||
@ -20,7 +20,7 @@ The built-in Alexa integration allows you to integrate Home Assistant into Alexa
|
||||
|
||||
- Amazon Developer Account. You can sign on [here](https://developer.amazon.com).
|
||||
- An [AWS account](https://aws.amazon.com/free/) is needed if you want to use the Alexa Custom Skill API. Part of your Alexa Custom Skill will be hosted on [AWS Lambda](https://aws.amazon.com/lambda/pricing/). However, you don't need to worry about the cost, as AWS Lambda allows for free to use up to 1 million requests and 1GB outbound data transfer per month.
|
||||
- The Alexa Custom Skill API also needs your Home Assistant instance to be accessible from the internet via HTTPS on port 443 using a certificate signed by [an Amazon approved certificate authority](https://ccadb-public.secure.force.com/mozilla/IncludedCACertificateReport). This is so account linking can take place. Read more on [our blog](/blog/2015/12/13/setup-encryption-using-lets-encrypt/) about how to set up encryption for Home Assistant. When running Home Assistant OS or Supervised, using the [Duck DNS](/addons/duckdns/) add-on is the easiest method.
|
||||
- The Alexa Custom Skill API also needs your Home Assistant instance to be accessible from the internet via HTTPS on port 443 using a certificate signed by [an Amazon approved certificate authority](https://ccadb-public.secure.force.com/mozilla/IncludedCACertificateReport). This is so account linking can take place. Read more on [our blog](/blog/2015/12/13/setup-encryption-using-lets-encrypt/) about how to set up encryption for Home Assistant. When running {% term "Home Assistant Operating System" %}, using the [Duck DNS](/addons/duckdns/) add-on is the easiest method.
|
||||
|
||||
### Create Your Amazon Alexa Custom Skill
|
||||
|
||||
|
||||
@ -294,12 +294,12 @@ retain:
|
||||
type: boolean
|
||||
default: true
|
||||
speed_range_max:
|
||||
description: The maximum of numeric output range (representing 100 %). The number of speeds within the `speed_range` / `100` will determine the `percentage_step`.
|
||||
description: The maximum of numeric output range (representing 100 %). The `percentage_step` is defined by `100` / the number of speeds within the speed range.
|
||||
required: false
|
||||
type: integer
|
||||
default: 100
|
||||
speed_range_min:
|
||||
description: The minimum of numeric output range (`off` not included, so `speed_range_min` - `1` represents 0 %). The number of speeds within the speed_range / 100 will determine the `percentage_step`.
|
||||
description: The minimum of numeric output range (`off` not included, so `speed_range_min` - `1` represents 0 %). The `percentage_step` is defined by `100` / the number of speeds within the speed range.
|
||||
required: false
|
||||
type: integer
|
||||
default: 1
|
||||
|
||||
@ -21,6 +21,20 @@ The **File size** {% term integration %} is for displaying the size in MB of a f
|
||||
|
||||
File paths must also be added to [allowlist_external_dirs](/integrations/homeassistant/#allowlist_external_dirs) in your `configuration.yaml`.
|
||||
|
||||
Example `allowlist_external_dirs` configuration to monitor a file in your configuration folder.
|
||||
|
||||
{% raw %}
|
||||
|
||||
```yaml
|
||||
|
||||
homeassistant:
|
||||
allowlist_external_dirs:
|
||||
- "/config" # Default configuration directory
|
||||
|
||||
```
|
||||
|
||||
{% endraw %}
|
||||
|
||||
File paths should be absolute paths. For example: `/config/home-assistant_v2.db` to monitor the size of the default database.
|
||||
|
||||
{% endimportant %}
|
||||
|
||||
@ -83,7 +83,7 @@ But you can do the following workaround that exposes a script to voice assistant
|
||||
|
||||
1. Add a second Google Generative AI service.
|
||||
2. Select **Configure**
|
||||
3. Select **No control** under **Control Home Assistant**
|
||||
3. In the **Control Home Assistant** section, uncheck **Assist** and any other options.
|
||||
4. Uncheck **Recommended model settings**
|
||||
5. Select **Submit**
|
||||
6. Check **Enable Google Search tool**
|
||||
|
||||
@ -354,7 +354,7 @@ notify:
|
||||
- action: html5
|
||||
data:
|
||||
target: "macbook"
|
||||
- action: html5_nexus
|
||||
- action: mobile_app_pauluus
|
||||
```
|
||||
|
||||
{% configuration %}
|
||||
|
||||
@ -22,8 +22,8 @@ ha_integration_type: integration
|
||||
---
|
||||
|
||||
Supervisor integration allows you to monitor and control Supervisor add-ons and operating system from Home Assistant.
|
||||
This integration is already installed if you run Home Assistant OS or Supervised. Please note that this integration
|
||||
cannot be installed on Home Assistant Container or Core (Python venv) installation types.
|
||||
This integration is already installed if you run {% term "Home Assistant Operating System" %}. Please note that this integration
|
||||
cannot be installed on {% term "Home Assistant Container" %}.
|
||||
|
||||
## Sensor entities
|
||||
|
||||
|
||||
@ -14,7 +14,7 @@ ha_platforms:
|
||||
---
|
||||
|
||||
The Home Assistant Hardware integration provides functionality
|
||||
shared between Home Assistant Yellow and Home Assistant Connect ZBT-1.
|
||||
shared between [Home Assistant Connect ZBT-1](/integrations/homeassistant_sky_connect/), [Home Assistant Green](/integrations/homeassistant_green), and [Home Assistant Yellow](/integrations/homeassistant_yellow/).
|
||||
|
||||
## Configuration
|
||||
|
||||
|
||||
@ -75,12 +75,6 @@ region:
|
||||
default: "`eastus`"
|
||||
{% endconfiguration %}
|
||||
|
||||
{% note %}
|
||||
Not all Azure regions support high-quality neural voices. Use [this overview](https://learn.microsoft.com/azure/cognitive-services/speech-service/regions) to determine the availability of standard and neural voices by region/endpoint.
|
||||
|
||||
New users ([any newly created Azure Speech resource after August 31st, 2021](https://learn.microsoft.com/azure/cognitive-services/speech-service/text-to-speech#more-about-neural-text-to-speech-features)) can only use neural voices. Existing resources can continue using standard voices through August 31st, 2024.
|
||||
{% endnote %}
|
||||
|
||||
{% important %}
|
||||
If you set the language to anything other than the default `en-us`, you will need to specify a matching voice type as well.
|
||||
{% endimportant %}
|
||||
|
||||
@ -109,6 +109,8 @@ This platform allows you to detect presence by looking at devices connected to a
|
||||
|
||||
If tracked devices continue to show "Home" when not connect/present and show connected in the UniFi Controller, disable 802.11r Fast Roaming. When enabled, it has been observed on the various UniFi Controller versions, failure to declare disconnected clients.
|
||||
|
||||
Presence detection is not compatible with Client MAC Address Randomization, enabled by default on most modern SmartPhones. This feature will need to be disabled within the client device settings, usually under the settings for the specific network.
|
||||
|
||||
Presence detection depends on accurate time configuration between Home Assistant and the UniFi Network application.
|
||||
|
||||
If Home Assistant and the UniFi Network application are running on separate machines or VMs ensure that all clocks are synchronized. Failing to have synchronized clocks will lead to Home Assistant failing to mark a device as home.
|
||||
|
||||
@ -1,17 +0,0 @@
|
||||
---
|
||||
title: "Common tasks - Core"
|
||||
description: "Common tasks for Home Assistant Core"
|
||||
installation: core
|
||||
---
|
||||
|
||||
## Backup
|
||||
|
||||
To learn how to back up the system or how to restore a system from a backup, refer to the backup documentation under [common tasks](/common-tasks/general/#backups).
|
||||
|
||||
## Update
|
||||
|
||||
{% include common-tasks/update.md %}
|
||||
{% include common-tasks/specific_version.md %}
|
||||
{% include common-tasks/beta_version.md %}
|
||||
{% include common-tasks/development_version.md %}
|
||||
{% include common-tasks/configuration_check.md %}
|
||||
@ -1,43 +0,0 @@
|
||||
---
|
||||
title: "Common tasks - Supervised"
|
||||
description: "Common tasks for Home Assistant Supervised"
|
||||
installation: supervised
|
||||
installation_name: Supervised
|
||||
related:
|
||||
- docs: /docs/configuration/
|
||||
---
|
||||
|
||||
|
||||
{% include common-tasks/file_access.md %}
|
||||
|
||||
## Backup
|
||||
|
||||
To learn how to back up the system or how to restore a system from a backup, refer to the backup documentation under [common tasks](/common-tasks/general/#backups).
|
||||
|
||||
### Alternative: Creating a backup using the Home Assistant Command Line Interface
|
||||
|
||||
In general, to create or restore from a backup, follow the steps described under [common tasks](/common-tasks/general/#backups). However, If you have the {% term "Home Assistant Supervised" %} installed, you can also create a backup from the command line. Follow these steps:
|
||||
|
||||
1. `ha backups list` - lists backups and their slugnames
|
||||
2. `ha backups restore slugname` - restores a specific backup
|
||||
3. `ha backups new --name nameofbackup` - create a backup
|
||||
|
||||
For additional information about command line usage, use the `ha help` command or refer to the [Home Assistant Command Line documentation](/common-tasks/supervised/#home-assistant-via-the-command-line).
|
||||
|
||||
## Update
|
||||
|
||||
{% include common-tasks/update.md %}
|
||||
{% include common-tasks/network_storage.md %}
|
||||
{% include common-tasks/lost_password.md %}
|
||||
{% include common-tasks/third-party-addons.md %}
|
||||
{% include common-tasks/configuration_check.md %}
|
||||
|
||||
## Home Assistant versions
|
||||
|
||||
To see which version your system is running, go to {% my info title="**Settings** > **About**" %}.
|
||||
|
||||
{% include common-tasks/specific_version.md %}
|
||||
{% include common-tasks/beta_version.md %}
|
||||
{% include common-tasks/development_version.md %}
|
||||
|
||||
{% include common-tasks/commandline.md %}
|
||||
@ -36,13 +36,9 @@ To change basic settings such as location, unit system, and language, refer to [
|
||||
|
||||
## Creating a backup
|
||||
|
||||
You can back up your Home Assistant, add-on data, and configuration. Backups are used to restore a system or parts of it if a rollback is needed, or to migrate your Home Assistant to new hardware. It is good practice to create a backup before updating.
|
||||
You can back up your Home Assistant, add-on data, and configuration. Backups are used to restore the system (or parts of the system) if a rollback is needed. Backups are also used or to migrate your Home Assistant to new hardware. It is good practice to create a backup before updating.
|
||||
|
||||
To learn how to create a backup of your Home Assistant installation, select the link below that matches your installation type.
|
||||
|
||||
- {% term "Home Assistant Operating System" %}: [Creating a backup from OS](/common-tasks/general/#backups)
|
||||
- {% term "Home Assistant Supervised" %}: [Creating a backup from Supervised](/common-tasks/general/#backups)
|
||||
- {% term "Home Assistant Core" %} or {% term "Home Assistant Container" %}: [Creating a backup from Core or Container](/integrations/backup/)
|
||||
To learn how to create a backup of your Home Assistant installation, refer to the documentation on [creating a backup](/common-tasks/general/#backups).
|
||||
|
||||
## Editing the configuration.yaml and configuring file access
|
||||
|
||||
@ -55,4 +51,3 @@ If you need more space to store data, you can configure a [network storage](/com
|
||||
## Getting started with voice assistant
|
||||
|
||||
If you want to get started with a voice assistant, refer to the documentation on [Assist](/voice_control/).
|
||||
|
||||
|
||||
@ -1,7 +1,10 @@
|
||||
---
|
||||
title: "Advanced Raspberry Pi installations"
|
||||
description: "Advanced instructions to install Home Assistant variants on a Raspberry Pi"
|
||||
title: "Advanced Raspberry Pi installation"
|
||||
description: "Instructions to install Home Assistant Container on a Raspberry Pi. This is for advanced users only."
|
||||
installation_type: raspberrypi-other
|
||||
related:
|
||||
- docs: /installation/raspberrypi/
|
||||
title: Installing the Home Assistant OS on Raspberry Pi
|
||||
---
|
||||
|
||||
{% comment %}
|
||||
@ -11,8 +14,7 @@ Included section for this page is located under source/_includes/installation
|
||||
{% assign board = "Raspberry Pi" %}
|
||||
{% assign installation_media = "SD card" %}
|
||||
|
||||
While we recommend Home Assistant OS, there are also alternative ways to install Home Assistant. Before you continue, be aware of the limitations and differences compared to Home Assistant OS. You can find more information on the [installation page](/installation/#about-installation-methods). Most notably,
|
||||
While we recommend using the {% term "Home Assistant Operating System" %}, you can also use the {% term "Home Assistant Container" %} method to install Home Assistant. Before you continue, be aware of the limitations and differences compared to the {% term "Home Assistant Operating System" %}. You can find more information on the [installation page](/installation/#about-installation-methods). Most notably,
|
||||
<a href="/addons">add-ons</a> are only available with the Home Assistant Operating System.
|
||||
|
||||
{% include installation/container.md %}
|
||||
{% include installation/core.md %}
|
||||
|
||||
@ -14,9 +14,9 @@ You can access your (automatically) created media folder using the dashboard.
|
||||
Navigate to the {% my media_browser title="Media > Local Media" %}, and in the
|
||||
top right corner, click manage. Here you can add and delete your media.
|
||||
|
||||
## Home Assistant OS & Supervised
|
||||
## Home Assistant OS
|
||||
|
||||
If you are running Home Assistant OS or Supervised, you can also use the
|
||||
If you are running {% term "Home Assistant Operating System" %}, you can also use the
|
||||
Samba add-on. If you haven't installed the Samba add-on yet, you can do
|
||||
so by browsing to the {% my supervisor title="Settings > Add-ons" %} panel.
|
||||
Next, click on the "Add-on store" tab and search for "Samba" and click on it.
|
||||
@ -28,18 +28,11 @@ media onto your device using drag and drop in your file explorer.
|
||||
Other add-ons are available, for example, SSH and others provide access to the
|
||||
media folders as well.
|
||||
|
||||
## Home Assistant Docker
|
||||
## Home Assistant Container
|
||||
|
||||
After you have [set up a local media][setup-media] folder, you can add
|
||||
any media to that folder you have mounted in.
|
||||
|
||||
Your media will show up in the Home Assistant frontend automatically.
|
||||
|
||||
## Home Assistant Core
|
||||
|
||||
After you have [set up a local media][setup-media] folder, you can add any
|
||||
media to that folder you have set up.
|
||||
|
||||
Your media will show up in the Home Assistant frontend automatically.
|
||||
|
||||
[setup-media]: /more-info/local-media/setup-media
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user