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-16 05:46:52 +00:00
Code Issues Packages Projects Releases Wiki Activity

Merge branch 'next' into tado-new-authentication-method

Browse Source
This commit is contained in:
Erwin Douna 2025-03-26 12:55:07 +01:00 committed by GitHub
commit 200edc286e
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
61 changed files with 1687 additions and 309 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
CODEOWNERS
View File

@ -557,6 +557,7 @@ source/_integrations/moon.markdown @fabaff @frenck
source/_integrations/mopeka.markdown @bdraco
source/_integrations/motion_blinds.markdown @starkillerOG
source/_integrations/motionblinds_ble.markdown @LennP @jerrybboy
source/_integrations/motionblinds_matter.markdown @home-assistant/matter
source/_integrations/motioneye.markdown @dermotduffy
source/_integrations/mqtt.markdown @emontnemery @jbouwh @bdraco
source/_integrations/msteams.markdown @peroyvind

10
source/_dashboards/heading.markdown
View File

@ -60,7 +60,7 @@ badges:
## Heading badges
In addition to the heading text, each heading card can show small badges. They are smaller than regular [badges](/dashboards/badges/) and don't have a background. The heading badges can display sensor information in a compact and minimal style.
In addition to the heading text, each heading card can show small badges. They are smaller than regular [badges](/dashboards/badges/) and don't have a background. The heading badges can display sensor information in a compact and minimal style. Heading badges also support [actions](/dashboards/actions/).
```yaml
type: entity
@ -108,4 +108,12 @@ tap_action:
required: false
description: Action taken on card tap. See [action documentation](/dashboards/actions/#tap-action). By default, it will do nothing.
type: map
hold_action:
required: false
description: Action taken on card hold. See [action documentation](/dashboards/actions/#hold-action). By default, it will do nothing.
type: map
double_tap_action:
required: false
description: Action taken on card double tap. See [action documentation](/dashboards/actions/#double-tap-action). By default, it will do nothing.
type: map
{% endconfiguration %}

5
source/_dashboards/iframe.markdown
View File

@ -61,6 +61,11 @@ allow:
description: The [Permissions Policy](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Permissions-Policy#iframes) of the iframe, that is, the value of the [`allow`](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/iframe#allow) attribute.
type: string
default: "fullscreen"
disable_sandbox:
required: false
description: Disables the [sandbox](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/iframe#attr-sandbox) attribute of the iframe, e.g. required for Chrome when viewing PDFs. This is less secure and should only be used if you trust the content of the iframe.
type: boolean
default: false
{% endconfiguration %}
### Examples

14
source/_dashboards/map.markdown
View File

@ -130,7 +130,11 @@ name:
label_mode:
required: false
default: name
description: When set to `icon`, renders the entity's icon in the marker instead of text. When set to `state`, renders the entity's state as the label for the map marker instead of the entity's name. This option doesn't apply to [zone](/integrations/zone/) entities because they don't use a label but an icon.
description: When set to `icon`, renders the entity's icon in the marker instead of text. When set to `state` or `attribute`, renders the entity's state or attribute as the label for the map marker instead of the entity's name. This option doesn't apply to [zone](/integrations/zone/) entities because they don't use a label but an icon.
type: string
attribute:
required: false
description: An entity's attribute when `label_mode` set to `attribute`.
type: string
focus:
required: false
@ -151,8 +155,12 @@ source:
label_mode:
required: false
default: name
description: When set to `icon`, renders the geolocation entity's icon in the marker instead of text. When set to `state`, renders the entity's state as the label for the map marker instead of the entity's name.
type: string
description: When set to `icon`, renders the entity's icon in the marker instead of text. When set to `state` or `attribute`, renders the entity's state or attribute as the label for the map marker instead of the entity's name. This option doesn't apply to [zone](/integrations/zone/) entities because they don't use a label but an icon.
type: string
attribute:
required: false
description: An entity's attribute when `label_mode` set to `attribute`.
type: string
focus:
required: false
default: true

23
source/_docs/blueprint/selectors.markdown
View File

@ -150,6 +150,12 @@ device:
the set model.
type: string
required: false
model_id:
description: >
When set, the list of areas is limited to areas with devices that have
the set model ID.
type: string
required: false
entity:
description: >
When entity options are provided, the list of areas is filtered by areas
@ -485,7 +491,7 @@ devices based on the selector configuration. The value of the input will contain
the device ID or a list of device IDs, based on if `multiple` is set to `true`.
A device selector can filter the list of devices, based on things like the
manufacturer or model of the device, the entities the device provides or based
manufacturer, model, or model ID of the device, the entities the device provides or based
on the domain that provided the device.
![Screenshot of a device selector](/images/blueprints/selector-device.png)
@ -561,6 +567,11 @@ filter:
When set, it limits the list of devices to devices that have the set model.
type: string
required: false
model_id:
description: >
When set, the list of devices is limited to devices that have the set model ID.
type: string
required: false
multiple:
description: >
Allows selecting multiple devices. If set to `true`, the resulting value of
@ -792,6 +803,12 @@ device:
the set model.
type: string
required: false
model_id:
description: >
When set, the list only includes floors with devices that have
the set model ID.
type: string
required: false
entity:
description: >
When entity options are provided, the list only includes floors
@ -1342,6 +1359,10 @@ device:
description: When set, it limits the targets to devices by the set model.
type: string
required: false
model_id:
description: When set, the targets are limited to devices that have the set model ID.
type: string
required: false
entity:
description: >
When entity options are provided, the targets are limited by entities

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

@ -473,6 +473,7 @@ The same thing can also be expressed as a test:
- `floor_id(lookup_value)` returns the floor ID for a given device ID, entity ID, area ID, or area name. Can also be used as a filter.
- `floor_name(lookup_value)` returns the floor name for a given device ID, entity ID, area ID, or floor ID. Can also be used as a filter.
- `floor_areas(floor_name_or_id)` returns the list of area IDs tied to a given floor ID or name. Can also be used as a filter.
- `floor_entities(floor_name_or_id)` returns the list of entity IDs tied to a given floor ID or name. Can also be used as a filter.
#### Floors examples
@ -1173,6 +1174,31 @@ Some examples:
</div>
### Hashing
The template engine contains a few filters and functions to hash a string of
data. A few very common hashing algorithms are supported: `md5`, `sha1`,
`sha256`, and `sha512`.
Some examples:
{% raw %}
- `{{ md5("Home Assistant") }}` - renders as `f3f2b8b3b40084aa87e92b7ffb02ed13885fea2d07`
- `{{ "Home Assistant" | md5 }}` - renders as `f3f2b8b3b40084aa87e92b7ffb02ed13885fea2d07`
- `{{ sha1("Home Assistant") }}` - renders as `14bffd017c73917bfda2372aaf287570597b8e82`
- `{{ "Home Assistant" | sha1 }}` - renders as `14bffd017c73917bfda2372aaf287570597b8e82`
- `{{ sha256("Home Assistant") }}` - renders as `a18f473c9d3ed968a598f996dcf0b9de84de4ee04c950d041b61297a25bcea49`
- `{{ "Home Assistant" | sha256 }}` - renders as `a18f473c9d3ed968a598f996dcf0b9de84de4ee04c950d041b61297a25bcea49`
- `{{ sha512("Home Assistant") }}` - renders as `f251e06eb7d3439e1a86d6497d6a4531c3e8c809f538be62f89babf147d7d63aca4e77ae475b94c654fd38d8f543f778ce80007d6afef379d8a0e5d3ddf7349d`
- `{{ "Home Assistant" | sha512 }}` - renders as `f251e06eb7d3439e1a86d6497d6a4531c3e8c809f538be62f89babf147d7d63aca4e77ae475b94c654fd38d8f543f778ce80007d6afef379d8a0e5d3ddf7349d`
{% endraw %}
### Regular expressions
For more information on regular expressions
@ -1184,6 +1210,137 @@ See: [Python regular expression operations](https://docs.python.org/3/library/re
- Filter `value | regex_findall(find='', ignorecase=False)` will find all regex matches of the find expression in `value` and return the array of matches.
- Filter `value | regex_findall_index(find='', index=0, ignorecase=False)` will do the same as `regex_findall` and return the match at index.
### Shuffling
The template engine contains a filter and function to shuffle a list.
Shuffling can happen randomly or reproducibly using a seed. When using a seed
it will always return the same shuffled list for the same seed.
Some examples:
{% raw %}
- `{{ [1, 2, 3] | shuffle }}` - renders as `[3, 1, 2]` (_random_)
- `{{ shuffle([1, 2, 3]) }}` - renders as `[3, 1, 2]` (_random_)
- `{{ shuffle(1, 2, 3) }}` - renders as `[3, 1, 2]` (_random_)
- `{{ [1, 2, 3] | shuffle("random seed") }}` - renders as `[2, 3, 1] (_reproducible_)
- `{{ shuffle([1, 2, 3], seed="random seed") }}` - renders as `[2, 3, 1] (_reproducible_)
- `{{ shuffle([1, 2, 3], "random seed") }}`- renders as `[2, 3, 1] (_reproducible_)
- `{{ shuffle(1, 2, 3, seed="random seed") }}` - renders as `[2, 3, 1] (_reproducible_)
{% endraw %}
### Flatten a list of lists
The template engine provides a filter to flatten a list of lists: `flatten`.
It will take a list of lists and return a single list with all the elements.
The depth of the flattening can be controlled using the `levels` parameter.
The flattening process is recursive, so it will flatten all nested lists, until
the number of levels (if specified) is reached.
Some examples:
{% raw %}
- `{{ flatten([1, [2, [3]], 4, [5 , 6]]) }}` - renders as `[1, 2, 3, 4, 5, 6]`
- `{{ [1, [2, [3]], 4, [5 , 6]] | flatten }}` - renders as `[1, 2, 3, 4, 5, 6]`
- `{{ flatten([1, [2, [3]]], levels=1) }}` - renders as `[1, 2, [3]]`
- `{{ [1, [2, [3]]], flatten(levels=1) }}` - renders as `[1, 2, [3]]`
- `{{ flatten([1, [2, [3]]], 1) }}` - renders as `[1, 2, [3]]`
- `{{ [1, [2, [3]]], flatten(1) }}` - renders as `[1, 2, [3]]`
{% endraw %}
### Find common elements between lists
The template engine provides a filter to find common elements between two lists: `intersect`.
This function returns a list containing all elements that are present in both input lists.
Some examples:
{% raw %}
- `{{ intersect([1, 2, 5, 3, 4, 10], [1, 2, 3, 4, 5, 11, 99]) }}` - renders as `[1, 2, 3, 4, 5]`
- `{{ [1, 2, 5, 3, 4, 10] | intersect([1, 2, 3, 4, 5, 11, 99]) }}` - renders as `[1, 2, 3, 4, 5]`
- `{{ intersect(['a', 'b', 'c'], ['b', 'c', 'd']) }}` - renders as `['b', 'c']`
- `{{ ['a', 'b', 'c'] | intersect(['b', 'c', 'd']) }}` - renders as `['b', 'c']`
{% endraw %}
### Find elements in first list not in second list
The template engine provides a filter to find elements that are in the first list but not in the second list: `difference`.
This function returns a list containing all elements that are present in the first list but absent from the second list.
Some examples:
{% raw %}
- `{{ difference([1, 2, 5, 3, 4, 10], [1, 2, 3, 4, 5, 11, 99]) }}` - renders as `[10]`
- `{{ [1, 2, 5, 3, 4, 10] | difference([1, 2, 3, 4, 5, 11, 99]) }}` - renders as `[10]`
- `{{ difference(['a', 'b', 'c'], ['b', 'c', 'd']) }}` - renders as `['a']`
- `{{ ['a', 'b', 'c'] | difference(['b', 'c', 'd']) }}` - renders as `['a']`
{% endraw %}
### Find elements that are in either list but not in both
The template engine provides a filter to find elements that are in either of the input lists but not in both: `symmetric_difference`.
This function returns a list containing all elements that are present in either the first list or the second list, but not in both.
Some examples:
{% raw %}
- `{{ symmetric_difference([1, 2, 5, 3, 4, 10], [1, 2, 3, 4, 5, 11, 99]) }}` - renders as `[10, 11, 99]`
- `{{ [1, 2, 5, 3, 4, 10] | symmetric_difference([1, 2, 3, 4, 5, 11, 99]) }}` - renders as `[10, 11, 99]`
- `{{ symmetric_difference(['a', 'b', 'c'], ['b', 'c', 'd']) }}` - renders as `['a', 'd']`
- `{{ ['a', 'b', 'c'] | symmetric_difference(['b', 'c', 'd']) }}` - renders as `['a', 'd']`
{% endraw %}
### Combine all unique elements from two lists
The template engine provides a filter to combine all unique elements from two lists: `union`.
This function returns a list containing all unique elements that are present in either the first list or the second list.
Some examples:
{% raw %}
- `{{ union([1, 2, 5, 3, 4, 10], [1, 2, 3, 4, 5, 11, 99]) }}` - renders as `[1, 2, 3, 4, 5, 10, 11, 99]`
- `{{ [1, 2, 5, 3, 4, 10] | union([1, 2, 3, 4, 5, 11, 99]) }}` - renders as `[1, 2, 3, 4, 5, 10, 11, 99]`
- `{{ union(['a', 'b', 'c'], ['b', 'c', 'd']) }}` - renders as `['a', 'b', 'c', 'd']`
- `{{ ['a', 'b', 'c'] | union(['b', 'c', 'd']) }}` - renders as `['a', 'b', 'c', 'd']`
{% endraw %}
### Combining dictionaries
The template engine provides a function and filter to merge multiple dictionaries: `combine`.
It will take multiple dictionaries and merge them into a single dictionary. When used as a filter,
the filter value is used as the first dictionary. The optional `recursive` parameter determines
whether nested dictionaries should be merged (defaults to `False`).
Some examples:
{% raw %}
- `{{ {'a': 1, 'b': 2} | combine({'b': 3, 'c': 4}) }}` - renders as `{'a': 1, 'b': 3, 'c': 4}`
- `{{ combine({'a': 1, 'b': 2}, {'b': 3, 'c': 4}) }}` - renders as `{'a': 1, 'b': 3, 'c': 4}`
- `{{ combine({'a': 1, 'b': {'x': 1}}, {'b': {'y': 2}, 'c': 4}, recursive=True) }}` - renders as `{'a': 1, 'b': {'x': 1, 'y': 2}, 'c': 4}`
- `{{ combine({'a': 1, 'b': {'x': 1}}, {'b': {'y': 2}, 'c': 4}) }}` - renders as `{'a': 1, 'b': {'y': 2}, 'c': 4}`
{% endraw %}
## Merge action responses
Using action responses we can collect information from various entities at the same time.
@ -1514,6 +1671,44 @@ When a command template renders to a valid `bytes` literal, then MQTT will publi
- Template {% raw %}`{{ 16 }}`{% endraw %} renders to payload encoded string `"16"`.
- Template {% raw %}`{{ pack(0x10, ">B") }}`{% endraw %} renders to a raw 1 byte payload `0x10`.
### Determining types
When working with templates, it can be useful to determine the type of
the returned value from a method or the type of a variable at times.
For this, Home Assistant provides the `typeof()` template function and filter,
which is inspired by the [JavaScript](https://en.wikipedia.org/wiki/JavaScript)
`typeof` operator. It reveals the type of the given value.
This is mostly useful when you are debugging or playing with templates in
the developer tools of Home Assistant. However, it might be useful in some
other cases as well.
Some examples:
{% raw %}
- `{{ typeof(42) }}` - renders as `int`
- `{{ typeof(42.0) }}` - renders as `float`
- `{{ typeof("42") }}` - renders as `str`
- `{{ typeof([1, 2, 3]) }}` - renders as `list`
- `{{ typeof({"key": "value"}) }}` - renders as `dict`
- `{{ typeof(True) }}` - renders as `bool`
- `{{ typeof(None) }}` - renders as `NoneType`
- `{{ 42 | typeof }}` - renders as `int`
- `{{ 42.0 | typeof }}` - renders as `float`
- `{{ "42" | typeof }}` - renders as `str`
- `{{ [1, 2, 3] | typeof }}` - renders as `list`
- `{{ {"key": "value"} | typeof }}` - renders as `dict`
- `{{ True | typeof }}` - renders as `bool`
- `{{ None | typeof }}` - renders as `NoneType`
- `{{ some_variable | typeof }}` - renders the type of `some_variable`
- `{{ states("sensor.living_room") | typeof }}` - renders the type of the result of `states()` function
{% endraw %}
## Some more things to keep in mind
### `entity_id` that begins with a number

35
source/_docs/scripts.markdown
View File

@ -62,7 +62,7 @@ The variables {% term action %} allows you to set/override variables that will b
```yaml
- alias: "Set variables"
variables:
entities:
entities:
- light.kitchen
- light.living_room
brightness: 100
@ -94,9 +94,7 @@ Variables can be templated.
### Scope of variables
Variables defined by the `variables` {% term action %} have local scope. This means that if a variable is changed in a nested sequence block, that change will not be visible in an outer sequence block.
Inside the `if` sequence the `variables` {% term action %} will only alter the `people` variable for that sequence.
The `variables` {% term action %} assigns the values to previously defined variables with the same name. If a variable was not previously defined, it is assigned in the top-level (script run) scope.
{% raw %}
@ -111,17 +109,17 @@ sequence:
entity_id: device_tracker.paulus
state: "home"
then:
# At this scope and this point of the sequence, people == 0
- variables:
people: "{{ people + 1 }}"
# At this scope, people will now be 1 ...
paulus_home: true
- action: notify.notify
data:
message: "There are {{ people }} people home" # "There are 1 people home"
# ... but at this scope it will still be 0
# Variable value is now updated
- action: notify.notify
data:
message: "There are {{ people }} people home" # "There are 0 people home"
message: "There are {{ people }} people home {% if paulus_home is defined %}(including Paulus){% endif %}"
# "There are 1 people home (including Paulus)"
```
{% endraw %}
@ -213,8 +211,8 @@ This {% term action %} evaluates the template, and if true, the script will cont
The template is re-evaluated whenever an entity ID that it references changes state. If you use non-deterministic functions like `now()` in the template it will not be continuously re-evaluated, but only when an entity ID that is referenced is changed. If you need to periodically re-evaluate the template, reference a sensor from the [Time and Date](/integrations/time_date/) integration that will update minutely or daily.
{% raw %}
```yaml
```yaml
# Wait until media player is stopped
- alias: "Wait until media player is stopped"
wait_template: "{{ is_state('media_player.floor', 'stop') }}"
@ -258,8 +256,8 @@ With both types of waits it is possible to set a timeout after which the script
You can also get the script to abort after the timeout by using optional `continue_on_timeout: false`.
{% raw %}
```yaml
```yaml
# Wait for IFTTT event or abort after specified timeout.
- wait_for_trigger:
- trigger: event
@ -322,6 +320,7 @@ This can be used to take different actions based on whether or not the condition
target:
entity_id: switch.some_light
```
{% endraw %}
## Fire an event
@ -453,7 +452,7 @@ repeat:
{% endraw %}
Other types are accepted as list items, for example, each item can be a
template, or even an mapping of key/value pairs.
template, or even an mapping of key/value pairs.
{% raw %}
@ -509,7 +508,7 @@ For example:
- repeat:
while: "{{ is_state('sensor.mode', 'Home') and repeat.index < 10 }}"
sequence:
- ...
- ...
```
{% endraw %}
@ -559,8 +558,9 @@ For example:
- repeat:
until: "{{ is_state('device_tracker.iphone', 'home') }}"
sequence:
- ...
- ...
```
{% endraw %}
### Repeat loop variable
@ -691,7 +691,6 @@ automation:
{% endraw %}
More `choose` can be used together. This is the case of an IF-IF.
The following example shows how a single {% term automation %} can control entities that aren't related to each other but have in common the same trigger.
@ -856,10 +855,8 @@ Some of the caveats of running {% term actions %} in parallel:
there is no guarantee that they will be completed in the same order.
- If one {% term action %} fails or errors, the other {% term actions %} will keep running until
they too have finished or errored.
- Variables created/modified in one parallelized {% term action %} are not available
in another parallelized {% term action %}. Each step in a parallelized has its own scope.
- The response data of a parallelized {% term action %} is however also available outside of its
own scope. This is especially useful for parallelizing execution of long-running {% term actions %}.
- Variables created/modified in one parallelized {% term action %} can conflict with variables
from another parallelized {% term action %}. Make sure to give them distinct names to prevent that.
## Stopping a script sequence
@ -963,7 +960,7 @@ blueprint:
input:
input_boolean:
name: Boolean
selector:
selector:
boolean:
actions:

2
source/_integrations/advantage_air.markdown
View File

@ -68,7 +68,7 @@ The integration will create a binary sensor for each zone that has a motion sens
### Switch
The integration will create switch entities to toggle the MyFan/ezFan setting, and to toggle air conditioning fresh air mode, if they are supported by your hardware.
The integration will create switch entities to toggle the MyFan/ezFan setting, to toggle air conditioning fresh air mode, and to toggle MySleep$aver, if they are supported by your hardware.
With MyPlace, any relays will be created as switch entities.

4
source/_integrations/anthropic.markdown
View File

@ -67,5 +67,7 @@ Model:
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.
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. This parameter is ignored if extended thinking is enabled (see below).
Thinking budget:
description: For models with [extending thinking](https://docs.anthropic.com/en/docs/build-with-claude/extended-thinking) support, such as Claude 3.7 Sonnet, this parameter determines the maximum number of tokens Claude is allowed use for its internal reasoning process. Larger budgets can improve response quality by enabling more thorough analysis for complex problems, although Claude may not use the entire budget allocated, especially at ranges above 32K. Anthropic suggests starting at the minimum and increasing the thinking budget incrementally to find the optimal range for Claude to perform well for your use case. Higher token counts may allow you to achieve more comprehensive and nuanced reasoning, but there may also be diminishing returns depending on the task. Be prepared for potentially longer response times due to the additional processing required for the reasoning process. The value must always be less than the `Maximum Tokens` specified. If the value is below `1024`, then extended thinking is disabled. This parameter is ignored if the model does not support extended thinking.
{% endconfiguration_basic %}

24
source/_integrations/backup.markdown
View File

@ -3,12 +3,15 @@ title: Backup
description: Allow creating backups of container and core installations.
ha_category:
- Other
- Sensor
ha_release: 2022.4
ha_quality_scale: internal
ha_domain: backup
ha_codeowners:
- '@home-assistant/core'
ha_iot_class: Calculated
ha_platforms:
- sensor
ha_integration_type: system
related:
- docs: /common-tasks/general/#backups
@ -80,3 +83,24 @@ automation:
## Restoring a backup
To restore a backup, follow the steps described in [Restoring a backup](/common-tasks/general/#restoring-a-backup).
## Sensors
The **Backup** {% term integration %} provides several sensors.
### Backup Manager State
The current state of the backup system. Possible states are:
- Idle
- Creating a backup
- Receiving a backup
- Restoring a backup
### Next scheduled automatic backup
The timestamp of the next scheduled automatic backup.
### Last successful automatic backup
The timestamp of the last successful automatic backup.

2
source/_integrations/balboa.markdown
View File

@ -13,6 +13,7 @@ ha_domain: balboa
ha_platforms:
- binary_sensor
- climate
- event
- fan
- light
- select
@ -32,6 +33,7 @@ There is currently support for the following device types within Home Assistant:
- Binary sensor (Filter cycles and circulation pumps)
- Climate
- Event (Last known fault, if any)
- Fan (Pumps/Jets)
- Light
- Select (Low/high temperature range)

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

@ -203,6 +203,11 @@ payload_stop:
required: false
type: string
default: STOP
payload_stop_tilt:
description: The command payload that stops the tilt.
required: false
type: string
default: stop
platform:
description: Must be `cover`. Only allowed and required in [MQTT auto discovery device messages](/integrations/mqtt/#device-discovery-payload).
required: true

2
source/_integrations/demo.markdown
View File

@ -42,6 +42,7 @@ ha_platforms:
- tts
- update
- vacuum
- valve
- water_heater
- weather
ha_integration_type: integration
@ -81,6 +82,7 @@ Available demo platforms:
- [Text-to-speech](/integrations/tts/) (`tts`)
- [Update](/integrations/update/) (`update`)
- [Vacuum](/integrations/vacuum/) (`vacuum`)
- [Valve](/integrations/valve/) (`valve`)
- [Water heater](/integrations/water_heater/) (`water_heater`)
- [Weather](/integrations/weather/) (`weather`)

49
source/_integrations/frankever.markdown Normal file
View File

@ -0,0 +1,49 @@
---
title: FrankEver
description: Integrate FrankEver (Powered by Shelly) devices
ha_category:
- Binary sensor
- Climate
- Cover
- Energy
- Event
- Light
- Number
- Select
- Sensor
- Switch
- Text
- Update
- Valve
ha_release: '0.115'
ha_codeowners:
- '@balloob'
- '@bieniu'
- '@thecode'
- '@chemelli74'
- '@bdraco'
ha_iot_class: Local Push
ha_domain: frankever
ha_config_flow: true
ha_zeroconf: true
ha_platforms:
- binary_sensor
- button
- climate
- cover
- diagnostics
- event
- light
- number
- select
- sensor
- switch
- text
- update
- valve
ha_integration_type: virtual
ha_supporting_domain: shelly
ha_supporting_integration: Shelly
---
{% include integrations/supported_brand.md %}

11
source/_integrations/gios.markdown
View File

@ -17,8 +17,11 @@ ha_integration_type: service
The `gios` integration uses the [GIOŚ](http://powietrze.gios.gov.pl/pjp/current) web service as a source for air quality data for your location.
## Setup
To obtain ID of the measuring station, go to [GIOŚ](http://powietrze.gios.gov.pl/pjp/current) page, select the measuring station on the map and click the "More Info" link. The address of the opened page will look like this: `http://powietrze.gios.gov.pl/pjp/current/station_details/chart/291` and `291` will be ID of the measuring station.
{% include integrations/config_flow.md %}
{% configuration_basic %}
Measuring station:
description: "Select a measuring station from the list."
Name:
description: "Service name in Home Assistant, by default, this is the name of your Home Assistant instance. For example `Home`."
{% endconfiguration_basic %}

1
source/_integrations/google_assistant.markdown
View File

@ -259,6 +259,7 @@ Currently, the following domains are available to be used with Google Assistant,
- input_button
- input_select (option/setting/mode/value)
- light (on/off/brightness/rgb color/color temp)
- lawn_mower (dock/start/pause)
- lock
- media_player (on/off/set volume (via set volume)/source (via set input source)/control playback)
- scene (on)

12
source/_integrations/govee_light_local.markdown
View File

@ -22,13 +22,17 @@ To enable local control on your Govee device, refer to the instructions availabl
## Supported devices
H6008,
H600D,
H6022,
H6042,
H6046,
H6047,
H6051,
H6052,
H6056,
H6059,
H605D,
H6061,
H6062,
H6065,
@ -53,6 +57,7 @@ H610B,
H6110,
H6117,
H612A,
H612B,
H612F,
H6144,
H6159,
@ -62,6 +67,7 @@ H615C,
H615D,
H615E,
H6163,
H6167,
H6168,
H6172,
H6173,
@ -84,10 +90,12 @@ H61A3,
H61A5,
H61A8,
H61B2,
H61B3,
H61B5,
H61BA,
H61BC,
H61BE,
H61C2,
H61C3,
H61C5,
H61D3,
@ -97,6 +105,7 @@ H61E1,
H61E5,
H61E6,
H61F5,
H6609,
H6640,
H6641,
H7012,
@ -141,7 +150,8 @@ H70C2,
H70C4,
H70C5,
H70D1,
H805C
H805C,
H8072
{% note %}
Some scenes may not be supported from all devices. If you find a scene that's not working with a specific model, please open an issue at the [underling library](https://github.com/Galorhallen/govee-local-api/issues)

135
source/_integrations/habitica.markdown
View File

@ -297,6 +297,141 @@ Updates a specific reward for the selected Habitica character.
| `remove_tag` | yes | Remove tags from the Habitica reward. |
| `alias` | yes | A task alias can be used instead of the name or task ID. Only dashes, underscores, and alphanumeric characters are supported. The task alias must be unique among all your tasks. |
### Action `habitica.create_reward`
Creates a reward for the selected Habitica character.
| Data attribute | Optional | Description |
| -------------- | -------- | -------------------------------------------------------------------------------------------- |
| `config_entry` | no | Select the Habitica account to create a reward. |
| `name` | no | The title for the Habitica reward. |
| `notes` | yes | The notes for the Habitica reward. |
| `cost` | no | The cost of the reward. |
| `tag` | yes | Add tags to the Habitica reward. If a tag does not already exist, a new one will be created. |
| `alias` | yes | A task alias can be used instead of the name or task ID. Only dashes, underscores, and alphanumeric characters are supported. The task alias must be unique among all your tasks. |
### Action `habitica.update_habit`
Updates a specific habit for the selected Habitica character.
| Data attribute | Optional | Description |
| -------------- | -------- | -------------------------------------------------------------------------------------------- |
| `config_entry` | no | Select the Habitica account to update a habit. |
| `task` | no | The name (or task ID) of the habit you want to update. |
| `rename` | yes | The new title for the Habitica habit. |
| `notes` | yes | The new notes for the Habitica habit. |
| `up_down` | yes | Update if the habit is good and rewarding (positive), bad and penalizing (negative) or both. Valid values: `up`, `down`, or `[up, down]` |
| `priority` | yes | Update the difficulty of a habit. Valid values: `trivial`, `easy`, `medium`, `hard` |
| `frequency` | yes | Update when a habit's counter resets. Valid values: `daily`, `weekly`, `monthly` |
| `tag` | yes | Add tags to the Habitica habit. If a tag does not already exist, a new one will be created. |
| `remove_tag` | yes | Remove tags from the Habitica habit. |
| `counter_up` | yes | Update the up counter of a positive habit. |
| `counter_down` | yes | Update the down counter of a negative habit. |
| `alias` | yes | A task alias can be used instead of the name or task ID. Only dashes, underscores, and alphanumeric characters are supported. The task alias must be unique among all your tasks. |
### Action `habitica.create_habit`
Creates a habit for the selected Habitica character.
| Data attribute | Optional | Description |
| -------------- | -------- | -------------------------------------------------------------------------------------------- |
| `config_entry` | no | Select the Habitica account to create a habit. |
| `name` | no | The title for the Habitica habit. |
| `notes` | yes | The notes for the Habitica habit. |
| `up_down` | yes | Defines if the habit is good and rewarding (positive), bad and penalizing (negative) or both. Valid values: `up`, `down`, or `[up, down]` |
| `priority` | yes | Sets the difficulty of the habit. Valid values: `trivial`, `easy`, `medium`, `hard`. Default: `easy` |
| `frequency` | yes | Defines when the habit's counter resets. Valid values: `daily`, `weekly`, `monthly`. Default: `daily` |
| `tag` | yes | Add tags to the Habitica habit. If a tag does not already exist, a new one will be created. |
| `alias` | yes | A task alias can be used instead of the name or task ID. Only dashes, underscores, and alphanumeric characters are supported. The task alias must be unique among all your tasks. |
### Action `habitica.update_todo`
Updates a specific to-do for the selected Habitica character.
| Data attribute | Optional | Description |
| -------------- | -------- | -------------------------------------------------------------------------------------------- |
| `config_entry` | no | Select the Habitica account to update a to-do. |
| `task` | no | The name (or task ID) of the to-do you want to update. |
| `rename` | yes | The new title for the Habitica to-do. |
| `notes` | yes | The new notes for the Habitica to-do. |
| `add_checklist_item` | yes | The items to add to the to-do's checklist. |
| `remove_checklist_item` | yes | Remove items from a to-do's checklist. |
| `score_checklist_item` | yes | Mark items from a to-do's checklist as completed. |
| `unscore_checklist_item` | yes | Undo completion of items of a to-do's checklist. |
| `priority` | yes | Update the difficulty of a to-do. Valid values: `trivial`, `easy`, `medium`, `hard` |
| `date` | yes | The to-do's due date. |
| `clear_date` | yes | Remove the due date from a to-do. |
| `reminder` | yes | Add reminders to a Habitica to-do. |
| `remove_reminder` | yes | Remove specific reminders from a Habitica to-do. |
| `clear_reminder` | yes | Remove all reminders from a Habitica to-do. |
| `tag` | yes | Add tags to the Habitica to-do. If a tag does not already exist, a new one will be created. |
| `remove_tag` | yes | Remove tags from the Habitica to-do. |
| `alias` | yes | A task alias can be used instead of the name or task ID. Only dashes, underscores, and alphanumeric characters are supported. The task alias must be unique among all your tasks. |
### Action `habitica.create_todo`
Creates a to-do for the selected Habitica character.
| Data attribute | Optional | Description |
| -------------- | -------- | -------------------------------------------------------------------------------------------- |
| `config_entry` | no | Select the Habitica account to create a to-do. |
| `name` | no | The title for the Habitica to-do. |
| `notes` | yes | The notes for the Habitica to-do. |
| `add_checklist_item` | yes | The items to add to the to-do's checklist. |
| `priority` | yes | The difficulty of the to-do. Valid values: `trivial`, `easy`, `medium`, `hard` |
| `date` | yes | The to-do's due date. |
| `reminder` | yes | Add reminders to a Habitica to-do. |
| `tag` | yes | Add tags to the Habitica to-do. If a tag does not already exist, a new one will be created. |
| `alias` | yes | A task alias can be used instead of the name or task ID. Only dashes, underscores, and alphanumeric characters are supported. The task alias must be unique among all your tasks. |
### Action `habitica.update_daily`
Updates a specific daily for the selected Habitica character.
| Data attribute | Optional | Description |
| -------------- | -------- | -------------------------------------------------------------------------------------------- |
| `config_entry` | no | Select the Habitica account to update a daily. |
| `task` | no | The name (or task ID) of the daily you want to update. |
| `rename` | yes | The new title for the Habitica daily. |
| `notes` | yes | The new notes for the Habitica daily. |
| `add_checklist_item` | yes | The items to add to the daily's checklist. |
| `remove_checklist_item` | yes | Remove items from a daily's checklist. |
| `score_checklist_item` | yes | Mark items from a daily's checklist as completed. |
| `unscore_checklist_item` | yes | Undo completion of items of a daily's checklist. |
| `priority` | yes | Update the difficulty of a daily. Valid values: `trivial`, `easy`, `medium`, `hard` |
| `start_date` | yes | Defines when the daily task becomes active and specifies the exact weekday or day of the month it repeats on. |
| `frequency` | yes | The repetition interval of a daily. Valid values: `daily`, `weekly`, `monthly`, `yearly`. |
| `every_x` | yes | The number of intervals (`days`, `weeks`, `months`, or `years`) after which the daily repeats, based on the chosen repetition interval. A value of 0 makes the daily inactive (a *Gray Daily*). |
| `repeat` | yes | The days of the week the daily repeats. Applicable when the repetition interval is set to weekly. |
| `repeat_monthly` | yes | Whether a monthly recurring task repeats on the same calendar day each month (`day_of_month`), or on the same weekday and week of the month (`day_of_week`), based on the start date. Applicable when the repetition interval is set to monthly. |
| `reminder` | yes | Add reminders to a Habitica daily. |
| `remove_reminder` | yes | Remove specific reminders from a Habitica daily. |
| `clear_reminder` | yes | Remove all reminders from a Habitica daily. |
| `tag` | yes | Add tags to the Habitica daily. If a tag does not already exist, a new one will be created. |
| `remove_tag` | yes | Remove tags from the Habitica daily. |
| `streak` | yes | Adjust or reset the streak counter of the daily. |
| `alias` | yes | A task alias can be used instead of the name or task ID. Only dashes, underscores, and alphanumeric characters are supported. The task alias must be unique among all your tasks. |
### Action `habitica.create_daily`
Creates a daily for the selected Habitica character.
| Data attribute | Optional | Description |
| -------------- | -------- | -------------------------------------------------------------------------------------------- |
| `config_entry` | no | Select the Habitica account to create a daily. |
| `name` | no | The title for the Habitica daily. |
| `notes` | yes | The new notes for the Habitica daily. |
| `add_checklist_item` | yes | The items to add to the daily's checklist. |
| `priority` | yes | The difficulty of a daily. Valid values: `trivial`, `easy`, `medium`, `hard` |
| `start_date` | yes | The date when the daily becomes active and specifies the exact weekday or day of the month it repeats on. |
| `frequency` | yes | The repetition interval of a daily. Valid values: `daily`, `weekly`, `monthly`, `yearly`. |
| `every_x` | yes | The number of intervals (`days`, `weeks`, `months`, or `years`) after which the daily repeats, based on the chosen repetition interval. A value of 0 makes the daily inactive (a *Gray Daily*). |
| `repeat` | yes | The days of the week the daily repeats. Applicable when the repetition interval is set to weekly. |
| `repeat_monthly` | yes | Whether a monthly recurring task repeats on the same calendar day each month (`day_of_month`), or on the same weekday and week of the month (`day_of_week`), based on the start date. Applicable when the repetition interval is set to monthly. |
| `reminder` | yes | Add reminders to a Habitica daily. |
| `tag` | yes | Add tags to the Habitica daily. If a tag does not already exist, a new one will be created. |
| `alias` | yes | A task alias can be used instead of the name or task ID. Only dashes, underscores, and alphanumeric characters are supported. The task alias must be unique among all your tasks. |
## Automations
Get started with these automation examples for Habitica, each featuring ready-to-use blueprints!

5
source/_integrations/heos.markdown
View File

@ -29,6 +29,7 @@ Add this integration to automate playback and group configuration of HEOS-capabl
- Controlling play mode (e.g., play/pause), volume, mute, and shuffle
- Playing HEOS favorites, playlists, quick selects, URLs
- Setting the source to physical inputs (e.g., `AUX1`)
- Browsing HEOS music services (for example, **Tidal**) and sources (such as **Favorites**)
- Grouping and ungrouping HEOS devices
- Clearing playlists
@ -40,12 +41,12 @@ Add this integration to automate playback and group configuration of HEOS-capabl
{% include integrations/config_flow.md %}
{% note %}
Only a single instance of the integration is needed to access the entire HEOS system on the network. It will only connect to a single {% term host %}.
A single instance of the integration adds all devices in the HEOS system to Home Assistant. When setup through discovery, it will automatically select the best {% term host %}. The integration will automatically reconnect and fail over to other hosts in the HEOS system if the configured host goes offline.
{% endnote %}
{% configuration_basic %}
Host:
description: "The host name or IP address (e.g., \"192.168.1.2\") of your HEOS-capable product. If you have more than one device, select, or enter a host, that is connected to the LAN via wire or has the strongest wireless signal."
description: "The host name or IP address (e.g., \"192.168.1.2\") of your HEOS-capable product. If you have more than one device, enter a host that is connected to the LAN via wire and is always powered on."
{% endconfiguration_basic %}
## Configuration options

139
source/_integrations/home_connect.markdown
View File

@ -117,9 +117,18 @@ The integration configuration will ask for the *Client ID* and *Client Secret* c
- **Bottle cooler door**:
- **Description**: Indicates if the bottle cooler door is open.
- **Availability**: Fridge freezer, Refrigerator
- **Common chiller door**:
- **Description**: Indicates if the common chiller door is open.
- **Availability**: Fridge freezer, Refrigerator
- **Chiller door**:
- **Description**: Indicates if the chiller door is open.
- **Availability**: Fridge freezer, Refrigerator
- **Left chiller door**:
- **Description**: Indicates if the left chiller door is open.
- **Availability**: Fridge freezer, Refrigerator
- **Right chiller door**:
- **Description**: Indicates if the right chiller door is open.
- **Availability**: Fridge freezer, Refrigerator
- **Flex compartment door**:
- **Description**: Indicates if the flex compartment door is open.
- **Availability**: Fridge freezer
@ -833,30 +842,120 @@ All the event sensors will have the following possible values:
{% enddetails %}
- **Freezer door alarm**:
- **Description**: Represents the alarm state of the freezer door.
- **Availability**: Freezer, Fridge freezer
- **Refrigerator door alarm**:
- **Description**: Represents the alarm state of the refrigerator door.
- **Availability**: Fridge freezer, Refrigerator
- **Freezer temperature alarm**:
- **Description**: Represents the alarm state of the freezer temperature.
- **Availability**: Freezer, Fridge freezer
- **Bean container empty**:
- **Description**: Indicates whether the bean container is empty.
- **Availability**: Coffee maker
- **Water tank empty**:
- **Description**: Indicates whether the water tank is empty.
- **Availability**: Coffee maker
- **Drip tray full**:
- **Description**: Indicates whether the drip tray is full.
- **Availability**: Coffee maker
- **Program aborted**:
- **Description**: Event triggered each time a program is successfully canceled.
- **Availability**: Cook processor, Cleaning robot, Dishwasher
- **Program finished**:
- **Description**: Event triggered each time a program run is successfully finished.
- **Availability**: Cook processor, Cooktop, Hood, Oven, Cleaning robot, Dishwasher, Washer, Washer dryer
- **Alarm clock elapsed**:
- **Description**: Event triggered when the alarm clock has elapsed.
- **Availability**: Cooktop, Oven
- **Pre-heat finished**:
- **Description**: Event triggered when **Fast pre-heat** program option is active and the preheating phase is finished.
- **Availability**: Cooktop, Oven
- **Regular pre-heat finished**:
- **Description**: Event triggered when the preheating phase is finished (and the **Fast pre-heat** option is not active nor supported).
- **Availability**: Oven
- **Drying process finished**:
- **Description**: Event triggered when the drying process is finished.
- **Availability**: Dryer
- **Salt nearly empty**:
- **Description**: Indicates whether the salt is nearly empty.
- **Description**: Event triggered when the salt supply is running low.
- **Availability**: Dishwasher
- **Rinse aid nearly empty**:
- **Description**: Indicates whether the rinse aid is nearly empty.
- **Description**: Event triggered when the rinse aid supply is running low.
- **Availability**: Dishwasher
- **Bean container empty**:
- **Description**: Event triggered when the bean container is empty.
- **Availability**: Coffee maker
- **Water tank empty**:
- **Description**: Event triggered when the water tank is empty.
- **Availability**: Coffee maker
- **Drip tray full**:
- **Description**: Event triggered when the drip tray is full.
- **Availability**: Coffee maker
- **Keep milk tank cool**:
- **Description**: Event triggered when the user should remove the milk container and put it in a cool place so that the milk stays fresh.
- **Availability**: Coffee maker
- **Descaling in 20 cups**:
- **Description**: Event triggered when there are 20 cups left before the descaling process is required.
- **Availability**: Coffee maker
- **Descaling in 15 cups**:
- **Description**: Event triggered when there are 15 cups left before the descaling process is required.
- **Availability**: Coffee maker
- **Descaling in 10 cups**:
- **Description**: Event triggered when there are 10 cups left before the descaling process is required.
- **Availability**: Coffee maker
- **Descaling in 5 cups**:
- **Description**: Event triggered when there are 5 cups left before the descaling process is required.
- **Availability**: Coffee maker
- **Device should be descaled**:
- **Description**: Event triggered when the device should be descaled.
- **Availability**: Coffee maker
- **Device descaling overdue**:
- **Description**: Event triggered when the device descaling is overdue.
- **Availability**: Coffee maker
- **Device descaling blockage**:
- **Description**: Event triggered when the device descaling is blocked.
- **Availability**: Coffee maker
- **Device should be cleaned**:
- **Description**: Event triggered when the device should be cleaned.
- **Availability**: Coffee maker
- **Device cleaning overdue**:
- **Description**: Event triggered when the device cleaning is overdue.
- **Availability**: Coffee maker
- **Calc'N'Clean in 20 cups**:
- **Description**: Event triggered when there are 20 cups left before the Calc'N'Clean process is required.
- **Availability**: Coffee maker
- **Calc'N'Clean in 15 cups**:
- **Description**: Event triggered when there are 15 cups left before the Calc'N'Clean process is required.
- **Availability**: Coffee maker
- **Calc'N'Clean in 10 cups**:
- **Description**: Event triggered when there are 10 cups left before the Calc'N'Clean process is required.
- **Availability**: Coffee maker
- **Calc'N'Clean in 5 cups**:
- **Description**: Event triggered when there are 5 cups left before the Calc'N'Clean process is required.
- **Availability**: Coffee maker
- **Device should be Calc'N'Cleaned**:
- **Description**: Event triggered when the device should be Calc'N'Cleaned.
- **Availability**: Coffee maker
- **Device Calc'N'Clean overdue**:
- **Description**: Event triggered when the device Calc'N'Clean is overdue.
- **Availability**: Coffee maker
- **Device Calc'N'Clean blockage**:
- **Description**: Event triggered when the device Calc'N'Clean is blocked.
- **Availability**: Coffee maker
- **Freezer door alarm**:
- **Description**: Event triggered when the freezer door was left open too long.
- **Availability**: Freezer, Fridge freezer
- **Refrigerator door alarm**:
- **Description**: Event triggered when the refrigerator door was left open too long.
- **Availability**: Fridge freezer, Refrigerator
- **Freezer temperature alarm**:
- **Description**: Event triggered when the freezer temperature is too high.
- **Availability**: Freezer, Fridge freezer
- **Empty dust box and clean filter**:
- **Description**: Event triggered when the user has to empty the dust box and clean the filter.
- **Availability**: Cleaning robot
- **Cleaning robot is stuck**:
- **Description**: Event triggered when the cleaning robot is stuck and isn't able to continue its run.
- **Availability**: Cleaning robot
- **Docking station not found**:
- **Description**: Event triggered when the cleaning robot wasn't able to find the charging station.
- **Availability**: Cleaning robot
- **Poor i-Dos 1 fill level**:
- **Description**: Event triggered when i-Dos content 1 is poor.
- **Availability**: Washer
- **Poor i-Dos 2 fill level**:
- **Description**: Event triggered when i-Dos content 2 is poor.
- **Availability**: Washer
- **Grease filter max saturation nearly reached**:
- **Description**: Event triggered when the grease filters need to be cleaned soon
- **Availability**: Hood
- **Grease filter max saturation reached**:
- **Description**: Event triggered when the grease filters are saturated
- **Availability**: Hood
{% enddetails %}

4
source/_integrations/homee.markdown
View File

@ -10,10 +10,12 @@ ha_codeowners:
- '@Taraman17'
ha_domain: homee
ha_platforms:
- binary_sensor
- button
- cover
- light
- number
- select
- sensor
- switch
- valve
@ -25,11 +27,13 @@ ha_quality_scale: bronze
There is currently support for the following device types in Home Assistant:
- binary sensor
- button
- cover
- light
- number
- sensor
- select
- switch
- valve

2
source/_integrations/homekit.markdown
View File

@ -406,7 +406,7 @@ The following integrations are currently supported:
| Integration | Type Name | Description |
| ------------------------------------------------------------- | ---------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| alarm_control_panel | SecuritySystem | All security systems. |
| automation / input_boolean / remote / scene / script / vacuum | Switch | All represented as switches. |
| automation / input_boolean / lawn_mower / remote / scene / script / vacuum | Switch | All represented as switches. |
| input_select / select | Switch | Represented as a power strip with buttons for each option. |
| binary_sensor | Sensor | Support for `co2`, `door`, `garage_door`, `gas`, `moisture`, `motion`, `occupancy`, `opening`, `smoke` and `window` device classes. Defaults to the `occupancy` device class for everything else. |
| camera | Camera | All camera devices. **HomeKit Secure Video is not supported at this time.** |

5
source/_integrations/homematicip_cloud.markdown
View File

@ -7,6 +7,7 @@ ha_category:
- Button
- Climate
- Cover
- Event
- Hub
- Light
- Lock
@ -42,6 +43,7 @@ There is currently support for the following device types within Home Assistant:
- Button
- Climate
- Cover
- Event
- Light
- Lock
- Sensor
@ -150,6 +152,9 @@ Within this delay the device registration should be completed in the App, otherw
- Module for Hoermann drives (*HMIP-MOD-HO*)
- Hunter Douglas & erfal window blinds (*HMIP-HDM1*)
- homematicip_cloud.event
- Doorbell Event for devices *HmIP-DSD-PCB* and others where ChannelRole equals DOOR_BELL_INPUT
- homematicip_cloud.light
- Switch actuator and meter for brand switches (*HmIP-BSM*)
- Dimming actuator for brand switches (*HmIP-BDT*)

2
source/_integrations/husqvarna_automower.markdown
View File

@ -148,6 +148,7 @@ The integration will create the following sensors:
- Battery level
- Cutting blade usage time (if available)
- Error. For example: *Mower tilted*, *outside geofence*.
- Downtime (if available)
- Restricted reason. For example: *Week schedule*, *frost*, or *daily limit*.
- Mode
- Next start
@ -158,6 +159,7 @@ The integration will create the following sensors:
- Total drive distance
- Total running time
- Total searching time
- Uptime (if available)
- Work area (if available). For example: *My lawn*, *Front lawn*, *Back lawn*
For each work area with activated systematic mowing these sensors are created:

11
source/_integrations/igloohome.markdown
View File

@ -15,9 +15,10 @@ ha_integration_type: integration
ha_quality_scale: bronze
---
The **igloohome** {% term integration %} grants Home Assistant access to paired [smart access device\(s\)](https://www.igloohome.co/#products). The features of this integration includes:
The **igloohome** {% term integration %} grants Home Assistant access to paired [smart access device\(s\)](https://www.igloohome.co/#products) via the [igloodeveloper API](https://igloocompany.stoplight.io/docs/igloohome-api/1w1cuv56ge5xq-overview). The features of this integration include:
- For [Bridge](https://www.igloohome.co/products/bridge) owners:
- Lock/Unlock/Open locks that are linked to a bridge.
- Regular updates of all linked devices' battery level.
- For non-bridge owners:
@ -76,3 +77,11 @@ Some generic troubleshooting steps:
- Verify that your [API credentials](https://access.igloocompany.co/api-access) are correctly filled in.
- Ensure your API credentials have not expired or been revoked.
### Unable to lock/unlock/open lock
- Verify that the bridge is:
- powered on
- has an active internet connection
- and is within Bluetooth range of the lock
- If you've changed the link between the bridge and the lock, reload the config entry.

3
source/_integrations/inkbird.markdown
View File

@ -26,6 +26,9 @@ Integrates [INKBIRD](https://www.inkbird.com/) devices into Home Assistant.
- [INKBIRD Bluetooth BBQ Thermometer IBT-6XS](https://inkbird.com/products/bluetooth-bbq-thermometer-ibt-6xs)
- [INKBIRD Bluetooth Grill Thermometer IBT-4XS](https://inkbird.com/products/bluetooth-grill-thermometer-ibt-4xs)
- [INKBIRD Bluetooth Grill Thermometer IBT-2X](https://inkbird.com/products/bluetooth-grill-thermometer-ibt-2x)
- [INKBIRD Bluetooth Hygrometer Thermometer ITH-11-B](https://inkbird.com/products/bluetooth-hygrometer-thermometer-ith-11-b)
- [INKBIRD Bluetooth Hygrometer Thermometer ITH-13-B](https://inkbird.com/products/bluetooth-hygrometer-thermometer-ith-13-b)
- [INKBIRD Bluetooth Hygrometer Thermometer ITH-21-B](https://inkbird.com/products/bluetooth-hygrometer-thermometer-ith-21-b)
- [Nutrichef Smart Wireless Grill Thermometer](https://nutrichefkitchen.com/products/pwirbbq40)
- [Nutrichef Smart Bluetooth BBQ Grill Thermometer](https://nutrichefkitchen.com/products/pwirbbq80-1)

2
source/_integrations/iometer.markdown
View File

@ -51,6 +51,8 @@ The following sensors are supported:
- Core power status: Battery or USB-C power for the IOmeter Core
- Signal strength WiFi: WiFi connection strength of the Bridge
- Signal strength Core/Bridge: Sub-GHz connection strength between Core and Bridge
- Core/Bridge connection status: If Core and Bridge are connected
- Core attachment status: If the IOmeter Core is attached to the electricity meter
## Troubleshooting

6
source/_integrations/iron_os.markdown
View File

@ -102,6 +102,8 @@ The following controls allow you to customize the settings and options for your
- **Button locking mode:** Configures whether buttons can be locked to prevent accidental presses, with options for disabled, full locking, or boost only.
- **Display orientation mode:** Sets the display orientation with options for left-handed, right-handed, or automatic adjustment.
- **Startup behavior:** Defines the mode the device enters on power-up: disabled, sleeping mode, idle mode (heat-off until moved), or soldering mode.
- **Soldering tip type:** Select the type of soldering tip in use: TS100 long/Hakko T12, Pinecil short, or PTS200 short. The auto-sense option enables automatic detection of the tip type. This feature requires IronOS v2.23 or higher.
- **Hall effect sleep timeout:** Specifies the duration of inactivity after which the device enters sleep mode when a hall effect sensor (if present) detects proximity to a magnet. This feature requires IronOS v2.23 or higher.
### User interface settings
@ -126,7 +128,7 @@ The following controls allow you to customize the settings and options for your
- **Power Delivery timeout:** Defines how long the firmware will attempt to negotiate USB-PD before switching to Quick Charge. Lower values are recommended for faster PD negotiation.
- **Power limit:** Sets a custom wattage cap for the device to maintain the **average** power below this value. Note: Peak power cannot be controlled. When using USB-PD, the limit will be the lower of this setting and the power supply's advertised wattage.
- **Quick Charge voltage:** Adjusts the maximum voltage for Quick Charge negotiation. Does not affect USB-PD. Ensure the setting aligns with the current rating of your power supply for safety.
- **Power Delivery 3.1 EPR (Extended Power Range):** Enables EPR mode, allowing input voltages up to 28V with a [compatible USB-C power supply](https://wiki.pine64.org/wiki/Pinecil_Power_Supplies#EPR_PD3.1,_140W_Chargers)
- **Power Delivery 3.1 EPR (Extended Power Range):** Enables EPR mode, allowing input voltages up to 28V with a [compatible USB-C power supply](https://wiki.pine64.org/wiki/Pinecil_Power_Supplies#EPR_PD3.1,_140W_Chargers). Options are *on*, *off*, and *safe* (does not dynamically request more power). The *safe* option requires IronOS v2.23 or higher.
### Advanced settings
@ -149,7 +151,7 @@ Get started with this automation example for IronOS with a ready-to-use blueprin
Automatically activate the fume extractor when soldering begins and deactivate it when the soldering iron is idle.
{% my blueprint_import badge blueprint_url="https://community.home-assistant.io/t/ironos-soldering-fume-extractor-automation-pinecil-v2/802156" %}
{% my blueprint_import badge blueprint_url="<https://community.home-assistant.io/t/ironos-soldering-fume-extractor-automation-pinecil-v2/802156>" %}
{% details "Example YAML configuration" %}

93
source/_integrations/jewish_calendar.markdown
View File

@ -84,53 +84,56 @@ Time sensor states are represented as ISO8601 formatted *UTC time*.
### Holiday sensor
The holiday sensor includes 3 attributes: *type*, *type_id*, and *id*.
The *type_id* is useful for cases to condition automations based on a range of types.
The holiday sensor includes 2 attributes: *type*, and *id*.
The *id* is useful for automations so they're not language-dependent.
On Rosh Chodesh Tevet, which always falls on Chanukah, the sensor will report both values: "Rosh Chodesh, Chanukah".
In Israel, on the 30th of Shvat, the sensor will report: "Rosh Chodesh, Family day". On the 22nd of Tishrei it will report: "Shmini Atzeret, Simchat Torah".
The following is the list of holidays the sensor knows about with their selected type:
| ID | English | Hebrew | Type | Type_ID |
|----------------------|----------------------------|-----------------------|---------------------------|:-------:|
| erev_rosh_hashana | Erev Rosh Hashana | ערב ראש השנה | EREV_YOM_TOV | 2 |
| rosh_hashana_i | Rosh Hashana I | א' ראש השנה | YOM_TOV | 1 |
| rosh_hashana_ii | Rosh Hashana II | ב' ראש השנה | YOM_TOV | 1 |
| tzom_gedaliah | Tzom Gedaliah | צום גדליה | FAST_DAY | 5 |
| erev_yom_kippur | Erev Yom Kippur | עיוה"כ | EREV_YOM_TOV | 2 |
| yom_kippur | Yom Kippur | יום הכפורים | YOM_TOV | 1 |
| erev_sukkot | Erev Sukkot | ערב סוכות | EREV_YOM_TOV | 2 |
| sukkot | Sukkot | סוכות | YOM_TOV | 1 |
| sukkot_ii | Sukkot II | שני של סוכות | YOM_TOV | 1 |
| hol_hamoed_sukkot | Hol hamoed Sukkot | חול המועד סוכות | HOL_HAMOED | 3 |
| hoshana_raba | Hoshana Raba | הושענא רבה | EREV_YOM_TOV | 2 |
| shmini_atzeret | Shmini Atzeret | שמיני עצרת | YOM_TOV | 1 |
| simchat_torah | Simchat Torah | שמחת תורה | YOM_TOV | 1 |
| chanukah | Chanukah | חנוכה | MELACHA_PERMITTED_HOLIDAY | 4 |
| rabin_memorial_day | Yitzhak Rabin memorial day | יום הזכרון ליצחק רבין | MEMORIAL_DAY | 8 |
| asara_btevet | Asara B'Tevet | צום עשרה בטבת | FAST_DAY | 5 |
| tu_bshvat | Tu B'Shvat | ט"ו בשבט | MINOR_HOLIDAY | 7 |
| family_day | Family Day | יום המשפחה | ISRAEL_NATIONAL_HOLIDAY | 9 |
| memorial_day_unknown | Memorial day for fallen whose place of burial is unknown | יום הזיכרון לחללי מערכות ישראל שמקום קבורתם לא נודע | MEMORIAL_DAY | 8 |
| taanit_esther | Ta'anit Esther | תענית אסתר | FAST_DAY | 5 |
| purim | Purim | פורים | MELACHA_PERMITTED_HOLIDAY | 4 |
| shushan_purim | Shushan Purim | שושן פורים | MELACHA_PERMITTED_HOLIDAY | 4 |
| erev_pesach | Erev Pesach | ערב פסח | EREV_YOM_TOV | 2 |
| pesach | Pesach | פסח | YOM_TOV | 1 |
| pesach_ii | Pesach II | שני של פסח | YOM_TOV | 1 |
| hol_hamoed_pesach | Hol hamoed Pesach | חול המועד פסח | HOL_HAMOED | 3 |
| pesach_vii | Pesach VII | שביעי פסח | YOM_TOV | 1 |
| pesach_viii | Pesach VIII | אחרון של פסח | YOM_TOV | 1 |
| yom_hashoah | Yom HaShoah | יום השואה | MEMORIAL_DAY | 8 |
| yom_hazikaron | Yom HaZikaron | יום הזכרון | MEMORIAL_DAY | 8 |
| yom_haatzmaut | Yom HaAtzma'ut | יום העצמאות | MODERN_HOLIDAY | 6 |
| lag_bomer | Lag B'Omer | ל"ג בעומר | MINOR_HOLIDAY | 7 |
| yom_yerushalayim | Yom Yerushalayim | יום ירושלים | MODERN_HOLIDAY | 6 |
| erev_shavuot | Erev Shavuot | ערב שבועות | EREV_YOM_TOV | 2 |
| shavuot | Shavuot | שבועות | YOM_TOV | 1 |
| shavuot_ii | Shavuot II | שני של שבועות | YOM_TOV | 1 |
| tzom_tammuz | Tzom Tammuz | צום שבעה עשר בתמוז | FAST_DAY | 5 |
| zeev_zhabotinsky_day | Zeev Zhabotinsky day | יום זאב ז'בוטינסקי | MEMORIAL_DAY | 8 |
| tisha_bav | Tish'a B'Av | תשעה באב | FAST_DAY | 5 |
| tu_bav | Tu B'Av | ט"ו באב | MINOR_HOLIDAY | 7 |
| rosh_chodesh | Rosh Chodesh | ראש חודש | ROSH_CHODESH | 10 |
| ID | English | Hebrew | Type |
|----------------------|----------------------------|-----------------------|---------------------------|
| erev_rosh_hashana | Erev Rosh Hashana | ערב ראש השנה | EREV_YOM_TOV |
| rosh_hashana_i | Rosh Hashana I | א' ראש השנה | YOM_TOV |
| rosh_hashana_ii | Rosh Hashana II | ב' ראש השנה | YOM_TOV |
| tzom_gedaliah | Tzom Gedaliah | צום גדליה | FAST_DAY |
| erev_yom_kippur | Erev Yom Kippur | עיוה"כ | EREV_YOM_TOV |
| yom_kippur | Yom Kippur | יום הכפורים | YOM_TOV |
| erev_sukkot | Erev Sukkot | ערב סוכות | EREV_YOM_TOV |
| sukkot | Sukkot | סוכות | YOM_TOV |
| sukkot_ii | Sukkot II | שני של סוכות | YOM_TOV |
| hol_hamoed_sukkot | Hol hamoed Sukkot | חול המועד סוכות | HOL_HAMOED |
| hoshana_raba | Hoshana Raba | הושענא רבה | EREV_YOM_TOV |
| shmini_atzeret | Shmini Atzeret | שמיני עצרת | YOM_TOV |
| simchat_torah | Simchat Torah | שמחת תורה | YOM_TOV |
| chanukah | Chanukah | חנוכה | MELACHA_PERMITTED_HOLIDAY |
| rabin_memorial_day | Yitzhak Rabin memorial day | יום הזכרון ליצחק רבין | MEMORIAL_DAY |
| asara_btevet | Asara B'Tevet | צום עשרה בטבת | FAST_DAY |
| tu_bshvat | Tu B'Shvat | ט"ו בשבט | MINOR_HOLIDAY |
| family_day | Family Day | יום המשפחה | ISRAEL_NATIONAL_HOLIDAY |
| memorial_day_unknown | Memorial day for fallen whose place of burial is unknown | יום הזיכרון לחללי מערכות ישראל שמקום קבורתם לא נודע | MEMORIAL_DAY |
| taanit_esther | Ta'anit Esther | תענית אסתר | FAST_DAY |
| purim | Purim | פורים | MELACHA_PERMITTED_HOLIDAY |
| shushan_purim | Shushan Purim | שושן פורים | MELACHA_PERMITTED_HOLIDAY |
| erev_pesach | Erev Pesach | ערב פסח | EREV_YOM_TOV |
| pesach | Pesach | פסח | YOM_TOV |
| pesach_ii | Pesach II | שני של פסח | YOM_TOV |
| hol_hamoed_pesach | Hol hamoed Pesach | חול המועד פסח | HOL_HAMOED |
| pesach_vii | Pesach VII | שביעי פסח | YOM_TOV |
| pesach_viii | Pesach VIII | אחרון של פסח | YOM_TOV |
| yom_hashoah | Yom HaShoah | יום השואה | MEMORIAL_DAY |
| yom_hazikaron | Yom HaZikaron | יום הזכרון | MEMORIAL_DAY |
| yom_haatzmaut | Yom HaAtzma'ut | יום העצמאות | MODERN_HOLIDAY |
| lag_bomer | Lag B'Omer | ל"ג בעומר | MINOR_HOLIDAY |
| yom_yerushalayim | Yom Yerushalayim | יום ירושלים | MODERN_HOLIDAY |
| erev_shavuot | Erev Shavuot | ערב שבועות | EREV_YOM_TOV |
| shavuot | Shavuot | שבועות | YOM_TOV |
| shavuot_ii | Shavuot II | שני של שבועות | YOM_TOV |
| tzom_tammuz | Tzom Tammuz | צום שבעה עשר בתמוז | FAST_DAY |
| zeev_zhabotinsky_day | Zeev Zhabotinsky day | יום זאב ז'בוטינסקי | MEMORIAL_DAY |
| tisha_bav | Tish'a B'Av | תשעה באב | FAST_DAY |
| tu_bav | Tu B'Av | ט"ו באב | MINOR_HOLIDAY |
| rosh_chodesh | Rosh Chodesh | ראש חודש | ROSH_CHODESH |

2
source/_integrations/linak.markdown
View File

@ -6,7 +6,7 @@ ha_category:
ha_domain: linak
ha_integration_type: virtual
ha_supporting_domain: idasen_desk
ha_supporting_integration: IKEA Idasen Desk
ha_supporting_integration: IKEA Idåsen Desk
ha_release: '2023.10'
ha_codeowners:
- '@abmantis'

49
source/_integrations/linkedgo.markdown Normal file
View File

@ -0,0 +1,49 @@
---
title: LinkedGo
description: Integrate LinkedGo (Powered by Shelly) devices
ha_category:
- Binary sensor
- Climate
- Cover
- Energy
- Event
- Light
- Number
- Select
- Sensor
- Switch
- Text
- Update
- Valve
ha_release: '0.115'
ha_codeowners:
- '@balloob'
- '@bieniu'
- '@thecode'
- '@chemelli74'
- '@bdraco'
ha_iot_class: Local Push
ha_domain: linkedgo
ha_config_flow: true
ha_zeroconf: true
ha_platforms:
- binary_sensor
- button
- climate
- cover
- diagnostics
- event
- light
- number
- select
- sensor
- switch
- text
- update
- valve
ha_integration_type: virtual
ha_supporting_domain: shelly
ha_supporting_integration: Shelly
---
{% include integrations/supported_brand.md %}

11
source/_integrations/mcp_server.markdown
View File

@ -35,10 +35,8 @@ The integration provides the following configuration options:
{% configuration_basic %}
Control Home Assistant:
description: The API to use to expose tools over the Model Context Protocol. It is recommended
to use **Stateless Assist** which is a version of the **Assist** API where the
prompt does not contain any state information. Clients can only control or
provide information about entities that are [exposed](/voice_control/voice_remote_expose_devices/) to it.
description: If MCP clients are allowed to control Home Assistant. Clients can only
control or provide information about entities that are [exposed](/voice_control/voice_remote_expose_devices/) to it.
{% endconfiguration_basic %}
## Architecture overview
@ -132,11 +130,6 @@ The [MCP Prompts](https://modelcontextprotocol.io/docs/concepts/prompts) provide
inform LLMs how to call the tools. The tools used by the configured LLM API
are exposed.
It is recommended to use the **Stateless Assist** API since the prompt does
not contain any state information, which will be incorrect after any actions
are performed.
## Known Limitations
The Home Assistant Model Context Protocol integration currently only supports a

53
source/_integrations/modbus.markdown
View File

@ -527,7 +527,7 @@ The master configuration like device_class are automatically copied to the slave
## Configuring climate entities
The Modbus climate platform allows you to monitor a thermostat or heaters as well as set a target temperature, HVAC mode, swing mode, and fan state.
The Modbus climate platform allows you to monitor a thermostat or heaters as well as set a target temperature, HVAC action, HVAC mode, swing mode, and fan state.
Please refer to [Parameter usage](#parameters-usage-matrix) for conflicting parameters.
@ -652,6 +652,57 @@ climates:
description: "Swap word ABCD -> CDAB, **not valid with data types: `int16`, `uint16`**"
word_byte:
description: "Swap word ABCD -> DCBA, **not valid with data types: `int16`, `uint16`**"
hvac_action_register:
description: "Configuration of register for HVAC action"
required: false
type: map
keys:
address:
description: "Address of HVAC action register."
required: true
type: integer
input_type:
description: "Type of register, either `holding` or `input`"
required: false
default: holding
type: string
values:
description: "Mapping between the register values and HVAC actions"
required: true
type: map
keys:
action_off:
description: "Value corresponding to HVAC Off action."
required: false
type: [integer, list]
action_cooling:
description: "Value corresponding to HVAC Cooling action."
required: false
type: [integer, list]
action_defrosting:
description: "Value corresponding to HVAC Defrosting action."
required: false
type: [integer, list]
action_drying:
description: "Value corresponding to HVAC Drying action."
required: false
type: [integer, list]
action_fan:
description: "Value corresponding to HVAC Fan action."
required: false
type: [integer, list]
action_heating:
description: "Value corresponding to HVAC Heating action."
required: false
type: [integer, list]
action_idle:
description: "Value corresponding to HVAC Idle action."
required: false
type: [integer, list]
action_preheating:
description: "Value corresponding to HVAC Preheating action."
required: false
type: [integer, list]
hvac_mode_register:
description: "Configuration of register for HVAC mode"
required: false

51
source/_integrations/motionblinds_matter.markdown Normal file
View File

@ -0,0 +1,51 @@
---
title: Motionblinds Matter
description: Control your Motionblinds Matter devices using the Matter integration.
ha_category:
- Cover
ha_brand: true
ha_domain: motionblinds
ha_release: '2025.4'
ha_codeowners:
- '@home-assistant/matter'
ha_config_flow: true
ha_platforms:
- cover
ha_iot_class: Local Push
ha_integration_type: virtual
works_with:
- matter
ha_iot_standard:
- matter
---
[Motionblinds](https://motionblinds.com) is a member of the Works with Home Assistant partner program for their Matter products. Motionblinds is committed to making sure their products are up-to-date and ready to use in Home Assistant.
Motionblinds Matter devices work locally and integrate seamlessly with the Matter integration in Home Assistant. As all connectivity is happening locally, status updates and controlling your devices happen instantly in Home Assistant.
{% my add_matter_device badge domain=page.ha_domain %}
[Learn more about Matter in Home Assistant.](/integrations/matter/)
## Supported devices
The following devices are known to be supported by the integration:
- CMD-02
- CMD-02-P
- CMD-03
- CM-03
- CM-04
- CM-05
- CM-06
- CM-07
- CM-07V2
- CM-08
- CM-09
- CM-10
- CM-34
- CM-35
- CM-36
- CM-40
- CM-45
- CM-52
- CM-57

48
source/_integrations/mqtt.markdown
View File

@ -51,19 +51,7 @@ MQTT (aka MQ Telemetry Transport) is a machine-to-machine or "Internet of Things
{% include integrations/config_flow.md %}
### Removing the MQTT integration
The MQTT integration and its entities can be removed by following these steps:
1. Navigate to **Settings** > **Devices & Services**
2. Find the MQTT integration and click on it
3. Click the delete button to remove the MQTT config entry
Note: This action does not remove the [MQTT broker](#setting-up-a-broker) or its data. If you want to completely remove MQTT:
1. Check your `configuration.yaml` and other YAML files for MQTT-related configurations and remove them
2. Review your automations and scripts for any MQTT dependencies
3. Consider backing up your configuration before making these changes
MQTT Devices and entities can be set up through [MQTT -discovery](#mqtt-discovery) or [added manually](#manual-configured-mqtt-items) via YAML or subentries.
<a name="configuration-via-mqtt-discovery"></a>
{% details "Configuration of MQTT components via MQTT discovery" %}
@ -131,6 +119,21 @@ Note: This action does not remove the [MQTT broker](#setting-up-a-broker) or its
{% enddetails %}
<a name="configuration-via-subentries"></a>
{% details "Configuration of MQTT components via Subentries" %}
- [Notify](/integrations/notify.mqtt/)
To add an MQTT device via a Subentry, follow these steps:
1. Go to **{% my integrations title="Settings > Devices & services" %}**.
2. Select the MQTT integration.
3. Add a subentry via {% my integrations title="**Settings** > **Devices & services**" %}, click {% icon "mdi:dots-vertical" %} and select **Add MQTT device**.
A device context and one or more entities can be added to the subentry.
{% enddetails %}
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.
@ -163,6 +166,8 @@ Add the MQTT integration, then provide your broker's hostname (or IP address) an
2. Select the MQTT integration.
3. Reconfigure the MQTT broker settings via {% my integrations title="**Settings** > **Devices & services**" %}, click {% icon "mdi:dots-vertical" %} and select **Reconfigure**.
MQTT subentries can also be reconfigured. Additional entities can be added, or an entity can bve removed from the sub entry. Each MQTT subentry holds one MQTT device. The MQTT device must have at least one entity.
{% important %}
If you experience an error message like `Failed to connect due to exception: [SSL: CERTIFICATE_VERIFY_FAILED] certificate verify failed`, then turn on `Advanced options` and set [Broker certificate validation](/integrations/mqtt/#broker-certificate-validation) to `Auto`.
{% endimportant %}
@ -185,7 +190,7 @@ The time in seconds between sending keep alive messages for this client. The def
#### Broker certificate validation
To enable a secure connection to the broker, the broker certificate should be validated. If your broker uses a trusted certificate, then choose `Auto`. This will allow validation against certificate CAs bundled certificates. If a self-signed certificate is used, select `Custom`. A custom PEM-encoded CA certificate can be uploaded. Click `NEXT` to show the control to upload the CA certificate.
To enable a secure connection to the broker, the broker certificate should be validated. If your broker uses a trusted certificate, then choose `Auto`. This will allow validation against certificate CAs bundled certificates. If a self-signed certificate is used, select `Custom`. A custom PEM- or DER-encoded CA certificate can be uploaded. Click `NEXT` to show the control to upload the CA certificate.
If the server certificate does not match the hostname then validation will fail. To allow a connection without the verification of the hostname, turn the `Ignore broker certificate validation` switch on.
#### MQTT Protocol
@ -194,7 +199,7 @@ The MQTT protocol setting defaults to version `3.1.1`. If your MQTT broker suppo
#### Securing the connection
With a secure broker connection it is possible to use a client certificate for authentication. To set the client certificate and private key turn on the option `Use a client certificate` and click "Next" to show the controls to upload the files. Only a PEM encoded client certificates together with a PEM encoded private key can be uploaded. Make sure the private key has no password set.
With a secure broker connection, it is possible to use a client certificate for authentication. To set the client certificate and private key turn on the option `Use a client certificate` and click "Next" to reveal file upload controls. A client certificate and the corresponding private key must be uploaded together. Both client certificate and private key must be either PEM- or DER-encoded. If the private key is encrypted with a password, ensure you supply the correct password when uploading the client certificate and key files.
#### Using WebSockets as transport
@ -833,6 +838,7 @@ support_url:
'pl_rst_pct': 'payload_reset_percentage',
'pl_rst_pr_mode': 'payload_reset_preset_mode',
'pl_stop': 'payload_stop',
'pl_stop_tilt': 'payload_stop_tilt',
'pl_stpa': 'payload_start_pause',
'pl_strt': 'payload_start',
'pl_toff': 'payload_turn_off',
@ -1371,6 +1377,8 @@ Compatibility and features will vary, and not all devices may work.
## Manual configured MQTT items
Support to add manual items is added for the MQTT Notify entities, other platforms will follow later.
For most integrations, it is also possible to manually set up MQTT items in {% term "`configuration.yaml`" %}. Read more [about configuration in YAML](/docs/configuration/yaml).
MQTT supports two styles for configuring items in YAML. All configuration items are placed directly under the `mqtt` integration key. Note that you cannot mix these styles. Use the *YAML configuration listed per item* style when in doubt.
@ -1590,3 +1598,13 @@ logger:
Event `event_mqtt_reloaded` is fired when Manually configured MQTT entities have been reloaded and entities thus might have changed.
This event has no additional data.
## Removing the integration
{% include integrations/remove_device_service_steps.md %}
Note: This action does not remove the [MQTT broker](#setting-up-a-broker) or its data. If you want to completely remove MQTT:
1. Check your {% term "`configuration.yaml`" %} and other YAML files for MQTT-related configurations and remove them
2. Review your automations and scripts for any MQTT dependencies
3. Consider backing up your configuration before making these changes

1
source/_integrations/nam.markdown
View File

@ -21,6 +21,7 @@ The Nettigo Air Monitor integration allows you to read temperature, humidity, pr
The integration currently has support for the following sensors:
- BH1750
- BME280
- BMP180
- BMP280

2
source/_integrations/ness_alarm.markdown
View File

@ -124,7 +124,7 @@ Trigger an aux output. This requires PCB version 7.8 or higher.
| Data attribute | Optional | Description |
| ---------------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `output_id` | No | The aux output you wish to change. A number from 1-4. |
| `output_id` | No | The aux output you wish to change. A number from 1-8. |
| `state` | Yes | The On/Off State, represented as true/false. Default is true. If P14xE 8E is enabled then a value of true will pulse output x for the time specified in P14(x+4)E. |
### Action `panic`

19
source/_integrations/nibe_heatpump.markdown
View File

@ -25,25 +25,26 @@ The Nibe Heat Pump integration allows you to control and monitor [Nibe Heat Pump
Supported devices:
- F1145/F1155
- S1145/S1155
- F1245/F1255
- F1355/F1355
- F1145/F1245
- F1155/F1255
- S1155/S1255
- F1345
- F1355
- S2125
- S320/S325
- S330/S332
- F370
- F470
- F730
- S735
- F750
- S1156
- S1255
- S1256
- SMO40
- SMOS40
- VVM225
- VVM310
- VVM320
- VVM325
- VVM500
- VVM225/VVM320/VVM325
- VVM310/VVM500
{% include integrations/config_flow.md %}

2
source/_integrations/number.markdown
View File

@ -51,7 +51,7 @@ The following device classes are supported for numbers:
- **data_rate**: Data rate in bit/s, kbit/s, Mbit/s, Gbit/s, B/s, kB/s, MB/s, GB/s, KiB/s, MiB/s or GiB/s
- **data_size**: Data size in bit, kbit, Mbit, Gbit, B, kB, MB, GB, TB, PB, EB, ZB, YB, KiB, MiB, GiB, TiB, PiB, EiB, ZiB or YiB
- **distance**: Generic distance in km, m, cm, mm, mi, nmi, yd, or in
- **duration**: Duration in d, h, min, s, or ms
- **duration**: Duration in d, h, min, s, ms, or µs
- **energy**: Energy in J, kJ, MJ, GJ, mWh, Wh, kWh, MWh, GWh, TWh, cal, kcal, Mcal, or Gcal
- **energy_distance**: Energy per distance in kWh/100km, mi/kWh or km/kWh.
- **energy_storage**: Stored energy in J, kJ, MJ, GJ, mWh, Wh, kWh, MWh, GWh, TWh, cal, kcal, Mcal, or Gcal

37
source/_integrations/nut.markdown
View File

@ -2,7 +2,9 @@
title: Network UPS Tools (NUT)
description: Instructions on how to set up NUT sensors within Home Assistant.
ha_category:
- Button
- System monitor
- Switch
ha_iot_class: Local Polling
ha_release: 0.34
ha_domain: nut
@ -14,8 +16,10 @@ ha_codeowners:
- '@tdfountain'
ha_zeroconf: true
ha_platforms:
- button
- diagnostics
- sensor
- switch
ha_integration_type: device
related:
- url: https://www.networkupstools.org
@ -59,6 +63,39 @@ Password:
description: "The password associated with the username to log into the NUT server. This is configured in NUT."
{% endconfiguration_basic %}
## Supported functionality
{% important %}
The username and password configured for the device must be granted
`instcmds` permissions on the NUT server to use buttons and
switches. Buttons and switches will not be available if user
credentials are not specified. See the [NUT server
documentation](https://networkupstools.org/documentation.html) for
configuration information.
{% endimportant %}
### Buttons
This NUT integration will add buttons for NUT server commands
available for your device.
The following buttons are available for each switchable outlet:
| name | Description |
|---------------------------|:------------------------------------------------|
| Power cycle outlet `name` | Power cycle the named outlet |
### Switches
This NUT integration will add switches for NUT server commands
available for your device.
The following switches are available for each switchable outlet:
| name | Description |
|---------------------------|:------------------------------------------------|
| Power outlet `name` | Turn power on/off for named outlet |
## Data updates
The integration uses {% term polling %} to retrieve data from the NUT

49
source/_integrations/ogemray.markdown Normal file
View File

@ -0,0 +1,49 @@
---
title: Ogemray
description: Integrate Ogemray (Powered by Shelly) devices
ha_category:
- Binary sensor
- Climate
- Cover
- Energy
- Event
- Light
- Number
- Select
- Sensor
- Switch
- Text
- Update
- Valve
ha_release: '0.115'
ha_codeowners:
- '@balloob'
- '@bieniu'
- '@thecode'
- '@chemelli74'
- '@bdraco'
ha_iot_class: Local Push
ha_domain: ogemray
ha_config_flow: true
ha_zeroconf: true
ha_platforms:
- binary_sensor
- button
- climate
- cover
- diagnostics
- event
- light
- number
- select
- sensor
- switch
- text
- update
- valve
ha_integration_type: virtual
ha_supporting_domain: shelly
ha_supporting_integration: Shelly
---
{% include integrations/supported_brand.md %}

14
source/_integrations/ohme.markdown
View File

@ -73,6 +73,9 @@ The Ohme integration provides the following entities.
- **Charger mode**
- **Description**: Sets the mode of the charger. Possible options: `Smart charge`, `Max charge`, `Paused`. This is only available with a vehicle plugged in.
- **Available for devices**: all
- **Vehicle**
- **Description**: Select the vehicle to charge. This will show vehicles configured in the Ohme app.
- **Available for devices**: all
#### Sensors
@ -100,6 +103,9 @@ The Ohme integration provides the following entities.
#### Switches
- **Price cap**
- **Description**: Prevents charging when the electricity price exceeds a defined threshold. The threshold can be set by the service `ohme.set_price_cap`. ***Not available with some energy providers and tariffs.***
- **Available for devices**: all
- **Lock buttons**
- **Description**: Disable the controls on the device.
- **Available for devices**: all
@ -128,6 +134,14 @@ The `ohme.list_charge_slots` action is used to fetch a list of charge slots from
|------------------------|----------|--------------------------------------------------------------|
| `config_entry` | No | The config entry of the account to get the charge list from. |
### Action: Set price cap
The `ohme.set_price_cap` action is used to set the price cap threshold. This can be toggled by the switch **Price cap**.
| Data attribute | Optional | Description |
|------------------------|----------|-------------------------------------------------------------|
| `config_entry` | No | The config entry of the account to apply the price cap to. |
| `price_cap` | No | Threshold in 1/100ths of your local currency. |
## Removing the integration

21
source/_integrations/onedrive.markdown
View File

@ -18,7 +18,7 @@ ha_platforms:
- sensor
---
This integration allows you to use [Microsoft OneDrive](https://www.microsoft.com/en-us/microsoft-365/onedrive/online-cloud-storage) for [Home Assistant Backups](/common-tasks/general/#backups).
This integration allows you to use [OneDrive](https://www.microsoft.com/en-us/microsoft-365/onedrive/online-cloud-storage) for [Home Assistant Backups](/common-tasks/general/#backups) as well as uploading generic files to your OneDrive.
Backups will be created in a folder called `Home Assistant\backups_<id>` in the `App Folder` of your OneDrive by default.
`id` is part of your Home Assistant instance's unique id to allow backups from multiple instances to the same OneDrive account.
@ -85,6 +85,25 @@ The integration provides the following sensors, which are updated every 5 minute
A drive that is in **Drive state** `Exceeded` will be automatically frozen (meaning you can't upload any more backups & files), until you clear up enough storage.
{% endnote %}
## Actions
This integration provides the following actions:
### Action `onedrive.upload`
You can use the `onedrive.upload` action to upload files from Home Assistant
to OneDrive. For example, to upload `camera` snapshots.
{% details "Upload action details" %}
| Data attribute | Optional | Description | Example |
| ---------------------- | -------- | ----------- | --------|
| `filename` | no | Path to the file to upload. | /media/image.jpg |
| `destination_folder` | no | Folder inside your `Apps/Home Assistant` app folder that is the destination for the uploaded content. Will be created if it does not exist. Supports subfolders. | Snapshots/2025 |
| `config_entry_id` | no | The ID of the OneDrive config entry (the OneDrive you want to upload to). | a1bee602deade2b09bc522749bbce48e |
{% enddetails %}
## Automations
Get started with these automation examples.

60
source/_integrations/openai_conversation.markdown
View File

@ -151,3 +151,63 @@ template:
```
{% endraw %}
### Service `openai_conversation.generate_content`
Allows you to ask OpenAI to generate a content based on a prompt. This service
populates [Response Data](/docs/scripts/service-calls#use-templates-to-handle-response-data)
with the response from OpenAI.
- **Service data attribute**: `config_entry`
- **Description**: Integration entry ID to use.
- **Example**:
- **Optional**: no
- **Service data attribute**: `prompt`
- **Description**: The text to generate content from.
- **Example**: Describe the weather
- **Optional**: no
- **Service data attribute**: `image_filename`
- **Description**: List of file names for images to include in the prompt.
- **Example**: /tmp/image.jpg
- **Optional**: yes
{% raw %}
```yaml
service: openai.generate_content
data:
config_entry: abce6b8696a15e107b4bd843de722249
prompt: >-
Very briefly describe what you see in this image from my doorbell camera.
Your message needs to be short to fit in a phone notification. Don't
describe stationary objects or buildings.
image_filename:
- /tmp/doorbell_snapshot.jpg
response_variable: generated_content
```
{% endraw %}
The response data field `text` will contain the generated content.
Another example with multiple images:
{% raw %}
```yaml
service: openai.generate_content
data:
prompt: >-
Briefly describe what happened in the following sequence of images
from my driveway camera.
image_filename:
- /tmp/driveway_snapshot1.jpg
- /tmp/driveway_snapshot2.jpg
- /tmp/driveway_snapshot3.jpg
- /tmp/driveway_snapshot4.jpg
response_variable: generated_content
```
{% endraw %}

8
source/_integrations/pglab.markdown
View File

@ -2,7 +2,9 @@
title: PG LAB Electronics
description: Instructions on how to integrate PG LAB Electronics with Home Assistant.
ha_category:
- Cover
- Switch
- Sensor
ha_release: '2025.3'
ha_iot_class: Local Push
ha_config_flow: true
@ -10,7 +12,9 @@ ha_codeowners:
- '@pglab-electronics'
ha_domain: pglab
ha_platforms:
- cover
- switch
- sensor
ha_integration_type: integration
ha_quality_scale: bronze
---
@ -50,9 +54,11 @@ Configure each PG LAB Electronics devices following these steps:
## Supported features
PG LAB Electronics relays, shutters, and switches are supported.
PG LAB Electronics relays, sensors, and switches are supported.
- PG LAB Relays will be added as Home Assistant `switch` entities.
- PG LAB Shutters will be added as Home Assistant `cover` entities.
- PG LAB Sensors will be added as Home Assistant `sensor` entities.
- The integration will also create diagnostic status sensors, with device different information.
## Removing the integration

58
source/_integrations/pterodactyl.markdown Normal file
View File

@ -0,0 +1,58 @@
---
title: Pterodactyl
description: Instructions on how to integrate a Pterodactyl server into Home Assistant.
ha_release: 2025.4
ha_category:
- Binary sensor
ha_iot_class: Local Polling
ha_config_flow: true
ha_codeowners:
- '@elmurato'
ha_domain: pterodactyl
ha_platforms:
- binary_sensor
ha_integration_type: integration
ha_quality_scale: bronze
---
[Pterodactyl](https://www.pterodactyl.io) is a game server management panel designed to simplify the administration of game servers. It offers a user-friendly interface which allows users to manage multiple game servers from a single dashboard, supporting popular games like Minecraft. Its key features include an intuitive web-based control panel, automated server installation, real-time server monitoring, scheduled backups and more. Each game server runs in an isolated Docker container, ensuring security and stability.
The Pterodactyl {% term integration %} allows you to monitor your game servers of your Pterodactyl server within Home Assistant.
## Prerequisites
To access your Pterodactyl server, an account API key is required. Follow these steps to create a new one:
- Access your **Pterodactyl Panel** and log in with your user account.
- From the main dashboard, click your **username** or **profile icon** in the top-right corner, then select **API Credentials**.
- Enter a **Description** to identify the key (for example, "Home Assistant").
- Optionally, specify **Allowed IPs** to restrict where the key can be used (leave blank to allow all IPs).
- Click **Create**. The panel will generate and display your new account API key.
- Copy the **account API key** immediately and store it securely. You won’t be able to view it again after leaving the page.
{% important %}
Pterodactyl has two different types of API keys: Account and Application. Application API keys are not supported, an account API key as described above is required instead.
{% endimportant %}
{% include integrations/config_flow.md %}
During setup, you will be prompted to enter the **URL** and the **account API key** of the server.
{% configuration_basic %}
URL:
description: "The URL of your Pterodactyl server, including the protocol (`http://` or `https://`) and optionally the port number. Example: `http://192.168.0.123:8080`"
Account API key:
description: "The account API key for accessing your Pterodactyl server (see prerequisites)."
{% endconfiguration_basic %}
## Binary sensors
This integration provides a binary sensor with the following information for each game server of your Pterodactyl server:
- Status: `Running` or `Not running`
## Removing the integration
This integration follows standard integration removal. No extra steps are required.
{% include integrations/remove_device_service.md %}

11
source/_integrations/pyload.markdown
View File

@ -39,8 +39,7 @@ If you haven't set up pyLoad yet, an easy way to get it up and running is by ins
- During the setup process in Home Assistant, you will need:
- pyLoad account credentials – A valid *username* and *password* to authenticate with pyLoad.
- The {% term host %} of the device running pyLoad.
- The port number that pyLoad is listening on (default is usually `8000`).
- The full URL of your pyLoad web interface, including the protocol (HTTP or HTTPS), hostname or IP address, port (pyLoad uses 8000 by default), and any path prefix if applicable.
{% note %}
@ -53,12 +52,8 @@ The account used for integration must either be an admin account or one with at
### Configuration parameters
{% configuration_basic %}
Host:
description: "The hostname or IP address of the device running your pyLoad instance."
Port:
description: "The port of the pyLoad instance. pyLoad uses port 8000 by default."
Uses an SSL Certificate:
description: "If enabled, the connection to the pyLoad instance will use HTTPS."
URL:
description: "The full URL of the pyLoad web interface, including the protocol (HTTP or HTTPS), hostname or IP address, port, and any path prefix if applicable. Example: `https://example.com:8000/path`"
Verify SSL certificate:
description: "If checked, the SSL certificate will be validated to ensure a secure connection."
Username:

7
source/_integrations/qbus.markdown
View File

@ -2,8 +2,11 @@
title: Qbus
description: Instructions on how to integrate your Qbus installation with Home Assistant.
ha_category:
- Climate
- Light
- Switch
ha_platforms:
- climate
- light
- switch
ha_iot_class: Local Push
@ -38,11 +41,13 @@ There is currently support for the following **Qbus** products within Home Assis
- **CTD01E to CTD03E (CTD 3.0)**: main controllers (yellow).
- **CTD10 to CTDMax (CTD 3.5)**: main controllers (black).
- **Toggle**: toggle outputs on controllers.
- **Dimmer**: dimmer outputs on controllers.
## Available entities
- **Switch**: toggles on/off outputs.
- **Climate**: manages thermostats by setting temperature and choosing presets.
- **Light**: controls dimmer lights, allowing both on/off functionality and brightness adjustment.
- **Switch**: toggles on/off outputs.
## Removing the integration

60
source/_integrations/remote_calendar.markdown Normal file
View File

@ -0,0 +1,60 @@
---
title: Remote calendar
description: Instructions on how to use remote calendars in Home Assistant.
ha_category:
- Calendar
ha_iot_class: Cloud Polling
ha_release: 2025.04
ha_config_flow: true
ha_domain: remote_calendar
ha_platforms:
- calendar
ha_codeowners:
- '@Thomas55555'
ha_integration_type: service
---
The **Remote calendar** {% term integration %} allows you to read a calendar in Home Assistant for powering automations.
## Known limitations
The integration does not provide the ability to connect to an resource that requires authentication or special headers.
## Installation instructions
{% include integrations/config_flow.md %}
Please provide the following information to the config flow.
{% configuration_basic %}
Calendar Name:
description: "A name for your calendar, you can choose a name you want.
Example: `Home Assistant Events`"
Calendar URL:
description: "The URL of the remote calendar. Example: `https://calendar.google.com/calendar/ical/p07n98go11onamd08d0kmq6jhs%40group.calendar.google.com/public/basic.ics`"
{% endconfiguration_basic %}
## Data updates
At the start of the integration, we fetch data from the remote. If the update fails, the integration tries again to fetch the data. After that, the update interval of the calendar is set to every 24 hours.
### Defining a custom polling interval
{% include common-tasks/define_custom_polling.md %}
## Supported functionality
The integration only supports reading a calendar. A calendar entity has a state and attributes that represent the next upcoming event (only). All the events of the calendar can be displayed in the Calendar dashboard.
## Calendar Event Automations
Individual Calendar *Events* are what powers automations such as:
- Notify me *12 hours before* the *start* of the event named *Garbage collection*.
See [Calendar Automations](/integrations/calendar#automation) for an overview, and read more about [Calendar Trigger Variables](/docs/automation/templating/#calendar) for the available information you can use in a condition or action such as the event `summary`, `description`, `location` and more.
## Removing the integration
This integration follows standard integration removal. No extra steps are required.
{% include integrations/remove_device_service.md %}

26
source/_integrations/reolink.markdown
View File

@ -100,6 +100,17 @@ Depending on the supported features of the camera, binary sensors are added for:
- AI face detection++
- AI package detection++
- AI baby crying detection+ (sound detection)
- AI crossline person+ (up to 3 lines)
- AI crossline vehicle+ (up to 3 lines)
- AI crossline animal+ (up to 3 lines)
- AI intrusion person+ (up to 3 zones)
- AI intrusion vehicle+ (up to 3 zones)
- AI intrusion animal+ (up to 3 zones)
- AI linger person+ (up to 3 zones)
- AI linger vehicle+ (up to 3 zones)
- AI linger animal+ (up to 3 zones)
- AI item forgotten+ (up to 3 zones)
- AI item taken+ (up to 3 zones)
- Sleep status+
\++ These sensors receive events using the following 4 methods (in order): TCP push, ONVIF push, ONVIF long polling or fast polling (every 5 seconds).
@ -107,6 +118,8 @@ The latency for receiving the events is the best for TCP push and the worst for
For redundancy, these sensors are polled every 60 seconds together with the update of all other entities.
To ensure you have the best latency possible, refer to the [Reducing latency of motion events](#reducing-latency-of-motion-events) section.
For the **crossline**, **intrusion**, **linger**, **item forgotten**, and **item taken** entities, you first need to configure the lines/zones in the Reolink app (**Settings** > **Detection alarm** > **Smart event detection**). In the Reolink app, you can add up to 3 zones/lines, and for each zone/line, you can enable/disable the person/vehicle/animal detection. Within 60 seconds after making a change in the Reolink app, the corresponding entities will automatically show up in Home Assistant.
### Number entities
Depending on the supported features of the camera, number entities are added for:
@ -127,12 +140,21 @@ Depending on the supported features of the camera, number entities are added for
- AI package sensitivity
- AI pet sensitivity
- AI animal sensitivity
- AI crossline sensitivity+ (up to 3 lines)
- AI intrusion sensitivity+ (up to 3 zones)
- AI linger sensitivity+ (up to 3 zones)
- AI item forgotten sensitivity+ (up to 3 zones)
- AI item taken sensitivity+ (up to 3 zones)
- AI face delay*
- AI person delay*
- AI vehicle delay*
- AI package delay*
- AI pet delay*
- AI animal delay*
- AI intrusion delay+ (up to 3 zones)
- AI linger delay+ (up to 3 zones)
- AI item forgotten delay+ (up to 3 zones)
- AI item taken delay+ (up to 3 zones)
- Auto quick reply time
- Auto track limit left
- Auto track limit right
@ -207,11 +229,14 @@ Depending on the supported features of the camera, select entities are added for
- Chime visitor ringtone
- Hub alarm ringtone
- Hub visitor ringtone
- Hub scene mode (Off, Disarmed, Home, Away)
**PTZ preset** positions can be set in the Reolink app/windows/web client, the names of the presets will be loaded into Home Assistant at the start of the integration. When adding new preset positions, please restart the Reolink integration.
**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.
**Hub scene modes** can be set in the Reolink app/client. The scene names are loaded into Home Assistant at the start of the integration. After adding new custom scenes, restart the Reolink integration.
#### Action reolink.play_chime
To play a ringtone on a Reolink chime, the `reolink.play_chime` action can be used.
@ -281,6 +306,7 @@ Depending on the supported features of the camera, the following sensor entities
- PTZ pan position
- PTZ tilt position
- Day night state+
- Wi-Fi signal*
- CPU usage*
- HDD/SD storage*

345
source/_integrations/sensibo.markdown
View File

@ -33,7 +33,7 @@ ha_dhcp: true
ha_integration_type: integration
---
Integrates [Sensibo](https://sensibo.com) devices into Home Assistant.
The **Sensibo** {% term integration %} integrates [Sensibo](https://sensibo.com) devices into Home Assistant.
## Prerequisites
@ -45,127 +45,180 @@ then in the Sensibo app log you will be able to distinguish between actions
done in the app and actions done by Home Assistant.
{% endtip %}
## Supported devices
The **Sensibo** {% term integration %} supports the following devices and accessories.
- **Sensibo Sky**: Smart AC control device.
- **Sensibo Air**: Smart AC control device.
- **Sensibo Air Pro**: Smart AC control device with air quality monitoring.
- **Sensibo Pure**: Smart air purifier.
- **Sensibo Elements**: Smart air quality monitoring.
- **Sensibo Room Sensor**: Motion sensor and temperature readings (needs to be connected with an Air device).
{% include integrations/config_flow.md %}
## Binary sensors
{% configuration_basic %}
API key:
description: The previously created API key.
{% endconfiguration_basic %}
For motion sensors (supported by Sensibo Air devices), this integration provides the following sensors:
## Supported functionality
- Motion
- Alive
- Main sensor
{% note %}
For climate devices, these sensors are available:
Some entities are disabled by default, so you need to [enable them](/common-tasks/general/#to-enable-or-disable-a-single-entity) to use them.
- Room presence (for Air devices with an attached motion sensor)
Depending on device support, some entities might not be available as the device does not support them.
For Pure devices, these sensors are available:
{% endnote %}
- Pure Boost Enabled
- Pure Boost linked with AC
- Pure Boost linked with Presence
- Pure Boost linked with Outdoor Air Quality
### Sensibo Sky, Air, Air Pro, Pure, Elements and Room sensor
For all devices, these sensors are available:
#### Numbers
- Filter Clean Required
- **Temperature calibration**: Calibrate the temperature reading of the device.
- **Humidity calibration**: Calibrate the humidity reading of the device.
## Button
#### Updates
You can reset your filter check by using the button available on climate devices.
- **Firmware**: Firmware update available.
By pressing the button, you tell your device that you have cleaned or replaced the filter.
### Sensibo Sky, Air, Air Pro, Pure, and Elements
## Number entities
#### Binary sensors
By using the number entities you can calibrate the temperature and hunmidity of your device.
- **Filter clean required**: Does the A/C's filter need cleaning.
These entities are disabled by default.
#### Buttons
## Select entities
- **Reset filter**: Reset the filter timer after cleaning.
For supported devices, this integration provides support to set the following modes by the select entity:
#### Climates
- Light
- **[Name of device]**: The main climate entity for the device to control <abbr title="Heating, ventilation, and air conditioning">HVAC</abbr> mode.
## Sensor entities
#### Selects
For all devices, these sensors are available:
- **Light**: Turn the light on/off or dim for the device.
- Filter last reset
- Feels Like
- Timer end time
#### Sensors
For motion sensors (supported by Sensibo Air devices), this integration provides the following sensors:
- **Filter last reset**: Last reset of the filter cleaning.
- Temperature
- Humidity
### Sensibo Sky, Air, and Air Pro
For diagnostics, not automatically displayed on dashboards, these sensors are available for motion sensors:
#### Sensors
- Voltage
- Rssi
- **Feels like**: Feels like temperature.
- **Timer end time**: End time of timer.
- **Climate React type**: Climate React type: Temperature, Feels like, or Humidity.
- **Climate React low temperature threshold**: Low temperature threshold setting for Climate react.
- **Climate React high temperature threshold**: High temperature threshold setting for Climate react.
For Pure devices, these sensors are available:
#### Switches
- PM2.5
- Pure Boost Sensitivity
- **Timer**: Timer on/off. Enabling the timer, sets it to 10 minutes.
- **Climate React**: Enable/Disable Climate React.
For AirQ device, these sensors are available:
### Sensibo Air, Air Pro, and Elements
- TVOC
- CO2
#### Sensors
For Element device, these sensors are available:
- **TVOC**: TVOC reading from device.
- **Co2**: Co2 reading from device.
- PM 2.5
- TVOC
- CO2
- Ethanol
- Air quality
### Sensibo Elements
For climate devices, these sensors are available:
#### Sensors
- Climate React low temperature threshold
- Climate React high temperature threshold
- **PM2.5**: PM2.5 reading from device.
- **Ethanol**: Ethanol reading from device.
- **Air quality**: Air quality based on readings from device.
## Switch entities
### Sensibo Pure
For climate devices, these switches are available:
#### Binary sensors
Support to enable/disable a timer to delay a start or stop (depending on the current state) of your device.
- **Pure Boost linked with AC**: Is Pure Boost linked with an A/C device.
- **Pure Boost linked with presence**: Is Pure Boost linked to presence.
- **Pure Boost linked with indoor air quality**: Is Pure Boost linked with indoor air quality.
- **Pure Boost linked with outdoor air quality**: Is Pure Boost linked with outdoor air quality.
The switch uses a timer of 60 minutes delay. You can choose a custom delay using the custom `sensibo.enable_timer` action. See [Timer](#timer).
#### Sensors
Support to enable/disable Climate React
- **Pure AQI**: PM2.5 level indicated as 'Good', 'Moderate', and 'Bad'.
- **Pure Boost Sensitivity**: Sensitivity for Pure Boost.
Usage of the Climate React switch requires that the action has been configured previously in the app or by using the custom `sensibo.enable_climate_react` action. See [Climate React](#climate-react)
#### Switches
For Pure devices, this integration provides support to enable/disable Pure Boost.
- **Pure Boost**: Enable/Disable Pure Boost.
To customize the settings of Pure Boost, you can use the custom `sensibo.enable_pure_boost` action. See [Pure Boost](#pure-boost)
### Sensibo Room sensor
## Custom actions
#### Binary sensors
- **Motion**: Is there motion
- **Connectivity**: Is the motion sensor alive and connected
- **Main sensor**: Is the connected motion sensor the main sensor for the connected Air device.
- **Room occupied**: Is there presence in the room of the connected Air device.
## Actions
### Get device mode capabilities
As the below custom actions [Full state](#full-state) and [Climate react](#climate-react) both require their inputs to be exactly what the API requires, this custom action will provide the capabilities for the device for a certain HVAC mode to help the users on using those actions properly.
As the below custom actions [Full state](#set-full-state) and [Climate react](#enable-climate-react) both require their inputs to match the API requirements precisely, this custom action will provide the capabilities for the device for a certain HVAC mode to help the users on using those actions properly.
**Action configuration:**
{% configuration_basic %}
Target:
description: Select the Sensibo climate entity.
HVAC mode:
description: Select the HVAC mode for which you want to get the capabilities.
{% endconfiguration_basic %}
**Proposed action use:**
1. Go to [Developer Tools](https://my.home-assistant.io/redirect/server_controls/).
2. Switch to the **Actions** page.
3. Use the `sensibo.get_device_capabilities` action.
4. Select the `climate` entity as the target.
5. Select the `hvac_mode` from the available list.
6. Select **Perform action** to retrieve the available options per capability for that particular `climate` entity.
6. Select **Perform action** to retrieve the available options.
7. Copy the case-sensitive options as needed to other action calls, automations or scripts.
From the provided dictionary, copy the case-sensitive options as needed into other action calls used in automations or scripts.
### Set full state
### Full state
You can send a full state command to **Sensibo** instead of single commands using the `sensibo.full_state` action.
You can send a full state command to Sensibo instead of single commands using the `sensibo.full_state` action.
{% note %}
All fields are required to be according to Sensibo API specifications and are case-sensitive.
Only provide the fields which are supported by the device.
{% endnote %}
**Action configuration:**
{% configuration_basic %}
Target:
description: Select the Sensibo climate entity.
HVAC mode:
description: Select the HVAC mode for which you want to get the capabilities.
Target temperature:
description: Provide a target temperature if applicable.
Fan mode:
description: Provide a fan mode if applicable.
Swing mode:
description: Provide a swing mode if applicable.
Horizontal swing mode:
description: Provide a horizontal swing mode if applicable.
Light:
description: Provide a setting for the light if applicable.
{% endconfiguration_basic %}
{% tip %}
Use the [Get device mode capabilities](#get-device-mode-capabilities) action to provide a list of capabilities.
@ -174,29 +227,88 @@ Use the [Get device mode capabilities](#get-device-mode-capabilities) action to
### Assume state
For devices which are also controlled in other ways or often goes out of sync with Sensibo there is a `sensibo.assume_state` action.
An HVAC device often has a manual remote or other means of control which can put **Sensibo** out of sync with the HVAC device.
With this action you can tell Sensibo if your device is currently running or not without sending a new command to you device.
Use the `sensibo.assume_state` action to tell **Sensibo** if the HVAC device is currently on or off without sending a control to the actual device.
### Pure Boost
**Action configuration:**
{% configuration_basic %}
Target:
description: Select the Sensibo climate entity.
State:
description: Select if the HVAC device is on or off.
{% endconfiguration_basic %}
### Enable Pure Boost
You can configure your Pure Boost settings using the `sensibo.enable_pure_boost` action.
- Enable Pure Boost will enable the action with configured settings
{% note %}
Using Geo integration for Pure Boost is only possible by pre-configuration of Presence within the app.
AC integration and Geo integration needs to be pre-configured via the app before first use.
### Timer
{% endnote %}
You can enable a timer with a custom delay using the `sensibo.enable_timer` action that is provided.
**Action configuration:**
### Climate React
{% configuration_basic %}
Target:
description: Select the Sensibo climate entity.
AC integration:
description: Integrate with a HVAC device.
Geo integration:
description: Integrate with presence.
Indoor air quality:
description: Integrate with indoor air quality.
Outdoor air quality:
description: Integrate with outdoor air quality.
Sensitivity:
description: Set the sensitivity to `Normal` or `Sensitive`.
{% endconfiguration_basic %}
### Enable timer
You can enable a timer to turn the HVAC device on or off for a certain time, using the `sensibo.enable_timer` action that is provided.
**Action configuration:**
{% configuration_basic %}
Target:
description: Select the Sensibo climate entity.
Minutes:
description: Number of minutes to turn the device on or off.
mandatory: true
{% endconfiguration_basic %}
### Enable Climate React
You can configure your Climate React settings using the `sensibo.enable_climate_react` action.
- Configuring this action also turns Climate React on
{% note %}
When using the action, the state needs to be set to precisely what Sensibo API expects. The first time it's recommended to use the app to configure it.
Configuring this action also turns Climate React on.
When using the action, the state needs to be set to precisely what Sensibo API expects. The first time, it's recommended to use the app to configure it.
{% endnote %}
**Action configuration:**
{% configuration_basic %}
Target:
description: Select the Sensibo climate entity.
Threshold high:
description: When the trigger goes above this value.
State high threshold:
description: The full state to configure above the high threshold.
Threshold low:
description: When the trigger goes below this value.
State low threshold:
description: The full state to configure below the low threshold.
Trigger type:
description: The trigger type (`temperature`, `feelsLike`, or `humidity`).
{% endconfiguration_basic %}
{% tip %}
@ -204,7 +316,7 @@ Use the [Get device mode capabilities](#get-device-mode-capabilities) action to
{% endtip %}
Example for low threshold state:
**Example full state:**
{% raw %}
@ -221,9 +333,11 @@ light: "on"
{% endraw %}
## Adding a quick switch example
## Examples
If you want a "Quick Switch" to turn your AC On / Off, you can do that using the following `Switch Template`:
### Template switch to turn HVAC device on or off
A simple switch which has `heat` or `off` as mode.
{% raw %}
@ -233,13 +347,13 @@ switch:
switches:
ac:
friendly_name: "AC"
value_template: "{{ is_state('climate.ac', 'cool') or is_state('climate.ac', 'heat') or is_state('climate.ac', 'dry') or is_state('climate.ac', 'fan_only') }}"
value_template: "{{ is_state('climate.ac', 'heat') }}"
turn_on:
action: climate.set_hvac_mode
target:
entity_id: climate.ac
data:
hvac_mode: "cool"
hvac_mode: "heat"
turn_off:
action: climate.set_hvac_mode
target:
@ -249,3 +363,76 @@ switch:
```
{% endraw %}
### Start the timer for 30 minutes when I get home
{% raw %}
```yaml
automation:
alias: "Example timer"
triggers:
- trigger: zone
entity_id: person.me
zone: zone.home
event: enter
actions:
- action: sensibo.enable_timer
data:
minutes: 30
target:
entity_id: climate.hvac_device
```
{% endraw %}
### Set a full state of the HVAC device at 6pm
{% raw %}
```yaml
automation:
alias: "Example full state"
triggers:
- trigger: time
at: "18:00:00"
actions:
- action: sensibo.full_state
data:
mode: "heat"
target_temperature: 23
fan_mode: "medium"
swing_mode: "fixedMiddleTop"
horizontal_swing_mode: "fixedCenter"
light: "off"
target:
entity_id: climate.hvac_device
```
{% endraw %}
## Data fetching and limitations
Data is {% term polling polled %} from the **Sensibo** API once every minute for all devices.
If {% term polling %} cannot happen because of no connectivity or a malfunctioning API, it will retry a few times before failing.
The user can use the [`homeassistant.update_entity`](homeassistant#action-homeassistantupdate_entity) action to manually try again later, in the case the user has solved the connectivity issue.
## Troubleshooting
This service is reliant on an internet connection and that the **Sensibo** API is available. Here are the things you can try before raising an issue:
- Check that internet is available in your Home Assistant instance.
- Check that the **Sensibo** API is available by accessing the [Sensibo API page](https://home.sensibo.com/api/v1/users/me). If you have previously logged in to Sensibo web, you will get a JSON back with the provided information about your account. If not logged in, the API will respond with `login_required`.
- Use `curl` in a terminal on your Home Assistant instance using the same URL as previously opened in the browser. `curl https://home.sensibo.com/api/v1/users/me`
### Specific log entries
**Log entry:** `Device [name of device] not correctly registered with remote on Sensibo cloud.`
When setting up a device the first time, a `remote` needs to be defined for the device in the **Sensibo** app, either automatically or manually.
The device will appear in Home Assistant, but won't be usable as no HVAC modes can be selected.
## Remove the integration
{% include integrations/remove_device_service.md %}

2
source/_integrations/sensor.markdown
View File

@ -61,7 +61,7 @@ The following device classes are supported for sensors:
- **data_size**: Data size in bit, kbit, Mbit, Gbit, B, kB, MB, GB, TB, PB, EB, ZB, YB, KiB, MiB, GiB, TiB, PiB, EiB, ZiB or YiB
- **date**: Date string (ISO 8601)
- **distance**: Generic distance in km, m, cm, mm, mi, nmi, yd, or in
- **duration**: Duration in d, h, min, s, or ms
- **duration**: Duration in d, h, min, s, ms, or µs
- **energy**: Energy in J, kJ, MJ, GJ, mWh, Wh, kWh, MWh, GWh, TWh, cal, kcal, Mcal, or Gcal
- **energy_distance**: Energy per distance in kWh/100km, mi/kWh or km/kWh.
- **energy_storage**: Stored energy in J, kJ, MJ, GJ, mWh, Wh, kWh, MWh, GWh, TWh, cal, kcal, Mcal, or Gcal

89
source/_integrations/smartthings.markdown
View File

@ -4,29 +4,43 @@ description: Instructions on setting up SmartThings within Home Assistant.
featured: true
ha_category:
- Binary sensor
- Button
- Climate
- Cover
- Event
- Fan
- Hub
- Light
- Lock
- Media player
- Number
- Scene
- Select
- Sensor
- Switch
- Update
- Valve
ha_release: 0.87
ha_iot_class: Cloud Push
ha_config_flow: true
ha_domain: smartthings
ha_platforms:
- binary_sensor
- button
- climate
- cover
- event
- fan
- light
- lock
- media_player
- number
- scene
- select
- sensor
- switch
- update
- valve
ha_dhcp: true
ha_integration_type: integration
---
@ -45,29 +59,41 @@ ha_integration_type: integration
SmartThings represents devices as a set of [capabilities](https://developer.smartthings.com/docs/devices/capabilities/capabilities-reference). The SmartThings integration maps those capabilities to entities in Home Assistant. A single device may be represented by one or more entities.
- [Binary sensor](#binary-sensor)
- [Button](#button)
- [Climate](#climate)
- [Cover](#cover)
- [Fan](#fan)
- [Light](#light)
- [Lock](#lock)
- [Media player](#media-player)
- [Number](#number)
- [Select](#select)
- [Sensor](#sensor)
- [Scene](#scene)
- [Switch](#switch)
- [Valve](#valve)
### Binary sensor
In Home Assistant, a binary sensor entity will be created for each of the following SmartThings capabilities:
| SmartThings capability |
| --------------------------------------------------------------------------------------------------------------------- |
| `accelerationSensor` |
| [`contactSensor`](https://developer.smartthings.com/docs/devices/capabilities/capabilities-reference#contactSensor) |
| [`filterStatus`](https://developer.smartthings.com/docs/devices/capabilities/proposed#filterStatus) |
| [`motionSensor`](https://developer.smartthings.com/docs/devices/capabilities/capabilities-reference#motionSensor) |
| [`presenceSensor`](https://developer.smartthings.com/docs/devices/capabilities/capabilities-reference#presenceSensor) |
| [`tamperAlert`](https://developer.smartthings.com/docs/devices/capabilities/capabilities-reference#tamperAlert) |
| [`valve`](https://developer.smartthings.com/docs/devices/capabilities/capabilities-reference#valve) |
| [`waterSensor`](https://developer.smartthings.com/docs/devices/capabilities/capabilities-reference#waterSensor) |
| SmartThings capability |
|---------------------------------------------------------------------------------------------------------------------------------|
| `accelerationSensor` |
| [`contactSensor`](https://developer.smartthings.com/docs/devices/capabilities/capabilities-reference#contactSensor) |
| [`filterStatus`](https://developer.smartthings.com/docs/devices/capabilities/proposed#filterStatus) |
| [`motionSensor`](https://developer.smartthings.com/docs/devices/capabilities/capabilities-reference#motionSensor) |
| [`presenceSensor`](https://developer.smartthings.com/docs/devices/capabilities/capabilities-reference#presenceSensor) |
| `samsungce.kidsLock` |
| `switch` (only for dryers and washers) |
| [`remoteControlStatus`](https://developer.smartthings.com/docs/devices/capabilities/capabilities-reference#remoteControlStatus) |
| [`tamperAlert`](https://developer.smartthings.com/docs/devices/capabilities/capabilities-reference#tamperAlert) |
| [`valve`](https://developer.smartthings.com/docs/devices/capabilities/capabilities-reference#valve) |
| [`waterSensor`](https://developer.smartthings.com/docs/devices/capabilities/capabilities-reference#waterSensor) |
### Button
The SmartThings Button platform provides stop buttons for devices with the `ovenOperatingState` capability.
### Climate
@ -111,6 +137,10 @@ The SmartThings Cover platform lets you control devices that have open/close rel
| [`windowShadeLevel`](https://developer.smartthings.com/docs/devices/capabilities/capabilities-reference/#windowShadeLevel) | `position` |
| [`battery`](https://developer.smartthings.com/docs/devices/capabilities/capabilities-reference#battery) | `battery_level` (state attribute) |
### Event
The SmartThings Event platform will create entities for every button. It will show any button presses and allows you to automate on these events.
### Fan
The SmartThings Fan lets you control devices that have fan-related capabilities. For a SmartThings device to be represented by the fan entity, it must have one or more of the capabilities below in addition to the [`switch`](https://smartthings.developer.samsung.com/develop/api-ref/capabilities.html#Switch) capability.
@ -133,6 +163,29 @@ The SmartThings Light lets you control devices that have light-related capabilit
The SmartThings Lock platform lets you control devices that have the [`lock`](https://developer.smartthings.com/docs/devices/capabilities/capabilities-reference#lock) capability, showing current lock status and supporting lock and unlock commands.
### Media player
The SmartThings Media player lets you control devices that have media player-related capabilities. For a SmartThings device to be represented by the media player entity, it must have all required capabilities.
| SmartThings capability | Related media player features in Home Assistant |
| --------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- |
| [`audioMute`](https://developer.smartthings.com/docs/devices/capabilities/capabilities-reference#audioMute) (required) | `volume_mute` |
| [`audioTrackData`](https://developer.smartthings.com/docs/devices/capabilities/capabilities-reference#audioTrackData) (required) | `media_title` and `media_artist` |
| [`audioVolume`](https://developer.smartthings.com/docs/devices/capabilities/capabilities-reference#audioVolume) (required) | `volume_up`, `volume_down`, `volume_set` |
| [`mediaPlayback`](https://developer.smartthings.com/docs/devices/capabilities/capabilities-reference#mediaPlayback) (required) | `media_play`, `media_pause`, `media_stop`, `media_next_track`, `media_previous_track` |
| [`mediaInputSource`](https://developer.smartthings.com/docs/devices/capabilities/capabilities-reference#mediaInputSource) | `select_source` |
| [`mediaPlaybackRepeat`](https://developer.smartthings.com/docs/devices/capabilities/capabilities-reference#mediaPlaybackRepeat) | `repeat_set` |
| [`mediaPlaybackShuffle`](https://developer.smartthings.com/docs/devices/capabilities/capabilities-reference#mediaPlaybackShuffle) | `shuffle_set` |
| [`switch`](https://developer.smartthings.com/docs/devices/capabilities/capabilities-reference#switch) | `turn_on`, `turn_off` |
### Number
The SmartThings number platform lets you control the amount of washer rinse cycles.
### Select
The SmartThings Select platform can be used to remotely turn on a dryer and washer. Be aware that for them to work, the Remote control has to be turned on.
### Sensor
The SmartThings Sensor platform lets your view devices that have sensor-related capabilities. A Sensor entity is created for each attribute (below) supported by the device.
@ -189,6 +242,7 @@ The SmartThings Sensor platform lets your view devices that have sensor-related
| [`tvChannel`](https://developer.smartthings.com/docs/devices/capabilities/proposed#tvChannel) | TV channel<br/>TV channel name |
| [`tvocMeasurement`](https://developer.smartthings.com/docs/devices/capabilities/capabilities-reference#tvocMeasurement) | Volatile organic compounds |
| [`ultravioletIndex`](https://developer.smartthings.com/docs/devices/capabilities/capabilities-reference#ultravioletIndex) | UV index |
| [`veryFineDustSensor`](https://developer.smartthings.com/docs/devices/capabilities/capabilities-reference#veryFineDustSensor) | PM1.0 |
| [`voltageMeasurement`](https://developer.smartthings.com/docs/devices/capabilities/capabilities-reference#voltageMeasurement) | Voltage |
| [`washerMode`](https://developer.smartthings.com/docs/devices/capabilities/proposed#washerMode) | Washer mode |
| [`washerOperatingState`](https://developer.smartthings.com/docs/devices/capabilities/proposed#washerOperatingState) | Machine state<br/>Job state<br/>Completion time |
@ -201,6 +255,21 @@ The SmartThings Scene lets you activate scenes defined in SmartThings. A scene e
The SmartThings Switch lets you control devices that have the [`switch`](https://developer.smartthings.com/docs/devices/capabilities/capabilities-reference#switch) capability that are not already represented by a more specific platform.
It will also create switches for the following capabilities:
| SmartThings capability |
|------------------------------|
| `custom.dryerWrinklePrevent` |
### Update
The SmartThings update platform lets you update the firmware of devices that have the [`firmwareUpdate`](https://developer.smartthings.com/docs/devices/capabilities/capabilities-reference#firmwareUpdate) capability.
### Valve
The SmartThings Valve platform lets you control devices that have the [`valve`](https://developer.smartthings.com/docs/devices/capabilities/capabilities-reference#valve) capability, showing the valve status and opening and closing.
## Troubleshooting
### Enabling debug logs and diagnostics

55
source/_integrations/snoo.markdown
View File

@ -2,7 +2,11 @@
title: Happiest Baby Snoo
description: Instructions on how to integrate Snoo into Home Assistant
ha_category:
- Binary Sensor
- Event
- Sensor
- Select
- Switch
ha_iot_class: Cloud Push
ha_release: 2025.3
ha_config_flow: true
@ -10,7 +14,11 @@ ha_codeowners:
- '@Lash-L'
ha_domain: snoo
ha_platforms:
- binary_sensor
- event
- sensor
- select
- switch
ha_integration_type: integration
ha_quality_scale: bronze
---
@ -23,6 +31,30 @@ This integration follows standard integration installation. No extra steps are r
{% include integrations/config_flow.md %}
## Binary Sensors
### Left and right safety clips
States if the left or right safety clip is connected to the baby's swaddle.
## Events
### Snoo events
These are the events broadcasted by your device. The most notable event is your baby crying.
They can be:
- Timer - A timer has started or updated for the current Snoo level.
- Cry - The Snoo has detected your baby crying.
- Command sent - A command has been received by the Snoo.
- Safety clip changed - The left or right safety clip has been disconnected or connected.
- Long activity press - The activity button has been held down.
- Activity press - The activity button has been pressed.
- Power button pressed - The power button has been pressed.
- Status requested - Either the integration or your mobile app has requested a status update.
- Sleepytime sounds updated - The Sleepytime sounds were turned on or off.
## Sensors
### State
@ -40,6 +72,29 @@ The Snoo can have one of 8 states
## Time left
This describes how long until the Snoo will change levels or it is Unknown if it is not currently planning to change levels.
## Select
### Intensity
This allows you to set the soothing level of your Snoo.
1. Baseline - This is the basic state the snoo starts with. It has not detected the need to do any further soothing.
2. Level 1 - This is the lowest level of soothing.
3. Level 2
4. Level 3
5. Level 4
6. Stop - The snoo is no longer running.
## Switch
### Level lock
Keep SNOO’s rhythms locked on your baby’s favorite level (Baseline, Level 1, or Level 2).
### Sleepytime sounds
Allows you to turn on SNOO’s soothing sounds before you put your baby in SNOO or after you took your baby out of SNOO for a diaper change or feeding.
## Removing the integration
{% include integrations/remove_device_service.md %}

23
source/_integrations/squeezebox.markdown
View File

@ -147,6 +147,13 @@ data:
- **Needs restart**: Server Service needs to be restarted (typically, this is needed to apply updates).
- **Library rescan**: The music library is currently being scanned by LMS (depending on the type of scan, some content may be unavailable).
### Buttons
- **Preset 1 ... Preset 6**: Play media stored in Preset 1 to Preset 6 on Squeezebox.
- **Brightness Up, Brightness Down**: Adjust the brightness on Logitech Squeezebox players with built-in screen, such as Radio and Boom.
- **Bass Up, Bass Down**: Adjust the bass on Logitech Squeezebox players, such as Radio and Boom.
- **Treble Up, Treble Down**: Adjust the treble on Logitech Squeezebox players, such as Radio and Boom.
### Sensors
- **Last scan**: Date of the last library scan.
@ -188,10 +195,9 @@ When specifying additional parameters in the Visual Editor, each parameter must
For example, to create an automation to mute playback, use the command `mixer` and the parameter `muting`:
| Row | Parameter | Description |
| --- | -------- | ----------- |
| 1 | - muting | Toggle muting on / off |
| 2 | | |
| Row | Parameter | Description |
| --- | --------- | ---------------------- |
| 1 | - muting | Toggle muting on / off |
resulting in the YAML:
@ -209,10 +215,10 @@ Where a parameter is an increment or decrement, it is necessary to place the val
For example, to increase the playback volume, use the command `mixer` and the parameters `volume` and the amount to increment:
| Row | Parameter | Description |
| --- | -------- | ----------- |
| 1 | - volume | Parameter to change |
| 2 | - "+5" | Increment volume by 5 percent |
| Row | Parameter | Description |
| --- | --------- | ----------------------------- |
| 1 | - volume | Parameter to change |
| 2 | - "+5" | Increment volume by 5 percent |
resulting in the YAML:
@ -227,7 +233,6 @@ data:
- "+5"
```
### Action `call_query`
Call a custom Squeezebox JSON-RPC API. The result of the query will be stored in the 'query_result' attribute of the player.

6
source/_integrations/vesync.markdown
View File

@ -134,6 +134,10 @@ VeSync air purifiers will expose the following details depending on the features
| `night_light` | The current status of the night light (Core200S/Core400s) | off |
| `child_lock` | The current status of the child lock (Core200S/300s/400s) | off |
| Select | Description | Example |
| ----------------------- | ---------------------------------------------------------------------------------- | --------- |
| `night_light_level` | Night light brightness level (Values: off, dim, on). | off |
## Humidifier
Sensors and settings exposed by VeSync humidifiers.
@ -148,7 +152,7 @@ Sensors and settings exposed by VeSync humidifiers.
| Select | Description | Example |
| ----------------------- | ---------------------------------------------------------------------------------- | --------- |
| `night_light_level`| Night light brightness level (Values: off, dim, bright). | off |
| `night_light_level` | Night light brightness level (Values: off, dim, bright). | off |
## Binary Sensors

5
source/_integrations/wallbox.markdown
View File

@ -9,6 +9,7 @@ ha_domain: wallbox
ha_platforms:
- lock
- number
- select
- sensor
- switch
ha_config_flow: true
@ -54,6 +55,10 @@ The number {% term entity %} is only loaded if the supplied username has suffici
The {% term integration %} adds a lock {% term entity %}, allowing you to lock the charger. Please note, this only works with a user with admin rights.
## Select
The {% term integration %} adds a select {% term entity %} to control Solar Charging options, allowing you to choose between Eco Mode, Full Solar or disable Solar Charging.
## Switch
The {% term integration %} adds a switch {% term entity %}, allowing you to pause/resume the charging process.

26
source/_integrations/watergate.markdown
View File

@ -13,6 +13,7 @@ ha_codeowners:
ha_domain: watergate
ha_platforms:
- sensor
- event
- valve
ha_quality_scale: bronze
ha_integration_type: integration
@ -24,6 +25,7 @@ With this integration, you are able to:
- Control your valve
- Monitor live telemetry (water flow, water pressure, water temperature)
- Monitor water usage
- Receive information when Sonic shuts off the valve due to potential leak
## Prerequisites
@ -71,6 +73,16 @@ The Watergate integration provides the following entities.
- **Water valve state**
- **Description**: The current state of the water valve (open/closed).
- **Remarks**: It is automatically updated when the valve state is changed.
#### Events
- **Auto Shut-Off**
- **Description**: Event triggered when the valve automatically shuts off due to detected leak.
- **Event Type**: Either `volume_threshold` or `duration_threshold`
- **Event Data**:
- `volume`: The volume of water that triggered the shut-off
- `duration`: The duration of leak that triggered the shut-off
- **Remarks**: Historical events are not preserved across Home Assistant restarts.
## Data updates
@ -79,7 +91,7 @@ Thanks to the webhook option, Sonic will provide live telemetry every second whe
## Known limitations
The integration does not provide the ability to set auto shut-off thresholds and does not report any events regarding automatically closed valves.
The integration does not provide the ability to set auto shut-off thresholds.
{% include integrations/config_flow.md %}
@ -88,12 +100,6 @@ IP address:
description: "The IP address of your Sonic device."
{% endconfiguration_basic %}
## Removing the integration
This integration follows standard integration removal procedures. No extra steps are required.
{% include integrations/remove_device_service.md %}
## Examples
### Monitor water usage in the Energy Dashboard
@ -107,3 +113,9 @@ The water meter volume entity can be added to the Energy Dashboard, allowing you
- Send a notification when the water is too hot.
- Send a notification when the water is too cold.
- Send a notification when water is flowing for too long.
## Removing the integration
This integration follows standard integration removal procedures. No extra steps are required.
{% include integrations/remove_device_service.md %}

2
source/_integrations/weheat.markdown
View File

@ -67,7 +67,7 @@ Depending on the model/installation, states for the Indoor Unit states are avail
## Data updates
The integration is {% term polling %} and retrieves data every 30 seconds from the cloud.
The integration uses {% term polling %} to retrieve data every 120 seconds for a single heat pump. This interval increases proportionally with the number of heat pumps, for example, to 240 seconds for two heat pumps. Additionally, energy data is retrieved from the cloud every 1800 seconds.
## Actions

51
source/_integrations/zengge.markdown
View File

@ -1,51 +0,0 @@
---
title: Zengge
description: Instructions on how to integrate Zengge Bluetooth bulbs into Home Assistant.
ha_category:
- Light
ha_iot_class: Local Polling
ha_release: 0.36
ha_domain: zengge
ha_platforms:
- light
ha_integration_type: integration
ha_codeowners:
- '@emontnemery'
related:
- docs: /docs/configuration/
title: Configuration file
ha_quality_scale: legacy
---
The `zengge` {% term integration %} allows you to integrate your [Zengge Bluetooth bulbs](http://www.zengge.com/) into Home Assistant.
## Configuration
To enable the lights, add the following lines to your {% term "`configuration.yaml`" %} file.
{% include integrations/restart_ha_after_config_inclusion.md %}
```yaml
# Example configuration.yaml entry
light:
- platform: zengge
devices:
"C4:BE:84:51:54:8B":
name: Living Room
```
{% configuration %}
devices:
description: The list of your devices/bulbs.
required: true
type: list
keys:
mac_address:
description: The MAC address of the bulb.
required: true
type: list
keys:
name:
description: The friendly name for the frontend.
required: false
type: string
{% endconfiguration %}

1
source/_redirects
View File

@ -648,6 +648,7 @@ layout: null
/integrations/xfinity /more-info/removed-integration 301
/integrations/yessssms /more-info/removed-integration 301
/integrations/yweather /more-info/removed-integration 301
/integrations/zengge /integrations/led_ble
/components/zwave /integrations/zwave_js
# Lovelace images