jeans/home-assistant.io
jeans/home-assistant.io
1
0
Fork 0
mirror of https://github.com/home-assistant/home-assistant.io.git synced 2025-07-21 16:27:19 +00:00
Code Issues Packages Projects Releases Wiki Activity

2024.9 (#34578)

Browse Source
This commit is contained in:
Bram Kragten 2024-09-04 18:00:25 +02:00 committed by GitHub
commit 28546b6690
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
82 changed files with 3378 additions and 208 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
Gemfile.lock
View File

@ -26,6 +26,7 @@ GEM
eventmachine (>= 0.12.9)
http_parser.rb (~> 0)
eventmachine (1.2.7)
ffi (1.17.0-arm64-darwin)
ffi (1.17.0-x86_64-linux-gnu)
forwardable-extended (2.6.0)
google-protobuf (4.28.0-x86_64-linux)
@ -77,6 +78,8 @@ GEM
multi_json (1.15.0)
mustermann (3.0.3)
ruby2_keywords (~> 0.0.1)
nokogiri (1.16.7-arm64-darwin)
racc (~> 1.4)
nokogiri (1.16.7-x86_64-linux)
racc (~> 1.4)
parallel (1.26.3)
@ -132,6 +135,8 @@ GEM
google-protobuf (~> 4.27)
sass-globbing (1.1.5)
sass (>= 3.1)
sassc (2.1.0)
ffi (~> 1.9)
sassc (2.1.0-x86_64-linux)
ffi (~> 1.9)
sinatra (4.0.0)
@ -153,6 +158,7 @@ GEM
webrick (1.8.1)
PLATFORMS
arm64-darwin-23
x86_64-linux
DEPENDENCIES

6
_config.yml
View File

@ -107,9 +107,9 @@ social:
# Home Assistant release details
current_major_version: 2024
current_minor_version: 8
current_patch_version: 3
date_released: 2024-08-25
current_minor_version: 9
current_patch_version: 0
date_released: 2024-09-04
# Either # or the anchor link to latest release notes in the blog post.
# Must be prefixed with a # and have double quotes around it.

104
source/_docs/asterisk_mbox.markdown
View File

@ -1,104 +0,0 @@
---
title: "Asterisk Voicemail server installation"
description: "Instructions on how to integrate your existing Asterisk voicemail within Home Assistant."
---
Asterisk Voicemail integration allows Home Assistant to view, listen to and delete voicemails from a Asterisk voicemail mailbox.
There are two components to the integration:
- A server that runs on the Asterisk PBX host and communicates over an open port.
- A client which can request information from the server.
Both parts are necessary for Asterisk voicemail integration.
The server installation is documented below. The client is [integrated inside Home Assistant](/integrations/asterisk_mbox)
{% note %}
Currently this module can only monitor a single Asterisk PBX mailbox.
{% endnote %}
### Prerequisites
Before beginning make sure that you have the following:
- A functional Asterisk PBX setup which is using the default `voicemail` application.
- Both Home Assistant and Asterisk PBX running on the same LAN (or the same server).
- The Asterisk PBX server has Python 3.5 or newer installed.
- Administrator access on the Asterisk PBX (for Python module installation).
- Account access to the `asterisk` user that runs the Asterisk PBX software.
### Installation
1. Apply for a Google API key to enable speech-transcription services
2. Install the `asterisk_mbox_server` Python module:
```bash
pip3 install asterisk_mbox_server
```
3. Create a configuration file for the server
As the `asterisk` user create an `asterisk_mbox.ini` file. You can place this in any directory you choose, but the recommended location is `/etc/asterisk/asterisk_mbox.ini`.
```ini
[default]
host = IP_ADDRESS
port = PORT
password = PASSWORD
mbox_path = PATH_TO_VOICEMAIL_FILES
cache_file = PATH_TO_CACHE_FILE
google_key = GOOGLE_API_KEY
cdr = mysql+pymysql://<mysql-user>:<mysql-password>@localhost/asterisk/cdr
```
- `host` (*Optional*): The IP address to listen on for client requests. This defaults to all IP addresses on the server. To listen only locally, choose `127.0.0.1`
- `port` (*Optional*): The port to listen on for client requests. Defaults to 12345.
- `password` (*Required*): A password shared between client and server. Use only alphanumeric characters and spaces
- `mbox_path` (*Required*): The path to the storage location of mailbox files. This is typically `/var/spool/asterisk/voicemail/default/<mailbox>/`
- `cache_file` (*Required*): A fully-qualified path to a file that can be written by the server containing transcriptions of voicemails. Example: `/var/spool/asterisk/transcription.cache`
- `google_key` (*Required*): Your 40 characters Google API key.
- `cdr` (*Optional*): Where to find CDR data. Supports various SQL databases as well as a file log. Configuring the CDR will enable the `asterisk_cdr` platform.
Once complete, ensure this file is only accessible by the Asterisk user:
```bash
sudo chown asterisk:asterisk /etc/asterisk/asterisk_mbox.ini
sudo chmod 600 /etc/asterisk/asterisk_mbox.ini
```
4. Interactively start the server to verify it is functioning
```bash
sudo -u asterisk asterisk_mbox_server -v --cfg /etc/asterisk/asterisk_mbox.ini
```
Now complete the [Home Assistant configuration](/integrations/asterisk_mbox) and verify that Home Assistant can communicate with the server
You can use `Ctrl-c` to terminate the server when done testing
5. Configure the server to start automatically
Copy the following code into `/etc/systemd/system/asterisk_mbox.service`:
```ini
[Unit]
Description=Asterisk PBX voicemail server for Home Assistant
Wants=network.target
After=network.target
[Service]
Type=simple
User=asterisk
Group=asterisk
ExecStart=/usr/local/bin/asterisk-mbox-server --cfg /etc/asterisk/asterisk_mbox.ini
Restart=on-failure
[Install]
WantedBy=multi-user.target
```
{% note %}
This assumes that your Asterisk PBX server is using `systemd` for init handling. If not, you will need to create the appropriate configuration files yourself.
{% endnote %}

42
source/_docs/configuration/templating.markdown
View File

@ -1091,6 +1091,38 @@ While Jinja natively supports the conversion of an iterable to a `list`, it does
Note that, in Home Assistant, to convert a value to a `list`, a `string`, an `int`, or a `float`, Jinja has built-in functions with names that correspond to each type.
### Iterating multiple objects
The `zip()` function can be used to iterate over multiple collections in one operation.
{% raw %}
```text
{% set names = ['Living Room', 'Dining Room'] %}
{% set entities = ['sensor.living_room_temperature', 'sensor.dining_room_temperature'] %}
{% for name, entity in zip(names, entities) %}
The {{ name }} temperature is {{ states(entity) }}
{% endfor %}
```
{% endraw %}
`zip()` can also unzip lists.
{% raw %}
```text
{% set information = [
('Living Room', 'sensor.living_room_temperature'),
('Dining Room', 'sensor.dining_room_temperature')
] %}
{% set names, entities = zip(*information) %}
The names are {{ names | join(', ') }}
The entities are {{ entities | join(', ') }}
```
{% endraw %}
### Functions and filters to process raw data
These functions are used to process raw value's in a `bytes` format to values in a native Python type or vice-versa.
@ -1284,7 +1316,7 @@ For actions, command templates are defined to format the outgoing MQTT payload t
{% note %}
Example command template:
**Example command template with JSON data:**
With given value `21.9` template {% raw %}`{"temperature": {{ value }} }`{% endraw %} renders to:
@ -1298,6 +1330,14 @@ Additional the MQTT entity attributes `entity_id`, `name` and `this` can be used
{% endnote %}
**Example command template with raw data:**
When a command template renders to a valid `bytes` literal, then MQTT will publish this data as raw data. In other cases, a string representation will be published. So:
- Template {% raw %}`{{ "16" }}`{% endraw %} renders to payload encoded string `"16"`.
- Template {% raw %}`{{ 16 }}`{% endraw %} renders to payload encoded string `"16"`.
- Template {% raw %}`{{ pack(0x10, ">B") }}`{% endraw %} renders to a raw 1 byte payload `0x10`.
## Some more things to keep in mind
### `entity_id` that begins with a number

1
source/_integrations/airgradient.markdown
View File

@ -17,6 +17,7 @@ ha_platforms:
- select
- sensor
- switch
- update
ha_integration_type: device
ha_zeroconf: true
---

6
source/_integrations/alarm_control_panel.mqtt.markdown
View File

@ -135,6 +135,10 @@ device:
description: "The model of the device."
required: false
type: string
model_id:
description: The model identifier of the device.
required: false
type: string
name:
description: "The name of the device."
required: false
@ -344,4 +348,4 @@ mqtt:
{% caution %}
When your MQTT connection is not secured, this will send your secret code over the network unprotected!
{% endcaution %}

20
source/_integrations/amcrest.markdown
View File

@ -292,7 +292,7 @@ elements:
bottom: 50px
tap_action:
action: call-service
action: amcrest.ptz_control
service: amcrest.ptz_control
service_data:
entity_id: camera.lakehouse
movement: up
@ -304,7 +304,7 @@ elements:
bottom: 0px
tap_action:
action: call-service
action: amcrest.ptz_control
service: amcrest.ptz_control
service_data:
entity_id: camera.lakehouse
movement: down
@ -316,7 +316,7 @@ elements:
bottom: 25px
tap_action:
action: call-service
action: amcrest.ptz_control
service: amcrest.ptz_control
service_data:
entity_id: camera.lakehouse
movement: left
@ -328,7 +328,7 @@ elements:
bottom: 25px
tap_action:
action: call-service
action: amcrest.ptz_control
service: amcrest.ptz_control
service_data:
entity_id: camera.lakehouse
movement: right
@ -340,7 +340,7 @@ elements:
bottom: 50px
tap_action:
action: call-service
action: amcrest.ptz_control
service: amcrest.ptz_control
service_data:
entity_id: camera.lakehouse
movement: left_up
@ -352,7 +352,7 @@ elements:
bottom: 50px
tap_action:
action: call-service
action: amcrest.ptz_control
service: amcrest.ptz_control
service_data:
entity_id: camera.lakehouse
movement: right_up
@ -364,7 +364,7 @@ elements:
bottom: 0px
tap_action:
action: call-service
action: amcrest.ptz_control
service: amcrest.ptz_control
service_data:
entity_id: camera.lakehouse
movement: left_down
@ -376,7 +376,7 @@ elements:
bottom: 0px
tap_action:
action: call-service
action: amcrest.ptz_control
service: amcrest.ptz_control
service_data:
entity_id: camera.lakehouse
movement: right_down
@ -388,13 +388,13 @@ elements:
right: 25px
tap_action:
action: call-service
action: amcrest.ptz_control
service: amcrest.ptz_control
service_data:
entity_id: camera.lakehouse
movement: zoom_in
hold_action:
action: call-service
action: amcrest.ptz_control
service: amcrest.ptz_control
data:
entity_id: camera.lakehouse
movement: zoom_out

77
source/_integrations/anthropic.markdown Normal file
View File

@ -0,0 +1,77 @@
---
title: Anthropic Conversation
description: Instructions on how to integrate Anthropic Claude as a conversation agent
ha_category:
- Voice
ha_release: 2024.9
ha_iot_class: Cloud Polling
ha_config_flow: true
ha_codeowners:
- '@Shulyaka'
ha_domain: anthropic
ha_integration_type: service
ha_platforms:
- conversation
related:
- docs: /voice_control/voice_remote_expose_devices/
title: Exposing entities to Assist
- docs: /voice_control/assist_create_open_ai_personality/
title: Create an AI personality
- url: https://console.anthropic.com/settings/keys
title: Anthropic API key
- url: https://www.anthropic.com
title: Anthropic
- url: https://claude.ai
title: Claude
---
The **Anthropic** {% term integrations %} adds a conversation agent powered by [Anthropic](https://www.anthropic.com), such as Claude 3.5 Sonnet, in Home Assistant.
Controlling Home Assistant is done by providing the AI access to the Assist API of Home Assistant. You can control what devices and entities it can access from the {% my voice_assistants title="exposed entities page" %}. The AI can provide you information about your devices and control them.
Legal note: Anthropic currently limits the API usage to organizations only, more info here: [Can I use the Claude API for individual use?](https://support.anthropic.com/en/articles/8987200-can-i-use-the-claude-api-for-individual-use)
This integration does not integrate with [sentence triggers](/docs/automation/trigger/#sentence-trigger).
## Prerequisites
- This integration requires an API key to use, [which you can generate here.](https://console.anthropic.com/settings/keys).
- This is a paid service, we advise you to monitor your costs in the [Anthropic portal](https://console.anthropic.com/settings/cost) closely.
### Generating an API Key
The Anthropic API key is used to authenticate requests to the Anthropic API. To generate an API key, take the following steps:
1. Log in to the [Anthropic portal](https://console.anthropic.com) or sign up for an account.
2. Enable billing with a valid credit card on the [plans page](https://console.anthropic.com/settings/plans).
3. Visit the [API Keys page](https://console.anthropic.com/settings/keys) to retrieve the API key you'll use to configure the integration.
{% include integrations/config_flow.md %}
{% include integrations/option_flow.md %}
{% configuration_basic %}
Instructions:
description: Instructions for the AI on how it should respond to your requests. It is written using [Home Assistant Templating](/docs/configuration/templating/).
Control Home Assistant:
description: If the model is allowed to interact with Home Assistant. It can only control or provide information about entities that are [exposed](/voice_control/voice_remote_expose_devices/) to it.
Recommended settings:
description: If enabled, the recommended model and settings are chosen.
{% endconfiguration_basic %}
If you choose not to use the recommended settings, you can configure the following options:
{% configuration_basic %}
Model:
description: The model that will complete your prompt. See [models](https://docs.anthropic.com/en/docs/about-claude/models#model-names) for additional details and options.
Maximum Tokens to Return in Response:
description: The maximum number of tokens to generate before stopping. Note that our models may stop _before_ reaching this maximum. This parameter only specifies the absolute maximum number of tokens to generate. Different models have different maximum values for this parameter. See [models](https://docs.anthropic.com/en/docs/models-overview) for details.
Temperature:
description: Amount of randomness injected into the response. Use `temperature` closer to `0.0` for analytical / multiple choice, and closer to `1.0` for creative and generative tasks. Note that even with `temperature` of `0.0`, the results will not be fully deterministic.
{% endconfiguration_basic %}

42
source/_integrations/apsystems.markdown
View File

@ -8,6 +8,7 @@ ha_category:
- Energy
ha_domain: apsystems
ha_platforms:
- binary_sensor
- number
- sensor
- switch
@ -17,17 +18,42 @@ ha_codeowners:
- '@SonnenladenGmbH'
---
The **APsystems** {% term integration %} allows you to read the data from your [APsystems EZ1](https://emea.apsystems.com/diy/ez1/) microinverter. It also allows you to set the output limit to any number between 30 and 800 watts.
The following data is provided by the integration:
The **APsystems** {% term integration %} allows you to read the data from your [APsystems EZ1](https://emea.apsystems.com/diy/ez1/) microinverter. It also allows you to set the output limit to anything above 30 watts.
## Sensors
### Numerical sensors
| Sensor ID | Unit | Description
|---|---| ---|
| total_power | W | Total current output of the inverter
| lifetime_production_p1 | kWh | Lifetime production of first input
| lifetime_production_p2 | kWh | Lifetime production of second input
| lifetime_production | kWh | Lifetime production of both inputs combined
| total_power_p1 | W | Current input on first input
| total_power_p2 | W | Current input on second input
| today_production | kWh | Today's production of both inputs combined
| today_production_p1 | kWh | Today's production of first input
| today_production_p2 | kWh | Today's production of second input
### Binary sensors
| Sensor ID | Description
|---|---|
| off_grid_status | On when the inverter is not connected to the power grid
| dc_1_short_circuit_error_status | Short circuit detected on first input
| dc_2_short_circuit_error_status | Short circuit detected on second input
| output_fault_status | Output because of any error deactivated
## Settings
| Setting ID | Type | Description
|---|---|---|
| inverter_status | switch | Enables or disables the inverter's output
| output_limit | number | Sets the max output of the inverter
- Lifetime production (Per input and in total)
- Current production (Per input and in total)
- Today's production (Per input and in total)
The following data can be set by the integration:
- Maximal output in watts
- Inverter status (on or off)
## Prerequisites

6
source/_integrations/aquacell.markdown
View File

@ -1,5 +1,5 @@
---
title: Aquacell
title: AquaCell
description: Instructions on how to integrate AquaCell with Home Assistant.
ha_category:
- Sensor
@ -17,10 +17,12 @@ ha_integration_type: device
AquaCell is a water-softening device. The **AquaCell** {% term integration %} allows you to monitor your AquaCell device in Home Assistant.
You will need your Aquacell account information as used in the **AquaCell** app.
This integration also supports **Harvey** softeners.
{% include integrations/config_flow.md %}
<div class='note warning'>
This integration only works with <b>AquaCell</b> devices which have an <b>i-Lid</b> and are configured through the 'Mijn AquaCell' mobile app.
This integration only works with <b>AquaCell</b> or <b>Harvey</b> devices which have an <b>i-Lid</b> and are configured through the 'Mijn AquaCell' or 'My Harvey' mobile app.
</div>
## Sensors

1
source/_integrations/aranet.markdown
View File

@ -28,5 +28,6 @@ The Aranet integration will automatically discover devices once the [Bluetooth](
- [Aranet2](https://aranet.com/products/aranet2/)
- [Aranet4](https://aranet.com/products/aranet4/)
- [Aranet Radiation](https://aranet.com/products/aranet-radiation-sensor/)
- [Aranet Radon Plus](https://aranet.com/products/aranet-radon-sensor)
The Aranet integration requires that your Aranet device is updated to at least firmware version 1.2.0 and has the "Smart Home integration" feature enabled. Both of these can be done within the settings portion of the Aranet Home mobile application on both Android and iOS.

17
source/_integrations/artsound.markdown Normal file
View File

@ -0,0 +1,17 @@
---
title: ArtSound
description: Connect and control your ArtSound media players using the LinkPlay integration
ha_release: 2024.9
ha_category:
- Media player
ha_domain: artsound
ha_integration_type: virtual
works_with:
- linkplay
---
The **ArtSound** {% term integration %} allows users to control their ArtSound media players through the **LinkPlay** {% term integration %}.
[Learn more about LinkPlay in Home Assistant.](/integrations/linkplay/)
{% include integrations/supported_brand.md %}

10
source/_integrations/august.markdown
View File

@ -29,6 +29,8 @@ ha_integration_type: integration
The `august` integration allows you to integrate your [August](https://august.com/) and some Yale Access devices in Home Assistant.
For devices that use the [Yale Home](https://yalehome.com/global) app, the [Yale](/integrations/yale) integration should be used instead.
{% include integrations/config_flow.md %}
## Known working devices
@ -43,10 +45,6 @@ The `august` integration allows you to integrate your [August](https://august.co
| August View | no |
| Yale Assure Lock | yes |
| Yale Assure Lock 2 | yes |
| Yale Conexis L1 | yes |
| Yale Conexis L2 | yes |
| Yale Doorman L3 | yes |
| Yale Linus | yes |
| Yale Smart Safe | yes |
Other devices not listed above have not been tested and may not function as expected.
@ -124,9 +122,7 @@ If you have an August Keypad, once you have enabled the August integration, you
## Integration with Yale Access Bluetooth
Following Assa Abloy, Yale's parent company, purchasing August in 2017, most newer devices use the Yale Access branding.
The [Yale Access Bluetooth](/integrations/yalexs_ble) integration provides local control over Bluetooth of many Yale Access locks and some August locks that use the same system.
The [Yale Access Bluetooth](/integrations/yalexs_ble) integration provides local control over Bluetooth of many Yale Access locks and some August locks that use the same system.
For locks that support the Yale Access system, the August integration can keep your offline access keys up to date to ensure you can operate your lock over Bluetooth. The following requirements must be met for the offline key updates to work:

4
source/_integrations/binary_sensor.mqtt.markdown
View File

@ -96,6 +96,10 @@ device:
description: The model of the device.
required: false
type: string
model_id:
description: The model identifier of the device.
required: false
type: string
name:
description: The name of the device.
required: false

4
source/_integrations/button.mqtt.markdown
View File

@ -93,6 +93,10 @@ device:
description: The model of the device.
required: false
type: string
model_id:
description: The model identifier of the device.
required: false
type: string
name:
description: The name of the device.
required: false

4
source/_integrations/camera.mqtt.markdown
View File

@ -95,6 +95,10 @@ device:
description: The model of the device.
required: false
type: string
model_id:
description: The model identifier of the device.
required: false
type: string
name:
description: The name of the device.
required: false

26
source/_integrations/chacon_dio.markdown
View File

@ -3,6 +3,7 @@ title: Chacon Dio
description: Instructions on how to integrate your Chacon Dio devices within Home Assistant.
ha_category:
- Cover
- Switch
ha_release: 2024.8
ha_iot_class: Cloud Push
ha_config_flow: true
@ -11,15 +12,17 @@ ha_codeowners:
ha_domain: chacon_dio
ha_platforms:
- cover
- switch
ha_integration_type: integration
---
[Chacon Dio devices](https://chacon.com/en/) are connected home devices that can be controlled via RF 433 MHz or Wi-Fi.
This {% term integrations %} gives you access to the Wi-Fi connection so that Home Assistant can list your Chacon Dio devices and interact with them in real time, the same way the vendor's smartphone application does.
There is currently support for the following information within Home Assistant:
There is currently support for the following device types within Home Assistant:
- Cover devices (get statuses, move up, down, stop, and move to a given percentage)
- [Cover](#cover)
- [Switch](#switch)
## Prerequisites
@ -30,6 +33,25 @@ You will need to use the standalone app for this device to register a username a
{% include integrations/config_flow.md %}
## Cover
The cover platform integrates Chacon Dio devices to manage covers (like the REV-SHUTTER model) into Home Assistant, enabling control of the following:
- get the **state** of the cover (connected or not, position and current movement)
- **Open/close/stop** the cover
- **Set position** of the cover (0-100%)
## Switch
The switch platform integrates Chacon Dio devices to manage switches (like the REV-SWITCH model) into Home Assistant, enabling control of the following:
- get the **state** of the switch (connected or not and on/off state)
- **Turn on/off** the switch
## Actions
In rare cases, such as Wi-Fi interruptions, you may need to manually update the state of your devices. You can use the `homeassistant.update_entity` action to refresh the device state manually.
## Tips
You can use the [group integration](/integrations/group) to group entities as the application proposes (for example covers of the first floor).

6
source/_integrations/climate.mqtt.markdown
View File

@ -115,6 +115,10 @@ device:
description: 'The model of the device.'
required: false
type: string
model_id:
description: The model identifier of the device.
required: false
type: string
name:
description: 'The name of the device.'
required: false
@ -474,4 +478,4 @@ mqtt:
precision: 1.0
```
{% endraw %}
{% endraw %}

2
source/_integrations/coinbase.markdown
View File

@ -18,7 +18,7 @@ ha_integration_type: integration
The `coinbase` integration lets you access account balances and exchange rates from [Coinbase](https://coinbase.com).
You will need to obtain an API key from the API section in Coinbase's [User Settings](https://www.coinbase.com/settings/api) to use this integration. You need to select the account wallet or wallets (e.g. "BTC Wallet") that you wish to show in Home Assistant and give read access to `wallet:accounts` in order for the integration to access relevant data. It is worth noting that once you close the New API Key popup on Coinbase you will not be able to see the API Secret again.
You will need to obtain an API key from the API section in Coinbase's [User Settings](https://www.coinbase.com/settings/api) to use this integration. Your API key and secret should be of the form `organizations/XXXXX/apiKeys/XXXXX` and `-----BEGIN EC PRIVATE KEY-----\nXXXXXXXXXXXXXXXXX\n-----END EC PRIVATE KEY-----\n` respectively. When creating your API key, it is highly recommended to ensure that only the **View** box is ticked in the **API restrictions** section.
{% include integrations/config_flow.md %}

4
source/_integrations/cover.mqtt.markdown
View File

@ -106,6 +106,10 @@ device:
description: The model of the device.
required: false
type: string
model_id:
description: The model identifier of the device.
required: false
type: string
name:
description: The name of the device.
required: false

4
source/_integrations/device_tracker.mqtt.markdown
View File

@ -95,6 +95,10 @@ device:
description: The model of the device.
required: false
type: string
model_id:
description: The model identifier of the device.
required: false
type: string
name:
description: The name of the device.
required: false

4
source/_integrations/device_trigger.mqtt.markdown
View File

@ -68,6 +68,10 @@ device:
description: The model of the device.
required: false
type: string
model_id:
description: The model identifier of the device.
required: false
type: string
name:
description: The name of the device.
required: false

1
source/_integrations/drop_connect.markdown
View File

@ -37,6 +37,7 @@ There is currently support for the following DROP products within Home Assistant
- **Pump Controller**: smart replacement for an FSG pressure switch.
- **RO Filter**: reverse osmosis drinking water filtration.
- **Salt Sensor**: alerts when the salt level in the softener brine tank is low.
- **Alert**: monitors both the water level in a sump pit and electrical power to the sump pump.
### Prerequisites

4
source/_integrations/event.mqtt.markdown
View File

@ -87,6 +87,10 @@ device:
description: The model of the device.
required: false
type: string
model_id:
description: The model identifier of the device.
required: false
type: string
name:
description: The name of the device.
required: false

4
source/_integrations/fan.mqtt.markdown
View File

@ -102,6 +102,10 @@ device:
description: The model of the device.
required: false
type: string
model_id:
description: The model identifier of the device.
required: false
type: string
name:
description: The name of the device.
required: false

36
source/_integrations/fujitsu_fglair.markdown Normal file
View File

@ -0,0 +1,36 @@
---
title: Fujitsu FGLair
description: Control your Fujitsu heat pump or air conditioner that uses the FGLair app
ha_category:
- Climate
ha_release: 2024.9
ha_domain: fujitsu_fglair
ha_integration_type: integration
ha_codeowners:
- '@crevetor'
ha_config_flow: true
ha_platforms:
- climate
ha_iot_class: "Cloud Polling"
---
The {{ page.title }} {% term integration %} provides support for Fujitsu heat pumps and air conditioners that use the FGLair app.
To find out which app to use for your heat pump, check [the Fujitsu FGLair FAQ](https://www.fujitsu-general.com/global/support/faq/airstage-mobile/0127.html).
## Prerequisites
First, set up your device in the FGLair app before using this integration.
To configure this integration, you will need the credentials (login and password) used to connect to the FGLair application.
{% include integrations/config_flow.md %}
## Climate
This integration supports the following functionalities (if the devices support them):
- [`set_hvac_mode`](/integrations/climate/#action-climateset_hvac_mode)
- [`target temperature`](/integrations/climate#action-climateset_temperature)
- [`turn on/off`](/integrations/climate#action-climateturn_on)
- [`fan mode`](/integrations/climate#action-climateset_fan_mode)
- [`swing mode`](/integrations/climate#action-climateset_swing_mode)

11
source/_integrations/homematicip_cloud.markdown
View File

@ -219,6 +219,7 @@ Executable by all users:
- `homematicip_cloud.deactivate_eco_mode`: Deactivates the eco mode immediately.
- `homematicip_cloud.deactivate_vacation`: Deactivates the vacation mode immediately.
- `homematicip_cloud.set_active_climate_profile`: Set the active climate profile index.
- `homematicip_cloud.set_home_cooling_mode`: Enable or disable cooling for the home.
Executable by administrators or within the context of an automation:
- `homematicip_cloud.dump_hap_config`: Dump the configuration of the Homematic IP Access Point(s).
@ -318,6 +319,16 @@ action:
entity_id: switch.livingroom
```
Enable (or disable) Cooling mode for the entire home. Disabling Cooling mode will revert to Heating.
```yaml
...
action:
action: homematicip_cloud.set_home_cooling_mode
data:
cooling: True
accesspoint_id: 3014xxxxxxxxxxxxxxxxxxxx
```
## Additional info

4
source/_integrations/humidifier.mqtt.markdown
View File

@ -120,6 +120,10 @@ device:
description: The model of the device.
required: false
type: string
model_id:
description: The model identifier of the device.
required: false
type: string
name:
description: The name of the device.
required: false

2
source/_integrations/husqvarna_automower.markdown
View File

@ -107,7 +107,7 @@ The integration will create the following binary sensors:
### Button (if available)
The integration will create a button entity for confirming minor mower errors. This entity is disabled by default. You have to enable it manually. The API can't detect if the mower has the capability to confirm minor errors remotely. Before enabling this function, refer to the mower documentation.
The integration will create a button entity for confirming minor mower errors.
### Device tracker (if available)

4
source/_integrations/image.mqtt.markdown
View File

@ -98,6 +98,10 @@ device:
description: The model of the device.
required: false
type: string
model_id:
description: The model identifier of the device.
required: false
type: string
name:
description: The name of the device.
required: false

34
source/_integrations/ista_ecotrend.markdown
View File

@ -34,3 +34,37 @@ The **ista EcoTrend** integration exposes the last monthly readings as sensors.
- **Water costs**: estimated costs in EUR
Not all values may be available in your ista EcoTrend account. Cost estimation is an optional service that has to be booked by your property manager. Therefore, the cost sensors are deactivated by default.
## Long-term statistics
The **ista EcoTrend** integration allows you to import all your historical consumption readings from your ista EcoTrend account into long-term statistic entities. These entities can be displayed in your Home Assistant energy dashboard, providing a comprehensive view of your consumption data over time.
### Identifying ista EcoTrend statistic entities
The statistic entities imported via this integration have a `ista_ecotrend:` prefix. This prefix helps you identify and distinguish these entities from other sensor statistics when setting up the long-term statistics in the energy dashboard.
### Setting up long-term statistics in the energy dashboard
To set up the **ista EcoTrend** long-term statistics in your Home Assistant energy dashboard, follow these steps:
- **Access the energy configuration panel**
- Go to the [energy configuration panel](https://my.home-assistant.io/redirect/config_energy/) of your Home Assistant instance.
[![Open your Home Assistant instance and show your energy configuration panel.](https://my.home-assistant.io/badges/config_energy.svg)](https://my.home-assistant.io/redirect/config_energy/)
- **Add heating energy usage**
- Go to **Gas consumption**.
- Select **Add gas source**.
- Choose your **Heating energy** entity (for example, `ista_ecotrend:luxemburger_str_1_heating_energy`).
- For cost tracking, select the **Use an entity tracking the total costs** option.
- Select the corresponding **Heating costs** entity (for example, `ista_ecotrend:luxemburger_str_1_heating_cost`).
- **Add hot water energy usage**
- To track hot water energy usage and costs (for example, `ista_ecotrend:luxemburger_str_1_hot_water_energy` and `ista_ecotrend:luxemburger_str_1_hot_water_cost`), repeat the above steps for your **Hot water energy** and **Hot water costs** entities.
- **Add hot water consumption**
- Go to **Water consumption**.
- Select **Add water source**.
- Choose the **Hot water** entity (for example, `ista_ecotrend:luxemburger_str_1_hot_water`).
- For cost tracking, select the **Use an entity tracking the total costs** option.
- Select the corresponding **Hot water costs** entity (for example, `ista_ecotrend:luxemburger_str_1_hot_water_cost`).
- **Add water consumption**
- To track cold water consumption and costs (for example, `ista_ecotrend:luxemburger_str_1_water` and `ista_ecotrend:luxemburger_str_1_water_cost`), repeat the above steps for your **Water** and **Water costs** entities.

35
source/_integrations/knx.markdown
View File

@ -74,10 +74,6 @@ There is currently support for the following device types within Home Assistant:
- [Time](#time)
- [Weather](#weather)
## Free KNX online training
As a Home Assistant KNX user, you can start a FREE KNX online training and get a discounted ETS Home license on the [KNX website](https://www.knx.org/knx-en/for-your-home/home-assistant/).
{% include integrations/config_flow.md %}
## Basic configuration
@ -791,29 +787,28 @@ knx:
```
`operation_mode_frost_protection_address` / `operation_mode_night_address` / `operation_mode_comfort_address` / `operation_mode_standby_address` are not necessary if `operation_mode_address` is specified.
If the actor doesn't support explicit state group objects the `*_state_address` can be configured with the same group address as the writeable `*_address`. The read flag for the `*_state_address` group object has to be set in ETS to support initial reading e.g., when starting Home Assistant.
The following values are valid for the `heat_cool_address` and the `heat_cool_state_address`:
- `0` (cooling)
- `1` (heating)
The following values are valid for the Home Assistant [Climate](/integrations/climate/) `hvac_mode` attribute. Supported values for your KNX thermostats can be specified via `controller_modes` configuration variable:
Supported HVAC modes for your KNX thermostats are found automatically. This can be overridden by using the `controller_modes` configuration variable. The following values are valid controller modes:
- `off` (maps internally to `HVAC_MODE_OFF` within Home Assistant)
- `auto` (maps internally to `HVAC_MODE_AUTO` within Home Assistant)
- `heat` (maps internally to `HVAC_MODE_HEAT` within Home Assistant)
- `cool` (maps internally to `HVAC_MODE_COOL` within Home Assistant)
- `fan_only` (maps internally to `HVAC_MODE_FAN_ONLY` within Home Assistant)
- `dehumidification` (maps internally to `HVAC_MODE_DRY` within Home Assistant)
- `off`
- `auto`
- `heat`
- `cool`
- `fan_only`
- `dehumidification`
The following presets are valid for the Home Assistant [Climate](/integrations/climate/) `preset_mode` attribute. Supported values for your KNX thermostats can be specified via `operation_modes` configuration variable:
Supported preset modes for your KNX thermostats are found automatically. This can be overridden by using the `operation_modes` configuration variable. The following values are valid operation modes:
- `auto` (maps to `none` of the Home Assistant [Climate](/integrations/climate/) `preset_mode` attribute)
- `comfort` (maps to `comfort` of the Home Assistant [Climate](/integrations/climate/) `preset_mode` attribute)
- `standby` (maps to `away` of the Home Assistant [Climate](/integrations/climate/) `preset_mode` attribute)
- `economy` (maps to `sleep` of the Home Assistant [Climate](/integrations/climate/) `preset_mode` attribute)
- `building_protection` (maps to `eco` of the Home Assistant [Climate](/integrations/climate/) `preset_mode` attribute)
- `auto`
- `comfort`
- `standby`
- `economy`
- `building_protection`
{% configuration %}
name:
@ -918,11 +913,11 @@ operation_mode_standby_address:
required: false
type: [string, list]
operation_modes:
description: Overrides the supported operation modes. Provide the supported `preset_mode` values for your device.
description: Overrides the supported operation modes. Provide the supported `preset_modes` value for your device.
required: false
type: list
controller_modes:
description: Overrides the supported controller modes. Provide the supported `hvac_mode` values for your device.
description: Overrides the supported controller modes. Provide the supported `hvac_modes` value for your device.
required: false
type: list
default_controller_mode:

4
source/_integrations/lawn_mower.mqtt.markdown
View File

@ -96,6 +96,10 @@ device:
description: The model of the device.
required: false
type: string
model_id:
description: The model identifier of the device.
required: false
type: string
name:
description: The name of the device.
required: false

4
source/_integrations/light.mqtt.markdown
View File

@ -164,6 +164,10 @@ device:
description: 'The model of the device.'
required: false
type: string
model_id:
description: The model identifier of the device.
required: false
type: string
name:
description: 'The name of the device.'
required: false

4
source/_integrations/lock.mqtt.markdown
View File

@ -108,6 +108,10 @@ device:
description: 'The model of the device.'
required: false
type: string
model_id:
description: The model identifier of the device.
required: false
type: string
name:
description: 'The name of the device.'
required: false

5
source/_integrations/manual.markdown
View File

@ -34,6 +34,10 @@ name:
required: false
type: string
default: HA Alarm
unique_id:
description: Create a unique id for the entity.
required: false
type: string
code:
description: >
If defined, specifies a code to enable or disable the alarm in the frontend.
@ -147,6 +151,7 @@ In the configuration example below:
alarm_control_panel:
- platform: manual
name: Home Alarm
unique_id: a_very_unique_id
code: "1234"
arming_time: 30
delay_time: 20

6
source/_integrations/mastodon.markdown
View File

@ -10,7 +10,9 @@ ha_codeowners:
ha_domain: mastodon
ha_iot_class: Cloud Push
ha_platforms:
- diagnostics
- notify
- sensor
ha_integration_type: service
ha_config_flow: true
---
@ -24,6 +26,10 @@ If you want to grant only required accesses, uncheck all checkboxes then check o
{% include integrations/config_flow.md %}
## Sensors
The integration will create sensors for the Mastodon account showing total followers, following, and posts.
## Notifications
The integration will create a `notify` action matching the name of the integration entry.

7
source/_integrations/motion_blinds.markdown
View File

@ -10,6 +10,7 @@ ha_codeowners:
- '@starkillerOG'
ha_config_flow: true
ha_platforms:
- button
- cover
- sensor
ha_dhcp: true
@ -95,6 +96,12 @@ In the official Bloc Blinds app go to settings (three bars > gear icon), go to t
Click the about page of the connector app 5 times to get the key ([iOS app](https://apps.apple.com/us/app/connector/id1344058317), [Android app](https://play.google.com/store/apps/details?id=com.smarthome.app.connector)).
## Favorite position
A **Go to favorite position** button entity allows you to move the blind to its favorite position. For this entity to show up, you first need to set the blind's favorite position in the mobile app, using a remote or physical buttons on the blind. Refer to the manual of your specific blind for instructions.
The **Set current position as favorite** button entity allows you to change the favorite position. For this to work, the blind first needs to be put in programming mode by shortly pressing the reset button on the blind. It will start stepping (moving a small bit up-down repeatedly). You can then use the **Set current position as favorite** entity. After you are done, shortly press the reset button again to exit the programming mode.
## Top Down Bottom Up (TDBU) blinds
TDBU blinds consist of two bars controlled by two motors designated by Top and Bottom with fabric in between.

28
source/_integrations/mqtt.markdown
View File

@ -119,6 +119,15 @@ MQTT (aka MQ Telemetry Transport) is a machine-to-machine or "Internet of Things
Your first step to get MQTT and Home Assistant working is to choose a broker.
The easiest option is to install the official Mosquitto Broker add-on. You can choose to set up and configure this add-on automatically when you set up the MQTT integration. Home Assistant will automatically generate and assign a safe username and password, and no further attention is required. This also works if you have already set up this add-on yourself in advance.
You can set up additional logins for your MQTT devices and services using the [Mosquitto add-on configuration](https://my.home-assistant.io/create-link/?redirect=supervisor_addon&addon=core_mosquitto).
{% important %}
When MQTT is set up with the official Mosquitto MQTT broker add-on, the broker's credentials are generated and kept secret. If the official Mosquitto MQTT broker needs to be re-installed, make sure you save a copy of the add-on user options, like the additional logins. After re-installing the add-on, the MQTT integration will automatically update the new password for the re-installed broker. It will then reconnect automatically.
{% endimportant %}
Alternatively, you can use a different MQTT broker that you configure yourself, ensuring it is compatible with Home Assistant.
## Setting up a broker
While public MQTT brokers are available, the easiest and most private option is running your own.
@ -584,6 +593,7 @@ support_url:
'name': 'name',
'mf': 'manufacturer',
'mdl': 'model',
'mdl_id': 'model_id',
'hw': 'hw_version',
'sw': 'sw_version',
'sa': 'suggested_area',
@ -820,7 +830,8 @@ Setting up a sensor with multiple measurement values requires multiple consecuti
],
"name":"Bedroom",
"manufacturer": "Example sensors Ltd.",
"model": "K9",
"model": "Example Sensor",
"model_id": "K9",
"serial_number": "12AE3010545",
"hw_version": "1.01a",
"sw_version": "2024.1.0",
@ -955,6 +966,7 @@ Setting up a [light that takes JSON payloads](/integrations/light.mqtt/#json-sch
"name": "Kitchen",
"mf": "Bla electronics",
"mdl": "xya",
"mdl_id": "ABC123",
"sw": "1.0",
"sn": "ea334450945afc",
"hw": "1.0rev2",
@ -1082,10 +1094,19 @@ The MQTT integration will register the `mqtt.publish` action, which allows publi
| ---------------------- | -------- | ------------------------------------------------------------ |
| `topic` | no | Topic to publish payload to. |
| `payload` | no | Payload to publish. |
| `evaluate_payload` | yes | If a `bytes` literal in `payload` should be evaluated to publish raw data. (default: false)|
| `qos` | yes | Quality of Service to use. (default: 0) |
| `retain` | yes | If message should have the retain flag set. (default: false) |
### Publish action data examples
{% note %}
When `payload` is rendered from [template](/docs/configuration/templating/#using-templates-with-the-mqtt-integration) in a YAML script or automation, and the template renders to a `bytes` literal, the outgoing MQTT payload will only be sent as `raw` data, if the `evaluate_payload` option flag is set to `true`.
{% endnote %}
{% important %}
You must include either `topic` or `topic_template`, but not both. If providing a payload, you need to include either `payload` or `payload_template`, but not both.
{% endimportant %}
```yaml
topic: homeassistant/light/1/command
@ -1143,7 +1164,8 @@ data:
"device": {
"identifiers": "Acurite-986-1R-51778",
"name": "Bathroom",
"model": "Acurite-986",
"model": "Acurite",
"model_id": "986",
"manufacturer": "rtl_433" }
}
```

54
source/_integrations/nest.markdown
View File

@ -5,6 +5,7 @@ ha_category:
- Camera
- Climate
- Doorbell
- Event
- Hub
- Media source
- Sensor
@ -20,6 +21,7 @@ ha_platforms:
- camera
- climate
- diagnostics
- event
- sensor
ha_integration_type: integration
---
@ -31,6 +33,7 @@ There is currently support for the following device types within Home Assistant:
- [Climate](#climate)
- [Sensor](#sensor)
- [Camera](#camera)
- [Event](#event)
Cameras and doorbells use [Automation and device triggers](#automation-and-device-triggers) for events and a [media source](#media-source) for capturing media images on supported devices. Other device types like Smoke and CO Alarms or Security systems are not currently supported by the SDM API.
@ -260,6 +263,8 @@ Home Assistant supports all SDM API features. However, every Camera or Doorbell
- **RTSP**: These devices have an HLS stream served by the Home Assistant Core. These cameras support server-side `camera` actions like stream recording or image preview. See [Low Latency HLS](/integrations/stream#ll-hls) as a great option to enable to reduce stream latency.
- **WebRTC**: These devices support direct browser to camera communication and a super low latency stream. A [Picture Glance Card](/dashboards/picture-glance/) can show the live stream in the grid with the *Camera View* set to `live` (not recommended for battery-powered cameras). `camera` actions like stream recording are *not supported*.
Given a camera named `Front Yard`, then the camera is created with a name such as `camera.front_yard`.
{% note %}
This feature is enabled by the following permissions:
@ -269,10 +274,10 @@ This feature is enabled by the following permissions:
{% endnote %}
All cameras also expose event entities for automation. Some camera models also
support capturing media (snapshots or clips) through device triggers. The table below summarizes the [supported SDM API features](https://developers.google.com/nest/device-access/supported-devices) for each device.
All cameras have motion and person triggers, however only some support capturing snapshots for events. The table below summarizes the [Supported SDM API features](https://developers.google.com/nest/device-access/supported-devices) for each device.
| Device | Live Stream | Triggers / Events | Media Source<br> for Triggers / Events |
| Device | Live stream | Event entities / triggers | Media source<br> for triggers |
| -------------------------------------------------------------------------------- | :---------------: | :--------------------------------: | :------------------------------------: |
| Nest Cam (indoor, wired)<br>Nest Cam (outdoor, battery) | WebRTC | Motion<br>Person | N/A |
| Nest Cam Indoor<br>Nest Cam IQ Indoor<br>Nest Cam IQ Outdoor<br>Nest Cam Outdoor | RTSP<br>Recording | Motion<br>Person<br>Sound | Snapshot (jpg) |
@ -282,13 +287,26 @@ All cameras have motion and person triggers, however only some support capturing
| Nest Doorbell (wired, 2nd gen) | WebRTC | Motion<br>Person<br>Chime | Clip Preview (mp4, gif) |
| Nest Hub Max | RTSP<br>Recording | Motion<br>Person<br>Sound<br> | Snapshot (jpg) |
Given a camera named `Front Yard` then the camera is created with a name such as `camera.front_yard`.
## Event
## Automation and device triggers
All doorbells and cameras support event entities. See the [Event](https://www.home-assistant.io/integrations/event/) integration documentation for more about how to use event entities in automations.
There are two classes of event entities that are available based on the above camera features:
- `motion` for cameras that support any of the event types `camera_motion`, `camera_person`, or `camera_sound`
- `doorbell` for all cameras that are doorbells and support `doorbell_chime` events
Nest event entities are updated immediately when an event message is received
without waiting for any media to be fetched. See Device Triggers for media support.
## Device Triggers
The Nest integration provides [device triggers](/docs/automation/trigger/#device-triggers) to enable automation in Home Assistant. You should review the [Automating Home Assistant](/getting-started/automation/) getting started guide on automations or the [Automation](/docs/automation/) documentation for full details.
Device triggers will wait to fire after any media associated with the event is downloaded. Use an
event entity for immediate notifications without media.
{% my automations badge %}
![Screenshot Device Triggers](/images/integrations/nest/device_triggers.png)
@ -305,13 +323,18 @@ This is an example of what the `nest_event` payload looks like for a Device Trig
"type": "doorbell_chime",
"timestamp": "2022-01-26T04:56:54.031000+00:00",
"nest_event_id": "EXAMPLE_EVENT_ID",
"attachment": {
"image": "/api/nest/event_media/DEVICE_ID/EVENT_ID/thumbnail",
"video": "/api/nest/event_media/DEVICE_ID/EVENT_ID",
}
"zones": ["Zone 1"],
},
}
```
- `device_id`: The Home Assistant device identifier for the camera
- `nest_event_id`: is an opaque identifier that can be used with the Media Source Attachments described below for supported cameras.
- `nest_event_id`: is an opaque identifier that identifies the event.
- `attachment`: May be present if the device supports snapshots or clips and depends on the device's capabilities. This is a URL where media can be fetched from the media source.
- `zones`: Zones triggering the event if available. Zones are configured in the Google Home App, though not supported by all cameras. Events in the area outside of a named zone will be an empty zone name.
{% enddetails %}
@ -327,7 +350,7 @@ This feature is enabled by the following permissions:
- *Other permissions and notification settings in the Nest or Google Home apps*.
{% endnote %}
### Google Home App Notification Settings
## Google Home App Notification Settings
The Google Home App Notifications settings control not only which notifications are sent to your phone,
but also what gets published to the Pub/Sub feed.
@ -346,7 +369,6 @@ If you are still not getting notifications, you can read this [troubleshooting g
{% details "Google Home App Notification Settings" %}
| Google Home App Setting | Notes |
| ------------------------ | :---------------------------------------------------------------------: |
| Notifications: Push | Required for any detection event to be published |
@ -362,7 +384,7 @@ If you are still not getting notifications, you can read this [troubleshooting g
The Nest [media source](/integrations/media_source) platform allows you to browse clips for recent camera events. Home Assistant is not intended to be a Network Video Recorder (NVR) platform, however, basic support for capturing recent events is supported.
The table above describes which devices support event image snapshots or 10-frame mp4 video clips for recent events.
The table above describes which devices support image snapshots or 10-frame mp4 video clips.
### Media Attachments
@ -372,7 +394,7 @@ The Media Source APIs can be used in [Companion App Attachments](https://compani
- `/api/nest/event_media/DEVICE_ID/EVENT_ID/thumbnail`: A thumbnail preview of the media, which supports image snapshots (jpg) or clip previews (gif) depending on the camera type.
You can use the event payload fields `device_id` and `event_id` in an [automation](/getting-started/automation/) to send a notification from an [actions](/getting-started/automation-action/) as shown in the examples below.
You can use the Nest Device Trigger payload fields `attachment.image` or `attachment.video`in an [automation](/getting-started/automation/) to send a notification from an [actions](/getting-started/automation-action/) as shown in the examples below.
{% details "Example Action: Clip Preview (mp4) attachment for iOS" %}
@ -386,10 +408,8 @@ data:
message: Doorbell Pressed
title: Someone pressed the doorbell
data:
image: >-
/api/nest/event_media/{{ trigger.event.data.device_id }}/{{ trigger.event.data.nest_event_id }}/thumbnail
video: >-
/api/nest/event_media/{{ trigger.event.data.device_id }}/{{ trigger.event.data.nest_event_id }}
image: {{ trigger.event.data.attachment.image }}
video: {{ trigger.event.data.attachment.video }}
mode: single
```
@ -409,8 +429,7 @@ data:
message: Doorbell Pressed
title: Someone pressed the doorbell
data:
image: >-
/api/nest/event_media/{{ trigger.event.data.device_id }}/{{ trigger.event.data.nest_event_id }}/thumbnail
image: {{ trigger.event.data.attachment.image }}
```
{% endraw %}
@ -429,8 +448,7 @@ data:
message: Doorbell Pressed
title: Someone pressed the doorbell
data:
image: >-
/api/nest/event_media/{{ trigger.event.data.device_id }}/{{ trigger.event.data.nest_event_id }}/thumbnail
image: {{ trigger.event.data.attachment.image }}
```
{% endraw %}

46
source/_integrations/nice_go.markdown Normal file
View File

@ -0,0 +1,46 @@
---
title: Nice G.O.
description: Control Nice G.O. garage doors
ha_release: '2024.9'
ha_category:
- Cover
- Event
- Light
- Switch
ha_iot_class: Cloud Push
ha_config_flow: true
ha_codeowners:
- '@IceBotYT'
ha_domain: nice_go
ha_platforms:
- cover
- diagnostics
- event
- light
- switch
ha_integration_type: integration
---
The **Nice G.O.** {% term integration %} lets you control Nice G.O. garage doors through Home Assistant. Device names in Home Assistant are generated based on the names defined in your Nice G.O. mobile app.
## Prerequisites
Make sure you have a working account with the Nice G.O. app and have your email and password ready.
{% include integrations/config_flow.md %}
## Cover
Garage doors linked to your Nice G.O. account will appear as covers.
## Event
The barrier obstructed event entity will be triggered whenever the barrier gets obstructed. This could be triggered by anything that results in the closure being unsuccessful. This may include beam block during closure, beam block before closure, and an object in the way.
## Light
Lights on your garage door will appear as lights.
## Switch
A switch for turning vacation mode on and off will be made available for each device. Vacation mode prevents the operation of the door from physical control points such as a wall station, wireless keypad, remote control, or HomeLink. It can still be controlled from Home Assistant.

4
source/_integrations/notify.mqtt.markdown
View File

@ -93,6 +93,10 @@ device:
description: The model of the device.
required: false
type: string
model_id:
description: The model identifier of the device.
required: false
type: string
name:
description: The name of the device.
required: false

4
source/_integrations/number.mqtt.markdown
View File

@ -87,6 +87,10 @@ device:
description: The model of the device.
required: false
type: string
model_id:
description: The model identifier of the device.
required: false
type: string
name:
description: The name of the device.
required: false

2
source/_integrations/ollama.markdown
View File

@ -45,6 +45,8 @@ Instructions:
Control Home Assistant:
description: If the model is allowed to interact with Home Assistant. It can only control or provide information about entities that are [exposed](/voice_control/voice_remote_expose_devices/) to it. This feature is considered experimental and see [Controlling Home Assistant](#controlling-home-assistant) below for details on model limitations.
Context window size:
description: "The context window size is the number of tokens the model can take as input. Home Assistant defaults to 8k, which is larger than the default value in Ollama Server (2k), and you may adjust it based on the maximum context size of the specific model used. A larger value will better support larger homes with more entities, and smaller values may lower Ollama server RAM usage."
Max history messages:
description: Maximum number of messages to keep for each conversation (0 = no limit). Limiting this value will cause older messages in a conversation to be dropped.

1
source/_integrations/opower.markdown
View File

@ -41,6 +41,7 @@ More than 175 utilities use Opower. Currently only the following utilities are s
- PECO Energy Company (PECO)
- Potomac Electric Power Company (Pepco)
- Mercury NZ Limited
- National Grid NY Upstate
- Pacific Gas & Electric (PG&E)
- Portland General Electric (PGE)
- Puget Sound Energy (PSE)

2
source/_integrations/prometheus.markdown
View File

@ -209,4 +209,4 @@ For example:
Metrics are exported only for the following domains:
`automation`, `binary_sensor`, `climate`, `cover`, `counter`, `device_tracker`, `fan`, `humidifier`, `input_boolean`, `input_number`, `light`, `lock`, `number`, `person`, `sensor`, `update`, `switch`
`alarm_control_panel`, `automation`, `binary_sensor`, `climate`, `cover`, `counter`, `device_tracker`, `fan`, `humidifier`, `input_boolean`, `input_number`, `light`, `lock`, `number`, `person`, `sensor`, `switch`, `update`

9
source/_integrations/reolink.markdown
View File

@ -178,6 +178,15 @@ Depending on the supported features of the camera, select entities are added for
**Play quick reply messages**/**Auto quick reply messages** can be recorded in the Reolink phone app where a name is also supplied. New or updated quick reply messages will be loaded into Home Assistant at the start of the integration. When adding new quick reply messages, please restart the Reolink integration.
### Action reolink.play_chime
To play a ringtone on a Reolink chime, the `reolink.play_chime` action can be used.
| Data attribute | Optional | Description |
| ---------------------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------- |
| `device_id` | no | List of device ids of the Reolink Chimes to control. For example, `- 12a34b56c7d8ef9ghijklm0n1op2345q`. |
| `ringtone` | no | The ringtone to play. For example `operetta`. |
## Siren entities
If the camera supports a siren, a siren entity will be created.

1
source/_integrations/russound_rio.markdown
View File

@ -6,6 +6,7 @@ ha_category:
ha_release: 0.49
ha_iot_class: Local Push
ha_domain: russound_rio
ha_quality_scale: silver
ha_platforms:
- media_player
ha_codeowners:

4
source/_integrations/scene.mqtt.markdown
View File

@ -91,6 +91,10 @@ device:
description: The model of the device.
required: false
type: string
model_id:
description: The model identifier of the device.
required: false
type: string
name:
description: The name of the device.
required: false

4
source/_integrations/select.mqtt.markdown
View File

@ -99,6 +99,10 @@ device:
description: The model of the device.
required: false
type: string
model_id:
description: The model identifier of the device.
required: false
type: string
name:
description: The name of the device.
required: false

8
source/_integrations/sensor.mqtt.markdown
View File

@ -88,6 +88,10 @@ device:
description: The model of the device.
required: false
type: string
model_id:
description: The model identifier of the device.
required: false
type: string
name:
description: The name of the device.
required: false
@ -161,6 +165,10 @@ object_id:
description: Used instead of `name` for automatic generation of `entity_id`
required: false
type: string
options:
description: List of allowed sensor state value. An empty list is not allowed. The sensor's `device_class` should be set to `enum`. Cannot be used together with `state_class` or `unit_of_measurement`.
required: false
type: list
payload_available:
description: The payload that represents the available state.
required: false

2
source/_integrations/shelly.markdown
View File

@ -73,7 +73,7 @@ The list below will help you diagnose and fix the problem:
## Shelly device configuration (generation 2 and 3)
Generation 2 and 3 devices use the `RPC` protocol to communicate with the integration. **Battery operated devices** (even if USB connected) need manual outbound WebSocket configuration, Navigate to the local IP address of your Shelly device, **Settings** >> **Connectivity** >> **Outbound WebSocket** and check the box **Enable Outbound WebSocket**, under server enter the following address:
Generation 2 and 3 devices use the `RPC` protocol to communicate with the integration. **Battery-operated devices** (even if USB connected) may need manual outbound WebSocket configuration if Home Assistant cannot correctly determine your instance's internal URL or the outbound WebSocket was previously configured for a different Home Assistant instance. In this case, navigate to the local IP address of your Shelly device, **Settings** >> **Connectivity** >> **Outbound WebSocket** and check the box **Enable Outbound WebSocket**, under server enter the following address:
`ws://` + `Home_Assistant_local_ip_address:Port` + `/api/shelly/ws` (for example: `ws://192.168.1.100:8123/api/shelly/ws`), click **Apply** to save the settings.
In case your installation is set up to use SSL encryption (HTTP**S** with certificate), an additional `s` needs to be added to the WebSocket protocol, too, so that it reads `wss://` (for example: `wss://192.168.1.100:8123/api/shelly/ws`).

3
source/_integrations/simplefin.markdown
View File

@ -32,5 +32,6 @@ Each `account` will be set up as a device in Home Assistant, and it will contain
|Sensor|Description|
|-------|---------------|
|Balance|Account balance|
|Age| This sensor shows when the data was retrieved by the SimpleFin API |
|Balance|Account balance|
|Problem| Binary sensor that indicates whether the account sync may have a problem |

4
source/_integrations/siren.mqtt.markdown
View File

@ -110,6 +110,10 @@ device:
description: The model of the device.
required: false
type: string
model_id:
description: The model identifier of the device.
required: false
type: string
name:
description: The name of the device.
required: false

47
source/_integrations/smlight.markdown Normal file
View File

@ -0,0 +1,47 @@
---
title: SMLIGHT SLZB
description: The SMLIGHT SLZB integration allows users to monitor and manage their SMLIGHT SLZB-06x devices from directly within Home Assistant.
ha_category:
- Sensor
ha_release: 2024.9
ha_iot_class: Local Polling
ha_config_flow: true
ha_domain: smlight
ha_zeroconf: true
ha_platforms:
- sensor
ha_codeowners:
- '@tl-sl'
ha_integration_type: device
---
The [SMLIGHT](https://smlight.tech) SLZB-06x Ethernet Zigbee coordinators
provide a convenient way to add Zigbee to your smart home setup.
The **SMLIGHT SLZB** {% term integration %} allows users to monitor and manage their SLZB-06x devices
directly from within Home Assistant and to directly access many of the
features found in the SMLIGHT web UI. You can also use these in your automations.
## Prerequisites
You need a supported SLZB-06 adapter.
This integration has been tested with the following devices:
- [SLZB-06](https://smlight.tech/product/slzb-06)
- [SLZB-06M](https://smlight.tech/product/slzb-06m)
- [SLZB-06p7](https://smlight.tech/product/slzb-06p7)
- [SLZB-06p10](https://smlight.tech/product/slzb-06p10/)
{% include integrations/config_flow.md %}
## Integration entities
The following sensors will be created:
- **Core Temperature** - Temperature of core ESP32
- **Zigbee Temperature** - Temperature of Zigbee CC2652 or EFR32 chip
- **Core Uptime** - Uptime of Core device
- **Zigbee Uptime** - Uptime of Zigbee connection to ZHA/Z2M
- **RAM Usage** - Monitor RAM Usage
- **FS Usage** - Monitor filesystem usage

41
source/_integrations/sonos.markdown
View File

@ -342,6 +342,47 @@ Force start playing the queue, allows switching from another stream (such as rad
| `entity_id` | yes | String or list of `entity_id`s that will start playing. It must be the coordinator if targeting a group.
| `queue_position` | yes | Position of the song in the queue to start playing from, starts at 0.
### Action `sonos.get_queue`
Returns the media_players queue.
| Data attribute | Optional | Description |
| ---------------------- | -------- | ----------- |
| `entity_id` | no | media_player entity id. |
This example script does the following: get the queue, loop through in reverse order, and remove media containing the words "holiday".
{% raw %}
```yaml
- action: sonos.get_queue
target:
entity_id: media_player.living_room
response_variable: queue
- variables:
queue_len: '{{ queue["media_player.living_room"] | length }}'
- repeat:
sequence:
- variables:
title: '{{ queue["media_player.living_room"][queue_len - repeat.index]["media_title"].lower() }}'
album: '{{ queue["media_player.living_room"][queue_len - repeat.index]["media_album_name"].lower() }}'
position: '{{ queue_len - repeat.index }}'
- if:
- '{{ "holiday" in title or "holiday" in album }}'
then:
- action: sonos.remove_from_queue
target:
entity_id: media_player.living_room
data:
queue_position: '{{position}}'
until:
- condition: template
value_template: '{{queue_len == repeat.index}}'
```
{% endraw %}
### Action `sonos.remove_from_queue`
Removes an item from the queue.

17
source/_integrations/swiss_public_transport.markdown
View File

@ -25,6 +25,21 @@ The [Stationboard](https://transport.opendata.ch/examples/stationboard.html) web
The public timetables are coming from [Swiss public transport](https://transport.opendata.ch/).
### Defining a custom polling interval
## Actions
The Swiss public transport integration has the following action:
- `swiss_public_transport.fetch_connections`
### Action `swiss_public_transport.fetch_connections`
Fetch the connections for a specific instance.
| Data attribute | Optional | Description |
|------------------------|----------|----------------------------------------------------------|
| `config_entry_id` | No | The ID of the Swiss public transport config entry to get data from. For example, in YAML: `config_entry_id: zurich_geneva` or in UI `Instance: zurich_geneva`)|
| `limit` | Yes | The number of connections to fetch. (default: 3, range: [1,15])|
## Defining a custom polling interval
{% include common-tasks/define_custom_polling.md %}

4
source/_integrations/switch.mqtt.markdown
View File

@ -101,6 +101,10 @@ device:
description: The model of the device.
required: false
type: string
model_id:
description: The model identifier of the device.
required: false
type: string
name:
description: The name of the device.
required: false

4
source/_integrations/tag.mqtt.markdown
View File

@ -53,6 +53,10 @@ device:
description: The model of the device.
required: false
type: string
model_id:
description: The model identifier of the device.
required: false
type: string
name:
description: The name of the device.
required: false

1
source/_integrations/technove.markdown
View File

@ -64,3 +64,4 @@ The {% term integration %} adds the following switch:
| Name | Description |
| ---------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Auto-charge mode | When enabled, vehicles will start charging automatically when plugged in. When turned off, charging will need to be manually started each time a vehicle is plugged in. Note: Disabling auto-charge mode does not interrupt an ongoing charging session. |
| Charging enabled | When enabled, vehicles will be able to charge. Disable it to stop a vehicle from charging. Note: This switch can only be used when auto-charge mode is disabled. |

18
source/_integrations/template.markdown
View File

@ -41,7 +41,9 @@ related:
The `template` integration allows creating entities which derive their values from other data. This is done by specifying [templates](/docs/configuration/templating/) for properties of an entity, like the name or the state.
Sensors, binary (on/off) sensors, buttons, images, numbers and selects are covered on this page. For other types, please see the specific pages:
Sensors, binary (on/off) sensors, buttons, images, numbers, and selects are covered on this page. They can be configured using [UI](#configuration) or [YAML](#yaml-configuration) file.
For other types, please see the specific pages:
- [Alarm control panel](/integrations/alarm_control_panel.template/)
- [Cover](/integrations/cover.template/)
@ -52,16 +54,6 @@ Sensors, binary (on/off) sensors, buttons, images, numbers and selects are cover
- [Vacuum](/integrations/vacuum.template/)
- [Weather](/integrations/weather.template/)
Sensor, binary sensor, button, image and select can be configured using [UI](#ui-configuration) or [YAML](#yaml-configuration) file.
Number template entities are defined in your YAML configuration files under the `template:` key and cannot be configured via the UI. You can define multiple configuration blocks as a list. Each block defines sensor/binary sensor/number/select entities and can contain an optional update trigger.
_For old sensor/binary sensor configuration format, [see below](#legacy-binary-sensor-configuration-format)._
## UI configuration
Sensor template, binary sensor template, button template, image template and select template can be configured using the user interface at **{% my helpers title="Settings > Devices & services > Helpers" %}**. Select the **+ Add helper** button and then select the **{% my config_flow_start domain=page.ha_domain title=page.title %}** helper.
{% include integrations/config_flow.md %}
{% important %}
@ -76,6 +68,10 @@ If you need more specific features for your use case, the manual [YAML-configura
## YAML configuration
Entities (sensors, binary sensors, buttons, images, numbers, and selections) are defined in your YAML configuration files under the `template:` key. You can define multiple configuration blocks as a list. Each block defines sensor/binary sensor/number/select entities and can contain an optional update trigger.
_For old sensor/binary sensor configuration format, [see below](#legacy-binary-sensor-configuration-format)._
### State-based template binary sensors, buttons, images, numbers, selects and sensors
Template entities will by default update as soon as any of the referenced data in the template updates.

9
source/_integrations/tesla_fleet.markdown
View File

@ -17,6 +17,7 @@ ha_platforms:
- device_tracker
- diagnostics
- sensor
ha_quality_scale: gold
ha_integration_type: integration
---
@ -26,6 +27,14 @@ The Tesla Fleet API {% term integration %} exposes various sensors from Tesla ve
You must have a [Tesla](https://tesla.com) account and a Tesla vehicle, PowerWall, Solar, or Wall Connector, and must not have disabled the [My Home Assistant](/integrations/my/) integration.
{% details "Use a custom OAuth application" %}
The integration has a built-in OAuth application that will be suitable for most users. However, you can [create your own application](https://developer.tesla.com/dashboard) for the Tesla Fleet API and configure it as an [application credential](https://my.home-assistant.io/redirect/application_credentials). When creating the application, you must set `https://my.home-assistant.io/redirect/oauth` as the redirect URL.
You will be prompted to pick your custom application credential when creating a Tesla Fleet config entry.
{% enddetails %}
{% include integrations/config_flow.md %}
## Scopes

4
source/_integrations/text.mqtt.markdown
View File

@ -95,6 +95,10 @@ device:
description: The model of the device.
required: false
type: string
model_id:
description: The model identifier of the device.
required: false
type: string
name:
description: The name of the device.
required: false

2
source/_integrations/todoist.markdown
View File

@ -190,6 +190,8 @@ Here are two example JSON payloads resulting in the same task:
- **project** (*Optional*): The project to put the task in.
- **section** (*Optional*): The section within the project to add the task to.
- **labels** (*Optional*): Any labels you want to add to the task, separated by commas.
- **assignee** (*Optional*): A member's username of a shared project to assign this task to. You find the username formatted as bold text in the collaborator menu of a shared project.

29
source/_integrations/touchline_sl.markdown Normal file
View File

@ -0,0 +1,29 @@
---
title: Roth Touchline SL
description: Instructions on how to integrate Roth Touchline SL within Home Assistant.
ha_category:
- Climate
ha_release: 2024.9
ha_iot_class: Cloud Polling
ha_domain: touchline_sl
ha_platforms:
- climate
ha_integration_type: integration
---
The **Roth Touchline SL** climate integration enables you to control [Roth Touchline SL](https://www.roth-uk.com/products/control-systems/roth-touchliner-sl-wireless-system) underfloor heating systems.
## Prerequisites
You must have an account registered with the [Roth Touchline SL dashboard](https://roth-touchlinesl.com/login).
{% include integrations/config_flow.md %}
## Entities
The integration will present each Roth Touchline SL zone as a climate entity, which can:
- Display the current temperature
- Display the current humidity
- Set a target temperature
- Assign to a configured "Global Schedule" using Home Assistant climate entity presets.

4
source/_integrations/update.mqtt.markdown
View File

@ -92,6 +92,10 @@ device:
description: The model of the device.
required: false
type: string
model_id:
description: The model identifier of the device.
required: false
type: string
name:
description: The name of the device.
required: false

4
source/_integrations/vacuum.mqtt.markdown
View File

@ -84,6 +84,10 @@ device:
description: The model of the device.
required: false
type: string
model_id:
description: The model identifier of the device.
required: false
type: string
name:
description: The name of the device.
required: false

4
source/_integrations/valve.mqtt.markdown
View File

@ -130,6 +130,10 @@ device:
description: The model of the device.
required: false
type: string
model_id:
description: The model identifier of the device.
required: false
type: string
name:
description: The name of the device.
required: false

9
source/_integrations/vesync.markdown
View File

@ -62,6 +62,7 @@ This {% term integration %} supports devices controllable by the VeSync App. Th
- Core 300S: Smart True HEPA Air Purifier
- Core 400S: Smart True HEPA Air Purifier
- Core 600S: Smart True HEPA Air Purifier
- EverestAir: Smart Air Purifier
- Vital 100S Smart True HEPA Air Purifier (LAP-V102S-WUS)
- Vital 200S Smart True HEPA Air Purifier (LAP-V201S-WUS)
- LEVOIT Smart Wifi Air Purifier (LV-PUR131S)
@ -97,11 +98,11 @@ itself. Note that prior versions of the {% term integration %} exposed these as
## Fan & air quality sensors
All VeSync air purifiers expose the remaining filter lifetime, and some also expose air quality measurements.
| Sensor | Description | Example |
| --------------------------------------- | ------------------------------------------------------------------ | ------- |
| `filter_life` | Remaining percentage of the filter. (LV-PUR131S, Core200S/300s/400s/600s) | 142 |
| Sensor | Description | Example |
| ----------------------- | -------------------------------------------------------------------------------------- | --------- |
| `filter_life` | Remaining percentage of the filter. (LV-PUR131S, Core200S/300s/400s/600s/EverestAir) | 142 |
| `air_quality` | The current air quality reading. (LV-PUR131S, Core300s/400s/600s) | excellent |
| `pm2_5` | The current air quality reading. (Core300s/400s/600s) | 8 |
| `pm2_5` | The current air quality reading. (Core300s/400s/600s/EverestAir) | 8 |
## Fan exposed attributes

4
source/_integrations/water_heater.mqtt.markdown
View File

@ -96,6 +96,10 @@ device:
description: 'The model of the device.'
required: false
type: string
model_id:
description: The model identifier of the device.
required: false
type: string
name:
description: 'The name of the device.'
required: false

156
source/_integrations/yale.markdown Normal file
View File

@ -0,0 +1,156 @@
---
title: Yale
description: Instructions on how to integrate your Yale devices into Home Assistant.
ha_category:
- Binary sensor
- Button
- Camera
- Doorbell
- Event
- Lock
- Sensor
ha_release: 2024.9
ha_iot_class: Cloud Push
ha_config_flow: true
ha_codeowners:
- '@bdraco'
ha_domain: yale
ha_dhcp: true
ha_platforms:
- binary_sensor
- button
- camera
- diagnostics
- event
- lock
- sensor
ha_integration_type: integration
---
The **Yale** integration allows you to integrate your [Yale](https://www.assaabloy.com/vn/en/solutions/products/yale) devices in Home Assistant.
The login credentials used to authenticate the integration are the same as the ones used in the Yale Home app.
{% include integrations/config_flow.md %}
## Known working devices
| Device | Requires [Connect Bridge](https://www.yalehome.com/vn/en/products/yale-smart-door-lock/smart-accessories/yale-connect-wi-fi-bridge) or Doorbell |
| --------------------------------- | ------------------------------------|
| Yale Assure Lock | yes |
| Yale Conexis L1 | yes |
| Yale Conexis L2 | yes |
| Yale Doorman L3 | yes |
| Yale Linus | yes |
| Yale Smart Safe | yes |
Other devices not listed above have not been tested and may not function as expected.
There is currently support for the following device types within Home Assistant:
- Doorbell
- Binary sensor
- Button
- Sensor
- Camera
- Lock
{% note %}
Most devices will need either a Yale Connect Bridge or a Doorbell to connect to Home Assistant.
{% endnote %}
## Push updates not available for some entities
While most entities can be updated via the push API, Yale/Yale does not offer a push API for some data, which means these entities will update slower:
- Doorbell ding sensor (Doorman models only)
- Lock Battery sensor
- Lock Operation sensor
## Binary sensor
If you have a Yale Doorbell, once you have enabled the Yale integration, you should see the following sensors:
- Doorbell ding sensor
- Doorbell motion sensor
- Doorbell online sensor
If you have a Yale Smart Lock with DoorSense, once you have enabled the Yale integration, you should see the following sensors:
- Door sensor
## Button
Buttons are created to wake locks from a deep sleep. If your lock is not reporting a status, it may be in a deep sleep, and the button can be used to wake it. Locks are not automatically woken from deep sleep to preserve battery life.
## Event
If you have a Yale doorbell or lock that has a built-in doorbell, once you have enabled the Yale integration, you should see the following event entities:
- Doorbell
- Motion
Not all models include motion sensors and support for locks with built-in doorbells is limited to Yale Doorman models type 7 and 10.
## Camera
The `yale` camera platform allows you to view the latest camera image (triggered by motion) by your [Yale](https://yale.com/) device in Home Assistant.
## Sensor
If you have a Yale Doorbell with a battery, once you have enabled the Yale integration, you should see the following sensors:
- Doorbell Battery
If you have a Yale Smart Lock, once you have enabled the Yale integration, you should see the following sensors:
- Lock Battery
- Lock Operation
If you have a Yale Keypad, once you have enabled the Yale integration, you should see the following sensors:
- Keypad Battery
## Integration with Yale Access Bluetooth
Following Assa Abloy, Yale's parent company, purchasing Yale in 2017, most newer devices use the Yale Home branding.
The [Yale Access Bluetooth](/integrations/yalexs_ble) integration provides local control over Bluetooth of many Yale Home locks that use the same system.
For locks that support the Yale Access system, the Yale integration can keep your offline access keys up to date to ensure you can operate your lock over Bluetooth. The following requirements must be met for the offline key updates to work:
- The Yale integration must support the lock.
- The [Yale Access Bluetooth integration](/integrations/yalexs_ble) must support the lock.
- The Bluetooth integration must be active and functional.
- The lock must be discoverable by the [Yale Access Bluetooth integration](/integrations/yalexs_ble).
- The account logged in with the Yale integration must have the offline keys.
### Troubleshooting offline key updates
- If you do not know which account has the offline keys, configure Yale integration with each different Owner account until you find the one that holds the keys. You may need to make a new owner account and grant the account access to your lock to force the keys to synchronize with the cloud service.
- Ensure the lock is in range and discoverable by the [Yale Access Bluetooth integration](/integrations/yalexs_ble).
## Presence detection with lock operation
Using the lock operation sensors, you can detect when a user operates a lock and is physically present (not remote). The below automation example (added to `automations.yaml`) will trigger when the user named “John Doe” in Yale locks or unlocks the door either from the keypad (if present), via Bluetooth from their phone, or by auto-unlock. The state of the sensor will be the name of the party operating the lock as returned by Yale.
{% raw %}
```yaml
- id: "1583706446906"
alias: "joe_doe_front_door_operate"
description: John Doe locks or unlocks the Front Door
trigger:
- entity_id: sensor.front_door_operator
platform: state
to: John Doe
condition:
- condition: template
value_template: "{{ not state_attr('sensor.front_door_operator', 'remote') }}"
action:
- data: {}
entity_id: camera.inside
service: camera.turn_off
```
{% endraw %}

6
source/_integrations/yale_home.markdown
View File

@ -1,6 +1,6 @@
---
title: Yale Home
description: Connect and control your Yale Home devices using the August integration
description: Connect and control your Yale Home devices using the Yale integration
ha_category:
- Binary sensor
- Button
@ -12,8 +12,8 @@ ha_category:
ha_release: 0.64
ha_domain: yale_home
ha_integration_type: virtual
ha_supporting_domain: august
ha_supporting_integration: August
ha_supporting_domain: yale
ha_supporting_integration: Yale
ha_codeowners:
- '@bdraco'
ha_config_flow: true

531
source/_posts/2024-09-04-release-20249.markdown Normal file
View File

@ -0,0 +1,531 @@
---
layout: post
title: "2024.9: Sections go BIG"
description: "Bigger wider sections for big cards, smarter energy monitoring, a new LLM option, Works with Home Assistant Matter devices, and more open source."
date: 2024-09-04 00:00:00
date_formatted: "September 4, 2024"
author: Gordon Cameron
comments: true
categories:
- Release-Notes
- Core
og_image: /images/blog/2024-09/social.jpg
---
<lite-youtube videoid="dSbCzRhbOVA" videotitle="Home Assistant 2024.9 Release Party"></lite-youtube>
Home Assistant 2024.9! 🎉
Many community members based in the northern hemisphere have taken advantage of the nicer weather to take a little time off. Home Assistant releases have continued to grow for some time, and this one might not be as gargantuan in size as previous releases, but it still packs some really cool features and announcements.
This release includes bigger sections, smarter energy monitoring, and a new LLM option. We've added [five](#new-integrations) new integrations, along with [one](#now-available-to-set-up-from-the-ui) existing integration being added to the UI. On top of all that, we've announced a new Works with Home Assistant partner, and the culmination of a project to ensure our project is truly open source.
We hope you've been able to enjoy some time in, and away, from your smart home this month as well.
Enjoy the release!
{% tip %}
Don't forget to [join our release party live stream on YouTube](https://www.youtube.com/watch?v=dSbCzRhbOVA)
4 September 2024, at 20:00 GMT / 12:00 PST / 21:00 CEST!
{% endtip %}
- [Sections go BIG](#sections-go-big)
- [Wider sections](#wider-sections)
- [Full span cards](#full-span-cards)
- [Badges](#badges)
- [Tracking your untracked energy](#tracking-your-untracked-energy)
- [LLM agent options grow](#llm-agent-options-grow)
- [Aqara joins Works with Home Assistant](#aqara-joins-works-with-home-assistant)
- [Open source compliance](#open-source-compliance)
- [Integrations](#integrations)
- [New integrations](#new-integrations)
- [Noteworthy improvements to existing integrations](#noteworthy-improvements-to-existing-integrations)
- [Now available to set up from the UI](#now-available-to-set-up-from-the-ui)
- [Farewell to the following](#farewell-to-the-following)
- [Other noteworthy changes](#other-noteworthy-changes)
- [Need help? Join the community!](#need-help-join-the-community)
- [Backward-incompatible changes](#backward-incompatible-changes)
- [All changes](#all-changes)
## Sections go BIG
In the drive to give our users more customization and organization options for their dashboards, we've added some new options to our Sections view that really lets us take big advantage of [resizable cards](/blog/2024/07/03/release-20247/#resize-the-cards-on-your-dashboard). These powerful customization features can affect the [predictability of where cards or sections will go](/blog/2024/03/04/dashboard-chapter-1/#drag-and-drop-rearrangement-of-cards-and-sections), especially when switching between desktop and mobile views, and we have found it works best with large cards. As always, the choice of how to use it is up to you.
<div style="display: flex;">
<img src="/images/blog/2024-09/sections-before.png" width="50%" alt="Screenshot showing sections that are all 1 section wide, on the right showing a section that is 2 sections wide.">
<img src="/images/blog/2024-09/sections-after.png" width="50%" alt="Screenshots showing a section that is 2 sections wide.">
</div>
### Wider sections
Sections can be expanded to span multiple sections. Now you can, for example, have your security camera feed span two sections or have a massive three-section wide map.
Cards and sections will continue to follow the [Z-Grid rules](/blog/2024/03/04/dashboard-chapter-1/#drag-and-drop-rearrangement-of-cards-and-sections), which can lead to blank spaces if the new wider sections don't fit on a specific part of the screen. If you don't like those blank spaces between sections, you can choose a _dense_ layout. A dense section layout option will attempt to follow the Z-Grid rules, but will fill blank spaces whenever possible. This can affect the order and predictability of your sections, but will maximize screen real estate.
When switching to smaller screens, these larger sections will revert to one section wide (if this causes issues for certain big cards, we would recommend using our device [visibility settings](/blog/2024/06/05/release-20246/#control-visibility-of-cards)).
<img src="/images/blog/2024-09/section-settings.png" alt="Screenshot of the section settings">
### Full span cards
Larger sections mean larger cards. Instead of just stretching out the layout of a card, there is also a new option on cards to have them always use the full width of the section.
### Badges
Talking about dashboards, the newly styled badges we [introduced](/blog/2024/08/07/release-20248/#new-badges-for-your-dashboard) in last release, are now more configurable.
Instead of using display mode, you can decide for yourself what element you want to show. This allows you, for example, to hide the icon of an badge and only show the state of the device you want to show in your badge.
## Tracking your untracked energy
In April, we introduced a [new energy graph for individual devices](/blog/2024/03/06/release-20243/#new-energy-graph-for-individual-devices) in our energy dashboard. This allows you to aggregate all your energy monitoring into one graph, giving you a quick way to see your house's biggest energy-using devices. Big thanks to [@karwosts](https://github.com/karwosts), the original creator of this graph, who has now updated it.
<img src="/images/blog/2024-09/untracked-energy.png" alt="Screenshot of the individual device energy graph">
We can't all have energy tracking for every device, and if you have whole-home energy tracking (like a smart meter or [something more DIY](/home-energy-management)) the updated graph will calculate the difference and show your home's untracked usage. So hop onto your [energy dashboard](https://my.home-assistant.io/redirect/energy/) and start to tackle your phantom energy load.
## LLM agent options grow
When we added the ability to use [Large Language Models (LLMs)](/blog/2024/06/05/release-20246/#dipping-our-toes-in-the-world-of-ai-using-llms) in our Voice Assistant, it began with a limited number of conversation agents. These included the cloud-based [OpenAI](/components/openai_conversation/) and [Google AI](/components/google_generative_ai_conversation/) integrations, along with the locally-run [Ollama](/integrations/ollama/) integration. All three can now control the devices in your home.
[@Shulyaka](https://github.com/Shulyaka) has now added another cloud option with [Anthropic](/integrations/anthropic) - thanks again for giving us another option for experimenting with AI in Home Assistant. Setting it up can be a little different than other conversation agents, so take a look at the [documentation](/integrations/anthropic).
We have updated our [LLM leaderboard](https://github.com/allenporter/home-assistant-datasets/tree/main/reports) to include Anthropic. Both Claude 3 Haiku and Claude 3 Sonnet score very high on our benchmarks and now rank among the top. Based on the results of the benchmark, we have set the cheaper Claude 3 Haiku as the default model for the Anthropic integration.
[@allenporter] added the ability to configure the context window size of the [Ollama](/integrations/ollama) integration. The default size was increased, making it perform 20% better!
## Aqara joins Works with Home Assistant
<img src="/images/blog/2024-09-aqara-wwha/art.jpg" alt="Aqara join Works via Matter with Home Assistant">
We [recently announced](/blog/2024/09/03/aqara-joins-works-with-home-assistant/) that four Aqara devices are joining our [Works with Home Assistant](https://partner.home-assistant.io/) program. What's really exciting is that these are all Matter devices, and Aqara will be the first partner to use our "Works via Matter with Home Assistant" badge, giving some great options to use with Home Assistant's amazing Matter integration.
What's more, this will be the first partner to join since [our recent update to the program](/blog/2024/08/08/works-with-home-assistant-becomes-part-ohf/), meaning device-by-device certification that we tested ourselves. This makes it really easy to see what will give you the best experience in Home Assistant.
## Open source compliance
We have put a lot of work into making sure that Home Assistant is truly open source, from top to bottom. This means ensuring that every library our integrations rely on uses the compliant license. We're now at more than 2,800 integrations, so as you can imagine, this was not a small task. Working with code owners and library developers, we have painstakingly checked that every library is now using an [OSI-approved license](https://opensource.org/license).
This might seem like a small procedural thing, but it is critical to keep integrations and Home Assistant functional far into the future. If you're not aware, libraries are what many device and service integrations rely on to function, by calling in additional protocol specific code that [purposely](https://developers.home-assistant.io/docs/api_lib_index/) sits outside of the Home Assistant project. If an individual or corporation can no longer maintain libraries, a proper open source license allows it to be picked up and continued by others.
## Integrations
Thanks to our community for keeping pace with the new {% term integrations %}
and improvements to existing ones! You're all awesome 🥰
### New integrations
We welcome the following new integrations in this release:
- **[Anthropic Conversation]**, added by [@Shulyaka]<br>
Use AI by [Anthropic], like the [Claude 3.5 Sonnet] as a conversation agent in Home Assistant.
- **[Nice G.O.]**, added by [@IceBotYT]<br>
Integrate with compatible garage door and gate openers from the Nice.
- **[Fujitsu FGLair]**, added by [@crevetor]<br>
Fujitsu HVAC devices that use the Ayla IoT platform (controlled with the FGLair app).
- **[SMLIGHT]**, added by [@tl-sl]<br>
Manage SMLIGHT SLZB-06 adaptors from Home Assistant.
- **[Roth Touchline SL]**, added by [@jnsgruk]<br>
A new integration for the Roth Touchline SL underfloor heating system.
- **[Yale]**, added by [@bdraco]<br>
The Yale Home brand now has its own integration and will no longer be using the [August] integration. If you use a Yale Home device with the August integration, you should migrate to the new Yale integration.
[Anthropic Conversation]: /integrations/anthropic
[Anthropic]: https://anthropic.com/
[Claude 3.5 Sonnet]: https://www.anthropic.com/claude
[Nice G.O.]: /integrations/nice_go
[Fujitsu FGLair]: /integrations/fujitsu_fglair
[SMLIGHT]: /integrations/smlight
[Roth Touchline SL]: /integrations/touchline_sl
[Yale]: /integrations/yale
[August]: /integrations/august
[@Shulyaka]: https://github.com/Shulyaka
[@IceBotYT]: https://github.com/IceBotYT
[@crevetor]: https://github.com/crevetor
[@tl-sl]: https://github.com/tl-sl
[@jnsgruk]: https://github.com/jnsgruk
[@bdraco]: https://github.com/bdraco
This release also has a new virtual integration. Virtual integrations
are stubs that are handled by other (existing) integrations to help with
discoverability. These ones are new:
- **[ArtSound]**, provided by [LinkPlay], added by [@dukeofphilberg]
[@dukeofphilberg]: https://github.com/dukeofphilberg
[ArtSound]: /integrations/artsound
[LinkPlay]: /integrations/linkplay
### Noteworthy improvements to existing integrations
It is not just new {% term integrations %} that have been added; existing
integrations are also being constantly improved. Here are some of the noteworthy
changes to existing integrations:
- The Mosquitto MQTT broker add-on can now be installed and started automatically when you setup [MQTT](/integrations/mqtt). Great work [@jbouwh]!
- In the [UI for KNX that was introduced last release](/blog/2024/08/07/release-20248/#knx-can-now-be-managed-via-the-ui), you can now also add switch and light entities! Thanks [@farmio]!
- [@allenporter] added event entities to the [Nest](integrations/nest) integration.
- [@bdraco] made it easier to add battery operated [Shelly](/integrations/shelly) devices, you no longer have to manually set an outbound WebSocket configuration.
- [MotionBlinds](/integrations/motion_blinds) now has a button for your favorite position. Thanks [@starkillerOG].
- [@joostlek] added the abilitiy to update your [AirGradient](/integrations/airgradient) devices from Home Assistant.
- [@CM000n] added diagnostic binary sensors to the [APsystems](/integrations/apsystems) integration.
- The [Mastodon](/integrations/mastodon) integration now shows information about your account, like how many followers you have. Thanks [@andrew-codechimp]!
[@CM000n]: https://github.com/CM000n
[@andrew-codechimp]: https://github.com/andrew-codechimp
[@joostlek]: https://github.com/joostlek
[@starkillerOG]: https://github.com/starkillerOG
[@cnico]: https://github.com/cnico
[@allenporter]: https://github.com/allenporter
[@jeeftor]: https://github.com/jeeftor
[#123045]: https://github.com/home-assistant/core/pull/123045
[#123434]: https://github.com/home-assistant/core/pull/123434
[#123534]: https://github.com/home-assistant/core/pull/123534
[#123489]: https://github.com/home-assistant/core/pull/123489
[#122514]: https://github.com/home-assistant/core/pull/122514
[#123042]: https://github.com/home-assistant/core/pull/123042
[#122554]: https://github.com/home-assistant/core/pull/122554
[apsystems docs]: /integrations/apsystems/
[mastodon docs]: /integrations/mastodon/
[airgradient docs]: /integrations/airgradient/
[motion_blinds docs]: /integrations/motion_blinds/
[chacon_dio docs]: /integrations/chacon_dio/
[nest docs]: /integrations/nest/
[simplefin docs]: /integrations/simplefin/
### Now available to set up from the UI
While most {% term integrations %} can be set up directly from the Home Assistant
user interface, some were only available using YAML configuration. We keep moving
more integrations to the UI, making them more accessible for everyone
to set up and use.
You can now add a number [template helper] from the UI Thanks [@dougiteixeira]!
[@dougiteixeira]: https://github.com/dougiteixeira
[template helper]: /integrations/template
### Farewell to the following
The following {% term integrations %} are also no longer available as
of this release:
- **Asterisk Call Detail Records** and **Asterisk Voicemail**. Previously
deprecated and now removed. They have been using a deprecated mailbox feature
that is no longer available.
## Need help? Join the community!
Home Assistant has a great community of users who are all more than willing
to help each other out. So, join us!
Our very active [Discord chat server](/join-chat) is an excellent place to be
at, and don't forget to join our amazing [forums](https://community.home-assistant.io/).
Found a bug or issue? Please report it in our [issue tracker](https://github.com/home-assistant/core/issues),
to get it fixed! Or, check [our help page](/help) for guidance for more
places you can go.
Are you more into email? [Sign-up for our Building the Open Home Newsletter](/newsletter)
to get the latest news about features, things happening in our community and
other news about building an Open Home; straight into your inbox.
## Backward-incompatible changes
We do our best to avoid making changes to existing functionality that might
unexpectedly impact your Home Assistant installation. Unfortunately, sometimes,
it is inevitable.
We always make sure to document these changes to make the transition as easy as
possible for you. This release has the following backward-incompatible changes:
{% details "Recorder database upgrade notice" %}
This notice applies only if you use the recorder integration with a MySQL or
PostgreSQL database. If you are using the default SQLite database,
you can ignore it.
Last release included a database upgrade/migration that increases the size of
the number we can store for the identifier fields.
Not all migrations were successful despite being marked as successful. This
release will do the migration again, but will catch unsuccessful migrations.
This can cause the database upgrade to take longer than usual, depending on
the size of your database.
Please be patient and let the upgrade process finish. Do not interrupt the
upgrade process, as this can lead to a corrupted database.
([@emontnemery] - [#123973]) ([documentation](/integrations/recorder))
[@emontnemery]: https://github.com/emontnemery
[#123973]: https://github.com/home-assistant/core/pull/123973
{% enddetails %}
{% details "Asterisk Call Detail Records" %}
Asterisk Call Detail Records has been deprecated in 2024.3.0 and has now been removed.
It was using a deprecated mailbox feature that is no longer available.
([@joostlek] - [#123180])
[#123180]: https://github.com/home-assistant/core/pull/123180
{% enddetails %}
{% details "Asterisk Voicemail" %}
Asterisk Voicemail has been deprecated in 2024.3.0 and has now been removed.
It was using a deprecated mailbox feature that is no longer available.
([@joostlek] - [#123180])
[#123180]: https://github.com/home-assistant/core/pull/123180
{% enddetails %}
{% details "August" %}
If you are using a Yale Home device with the [August] integration, you should migrate to the new [Yale] integration.
Yale Home devices will soon stop working with the August integration.
([@bdraco] - [#124895]) ([august documentation](/integrations/august) - [yale documentation](/integrations/yale))
[#124895]: https://github.com/home-assistant/core/pull/124895
{% enddetails %}
{% details "Ecovacs" %}
The YAML configuration for the Ecovacs integration was removed. The configuration has been moved to the UI in Home Assistant 2024.2.
The YAML configuration was automatically imported and should be removed from your YAML configuration.
[@gjohansson-ST] - [#123605] ([documentation](/integrations/ecovacs))
[@gjohansson-ST]: https://github.com/gjohansson-ST
[#123605]: https://github.com/home-assistant/core/pull/123605
{% enddetails %}
{% details "GPSD" %}
The YAML configuration for the GPSD integration was removed. The configuration has been moved to the UI in Home Assistant 2024.2.
The YAML configuration was automatically imported and should be removed from your YAML configuration.
([@gjohansson-ST] - [#123725]) ([documentation](/integrations/gpsd))
[#123725]: https://github.com/home-assistant/core/pull/123725
{% enddetails %}
{% details "KNX" %}
The KNX Climate preset modes are renamed to match the KNX specifications.
| KNX specifications | Previous | Now |
|---------------------|----------|----------------|
| Auto | none | auto |
| Comfort | comfort | comfort |
| Standby | away | standby |
| Economy | sleep | economy |
| Building protection | eco | building_protection |
[@farmio] - [#123964] ([documentation](/integrations/knx))
[@farmio]: http://gtihub.com/farmio
[#123964]: https://github.com/home-assistant/core/pull/123964
{% enddetails %}
{% details "Logi circle" %}
Logitech stopped accepting applications for access to the Logi Circle API in May 2022, and the Logi Circle integration has now been removed.
[@gjohansson-ST] - [#123727]
[#123727]: https://github.com/home-assistant/core/pull/123727
{% enddetails %}
{% details "Lupusec" %}
The YAML configuration for the Lupusec integration was removed. The configuration has been moved to the UI in Home Assistant 2024.2.
The YAML configuration was automatically imported and should be removed from your YAML configuration.
[@gjohansson-ST] - [#123606] ([documentation](/integrations/lupusec))
[#123606]: https://github.com/home-assistant/core/pull/123606
{% enddetails %}
{% details "Lutron" %}
In Home Assistant 2024.2, fans where converted from a light entity to a fan entity.
The old light entities will no longer work in this release and can be removed.
[@gjohansson-ST] - [#123607] ([documentation](/integrations/lutron))
[#123607]: https://github.com/home-assistant/core/pull/123607
{% enddetails %}
{% details "Mailbox" %}
The Mailbox platform that was previously deprecated has been removed.
[@gjohansson-ST] - [#123741]
[#123741]: https://github.com/home-assistant/core/pull/123741
{% enddetails %}
{% details "MQTT" %}
The schema option was removed from the MQTT vacuum schema in Home Assistant 2024.2. You should remove this from your YAML configuration if set.
Manual configured MQTT vacuum entities will break if the schema option is still configured.
When using MQTT discovery the option will be silently ignored.
[@jbouwh] - [#124722] ([documentation](/integrations/mqtt))
[@jbouwh]: https://github.com/jbouwh
[#124722]: https://github.com/home-assistant/core/pull/124722
{% enddetails %}
{% details "Overkiz" %}
Atlantic CozyTouch Water Heaters will now show the Manual operation mode as Electric.
A binary sensor was added to indicate if the manual mode is activated.
Users that have automations or scripts using these entities together with the Manual mode should update the automations or scripts accordingly.
[@ALERTua] - [#124619] ([documentation](/integrations/overkiz))
[@ALERTua]: https://github.com/ALERTua
[#124619]: https://github.com/home-assistant/core/pull/124619
{% enddetails %}
{% details "Proximity" %}
In 2024.2, [we introduced new sensor entities](/blog/2024/02/07/release-20242/#revamped-proximity-integration)
to the [Proximity](/integrations/proximity) {% term integration %} and therefore deprecated the `proximity` entity.
Now this deprecated `proximity` entity has been removed.
([@mib1185] - [#123158]) ([documentation](/integrations/proximity))
[@mib1185]: https://github.com/mib1185
[#123158]: https://github.com/home-assistant/core/pull/123158
{% enddetails %}
{% details "Sensibo" %}
The previous PM2.5 sensor for Pure devices was incorrectly reporting a PM2.5 value, but it's actually a number representing an AQI level. The sensor will now provide the new states of 'good', 'moderate', and 'bad'.
[@gjohansson-ST] - [#124151] ([documentation](/integrations/sensibo))
[#124151]: https://github.com/home-assistant/core/pull/124151
{% enddetails %}
{% details "Starline" %}
The horn switch has been deprecated since 2024.1 and is now removed.
Instead of a switch a horn button entity was added. Please update your automations accordingly.
([@gjohansson-ST] - [#123608]) ([documentation](/integrations/starline))
[#123608]: https://github.com/home-assistant/core/pull/123608
{% enddetails %}
{% details "System monitor" %}
Removes the deprecated process sensor from the System Monitor integration.
This sensor has been provided as a binary sensor for 6 months, raising a repair issue.
[@gjohansson-ST] - [#123616] ([documentation](/integrations/systemmonitor))
[#123616]: https://github.com/home-assistant/core/pull/123616
{% enddetails %}
{% details "TP-Link Smart Home" %}
The binary sensor for "Update available" will no longer be provided by the TP-Link Smart Home integration.
It will be replaced in a subsequent release with the Update entity but is disabled for now due to stability issues when calling the TP-Link cloud API to check the latest firmware version. This may cause devices to go offline. They need to be power-cycled to function again. The sensor was also unreliable and may have returned incorrect data because of rate limiting from the TP-Link cloud.
[@sdb9696] - [#124930] ([documentation](/integrations/tplink))
[@sdb9696]: https://github.com/sdb9696
[#124930]: https://github.com/home-assistant/core/pull/124930
{% enddetails %}
{% details "Velux" %}
The YAML configuration for the Velux integration was removed. The configuration has been moved to the UI in Home Assistant 2024.2.
The YAML configuration was automatically imported and should be removed from your YAML configuration.
[@gjohansson-ST] - [#123724] ([documentation](/integrations/velux))
[#123724]: https://github.com/home-assistant/core/pull/123724
{% enddetails %}
{% details "Zigbee Home Automation" %}
- The IKEA Starkvind fan modes have been updated. Automations that used to set the fan to 10% speed to switch it to "auto mode", should now be updated to set the preset to "auto."
In auto mode, the actual fan speed is now properly displayed.
For more information, see the [PR in the ZHA repo](https://github.com/zigpy/zha/pull/87).
- The firmware update entity logic has changed. A device will only be considered "up-to-date" if there is a known firmware update for it and the current firmware version is greater than the firmware update version. If there is no known firmware update, the device firmware state will be considered "unknown", as we can't tell if it's up to date or not.
Previously, we showed "up-to-date" if there was no known firmware which misrepresented the state for many devices.
[@puddly] - [#124804] ([documentation](/integrations/zha))
[@puddly]: https://github.com/puddly
[#124804]: https://github.com/home-assistant/core/pull/124804
{% enddetails %}
If you are a custom integration developer and want to learn about changes and
new features available for your integration: Be sure to follow our
[developer blog][devblog]. The following are the most notable for this release:
- [New returning type in LawnMowerActivity](https://developers.home-assistant.io/blog/2024/08/23/lawn-mower-activity-returning)
- [Validation of entity action schemas](https://developers.home-assistant.io/blog/2024/08/27/entity-service-schema-validation)
- [Changes to the icon translations schema](https://developers.home-assistant.io/blog/2024/08/27/changed-icon-translations-schema)
- [Template.hass is no longer automatically set when rendering templates](https://developers.home-assistant.io/blog/2024/09/02/template-hass-required)
[devblog]: https://developers.home-assistant.io/blog/
## All changes
Of course, there is a lot more in this release. You can find a list of
all changes made here: [Full changelog for Home Assistant Core 2024.9](/changelogs/core-2024.9)

1
source/_redirects
View File

@ -499,6 +499,7 @@ layout: null
/integrations/arduino /more-info/removed-integration 301
/integrations/asterisk_cdr /more-info/removed-integration 301
/integrations/asterisk_mbox /more-info/removed-integration 301
/_docs/asterisk_mbox.markdown /more-info/removed-integration 301
/integrations/bbb_gpio /more-info/removed-integration 301
/integrations/bh1750 /more-info/removed-integration 301
/integrations/binary_sensor.mychevy /more-info/removed-integration 301

1936
source/changelogs/core-2024.9.markdown Normal file
View File

File diff suppressed because it is too large Load Diff

18
source/dashboards/badges.markdown
View File

@ -71,11 +71,21 @@ show_entity_picture:
description: If your entity has a picture, it will replace the icon.
type: boolean
default: false
display_type:
show_name:
required: false
description: Type of display for the badge. It can be either `minimal` (icon only), `standard` (icon and state), or `complete` (icon, state, and name).
type: string
default: standard
description: Show the name
type: boolean
default: "true"
show_icon:
required: false
description: Show the icon
type: boolean
default: "true"
show_state:
required: false
description: Show the state.
type: boolean
default: "false"
state_content:
required: false
description: >

BIN
source/images/blog/2024-09/section-settings.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 7.8 KiB

BIN
source/images/blog/2024-09/sections-after.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 68 KiB

BIN
source/images/blog/2024-09/sections-before.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 45 KiB

BIN
source/images/blog/2024-09/social.jpg Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 56 KiB

BIN
source/images/blog/2024-09/untracked-energy.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 20 KiB

BIN
source/images/dashboards/badge_configure.png
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 51 KiB

After

Width:  |  Height:  |  Size: 42 KiB