Merge branch 'current' into next

This commit is contained in:
Franck Nijhof 2023-03-13 11:35:47 +01:00
commit 1556f0dac7
No known key found for this signature in database
GPG Key ID: D62583BA8AB11CA3
91 changed files with 3740 additions and 347 deletions

View File

@ -79,6 +79,7 @@
"Cisco IOS",
"CLI",
"ClimaCell",
"ConBee",
"Daikin",
"Danfoss",
"Dark Sky",
@ -126,6 +127,9 @@
"Home Assistant Supervised",
"Home Assistant Supervisor",
"Home Assistant",
"Home Assistant SkyConnect",
"SkyConnect",
"Home Assistant Yellow",
"HomeKit",
"Homematic",
"Honeywell",
@ -183,6 +187,7 @@
"NodeMCU",
"Norway",
"NuHeat",
"NVMe",
"NZBGet",
"ODRIOD-N2",
"ODROID",

View File

@ -72,7 +72,7 @@ source/_integrations/azure_event_hub.markdown @eavanvalkenburg
source/_integrations/azure_service_bus.markdown @hfurubotten
source/_integrations/backup.markdown @home-assistant/core
source/_integrations/baf.markdown @bdraco @jfroy
source/_integrations/balboa.markdown @garbled1
source/_integrations/balboa.markdown @garbled1 @natekspencer
source/_integrations/bayesian.markdown @HarvsG
source/_integrations/beewi_smartclim.markdown @alemuro
source/_integrations/binary_sensor.markdown @home-assistant/core
@ -121,7 +121,7 @@ source/_integrations/compensation.markdown @Petro31
source/_integrations/config.markdown @home-assistant/core
source/_integrations/configurator.markdown @home-assistant/core
source/_integrations/control4.markdown @lawtancool
source/_integrations/conversation.markdown @home-assistant/core
source/_integrations/conversation.markdown @home-assistant/core @synesthesiam
source/_integrations/coolmaster.markdown @OnFreund
source/_integrations/coronavirus.markdown @home-assistant/core
source/_integrations/counter.markdown @fabaff
@ -160,12 +160,14 @@ source/_integrations/dlna_dms.markdown @chishm
source/_integrations/dnsip.markdown @gjohansson-ST
source/_integrations/doorbird.markdown @oblogic7 @bdraco @flacjacket
source/_integrations/dooya.markdown @starkillerOG
source/_integrations/dormakaba_dkey.markdown @emontnemery
source/_integrations/dsmr.markdown @Robbie1221 @frenck
source/_integrations/dsmr_reader.markdown @depl0y @glodenox
source/_integrations/dunehd.markdown @bieniu
source/_integrations/dwd_weather_warnings.markdown @runningman84 @stephan192 @Hummel95
source/_integrations/dynalite.markdown @ziv1234
source/_integrations/ecobee.markdown @marthoc
source/_integrations/easyenergy.markdown @klaasnicolaas
source/_integrations/ecobee.markdown @marthoc @marcolivierarsenault
source/_integrations/econet.markdown @vangorra @w1ll1am23
source/_integrations/ecovacs.markdown @OverloadUT @mib1185
source/_integrations/ecowitt.markdown @pvizeli
@ -179,7 +181,7 @@ source/_integrations/elv.markdown @majuss
source/_integrations/emby.markdown @mezz64
source/_integrations/emoncms.markdown @borpin
source/_integrations/emonitor.markdown @bdraco
source/_integrations/emulated_hue.markdown @bdraco
source/_integrations/emulated_hue.markdown @bdraco @Tho85
source/_integrations/emulated_kasa.markdown @kbickar
source/_integrations/energie_vanons.markdown @klaasnicolaas
source/_integrations/energy.markdown @home-assistant/core
@ -237,7 +239,7 @@ source/_integrations/gaviota.markdown @starkillerOG
source/_integrations/gdacs.markdown @exxamalte
source/_integrations/generic.markdown @davet2001
source/_integrations/generic_hygrostat.markdown @Shulyaka
source/_integrations/geniushub.markdown @zxdavb
source/_integrations/geniushub.markdown @manzanotti
source/_integrations/geo_json_events.markdown @exxamalte
source/_integrations/geo_location.markdown @home-assistant/core
source/_integrations/geo_rss_events.markdown @exxamalte
@ -262,7 +264,7 @@ source/_integrations/gpsd.markdown @fabaff
source/_integrations/gree.markdown @cmroche
source/_integrations/greeneye_monitor.markdown @jkeljo
source/_integrations/group.markdown @home-assistant/core
source/_integrations/growatt_server.markdown @indykoning @muppet3000 @JasperPlant
source/_integrations/growatt_server.markdown @muppet3000
source/_integrations/guardian.markdown @bachya
source/_integrations/habitica.markdown @ASMfreaK @leikoilja
source/_integrations/hardware.markdown @home-assistant/core
@ -392,6 +394,7 @@ source/_integrations/lyric.markdown @timmo001
source/_integrations/marantz.markdown @ol-iver @starkillerOG
source/_integrations/martec.markdown @starkillerOG
source/_integrations/mastodon.markdown @fabaff
source/_integrations/matter.markdown @home-assistant/matter
source/_integrations/mazda.markdown @bdr99
source/_integrations/meater.markdown @Sotolotl @emontnemery
source/_integrations/media_player.markdown @home-assistant/core
@ -568,7 +571,7 @@ source/_integrations/rtsp_to_webrtc.markdown @allenporter
source/_integrations/ruckus_unleashed.markdown @gabe565
source/_integrations/ruuvi_gateway.markdown @akx
source/_integrations/ruuvitag_ble.markdown @akx
source/_integrations/rympro.markdown @OnFreund
source/_integrations/rympro.markdown @OnFreund @elad-bar @maorcc
source/_integrations/sabnzbd.markdown @shaiu
source/_integrations/safe_mode.markdown @home-assistant/core
source/_integrations/saj.markdown @fredericvl
@ -703,6 +706,7 @@ source/_integrations/tolo.markdown @MatthiasLohr
source/_integrations/tomorrowio.markdown @raman325 @lymanepp
source/_integrations/totalconnect.markdown @austinmroczek
source/_integrations/tplink.markdown @rytilahti @thegardenmonkey
source/_integrations/tplink_omada.markdown @MarkGodwin
source/_integrations/traccar.markdown @ludeeus
source/_integrations/tractive.markdown @Danielhiversen @zhulik @bieniu
source/_integrations/trafikverket_ferry.markdown @gjohansson-ST

View File

@ -27,8 +27,8 @@ GEM
ffi (1.15.5)
ffi (1.15.5-x64-mingw32)
forwardable-extended (2.6.0)
google-protobuf (3.22.0)
google-protobuf (3.22.0-x64-mingw32)
google-protobuf (3.22.2)
google-protobuf (3.22.2-x64-mingw32)
http_parser.rb (0.8.0)
i18n (1.12.0)
concurrent-ruby (~> 1.0)
@ -82,7 +82,7 @@ GEM
forwardable-extended (~> 2.6)
public_suffix (5.0.1)
racc (1.6.2)
rack (2.2.6.2)
rack (2.2.6.3)
rack-protection (3.0.5)
rack
rake (13.0.6)
@ -94,10 +94,10 @@ GEM
ruby2_keywords (0.0.5)
safe_yaml (1.0.5)
sass (3.4.25)
sass-embedded (1.58.3)
sass-embedded (1.59.2)
google-protobuf (~> 3.21)
rake (>= 10.0.0)
sass-embedded (1.58.3-x64-mingw32)
sass-embedded (1.59.2-x64-mingw32)
google-protobuf (~> 3.21)
sass-globbing (1.1.5)
sass (>= 3.1)

View File

@ -109,9 +109,9 @@ social:
# Home Assistant release details
current_major_version: 2023
current_minor_version: 2
current_patch_version: 5
date_released: 2023-02-15
current_minor_version: 3
current_patch_version: 3
date_released: 2023-03-09
# Either # or the anchor link to latest release notes in the blog post.
# Must be prefixed with a # and have double quotes around it.

View File

@ -0,0 +1,52 @@
module Jekyll
module HomeAssistant
class TerminologyTooltip < Liquid::Tag
def initialize(tag_name, args, tokens)
super
if args.strip =~ SYNTAX
@term = Regexp.last_match(1)
@text = Regexp.last_match(2)
else
raise SyntaxError, <<~MSG
Syntax error in tag 'term' while parsing the following options:
#{args}
Valid syntax:
{% term <term> [<text>] %}
MSG
end
end
def render(context)
entries = context.registers[:site].data["glossary"].select do |entry|
entry.key?("term") and (@term.casecmp(entry["term"]).zero? or (entry.key?("aliases") and entry["aliases"].any?{ |s| s.casecmp(@term)==0 }))
end
raise ArgumentError, "Term #{@term} was not found in the glossary" if entries.length == 0
raise ArgumentError, "Term #{@term} is in the glossary multiple times" if entries.length > 1
raise ArgumentError, "Term #{@term} is missing a definition" unless entries[0].key?("definition")
glossary = entries[0]
definition = glossary["excerpt"] || glossary["definition"]
if glossary.key?("link")
rendered_link = Liquid::Template.parse(glossary["link"]).render(context).strip
link = "<br><a class='terminology-link' href='#{rendered_link}' target='_blank'>[Learn more]</a>"
end
tooltip = "<span class='terminology-tooltip'>#{definition}#{link || ""}</span>"
"<span class='terminology'>#{@text || @term}#{tooltip}</span>"
end
private
SYNTAX = %r!^(\w+?|".+?")(?:\s+(\w+|".+"))?$!.freeze
end
end
end
Liquid::Template.register_tag('term', Jekyll::HomeAssistant::TerminologyTooltip)

View File

@ -0,0 +1,46 @@
.terminology {
position: relative;
border-bottom: 2px dotted $primary-color;
cursor: help;
&:hover .terminology-tooltip {
visibility: visible;
opacity: 1;
}
.terminology-tooltip {
visibility: hidden;
width: 250px;
background-color: $primary-color;
color: #fff;
font-size: 0.8em;
padding: 8px;
border-radius: 8px;
opacity: 0;
transition: opacity 0.5s;
position: absolute;
z-index: 1;
bottom: 100%;
left: 50%;
margin-left: -125px;
a {
color: #fff;
font-weight: 500;
}
&:after {
content: " ";
position: absolute;
top: 100%;
left: 50%;
margin-left: -5px;
border-width: 5px;
border-style: solid;
border-color: $primary-color transparent transparent transparent;
}
}
}

View File

@ -8,4 +8,5 @@
@import 'custom/print';
@import 'custom/layout';
@import 'custom/getting_started';
@import 'custom/tabbed_block';
@import 'custom/tabbed_block';
@import 'custom/terminology_tooltip';

View File

@ -1,78 +1,299 @@
- topic: Action
description: "An [Action](/docs/automation/action/) is an event that can be fired as a response to a trigger, once all conditions have been met."
- topic: Add-on
description: "Add-ons are additional standalone third-party software packages that can be installed on Home Assistant OS. Most of these, add-on provided, applications can be integrated into Home Assistant using integrations. Examples of add-ons are: an MQTT broker, database service or a file server."
- topic: Automation
description: "[Automations](/docs/automation/) connect one or more triggers to one or more actions in a 'when trigger then do action' fashion with additional optional conditions. For example, an automation might connect the trigger 'sunset' to the action 'turn the lights on' but only if the condition 'someone is home' is met. Pre-made automations for common use-cases are available via [the blueprints feature](/docs/automation/using_blueprints/)."
- topic: Binary sensor
description: "A [binary sensor](/integrations/binary_sensor) returns information about things that only have two states - such as on or off."
- topic: Component
description: "Integrations (see below) used to be known as components."
- topic: Condition
description: "[Conditions](/docs/scripts/conditions/) are an optional part of an automation that will prevent an action from firing if they are not met."
- topic: Cover
description: "[Covers](/integrations/cover) are devices such as blinds, garage doors, etc that can be opened and closed and optionally set to a specific position."
- topic: Customize
description: "[Customization](/docs/configuration/customizing-devices/) allows you to overwrite the default parameters of your devices in the configuration."
- topic: Device
description: "A device is a named collection of entities that all represent the same physical/logical unit, which can do or observe something. An example for a device would be a smart plug named 'Coffee Machine' which provides a `switch` entity plus one or more `sensor` entities for power monitoring or similar."
- topic: Device tracker
description: "[Device trackers](/integrations/device_tracker) are used to track the presence, or location, of a device."
- topic: Discovery
description: "[Discovery](/integrations/discovery/) is the automatic setup of zeroconf/mDNS and uPnP devices after they are discovered."
- topic: Domain
description: "Each integration in Home Assistant has a unique identifier: a domain. All of the entities and services available in Home Assistant are provided by integrations and thus belong to such a domain. The first part of the entity or service, before the `.` shows the domain they belong to. For example `light.kitchen` is an entity in the `light` domain from the [light integration](/integrations/light), while `hue.activate_scene` is the `activate_scene` service for the `hue` domain which belongs to the [Hue integration](/integrations/hue)."
- topic: Entity
description: "An entity is the representation of a single control or data point of a device or service inside Home Assistant. A single device or service can thus provide multiple entities to be able to monitor and control all features a device provides. For example, a combined temperature and humidity sensor, in general, provides two `sensor` entities. One for the temperature (e.g., `sensor.temperature` with state `21.0` and unit `°C`) and one for the humity (e.g., `sensor.humidity` with state `65.4` and unit `%`)."
- topic: Event
description: "An [event](/docs/configuration/events/) is when something happens."
- topic: Frontend
description: "The [frontend](/integrations/frontend/) is a necessary component for the UI, it is also where you can define your themes."
- topic: Group
description: "[Groups](/integrations/group/) are a way to organize your entities into a single unit."
- topic: HASS
description: "HASS or [hass](/docs/tools/hass/) is often used as an abbreviation for Home Assistant. It is also the command-line tool."
- topic: HassOS
description: "Another name for Home Assistant Operating System"
- topic: Home Assistant Core
description: Home Assistant Core is a Python program. It can be run on various operating systems and is the basis for Home Assistant. When people are talking about Home Assistant Core they usually refer to a standalone installation method that can be installed using a Virtual Environment or Docker. Home Assistant Core does not use the Home Assistant Supervisor.
- topic: Home Assistant Supervised (Previously Hass.io)
description: "Home Assistant Supervised is a full UI managed home automation ecosystem that runs Home Assistant, the Home Assistant Supervisor and add-ons. It comes pre-installed on Home Assistant OS, but can be installed on any Linux system. It leverages Docker, which is managed by the Home Assistant Supervisor."
- topic: Home Assistant Supervisor
description: "The Home Assistant Supervisor is a program that manages a Home Assistant installation, taking care of installing and updating Home Assistant, add-ons, itself and, if used, updating the Home Assistant Operating System."
- topic: Home Assistant Operating System
description: "Home Assistant OS, the Home Assistant Operating System, is an embedded, minimalistic, operating system designed to run the Home Assistant ecosystem on single board computers (like the Raspberry Pi) or Virtual Machines. The Home Assistant Supervisor can keep it up to date, removing the need for you to manage an operating system."
- topic: Integration
description: "[Integrations](/integrations/) connect and integrates Home Assistant with devices, services, and more. Such an integration contains all the logic that takes care of vendor- and device-specific implementations such as authentication or special protocols and brings those into Home Assistant in a standardized way. For example, the [Hue](/integrations/hue) integration integrates the Philips Hue bridge and its connected bulbs into Home Assistant, making them available as Home Assistant light entities you can control."
- topic: Lovelace
description: "Lovelace is the original code name of the UI that is now known as [Home Assistant dashboards](/dashboards)."
- topic: Light
description: "A [light](/integrations/light) has a brightness you can control, and optionally color temperature or RGB color control."
- topic: Notification
description: "You can use [notifications](/integrations/#notifications) to send messages, pictures, and more, to devices."
- topic: Packages
description: "[Packages](/docs/configuration/packages/) allow you to bundle different component configurations together."
- topic: Platform
description: "[Platforms](/docs/configuration/platform_options/) are building blocks provided by some integrations to be used by other integrations. For example, the [Light](/integrations/light) integration provides the `light platform` that is utilized by all integrations providing `light` entities such as e.g. [Hue](/integrations/hue)."
- topic: Scene
description: "[Scenes](/integrations/scene/) capture the states you want certain entities to be. For example, a scene can specify that light A should be turned on and light B should be bright red."
- topic: Script
description: "[Scripts](/docs/scripts/) are components that allow users to specify a sequence of actions to be executed by Home Assistant when turned on."
- topic: Sensor
description: "[Sensors](/integrations/sensor) return information about a thing, for instance the level of water in a tank."
- topic: Selectors
description: "[Selectors](/docs/blueprint/selectors/) are components for the user interface. Some selectors can, for example, show a toggle button to turn something on or off, while another select can filter a list of devices to show only devices that have motion-sensing capabilities."
- topic: Service
description: "[Services](/docs/scripts/service-calls/) are called to perform actions."
- topic: Switch
description: "[Switches](/integrations/switch) are things that have two states you can select between, such as turning on or off a socket."
- topic: Template
description: "A [template](/docs/automation/templating/) is an automation definition that can include variables for the service or data from the trigger values. This allows automations to generate dynamic actions."
- topic: Trigger
description: "A [trigger](/docs/automation/trigger/) is a set of values or conditions of a platform that are defined to cause an automation to run."
- topic: TTS
description: "TTS ([text to speech](/integrations/tts)) allows Home Assistant to talk to you."
- topic: Variables
description: "[Variables](/docs/scripts/#variables) are used to store values in memory that can be processed e.g. in a script."
- topic: Zone
description: "[Zones](/integrations/zone/) are areas that can be used for presence detection."
## Glossary
#
# Format is a list of terms, each term is a dictionary with the following keys:
# - term: The term to define (required)
# - definition: The definition of the term (required)
# - excerpt: Short excerpt of the definition, overrides definition for tooltips (optional)
# - link: A URL to link to for more information (optional)
# - aliases: A list of aliases for the term (optional)
#
- term: Action
definition: >
An action is an command that can be fired. For example, turning on a light.
Actions used in many places, most notably in automations and scripts.
aliases:
- actions
link: /docs/automation/action/
- term: Add-on
definition: >
Add-ons are additional standalone third-party software packages that can be
installed on Home Assistant OS. Most of these, add-on provided, applications
can be integrated into Home Assistant using integrations. Examples of
add-ons are: an MQTT broker, database service or a file server.
excerpt: >
Add-ons are additional standalone third-party software packages that can be
installed on Home Assistant OS.
- term: Automation
definition: >
Automations connect one or more triggers to one or more actions in a
'when trigger then do action' fashion with additional optional conditions.
For example, an automation might connect the trigger 'sunset' to the action
'turn the lights on' but only if the condition 'someone is home' is met.
Pre-made automations for common use-cases are available via
[the blueprints feature](/docs/automation/using_blueprints/).
excerpt: >
Automations in Home Assistant allow you to automatically respond to things
that happen in and around your home.
link: /docs/automation/
aliases:
- automations
- term: Binary sensor
definition: >
A binary sensor returns information about things that only have two states -
such as on or off.
link: /integrations/binary_sensor
- term: Component
definition: >
Better known as: Integrations. Integrations used to be known as components.
- term: Condition
definition: >
Conditions are an optional part of an automation that will prevent an
action from firing if they are not met.
link: /docs/scripts/conditions/
- term: Cover
definition: >
Covers are devices such as blinds, garage doors, etc that can be opened
and closed and optionally set to a specific position.
link: /integrations/cover
- term: Customize
definition: >
Customization allows you to overwrite the default parameters of your
devices in the configuration.
- term: Device
definition: >
A device is a named collection of entities that all represent the same
physical/logical unit, which can do or observe something. An example,
for a device would be a smart plug named 'Coffee Machine' which provides
a `switch` entity plus one or more `sensor` entities for power monitoring
or similar.
excerpt: >
A device is a named collection of entities that all represent the same
physical/logical unit, which can do or observe something.
- term: Device tracker
definition: >
Device trackers are used to track the presence, or location, of a device.
link: /integrations/device_tracker
- term: Discovery
definition: >
Discovery is the automatic setup of zeroconf/mDNS and uPnP devices after
they are discovered.
- term: Domain
definition: >
Each integration in Home Assistant has a unique identifier:
a domain. All of the entities and services available in Home Assistant
are provided by integrations and thus belong to such a domain. The first
part of the entity or service, before the `.` shows the domain they belong
to. For example `light.kitchen` is an entity in the `light` domain from
the [light integration](/integrations/light), while `hue.activate_scene`
is the `activate_scene` service for the `hue` domain which belongs to
the [Hue integration](/integrations/hue).
excerpt: >
Each integration in Home Assistant has a unique identifier: The domain.
It is often shown as the first part (before the dot) of entity IDs.
- term: Entity
definition: >
An entity is the representation of a single control or data point of a
device or service inside Home Assistant. A single device or service can
thus provide multiple entities to be able to monitor and control all
features a device provides. For example, a combined temperature and
humidity sensor, in general, provides two `sensor` entities. One for the
temperature (e.g., `sensor.temperature` with state `21.0` and unit `°C`)
and one for the humity
(e.g., `sensor.humidity` with state `65.4` and unit `%`).
excerpt: >
An entity is the representation of a single control or data point of a
device or service inside Home Assistant.
- term: Event
definition: >
An event is when something happens.
link: /docs/configuration/events/
- term: Frontend
definition: >
The frontend is a necessary component for the UI, it is also where you
can define your themes.
link: /integrations/frontend/
- term: Group
definition: >
Groups are a way to organize your entities into a single unit.
link: /integrations/group/
- term: HASS
definition: >
HASS or [hass](/docs/tools/hass/) is often used as an abbreviation for
Home Assistant. It is also the command-line tool.
- term: HassOS
definition: >
Another name for Home Assistant Operating System
link: /hassio/installation/
- term: Home Assistant Core
definition: >
Home Assistant Core is a Python program. It can be run on various operating
systems and is the basis for Home Assistant. When people are talking about
Home Assistant Core they usually refer to a standalone installation method
that can be installed using a Virtual Environment or Docker. Home Assistant
Core does not use the Home Assistant Supervisor.
excerpt: >
Home Assistant Core is the hart of Home Assistant itself. It is a Python
program that powers every installation type, but can be installed standalone.
- term: Home Assistant Supervised
definition: >
Home Assistant Supervised is a full UI managed home automation ecosystem that
runs Home Assistant, the Home Assistant Supervisor and add-ons. It comes
pre-installed on Home Assistant OS, but can be installed on any Linux system.
It leverages Docker, which is managed by the Home Assistant Supervisor.
excerpt: >
Home Assistant Supervised is the full Home Assistant ecosystem, without the
Home Assistant Operating System.
- term: Home Assistant Supervisor
definition: >
The Home Assistant Supervisor is a program that manages a Home Assistant
installation, taking care of installing and updating Home Assistant,
add-ons, itself and, if used, updating the Home Assistant Operating System.
- term: Home Assistant Operating System
definition: >
Home Assistant OS, the Home Assistant Operating System, is an embedded,
minimalistic, operating system designed to run the Home Assistant ecosystem
on single board computers (like the Raspberry Pi) or Virtual Machines.
The Home Assistant Supervisor can keep it up to date, removing the need for
you to manage an operating system.
excerpt: >
Home Assistant OS, the Home Assistant Operating System, is an embedded,
minimalistic, operating system designed to run the Home Assistant ecosystem.
- term: Integration
definition: >
Integrations connect and integrates Home Assistant with devices, services,
and more. Such an integration contains all the logic that takes care of
vendor- and device-specific implementations such as authentication or
special protocols and brings those into Home Assistant in a standardized
way. For example, the [Hue](/integrations/hue) integration integrates
the Philips Hue bridge and its connected bulbs into Home Assistant, making
them available as Home Assistant light entities you can control.
excerpt: >
Integrations connect and integrates Home Assistant with your devices,
services, and more.
link: /integrations/
- term: Lovelace
definition: >
Lovelace is the original code name of the UI that is now known as
[Home Assistant dashboards](/dashboards).
- term: Light
definition: >
A light has a brightness you can control, and optionally color temperature
or RGB color control.
link: /integrations/light
- term: Notification
definition: >
You can use notifications to send messages, pictures, and more, to devices.
link: /integrations/#notifications
- term: Packages
definition: >
Packages allow you to bundle different component configurations together.
link: /docs/configuration/packages/
- term: Platform
definition: >
Platforms are building blocks provided by some integrations to be used by
other integrations. For example, the [Light](/integrations/light)
integration provides the `light platform` that is utilized by all
integrations providing `light` entities such
as e.g. [Hue](/integrations/hue).
excerpt: >
Platforms are building blocks provided by some integrations to be used by
other integrations.
link: /docs/configuration/platform_options/
- term: Scene
definition: >
Scenes capture the states you want certain entities to be. For example,
a scene can specify that light A should be turned on and light B should
be bright red.
link: /integrations/scene/
- term: Script
definition: >
Scripts are components that allow users to specify a sequence of actions
to be executed by Home Assistant when turned on.
link: /docs/scripts/
- term: Sensor
definition: >
Sensors return information about a thing, for instance the level of water
in a tank.
link: /integrations/sensor/
- term: Selectors
definition: >
Selectors are components for the user interface. Some selectors can,
for example, show a toggle button to turn something on or off, while another
select can filter a list of devices to show only devices that have
motion-sensing capabilities.
excerpt: >
Selectors are components for the user interface. Like toggle, dropdown,
and more.
link: /docs/blueprint/selectors/
- term: Service
definition: >
Services are called to perform actions.
link: /docs/scripts/service-calls/
- term: Switch
definition: >
Switches are things that have two states you can select between, such as
turning on or off a socket.
link: /integrations/switch/
- term: Template
definition: >
A template is an automation definition that can include variables for the
service or data from the trigger values. This allows automations to generate
dynamic actions.
link: /docs/automation/templating/
- term: Trigger
definition: >
A trigger is a set of values or conditions of a platform that are defined
to cause an automation to run.
link: /docs/automation/trigger/
- term: TTS
definition: >
TTS (text to speech) allows Home Assistant to talk to you.
link: /integrations/tts/
- term: Variables
definition: >
Variables are used to store values in memory that can be processed
e.g. in a script.
link: /docs/scripts/#variables
- term: Zone
definition: >
Zones are areas that can be used for presence detection.
link: /integrations/zone/

View File

@ -198,7 +198,12 @@ automation:
## Numeric state trigger
Fires when the numeric value of an entity's state (or attribute's value if using the `attribute` property, or the calculated value if using the `value_template` property) **crosses** (and only when crossing) a given threshold. On state change of a specified entity, attempts to parse the state as a number and fires if the value is changing from above to below or from below to above the given threshold.
Fires when the numeric value of an entity's state (or attribute's value if using the `attribute` property, or the calculated value if using the `value_template` property) **crosses** a given threshold. On state change of a specified entity, attempts to parse the state as a number and fires if the value is changing from above to below or from below to above the given threshold.
<div class='note'>
Crossing the threshold means that the trigger only fires if the state wasn't previously within the threshold.
If the current state of your entity is `50` and you set the threshold to `below: 75`, the trigger would not fire if the state changed to e.g. `49` or `72` because the threshold was never crossed. The state would first have to change to e.g. `76` and then to e.g. `74` for the trigger to fire.
</div>
{% raw %}

View File

@ -3,15 +3,16 @@ title: "Glossary"
description: "Home Assistant's Glossary."
---
{% assign entries = site.data.glossary | sort: 'topic' %}
{% assign entries = site.data.glossary | sort: 'term' %}
The glossary covers terms which are used around Home Assistant.
{% configuration_basic %}
{% for entry in entries %}
"{{ entry.topic }}":
description: "{{ entry.description }}"
"{{ entry.term }}":
description: "{{ entry.definition }}
{% if entry.link %}<br />[Read more about: {{ entry.term }}]({{ entry.link }}){% endif %}"
{% endfor %}
{% endconfiguration_basic %}

View File

@ -5,7 +5,7 @@ toc: true
no_toc: true
---
Scripts are a sequence of actions that Home Assistant will execute. Scripts are available as an entity through the standalone [Script component] but can also be embedded in [automations] and [Alexa/Amazon Echo] configurations.
Scripts are a sequence of {% term actions %} that Home Assistant will execute. Scripts are available as an entity through the standalone [Script component] but can also be embedded in {% term automations %} and [Alexa/Amazon Echo] configurations.
When the script is executed within an automation the `trigger` variable is available. See [Available-Trigger-Data](/docs/automation/templating/#available-trigger-data).

View File

@ -42,7 +42,7 @@
<li>
<b>{% active_link /docs/assist/ Assist %}</b>
<ul>
<li>{% active_link /docs/assist/android/ Assist for Android Wear %}</li>
<li>{% active_link /docs/assist/android/ Assist for Android %}</li>
<li>{% active_link /docs/assist/apple/ Assist for Apple devices %}</li>
<li>{% active_link /docs/assist/builtin_sentences/ Built-in sentences %}</li>
<li>{% active_link /docs/assist/custom_sentences/ Custom sentences %}</li>

View File

@ -4,6 +4,7 @@
<ul class="divided sidebar-menu">
<li>{% active_link /installation/ Installation %}</li>
<li>{% active_link /getting-started/onboarding/ Onboarding %}</li>
<li>{% active_link /getting-started/concepts-terminology/ Concepts and terminology %}</li>
<li>{% active_link /getting-started/automation/ Automation %}</li>
<li>
{% active_link /getting-started/presence-detection/ Presence detection

View File

@ -53,16 +53,16 @@ We will need a few things to get started with installing Home Assistant. Links b
<div class='note'>
<b>Prerequisites</b>
This guide assumes that you have a dedicated generic x86 PC (typically an Intel or AMD-based system) available to exclusively run Home Assistant Operating System. The system must be 64-bit capable and able to boot using UEFI. Pretty much all systems produced in the last 10 years support the UEFI boot mode.
This guide assumes that you have a dedicated {{ site.installation.types[page.installation_type].board }} PC (typically an Intel or AMD-based system) available to exclusively run Home Assistant Operating System. The system must be 64-bit capable and able to boot using UEFI. Pretty much all systems produced in the last 10 years support the UEFI boot mode.
<b>Summary</b>
You will need to write the HAOS (Home Assistant OS) disk image directly to your boot media, and configure your x86 to use UEFI boot mode when booting from this media.
You will need to configure your {{ site.installation.types[page.installation_type].board }} PC to use UEFI boot mode, then write the HAOS (Home Assistant OS) disk image to your boot medium. There are two ways to do this listed below.
</div>
### Configure the BIOS on your x86-64 hardware
To boot Home Assistant OS, the BIOS needs to have UEFI boot mode enabled and Secure Boot disabled. The following screenshots are from a 7th generation Intel NUC system. The BIOS menu will likely look different on your systems. However, the options should still be present and named similarly.
To boot Home Assistant OS, the BIOS needs to have UEFI boot mode enabled and Secure Boot disabled. The following screenshots are from a 7th generation Intel NUC system. The BIOS menu will likely look different on your system. However, the options should still be present and named similarly.
1. To enter the BIOS, start up your x86-64 hardware and repeatedly press the `F2` key (on some systems this might be `Del`, `F1` or `F10`).
![Enter BIOS using F2, Del, F1 or F10 key](/images/installation/intel-nuc-enter-bios.jpg)
@ -73,28 +73,29 @@ To boot Home Assistant OS, the BIOS needs to have UEFI boot mode enabled and Sec
1. Disable Secure Boot.
![Disable Secure Boot mode](/images/installation/intel-nuc-disable-secure-boot.jpg)
1. Save the changes and exit.
1. Save your changes and exit.
- The BIOS configuration is complete.
The BIOS configuration is now complete.
As a next step, we need to write the Home Assistant Operating System image to the target boot medium. The HAOS has no integrated installer. This means the Operating System is not copied automatically to the internal disk.
Next, we need to write the Home Assistant Operating System image to the "boot medium", which is the medium your x86-64 hardware will boot from when it is running Home Assistant.
- The "boot medium" is the medium your x86-64 hardware will boot from when it is running Home Assistant.
- Typically, an internal medium is used for the x86-64 hardware. Examples of internal media are S-ATA hard disk, S-ATA SSD, M.2 SSD, or a non-removable eMMC.
- Alternatively, an external medium can be used to boot HAOS such as a USB SDD (not recommended).
<div class='note'>
HAOS has no integrated installer that writes the image automatically, you must write it manually using e.g. Etcher.
</div>
To install the HAOS internally on your x86-64 hardware, there are 2 methods:
Typically an internal medium like S-ATA hard disk, S-ATA SSD, M.2 SSD, or a non-removable eMMC is used for the x86-64 boot medium. Alternatively, an external medium can be used such as a USB SDD, though this is not recommended.
1. Copying the HAOS disk image from your Desktop computer onto your boot medium (e.g. by using a USB to S-ATA adapter). This is not an option for a non-removable eMMC on your x86-64 hardware, of course.
To use this method, follow the steps described in the procedure below: [Write the image to your boot media](#write-the-image-to-your-boot-media).
2. Copying a live operating system (e.g. Ubuntu) onto a USB device. Then, insert this USB device into your x86-64 hardware and start the Ubuntu.
To write the HAOS image to the boot medium on your x86-64 hardware, there are 2 different methods:
- To use this method, follow the instructions of your Live distribution (e.g., [this Ubuntu guide](https://ubuntu.com/tutorials/try-ubuntu-before-you-install)). Once you booted the live operating system, follow the steps described in the procedure below: [Write the image to your boot media](#write-the-image-to-your-boot-media).
1. Write the HAOS disk image from your desktop computer directly to the boot medium (e.g. using a USB to S-ATA adapter).
If you can use this method, proceed to "[Write the image to your boot medium](#write-the-image-to-your-boot-medium)" and follow all steps. If you have non-removable internal mediums or don't have the necessary adapter, try the next method instead.
1. Create a "live operating system" on a USB device running e.g. Ubuntu ([how-to guide](https://ubuntu.com/tutorials/try-ubuntu-before-you-install)). Insert it into your system and boot the live operating system. Then follow from step 2 in "[Write the image to your boot medium](#write-the-image-to-your-boot-medium)".
{% details "Ubuntu dependencies for Etcher" %}
When installing Etcher on an Ubuntu system you may need to install the fuse
dependency, you can do so with the following commands:
When installing Etcher on Ubuntu you may need to install the fuse dependency first,
to do this run the following commands in the terminal:
```bash
sudo add-apt-repository universe
@ -106,17 +107,17 @@ sudo apt install libfuse2
{% endif %}
### Write the image to your boot media
### Write the image to your boot medium
1. Attach the Home Assistant boot media ({{site.installation.types[page.installation_type].installation_media}}) to your computer
1. Attach the Home Assistant boot medium ({{site.installation.types[page.installation_type].installation_media}}) to your computer.
{% if page.installation_type == 'odroid' %}
If you are using a [Home Assistant Blue](/blue) or ODROID N2+, you can [attach your device directly](/common-tasks/os/#flashing-an-odroid-n2).
{% endif %}
2. Download and start <a href="https://www.balena.io/etcher" target="_blank">Balena Etcher</a>. (You may need to run it with administrator privileges on Windows).
3. Select "Flash from URL"
2. Download and start <a href="https://www.balena.io/etcher" target="_blank">Balena Etcher</a>. You may need to run it with administrator privileges on Windows.
3. Select "Flash from URL".
![Screenshot of the Etcher software showing flash from URL selected.](/images/installation/etcher1.png)
4. Get the URL for your {{site.installation.types[page.installation_type].board}}:
4. Copy the URL for the {{site.installation.types[page.installation_type].board}} image which is:
{% if site.installation.types[page.installation_type].variants.size > 1 %}
{% tabbed_block %}
{% for variant in site.installation.types[page.installation_type].variants %}
@ -147,29 +148,27 @@ sudo apt install libfuse2
_Select and copy the URL or use the "copy" button that appear when you hover it._
1. Paste the URL for your {{site.installation.types[page.installation_type].board}} into Balena Etcher and click "OK"
1. Paste the URL for the {{site.installation.types[page.installation_type].board}} image into Balena Etcher and click "OK"
![Screenshot of the Etcher software showing the URL bar with a URL pasted in.](/images/installation/etcher2.png)
6. Balena Etcher will now download the image, when that is done click "Select target"
1. When Balena Etcher has downloaded the image, click "Select target"
![Screenshot of the Etcher software showing the select target button highlighted.](/images/installation/etcher3.png)
7. Select the {{site.installation.types[page.installation_type].installation_media}} you want to use for your {{site.installation.types[page.installation_type].board}}
1. Select the boot medium ({{site.installation.types[page.installation_type].installation_media}}) you want to use for your installation
![Screenshot of the Etcher software showing teh targets available.](/images/installation/etcher4.png)
8. Click on "Flash!" to start writing the image
1. Click on "Flash!" to start writing the image
![Screenshot of the Etcher software showing the Flash button highlighted.](/images/installation/etcher5.png)
9. When Balena Etcher is finished writing the image you will get this confirmation
1. When Balena Etcher has finished writing the image you will see a confirmation
![Screenshot of the Etcher software showing that the installation has completed.](/images/installation/etcher6.png)
### Start up your {{site.installation.types[page.installation_type].board}}
{% if page.installation_type == 'generic-x86-64' %}
1. If you used your desktop system to write the HAOS your boot media, install the boot media ({{site.installation.types[page.installation_type].installation_media}}) in the generic-x86-64 system.
- If you used your desktop system to write the HAOS image directly to a boot medium like an S-ATA SSD, connect this back to your {{ site.installation.types[page.installation_type].board }} system.
- If you used a live operating system (e.g. Ubuntu), shut down the live operating system and make sure to remove the USB flash drive you used for the live system.
- If you used a live operating system (e.g. Ubuntu), shut it down and remove the live operating system USB device.
2. Make sure an Ethernet cable is plugged in for network.
3. Power the system on.
- Wait for the Home Assistant welcome banner to show up in the console of the generic-x86-64 system.
1. Plug in an Ethernet cable that is connected to the network.
2. Power the system on. If you have a screen connected to the {{site.installation.types[page.installation_type].board}} system, after a minute or so the Home Assistant welcome banner will appear in the console.
<div class="note">
@ -181,6 +180,9 @@ This can be accomplished either by using a live operating system (e.g. Ubuntu) a
--loader '\EFI\BOOT\bootx64.efi'
```
The efibootmgr command will only work if you booted the live operating system in UEFI mode, so be sure to boot from your USB flash drive in this mode.
Depending on your privileges on the prompt, you may need to run efibootmgr using sudo.
Or else, the BIOS might provide you with a tool to add boot options, there you can specify the path to the EFI file:
```text
@ -191,13 +193,16 @@ Or else, the BIOS might provide you with a tool to add boot options, there you c
{% else %}
1. Insert the boot media ({{site.installation.types[page.installation_type].installation_media}}) you just created.
2. Attach an Ethernet cable for network.
3. Attach the power cable.
{% endif %}
4. In the browser of your Desktop system, within a few minutes you will be able to reach your new Home Assistant on <a href="http://homeassistant.local:8123" target="_blank">homeassistant.local:8123</a>.
1. Insert the boot medium ({{ site.installation.types[page.installation_type].installation_media }}) you just created.
2. Plug in an Ethernet cable that is connected to the network and power the system on.
- If you are running an older Windows version or have a stricter network configuration, you might need to access Home Assistant at <a href="http://homeassistant:8123" target="_blank">homeassistant:8123</a> or `http://X.X.X.X:8123` (replace X.X.X.X with your {{site.installation.types[page.installation_type].board}}s IP address).
{% endif %}
3. In the browser of your desktop system, within a few minutes you will be able to reach your new Home Assistant at <a href="http://homeassistant.local:8123" target="_blank">homeassistant.local:8123</a>.
<div class="note">
If you are running an older Windows version or have a stricter network configuration, you might need to access Home Assistant at <a href="http://homeassistant:8123" target="_blank">homeassistant:8123</a> or `http://X.X.X.X:8123` (replace X.X.X.X with your {{site.installation.types[page.installation_type].board}}s IP address).
</div>
{% else %}
@ -244,7 +249,7 @@ _All these can be extended if your usage calls for more resources._
4. Edit the "Settings" of the VM and go "System" then "Motherboard" and select "Enable EFI"
5. Then go to "Network" "Adapter 1" choose "Bridged Adapter" and choose your Network adapter
<div class="note warning">
Please keep in mind that the bridged adapter only functions over a hardwired ethernet connection.
Please keep in mind that the bridged adapter only functions over a hardwired Ethernet connection.
Using Wi-Fi on your VirtualBox host is unsupported.
</div>
6. Then go to "Audio" and choose "Intel HD Audio" as Audio Controller.

View File

@ -11,7 +11,7 @@ ha_platforms:
ha_integration_type: integration
---
The `aquostv` platform allows you to control a [Sharp Aquos TV](https://global.sharp/aquos/en/index.html).
The `aquostv` platform allows you to control a [Sharp Aquos TV](https://global.sharp/aquos/index.html).
When the TV is first connected, you will need to accept Home Assistant on the TV to allow communication.

View File

@ -12,6 +12,7 @@ ha_platforms:
- climate
ha_codeowners:
- '@garbled1'
- '@natekspencer'
ha_config_flow: true
ha_integration_type: integration
---

View File

@ -15,8 +15,6 @@ ha_integration_type: integration
The `bluesound` platform allows you to control your [Bluesound](https://www.bluesound.com/) HiFi wireless speakers and audio integrations from Home Assistant.
Bluesound devices should be discovered automatically by using [the discovery integration](/integrations/discovery/).
To manually add a Bluesound device to your installation, add the following to your `configuration.yaml` file:
```yaml

View File

@ -45,7 +45,7 @@ copy running-config startup-config
<div class='note warning'>
If you have a very large number of devices on your VLan (+1000), then you may want to adjust the ARP cache timeout to suit your needs. See [this discussion](https://supportforums.cisco.com/discussion/10169296/arp-timeout) to learn more.
If you have a very large number of devices on your VLan (+1000), then you may want to adjust the ARP cache timeout to suit your needs. See [this discussion](https://community.cisco.com/t5/switching/arp-timeout/td-p/839027) to learn more.
</div>

View File

@ -8,6 +8,7 @@ ha_quality_scale: internal
ha_iot_class: Local Push
ha_codeowners:
- '@home-assistant/core'
- '@synesthesiam'
ha_domain: conversation
ha_integration_type: system
---

View File

@ -39,6 +39,7 @@ This integration is a meta-component and configures a default set of integration
- [Media Source](/integrations/media_source/) (`media_source`)
- [Mobile App Support](/integrations/mobile_app/) (`mobile_app`)
- [My Home Assistant](/integrations/my/) (`my`)
- [Network](/integrations/network/) (`network`)
- [Person](/integrations/person/) (`person`)
- [Schedule](/integrations/schedule/) (`schedule`)
- [Scene](/integrations/scene/) (`scene`)

View File

@ -3,7 +3,7 @@ title: Denon AVR Network Receivers
description: Instructions on how to integrate Denon AVR Network Receivers into Home Assistant.
ha_category:
- Media Player
ha_iot_class: Local Polling
ha_iot_class: Local Push
ha_release: 0.7.2
ha_domain: denonavr
ha_codeowners:
@ -62,6 +62,7 @@ Known supported devices:
- Denon AVR-S650H
- Denon AVR-S710W
- Denon AVR-S720W
- Denon AVR-S740H
- Denon AVR-S750H
- Denon AVR-S760H
- Denon AVR-S940H

View File

@ -18,9 +18,8 @@ ha_platforms:
ha_integration_type: helper
---
The derivative ([Wikipedia](https://en.wikipedia.org/wiki/Derivative)) integration creates a sensor that "smooths-out" another sensor (the **source sensor**).
Derivatives of the specified sensor will be averaged in a given time window with a Simple Moving Average algorithm weighted by time. This is, for instance, useful for a sensor that outputs discrete values or to filter out short-duration noise.
Derivative sensors are updated upon changes of the **source sensor**.
The derivative ([Wikipedia](https://en.wikipedia.org/wiki/Derivative)) integration creates a sensor that estimates the derivative of the
values provided by another sensor (the **source sensor**). Derivative sensors are updated upon changes of the **source sensor**.
For sensors that reset to zero after a power interruption and need a "non-negative derivative", such as bandwidth counters in routers, or rain gauges, consider using the [Utility Meter](/integrations/utility_meter/) integration instead. Otherwise, each reset will register a significant change in the derivative sensor.
@ -83,7 +82,7 @@ unit:
required: false
type: string
time_window:
description: The time window in which to calculate the derivative. By default the derivative is calculated between two consecutive updates without any smoothing.
description: The time window in which to calculate the derivative. Derivatives in this window will be averaged with a Simple Moving Average algorithm weighted by time. This is for instance useful for a sensor that outputs discrete values, or to filter out short duration noise. By default the derivative is calculated between two consecutive updates without any smoothing.
default: 0
required: false
type: time

View File

@ -102,7 +102,7 @@ Note that it is not necessary to provide the full device information in each mes
- Discovery payload:
```json
{"automation_type":"trigger","type":"action","subtype":"arrow_left_click","payload":"arrow_left_click","topic":"zigbee2mqtt/0x90fd9ffffedf1266/action","device":{"identifiers":["zigbee2mqtt_0x90fd9ffffedf1266"],"name":"0x90fd9ffffedf1266","sw_version":"Zigbee2mqtt 1.14.0","model":"TRADFRI remote control (E1524/E1810)","manufacturer":"IKEA"}}
{"automation_type":"trigger","type":"action","subtype":"arrow_left_click","payload":"arrow_left_click","topic":"zigbee2mqtt/0x90fd9ffffedf1266/action","device":{"identifiers":["zigbee2mqtt_0x90fd9ffffedf1266"],"name":"0x90fd9ffffedf1266","sw_version":"Zigbee2MQTT 1.14.0","model":"TRADFRI remote control (E1524/E1810)","manufacturer":"IKEA"}}
```
- Trigger topic: `zigbee2mqtt/0x90fd9ffffedf1266/action`

View File

@ -11,6 +11,7 @@ ha_codeowners:
- '@klaasnicolaas'
ha_domain: easyenergy
ha_platforms:
- diagnostics
- sensor
ha_quality_scale: platinum
ha_integration_type: integration
@ -51,4 +52,4 @@ prices for electricity that you use (buy) or return (sell). Every day around
For the dynamic gas prices, only entities are created that display the
`current` and `next hour` price because the price is always fixed for
24 hours; new prices are published every morning at **05:00 UTC time**.
24 hours; new prices are published every morning at **05:00 UTC time**.

View File

@ -15,6 +15,7 @@ ha_iot_class: Cloud Polling
ha_config_flow: true
ha_codeowners:
- '@marthoc'
- '@marcolivierarsenault'
ha_domain: ecobee
ha_platforms:
- binary_sensor
@ -227,4 +228,4 @@ Enable/disable Smart Home/Away and Follow Me modes.
| ---------------------- | -------- | ------------------------------------------------- |
| `entity_id` | yes | ecobee thermostat on which to set occupancy modes |
| `auto_away` | yes | true or false |
| `follow_me` | yes | true or false |
| `follow_me` | yes | true or false |

View File

@ -10,6 +10,7 @@ ha_domain: emulated_hue
ha_integration_type: integration
ha_codeowners:
- '@bdraco'
- '@Tho85'
---
<div class='note warning'>

View File

@ -17,8 +17,6 @@ The `enigma2` platform allows you to control a Linux based set-top box which is
[OpenWebif](https://github.com/E2OpenPlugins/e2openplugin-OpenWebif) is an open source web interface for Enigma2 based set-top boxes.
Enigma2 devices should be discovered automatically by using [the discovery integration](/integrations/discovery/).
To manually add a set-top box to your installation, add the following to your `configuration.yaml` file:
```yaml

View File

@ -10,7 +10,7 @@ ha_category:
ha_release: 0.92
ha_iot_class: Local Polling
ha_codeowners:
- '@zxdavb'
- '@manzanotti'
ha_domain: geniushub
ha_platforms:
- binary_sensor

View File

@ -10,7 +10,7 @@ ha_codeowners:
- '@exxamalte'
ha_platforms:
- geo_location
ha_integration_type: integration
ha_integration_type: service
---
The `geo_json_events` platform lets you integrate GeoJSON feeds. It retrieves events from a feed and shows information of those events filtered by distance to Home Assistant's location.

View File

@ -2,7 +2,7 @@
title: Google Assistant SDK
description: Instructions on how to use Google Assistant SDK in Home Assistant.
ha_category:
- Utility
- Voice
ha_iot_class: Cloud Polling
ha_release: 2023.1
ha_config_flow: true
@ -12,6 +12,7 @@ ha_codeowners:
ha_integration_type: service
ha_platforms:
- notify
ha_quality_scale: platinum
---
The Google Assistant SDK integration allows Home Assistant to interact with Google Assistant. If you want to use Google Assistant (for example, from your phone or Google Home device) to interact with your Home Assistant managed devices, then you want the [Google Assistant](/integrations/google_assistant) integration.

View File

@ -21,7 +21,8 @@ The Google Mail integration allows you to connect your [Google Mail](https://mai
You need to configure developer credentials to allow Home Assistant to access your Google Account.
These credentials are the same as the ones for [Nest](/integrations/nest) and [Google Sheets](/integrations/google_sheets).
If you have already set up credentials, you can do step 1 and then skip to step 13 on the below instructions.
These are not the same as the one for [Google Calendar](/integrations/google).
If you have already set up the correct credentials, you can do step 1 and then skip to step 13 on the below instructions.
{% details "Generate Client ID and Client Secret" %}
@ -43,7 +44,7 @@ This section explains how to generate a Client ID and Client Secret on
13. Make sure **Publishing status** is set to production.
14. Click **Credentials** in the menu on the left-hand side of the screen, then click **Create credentials** (at the top of the screen), then select *OAuth client ID*.
15. Set the Application type to *Web application* and give this credential set a name (like "Home Assistant Credentials").
16. Add https://my.home-assistant.io/redirect/oauth to *Authorized redirect URIs* then click **Create**.
16. Add https://my.home-assistant.io/redirect/oauth to *Authorized redirect URIs* then click **Create**. This is not a placeholder and is the URI that must be used.
17. You will then be presented with a pop-up saying *OAuth client created* showing *Your Client ID* and *Your Client Secret*. Make a note of these (for example, copy and paste them into a text editor), as you will need these shortly. Once you have noted these strings, click **OK**. If you need to find these credentials again at any point, then navigate to *APIs & Services > Credentials*, and you will see *Home Assistant Credentials* (or whatever you named them in the previous step) under *OAuth 2.0 Client IDs*. To view both the *Client ID* and *Client secret*, click on the pencil icon; this will take you to the settings page for these credentials, and the information will be on the right-hand side of the page.
18. Double-check that the *Gmail API* has been automatically enabled. To do this, select **Library** from the menu, then search for *Gmail API*. If it is enabled you will see *API Enabled* with a green tick next to it. If it is not enabled, then enable it.

View File

@ -18,7 +18,7 @@ The `google_maps` platform allows you to detect presence using the unofficial AP
You need two Google accounts. Account A is the account that has to be set up to share its location with account B. Account B is used to fetch the location of your device(s) and will be connected to this integration.
1. You first have to setup sharing of the location of account A through the Google Maps app on your mobile phone. Share your location with account B. You can find more information [here](https://support.google.com/accounts?p=location_sharing).
2. Next, you have to retrieve a valid cookie from Google, while being logged in with account B. Log in with your credentials of account B on [Google Maps](https://www.google.com/maps) with a PC with Firefox or Chrome. Make sure to use the `.com` TLD (e.g., maps.google.com), otherwise the cookie won't be able to provide a valid session. After you have properly authenticated, you can retrieve the cookie with either [Export cookies](https://addons.mozilla.org/en-US/firefox/addon/export-cookies-txt/?src=search) for Firefox (make sure that "Prefix HttpOnly cookies" is unchecked) or [get_cookies.txt](https://chrome.google.com/webstore/detail/get-cookiestxt/bgaddhkoddajcdgocldbbfleckgcbcid?hl=en) for Chrome/Chromium.
2. Next, you have to retrieve a valid cookie from Google, while being logged in with account B. Log in with your credentials of account B on [Google Maps](https://www.google.com/maps) with a PC with Firefox or Chrome. Make sure to use the `.com` TLD (e.g., maps.google.com), otherwise the cookie won't be able to provide a valid session. After you have properly authenticated, you can retrieve the cookie with either [Export cookies](https://addons.mozilla.org/en-US/firefox/addon/export-cookies-txt/?src=search) for Firefox (make sure that "Prefix HttpOnly cookies" is unchecked) or [get_cookies.txt locally](https://chrome.google.com/webstore/detail/get-cookiestxt-locally/cclelndahbckbenkjhflpdbgdldlbecc) for Chrome/Chromium.
3. Save the cookie file to your Home Assistant configuration directory with the following name: `.google_maps_location_sharing.cookies.` followed by the slugified username of the NEW Google account (account B).
- For example: If your email address was `location.tracker@gmail.com`, the filename would be: `.google_maps_location_sharing.cookies.location_tracker_gmail_com`.

View File

@ -20,8 +20,9 @@ The integration currently only has access to that one document that is created d
## Prerequisites
You need to configure developer credentials to allow Home Assistant to access your Google Account.
These credentials are the same as the ones for [Nest](/integrations/nest).
If you have already set up credentials, you can do step 1 and then skip to step 13 on the below instructions.
These credentials are the same as the ones for [Nest](/integrations/nest) and [Google Mail](/integrations/google_mail).
These are not the same as the one for [Google Calendar](/integrations/google).
If you have already set up the correct credentials, you can do step 1 and then skip to step 13 on the below instructions.
{% details "Generate Client ID and Client Secret" %}
@ -43,7 +44,7 @@ This section explains how to generate a Client ID and Client Secret on
13. Make sure **Publishing status** is set to production.
14. Click **Credentials** in the menu on the left hand side of the screen, then click **Create credentials** (at the top of the screen), then select *OAuth client ID*.
15. Set the Application type to *Web application* and give this credential set a name (like "Home Assistant Credentials").
16. Add https://my.home-assistant.io/redirect/oauth to *Authorized redirect URIs* then click **Create**.
16. Add https://my.home-assistant.io/redirect/oauth to *Authorized redirect URIs* then click **Create**. This is not a placeholder and is the URI that must be used.
17. You will then be presented with a pop-up saying *OAuth client created* showing *Your Client ID* and *Your Client Secret*. Make a note of these (for example, copy and paste them into a text editor) as you will need these shortly. Once you have noted these strings, click **OK**. If you need to find these credentials again at any point then simply navigate to *APIs & Services > Credentials* and you will see *Home Assistant Credentials* (or whatever you named them in the previous step) under *OAuth 2.0 Client IDs*. To view both the *Client ID* and *Client secret*, click on the pencil icon, this will take you to the settings page for these credentials and the information will be on the right hand side of the page.
18. Double check that the *Google Drive API* has been automatically enabled. To do this, select **Library** from the menu, then search for *Google Drive API*. If it is enabled you will see *API Enabled* with a green tick next to it. If it is not enabled, then enable it.

View File

@ -7,9 +7,7 @@ ha_category:
ha_release: 0.99
ha_iot_class: Cloud Polling
ha_codeowners:
- '@indykoning'
- '@muppet3000'
- '@JasperPlant'
ha_domain: growatt_server
ha_platforms:
- sensor

View File

@ -43,7 +43,10 @@ Note that it depends on the appliance and on API permissions which of the featur
- OAuth Flow: Authorization Code Grant Flow
- Redirect URI: `https://my.home-assistant.io/redirect/oauth`
*Important*: after performing the steps above **log out** of your Home Connect Developer account. If you don't so this, the configuration steps below will fail during OAuth authentication with the message `“error”: “unauthorized_client”`.
*Important*:
- After performing the steps above **log out** of your Home Connect Developer account. If you don't do this, the configuration steps below will fail during OAuth authentication with the message `“error”: “unauthorized_client”`.
- The provided Home Connect User Account email address **must** be all lowercase otherwise it will result in authentication failures.
- All changes in the developer portal take 15 minutes before the change is implemented.
{% details "I have manually disabled My Home Assistant" %}

View File

@ -29,7 +29,7 @@ ha_platforms:
ha_integration_type: integration
---
The [Homematic](https://www.homematic.com/) integration provides bi-directional communication with your CCU/Homegear. It uses an XML-RPC connection to set values on devices and subscribes to receive events the devices and the CCU emit.
The [Homematic](https://www.eq-3.com/products/homematic.html) integration provides bi-directional communication with your CCU/Homegear. It uses an XML-RPC connection to set values on devices and subscribes to receive events the devices and the CCU emit.
If you are using Homegear with paired [Intertechno](https://intertechno.at/) devices, uni-directional communication is possible as well.
There is currently support for the following device types within Home Assistant:
@ -54,7 +54,7 @@ Since CCU Version 3, the internal firewalls are enabled by default. You have to
If you want to see if a specific device you have is supported, head over to the [pyhomematic](https://github.com/danielperna84/pyhomematic/tree/master/pyhomematic/devicetypes) repository and browse through the source code. A dictionary with the device identifiers (e.g., HM-Sec-SC-2) can be found within the relevant modules near the bottom. If your device is not supported, feel free to contribute.
We automatically detect all devices we currently support and try to generate useful names. If you enable name-resolving, we try to fetch names from Metadata (Homegear), via JSON-RPC or the XML-API you may have installed on your CCU. Since this may fail this is disabled by default.
You can manually rename the created entities by using Home Assistant's [Customizing](/docs/configuration/customizing-devices/) feature. The Homematic integration is also supported by the [Entity Registry](https://developers.home-assistant.io/docs/en/entity_registry_index.html), which allows you to change the friendly name and the entity ID directly in the Home Assistant UI.
You can manually rename the created entities by using Home Assistant's [Customizing](/docs/configuration/customizing-devices/) feature. The Homematic integration is also supported by the [Entity Registry](https://developers.home-assistant.io/docs/entity_registry_index/), which allows you to change the friendly name and the entity ID directly in the Home Assistant UI.
## Configuration

View File

@ -62,7 +62,7 @@ Sensors for P1 meter, only available when smart meter exposes these values:
- **Active frequency (Hz)**: Net frequency.
- **Voltage sags and swells**: Number of times a voltage sag or well has been detected.
- **Power failures**: Two sensors that indicate the number of power failures that have been detected by the smart meter. One for all power failures and another for 'long' power failures.
- **Peak demand**: Belgium users are started to get charged for the peak usage per month (see [capaciteitstarief](https://www.fluvius.be/nl/thema/factuur-en-tarieven/capaciteitstarief)). Two sensors are available: One that shows the current quarterly average and another that shows the peak measured this month. Both these sensors are provided directly from the smart meter and can be used to keep the peak as low as possible.
- **Peak demand**: Belgium users are started to get charged for the peak usage per month (see [capaciteitstarief](https://www.fluvius.be/thema/factuur-en-tarieven/capaciteitstarief)). Two sensors are available: One that shows the current quarterly average and another that shows the peak measured this month. Both these sensors are provided directly from the smart meter and can be used to keep the peak as low as possible.
Sensors for Water meter:

View File

@ -19,14 +19,40 @@ ha_integration_type: integration
The Honeywell integration integrates Home Assistant with _US-based_ [Honeywell Total Connect Comfort (TCC)](https://mytotalconnectcomfort.com/portal/) climate systems.
It uses the [somecomfort](https://github.com/kk7ds/somecomfort) client library. It does not support the home security functionality of TCC.
If your system is compatible with this integration, then you will be able access it via [https://mytotalconnectcomfort.com/portal/](https://mytotalconnectcomfort.com/portal/) (note the `/portal/`).
- [Supported hardware](#supported-hardware)
- [Climate](#climate)
- [Sensor](#sensor)
{% include integrations/config_flow.md %}
## Supported hardware
Home Assistant is integrated with the following devices through [https://mytotalconnectcomfort.com/portal/](https://mytotalconnectcomfort.com/portal/):
- Thermostats
- Every thermostat is exposed as a climate entity
- Known working devices: TH6320R1004, RTH9585WF1004
- Sensors
- A Temperature sensor entity.
- A Humidity sensor entity.
- Known working devices: C7089R1013
Others devices like Security systems are not currently supported by this integration
## Climate
The climate platform integrates Honeywell US-based thermostats into Home Assistant, allowing control of the thermostat through the user interface. The current inside temperature, operating mode, and fan state are also displayed on the thermostat card.
All [climate services](/integrations/climate) are supported except set_swing_mode
## Sensor
The sensor platform integrates outside temperature and outside humidity into Home Assistant as sensors for each device.
This integration will add Home Assistant sensors for the following:
|Sensor|Value|
--- | ---
|Outdoor temperature | Average temperature of all Honeywell Wireless Outdoor Sensors|
|Outdoor humidity | Average humidity of all Honeywell Wireless Outdoor Sensors|
{% include integrations/config_flow.md %}

View File

@ -147,7 +147,6 @@ Example of adding a tag to your notification. This won't create new notification
service: notify.html5
data:
message: "Last known sensor state is {{ states('sensor.sensor') }}."
data:
data:
tag: "notification-about-sensor"
```

View File

@ -0,0 +1,26 @@
---
title: Jasco
description: Connect and control your Jasco Z-Wave devices using the Z-Wave integration
ha_release: '2022.11'
ha_iot_class: Local Push
ha_category:
- Switch
- Plug
ha_domain: jasco
ha_integration_type: brand
works_with:
- zwave
ha_platforms:
- Switch
- Plug
ha_iot_standard: zwave
ha_brand: true
---
[Jasco](https://byjasco.com/) is a member of the Works with Home Assistant partner program for their Z-Wave products. Jasco is committed to making sure their products are up-to-date and ready to use in Home Assistant.
Jasco Z-Wave devices work locally and integrate seamlessly with the Z-Wave integration in Home Assistant (Z-Wave stick required). As all connectivity is happening locally, status updates and controlling your devices happen instantly in Home Assistant.
{% my add_zwave_device badge domain=page.ha_domain %}
[Learn more about Z-Wave in Home Assistant.](/integrations/zwave_js/)

View File

@ -171,7 +171,7 @@ type:
Every telegram that matches an address pattern with its destination field will be announced on the event bus as a `knx_event` event containing data attributes
- `data` contains the raw payload data (e.g., 1 or "[12, 55]").
- `destination` the KNX group address the telegram is sent to as string (e.g., "1/2/3).
- `destination` the KNX group address the telegram is sent to as string (e.g., "1/2/3").
- `direction` the direction of the telegram as string ("Incoming" / "Outgoing").
- `source` the KNX individual address of the sender as string (e.g., "1.2.3").
- `telegramtype` the APCI service of the telegram. "GroupValueWrite", "GroupValueRead" or "GroupValueResponse" generate a knx_event.

View File

@ -338,51 +338,6 @@ Konnected runs on an ESP8266 board with the NodeMCU firmware. It is commonly use
| 6 | RX | 9 | GPIO3 |
| ALARM or OUT | D8 | 8 | GPIO15 |
## Revision History
### 0.112
- Note that Device ID is used for Konnected Alarm Panel Pro and note that it is available on the status page.
### 0.108
- Multiple output states for a zone. Details on configuring additional panel behaviors via the UI.
### 0.106
- Added information on configuration and options flow. Mention that alarm panel FW should be updated before connecting.
### 0.91
- Improved Unique ID generation for Konnected switches
### 0.90
- Added support for `dht` and `ds18b20` temperature sensors
- Added Unique IDs
### 0.80
- Added ability to specify `host` and `port` to set up devices without relying on discovery.
- Added `discovery` and `blink` configuration options to enable/disable these features.
### 0.79
- Added `inverse` configuration option for binary sensors.
### 0.77
- Added support for momentary and beep/blink switches. [[#15973](https://github.com/home-assistant/home-assistant/pull/15973)]
- Decouple entity initialization from discovery, enabling devices to recover faster after a Home Assistant reboot. [[#16146](https://github.com/home-assistant/home-assistant/pull/16146)]
- **Breaking change:** Device `id` in `configuration.yaml` must now be the full 12-character device MAC address. Previously, omitting the first 6 characters was allowed.
### 0.72
- Adds `api_host` configuration option [[#14896](https://github.com/home-assistant/home-assistant/pull/14896)]
### 0.70
- Initial release
## Binary Sensor
The `konnected` binary sensor allows you to monitor wired door sensors, window sensors, motion sensors, smoke detectors, CO detectors, glass-break sensors, water leak sensors or any other simple wired open/close circuit attached to a NodeMCU ESP8266 Wi-Fi module running the [open source Konnected software](https://github.com/konnected-io/konnected-security).

View File

@ -14,7 +14,7 @@ ha_codeowners:
ha_config_flow: true
ha_platforms:
- media_player
ha_iot_class: Local Polling
ha_iot_class: Local Push
ha_ssdp: true
---

View File

@ -1,5 +1,5 @@
---
title: Matter
title: Matter (BETA)
description: Instructions on how to integrate Matter with Home Assistant.
ha_category:
- Binary Sensor
@ -10,11 +10,11 @@ ha_release: '2022.12'
ha_iot_class: Local Push
ha_config_flow: true
ha_codeowners:
- '@marcelveldt'
- '@MartinHjelmare'
- '@home-assistant/matter'
ha_domain: matter
ha_platforms:
- binary_sensor
- diagnostics
- light
- sensor
- switch
@ -200,4 +200,3 @@ _This option is only available for Home Assistant OS (the recommended installati
This option is considered a very advanced setup and only for experienced users. You can find instructions on how to run the Matter Server in the [project repository](https://github.com/home-assistant-libs/python-matter-server).
_Disclaimer: Some links on this page are affiliate links._

View File

@ -29,7 +29,7 @@ ha_platforms:
ha_integration_type: integration
---
The Mazda Connected Services integration allows you to control and retrieve data from a Mazda vehicle. In order to use this integration, you must first register your vehicle using the MyMazda app ([iOS](https://apps.apple.com/us/app/mymazda/id451886367)/[Android](https://play.google.com/store/apps/details?id=com.interrait.mymazda)).
The Mazda Connected Services integration allows you to control and retrieve data from a Mazda vehicle. In order to use this integration, you must first register your vehicle using the MyMazda app ([iOS](https://apps.apple.com/app/mymazda/id451886367)/[Android](https://play.google.com/store/apps/details?id=com.interrait.mymazda)).
This integration requires an active Mazda Connected Services subscription and a compatible vehicle. The following Mazda vehicles are Mazda Connected Services capable:

View File

@ -535,7 +535,7 @@ The following software has built-in support for MQTT discovery:
- [WyzeSense2MQTT](https://github.com/raetha/wyzesense2mqtt)
- [Xiaomi DaFang Hacks](https://github.com/EliasKotlyar/Xiaomi-Dafang-Hacks)
- [Zehnder Comfoair RS232 MQTT](https://github.com/adorobis/hacomfoairmqtt)
- [Zigbee2mqtt](https://github.com/koenkk/zigbee2mqtt)
- [Zigbee2MQTT](https://github.com/koenkk/zigbee2mqtt)
- [Zwave2Mqtt](https://github.com/OpenZWave/Zwave2Mqtt) (starting with 2.0.1)
### Discovery examples

View File

@ -157,7 +157,7 @@ If you have set [`login_attempts_threshold`](/integrations/http/) and forget to
## Switch
The `mystrom` switch platform allows you to control the state of your [myStrom](https://mystrom.ch/en/) switches.
The `mystrom` switch platform allows you to control the state of your [myStrom](https://mystrom.ch/) switches.
### Setup

View File

@ -20,12 +20,12 @@ In your `configuration.yaml` file type:
```yaml
tts:
- platform: google_translate
service_name: google_say
service_name: google_translate_say
notify:
- platform: tts
name: in_the_living_room
tts_service: tts.google_say
tts_service: tts.google_translate_say
media_player: media_player.living_room
```

View File

@ -13,7 +13,7 @@ ha_platforms:
ha_integration_type: integration
---
The `openhome` platform allows you to connect an [Openhome Compliant Renderer](http://openhome.org/) to Home Assistant such as a [Linn Products Ltd](https://www.linn.co.uk) HiFi streamer. It will allow you to control media playback, volume, source and see the current playing item. Openhome devices should be discovered by using [the discovery component](/integrations/discovery/), their device names are taken from the name of the room configured on the device.
The `openhome` platform allows you to connect an [Openhome Compliant Renderer](http://openhome.org/) to Home Assistant such as a [Linn Products Ltd](https://www.linn.co.uk) HiFi streamer. It will allow you to control media playback, volume, source and see the current playing item.
### Example `configuration.yaml` entry

View File

@ -22,7 +22,7 @@ Some examples of its use include:
The Proximity entity which is created has the following values:
- `state`: Distance from the monitored zone (in km)
- `state`: Distance from the monitored zone (in `unit_of_measurement`)
- `dir_of_travel`: Direction of the closest device or person to the monitored zone. Values are:
- `not set`
- `arrived`

View File

@ -75,7 +75,7 @@ recorder:
default: 10
type: integer
commit_interval:
description: How often (in seconds) the events and state changes are committed to the database. The default of `5` allows events to be committed almost right away without trashing the disk when an event storm happens. Increasing this will reduce disk I/O and may prolong disk (SD card) lifetime with the trade-off being that the logbook and history will lag. If this is set to `0` (zero), commit are made as soon as possible after an event is processed.
description: How often (in seconds) the events and state changes are committed to the database. The default of `5` allows events to be committed almost right away without trashing the disk when an event storm happens. Increasing this will reduce disk I/O and may prolong disk (SD card) lifetime with the trade-off being that the database will lag (the logbook and history will not lag, because the changes are streamed to them immediatelly). If this is set to `0` (zero), commit are made as soon as possible after an event is processed.
required: false
default: 5
type: integer

View File

@ -3,6 +3,7 @@ title: Reolink IP NVR/camera
description: Instructions on how to integrate Reolink devices (NVR/cameras) into Home Assistant.
ha_category:
- Camera
- Update
ha_iot_class: Local Push
ha_release: 2023.1
ha_domain: reolink
@ -12,6 +13,8 @@ ha_config_flow: true
ha_platforms:
- binary_sensor
- camera
- number
- update
ha_integration_type: integration
ha_dhcp: true
---
@ -146,6 +149,7 @@ The following models have been tested and confirmed to work:
- C2 Pro
- E1 Zoom
- E1 Outdoor
- RLC-410
- RLC-410W
- RLC-411
- RLC-420
@ -158,7 +162,10 @@ The following models have been tested and confirmed to work:
- RLC-810A
- RLC-811A
- RLC-820A
- RLC-822A
- RLC-823A
- RLC-833A
- RLC-1224A
- RLN8-410 NVR
- RLN16-410 NVR
- Reolink Duo Floodlight PoE
@ -170,6 +177,7 @@ Battery-powered cameras are not yet supported.
The following models are lacking the HTTP webserver API and can therfore not work with this integration:
- E1 Pro
- E1
## Troubleshooting

View File

@ -8,6 +8,8 @@ ha_iot_class: Cloud Polling
ha_config_flow: true
ha_codeowners:
- '@OnFreund'
- '@elad-bar'
- '@maorcc'
ha_domain: rympro
ha_platforms:
- sensor

View File

@ -145,15 +145,6 @@ sensor:
description: Defines a template for the entity picture of the sensor.
required: false
type: template
attributes:
description: Defines templates for attributes of the sensor.
required: false
type: map
keys:
"attribute: template":
description: The attribute and corresponding template.
required: true
type: template
device_class:
description: Sets the class of the device, changing the device state and icon that is displayed on the UI (see below). It does not set the `unit_of_measurement`.
required: false

View File

@ -8,7 +8,7 @@ ha_category:
- Hub
- Sensor
- Switch
ha_iot_class: Local Polling
ha_iot_class: Local Push
ha_config_flow: true
ha_dhcp: true
ha_codeowners:

View File

@ -47,8 +47,8 @@ The type of data a sensor returns impacts how it is displayed in the frontend. T
- **nitrous_oxide**: Concentration of Nitrous Oxide in µg/m³
- **ozone**: Concentration of Ozone in µg/m³
- **pm1**: Concentration of particulate matter less than 1 micrometer in µg/m³
- **pm10**: Concentration of particulate matter less than 10 micrometers in µg/m³
- **pm25**: Concentration of particulate matter less than 2.5 micrometers in µg/m³
- **pm10**: Concentration of particulate matter less than 10 micrometers in µg/m³
- **power_factor**: Power factor (unitless), unit may be `None` or %
- **power**: Power in W or kW
- **precipitation**: Accumulated precipitation in cm, in or mm

View File

@ -1,6 +1,6 @@
---
title: Shark IQ
description: Instructions on how to integrate your Shark IQ vacuum robot with Home Assistant.
description: Integrate your Shark IQ robot vacuum with Home Assistant.
ha_category:
- Vacuum
ha_iot_class: Cloud Polling
@ -9,7 +9,6 @@ ha_config_flow: true
ha_codeowners:
- '@JeffResc'
- '@funkybunch'
- '@AritroSaha10'
ha_domain: sharkiq
ha_platforms:
- vacuum
@ -18,12 +17,6 @@ ha_integration_type: integration
The `sharkiq` integration allows you to control your [Shark IQ](https://www.sharkclean.com/vacuums/robot-vacuums/) vacuum.
<p class='img'>
<img src='/images/screenshots/more-info-dialog-sharkiq.png' />
</p>
This platform has been tested and is confirmed to be working with the Shark IQ R101AE robot vacuum with self-empty base but should also work with the R100.
{% include integrations/config_flow.md %}
## Services
@ -36,6 +29,8 @@ Currently supported services are:
- `return_to_base`
- `locate`
If `pause` does not work for you, then it is not supported by your vacuum. The `stop` service will provide similar functionality.
## Troubleshooting
### Integration Disconnecting

View File

@ -65,6 +65,40 @@ recipients:
type: string
{% endconfiguration %}
## Sending messages to Signal to trigger events
You can use Signal Messenger REST API as a Home Assistant trigger. In this example, we will make a simple chatbot. If you write anything to your Signal account linked to Signal Messenger REST API, the automation gets triggered, with the condition that the number (attribute source) is correct, to take action by sending a Signal notification back with a "Message received!".
To accomplish this, edit the configuration of Home Assistant, adding a [RESTful resource](/integrations/rest/) as follows:
```yaml
- resource: "http://127.0.0.1:8080/v1/receive/<number>"
headers:
Content-Type: application/json
sensor:
- name: "Signal message received"
value_template: "{{ value_json[0].envelope.dataMessage.message }}" #this will fetch the message
json_attributes_path: $[0].envelope
json_attributes:
- source #using attributes you can get additional information, in this case, the phone number.
```
You can create an automation as follows:
```yaml
...
trigger:
- platform: state
entity_id:
- sensor.signal_message_received
attribute: source
to: "<yournumber>"
action:
- service: notify.signal
data:
message: "Message received!"
```
## Examples
A few examples on how to use this integration as actions in automations.

View File

@ -41,7 +41,7 @@ There is currently support for the following device types within Home Assistant:
## SimpliSafe Plans
SimpliSafe offers several [monitoring plans](https://support.simplisafe.com/hc/en-us/articles/360023809972-What-are-the-service-plan-options-). Currently, only the Standard and Interactive Monitoring are known to work with this integration; if you find otherwise, please consider updating this documentation.
SimpliSafe offers several [monitoring plans](https://support.simplisafe.com/articles/alarm-events-monitoring/what-are-the-service-plan-options/6344794a013ba90af0bce6a4). Currently, only the Standard and Interactive Monitoring are known to work with this integration; if you find otherwise, please consider updating this documentation.
{% include integrations/config_flow.md %}

View File

@ -13,7 +13,7 @@ ha_platforms:
ha_integration_type: integration
---
The `sinch` platform uses [Sinch](https://www.sinch.com/products/messaging/sms/) to deliver notifications from Home Assistant.
The `sinch` platform uses [Sinch](https://www.sinch.com/products/apis/messaging/sms/) to deliver notifications from Home Assistant.
## Prerequisites

View File

@ -26,7 +26,7 @@ ha_integration_type: integration
The `tellduslive` integration let you connect to [Telldus Live](https://live.telldus.com). It's cloud platform that connects to your Tellstick Net or Tellstick ZNet connected gear at home.
Home Assistant will automatically discover the presence of a Tellstick Net or Tellstick ZNet on your local network if the [discovery](/integrations/discovery/) integration is enabled. When discovery and the key exchange with Telldus Live have been completed, you will be presented with an option to integrate with the cloud or local API for direct communication with your hardware in your LAN. Local API supports only one device at this stage. Local API is only supported with the Znet Lite products, the older hardware (such as Tellstick Net) does not support local API.
Local API supports only one device at this stage. Local API is only supported with the Znet Lite products, the older hardware (such as Tellstick Net) does not support local API.
## Configuration

View File

@ -9,6 +9,9 @@ ha_domain: thread
ha_iot_class: Local Polling
ha_integration_type: service
ha_config_flow: true
ha_platforms:
- diagnostics
ha_zeroconf: true
---
The Thread integration helps you track the different Thread networks in your home and helps you manage their credentials. It is currently a work in progress.
@ -19,4 +22,6 @@ To connect a Thread network to Home Assistant, Thread Border Routers (TBRs) are
Home Assistant communicates with TBRs over the local network. This means that TBRs do not have to be physically attached to Home Assistant to be used. You might already have a TBR as part of other products in your home, like a Google Nest Hub Gen 2 or Apple HomePod Mini. Each vendor forms their own network when you start using their products, so you can end up having a Home Assistant, an Apple, and a Google Thread network in your home. These are all separate networks using different credentials, which prevents devices to roam between TBRs.
It is possible to align credentials for TBRs from different vendors and have them form a single network together. This allows you to freely move devices between rooms without losing connectivity. To do this, you need to make sure that all TBRs use the same credentials.
It is possible to align credentials for TBRs from different vendors and have them form a single network together. This allows you to freely move devices between rooms without losing connectivity. To do this, you need to make sure that all TBRs use the same credentials. Sadly, this works differently for each TBR vendor.
Home Assistant will sync the Thread credentials with Google when starting to commission a Matter device via the Home Assistant Companion app. For other vendors, if the vendor allows you to see the operational dataset in TLV format, you can import it to Home Assistant from the Thread panel.

View File

@ -1,5 +1,5 @@
---
title: TP-Link Omada SDN Controller
title: TP-Link Omada
description: Instructions on integrating TP-Link Omada SDN networking devices to Home Assistant.
ha_category:
- Hub
@ -11,10 +11,10 @@ ha_codeowners:
ha_domain: tplink_omada
ha_platforms:
- switch
ha_integration_type: integration
ha_integration_type: hub
---
The TP-Link Omada SDN Controller integration allows you to control your [TP-Link Omada SDN Devices](https://www.tp-link.com/us/omada-sdn/) such as network switches, access points, and internet gateways. It requires a local Omada controller (software or hardware controllers) and does not currently support the paid-for TP-Link Omada Cloud Management SAAS Platform.
The TP-Link Omada SDN Controller integration allows you to control your [TP-Link Omada SDN Devices](https://www.tp-link.com/omada-sdn/) such as network switches, access points, and internet gateways. It requires a local Omada controller (software or hardware controllers) and does not currently support the paid-for TP-Link Omada Cloud Management SAAS Platform.
The integration provides basic configuration and status of Omada devices controlled by the controller. All supported devices connected to the controller will be added to Home Assistant.

View File

@ -16,7 +16,7 @@ ha_integration_type: integration
---
The `workday` binary sensor indicates whether the current day is a workday or not. It allows specifying which days of the week will count as workdays and also
uses the Python module [holidays](https://pypi.python.org/pypi/holidays) to incorporate information about region-specific public holidays.
uses the Python module [holidays](https://pypi.org/project/holidays/) to incorporate information about region-specific public holidays.
This can be used to make automations that act differently on weekdays vs weekends. For example, you could make your bedroom lights turn on (gently) at 7 in the morning if it is a weekday, but wait until 11 if it is a weekend day.

View File

@ -67,6 +67,18 @@ There is currently support for the following device types within Home Assistant:
There is also support for grouping of lights, switches, and fans (i.e. support for commanding device groups as entities). At least two entities must be added to a group before the group entity is created. As well as support for binding/unbinding (i.e. bind a remote to a lightbulb or group).
## Introduction
ZHA integration is a Zigbee gateway implementation that follows the standard Zigbee 3.0 specification (and earlier revisions). In Zigbee, there are three different device types: Zigbee Coordinator (ZC), Zigbee Router (ZR), and Zigbee End Device (ZED). A Zigbee network always has one (and no more) Zigbee Coordinator, however, a Zigbee network can have multiple Zigbee Routers and multiple Zigbee End Devices.
A Zigbee Coordinator is the central device in a Zigbee network that manages and controls the network. It acts as a physical interface for the Zigbee wireless protocol, as well as being responsible for maintaining the Zigbee network topology and ensuring secure and efficient communication between Zigbee devices. Zigbee Router devices are mains-powered and will act as Zigbee signal repeaters within the Zigbee network mesh to extend its range and improve coverage, while Zigbee End Device devices are usually battery-operated sensors that will not act as Zigbee signal repeaters.
In the case of ZHA, the Zigbee Coordinator is a radio adapter or hardware module, that contains a microcontroller that runs the Zigbee protocol stack which the ZHA integration uses to manage and communicate with a Zigbee network and its devices.
Before installing the ZHA integration, you will need to buy and connect a Zigbee Coordinator radio adapter or hardware module, those usually come in the form of a USB dongle that plugs directly into the computer that is running the Home Assistant installation. The ZHA integration can work with many different "Zigbee Coordinator" adapters, however, be sure to read the respective sections below about compatible Zigbee radio adapters and hardware modules.
Once ZHA has been set up and the Zigbee Coordinator radio adapter or module is configured, you will be able to directly join/pair any Zigbee device to the Zigbee network; regardless of the manufacturer and brand of that Zigbee-based product. Note, that while it is generally recommended to buy Zigbee 3.0 compliant devices as those should, in theory, offer greater interoperability, be sure of the sections about which devices are supported and exception handling.
## Compatible hardware
ZHA integration uses a hardware independent Zigbee stack implementation with modular design, which means that it can support any one of the many Zigbee coordinator radio modules/adapters available from different manufacturers, as long as that module/adapter is compatible with [zigpy](https://github.com/zigpy/zigpy).
@ -424,7 +436,15 @@ Within ZHA is possible to use this backup and restore feature to migrate between
## Troubleshooting
To help resolve any kinks or compatibility problems, report bugs as issues with debug logs. Please follow the instructions in this troubleshooting section.
To help resolve any kinks or compatibility problems, report bugs as issues with debug logs. Please note the current limitations and follow the instructions in this troubleshooting section.
### Limitations
Note that ZHA only supports connecting a single dedicated Zigbee Coordinator radio adapter or module with a single Zigbee network and that the Zigbee Coordinator cannot already be connected or used by any other application. Any devices that are or have previously been connected to another Zigbee implementation will also need to first be reset to their factory default settings before they can be paired/joined to ZHA, please see each device manufacturer's documentation.
ZHA does currently not support devices that can only use the ZGP ("Zigbee Green Power") profile which is used in a few batteryless self-powered or energy harvesting devices, (such as for example; Philips Hue Click, Philips Hue Tap, and some "Friends of Hue" partnership switches).
ZHA does not currently support devices that can only use the ZSE ("Zigbee Smart Energy") profile, that is however due to the "Zigbee SE" specification not being part of the standard Zigbee 3.0 specification and thus not implemented in most of the Zigbee protocol stacks that are commonly available Zigbee Coordinator radio adapters and modules.
### Knowing which devices are supported
@ -438,7 +458,55 @@ Home Assistant's ZHA integration already supports most standard device types out
The few devices that will, for example, not join/pair properly or, while joined/paired, do not present all attributes in the ZHA integration likely deviate from the Zigbee specifications set by the [CSA (Connectivity Standards Alliance)](https://csa-iot.org/all-solutions/zigbee/). These devices may therefore require the creation of a bug report by a device owner, supplying debug logs. The device owner may need to actively assist in troubleshooting by providing the information developers need to create custom ZHA Device Handlers.
### Zigbee interference avoidance and network range/coverage optimization
Sources of interference for radios can lead to transmission/reception loss or connection problems and show symptoms such as errors/failures when sending and receiving Zigbee messages/signals that can cause significant degradation in performance or even prevent devices from communicating at all. Below are some basic but essential tips for getting a good setup starting point to achieve better signal quality, improved coverage, and extended range.
Following all these optimization tips below should significantly improve the reception of your Zigbee radio adapter. The below insights describe working around the well-known limitations of low-power/low-bandwidth 2.4 GHz digital radios. It can that way resolve or avoid many known issues caused by interference or poor placement of your Zigbee radio adapter or devices.
All electric devices/appliances, especially computers and computer peripherals, generate [EMI/EMF/RMI (electromagnetic fields that cause electromagnetic interference (often called radio-frequency interference, also commonly called signal noise in layman's terms)](https://en.wikipedia.org/wiki/Electromagnetic_interference), which can interfere with signals transmissions on the 2.4 GHz radio band frequency, and in practice partially degrade or even fully jam the wireless communication messages between your Zigbee adapter/devices.
For example, interference from USB 3.x ports, unshielded USB 3.x devices, and non-shielded USB 3.x peripheral cables are especially infamously known to affect 2.4 GHz radio reception for low-power/low-bandwidth devices. Therefore you should always place your Zigbee adapter far away as possible from any potential sources of EMI/EMI/RMI, preferably by using an adequately long shielded USB extension cable connected to a USB 2.0 port.
Zigbee also uses [mesh networking topology](https://en.wikipedia.org/wiki/Mesh_networking), which means that most mains-powered devices are a "Zigbee Router" that can act as a signal repeater and range extended by transmitting data over long distances by passing data messages through the Zigbee network mesh of intermediate devices to reach more distant Zigbee devices. Thus to have a healthy Zigbee network, you need many Zigbee Router devices relatively close to each other in order to achieve good coverage and range.
##### Actions to optimize Zigbee Coordinator radio hardware
Common root causes of unreliable performance are often seen with outdated Zigbee Coordinator radio adapter hardware, limited by obsolete chips, bad antenna designs, or old/buggy firmware. You can improve most Zigbee setups by using a good Zigbee Coordinator radio adapter and maintaining it.
- Buy and use a supported Zigbee Coordinator USB adapter based on newer/modern chip hardware.
- Consider a Zigbee Coordinator USB adapter with an external antenna for more flexibility.
- Update to a later version of Zigbee Coordinator firmware on the existing radio adapter.
- Most manufacturers usually provide straightforward guides for updating the firmware.
- Try different physical placement and orientations of the Zigbee Coordinator and its antenna.
- Optimal placement of the Zigbee adapter is close to the middle of the house as possible.
- Try placing Zigbee Coordinator at some distance away from walls, ceilings, and floors.
- Try different orientations of the Zigbee Coordinator adapter or its antenna.
While using an older Zigbee Coordinator radio adapter hardware might work, using obsolete hardware and/or old firmware can prevent reliable operation. It is also generally a good idea to upgrade Zigbee Coordinator firmware before troubleshooting any further if and when run into problems with devices.
##### Actions to avoid or workaround EMI/EMF/RMI interference
Since all Zigbee Coordinator radio adapters are very sensitive/susceptible to all types of EMI/EMF/RMI you should always try to optimize the placement of the Zigbee Coordinator and avoid known sources of interference.
- Use a long USB extension cable and place Zigbee Coordinator away from interference and obstacles.
- Ensure the USB extension cable is adequately shielded (thicker cables usually have better shielding).
- Place Zigbee Coordinator away from electrical wires/cables, power supplies, and household appliances.
- Extension cables also makes it easier to try different orientations of the adapter/antenna.
- Avoid USB 3.0 ports/computers/peripherals as they are known culprits of RFI/EMI/EMF disruption. (See Ref. [1](https://www.usb.org/sites/default/files/327216.pdf) and [2](https://www.unit3compliance.co.uk/2-4ghz-intra-system-or-self-platform-interference-demonstration/)).
- Make sure to only connect the Zigbee USB adapter to a USB 2.0 port (and not to a USB 3.x port).
- If a computer only has USB 3.x ports then buy and connect Zigbee Coordinator via a powered USB 2.0 hub.
- Shield any unshielded computers/peripherals/devices by adding all-metal enclosures/chassis/casings.
- Use shielded USB cables for all external peripherals/devices, especially USB 3.x peripherals.
- Be aware that metal casings can decrease the performance of an internal/built-in Zigbee Coordinator.
- Avoid Wi-Fi Routers and Wi-Fi Access Points, alternatively change the Wi-Fi channel or Zigbee channel.
- Place your Zigbee Coordinator away from any Wi-Fi access points and all other sources of WiFi.
- Wi-Fi frequency ranges can overlap with Zigbee, see the section above on defining Zigbee channel use.
### Reporting issues

View File

@ -44,7 +44,7 @@ ha_integration_type: hub
ha_zeroconf: true
---
This integration allows you to control a Z-Wave network via the [Z-Wave JS](https://zwave-js.github.io/node-zwave-js/#/) driver. This is our recommended Z-Wave integration for Home Assistant. If you're migrating from the legacy `zwave`, see [our migration instructions](#migrating-from-previous-z-wave-implementations).
This integration allows you to control a Z-Wave network via the [Z-Wave JS](https://zwave-js.github.io/node-zwave-js/#/) driver.
To Run Z-Wave you will need a [Supported Z-Wave dongle](/docs/z-wave/controllers/#supported-z-wave-usb-sticks--hardware-modules), a running Z-Wave JS server (using only **one** of the add-ons or installation methods described below), and the Z-Wave integration.
@ -575,65 +575,32 @@ In addition to the [standard automation trigger data](/docs/automation/templatin
| `trigger.event` | Name of event. |
| `trigger.event_data` | Any data included in the event. |
## Migrating from previous Z-Wave implementations
## Advanced Features (UI Only)
If you are switching from the legacy `zwave` integration to the new Z-Wave integration, you will not need to recreate your entire network, as the network is **stored on your stick**. A few things, such as how you receive [central scene events](#events) will work differently than they did before.
While the integration aims to provide as much functionality as possible through existing Home Assistant constructs (entities, states, automations, services, etc.), there are some features that are only available through the UI.
### Automatic migration wizard
All of these features can be accessed either in the Z-Wave integration configuration panel or in a Z-Wave device's device panel.
If you are using the legacy `zwave` integration, there is a migration wizard that will help you set up the Z-Wave integration, remove the legacy `zwave` integration and migrate the entities and devices that can be mapped from the legacy `zwave` integration to the Z-Wave integration. The migration wizard is available from the legacy `zwave` integration configuration panel in the GUI.
### Integration Configuration Panel
Some entities may not be able to migrate automatically and you will need to rename the corresponding available Z-Wave entities manually. Before completing the migration you will be shown a list of entities that could not be migrated automatically, and you'll have the option to abort or continue with the migration.
The following features can be accessed from the integration configuration panel:
### Manual migration path from legacy `zwave` or OpenZWave
- **Add device:** Allows you to pre-provision a SmartStart device or start the inclusion process for adding a new device to your network.
- **Remove device:** Starts the exclusion process for removing a device from your network.
- **Heal network:** Forces your network to rediscover routes to the controller from each device. This is useful when devices or the controller have moved to a new location, or if you are having significant problems with your network, but it also generates a lot of network traffic and should be used sparingly.
- **Third party data opt-in/out:** Allows you to opt-in or out of telemetry that the zwave-js project collects to help inform development decisions, influence manufacturers, etc. This telemetry is disabled by default and has to be opted in to be activated.
- **[Controller statistics](https://zwave-js.github.io/node-zwave-js/#/api/controller?id=quotstatistics-updatedquot):** Provides statistics about communication between the controller and other devices, allowing you to troubleshoot your network's RF quality.
1) Make a **backup** of your Home Assistant configuration. You should do this so you'll be able to quickly revert if you encounter unexpected problems.
### Device Panel
<div class='note info'>Write down/copy your Z-Wave network key somewhere, you are going to need it later.</div>
The following features can be accessed from the device panel of a Z-Wave device:
<div class='note info'>Make a list of what node ID belongs to each device. Your network (Nodes and their config etc) is stored on the stick but the names you gave your devices and entities are not. This step is optional but will save you a lot of time later.</div>
2) Remove the legacy `zwave` or OpenZWave integration from Home Assistant: Settings --> Devices & Services --> Z-Wave (or OpenZWave) --> Press the three dots and click Delete.
<div class='note info'>
If you have configured the legacy `zwave` manually, make sure to also remove the `zwave:` section from your `configuration.yaml`.
</div>
3) If you were running the OpenZWave beta, make sure to stop (or even remove) the OpenZWave add-on, also make sure it doesn't start automatically at startup.
4) Restart your Home Assistant host. This step is important to make sure that your Z-Wave stick is released by the operating system.
5) Install the Z-Wave JS Server of your choice. If you run the supervisor and you'd like to run the standard add-on, you can skip this step if you want. The add-on is installed automatically for you when you choose so in the integration set-up. Remember to fill in the network key you've saved before.
6) Set up the Z-Wave integration and connect it to the server. You should see your nodes being detected by Home Assistant. Carefully watch if the status of the node is "ready". This means it's been fully interviewed (and those details cached) by the Z-Wave JS driver. Battery-powered nodes will only be interviewed when they wake up (at scheduled intervals) or if you manually wakeup the device (refer to the device's manual for instructions).
<div class='note info'>
Activating a battery powered sensor, such as opening a door sensor, is *not* the same as waking up the device.
</div>
7) Once a node is ready, the entities will be created. Only at this point, is it safe to rename the device (and so its entities). This is actually the only real hard part of the migration as you will need to name all your devices again.
8) Enjoy your super fast up-to-date Z-Wave network in Home Assistant with support for all modern devices!
#### Need more help with your migration to Z-Wave?
Please see our [Frequently Asked Questions](#frequently-asked-questions).
There are also a few topics created on the forums that might be helpful:
- [OpenZwave (beta) -> Z-Wave JS Official add-on](https://community.home-assistant.io/t/switching-from-openzwave-beta-to-zwave-js/276723)
- [OpenZwave (beta) -> ZwaveJS2MQTT](https://community.home-assistant.io/t/switching-from-openzwave-beta-to-zwavejs2mqtt/276724)
- [Z-Wave legacy (1.4) -> Z-Wave JS Official add-on](https://community.home-assistant.io/t/switching-from-zwave-1-4-to-zwave-js/276718/2)
- [Z-Wave legacy (1.4) -> ZwaveJS2MQTT](https://community.home-assistant.io/t/switching-from-zwave-1-4-to-zwavejs2mqtt/276721)
You can also visit the `#zwave` channel on [our discord](/join-chat/).
- **Configure:** Provides an easy way to look up and update configuration parameters for the device. While there is an existing service for setting configuration parameter values, this UI may sometimes be quicker to use for one off changes.
- **Re-interview:** Forces the device to go through the interview process again so that zwave-js can discover all of its capabilities. Can be helpful if you don't see all the expected entities for your device.
- **Heal:** Forces the device to rediscover its optimal route back to the controller. Use this if you think you are experiencing unexpected delays or RF issues with your device. Your device may be less responsive during this process.
- **Remove failed:** Forces the controller to remove the device from the controller. Can be used when a device has failed and it can't go through the normal exclusion process.
- **[Statistics](https://zwave-js.github.io/node-zwave-js/#/api/node?id=quotstatistics-updatedquot):** Provides statistics about communication between this device and the controller, allowing you to troubleshoot RF issues with the device.
- **Update firmware:** Updates a device's firmware using a manually uploaded firmware file. Only some devices support this feature (controllers and devices with the Firmware Update Metadata Command Class).
## Advanced installation instructions
@ -679,8 +646,6 @@ This is considered a very advanced use case. In this case you run the Z-Wave JS
For new installations, unique default keys will be auto-generated for you by the Z-Wave JS add-on. You can also generate those network keys in the Settings section of Z-Wave JS UI.
If migrating from the legacy `zwave` integration, your network key from those integration should be entered as the S0 network key. Those integrations did not support S2 security, so you will not yet have S2 network keys to configure.
Make sure that you keep a backup of these keys in a safe place. You will need to enter the same keys to be able to access securely paired devices.
</div>
@ -724,23 +689,6 @@ Some Z-Wave USB sticks can be auto-discovered, which can simplify the Z-Wave set
Additional devices may be discoverable, however only devices that have been confirmed discoverable are listed above.
#### Is there a way to easily export a dump of all my current Z-Wave nodes before I migrate?
You can run the script below in the Developer Tools to get a full oversight of your nodes and their entities.
{% raw %}
```yaml
{%- for node, zstates in states | selectattr('attributes.node_id', 'in', range(1000)) | groupby('attributes.node_id') %}
{%- for s in zstates %}
Node {{ node }};{{ s.name }};{{ s.entity_id }}{% endfor %}
{%- endfor %}
```
{% endraw %}
#### What happened to Zwavejs2Mqtt or the Z-Wave JS to MQTT add-on?
Zwavejs2Mqtt was renamed Z-Wave JS UI in September 2022. They are synonymous with no difference between their capabilities.
@ -779,11 +727,6 @@ Correct, the Z-Wave JS UI project existed before Home Assistant had plans to mov
Sure, in the settings of Z-Wave JS UI, make sure to enable "WS Server" and disable "Gateway".
#### How do I use my OZW network key in Z-Wave JS UI?
You can use your existing network key in Z-Wave JS UI but you need to slightly adjust it.
The OZW looks like this: `0x01, 0x02, 0x03 etc.` while the network key format accepted in Z-Wave JS UI looks like this `0102030405 etc.`. You can simply edit your existing key and remove the `"0x"` part and the `", "` part so it becomes one large string of numbers.
#### Should I name my devices in Home Assistant, or in Z-Wave JS UI?
Ultimately, this is a personal decision. If you provide a name or location for a device in the Z-Wave JS UI, that name will be imported into Home Assistant when the integration is reloaded or Home Assistant is restarted. Any entity names, however, will not change if the device has already been set up by Home Assistant. Names set in Z-Wave JS UI _will not_ overwrite changes that have already been made in Home Assistant.
@ -828,7 +771,7 @@ S2 security does not impose additional network traffic and provides additional b
#### I'm having a problem, what should I do first?
_Many_ reported issues result from RF interference caused by the system's USB ports. This can manifest in many ways, including devices that won't include at all, devices that won't include securely, sensors with erroneous values (packets corrupted), delayed control of devices, or no ability to control devices. These problems can be intermittent, and they may be newly apparent after switching from `ozw`, though they existed before, as Z-Wave interviews devices and reports errors differently.
_Many_ reported issues result from RF interference caused by the system's USB ports. This can manifest in many ways, including devices that won't include at all, devices that won't include securely, sensors with erroneous values (packets corrupted), delayed control of devices, or no ability to control devices.
**All users are encouraged to use a USB extension cable to prevent such interference.** Please try such a cable before opening an issue or requesting support on Discord. It will nearly always be the first troubleshooting step that we ask you to take anyway.

View File

@ -0,0 +1,820 @@
---
layout: post
title: "2023.3: Dialogs!"
description: "A brand new restart dialog, ask Assist about the state of your home, amazing new dialogs for lights and switches, Thread & Matter updates, control the precision of your sensors, and Python 3.11 support."
date: 2023-03-01 00:00:00
date_formatted: "March 1, 2023"
author: Franck Nijhof
author_twitter: frenck
comments: true
categories:
- Release-Notes
- Core
og_image: /images/blog/2023-03/social.png
---
<a href='/integrations/#version/2023.3'><img src='/images/blog/2023-03/social.png' style='border: 0;box-shadow: none;'></a>
Home Assistant Core 2023.3! 🎉
February was a short month, resulting in a short release cycle, but... That
didn't stop anybody from stuffing this release with many great improvements!
As the release title most fittingly puts it, most features of this release
show up in dialogs. New dialogs, restyled dialogs, new features that appear
in dialogs, and all sorts of new dialogues you can have with Assist. Something
with "dialogs" all over these release notes!
Besides dialogs, this release brings in three new integrations, updates to
Thread and Matter, and quite an impressive list of other noteworthy changes.
My personal favorite in this release is, undoubtedly, the all-new restart dialog.
It brings in proper choice, less navigation, and it looks slick! I am genuinely
really loving and enjoying the result. 🤩
Enjoy the release!
../Frenck
<!--more-->
- [Restarting Home Assistant](#restarting-home-assistant)
- [Asking Assist for the current state of things](#asking-assist-for-the-current-state-of-things)
- [Cleaner entity information dialogs](#cleaner-entity-information-dialogs)
- [New dialogs for lights, switches and siren entities](#new-dialogs-for-lights-switches-and-siren-entities)
- [Sensor display precision](#sensor-display-precision)
- [New create automation dialog](#new-create-automation-dialog)
- [Thread \& Matter](#thread--matter)
- [Python 3.11 support](#python-311-support)
- [Other noteworthy changes](#other-noteworthy-changes)
- [New Integrations](#new-integrations)
- [Release 2023.3.1 - March 2](#release-202331---march-2)
- [Release 2023.3.2 - March 8](#release-202332---march-8)
- [Release 2023.3.3 - March 9](#release-202333---march-9)
- [Need help? Join the community!](#need-help-join-the-community)
- [Breaking Changes](#breaking-changes)
- [All changes](#all-changes)
Don't forget to [join our release party live stream on YouTube](https://www.youtube.com/watch?v=3UaLAhG9Brc) 1 March 2023, at 12:00 PST / 21:00 CET!
<lite-youtube videoid="3UaLAhG9Brc" videotitle="Home Assistant 2023.2 Release Party"></lite-youtube>
## Restarting Home Assistant
Since we started redesigning our menu structure (a little over a year
ago), "Restarting" Home Assistant has been a source of discussion in our
community. Home Assistant can be restarted, reloaded, rebooted,
and powered off; it quickly became unclear what to use and when.
We've come up with a solution inspired by the good old Windows XP computer
turn-off screen. [@matthiasdebaat] made a UX that has been implemented
by [@piitaya] that will hopefully make this all better, more clear.
<img class="no-shadow" src='/images/blog/2023-03/restart-home-assistant.png' alt='Screenshot showing the new restart dialog of Home Assistant that provides a guidance on what action to take.'>
Nice, right? 🤩 What is entirely new is the first item shown: "Quick reload".
Quick reload calls all active integrations in your system that support
reloading YAML configuration on the fly 🚀.
This means all integrations individually listed as reloadable under the YAML
tab in the developer tools are reloaded simultaneously! Also, [@frenck] made
quick reload available as a {% my developer_call_service service="homeassistant.reload_all" title="service" %},
so you can automate with it.
Lastly, another place for finding it more easily; the option to restart has
also been added to the three-dotted overflow menu in the top right of the
settings screen.
[@frenck]: https://github.com/frenck
[@matthiasdebaat]: https://github.com/matthiasdebaat
[@piitaya]: https://github.com/piitaya
## Asking Assist for the current state of things
This release updates Assist with the capability to ask for the state of things
around your home. For example:
<img class="no-shadow" src='/images/blog/2023-03/ask-assist-for-states.png' alt='Screenshot showing the assist conversation dialog demonstrating new intents to get the state of things in your home.'>
Intents for three types of questions have been added:
- Ask for the state of a single entity:
- _"What is the outside temperature?"_
- _"Is the front door locked?"_
- _"What is the power consumption in the office?"_
- Any or all questions:
- _"Are any lights on in the bedroom?"_
- _"Are all windows closed in the kitchen?"_
- How many or which questions:
- _"How many lights are on in the office?"_
- _"Which doors are open?"_
Thanks, [@synesthesiam] for implementing this, and thanks to language leaders
and contributors for helping out providing translations for all these [intents]! ❤️
Want to help with adding support for these intents in your language? Please do!
Read more about [contributing sentences in our documentation](https://developers.home-assistant.io/docs/voice/intent-recognition/contributing).
[@synesthesiam]: https://github.com/synesthesiam
[intents]: https://github.com/home-assistant/intents
## Cleaner entity information dialogs
The entity information dialog (also known as the more-info dialog) got some
nice improvements in this release.
<img class="no-shadow" src='/images/blog/2023-03/new-entity-dialog.png' alt='Screenshot showing the new entity information dialogs, highlighting the top bar changes.'>
The "Info", "History", "Settings", and "Related" tabs have been removed, which
gives the dialog a much cleaner look. Icons for settings and history have been
added in the top right to replace these tabs. The new three-dotted overflow menu
can bring up related entity information and provides a direct link to the device
dashboard of the device that provided this entity.
Nice job [@matthiasdebaat] and [@piitaya]!
[@matthiasdebaat]: https://github.com/matthiasdebaat
[@piitaya]: https://github.com/piitaya
## New dialogs for lights, switches and siren entities
There is more to tell about this release's more-info dialogs. [@matthiasdebaat]
and [@piitaya] have been working on the designs shared
[during the State of the Open Home 2022](https://www.youtube.com/live/D936T1Ze8-4?feature=share&t=5193).
This release brings in the first overhauls to the entity dialogs of light,
switch, and siren entities.
<img class="no-shadow" style="padding-right: 24px" src='/images/blog/2023-03/new-light-switch-more-info-dialog.png' alt='Screenshots showing the new entity more-info dialogs for a light, a switch and a switch with an assumed state.'>
The new dialogs are nice and clean. The new sliders and buttons work absolutely
magnificent on both desk and mobile. For the brightness slider, you can drag
it all down without turning the light off, making it possible to dim your
light to even the lowest point.
In case of a light, additional controls for turning on/off, color (temperature),
and effects appear right below the slider. In the top right, you'll find the new
controls that come with the cleaner look we discussed in the previous paragraph.
[@matthiasdebaat]: https://github.com/matthiasdebaat
[@piitaya]: https://github.com/piitaya
## Sensor display precision
Got a sensor that has too many decimals in its numeric value? Would you like
to display it rounded to a single or maybe even no decimals?
Just ~~create a template sensor~~ change it directly from the UI!
<img class="no-shadow" src='/images/blog/2023-03/entity-precision.png' alt='Screenshot showing you can now set the numerical
precision of a sensor entity value shown in the UI from the entity settings dialog.'>
Thanks [@emontnemery] for building out this feature!
This has also been extended into integrations, which now can provide
a more precise value while suggesting to, show it with less precision
by default. This allows you to change it if you don't like the defaults.
You can also take advantage of the configured precision when writing templates,
as the `states()` function has been extended to help with that.
You can find more information on
[formatting sensor states in the templating documentation](/docs/configuration/templating/#formatting-sensor-states).
[@emontnemery]: https://github.com/emontnemery
## New create automation dialog
Let's continue the dialogs theme this release! As [@piitaya] also gave
the dialog you see when you create a new automation, a facelift!
You can now quickly find and pick a Blueprint to use for your automation or
create one from scratch. The overall look and feel is much more modern, and
fits our current design better.
<img class="no-shadow" src='/images/blog/2023-03/new-automation-dialog.png' alt='Screenshot showing the improved createnew automation dialogs, which allows easily starting a new automation from a blueprint or from scratch.'>
You may notice it now shows author information in this dialog. If you create
Blueprints, you can now add [author information] to your Blueprint,
which will be shown in this dialog.
[@piitaya]: https://github.com/piitaya
[author information]: /docs/blueprint/schema/#author
## Thread & Matter
Behind the scenes, a lot is happening; adding, extending and improving
Thread & Matter support for Home Assistant.
A couple of weeks ago, we published [an extensive blog article on where we're at](/blog/2023/02/08/state-of-matter-and-thread/).
Some of the features mentioned in that blog post will become available today.
The most visual change is that the [Thread integration](/integrations/thread)
will now show up on your devices & services dashboard. The "Configure" button
on the Thread card will reveal the all-new Thread panel.
<img class="no-shadow" src='/images/blog/2023-03/thread-panel.png' alt='Screenshot of the all new Thread panel, giving insight into your Thread network(s).'>
The Thread panel lets you view your Thread network(s) and provides controls
to add an OpenThread border router. More importantly, an option to download
diagnostics has been added in the three-dotted menu in the top right. This will
help with finding, triaging, and fixing issues as the development
on Thread continues.
As for Matter, it now supports connecting to Matter bridges! So, you can
now connect, for example, your Hue hub over Matter!
<p class='img'>
<img src='/images/blog/2023-03/matter-bridges.png' alt='Screenshot showing the Home Assistant Matter integration card, with lots of devices and entities; brought in by Hue bridges.'></a>
Two Philips Hue bridges connected using Matter, and it is fast!
</p>
Although, if you want to connect your Hue hub, we of course recommend using
the dedicated [Hue integration](/integrations/hue), which will provide a much
more stable and feature rich solution. Nevertheless, having bridge support is
a huge milestone!
Adding a Matter device is now also more logical. Just add a new device
from the Devices & Services page, just like how you would add any other device
or integration to Home Assistant. Oh! Let's not forget about [@ArturoGuerra],
who added support for color lights to Matter! Thanks!
[@ArturoGuerra]: https://github.com/ArturoGuerra
## Python 3.11 support
Support for Python 3.11 is here! 🐍
This change is only interesting if you manually run Home Assistant
directly in Python (the Home Assistant Core installation method). If that
is the case, you can now start using Home Assistant with Python 3.11, which
should dramatically improve performance over previous Python versions.
We are also working on upgrading to Python 3.11 for our Home Assistant OS,
Supervised, and Container installation methods so we can provide
the same performance improvements. We'll keep you posted.
## Other noteworthy changes
There is much more juice in this release; here are some of the other
noteworthy changes this release:
- You can now change the unit of measurement for a sensor that provides power readings.
So, if you like your kW sensor to be displayed as W, that is now possible. Thanks, [@emontnemery]!
- All [contributed translations] are now automatically updated with each release!
This includes patch releases. Thanks, [@frenck].
- Faster it is! [@bdraco] keeps improving the performance, and this release is no exception!
The statistics should be almost instant now, which is notable on
the energy dashboard. Lots of MQTT-related performance improvements too!
- The statistic graph card can now hide the legend, nice and clean [@piitaya]!
- You can now use templates in the `for` parameter of [state conditions]. Thanks, [@emontnemery]!
- Our (opt-in only) {% my analytics %} will now include the database engine and version
you use with your recorder. This helps us making database-related decisions and improvements.
Thanks, [@ludeeus]!
- [@marcelveldt] added support for Smart Scenes (Natural Light) to the [Philips Hue] integrations. Nice!
- If your [ONVIF] camera supports it, it will now provide switch entities
for auto-focus, wiper, and IR lights. Thanks, [@partofthething]!
- The input select helper first, last, previous, and next services are now also
available on select entities, thanks [@frenck].
- It looks like [@jesserockz] took a small break from [ESPHome] to implement support
for the SwitchBot Blind Tilt to the [SwitchBot] integration. Thank you!
- The [OpenAI Conversation] integration now has options to customize it to your liking, thanks [@bendews]!
- [@marcolivierarsenault] added support for [ecobee] ventilator, awesome!
- The [Reolink] integration now provides entities to update the firmware of your camera, control zoom,
and control auto-focus. Thanks [@starkillerOG]!
- [KNX] Data Secure support is added, and importing your Keyfile to use it is now super easy. Just upload it from your browser
when configuring it in Home Assistant. Awesome [@farmio]!
- [@thecode] added support for [Shelly] Pro 3EM energy sensors, nice!
- [ScreenLogic] now supports local push updates for almost all entities. Thanks [@dieselrabbit]!
[@bdraco]: https://github.com/bdraco
[@bendews]: https://github.com/bendews
[@dieselrabbit]: https://github.com/dieselrabbit
[@emontnemery]: https://github.com/emontnemery
[@farmio]: https://github.com/farmio
[@frenck]: https://github.com/frenck
[@jesserockz]: https://github.com/jesserockz
[@ludeeus]: https://github.com/ludeeus
[@marcelveldt]: https://github.com/marcelveldt
[@marcolivierarsenault]: https://github.com/marcolivierarsenault
[@partofthething]: https://github.com/partofthething
[@piitaya]: https://github.com/piitaya
[@starkillerOG]: https://github.com/starkillerOG
[@thecode]: https://github.com/thecode
[contributed translations]: https://developers.home-assistant.io/docs/translations
[ecobee]: /integrations/ecobee
[ESPHome]: https://esphome.io
[KNX]: /integrations/knx
[ONVIF]: /integrations/onvif
[OpenAI Conversation]: /integrations/openai_conversation
[Philips Hue]: /integrations/hue
[Reolink]: /integrations/reolink
[ScreenLogic]: /integrations/screenlogic
[Shelly]: /integrations/shelly
[state conditions]: /docs/scripts/conditions/#state-condition
[SwitchBot]: /integrations/switchbot
## New Integrations
We welcome the following new integrations in this release:
- **[Dormakaba dKey]**, added by [@emontnemery]<br />
Connect and control your Dormakaba dKey Bluetooth Low Energy locks.
- **[easyEnergy]**, added by [@klaasnicolaas]<br />
Retrieves dynamic (hourly) energy & gas prices from the Dutch utility company
easyEnergy.
- **[TP-Link Omada SDN Controller]**, added by [@MarkGodwin]<br />
Control your TP-Link Omada SDN Devices, such as network switches,
access points, and internet gateways.
[@emontnemery]: https://github.com/emontnemery
[@klaasnicolaas]: https://github.com/klaasnicolaas
[@MarkGodwin]: https://github.com/MarkGodwin
[Dormakaba dKey]: /integrations/dormakaba_dkey
[easyEnergy]: /integrations/easyenergy
[TP-Link Omada SDN Controller]: /integrations/tplink_omada
## Release 2023.3.1 - March 2
- Update pyTibber to 0.27.0 ([@toini] - [#86940]) ([tibber docs]) (breaking-change)
- Bump requests to 2.28.2 ([@mitch-dc] - [#88956])
- Bump py-dormakaba-dkey to 1.0.4 ([@emontnemery] - [#88992]) ([dormakaba_dkey docs])
- Fix KNX Keyfile upload ([@farmio] - [#89029]) ([knx docs])
- Update orjson to 3.8.7 ([@frenck] - [#89037])
- Update frontend to 20230302.0 ([@piitaya] - [#89042]) ([frontend docs])
- Fix check on non numeric custom sensor device classes ([@jbouwh] - [#89052]) ([sensor docs])
- Bump nuheat to 1.0.1 ([@mitch-dc] - [#88958]) ([nuheat docs])
[@mitch-dc]: https://github.com/mitch-dc
[#88958]: https://github.com/home-assistant/core/pull/88958
[nuheat docs]: /integrations/nuheat/
[#86940]: https://github.com/home-assistant/core/pull/86940
[#88956]: https://github.com/home-assistant/core/pull/88956
[#88979]: https://github.com/home-assistant/core/pull/88979
[#88992]: https://github.com/home-assistant/core/pull/88992
[#89029]: https://github.com/home-assistant/core/pull/89029
[#89037]: https://github.com/home-assistant/core/pull/89037
[#89042]: https://github.com/home-assistant/core/pull/89042
[#89052]: https://github.com/home-assistant/core/pull/89052
[@emontnemery]: https://github.com/emontnemery
[@farmio]: https://github.com/farmio
[@frenck]: https://github.com/frenck
[@jbouwh]: https://github.com/jbouwh
[@mitch-dc]: https://github.com/mitch-dc
[@piitaya]: https://github.com/piitaya
[@toini]: https://github.com/toini
[abode docs]: /integrations/abode/
[dormakaba_dkey docs]: /integrations/dormakaba_dkey/
[frontend docs]: /integrations/frontend/
[knx docs]: /integrations/knx/
[sensor docs]: /integrations/sensor/
[tibber docs]: /integrations/tibber/
## Release 2023.3.2 - March 8
- Check type key of zone exists in geniushub ([@warksit] - [#86798]) ([geniushub docs])
- Cache transient templates compiles provided via api ([@bdraco] - [#89065]) ([websocket_api docs]) ([api docs]) ([mobile_app docs])
- Handle InnoDB deadlocks during migration ([@bdraco] - [#89073]) ([recorder docs])
- Bump pyfibaro version to 0.6.9 ([@rappenze] - [#89120]) ([fibaro docs]) (dependency)
- Fix host IP and scheme entry issues in TP-Link Omada ([@MarkGodwin] - [#89130]) ([tplink_omada docs])
- Fix Tuya Python 3.11 compatibility issue ([@frenck] - [#89189]) ([tuya docs])
- Bump aioesphomeapi to 13.4.2 ([@bdraco] - [#89210]) ([esphome docs]) (dependency)
- Update frontend to 20230306.0 ([@bramkragten] - [#89227]) ([frontend docs])
- Fix conditional check ([@cdce8p] - [#89231]) ([konnected docs])
- Bump sqlalchemy to 2.0.5post1 ([@bdraco] - [#89253]) ([recorder docs]) ([sql docs]) (dependency)
- Make sql subqueries threadsafe ([@bdraco] - [#89254]) ([recorder docs])
- Bump python-snapcast to 2.3.2 ([@luar123] - [#89259]) ([snapcast docs]) (dependency)
- Ignore DSL entities if SFR box is not adsl ([@epenet] - [#89291]) ([sfr_box docs])
- Clean ZHA radio path with trailing whitespace ([@puddly] - [#89299]) ([zha docs])
- Fix Insteon open issues with adding devices by address and missing events ([@teharris1] - [#89305]) ([insteon docs])
- Fix thread diagnostics loading blocking the event loop ([@bdraco] - [#89307]) ([thread docs])
- Remove invalid device class in air-Q integration ([@Sibgatulin] - [#89329]) ([airq docs])
- Recreate iaqualink httpx client upon service exception ([@flz] - [#89341]) ([iaqualink docs])
- Fix bluetooth history and device expire running in the executor ([@bdraco] - [#89342]) ([bluetooth docs])
- Fix setting Reolink focus ([@starkillerOG] - [#89374]) ([reolink docs])
- Improve Supervisor API handling ([@frenck] - [#89379]) ([hassio docs])
- Fix invalid state class in litterrobot ([@epenet] - [#89380]) ([litterrobot docs])
[#86798]: https://github.com/home-assistant/core/pull/86798
[#88979]: https://github.com/home-assistant/core/pull/88979
[#89059]: https://github.com/home-assistant/core/pull/89059
[#89065]: https://github.com/home-assistant/core/pull/89065
[#89073]: https://github.com/home-assistant/core/pull/89073
[#89120]: https://github.com/home-assistant/core/pull/89120
[#89130]: https://github.com/home-assistant/core/pull/89130
[#89189]: https://github.com/home-assistant/core/pull/89189
[#89210]: https://github.com/home-assistant/core/pull/89210
[#89227]: https://github.com/home-assistant/core/pull/89227
[#89231]: https://github.com/home-assistant/core/pull/89231
[#89253]: https://github.com/home-assistant/core/pull/89253
[#89254]: https://github.com/home-assistant/core/pull/89254
[#89259]: https://github.com/home-assistant/core/pull/89259
[#89291]: https://github.com/home-assistant/core/pull/89291
[#89299]: https://github.com/home-assistant/core/pull/89299
[#89305]: https://github.com/home-assistant/core/pull/89305
[#89307]: https://github.com/home-assistant/core/pull/89307
[#89329]: https://github.com/home-assistant/core/pull/89329
[#89341]: https://github.com/home-assistant/core/pull/89341
[#89342]: https://github.com/home-assistant/core/pull/89342
[#89374]: https://github.com/home-assistant/core/pull/89374
[#89379]: https://github.com/home-assistant/core/pull/89379
[#89380]: https://github.com/home-assistant/core/pull/89380
[@MarkGodwin]: https://github.com/MarkGodwin
[@Sibgatulin]: https://github.com/Sibgatulin
[@balloob]: https://github.com/balloob
[@bdraco]: https://github.com/bdraco
[@bramkragten]: https://github.com/bramkragten
[@cdce8p]: https://github.com/cdce8p
[@epenet]: https://github.com/epenet
[@flz]: https://github.com/flz
[@frenck]: https://github.com/frenck
[@luar123]: https://github.com/luar123
[@puddly]: https://github.com/puddly
[@rappenze]: https://github.com/rappenze
[@starkillerOG]: https://github.com/starkillerOG
[@teharris1]: https://github.com/teharris1
[@warksit]: https://github.com/warksit
[abode docs]: /integrations/abode/
[airq docs]: /integrations/airq/
[api docs]: /integrations/api/
[bluetooth docs]: /integrations/bluetooth/
[dormakaba_dkey docs]: /integrations/dormakaba_dkey/
[esphome docs]: /integrations/esphome/
[fibaro docs]: /integrations/fibaro/
[frontend docs]: /integrations/frontend/
[geniushub docs]: /integrations/geniushub/
[hassio docs]: /integrations/hassio/
[iaqualink docs]: /integrations/iaqualink/
[insteon docs]: /integrations/insteon/
[knx docs]: /integrations/knx/
[konnected docs]: /integrations/konnected/
[litterrobot docs]: /integrations/litterrobot/
[mobile_app docs]: /integrations/mobile_app/
[recorder docs]: /integrations/recorder/
[reolink docs]: /integrations/reolink/
[sensor docs]: /integrations/sensor/
[sfr_box docs]: /integrations/sfr_box/
[snapcast docs]: /integrations/snapcast/
[sql docs]: /integrations/sql/
[thread docs]: /integrations/thread/
[tibber docs]: /integrations/tibber/
[tplink_omada docs]: /integrations/tplink_omada/
[tuya docs]: /integrations/tuya/
[websocket_api docs]: /integrations/websocket_api/
[zha docs]: /integrations/zha/
## Release 2023.3.3 - March 9
- Fix MQTT rgb light brightness scaling ([@jbouwh] - [#89264]) ([mqtt docs])
- Bump roombapy to 1.6.6 ([@Dilski] - [#89366]) ([roomba docs])
- Bump pymazda to 0.3.8 ([@bdr99] - [#89387]) ([mazda docs])
- Allow enum as MQTT sensor device_class ([@jbouwh] - [#89391]) ([mqtt docs])
- Add paths for add-on changelog and documentation ([@ludeeus] - [#89411]) ([hassio docs])
- Update frontend to 20230309.0 ([@piitaya] - [#89446]) ([frontend docs])
- Fix Dormakaba dKey deadbolt binary sensor ([@emontnemery] - [#89447]) ([dormakaba_dkey docs])
[#88979]: https://github.com/home-assistant/core/pull/88979
[#89059]: https://github.com/home-assistant/core/pull/89059
[#89264]: https://github.com/home-assistant/core/pull/89264
[#89366]: https://github.com/home-assistant/core/pull/89366
[#89381]: https://github.com/home-assistant/core/pull/89381
[#89387]: https://github.com/home-assistant/core/pull/89387
[#89391]: https://github.com/home-assistant/core/pull/89391
[#89411]: https://github.com/home-assistant/core/pull/89411
[#89446]: https://github.com/home-assistant/core/pull/89446
[#89447]: https://github.com/home-assistant/core/pull/89447
[@Dilski]: https://github.com/Dilski
[@balloob]: https://github.com/balloob
[@bdr99]: https://github.com/bdr99
[@emontnemery]: https://github.com/emontnemery
[@frenck]: https://github.com/frenck
[@jbouwh]: https://github.com/jbouwh
[@ludeeus]: https://github.com/ludeeus
[@piitaya]: https://github.com/piitaya
[abode docs]: /integrations/abode/
[dormakaba_dkey docs]: /integrations/dormakaba_dkey/
[frontend docs]: /integrations/frontend/
[hassio docs]: /integrations/hassio/
[knx docs]: /integrations/knx/
[mazda docs]: /integrations/mazda/
[mqtt docs]: /integrations/mqtt/
[roomba docs]: /integrations/roomba/
[sensor docs]: /integrations/sensor/
[tibber docs]: /integrations/tibber/
## Need help? Join the community!
Home Assistant has a great community of users who are all more than willing
to help each other out. So, join us!
Our very active [Discord chat server](/join-chat) is an excellent place to be
at, and don't forget to join our amazing [forums](https://community.home-assistant.io/).
Found a bug or issue? Please report it in our [issue tracker](https://github.com/home-assistant/core/issues),
to get it fixed! Or, check [our help page](/help) for guidance for more
places you can go.
Are you more into email? [Sign-up for our Building the Open Home Newsletter](/newsletter)
to get the latest news about features, things happening in our community and
other news about building an Open Home; straight into your inbox.
## Breaking Changes
{% details "Assist / Conversation" %}
Previously, all entities and areas were exposed to Assist's default agent. This
is now restricted to entities of the following domains:
- `climate`
- `cover`
- `fan`
- `humidifier`
- `light`
- `lock`
- `scene`
- `script`
- `sensor`
- `switch`
- `vacuum`
- `water_heater`
Only areas with exposed entities will be exposed themselves. In the future,
this will be customizable through the frontend.
([@synesthesiam] - [#88274]) ([documentation](/integrations/conversation))
[@synesthesiam]: https://github.com/synesthesiam
[#88274]: https://github.com/home-assistant/core/pull/88274
{% enddetails %}
{% details "Atmospheric pressure device triggers" %}
A bug with the atmospheric pressure sensor device triggers has been corrected.
Automations using such device triggers will need to be adjusted/reconfigured.
([@epenet] - [#88320]) ([documentation](/integrations/sensor))
[@epenet]: https://github.com/epenet
[#87377]: https://github.com/home-assistant/core/pull/88320
{% enddetails %}
{% details "ecobee" %}
The aux heat toggle will now show as enabled when the device is in
"aux heat only" mode instead of only when it is running.
([@Lash-L] - [#86100]) ([documentation](/integrations/ecobee))
[@Lash-L]: https://github.com/Lash-L
[#86100]: https://github.com/home-assistant/core/pull/86100
{% enddetails %}
{% details "Fibaro" %}
The previously deprecated YAML configuration of the Fibaro integration
has been removed.
Fibaro is now configured via the UI, any existing YAML configuration has
been imported in previous releases and can now be safely removed from
your YAML configuration files.
([@rappenze] - [#87939]) ([documentation](/integrations/fibaro))
[@rappenze]: https://github.com/rappenze
[#87939]: https://github.com/home-assistant/core/pull/87939
{% enddetails %}
{% details "GoodWe Inverter" %}
Inverter "Operation Mode" select values were changed to snake_case and localized.
- "General mode" -> `general`
- "Off grid mode" -> `off_grid`
- "Backup mode" -> `backup`
- "Eco mode" -> `eco`
- "Peak shaving" -> `peak_shaving`
- "Eco charge mode" -> `eco_charge`
- "Eco discharge mode" -> `eco_discharge`
If you used these select values in your automations or scripts, you will need
to adjust those to match this change.
([@mletenay] - [#86901]) ([documentation](/integrations/goodwe))
[@mletenay]: https://github.com/mletenay
[#86901]: https://github.com/home-assistant/core/pull/86901
{% enddetails %}
{% details "HomeKit" %}
VOC mappings in the HomeKit integration have been improved to use the IAQ
guidelines for Europe released by the WHO (World Health Organization).
HomeKit | Previous VOC µg/m3 | New VOC µg/m3
-- | -- | --
Excellent | <= 24 | <= 250
Good | <= 48 | <= 500
Fair | <= 64 | <= 1000
Inferior | <= 96 | <= 3000
Poor | > 96 | > 3000
Reference: [Sensirion_Gas_Sensors_SGP3x_TVOC_Concept.pdf](https://github.com/paulvha/svm30/blob/master/extras/Sensirion_Gas_Sensors_SGP3x_TVOC_Concept.pdf)
([@emanuelst] - [#87663]) ([documentation](/integrations/homekit))
[@emanuelst]: https://github.com/emanuelst
[#87663]: https://github.com/home-assistant/core/pull/87663
{% enddetails %}
{% details "Matter" %}
With this release, you will need to update your Matter Server instance.
You must use `python-matter-server` 3.0.0 or greater (schema 2).
- If you use the `Matter Server` add-on, you need to have at least version `4.0.0`.
- If you run your own Docker container, or some other installation method,
you will need to update your `python-matter-server` instance to at least `3.0.0`.
([@marcelveldt] - [#88607]) ([documentation](/integrations/matter))
[@marcelveldt]: https://github.com/marcelveldt
[#88607]: https://github.com/home-assistant/core/pull/88607
{% enddetails %}
{% details "MQTT" %}
The behavior for receiving values on sensors that expect numeric* values
has changed.
- A `'None'` value or a value rendered to `'None'` will
set such a sensor to an `unknown` state.
- Empty values on such sensors (`''`) are ignored and will not affect the state
of the sensor.
Integrations need to be corrected to send the correct values if an update is
published and no valid update value is available for the sensor.
- Other sensors that do not expect a numeric value will still accept
an empty string as a value.
\* Sensors expect numeric values if at least one of the following applies:
- A `device_class` is set but is not a `date`, `timestamp`, `enum`, or any custom device class.
- A `state_class` is set.
- A `unit_of_measurement` is set.
- A `suggested_display_precision` is set.
([@jbouwh] - [#87004]) ([documentation](/integrations/mqtt))
[@jbouwh]: https://github.com/jbouwh
[#87004]: https://github.com/home-assistant/core/pull/87004
{% enddetails %}
{% details "Plugwise" %}
The unit of measurement for the P1 gas consumed interval sensor is changed
from `m³` to `m³/h`. Go to Developer Option --> Statistics for the options
on how to handle this change in your existing installation.
([@bouwew] - [#87449]) ([documentation](/integrations/plugwise))
[@bouwew]: https://github.com/bouwew
[#87449]: https://github.com/home-assistant/core/pull/87449
{% enddetails %}
{% details "Profiler" %}
The `profiler.memory` service is unavailable when using Python 3.11, due to
an incompatibility with a needed dependency for this service. It will return
when the used `guppy3` package becomes available with Python 3.11 compatibility.
([@bdraco] - [#88136]) ([documentation](/integrations/profiler))
[@bdraco]: https://github.com/bdraco
[#88136]: https://github.com/home-assistant/core/pull/88136
{% enddetails %}
{% details "Template: Covers" %}
Template covers using `optimistic: false` without `value_template` nor
`position_template` still updated state optimistically. The integration now respects the optimistic setting of false. If you want to keep the
previous behavior, you must set the `optimistic` value to `true`,
or remove the optimistic declaration.
([@ylemoigne] - [#87925]) ([documentation](/integrations/template))
[@ylemoigne]: https://github.com/ylemoigne
[#87925]: https://github.com/home-assistant/core/pull/87925
{% enddetails %}
{% details "Trafikverket Weather" %}
The unit of measurement was incorrectly set to `mm` while the
API is returning `mm/h`. The unit of measurement and device class have now been corrected.
([@gjohansson-ST] - [#87308]) ([documentation](/integrations/trafikverket_weatherstation))
[@gjohansson-ST]: https://github.com/gjohansson-ST
[#87308]: https://github.com/home-assistant/core/pull/87308
{% enddetails %}
{% details "Todoist" %}
Labels used by custom projects for filtering are now case-sensitive.
Previously the labels were automatically lower-cased by the integration,
but in Todoist a label like `Test` and `test` are considered unique.
Because of that labels will now be case sensitive in your configuration.
([@boralyl] - [#87904]) ([documentation](/integrations/todoist))
[@boralyl]: https://github.com/boralyl
[#87904]: https://github.com/home-assistant/core/pull/87904
{% enddetails %}
{% details "UniFi Protect" %}
The `event_id` and `event_score` state attributes are now excluded from being
recorded in the database. They remain available for use in automations
and scripts.
([@bdraco] - [#88387]) ([documentation](/integrations/unifiprotect))
[@bdraco]: https://github.com/bdraco
[#88387]: https://github.com/home-assistant/core/pull/88387
---
The previously deprecated "Detected Object" sensor has been removed.
The sensor was removed because if multiple objects are detected at once
(very common for package detection), Home Assistant could not be automated
using the second detected object. The sensor has been split out from the single
Detected Object sensor into multiple binary issues for each detection type.
([@bdraco] - [#85656]) ([documentation](/integrations/unifiprotect))
[@bdraco]: https://github.com/bdraco
[#85656]: https://github.com/home-assistant/core/pull/85656
{% enddetails %}
{% details "Wiffi" %}
The Wiffi unit of illuminance `lux` has been adjusted to the standard unit
Home Assistant uses `lx`.
([@mampfes] - [#87377]) ([documentation](/integrations/wiffi))
[@mampfes]: https://github.com/mampfes
[#87377]: https://github.com/home-assistant/core/pull/87377
{% enddetails %}
{% details "Z-Wave" %}
With this release, you will need to update your zwave-js-server instance.
You must use `zwave-js-server` 1.26.0 or greater (schema 26).
- If you use the `Z-Wave JS` add-on, you need at least version `0.1.76`.
- If you use the `Z-Wave JS UI` add-on, you need at least version `1.6.3`.
- If you use the `Z-Wave JS UI` Docker container, you need at least version `8.8.6`.
- If you run your own Docker container or some other installation method,
you will need to update your `zwave-js-server` instance to at least `1.26.0`.
([@raman325] - [#88520]) ([documentation](/integrations/zwave_js))
[@raman325]: https://github.com/raman325
[#88520]: https://github.com/home-assistant/core/pull/88520
{% enddetails %}
If you are a custom integration developer and want to learn about breaking
changes and new features available for your integration: Be sure to follow our
[developer blog][devblog]. The following are the most notable for this release:
[devblog]: https://developers.home-assistant.io/blog/
- [Added support for snapshot testing](https://developers.home-assistant.io/blog/2023/02/20/snapshot-testing/)
- [Custom tile features](https://developers.home-assistant.io/blog/2023/02/28/custom-tile-features)
- [Deprecated callback signatures for MQTT subscribe removed](https://developers.home-assistant.io/blog/2023/02/21/deprecated-callback-removed/)
- [Intent Responses and Whitespace](https://developers.home-assistant.io/blog/2023/02/03/responses)
- [Introducing drafting of PRs in our review process](https://developers.home-assistant.io/blog/2023/02/07/introducing-PR-drafting-in-reviews)
- [The HassGetState intent](https://developers.home-assistant.io/blog/2023/02/09/hassgetstate)
- [The number of decimals used when displaying a sensor state is now configurable](https://developers.home-assistant.io/blog/2023/02/08/sensor_presentation_rounding)
- [Translation files removed from Core repository](https://developers.home-assistant.io/blog/2023/02/06/translations-files-removed-from-core)
## All changes
Of course, there is a lot more in this release. You can find a list of
all changes made here: [Full changelog for Home Assistant Core 2023.3](/changelogs/core-2023.3)

View File

@ -0,0 +1,73 @@
---
layout: post
title: "Disclosure: Supervisor security vulnerability"
description: "Disclosure of a security vulnerability found impacting installations using the Home Assistant Supervisor."
date: 2023-03-08 00:00:00
date_formatted: "March 08, 2023"
author: Paulus Schoutsen
author_twitter: balloob
comments: true
categories: Public-Service-Announcement
og_image: /images/blog/2023-03-supervisor-security-disclosure/social.png
---
![Attention please read](/images/blog/2023-03-supervisor-security-disclosure/social.png)
We were made aware of a security issue impacting installations using
the Home Assistant Supervisor. A fix for this security issue has been rolled
out to all affected Home Assistant users via the Supervisor auto-update system
and this issue is no longer present.
You can verify that you received the update on the {% my info title="Home Assistant About page" %}
and verify that you are running Supervisor 2023.03.1 or later. If you do not
see a Supervisor version on your About page, you do not use one of the affected
installation types and have not been vulnerable.
The issue has also been mitigated in Home Assistant 2023.3.0. This version
was released on March 1 and has since been installed by [33% of our users][analytics].
[analytics]: https://analytics.home-assistant.io/
## Affected version
The security issue affected installation types Home Assistant OS and
Home Assistant Supervised. This includes installations running on the
Home Assistant Blue and Home Assistant Yellow.
The two other installation types, Home Assistant Container (Docker) and
Home Assistant Core (own Python environment), have not been affected.
## Credits
The security issue was found by [Joseph Surin] from [elttam]. Many thanks for bringing this to our attention.
[Joseph Surin]: https://jsur.in
[elttam]: https://www.elttam.com/
## About the issue
The Supervisor is an application that is part of Home Assistant OS
and Home Assistant Supervised installations and is responsible for
system management. The issue allowed an attacker to remotely bypass
authentication and interact directly with the Supervisor API. This gives
an attacker access to install Home Assistant updates and manage add-ons
and backups. Our analysis shows that this issue has been in Home Assistant
since the introduction of the Supervisor in 2017.
We have published [security advisory CVE-2023-27482 on GitHub][advisory].
[advisory]: https://github.com/home-assistant/core/security/advisories/GHSA-2j8f-h4mr-qr25
## FAQ
---
### Has this vulnerability been abused?
We dont know. We have not heard any reports of people being hacked.
### Is there a workaround?
In case one is not able to upgrade the Home Assistant Supervisor or the
Home Assistant Core application at this time, it is advised to not expose
your Home Assistant instance to the internet.

View File

@ -7,7 +7,6 @@
/newsletter https://building.open-home.io/
/suggest-community-highlight https://docs.google.com/forms/d/e/1FAIpQLSd9VWPeVM0xg0swWL6kT3wkQUKt8vWsTL5WtPO95LAy-0cYZw/viewform
/get-blueprints https://community.home-assistant.io/c/blueprints-exchange/53
/latest-security-alert /blog/2021/01/23/security-disclosure2/
/merch https://home-assistant-store.creator-spring.com
/feature-requests https://community.home-assistant.io/c/feature-requests
/issues https://github.com/home-assistant/core/issues

File diff suppressed because it is too large Load Diff

View File

@ -1,14 +1,14 @@
---
title: "Assist on Android."
title: "Assist on Android"
---
Assist is available on WearOS using the [Home Assistant Companion App](https://companion.home-assistant.io/) and "Assist" tile.
Assist is available on Wear OS using the [Home Assistant Companion App](https://companion.home-assistant.io/) for Android and "Assist" tile.
<lite-youtube videoid="Dr_ZCbt8w5k" videotitle="Assist on Android Wear"></lite-youtube>
<lite-youtube videoid="Dr_ZCbt8w5k" videotitle="Assist on Wear OS"></lite-youtube>
## Installation
After [installing the companion app](https://companion.home-assistant.io/docs/getting_started/) and connecting it to your Home Assistant, visit the Android WatchOS app and click "Add tile" inside the Tiles area. Select the "Assist" tile to add it to your watch:
After [installing the companion app](https://companion.home-assistant.io/docs/getting_started/) and connecting it to your Home Assistant, visit your watch companion app or the Wear OS app and click "Add tile" inside the Tiles area. Select the "Assist" tile to add it to your watch:
![Conversation tile](/images/assist/android_tile.png)

View File

@ -11,8 +11,8 @@ Assist is our feature to allow you to control Home Assistant using natural langu
Assist is available to use on most platforms that can interface with Home Assistant. Look for the Assist icon <img src='/images/assist/assist-icon.svg' alt='Assist icon' style='height: 32px' class='no-shadow'>:
- Inside the Home Assistant app in the top-right corner
- On Android Watch using [Assist tile](/docs/assist/android)
- On Apple devices via [Siri and Assist shortcuts](/docs/assist/apple)
- On Wear OS watches using [Assist tile](/docs/assist/android)
Did Assist not understand your sentence? [Contribute them.](https://developers.home-assistant.io/docs/voice/intent-recognition/)

View File

@ -0,0 +1,60 @@
---
title: "Concepts and terminology"
description: "User explanation of Home Assistant basics"
---
Now you're in Home Assistant, let's go over important parts of Home Assistant and what they do.
## Dashboards
Customizable pages to display information connected to and available in Home Assistant. By default there are two Dashboards, Overview and Energy. The Overview dashboard is the first thing you see after the [onboarding process](/getting-started/onboarding). More details can be found [here](/dashboards).
![Dashboard](/images/getting-started/lovelace.png)
## Integrations
Software that allows Home Assistant to connect to other software and platforms. For example, the Philips Hue integration allows Home Assistant to talk to the Hue Bridge and read data such as the state of your lights through to controlling the lights themselves.
![Integrations](/images/getting-started/integrations.png)
A full list of compatible integrations can be found [here](/integrations).
Once an integration has been added, the hardware and/or data are represented in Home Assistant as [devices and entities](#devices--entities).
## Devices & Entities
Devices are a logical grouping for one or more entities. A device may represent a physical device and the device may have one or more sensors which appear as entities associated to the device. For example, a motion sensor is represented as a device and the motion may provide motion detection, temperature and light levels as entities. Entities have states such as on when motion is detected and off when there is no motion.
Devices and entities are used throughout Home Assistant. To name a few examples:
* [Dashboards](#dashboards) can show a state of an entity like if a light bulb is on or off as well as buttons that interact with devices like turning a light bulb on or off.
* An [automation](automations) can be triggered from a state change on an entity e.g. a light turning on and control another device or entity.
* A predefined setting for light device saved as a [scene](scenes).
![Home Assistant Device](/images/getting-started/home-assistant-device.png)
## Automations
A set of repeatable actions that can be set up to run automatically. Automations are made of three key components:
1. Triggers - event(s) that start an automation like when the sun sets.
2. Conditions - optional tests that must be met before continuing to running actions. For example, if someone is home.
3. Actions - interact with devices such as turn on a light.
More details can be found [here](/docs/automation/basics/) or try creating an [automation](/getting-started/automation).
![Automations](/images/getting-started/automation-editor.png)
## Scripts
Similar to automations, repeatable actions that can be run. The difference between scripts and automations is that scripts do not have triggers like automations. This means that scripts cannot automatically run unless they are used in an automation. Scripts are particularly useful if you perform the same actions in different automations or trigger them from a dashboard. More details can be found [here](/integrations/script/).
## Scenes
Scenes allow you to create predefined settings for your devices. Likened to driving mode on phones, driver profiles in cars, it can change an environment to suite you. For example, your environment for watching films may have dimmer lighting, TV is switched on and higher volume. This can be saved as a scene and used without having to set individual devices every time.
Further details can be found [here](/integrations/scene/).
## Add-ons
Depending on your [installation type](/installation), you may have the ability to install third party add-ons. Add-ons are usually apps that can be run with Home Assistant but provide a quick and easy way to install, configure, and run within Home Assistant. Add-ons provide additional functionality whereas integrations connect Home Assistant to other apps.
![Add-ons](/images/getting-started/add-ons.png)
{% include getting-started/next_step.html step="Automate Home Assistant" link="/getting-started/automation/" %}

View File

@ -7,6 +7,7 @@ show_title: true
{% include getting-started/next_step.html step="Installation" link="/installation/" %}
{% include getting-started/next_step.html step="Onboarding" link="/getting-started/onboarding/" %}
{% include getting-started/next_step.html step="Concepts and terminology" link="/getting-started/concepts-terminology/" %}
{% include getting-started/next_step.html step="Automation" link="/getting-started/automation/" %}
{% include getting-started/next_step.html step="Presence detection" link="/getting-started/presence-detection/" %}
{% include getting-started/next_step.html step="Join the community" link="/getting-started/join-the-community/" %}

View File

@ -29,4 +29,4 @@ When each integration is done setting up, it will ask you to put the new devices
When you're done, navigate back to the web interface and voila, your devices are ready for you to control.
{% include getting-started/next_step.html step="Automate Home Assistant" link="/getting-started/automation/" %}
{% include getting-started/next_step.html step="Concepts & Terminologies" link="/getting-started/concepts-terminology/" %}

Binary file not shown.

After

Width:  |  Height:  |  Size: 172 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 124 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 84 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 13 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 125 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 72 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 128 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 104 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 135 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 115 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 35 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 49 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 36 KiB

View File

@ -231,6 +231,10 @@ toc: true
<td><a href="/common-tasks/os/#backups" target="_blank">Backups</a></td>
<td></td><td><sup>1</sup></td><td><sup>1</sup></td><td></td>
</tr>
<tr>
<td>Managed Restore</td>
<td></td><td><sup>2</sup></td><td><sup>2</sup></td><td></td>
</tr>
<tr>
<td>Managed OS</td>
<td></td><td></td><td></td><td></td>
@ -238,5 +242,6 @@ toc: true
</table>
<sub>1: Backups for Home Assistant Core and Home Assistant Container is provided by the <a href="/integrations/backup" target="_blank"><code>backup</code> integration</a>.</sub>
<sub>2: Backups for Home Assistant Core and Home Assistant Container are either a tool to migrate to HAOS or a completely manual restore of the backup.</sub>
{% include getting-started/next_step.html step="onboarding" link="/getting-started/onboarding" %}

View File

@ -103,7 +103,7 @@ var allComponents = [
{% capture category %}"{{ ha_category | slugify | downcase }}"{% endcapture %}
{% assign categories = categories | push: category %}
{%- endfor -%}
{url:"{{ component.url }}", title:"{{component.title}}", cat: [{{categories|join: ","}}], featured: {% if component.featured %}true{% else %}false{% endif %}, v: "{{major_version}}.{{minor_version}}", logo: "{{component.logo}}", domain: "{{component.ha_domain}}"},
{url:"{{ component.url }}", title:"{{component.title}}", cat: [{{categories|join: ","}}], featured: {% if component.featured %}true{% else %}false{% endif %}, v: "{{major_version}}.{{minor_version}}", logo: "{{component.logo}}", domain: "{{component.ha_domain}}", ha_brand: "{{component.ha_brand}}"},
{% endif -%}
{%- endfor -%}
false
@ -161,7 +161,7 @@ allComponents.pop(); // remove placeholder element at the end
components: [],
image: function () {
if (this.logo === '') {
return '<img src="https://brands.home-assistant.io/_/' + this.domain + '/logo.png" srcset="https://brands.home-assistant.io/_/' + this.domain + '/logo@2x.png 2x" loading="lazy">';
return `<img src="https://brands.home-assistant.io/${this.ha_brand ? "brands": "_"}/${this.domain}/logo.png" srcset="https://brands.home-assistant.io/${this.ha_brand ? "brands ": "_"}/${this.domain}/logo@2x.png 2x" loading="lazy">`;
} else {
return '<img data-src="/images/supported_brands/' + this.logo + '" loading="lazy">';
}

View File

@ -22,5 +22,15 @@ If using Home Assistant Supervised, run the following on the host:
sudo apt install systemd-journal-remote -y
```
and then reboot. If you still see this issue then run the [supervised installer](https://github.com/home-assistant/supervised-installer)
and then reboot your system
If after upgrading you are still facing this error, reinstall `systemd-journal-remote` with the following command
```sh
sudo apt-get install --reinstall systemd-journal-remote
```
and reboot your system
If you still see this issue then run the [supervised installer](https://github.com/home-assistant/supervised-installer)
on the host as the supervisor service may need an update as well.