diff --git a/Gemfile.lock b/Gemfile.lock index d43a405f4679..1723f6b269c6 100644 --- a/Gemfile.lock +++ b/Gemfile.lock @@ -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) @@ -83,7 +83,7 @@ GEM rb-inotify (~> 0.9, >= 0.9.10) logger (1.7.0) mercenary (0.4.0) - multi_json (1.17.0) + multi_json (1.18.0) mustermann (3.0.4) ruby2_keywords (~> 0.0.1) nokogiri (1.18.10-arm64-darwin) @@ -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) @@ -167,7 +167,7 @@ GEM tzinfo-data (1.2025.2) tzinfo (>= 1.0.0) unicode-display_width (2.6.0) - webrick (1.9.1) + webrick (1.9.2) PLATFORMS arm64-darwin-23 diff --git a/package-lock.json b/package-lock.json index 1a6ed5c460f5..2b133be24c2f 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1001,24 +1001,28 @@ } }, "node_modules/body-parser": { - "version": "2.2.0", - "resolved": "https://registry.npmjs.org/body-parser/-/body-parser-2.2.0.tgz", - "integrity": "sha512-02qvAaxv8tp7fBa/mw1ga98OGm+eCbqzJOKoRt70sLmfEEi+jyBYVTDGfCL/k06/4EMk/z01gCe7HoCH/f2LTg==", + "version": "2.2.1", + "resolved": "https://registry.npmjs.org/body-parser/-/body-parser-2.2.1.tgz", + "integrity": "sha512-nfDwkulwiZYQIGwxdy0RUmowMhKcFVcYXUU7m4QlKYim1rUtg83xm2yjZ40QjDuc291AJjjeSc9b++AWHSgSHw==", "dev": true, "license": "MIT", "dependencies": { "bytes": "^3.1.2", "content-type": "^1.0.5", - "debug": "^4.4.0", + "debug": "^4.4.3", "http-errors": "^2.0.0", - "iconv-lite": "^0.6.3", + "iconv-lite": "^0.7.0", "on-finished": "^2.4.1", "qs": "^6.14.0", - "raw-body": "^3.0.0", - "type-is": "^2.0.0" + "raw-body": "^3.0.1", + "type-is": "^2.0.1" }, "engines": { "node": ">=18" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/express" } }, "node_modules/boundary": { @@ -1623,19 +1627,21 @@ } }, "node_modules/express": { - "version": "5.1.0", - "resolved": "https://registry.npmjs.org/express/-/express-5.1.0.tgz", - "integrity": "sha512-DT9ck5YIRU+8GYzzU5kT3eHGA5iL+1Zd0EutOmTE9Dtk+Tvuzd23VBU+ec7HPNSTxXYO55gPV/hq4pSBJDjFpA==", + "version": "5.2.1", + "resolved": "https://registry.npmjs.org/express/-/express-5.2.1.tgz", + "integrity": "sha512-hIS4idWWai69NezIdRt2xFVofaF4j+6INOpJlVOLDO8zXGpUVEVzIYk12UUi2JzjEzWL3IOAxcTubgz9Po0yXw==", "dev": true, "license": "MIT", + "peer": true, "dependencies": { "accepts": "^2.0.0", - "body-parser": "^2.2.0", + "body-parser": "^2.2.1", "content-disposition": "^1.0.0", "content-type": "^1.0.5", "cookie": "^0.7.1", "cookie-signature": "^1.2.1", "debug": "^4.4.0", + "depd": "^2.0.0", "encodeurl": "^2.0.0", "escape-html": "^1.0.3", "etag": "^1.8.1", @@ -2040,9 +2046,9 @@ } }, "node_modules/iconv-lite": { - "version": "0.6.3", - "resolved": "https://registry.npmjs.org/iconv-lite/-/iconv-lite-0.6.3.tgz", - "integrity": "sha512-4fCk79wshMdzMp2rH06qWrJE4iolqLhCUH+OiuIgU++RB0+94NlDL81atO7GX55uUKueo0txHNtvEyI6D7WdMw==", + "version": "0.7.0", + "resolved": "https://registry.npmjs.org/iconv-lite/-/iconv-lite-0.7.0.tgz", + "integrity": "sha512-cf6L2Ds3h57VVmkZe+Pn+5APsT7FpqJtEhhieDCvrE2MK5Qk9MyffgQyuxQTm6BChfeZNtcOLHp9IcWRVcIcBQ==", "dev": true, "license": "MIT", "dependencies": { @@ -2050,6 +2056,10 @@ }, "engines": { "node": ">=0.10.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/express" } }, "node_modules/ignore": { @@ -4598,23 +4608,6 @@ "node": ">= 0.10" } }, - "node_modules/raw-body/node_modules/iconv-lite": { - "version": "0.7.0", - "resolved": "https://registry.npmjs.org/iconv-lite/-/iconv-lite-0.7.0.tgz", - "integrity": "sha512-cf6L2Ds3h57VVmkZe+Pn+5APsT7FpqJtEhhieDCvrE2MK5Qk9MyffgQyuxQTm6BChfeZNtcOLHp9IcWRVcIcBQ==", - "dev": true, - "license": "MIT", - "dependencies": { - "safer-buffer": ">= 2.1.2 < 3.0.0" - }, - "engines": { - "node": ">=0.10.0" - }, - "funding": { - "type": "opencollective", - "url": "https://opencollective.com/express" - } - }, "node_modules/rc-config-loader": { "version": "4.1.3", "resolved": "https://registry.npmjs.org/rc-config-loader/-/rc-config-loader-4.1.3.tgz", @@ -6765,6 +6758,7 @@ "integrity": "sha512-KpVIFK2FoIbgyvaieEfUkUQCuVGI7poc7dB5qkr8ixnQjNT6/6tb8tgAnfxuYOY1Q6h7uuDXfMWJ9NPCL+rLuw==", "dev": true, "license": "MIT", + "peer": true, "dependencies": { "@modelcontextprotocol/sdk": "^1.21.1", "@textlint/ast-node-types": "15.4.0", @@ -8167,6 +8161,7 @@ "integrity": "sha512-gzUt/qt81nXsFGKIFcC3YnfEAx5NkunCfnDlvuBSSFS02bcXu4Lmea0AFIUwbLWxWPx3d9p8S5QoaujKcNQxcQ==", "dev": true, "license": "MIT", + "peer": true, "funding": { "url": "https://github.com/sponsors/colinhacks" } diff --git a/source/_dashboards/weather-forecast.markdown b/source/_dashboards/weather-forecast.markdown index 3079773a75b5..a97a60758a12 100644 --- a/source/_dashboards/weather-forecast.markdown +++ b/source/_dashboards/weather-forecast.markdown @@ -32,6 +32,8 @@ Forecast type: description: Select the forecast to display between "Daily", "Hourly" and "Twice daily". Secondary Info Attribute: description: Here you can specify a secondary attribute to show under the current temperature. Ex. Extrema, Precipitation, Humidity. If not set, it will default to Extrema (High/Low) if available, if not available then Precipitation and if precipitation isn't available then Humidity. +Round temperature: + description: Check this if you would like to round all temperature values in the card to its nearest integer. Theme: description: Name of any loaded theme to be used for this card. For more information about themes, see the [frontend documentation](/integrations/frontend/). {% endconfiguration_basic %} @@ -80,6 +82,10 @@ secondary_info_attribute: description: Which attribute to display under the temperature. type: string default: Defaults to `extrema` if available, if not available then `precipitation` and if precipitation isn't available then `humidity`. +round_temperature: + required: false + description: Round temperature values to closest integer. + default: `false` (uses the raw temperature values). theme: required: false description: Override the used theme for this card with any loaded theme. For more information about themes, see the [frontend documentation](/integrations/frontend/). diff --git a/source/_data/glossary.yml b/source/_data/glossary.yml index ff5f4351be3f..342c06bfa0f3 100644 --- a/source/_data/glossary.yml +++ b/source/_data/glossary.yml @@ -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 diff --git a/source/_data/products.yml b/source/_data/products.yml index c60ea34d874d..9bbaef150cdb 100644 --- a/source/_data/products.yml +++ b/source/_data/products.yml @@ -1,25 +1,30 @@ green: name: "Home Assistant Green" 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: "Home Assistant Yellow" 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: "Home Assistant Connect ZBT-1" 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: "Home Assistant Voice 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: "Home Assistant 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: "Home Assistant Connect ZBT-2" - new: true distributors: # North America #- name: Amazon @@ -678,7 +732,7 @@ zbt-2: - name: SmarterHome ship_from: Czech Republic ship_to: Europe - url: https://smarterhome.sk/cs/zwave-pc-adaptery/home-assistant-connect-zbt-2-zigbee-a-thread-usb-adapter-2062.html + url: https://smarterhome.sk/cs/adaptery-moduly-a-softver/home-assistant-connect-zbt-2-zigbee-a-thread-usb-adapter-2062.html logo: /images/distributors/smarter-home.png - name: Raspberrypi.dk ship_from: Denmark @@ -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 @@ -748,7 +802,7 @@ zbt-2: - name: SmarterHome ship_from: Slovakia ship_to: Europe - url: https://smarterhome.sk/sk/zwave-pc-adaptery/home-assistant-connect-zbt-2-zigbee-a-thread-usb-adapter-2062.html + url: https://smarterhome.sk/sk/adaptery-moduly-a-softver/home-assistant-connect-zbt-2-zigbee-a-thread-usb-adapter-2062.html logo: /images/distributors/smarter-home.png - name: Inet ship_from: Sweden diff --git a/source/_docs/blueprint/selectors.markdown b/source/_docs/blueprint/selectors.markdown index 01542ca362b6..0788b923067c 100644 --- a/source/_docs/blueprint/selectors.markdown +++ b/source/_docs/blueprint/selectors.markdown @@ -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 %} diff --git a/source/_docs/locked_out.md b/source/_docs/locked_out.md index 8298f5f93e29..df4a2f4991d3 100644 --- a/source/_docs/locked_out.md +++ b/source/_docs/locked_out.md @@ -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 diff --git a/source/_docs/tools/hass.markdown b/source/_docs/tools/hass.markdown deleted file mode 100644 index 26dcd7be8c3f..000000000000 --- a/source/_docs/tools/hass.markdown +++ /dev/null @@ -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 -``` diff --git a/source/_faq/sdcard_files.markdown b/source/_faq/sdcard_files.markdown index 6004145dc7ff..991b3ec960a0 100644 --- a/source/_faq/sdcard_files.markdown +++ b/source/_faq/sdcard_files.markdown @@ -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/`. \ No newline at end of file +For information on file access, refer to the section on [configuring access to files](/common-tasks/os/#configuring-access-to-files). \ No newline at end of file diff --git a/source/_includes/asides/docs_sitemap.html b/source/_includes/asides/docs_sitemap.html index a29d6a9660b2..5d15ead6214f 100644 --- a/source/_includes/asides/docs_sitemap.html +++ b/source/_includes/asides/docs_sitemap.html @@ -246,7 +246,6 @@ {% endif %} diff --git a/source/_includes/common-tasks/lost_password.md b/source/_includes/common-tasks/lost_password.md index 16f64889e37d..ca1181dbef67 100644 --- a/source/_includes/common-tasks/lost_password.md +++ b/source/_includes/common-tasks/lost_password.md @@ -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. \ No newline at end of file +Please refer to the [I'm locked out!](/docs/locked_out/) documentation page. \ No newline at end of file diff --git a/source/_integrations/alexa_devices.markdown b/source/_integrations/alexa_devices.markdown index b547344e352c..8b4566bfe24a 100644 --- a/source/_integrations/alexa_devices.markdown +++ b/source/_integrations/alexa_devices.markdown @@ -107,6 +107,10 @@ This action essentially allows you to control Alexa using text commands rather t This action allows you to play one of the built-in Alexa sounds. The full list of sounds is available in [Amazon's documentation (needs authentication)](https://alexa.amazon.com/api/behaviors/entities?skillId=amzn1.ask.1p.sound) +{%tip%} +Additional sounds are available through advanced markup using the `notify.send_message` [action](#action-notifysend_message) +{%endtip%} + | Data attribute | Optional | Description | | -------------- | -------- | ----------------------------------------- | | `device_id` | no | Device on which you want to play sound | diff --git a/source/_integrations/calendar.markdown b/source/_integrations/calendar.markdown index a745c1c799d4..f70d7a24726b 100644 --- a/source/_integrations/calendar.markdown +++ b/source/_integrations/calendar.markdown @@ -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: diff --git a/source/_integrations/command_line.markdown b/source/_integrations/command_line.markdown index 8ee6b1dd0b46..1ced61888d71 100644 --- a/source/_integrations/command_line.markdown +++ b/source/_integrations/command_line.markdown @@ -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%} diff --git a/source/_integrations/fail2ban.markdown b/source/_integrations/fail2ban.markdown index e3b9df77d92e..be5903566354 100644 --- a/source/_integrations/fail2ban.markdown +++ b/source/_integrations/fail2ban.markdown @@ -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 %} diff --git a/source/_integrations/fan.mqtt.markdown b/source/_integrations/fan.mqtt.markdown index 3ddc7d8df21f..c5e53238ec55 100644 --- a/source/_integrations/fan.mqtt.markdown +++ b/source/_integrations/fan.mqtt.markdown @@ -249,11 +249,11 @@ percentage_command_template: required: false type: template percentage_command_topic: - description: The MQTT topic to publish commands to change the fan speed state based on a percentage. + description: The MQTT topic to publish commands to change the fan speed state based on a percentage setting. The value shall be in the range from `speed_range_min` to `speed_range_max`. required: false type: string percentage_state_topic: - description: The MQTT topic subscribed to receive fan speed based on percentage. + description: The MQTT topic subscribed to receive fan speed state. This is a value in the range from `speed_range_min` to `speed_range_max`. required: false type: string percentage_value_template: diff --git a/source/_integrations/go2rtc.markdown b/source/_integrations/go2rtc.markdown index a6e4693d3f9b..c69a6234232b 100644 --- a/source/_integrations/go2rtc.markdown +++ b/source/_integrations/go2rtc.markdown @@ -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 diff --git a/source/_integrations/google_assistant_sdk.markdown b/source/_integrations/google_assistant_sdk.markdown index db9b5da700ca..772e5b076549 100644 --- a/source/_integrations/google_assistant_sdk.markdown +++ b/source/_integrations/google_assistant_sdk.markdown @@ -24,7 +24,6 @@ The Google Assistant SDK integration allows Home Assistant to interact with Goog This integration allows: - Sending text commands to Google Assistant to control devices supported by Google Assistant but not by Home Assistant. Examples: - - Set Nest Guard to home and guarding - Start vacuuming - Stream front door on living room TV - Turn off kitchen TV diff --git a/source/_integrations/ibeacon.markdown b/source/_integrations/ibeacon.markdown index c984360909ce..325599554503 100644 --- a/source/_integrations/ibeacon.markdown +++ b/source/_integrations/ibeacon.markdown @@ -74,10 +74,10 @@ To get the Estimated distance sensor to work, in most cases, it has to be calibr - Blue Charm Beacons BC037G-GeoPattern-iBeacon (discontinued) - Blue Charm Beacons BC037S-SmoothPattern-iBeacon (discontinued) - [Blue SLIM ID](https://elainnovation.com/en/catalogue/blue-slim-id-en/) -- [Feasycom FSC-BP103B](https://www.feasycom.com/bluetooth-ibeacon-da14531) -- [Feasycom FSC-BP104D](https://www.feasycom.com/dialog-da14531-bluetooth-low-energy-beacon) +- [Feasycom FSC-BP103B](https://www.feasycom.com/product/fsc-bp103b/) +- [Feasycom FSC-BP104D](https://www.feasycom.com/product/fsc-bp104d/) - [Feasycom FSC-BP106](https://www.feasycom.com/fsc-bp106) -- [Feasycom FSC-BP108](https://www.feasycom.com/bluetooth-5-1-waterproof-bluetooth-beacon) +- [Feasycom FSC-BP108](https://www.feasycom.com/product/fsc-bp108b/) - [MikroTik TG-BT5-IN](https://mikrotik.com/product/tg_bt5_in) (Additional sensors such as angle or impact are not compatible) - [NRF51822 iBeacon](https://www.aliexpress.com/item/32826502025.html) - [NRF52810 iBeacon](https://www.aliexpress.com/item/1005003211033416.html) diff --git a/source/_integrations/isal.markdown b/source/_integrations/isal.markdown index 3ada3457a637..111b136644d5 100644 --- a/source/_integrations/isal.markdown +++ b/source/_integrations/isal.markdown @@ -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 diff --git a/source/_integrations/lacrosse.markdown b/source/_integrations/lacrosse.markdown index ed41835874b2..78102ed62d0c 100644 --- a/source/_integrations/lacrosse.markdown +++ b/source/_integrations/lacrosse.markdown @@ -37,8 +37,7 @@ Or, when using Docker containers: docker exec -it 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`. diff --git a/source/_integrations/logger.markdown b/source/_integrations/logger.markdown index 3263aeb135a1..f5d1b6cb734b 100644 --- a/source/_integrations/logger.markdown +++ b/source/_integrations/logger.markdown @@ -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. diff --git a/source/_integrations/media_source.markdown b/source/_integrations/media_source.markdown index eae407edd0a3..9632886278cc 100644 --- a/source/_integrations/media_source.markdown +++ b/source/_integrations/media_source.markdown @@ -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`. diff --git a/source/_integrations/music_assistant.markdown b/source/_integrations/music_assistant.markdown index 6990d4bc27a3..518b036c0349 100644 --- a/source/_integrations/music_assistant.markdown +++ b/source/_integrations/music_assistant.markdown @@ -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. diff --git a/source/_integrations/nuki_matter.markdown b/source/_integrations/nuki_matter.markdown index 990aee35b9f1..87ec7a568f86 100644 --- a/source/_integrations/nuki_matter.markdown +++ b/source/_integrations/nuki_matter.markdown @@ -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: diff --git a/source/_integrations/onvif.markdown b/source/_integrations/onvif.markdown index dc5c6b4381dc..375d713522f5 100644 --- a/source/_integrations/onvif.markdown +++ b/source/_integrations/onvif.markdown @@ -108,3 +108,17 @@ This integration uses the ONVIF auxiliary command and imaging service to send ce | IR lamp | `ir_lamp` | Turn infrared lamp on and off via `IrCutFilter` ONVIF imaging setting. | | Autofocus | `autofocus` | Turn autofocus on and off via `AutoFocusMode` ONVIF imaging setting. | | Wiper | `wiper` | Turn on the lens wiper on and off via the `Wiper` ONVIF auxiliary command. | + +## Troubleshooting + +### Symptom: Error message: "No usable cameras were found" + +The ONVIF integration shows an error message "No usable cameras were found". + +#### Resolution + +Update the camera configuration to output at least one video stream in H.264 format rather than H.265. One option for doing this is to set a secondary stream to H.264 while leaving the primary stream at the default H.265. + +#### Cause + +Many newer cameras, particularly those with higher resolutions that benefit from H.265's improved video coding, support H.265 (HEVC) by default, while the ONVIF integration looks for H.264 (AVC) video streams to find cameras. diff --git a/source/_integrations/openai_conversation.markdown b/source/_integrations/openai_conversation.markdown index 75e1bdecc4d4..c6031eb38657 100644 --- a/source/_integrations/openai_conversation.markdown +++ b/source/_integrations/openai_conversation.markdown @@ -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 %} diff --git a/source/_integrations/sfr_box.markdown b/source/_integrations/sfr_box.markdown index fffe3f5d198a..f84139cbaaab 100644 --- a/source/_integrations/sfr_box.markdown +++ b/source/_integrations/sfr_box.markdown @@ -27,6 +27,15 @@ This integration provides the following platforms: {% include integrations/config_flow.md %} +{% configuration_basic %} +Host: + description: "The hostname, IP address, or full URL of your SFR device." +Username (optional): + description: "The username for accessing your SFR box's web interface. The default is 'admin'." +Password (optional): + description: "The password for accessing your SFR box's web interface. The default is the Wi-Fi security key found on the device label." +{% endconfiguration_basic %} + ## Compatibility The integration uses the REST API, which is known to be available on models `NB4`, `NB5`, `NB6`, `NB6V`, and `NB6VAC`. diff --git a/source/_integrations/system_health.markdown b/source/_integrations/system_health.markdown index ee4a4ab883c9..30d13987e4d3 100644 --- a/source/_integrations/system_health.markdown +++ b/source/_integrations/system_health.markdown @@ -11,7 +11,7 @@ ha_integration_type: system The System Health integration provides an API to offer information on the system and its components. It also allows to run diagnostic tools to diagnose problems. -System Health integration data can be viewed at **Settings** -> **System** -> **Repairs** -> **System Information** in the overflow menu (top right). +System Health integration data can be viewed at **Settings** -> **System** -> **Repairs** -> **System Information** in the three dots menu (top right). {% my system_health badge %} diff --git a/source/_integrations/thread.markdown b/source/_integrations/thread.markdown index a846102824cc..6b32abfaa8ed 100644 --- a/source/_integrations/thread.markdown +++ b/source/_integrations/thread.markdown @@ -141,6 +141,7 @@ Follow these steps if you want to turn Home Assistant into a Thread border route - [Enable Thread on Home Assistant Yellow](https://support.nabucasa.com/hc/en-us/articles/25742476767517). - [Enable Thread on Home Assistant Connect ZBT-1](https://support.nabucasa.com/hc/en-us/sections/26122472719517). - [Enable Thread on Home Assistant Connect ZBT-2](https://support.nabucasa.com/hc/en-us/sections/31260019451421). + - [Adding a Thread adapter to Home Assistant](#adding-a-thread-adapter-to-home-assistant). 2. Make sure the Home Assistant Thread network is defined as preferred network. - This should happen automatically, but check to be sure. @@ -192,15 +193,96 @@ Note: the steps and images here show the process with a Google Thread network. B ![image](/images/integrations/thread/thread-google-br.png) -5. To enable Thread support on your Home Assistant Yellow, Connect ZBT-1, or [Connect ZBT-2](/connect/zbt-2/), you need to install the **OpenThread Border Router** add-on. Follow the corresponding procedure: +5. To enable Thread support, you need to install the **OpenThread Border Router** add-on. Follow the corresponding procedure: - [Enable Thread on Home Assistant Yellow](https://support.nabucasa.com/hc/en-us/articles/25742476767517). - [Enable Thread on Home Assistant Connect ZBT-1](https://support.nabucasa.com/hc/en-us/sections/26122472719517). - [Enable Thread on Home Assistant Connect ZBT-2](https://support.nabucasa.com/hc/en-us/sections/31260019451421). + - [Adding a Thread adapter to Home Assistant](#adding-a-thread-adapter-to-home-assistant). - **Result**: The network now shows as the preferred network, joined with the third-party network. ![image](/images/integrations/thread/thread-ha-preferred.png) - 🎉 You successfully created a Home Assistant Thread network and joined it with a pre-existing third-party network. +## Adding a third-party Thread adapter to Home Assistant + +Follow these steps if you want to set up a third-party Thread adapter. + +If you have a Home Assistant Thread adapter, follow the corresponding instructions instead: + +- [Enable Thread on Home Assistant Yellow](https://support.nabucasa.com/hc/en-us/articles/25742476767517). +- [Enable Thread on Home Assistant Connect ZBT-1](https://support.nabucasa.com/hc/en-us/sections/26122472719517). +- [Enable Thread on Home Assistant Connect ZBT-2](https://support.nabucasa.com/hc/en-us/sections/31260019451421). + +### Prerequisites + +- [Home Assistant Operating System](/docs/glossary/#home-assistant-operating-system) installed on your smart home hub. For example: + - On a Home Assistant Green, where Home Assistant OS is preinstalled + - On a Home Assistant Yellow or on a Raspberry Pi +- Latest updates installed +- A new Thread adapter and a USB extension cable + - If your adapter supports multiple protocols: + - They might have another firmware installed by default (Zigbee, for example). + - Check their documentation and install the OpenThread firmware on the adapter. + - Check their documentation and take a note of the baudrate. + +### To add a Thread adapter to the OpenThread Border Router add-on + +1. Install the **OpenThread Border Router** add-on. + - Go to {% my supervisor_addon title="**Settings** > **Add-ons**" addon="core_openthread_border_router" %} and select the **OpenThread Border Router** add-on. +2. Plug the adapter into the extension cable and plug it into the Home Assistant hub. +3. Go to {% my supervisor_addon title="**Settings** > **Add-ons** > **OpenThread Border Router**" addon="core_openthread_border_router" %} and select the **Configuration** tab. +4. Under **Devices**, select your adapter. +5. Enter the **Baudrate** as specified in the documentation of your adapter. + - If you can't find the baudrate, try `460800` or contact the manufacturer's support. + - **Save** your changes. + - **Troubleshooting**: + - Check the logs. + - If the add-on crashes or fails to communicate with the Thread integration: Toggle the **Hardware flow control** option and try again. +6. Restart the add-on and check the logs. Wait. +7. Go to {% my integrations title="**Settings** > **Devices & services**" %}, select the **Thread** integration. + - Select the cogwheel {% icon "mdi:cog-outline" %}. + - **Result**: You should now see a new `ha-thread` Thread network. + - **Troubleshooting**: If you don't see the network there, go back to the add-on configuration and adjust your settings, if needed, and try again. + +## Migrating a Thread network to a new adapter + +Follow these steps if you already have a Thread adapter running but want to switch to a new adapter. + +If you want to migrate to a Home Assistant Connect ZBT-2, follow the steps in the [Home Assistant Connect ZBT-2 documentation](https://support.nabucasa.com/hc/en-us/articles/32087461954589). + +### Prerequisites + +- [Home Assistant Operating System](/docs/glossary/#home-assistant-operating-system) installed on your smart home hub. For example: + - On a Home Assistant Green, where Home Assistant OS is preinstalled + - On a Home Assistant Yellow or on a Raspberry Pi +- Existing Thread adapter connected to your Home Assistant hub +- Latest updates installed +- A new Thread adapter and a USB extension cable + - If your adapter supports multiple protocols: + - They might have another firmware installed by default (Zigbee, for example). + - Check their documentation and install the OpenThread firmware on the adapter. + - Check their documentation and take a note of the baudrate. +- Thread devices + +### To migrate an existing Thread network to a new adapter + +1. Plug the new adapter into the extension cable and plug it into the Home Assistant hub. +2. Go to {% my supervisor_addon title="**Settings** > **Add-ons** > **OpenThread Border Router**" addon="core_openthread_border_router" %} and select the **Configuration** tab. +3. Under **Devices**, select your adapter. +4. Enter the **Baudrate** as specified in the documentation of your adapter. + - If you can't find the baudrate, try `460800` or contact the manufacturer's support. + - **Save** your changes. + - **Troubleshooting**: + - Check the logs. + - If the add-on crashes or fails to communicate with the Thread integration: Toggle the **Hardware flow control** option and try again. +5. Restart the add-on and check the logs. Wait. + - **Info**: Your Thread network is managed by Home Assistant. It is not stored on the adapter. Migrating the adapter means that Home Assistant will start to use your new adapter's radio instead of the old one. +6. Go to {% my integrations title="**Settings** > **Devices & services**" %}, select the **Thread** integration. + - Select the cogwheel {% icon "mdi:cog-outline" %}. + - **Result**: You should now see that the Thread network is still there. + - **Troubleshooting**: If you don't see the network there, go back to the add-on configuration and adjust your settings, if needed, and try again. +7. If you no longer want to use the old adapter, you can unplug it now. + ## Understanding the Thread configuration page This section explains why you might see multiple networks on the Thread configuration page and what this means for your network. diff --git a/source/_integrations/tod.markdown b/source/_integrations/tod.markdown index 29ea8a9cb03a..85e5407713bd 100644 --- a/source/_integrations/tod.markdown +++ b/source/_integrations/tod.markdown @@ -29,11 +29,11 @@ Off time: ## YAML configuration -Alternatlively, this integration can be configured and set up manually via YAML instead. This has some additional functionality over the UI version. +Alternatively, this integration can be configured and set up manually via YAML. This has some additional functionality over the UI setup. -The time ranges can be provided as absolute local time or using the `sunrise` or `sunset` keyword calculated based on the sun position for location. The location must be provided in the configuration. +The time ranges can be provided as an absolute local time or by using the `sunrise` or `sunset` keyword, calculated based on the sun position for the location. -In addition for sun position based ranges, the negative or positive offset can be configured. +In addition, for sun position-based ranges, a negative or positive offset can be configured. To enable the Times of Day binary sensor in your installation, add the following to your {% term "`configuration.yaml`" %} file: diff --git a/source/_integrations/zwave_js.markdown b/source/_integrations/zwave_js.markdown index 4b8e5c2696b9..52fb09f1e8a3 100644 --- a/source/_integrations/zwave_js.markdown +++ b/source/_integrations/zwave_js.markdown @@ -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. diff --git a/source/_posts/2017-10-28-demo.markdown b/source/_posts/2017-10-28-demo.markdown index ce40642b6d60..056d8e049e33 100644 --- a/source/_posts/2017-10-28-demo.markdown +++ b/source/_posts/2017-10-28-demo.markdown @@ -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 diff --git a/source/getting-started/concepts-terminology.markdown b/source/getting-started/concepts-terminology.markdown index 8cec0ca7c590..844502482a04 100644 --- a/source/getting-started/concepts-terminology.markdown +++ b/source/getting-started/concepts-terminology.markdown @@ -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. diff --git a/source/help/trivia.markdown b/source/help/trivia.markdown index 09994c9b6695..00634bba3875 100644 --- a/source/help/trivia.markdown +++ b/source/help/trivia.markdown @@ -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 diff --git a/source/images/distributors/mauser.png b/source/images/distributors/mauser.png deleted file mode 100644 index 41a969bb434f..000000000000 Binary files a/source/images/distributors/mauser.png and /dev/null differ diff --git a/source/images/distributors/mauser.webp b/source/images/distributors/mauser.webp new file mode 100644 index 000000000000..5662e02610d6 Binary files /dev/null and b/source/images/distributors/mauser.webp differ diff --git a/source/installation/index.html b/source/installation/index.html index dcc6d4e336c2..213f917fbfd7 100644 --- a/source/installation/index.html +++ b/source/installation/index.html @@ -52,7 +52,7 @@

Home Assistant Green

%} View tutorial {% include assets/chevron_right.html %}Install Home Assistant on Raspberry Pi
TOOLS REQUIRED @@ -128,6 +128,11 @@

About installation types

the recommended installation type for most users.
  • Home Assistant Container: 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" %}. +
      +
    • + Note: Some integrations, such as Thread and Z-Wave, are controlled by {% term "add-ons" %}. There is no out-of-the-box support for these on Container installations. +
      • +
    • diff --git a/source/more-info/unsupported/os.markdown b/source/more-info/unsupported/os.markdown index 5c456aab6246..7e63f4f49754 100644 --- a/source/more-info/unsupported/os.markdown +++ b/source/more-info/unsupported/os.markdown @@ -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. - -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. +You need to reinstall the host machine running the Supervisor using Home Assistant OS. -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**.