mirror of
https://github.com/home-assistant/home-assistant.io.git
synced 2025-12-10 13:05:27 -06:00
Merge branch 'current' into next
This commit is contained in:
Franck Nijhof
commit
fdcd3afd9c
@ -1,8 +1,8 @@
|
||||
GEM
|
||||
remote: https://rubygems.org/
|
||||
specs:
|
||||
addressable (2.8.7)
|
||||
public_suffix (>= 2.0.2, < 7.0)
|
||||
addressable (2.8.8)
|
||||
public_suffix (>= 2.0.2, < 8.0)
|
||||
ast (2.4.3)
|
||||
base64 (0.3.0)
|
||||
bigdecimal (3.3.1)
|
||||
@ -97,7 +97,7 @@ GEM
|
||||
pathutil (0.16.2)
|
||||
forwardable-extended (~> 2.6)
|
||||
prism (1.6.0)
|
||||
public_suffix (6.0.2)
|
||||
public_suffix (7.0.0)
|
||||
racc (1.8.1)
|
||||
rack (3.2.4)
|
||||
rack-protection (4.2.1)
|
||||
|
||||
@ -296,8 +296,9 @@
|
||||
- groups
|
||||
- term: HASS
|
||||
definition: >-
|
||||
HASS or [hass](/docs/tools/hass/) is often used as an abbreviation for Home
|
||||
Assistant. It is also the command-line tool.
|
||||
HASS is an abbreviation for Home Assistant that was commonly used in the past.
|
||||
This abbreviation is no longer actively used. It is recommended to use the full
|
||||
name "Home Assistant" instead of abbreviations.
|
||||
- term: HassOS
|
||||
definition: >-
|
||||
Another name for Home Assistant Operating System
|
||||
|
||||
@ -1,25 +1,30 @@
|
||||
green:
|
||||
name: "<strong>Home Assistant Green</strong>"
|
||||
distributors:
|
||||
# America
|
||||
# North America
|
||||
- name: Amazon US
|
||||
ship_from: US
|
||||
ship_to: America
|
||||
ship_to: North America
|
||||
url: https://www.amazon.com/dp/B0CXVKSG19?maas=maas_adg_BB51722E249D328CABB2F6DF1F8976CC_afap_abs&ref_=aa_maas&tag=maas
|
||||
logo: /images/distributors/amazon.webp
|
||||
- name: Apollo Automation
|
||||
ship_from: US & Canada
|
||||
ship_to: North America
|
||||
url: https://apolloautomation.com/products/home-assistant-green
|
||||
logo: /images/distributors/apollo.webp
|
||||
- name: ameriDroid
|
||||
ship_from: US
|
||||
ship_to: America
|
||||
ship_to: North America
|
||||
url: https://ameridroid.com/products/home-assistant-green
|
||||
logo: /images/distributors/ameridroid.webp
|
||||
- name: CloudFree
|
||||
ship_from: US
|
||||
ship_to: America
|
||||
ship_to: North America
|
||||
url: https://cloudfree.shop/product/home-assistant-green/
|
||||
logo: /images/distributors/cloudfree.webp
|
||||
- name: Seeed Studio
|
||||
ship_from: US
|
||||
ship_to: America
|
||||
ship_to: North America
|
||||
url: https://www.seeedstudio.com/Home-Assistant-Green-p-5792.html
|
||||
logo: /images/distributors/seeed-studio.webp
|
||||
# Asia
|
||||
@ -94,7 +99,7 @@ green:
|
||||
ship_from: Portugal
|
||||
ship_to: Europe
|
||||
url: https://mauser.pt/catalog/product_info.php?products_id=095-3152
|
||||
logo: /images/distributors/mauser.png
|
||||
logo: /images/distributors/mauser.webp
|
||||
- name: mediarath
|
||||
ship_from: Germany
|
||||
ship_to: Europe
|
||||
@ -160,18 +165,33 @@ green:
|
||||
ship_to: Europe
|
||||
url: https://www.inet.se/produkt/8310063/home-assistant-green
|
||||
logo: /images/distributors/inet.webp
|
||||
- name: Nettop
|
||||
ship_from: Greece
|
||||
ship_to: Europe
|
||||
url: https://nettop.gr/index.php/smart-home/home-assistant/home-assistant-green.html
|
||||
logo: /images/distributors/nettop.webp
|
||||
- name: BerryBase
|
||||
ship_from: Germany
|
||||
ship_to: Europe
|
||||
url: https://www.berrybase.de/detail/019a8296042d70f19cbbcb67ddc0b205
|
||||
logo: /images/distributors/berrybase.webp
|
||||
- name: SmartDomo
|
||||
ship_from: Germany
|
||||
ship_to: Europe
|
||||
url: https://smartdomo.de/products/home-assistant-green
|
||||
logo: /images/distributors/smartdomo.webp
|
||||
yellow:
|
||||
name: "<strong>Home Assistant Yellow</strong>"
|
||||
distributors:
|
||||
# America
|
||||
# North America
|
||||
- name: ameriDroid
|
||||
ship_from: US
|
||||
ship_to: America
|
||||
ship_to: North America
|
||||
url: https://ameridroid.com/products/home-assistant-yellow
|
||||
logo: /images/distributors/ameridroid.webp
|
||||
- name: CloudFree
|
||||
ship_from: US
|
||||
ship_to: America
|
||||
ship_to: North America
|
||||
url: https://cloudfree.shop/product/home-assistant-yellow/
|
||||
logo: /images/distributors/cloudfree.webp
|
||||
# Australia
|
||||
@ -194,20 +214,20 @@ yellow:
|
||||
zbt-1:
|
||||
name: "<strong>Home Assistant Connect ZBT-1</strong>"
|
||||
distributors:
|
||||
# America
|
||||
# North America
|
||||
- name: ameriDroid
|
||||
ship_from: US
|
||||
ship_to: America
|
||||
ship_to: North America
|
||||
url: https://ameridroid.com/products/skyconnect
|
||||
logo: /images/distributors/ameridroid.webp
|
||||
- name: CloudFree
|
||||
ship_from: US
|
||||
ship_to: America
|
||||
ship_to: North America
|
||||
url: https://cloudfree.shop/product/home-assistant-skyconnect/
|
||||
logo: /images/distributors/cloudfree.webp
|
||||
- name: Seeed Studio
|
||||
ship_from: US
|
||||
ship_to: America
|
||||
ship_to: North America
|
||||
url: https://www.seeedstudio.com/Home-Assistant-SkyConnect-p-5479.html
|
||||
logo: /images/distributors/seeed-studio.webp
|
||||
# Asia
|
||||
@ -267,7 +287,7 @@ zbt-1:
|
||||
ship_from: Portugal
|
||||
ship_to: Europe
|
||||
url: https://mauser.pt/catalog/product_info.php?products_id=095-1222
|
||||
logo: /images/distributors/mauser.png
|
||||
logo: /images/distributors/mauser.webp
|
||||
- name: mediarath
|
||||
ship_from: Germany
|
||||
ship_to: Europe
|
||||
@ -336,20 +356,25 @@ zbt-1:
|
||||
voice-pe:
|
||||
name: "<strong>Home Assistant Voice</strong> Preview Edition"
|
||||
distributors:
|
||||
# America
|
||||
# North America
|
||||
- name: ameriDroid
|
||||
ship_from: US
|
||||
ship_to: America
|
||||
ship_to: North America
|
||||
url: https://ameridroid.com/products/home-assistant-voice-preview-edition/
|
||||
logo: /images/distributors/ameridroid.webp
|
||||
- name: Apollo Automation
|
||||
ship_from: US & Canada
|
||||
ship_to: North America
|
||||
url: https://apolloautomation.com/products/home-assistant-voice
|
||||
logo: /images/distributors/apollo.webp
|
||||
- name: CloudFree
|
||||
ship_from: US
|
||||
ship_to: America
|
||||
ship_to: North America
|
||||
url: https://cloudfree.shop/product/home-assistant-voice-preview-edition/
|
||||
logo: /images/distributors/cloudfree.webp
|
||||
- name: Seeed Studio
|
||||
ship_from: US
|
||||
ship_to: America
|
||||
ship_to: North America
|
||||
url: https://www.seeedstudio.com/Home-Assistant-Voice-p-6998.html
|
||||
logo: /images/distributors/seeed-studio.webp
|
||||
# Asia
|
||||
@ -409,7 +434,7 @@ voice-pe:
|
||||
ship_from: Portugal
|
||||
ship_to: Europe
|
||||
url: https://mauser.pt/catalog/product_info.php?products_id=095-4747
|
||||
logo: /images/distributors/mauser.png
|
||||
logo: /images/distributors/mauser.webp
|
||||
- name: SmarterHOME
|
||||
ship_from: Slovakia
|
||||
ship_to: Europe
|
||||
@ -455,10 +480,25 @@ voice-pe:
|
||||
ship_to: Europe
|
||||
url: https://www.robbshop.nl/home-assistant-voice-preview-edition
|
||||
logo: /images/distributors/robb.webp
|
||||
- name: Nettop
|
||||
ship_from: Greece
|
||||
ship_to: Europe
|
||||
url: https://nettop.gr/index.php/smart-home/home-assistant/home-assistant-voice.html
|
||||
logo: /images/distributors/nettop.webp
|
||||
- name: BerryBase
|
||||
ship_from: Germany
|
||||
ship_to: Europe
|
||||
url: https://www.berrybase.de/detail/019a8294e0e872c6a26a43c31d66e37a
|
||||
logo: /images/distributors/berrybase.webp
|
||||
- name: SmartDomo
|
||||
ship_from: Germany
|
||||
ship_to: Europe
|
||||
url: https://smartdomo.de/products/home-assistant-voice-preview-edition-sprachassistent-nabu-casa-nc-vk-9727
|
||||
logo: /images/distributors/smartdomo.webp
|
||||
zwa-2:
|
||||
name: "<strong>Home Assistant</strong> Connect ZWA-2"
|
||||
distributors:
|
||||
# America
|
||||
# North America
|
||||
- name: Amazon
|
||||
ship_from: US
|
||||
ship_to: North America
|
||||
@ -521,7 +561,7 @@ zwa-2:
|
||||
ship_from: Portugal
|
||||
ship_to: Europe
|
||||
url: https://mauser.pt/catalog/product_info.php?products_id=095-6904
|
||||
logo: /images/distributors/mauser.png
|
||||
logo: /images/distributors/mauser.webp
|
||||
- name: RaspberryPi.dk
|
||||
ship_from: Denmark
|
||||
ship_to: Europe
|
||||
@ -612,9 +652,23 @@ zwa-2:
|
||||
ship_to: Europe
|
||||
url: https://www.robbshop.nl/home-assistant-connect-zwa-2-z-wave-antenne
|
||||
logo: /images/distributors/robb.webp
|
||||
- name: Nettop
|
||||
ship_from: Greece
|
||||
ship_to: Europe
|
||||
url: https://nettop.gr/index.php/smart-home/home-assistant/home-assistant-connect-zwa-2.html
|
||||
logo: /images/distributors/nettop.webp
|
||||
- name: BerryBase
|
||||
ship_from: Germany
|
||||
ship_to: Europe
|
||||
url: https://www.berrybase.de/detail/019a8294957e72eeac488049bae6e5f7
|
||||
logo: /images/distributors/berrybase.webp
|
||||
- name: SmartDomo
|
||||
ship_from: Germany
|
||||
ship_to: Europe
|
||||
url: https://smartdomo.de/products/z-wave-adapter-home-assistant-connect-zwa-2
|
||||
logo: /images/distributors/smartdomo.webp
|
||||
zbt-2:
|
||||
name: "<strong>Home Assistant</strong> Connect ZBT-2"
|
||||
new: true
|
||||
distributors:
|
||||
# North America
|
||||
#- name: Amazon
|
||||
@ -739,7 +793,7 @@ zbt-2:
|
||||
ship_from: Portugal
|
||||
ship_to: Europe
|
||||
url: https://mauser.pt/095-7567
|
||||
logo: /images/distributors/mauser.png
|
||||
logo: /images/distributors/mauser.webp
|
||||
- name: WIFIShop
|
||||
ship_from: Romania
|
||||
ship_to: Europe
|
||||
|
||||
@ -191,6 +191,7 @@ entity:
|
||||
description: >
|
||||
Limits the list of areas to areas that have entities with a certain
|
||||
supported feature, for example, `light.LightEntityFeature.TRANSITION` or `climate.ClimateEntityFeature.TARGET_TEMPERATURE`. Should be a list of features.
|
||||
For a list of supported features for each entity type, refer to the [entity documentation](https://developers.home-assistant.io/docs/core/entity).
|
||||
type: list
|
||||
required: false
|
||||
multiple:
|
||||
@ -540,6 +541,7 @@ entity:
|
||||
description: >
|
||||
Limits the list of devices to devices that have entities with a certain
|
||||
supported feature, for example, `light.LightEntityFeature.TRANSITION` or `climate.ClimateEntityFeature.TARGET_TEMPERATURE`. Should be a list of features.
|
||||
For a list of supported features for each entity type, refer to the [entity documentation](https://developers.home-assistant.io/docs/core/entity).
|
||||
type: list
|
||||
required: false
|
||||
filter:
|
||||
@ -1517,6 +1519,13 @@ entity:
|
||||
or a list of string device_class to limit the selection to.
|
||||
type: [device_class, list]
|
||||
required: false
|
||||
supported_features:
|
||||
description: >
|
||||
Limits the targets to entities with a certain supported feature, for example,
|
||||
`light.LightEntityFeature.TRANSITION` or `climate.ClimateEntityFeature.TARGET_TEMPERATURE`. Should be a list of features.
|
||||
For a list of supported features for each entity type, refer to the [entity documentation](https://developers.home-assistant.io/docs/core/entity).
|
||||
type: list
|
||||
required: false
|
||||
{% endconfiguration %}
|
||||
|
||||
{% important %}
|
||||
|
||||
@ -46,9 +46,9 @@ You are the owner or administrator of Home Assistant and forgot your password.
|
||||
|
||||
If you are the owner or have administrator, there are different methods to reset a password, depending on your situation:
|
||||
|
||||
- [Reset a password while still logged in](#to-reset-a-password-while-still-logged-in-including-supervised)
|
||||
- [Reset a password while still logged in](#to-reset-a-password-while-still-logged-in)
|
||||
- [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)
|
||||
- [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
|
||||
|
||||
|
||||
@ -1,36 +0,0 @@
|
||||
---
|
||||
title: "hass"
|
||||
description: "Description of hass."
|
||||
---
|
||||
|
||||
The command-line part of Home Assistant is `hass`.
|
||||
|
||||
This tool is only available to users of the Home Assistant Core installation type. It is started from the command line on the computer running Home Assistant Core (accessed perhaps via SSH).
|
||||
|
||||
```text
|
||||
$ hass -h
|
||||
usage: hass [-h] [--version] [-c path_to_config_dir] [--safe-mode]
|
||||
[--debug] [--open-ui] [--skip-pip] [-v] [--log-rotate-days LOG_ROTATE_DAYS]
|
||||
[--log-file LOG_FILE] [--log-no-color] [--script ...] [--ignore-os-check]
|
||||
|
||||
Home Assistant: Observe, Control, Automate.
|
||||
|
||||
optional arguments:
|
||||
-h, --help show this help message and exit
|
||||
--version show program's version number and exit
|
||||
-c path_to_config_dir, --config path_to_config_dir
|
||||
Directory that contains the Home Assistant configuration
|
||||
--safe-mode Start Home Assistant in safe mode
|
||||
--debug Start Home Assistant in debug mode
|
||||
--open-ui Open the webinterface in a browser
|
||||
--skip-pip Skips pip install of required packages on startup
|
||||
-v, --verbose Enable verbose logging to file.
|
||||
--log-rotate-days LOG_ROTATE_DAYS
|
||||
Enables daily log rotation and keeps up to the specified days
|
||||
--log-file LOG_FILE Log file to write to. If not set, CONFIG/home-assistant.log is used
|
||||
--log-no-color Disable color logs
|
||||
--script ... Run one of the embedded scripts
|
||||
--ignore-os-check Skips validation of operating system
|
||||
|
||||
If restart is requested, exits with code 100
|
||||
```
|
||||
@ -3,7 +3,7 @@ title: "I'm trying to find my files on the host or SD card. Where are they?"
|
||||
ha_category: Home Assistant
|
||||
---
|
||||
|
||||
On a Home Assistant OS install, your files are on the data partition within `/mnt/data/supervisor/`.
|
||||
On a {% term "Home Assistant Operating System" %} installation, your files are on the data partition within `/mnt/data/supervisor/`.
|
||||
On the SD itself, this is an EXT4 partition labeled `hassos-data`.
|
||||
|
||||
On a Supervised install, they are in `/usr/share/hassio/`.
|
||||
For information on file access, refer to the section on [configuring access to files](/common-tasks/os/#configuring-access-to-files).
|
||||
@ -246,7 +246,6 @@
|
||||
<ul>
|
||||
<li>{% active_link /docs/tools/dev-tools/ Developer tools %}</li>
|
||||
<li>{% active_link /docs/tools/quick-bar/ Quick bar %}</li>
|
||||
<li>{% active_link /docs/tools/hass/ hass %}</li>
|
||||
<li>{% active_link /docs/tools/check_config/ check_config %}</li>
|
||||
</ul>
|
||||
{% endif %}
|
||||
|
||||
@ -1,3 +1,3 @@
|
||||
## Lost Password and password reset
|
||||
|
||||
Please refer to the [I'm locked out!](/docs/locked_out/#home-assistant-including-supervised) documentation page.
|
||||
Please refer to the [I'm locked out!](/docs/locked_out/) documentation page.
|
||||
@ -15,12 +15,22 @@ The **Calendar** {% term integration %} provides calendar {% term entities %}, a
|
||||
to integrate calendars into Home Assistant. Calendars are shown on the calendar
|
||||
dashboard and can be used with automations.
|
||||
|
||||
This page does not provide instructions on how to create calendar
|
||||
entities. Please see the ["Calendar" category](/integrations/#calendar) on the
|
||||
integrations page to find integrations offering calendar entities. For example, [Local Calendar](/integrations/local_calendar/) is a fully local integration to create calendars and events within your Home Assistant instance or other integrations work with other services providing calendar data.
|
||||
|
||||
{% include integrations/building_block_integration.md %}
|
||||
|
||||
## Getting started with calendars
|
||||
|
||||
Home Assistant’s calendar support is designed primarily for automation use cases. It allows you to trigger automations based on events and access event information provided by calendar integrations, regardless of where the actual calendar data is stored. When supported by a given integration, Home Assistant can also create, edit, and delete events in external calendars, making it possible to interact with calendars both for reading and writing.
|
||||
|
||||
Home Assistant is not intended to replace a full-featured personal calendar. Instead, it works alongside external calendar platforms and complements them with powerful automation capabilities.
|
||||
|
||||
Depending on your needs, you can choose from several approaches:
|
||||
|
||||
- Use an existing external calendar: Explore the built-in [calendar integrations](/integrations/#calendar) to connect Home Assistant to your preferred calendar platform and use its events for automations.
|
||||
|
||||
- Run your own full-featured, privacy-focused calendar platform: Solutions like [Nextcloud Calendar](https://apps.nextcloud.com/apps/calendar) or other [self-hosted calendar platforms](https://github.com/awesome-selfhosted/awesome-selfhosted) provide complete calendar functionality and expose calendars over CalDAV. You can integrate them with Home Assistant using the [CalDAV integration](/integrations/caldav/) while keeping full calendar management outside Home Assistant.
|
||||
|
||||
- Use a simple, local event store for automations: The [Local Calendar integration](/integrations/local_calendar/) provides a fully local calendar designed specifically for automation workflows. It is not intended to function as a general-purpose personal calendar.
|
||||
|
||||
## Viewing and managing calendars
|
||||
|
||||
Each calendar is represented as its own {% term entity %} in Home Assistant and can be
|
||||
@ -31,8 +41,17 @@ Some calendar integrations allow Home Assistant to manage your calendars
|
||||
directly from Home Assistant. In this case, you can add new events by selecting
|
||||
the **Add event** button in the lower right corner of the calendar dashboard.
|
||||
|
||||
The calendar dashboard provides quick visibility into upcoming events and simple
|
||||
event editing, making it easier to build and troubleshoot automations that depend
|
||||
on calendar data.
|
||||
|
||||
Also see [Actions](#actions) below.
|
||||
|
||||
## Calendar card
|
||||
|
||||
To display calendar events directly on your dashboards, Home Assistant includes the [calendar card](/dashboards/calendar/).
|
||||
The card shows upcoming events from one or more calendar entities and provides a quick,glanceable view of your schedule.
|
||||
|
||||
## The state of a calendar entity
|
||||
|
||||
The state shows whether or not there is an active event:
|
||||
|
||||
@ -329,8 +329,12 @@ To use your Command binary sensor in your installation, add the following to you
|
||||
command_line:
|
||||
- binary_sensor:
|
||||
command: "cat /proc/sys/net/ipv4/ip_forward"
|
||||
payload_on: "1"
|
||||
payload_off: "0"
|
||||
- binary_sensor:
|
||||
command: "echo 1"
|
||||
payload_on: "1"
|
||||
payload_off: "0"
|
||||
```
|
||||
{% endraw%}
|
||||
|
||||
|
||||
@ -18,12 +18,12 @@ ha_quality_scale: legacy
|
||||
The Fail2Ban {% term integration %} allows for IPs banned by [fail2ban](https://www.fail2ban.org/wiki/index.php/Main_Page) to be displayed in the Home Assistant frontend.
|
||||
|
||||
{% important %}
|
||||
This integration is only available on {% term "Home Assistant Core" %} installation types. Unfortunately, it cannot be used with {% term "Home Assistant Operating System" %}, {% term "Home Assistant Supervised" %}, or {% term "Home Assistant Container" %}.
|
||||
This integration is only available on {% term "Home Assistant Container" %} . Unfortunately, it cannot be used with {% term "Home Assistant Operating System" %}.
|
||||
{% endimportant %}
|
||||
|
||||
{% important %}
|
||||
|
||||
Your system must have `fail2ban` installed and correctly configured for this sensor to work. In addition, Home Assistant must be able to read the `fail2ban` log file.
|
||||
Your system must have `fail2ban` installed and correctly configured for this sensor to work. In addition, the `fail2ban` log file must be mounted to the Home Assistant container to be able to read it.
|
||||
|
||||
{% endimportant %}
|
||||
|
||||
|
||||
@ -16,11 +16,9 @@ ha_quality_scale: internal
|
||||
|
||||
go2rtc is an open source project providing a camera streaming application that supports formats such as RTSP, WebRTC, HomeKit, FFmpeg, RTMP. The **go2rtc** {% term integration %} connects to a go2rtc instance and provides a WebRTC proxy for all your cameras. To learn more about go2rtc, refer to the [project's GitHub page](https://github.com/AlexxIT/go2rtc/).
|
||||
|
||||
|
||||
If you are using the [`default_config`](/integrations/default_config/) and run Home Assistant using one of the following installation types, the go2rtc integration will be set up automatically and you don't need to do anything:
|
||||
|
||||
- {% term "Home Assistant Operating System" %}
|
||||
- {% term "Home Assistant Supervised" %}
|
||||
- {% term "Home Assistant Container" %}
|
||||
|
||||
## Configuration
|
||||
|
||||
@ -16,9 +16,9 @@ ha_iot_class: Local Polling
|
||||
|
||||
## Configuration
|
||||
|
||||
Configuration of this integration only applies to Home Assistant Core installations types. Home Assistant Container, Home Assistant Supervisor, and Home Assistant Operation System installs already have `isal` pre-installed, and no action is required.
|
||||
{% term "Home Assistant Operating System" %} and {% term "Home Assistant Container" %} installations already have `isal` pre-installed, and no action is required.
|
||||
|
||||
If your system supports [`isal`](https://github.com/pycompression/python-isal), it can be enabled with the following configuration:
|
||||
If for some reason you have removed it, and your system supports [`isal`](https://github.com/pycompression/python-isal), it can be enabled with the following configuration:
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
|
||||
@ -37,8 +37,7 @@ Or, when using Docker containers:
|
||||
docker exec -it <containername> pylacrosse -d /dev/ttyUSB0 scan
|
||||
```
|
||||
|
||||
If you are using the Home Assistant OS or Supervised installation types, these
|
||||
methods are not available for you. The use of an additional computer to figure
|
||||
If you are using the Home Assistant OS, these methods are not available for you. The use of an additional computer to figure
|
||||
out the ID is advised.
|
||||
|
||||
For TX 29 DTH-IT sensors you can also read the ID from the display and calculate the ID as followed: `hex2dec(ID_on_display) / 4`.
|
||||
|
||||
@ -173,23 +173,11 @@ data:
|
||||
|
||||
The log information can be viewed and downloaded from {% my logs title="**Settings** > **System** > **Logs**" %}
|
||||
|
||||
### Viewing logs on Container installations
|
||||
|
||||
### Supervised installations
|
||||
|
||||
On {% term "Home Assistant Supervisor" %} based installations, such as the
|
||||
{% term "Home Assistant Operating System" %} the logs can also be viewed
|
||||
by logging in through the [SSH add-on](/common-tasks/os/#installing-and-using-the-ssh-add-on) and running the following command:
|
||||
|
||||
```bash
|
||||
ha core logs
|
||||
```
|
||||
|
||||
### Non-Supervised installations
|
||||
|
||||
For installations without the {% term "Home Assistant Supervisor" %}
|
||||
the log information is stored in the
|
||||
[configuration directory](/docs/configuration/) as `home-assistant.log`
|
||||
and you can read it with the command-line tool `cat` or follow it dynamically
|
||||
For {% term "Home Assistant Container" %} installations, the log information is stored in the
|
||||
[configuration directory](/docs/configuration/) as `home-assistant.log`.
|
||||
You can read it with the command-line tool `cat` or follow it dynamically
|
||||
with `tail -f`.
|
||||
|
||||
You can use the example below, when logged in through the [SSH add-on](/common-tasks/os/#installing-and-using-the-ssh-add-on):
|
||||
@ -198,11 +186,11 @@ You can use the example below, when logged in through the [SSH add-on](/common-t
|
||||
tail -f /config/home-assistant.log
|
||||
```
|
||||
|
||||
On Docker you can use your host command line directly - follow the logs dynamically with:
|
||||
On Docker, you can use your host command line directly. Follow the logs dynamically with the following command:
|
||||
|
||||
```bash
|
||||
# follow the log dynamically
|
||||
docker logs --follow MY_CONTAINER_ID
|
||||
```
|
||||
|
||||
To see other options use `--help` instead, or simply leave with no options to display the entire log.
|
||||
To see other options, use `--help` instead, or simply leave with no options to display the entire log.
|
||||
|
||||
@ -34,10 +34,9 @@ By default, the integration looks for media in a specified folder.
|
||||
If other `media_dirs` are not declared you need to use `/media/local` path for
|
||||
example in companion app notification.
|
||||
|
||||
For Home Assistant OS, Supervised and Container users, this folder is by default
|
||||
configured in the path `/media`.
|
||||
This folder is by default configured in the path `/media`.
|
||||
|
||||
Home Assistant OS and Supervised users can access this folder by using,
|
||||
Home Assistant OS users can access this folder by using,
|
||||
for example, the Samba add-on. Users of Home Assistant Container can
|
||||
mount a volume of their choice to `/media`.
|
||||
|
||||
|
||||
@ -16,7 +16,7 @@ ha_zeroconf: true
|
||||
ha_integration_type: integration
|
||||
---
|
||||
|
||||
The **Music Assistant** (MA) {% term integration %} allows you to connect Home Assistant to a [Music Assistant Server](https://music-assistant.io/) (Required version 2.4 or later). Once configured, all [MA Players](https://music-assistant.io/player-support/) show up as Home Assistant [media player entities](/integrations/media_player/). Media players will allow you to control media playback and see the currently playing item.
|
||||
The **Music Assistant** (MA) {% term integration %} allows you to connect Home Assistant to a [Music Assistant Server](https://music-assistant.io/). Once configured, all [MA Players](https://music-assistant.io/player-support/) show up as Home Assistant [media player entities](/integrations/media_player/). Media players will allow you to control media playback and see the currently playing item.
|
||||
|
||||
## Prerequisites
|
||||
|
||||
@ -276,6 +276,12 @@ script:
|
||||
|
||||
- Any Home Assistant players added to Music Assistant will appear duplicated as the MA version of the player is created. The original HA player can be hidden if desired.
|
||||
|
||||
## Supported devices
|
||||
|
||||
This integration requires Music Assistant server version 2.4 or later. The integration can connect to Music Assistant servers hosted as an add-on or in a separate Docker container.
|
||||
|
||||
Music Assistant supports a [wide range of devices](https://www.music-assistant.io/player-support/) both natively and through the [Home Assistant provider](https://www.music-assistant.io/player-support/ha/). The Home Assistant provider, when installed, allows any Home Assistant media player to appear as a player in Music Assistant and thereby benefit from the advanced playback functionality that Music Assistant provides. As a general note, if there is a native Music Assistant provider then devices should be added via that method instead of using the HA media player. Any limitations associated with the providers are described on the related Player Provider page in the [Music Assistant documentation](https://www.music-assistant.io/).
|
||||
|
||||
## Known limitations
|
||||
|
||||
The data returned by the `get_queue` action will be partially limited if the item is not in the library (For example, if an item was selected for playback directly from Spotify). Metadata such as favorite status, explicit status, last played, played count, and disc art URL are only available for items that are in the MA library.
|
||||
|
||||
@ -20,6 +20,12 @@ works_with:
|
||||
|
||||
{% include integrations/wwha.md url="https://nuki.io" name="Nuki" %}
|
||||
|
||||
## Setting up your Nuki via Matter integrations requires Thread
|
||||
|
||||
To use this integration, you need a Thread border router that supports Matter. For more information, refer to the [Thread documentation](/integrations/thread/). You can turn your Home Assistant installation into a Thread border router e.g. by using the Home Assistant [Connect ZBT-1](https://www.home-assistant.io/connectzbt1/) or [ZBT-2](https://www.home-assistant.io/connect/zbt-2/). For more information on setting this up, go to [Turning Home Assistant into a Thread border router section](/integrations/thread/#turning-home-assistant-into-a-thread-border-router)
|
||||
|
||||
For more information on setting up Matter with Nuki devices, refer to the [Nuki Matter setup guide](https://help.nuki.io/hc/en-001/articles/14596875392017-Setting-up-your-Matter-integration).
|
||||
|
||||
## Supported devices
|
||||
|
||||
The following devices are supported:
|
||||
|
||||
@ -56,7 +56,7 @@ If you choose to not use the recommended settings, you can configure the followi
|
||||
|
||||
{% configuration_basic %}
|
||||
Model:
|
||||
description: The GPT language model is used for text generation. You can find more details on the available models in the [GPT-4o Documentation](https://platform.openai.com/docs/models/gpt-4o). The default is "gpt-4o-mini".
|
||||
description: The GPT language model is used for text generation. You can find more details on the available models in the [ChatGPT Documentation](https://platform.openai.com/docs/models). The default is "gpt-4o-mini".
|
||||
Maximum Tokens to Return in Response:
|
||||
description: The maximum number of words or "tokens" that the AI model should generate in its completion of the prompt. For more information, see the [OpenAI Completion Documentation](https://platform.openai.com/docs/guides/completion/introduction).
|
||||
Temperature:
|
||||
@ -64,9 +64,9 @@ Temperature:
|
||||
Top P:
|
||||
description: An alternative to temperature, top_p determines the proportion of the most likely word choices the model should consider when generating text. A higher top_p means the model will only consider the most likely words, while a lower top_p means a wider range of words, including less likely ones, will be considered. For more information, see the [OpenAI Completion API Reference](https://platform.openai.com/docs/api-reference/completions/create#completions/create-top_p).
|
||||
Enable web search:
|
||||
description: Enable OpenAI-provided [Web search tool](https://openai.com/index/new-tools-for-building-agents/#web-search). Note that it is only available for gpt-4o and gpt-4o-mini models.
|
||||
description: Enable OpenAI-provided [Web search tool](https://openai.com/index/new-tools-for-building-agents/#web-search). Note that it is only available for gpt-4o and newer models.
|
||||
Search context size:
|
||||
description: The search is performed with a separate fine-tuned "gpt-4o-search-preview" or "gpt-4o-mini-search-preview" model with its own context and its own [pricing](https://platform.openai.com/docs/pricing#web-search). This parameter controls how much context is retrieved from the web to help the tool formulate a response. The tokens used by the search tool do not affect the context window of the main model. These tokens are also not carried over from one turn to another — they're simply used to formulate the tool response and then discarded. This parameter would affect the search quality, cost, and latency.
|
||||
description: The search is performed with a separate fine-tuned model with its own context and its own [pricing](https://platform.openai.com/docs/pricing#built-in-tools). This parameter controls how much context is retrieved from the web to help the tool formulate a response. The tokens used by the search tool do not affect the context window of the main model. These tokens are also not carried over from one turn to another — they're simply used to formulate the tool response and then discarded. This parameter would affect the search quality, cost, and latency.
|
||||
Include home location:
|
||||
description: This parameter allows using the location of your Home Assistant instance during search to provide more relevant search results.
|
||||
{% endconfiguration_basic %}
|
||||
|
||||
@ -922,13 +922,13 @@ The chart below illustrates Options 1 and 2, which are available for Home Assist
|
||||
|
||||
**Option 1: The official Z-Wave JS add-on, as described above**
|
||||
|
||||
_This option is only available for {% term "Home Assistant Operating System" %} (the recommended installation type) and {% term "Home Assistant Supervised" %} installations._
|
||||
_This option is only available for {% term "Home Assistant Operating System" %} (the recommended installation type) installations._
|
||||
|
||||
This add-on can only be configured via the built-in Z-Wave control panel in Home Assistant. If you followed the standard [installation procedure](#setting-up-a-z-wave-js-server), this is how you are running the Z-Wave JS server.
|
||||
|
||||
**Option 2: The Z-Wave JS UI add-on installed from the community add-on store**
|
||||
|
||||
_This option is only available for {% term "Home Assistant Operating System" %} (the recommended installation type) and {% term "Home Assistant Supervised" %} installations._
|
||||
_This option is only available for {% term "Home Assistant Operating System" %} (the recommended installation type) installations._
|
||||
|
||||
This add-on includes the Z-Wave JS Server as part of the Z-Wave JS UI application. The Z-Wave network can be configured via the built-in Z-Wave control panel in Home Assistant and alternatively via the Z-Wave control panel built into Z-Wave JS UI. It provides you with a full-fledged, attractive, and feature-complete UI to manage your Z-Wave nodes and settings, which may support more advanced use cases as development continues on the Z-Wave control panel.
|
||||
|
||||
|
||||
@ -22,7 +22,7 @@ The simplest way to show Home Assistant to others is the online demo at [/demo/]
|
||||
|
||||
## `--demo-mode` and Demo platform
|
||||
|
||||
To be safe for your talk, you don't want to depend on an internet connection. The demo mode [`--demo-mode`](/docs/tools/hass/) allows you to run a demo locally including the latest features. Make sure that you have a backup of your configuration.
|
||||
To be safe for your talk, you don't want to depend on an internet connection. The demo mode `--demo-mode` allows you to run a demo locally including the latest features. Make sure that you have a backup of your configuration.
|
||||
|
||||
```bash
|
||||
hass --demo-mode
|
||||
|
||||
@ -74,7 +74,7 @@ To learn how to use {% term scenes %}, refer to the [scene](/integrations/scene/
|
||||
|
||||
## Add-ons
|
||||
|
||||
Add-ons are third-party applications that provide additional functionality in Home Assistant. Add-ons run directly alongside Home Assistant, whereas {% term integrations %} connect Home Assistant to other apps. Add-ons are only supported by the {% term "Home Assistant Operating System" %} and {% term "Home Assistant Supervised" %} [installation type](/installation).
|
||||
Add-ons are third-party applications that provide additional functionality in Home Assistant. Add-ons run directly alongside Home Assistant, whereas {% term integrations %} connect Home Assistant to other apps. Add-ons are only supported when using {% term "Home Assistant Operating System" %}.
|
||||
|
||||
Add-ons are installed from the add-on store under {% my supervisor title="**Settings** > **Add-ons**" %}. If you are curious now and feel like installing every add-on that looks interesting: beware that add-ons can use quite a bit of resources in terms of disk space, memory, and additional load on the processor.
|
||||
|
||||
|
||||
@ -8,7 +8,7 @@ This page contains only irrelevant and unhelpful information about Home Assistan
|
||||
|
||||
## Name
|
||||
|
||||
Isn't it obvious? Home Assistant is the good soul that is assisting you in your home. It's common to refer to Home Assistant simply as HA or `hass` (not to be confused with the German word "Hass", it's more like the abbreviation of **H**ome **A**ssistant **S**erver **S**ervice). [`hass`](/docs/tools/hass/) is also the name of the command-line part.
|
||||
Isn't it obvious? Home Assistant is the good soul that is assisting you in your home. The abbreviation `hass` (not to be confused with the German word "Hass", it's more like the abbreviation of **H**ome **A**ssistant **S**erver **S**ervice) was commonly used in the past, though it's now recommended to use the full name "Home Assistant" in documentation.
|
||||
|
||||
## Website
|
||||
|
||||
|
||||
Binary file not shown.
|
Before Width: | Height: | Size: 5.1 KiB |
BIN
source/images/distributors/mauser.webp
Normal file
BIN
source/images/distributors/mauser.webp
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 13 KiB |
@ -128,6 +128,11 @@ toc: true
|
||||
the recommended installation type for most users.</li>
|
||||
<li>
|
||||
<b>Home Assistant Container:</b> Container-based installation of Home Assistant. You need to bring your own system (such as Linux) with container orchestration (like Docker), and manually handle updates. Home Assistant Container installations don’t have access to {% term "add-ons" %}.
|
||||
<ul>
|
||||
<li>
|
||||
<b>Note</b>: Some integrations, such as <b>Thread</b> and <b>Z-Wave</b>, are controlled by {% term "add-ons" %}. There is no out-of-the-box support for these on Container installations.
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
|
||||
@ -5,24 +5,13 @@ description: "More information on why the OS marks the installation as unsupport
|
||||
|
||||
## The issue
|
||||
|
||||
There are only two supported operating systems to run the Supervisor on:
|
||||
|
||||
- Home Assistant OS
|
||||
- Debian 12 (Bookworm)
|
||||
|
||||
These operating systems are actively tested and maintained, for use with the Supervisor.
|
||||
The Home Assistant Supervisor is only supported on Home Assistant OS.
|
||||
|
||||
## The solution
|
||||
|
||||
You need to reinstall the host machine running the Supervisor on one of the supported
|
||||
operating systems.
|
||||
You need to reinstall the host machine running the Supervisor using Home Assistant OS.
|
||||
|
||||
The best approach here is to take a full backup of your current installation
|
||||
from the Supervisor panel, then reinstall your host with one of the supported
|
||||
operating systems.
|
||||
|
||||
If the host is a virtual machine or a supported board, you can use our [appliance images](/hassio/installation/).
|
||||
|
||||
If not, you can get [Debian from here](https://www.debian.org/) and use our [convenience installation script](https://github.com/home-assistant/supervised-installer). Make sure you make it compliant with [ADR-0014](https://github.com/home-assistant/architecture/blob/master/adr/0014-home-assistant-supervised.md), the convenience script will handle most of that for you.
|
||||
|
||||
When the new host is set up and you can reach the Home Assistant frontend, you can upload and restore the backup you made earlier.
|
||||
The best approach here is to [create a backup](/common-tasks/general/#backups) of your
|
||||
current installation, then reinstall your system using Home Assistant OS. During
|
||||
[Onboarding of Home Assistant](/getting-started/onboarding/), choose to **Restore from
|
||||
backup**.
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user