Merge branch 'rc' into current

This commit is contained in:
Franck Nijhof 2022-10-05 20:15:42 +02:00
commit 40f2a5e26e
No known key found for this signature in database
GPG Key ID: D62583BA8AB11CA3
141 changed files with 3533 additions and 596 deletions

View File

@ -30,7 +30,6 @@ source/_integrations/alert.markdown @home-assistant/core
source/_integrations/alexa.markdown @home-assistant/cloud @ochlocracy source/_integrations/alexa.markdown @home-assistant/cloud @ochlocracy
source/_integrations/alexa.smart_home.markdown @home-assistant/cloud @ochlocracy source/_integrations/alexa.smart_home.markdown @home-assistant/cloud @ochlocracy
source/_integrations/almond.markdown @gcampax @balloob source/_integrations/almond.markdown @gcampax @balloob
source/_integrations/ambee.markdown @frenck
source/_integrations/amberelectric.markdown @madpilot source/_integrations/amberelectric.markdown @madpilot
source/_integrations/ambiclimate.markdown @danielhiversen source/_integrations/ambiclimate.markdown @danielhiversen
source/_integrations/ambient_station.markdown @bachya source/_integrations/ambient_station.markdown @bachya
@ -41,6 +40,7 @@ source/_integrations/android_ip_webcam.markdown @engrbm87
source/_integrations/androidtv.markdown @JeffLIrion @ollo69 source/_integrations/androidtv.markdown @JeffLIrion @ollo69
source/_integrations/anthemav.markdown @hyralex source/_integrations/anthemav.markdown @hyralex
source/_integrations/apache_kafka.markdown @bachya source/_integrations/apache_kafka.markdown @bachya
source/_integrations/apcupsd.markdown @yuxincs
source/_integrations/api.markdown @home-assistant/core source/_integrations/api.markdown @home-assistant/core
source/_integrations/apple_tv.markdown @postlund source/_integrations/apple_tv.markdown @postlund
source/_integrations/application_credentials.markdown @home-assistant/core source/_integrations/application_credentials.markdown @home-assistant/core
@ -69,6 +69,7 @@ source/_integrations/azure_service_bus.markdown @hfurubotten
source/_integrations/backup.markdown @home-assistant/core source/_integrations/backup.markdown @home-assistant/core
source/_integrations/baf.markdown @bdraco @jfroy source/_integrations/baf.markdown @bdraco @jfroy
source/_integrations/balboa.markdown @garbled1 source/_integrations/balboa.markdown @garbled1
source/_integrations/bayesian.markdown @HarvsG
source/_integrations/beewi_smartclim.markdown @alemuro source/_integrations/beewi_smartclim.markdown @alemuro
source/_integrations/binary_sensor.markdown @home-assistant/core source/_integrations/binary_sensor.markdown @home-assistant/core
source/_integrations/bizkaibus.markdown @UgaitzEtxebarria source/_integrations/bizkaibus.markdown @UgaitzEtxebarria
@ -76,6 +77,7 @@ source/_integrations/blebox.markdown @bbx-a @riokuu
source/_integrations/blink.markdown @fronzbot source/_integrations/blink.markdown @fronzbot
source/_integrations/bliss_automation.markdown @starkillerOG source/_integrations/bliss_automation.markdown @starkillerOG
source/_integrations/bloc_blinds.markdown @starkillerOG source/_integrations/bloc_blinds.markdown @starkillerOG
source/_integrations/bluemaestro.markdown @bdraco
source/_integrations/blueprint.markdown @home-assistant/core source/_integrations/blueprint.markdown @home-assistant/core
source/_integrations/bluesound.markdown @thrawnarn source/_integrations/bluesound.markdown @thrawnarn
source/_integrations/bluetooth.markdown @bdraco source/_integrations/bluetooth.markdown @bdraco
@ -88,8 +90,11 @@ source/_integrations/broadlink.markdown @danielhiversen @felipediel @L-I-Am
source/_integrations/brother.markdown @bieniu source/_integrations/brother.markdown @bieniu
source/_integrations/brunt.markdown @eavanvalkenburg source/_integrations/brunt.markdown @eavanvalkenburg
source/_integrations/bsblan.markdown @liudger source/_integrations/bsblan.markdown @liudger
source/_integrations/bswitch.markdown @jafar-atili
source/_integrations/bt_smarthub.markdown @jxwolstenholme source/_integrations/bt_smarthub.markdown @jxwolstenholme
source/_integrations/bthome.markdown @Ernst79 source/_integrations/bthome.markdown @Ernst79
source/_integrations/bticino.markdown @cgtobi
source/_integrations/bubendorff.markdown @cgtobi
source/_integrations/buienradar.markdown @mjj4791 @ties @Robbie1221 source/_integrations/buienradar.markdown @mjj4791 @ties @Robbie1221
source/_integrations/button.markdown @home-assistant/core source/_integrations/button.markdown @home-assistant/core
source/_integrations/calendar.markdown @home-assistant/core source/_integrations/calendar.markdown @home-assistant/core
@ -148,7 +153,7 @@ source/_integrations/dnsip.markdown @gjohansson-ST
source/_integrations/doorbird.markdown @oblogic7 @bdraco @flacjacket source/_integrations/doorbird.markdown @oblogic7 @bdraco @flacjacket
source/_integrations/dooya.markdown @starkillerOG source/_integrations/dooya.markdown @starkillerOG
source/_integrations/dsmr.markdown @Robbie1221 @frenck source/_integrations/dsmr.markdown @Robbie1221 @frenck
source/_integrations/dsmr_reader.markdown @depl0y source/_integrations/dsmr_reader.markdown @depl0y @glodenox
source/_integrations/dunehd.markdown @bieniu source/_integrations/dunehd.markdown @bieniu
source/_integrations/dwd_weather_warnings.markdown @runningman84 @stephan192 @Hummel95 source/_integrations/dwd_weather_warnings.markdown @runningman84 @stephan192 @Hummel95
source/_integrations/dynalite.markdown @ziv1234 source/_integrations/dynalite.markdown @ziv1234
@ -190,6 +195,7 @@ source/_integrations/fan.markdown @home-assistant/core
source/_integrations/fastdotcom.markdown @rohankapoorcom source/_integrations/fastdotcom.markdown @rohankapoorcom
source/_integrations/fibaro.markdown @rappenze source/_integrations/fibaro.markdown @rappenze
source/_integrations/file.markdown @fabaff source/_integrations/file.markdown @fabaff
source/_integrations/file_upload.markdown @home-assistant/core
source/_integrations/filesize.markdown @gjohansson-ST source/_integrations/filesize.markdown @gjohansson-ST
source/_integrations/filter.markdown @dgomes source/_integrations/filter.markdown @dgomes
source/_integrations/fireservicerota.markdown @cyberjunky source/_integrations/fireservicerota.markdown @cyberjunky
@ -201,7 +207,6 @@ source/_integrations/flick_electric.markdown @ZephireNZ
source/_integrations/flipr.markdown @cnico source/_integrations/flipr.markdown @cnico
source/_integrations/flo.markdown @dmulcahey source/_integrations/flo.markdown @dmulcahey
source/_integrations/flume.markdown @ChrisMandich @bdraco @jeeftor source/_integrations/flume.markdown @ChrisMandich @bdraco @jeeftor
source/_integrations/flunearyou.markdown @bachya
source/_integrations/flux_led.markdown @icemanch @bdraco source/_integrations/flux_led.markdown @icemanch @bdraco
source/_integrations/forecast_solar.markdown @klaasnicolaas @frenck source/_integrations/forecast_solar.markdown @klaasnicolaas @frenck
source/_integrations/forked_daapd.markdown @uvjustin source/_integrations/forked_daapd.markdown @uvjustin
@ -237,6 +242,7 @@ source/_integrations/goodwe.markdown @mletenay @starkillerOG
source/_integrations/google.markdown @allenporter source/_integrations/google.markdown @allenporter
source/_integrations/google_assistant.markdown @home-assistant/cloud source/_integrations/google_assistant.markdown @home-assistant/cloud
source/_integrations/google_cloud.markdown @lufton source/_integrations/google_cloud.markdown @lufton
source/_integrations/google_sheets.markdown @tkdrob
source/_integrations/google_travel_time.markdown @eifinger source/_integrations/google_travel_time.markdown @eifinger
source/_integrations/govee_ble.markdown @bdraco source/_integrations/govee_ble.markdown @bdraco
source/_integrations/gpsd.markdown @fabaff source/_integrations/gpsd.markdown @fabaff
@ -246,6 +252,7 @@ source/_integrations/group.markdown @home-assistant/core
source/_integrations/growatt_server.markdown @indykoning @muppet3000 @JasperPlant source/_integrations/growatt_server.markdown @indykoning @muppet3000 @JasperPlant
source/_integrations/guardian.markdown @bachya source/_integrations/guardian.markdown @bachya
source/_integrations/habitica.markdown @ASMfreaK @leikoilja source/_integrations/habitica.markdown @ASMfreaK @leikoilja
source/_integrations/hardware.markdown @home-assistant/core
source/_integrations/harmony.markdown @ehendrix23 @bramkragten @bdraco @mkeesey @Aohzan source/_integrations/harmony.markdown @ehendrix23 @bramkragten @bdraco @mkeesey @Aohzan
source/_integrations/hassio.markdown @home-assistant/supervisor source/_integrations/hassio.markdown @home-assistant/supervisor
source/_integrations/hdmi_cec.markdown @inytar source/_integrations/hdmi_cec.markdown @inytar
@ -281,6 +288,7 @@ source/_integrations/hyperion.markdown @dermotduffy
source/_integrations/ialarm.markdown @RyuzakiKK source/_integrations/ialarm.markdown @RyuzakiKK
source/_integrations/iammeter.markdown @lewei50 source/_integrations/iammeter.markdown @lewei50
source/_integrations/iaqualink.markdown @flz source/_integrations/iaqualink.markdown @flz
source/_integrations/ibeacon.markdown @bdraco
source/_integrations/icloud.markdown @Quentame @nzapponi source/_integrations/icloud.markdown @Quentame @nzapponi
source/_integrations/ign_sismologia.markdown @exxamalte source/_integrations/ign_sismologia.markdown @exxamalte
source/_integrations/image.markdown @home-assistant/core source/_integrations/image.markdown @home-assistant/core
@ -318,7 +326,9 @@ source/_integrations/kaleidescape.markdown @SteveEasley
source/_integrations/keba.markdown @dannerph source/_integrations/keba.markdown @dannerph
source/_integrations/keenetic_ndms2.markdown @foxel source/_integrations/keenetic_ndms2.markdown @foxel
source/_integrations/kef.markdown @basnijholt source/_integrations/kef.markdown @basnijholt
source/_integrations/kegtron.markdown @Ernst79
source/_integrations/keyboard_remote.markdown @bendavid @lanrat source/_integrations/keyboard_remote.markdown @bendavid @lanrat
source/_integrations/keymitt_ble.markdown @spycle
source/_integrations/kmtronic.markdown @dgomes source/_integrations/kmtronic.markdown @dgomes
source/_integrations/knx.markdown @Julius2342 @farmio @marvin-w source/_integrations/knx.markdown @Julius2342 @farmio @marvin-w
source/_integrations/kodi.markdown @OnFreund @cgtobi source/_integrations/kodi.markdown @OnFreund @cgtobi
@ -333,8 +343,10 @@ source/_integrations/launch_library.markdown @ludeeus @DurgNomis-drol
source/_integrations/laundrify.markdown @xLarry source/_integrations/laundrify.markdown @xLarry
source/_integrations/lcn.markdown @alengwenus source/_integrations/lcn.markdown @alengwenus
source/_integrations/led_ble.markdown @bdraco source/_integrations/led_ble.markdown @bdraco
source/_integrations/legrand.markdown @cgtobi
source/_integrations/leviton_z_wave.markdown @home-assistant/z-wave source/_integrations/leviton_z_wave.markdown @home-assistant/z-wave
source/_integrations/lg_netcast.markdown @Drafteed source/_integrations/lg_netcast.markdown @Drafteed
source/_integrations/lidarr.markdown @tkdrob
source/_integrations/life360.markdown @pnbruckner source/_integrations/life360.markdown @pnbruckner
source/_integrations/lifx.markdown @bdraco @Djelibeybi source/_integrations/lifx.markdown @bdraco @Djelibeybi
source/_integrations/light.markdown @home-assistant/core source/_integrations/light.markdown @home-assistant/core
@ -411,12 +423,14 @@ source/_integrations/nextbus.markdown @vividboarder
source/_integrations/nextcloud.markdown @meichthys source/_integrations/nextcloud.markdown @meichthys
source/_integrations/nextdns.markdown @bieniu source/_integrations/nextdns.markdown @bieniu
source/_integrations/nfandroidtv.markdown @tkdrob source/_integrations/nfandroidtv.markdown @tkdrob
source/_integrations/nibe_heatpump.markdown @elupus
source/_integrations/nightscout.markdown @marciogranzotto source/_integrations/nightscout.markdown @marciogranzotto
source/_integrations/nilu.markdown @hfurubotten source/_integrations/nilu.markdown @hfurubotten
source/_integrations/nina.markdown @DeerMaximum source/_integrations/nina.markdown @DeerMaximum
source/_integrations/nissan_leaf.markdown @filcole source/_integrations/nissan_leaf.markdown @filcole
source/_integrations/nmbs.markdown @thibmaek source/_integrations/nmbs.markdown @thibmaek
source/_integrations/noaa_tides.markdown @jdelaney72 source/_integrations/noaa_tides.markdown @jdelaney72
source/_integrations/nobo_hub.markdown @echoromeo @oyvindwe
source/_integrations/notify.markdown @home-assistant/core source/_integrations/notify.markdown @home-assistant/core
source/_integrations/notify_events.markdown @matrozov @papajojo source/_integrations/notify_events.markdown @matrozov @papajojo
source/_integrations/notion.markdown @bachya source/_integrations/notion.markdown @bachya
@ -480,13 +494,14 @@ source/_integrations/pushover.markdown @engrbm87
source/_integrations/pvoutput.markdown @frenck source/_integrations/pvoutput.markdown @frenck
source/_integrations/pvpc_hourly_pricing.markdown @azogue source/_integrations/pvpc_hourly_pricing.markdown @azogue
source/_integrations/qbittorrent.markdown @geoffreylagaisse source/_integrations/qbittorrent.markdown @geoffreylagaisse
source/_integrations/qingping.markdown @bdraco source/_integrations/qingping.markdown @bdraco @skgsergio
source/_integrations/qld_bushfire.markdown @exxamalte source/_integrations/qld_bushfire.markdown @exxamalte
source/_integrations/qnap_qsw.markdown @Noltari source/_integrations/qnap_qsw.markdown @Noltari
source/_integrations/quantum_gateway.markdown @cisasteelersfan source/_integrations/quantum_gateway.markdown @cisasteelersfan
source/_integrations/qvr_pro.markdown @oblogic7 source/_integrations/qvr_pro.markdown @oblogic7
source/_integrations/qwikswitch.markdown @kellerza source/_integrations/qwikswitch.markdown @kellerza
source/_integrations/rachio.markdown @bdraco source/_integrations/rachio.markdown @bdraco
source/_integrations/radarr.markdown @tkdrob
source/_integrations/radio_browser.markdown @frenck source/_integrations/radio_browser.markdown @frenck
source/_integrations/radiotherm.markdown @bdraco @vinnyfuria source/_integrations/radiotherm.markdown @bdraco @vinnyfuria
source/_integrations/rainbird.markdown @konikvranik source/_integrations/rainbird.markdown @konikvranik
@ -566,6 +581,7 @@ source/_integrations/smappee.markdown @bsmappee
source/_integrations/smart_blinds.markdown @starkillerOG source/_integrations/smart_blinds.markdown @starkillerOG
source/_integrations/smart_home.markdown @starkillerOG source/_integrations/smart_home.markdown @starkillerOG
source/_integrations/smart_meter_texas.markdown @grahamwetzler source/_integrations/smart_meter_texas.markdown @grahamwetzler
source/_integrations/smarther.markdown @cgtobi
source/_integrations/smartthings.markdown @andrewsayre source/_integrations/smartthings.markdown @andrewsayre
source/_integrations/smarttub.markdown @mdz source/_integrations/smarttub.markdown @mdz
source/_integrations/smarty.markdown @z0mbieprocess source/_integrations/smarty.markdown @z0mbieprocess
@ -606,6 +622,7 @@ source/_integrations/swiss_hydrological_data.markdown @fabaff
source/_integrations/swiss_public_transport.markdown @fabaff source/_integrations/swiss_public_transport.markdown @fabaff
source/_integrations/switch.markdown @home-assistant/core source/_integrations/switch.markdown @home-assistant/core
source/_integrations/switch_as_x.markdown @home-assistant/core source/_integrations/switch_as_x.markdown @home-assistant/core
source/_integrations/switchbee.markdown @jafar-atili
source/_integrations/switchbot.markdown @bdraco @danielhiversen @RenierM26 @murtas @Eloston source/_integrations/switchbot.markdown @bdraco @danielhiversen @RenierM26 @murtas @Eloston
source/_integrations/switcher_kis.markdown @tomerfi @thecode source/_integrations/switcher_kis.markdown @tomerfi @thecode
source/_integrations/switchmate.markdown @danielhiversen @qiz-li source/_integrations/switchmate.markdown @danielhiversen @qiz-li
@ -632,6 +649,7 @@ source/_integrations/thethingsnetwork.markdown @fabaff
source/_integrations/threshold.markdown @fabaff source/_integrations/threshold.markdown @fabaff
source/_integrations/tibber.markdown @danielhiversen source/_integrations/tibber.markdown @danielhiversen
source/_integrations/tile.markdown @bachya source/_integrations/tile.markdown @bachya
source/_integrations/tilt_ble.markdown @apt-itude
source/_integrations/time_date.markdown @fabaff source/_integrations/time_date.markdown @fabaff
source/_integrations/tmb.markdown @alemuro source/_integrations/tmb.markdown @alemuro
source/_integrations/todoist.markdown @boralyl source/_integrations/todoist.markdown @boralyl

View File

@ -106,9 +106,9 @@ social:
# Home Assistant release details # Home Assistant release details
current_major_version: 2022 current_major_version: 2022
current_minor_version: 9 current_minor_version: 10
current_patch_version: 7 current_patch_version: 0
date_released: 2022-09-26 date_released: 2022-10-05
# Either # or the anchor link to latest release notes in the blog post. # Either # or the anchor link to latest release notes in the blog post.
# Must be prefixed with a # and have double quotes around it. # Must be prefixed with a # and have double quotes around it.

View File

@ -685,8 +685,8 @@ max:
type: [integer, float] type: [integer, float]
required: true required: true
step: step:
description: The step value of the number value. description: The step size of the number value. Set to `"any"` to allow any number.
type: [integer, float] type: [integer, float, "any"]
required: false required: false
default: 1 default: 1
unit_of_measurement: unit_of_measurement:

View File

@ -548,6 +548,23 @@ Example using `is_defined` to parse a JSON payload:
This will throw an error `UndefinedError: 'value_json' is undefined` if the JSON payload has no `val` attribute. This will throw an error `UndefinedError: 'value_json' is undefined` if the JSON payload has no `val` attribute.
### Version
- `version()` Returns a [AwesomeVersion object](https://github.com/ludeeus/awesomeversion) for the value given inside the brackets.
- This is also available as a filter (`| version`).
Examples:
{% raw %}
- `{{ version("2099.9.9") > "2000.0.0" }}` Will return `True`
- `{{ version("2099.9.9") < "2099.10" }}` Will return `True`
- `{{ "2099.9.9" | version < "2099.10" }}` Will return `True`
- `{{ (version("2099.9.9") - "2100.9.10").major }}` Will return `True`
- `{{ (version("2099.9.9") - "2099.10.9").minor }}` Will return `True`
- `{{ (version("2099.9.9") - "2099.9.10").patch }}` Will return `True`
{% endraw %}
### Distance ### Distance
@ -556,6 +573,7 @@ Not supported in [limited templates](#limited-templates).
- `distance()` will measure the distance in kilometers between home, entity, coordinates. - `distance()` will measure the distance in kilometers between home, entity, coordinates.
- `closest()` will find the closest entity. - `closest()` will find the closest entity.
#### Distance examples #### Distance examples
If only one location is passed in, Home Assistant will measure the distance from home. If only one location is passed in, Home Assistant will measure the distance from home.

View File

@ -8,14 +8,14 @@ interface, by using this My button:
{% my config_flow_start badge domain=domain %} {% my config_flow_start badge domain=domain %}
{% if include.discovery or page.ha_dhcp or page.ha_homekit or page.ha_ssdp or page.ha_zeroconf %} {% if include.discovery or page.ha_dhcp or page.ha_homekit or page.ha_ssdp or page.ha_zeroconf or page.ha_mqtt %}
{{ name }} can be auto-discovered by Home Assistant. If an instance was found, {{ name }} can be auto-discovered by Home Assistant. If an instance was found,
it will be shown as _"Discovered"_, which you can select to set it up right it will be shown as _"Discovered"_, which you can select to set it up right
away. away.
{% endif %} {% endif %}
{% details "Manual configuration steps" %} {% details "Manual configuration steps" %}
{% if include.discovery or page.ha_dhcp or page.ha_homekit or page.ha_ssdp or page.ha_zeroconf %} {% if include.discovery or page.ha_dhcp or page.ha_homekit or page.ha_ssdp or page.ha_zeroconf or page.ha_mqtt %}
If there wasn't any discovered automatically, don't worry! You can set up a If there wasn't any discovered automatically, don't worry! You can set up a
manual integration entry: manual integration entry:
{% else %} {% else %}

View File

@ -7,7 +7,7 @@ ha_quality_scale: internal
ha_category: [] ha_category: []
ha_codeowners: ha_codeowners:
- '@home-assistant/core' - '@home-assistant/core'
ha_integration_type: integration ha_integration_type: entity
--- ---
The `air_quality` base platform allows other integrations to process information about air quality and pollution details. It is used by integrations that provide an `air_quality` sensor - you can find those under the `health` [integrations](/integrations/#health). The `air_quality` base platform allows other integrations to process information about air quality and pollution details. It is used by integrations that provide an `air_quality` sensor - you can find those under the `health` [integrations](/integrations/#health).

View File

@ -8,7 +8,7 @@ ha_quality_scale: internal
ha_domain: alarm_control_panel ha_domain: alarm_control_panel
ha_codeowners: ha_codeowners:
- '@home-assistant/core' - '@home-assistant/core'
ha_integration_type: integration ha_integration_type: entity
--- ---
Home Assistant can give you an interface which is similar to a classic alarm system. Home Assistant can give you an interface which is similar to a classic alarm system.

View File

@ -1,95 +0,0 @@
---
title: Ambee
description: Instructions on how to integrate Ambee within Home Assistant.
ha_category:
- Environment
- Health
ha_release: 2021.7
ha_iot_class: Cloud Polling
ha_config_flow: true
ha_codeowners:
- '@frenck'
ha_domain: ambee
ha_platforms:
- sensor
ha_quality_scale: platinum
ha_integration_type: integration
---
<div class='note warning'>
This integration is pending removal from Home Assistant and will be no longer available as of Home Assistant 2022.10.
</div>
The Ambee integration integrates the [Ambee](https://www.getambee.com/) API
platform with Home Assistant.
Ambee fuses the power of thousands of on-ground sensor data and hundreds of
remote imagery from satellites. Their state-of-the-art AI and ML techniques with
proprietary models analyze environmental factors such as air quality, soil,
micro weather, pollen, and more to help millions worldwide say safe and protect
themselves.
## Prerequisites
To use the Ambee integration, you will need to obtain an API key from Ambee.
Ambee provides free evulation API keys, that are limited to 50,000 credits
and for a period of 30 days. After that, you will need to sign up for a
paid enterprise plan in order to continue using Ambee.
[Sign up for an Ambee account](https://api-dashboard.getambee.com/#/signup).
Once you have completed the sign up and logged in for the first time, the
API token will be displayed on the top of your
[Ambee dashboard](https://api-dashboard.getambee.com/#/). Make sure you select
both the Air Quality API and the Pollen API.
{% include integrations/config_flow.md %}
## Sensors
The Ambee platform mainly provides sensors that you can use in your automations.
### Air Quality
Polluted air affects planetary well-being with disruption to our ecosystem and
various health risks. The following sensors from Ambee are available on this:
- Air Quality Index (AQI)
- Carbon Monoxide (CO)
- Nitrogen Dioxide (NO2)
- Ozone
- Particulate Matter < 10 μm
- Particulate Matter < 2.5 μm
- Sulphur Dioxide (SO2)
### Pollen
Pollen is a fine powder produced by trees and plants. Pollen can severely affect
people, especially those with different ailments such as asthma and respiratory
issues. This integration provides a lot of sensors to monitor pollen counts and
risks.
Generic pollen count sensors (in pollen/m3)
and as risk level (low, moderate, high, very high):
- Grass
- Tree
- Weed
Additionally, sensors for specific pollen from specific grasses,
trees or weeds, in pollen/m3, are provided. These are disabled by default.
Enable those entities in the user interface if you like to use these:
- Alder Tree
- Birch Tree
- Chenopod Weed
- Cypress Tree
- Elm Tree
- Hazel Tree
- Mugwort Weed
- Nettle Weed
- Oak Tree
- Pine Tree
- Plane Tree
- Poaceae Grass
- Poplar Tree
- Ragweed

View File

@ -10,7 +10,7 @@ ha_codeowners:
- '@home-assistant/core' - '@home-assistant/core'
- '@ludeeus' - '@ludeeus'
ha_domain: analytics ha_domain: analytics
ha_integration_type: integration ha_integration_type: system
--- ---
{% assign current_version = site.current_major_version | append: "." | append: site.current_minor_version | append: "." | append: site.current_patch_version %} {% assign current_version = site.current_major_version | append: "." | append: site.current_minor_version | append: "." | append: site.current_patch_version %}

View File

@ -1,7 +1,6 @@
--- ---
title: apcupsd title: APC UPS Daemon
description: Instructions on how to integrate apcupsd status with Home Assistant. description: Instructions on how to integrate apcupsd status with Home Assistant.
logo: apcupsd.png
ha_category: ha_category:
- Binary Sensor - Binary Sensor
- Sensor - Sensor
@ -9,18 +8,21 @@ ha_category:
ha_release: 0.13 ha_release: 0.13
ha_iot_class: Local Polling ha_iot_class: Local Polling
ha_domain: apcupsd ha_domain: apcupsd
ha_config_flow: true
ha_codeowners:
- '@yuxincs'
ha_platforms: ha_platforms:
- binary_sensor - binary_sensor
- sensor - sensor
ha_integration_type: integration ha_integration_type: integration
--- ---
[Apcupsd](http://www.apcupsd.org/) status information can be integrated into Home Assistant when the Network Information Server (NIS) [is configured](http://www.apcupsd.org/manual/manual.html#nis-server-client-configuration-using-the-net-driver) on the APC device. [apcupsd](http://www.apcupsd.org/) status information can be integrated into Home Assistant when the Network Information Server (NIS) [is configured](http://www.apcupsd.org/manual/manual.html#nis-server-client-configuration-using-the-net-driver) on the APC device.
There is currently support for the following device types within Home Assistant: There is currently support for the following device types within Home Assistant:
- [Binary Sensor](#binary-sensor) - [Binary Sensor](#binary-sensor)
- [Sensor](#sensor) - [Sensor](#sensors)
## Home Assistant add-on installation ## Home Assistant add-on installation
@ -28,136 +30,94 @@ Install this [unofficial add-on](https://github.com/korylprince/hassio-apcupsd/)
After installation, follow the instructions on the GitHub page to configure the plugin. Then continue to follow the integration configurations below. After installation, follow the instructions on the GitHub page to configure the plugin. Then continue to follow the integration configurations below.
## Configuration {% include integrations/config_flow.md %}
To enable this sensor, add the following lines to your `configuration.yaml`:
```yaml
# Example configuration.yaml entry
apcupsd:
```
{% configuration %}
host:
description: The hostname/IP address on which the apcupsd NIS is being served.
required: false
type: string
default: localhost
port:
description: The port on which the apcupsd NIS is listening.
required: false
type: integer
default: 3551
{% endconfiguration %}
<div class='note'> <div class='note'>
If you get `ConnectionRefusedError: Connection refused` errors in the Home Assistant logs, ensure the [Apcupsd](http://www.apcupsd.org/) configuration directives used by its Network Information Server is set to permit connections from all addresses [NISIP 0.0.0.0](http://www.apcupsd.org/manual/manual.html#configuration-directives-used-by-the-network-information-server), else non-local addresses will not connect. If you get `ConnectionRefusedError: Connection refused` errors in the Home Assistant logs, ensure the [apcupsd](http://www.apcupsd.org/) configuration directives used by its Network Information Server is set to permit connections from all addresses [NISIP 0.0.0.0](http://www.apcupsd.org/manual/manual.html#configuration-directives-used-by-the-network-information-server), else non-local addresses will not connect.
</div>
</div>
## Binary sensor ## Binary sensor
In addition to the [Apcupsd Sensor](#sensor) devices, you may also create a device which is simply "on" when the UPS status is online and "off" at all other times. This integration provides a binary sensor for the following information from apcupsd:
### Configuration - UPS status
To enable this sensor, you first have to set up apcupsd integration (above), and add the following lines to your `configuration.yaml` file: ## Sensors
```yaml This integration provides sensors for the following information from apcupsd based on their availability. Each sensor is listed here along with their corresponding resource name obtained from `apcaccess`.
# Example configuration.yaml entry
binary_sensor:
- platform: apcupsd
```
{% configuration %} <div class='note'>
name:
description: Name to use in the frontend.
required: false
type: string
default: UPS Online Status
{% endconfiguration %}
## Sensor Some sensors are disabled by default, since they provide information that is only useful for advanced users. You can manually enable them in **{% my entities title="Settings -> Devices & Services -> Entities" %}** -> the sensor entity you want to enable -> Advanced settings -> Enabled.
The `apcupsd` sensor platform allows you to monitor a UPS (battery backup) by using data from the [apcaccess](https://linux.die.net/man/8/apcaccess) command. </div>
### Configuration - UPS Alarm Delay (ALARMDEL)
- UPS Ambient Temperature (AMBTEMP)
To use this sensor platform, you first have to set up apcupsd integration (above), and add the following to your `configuration.yaml` file: - UPS Status Data (APC)
- UPS Model (APCMODEL)
```yaml - UPS Bad Batteries (BADBATTS)
# Example configuration.yaml entry - UPS Battery Replaced (BATTDATE)
sensor: - UPS Battery Status (BATTSTAT)
- platform: apcupsd - UPS Battery Voltage (BATTV)
resources: - UPS Battery (BCHARGE)
- bcharge - UPS Cable Type (CABLE)
- linev - UPS Total Time on Battery (CUMONBATT)
``` - UPS Status Date (DATE)
- UPS Dip Switch Settings (DIPSW)
{% configuration %} - UPS Low Battery Signal (DLOWBATT)
resources: - UPS Driver (DRIVER)
description: Contains all entries to display. - UPS Shutdown Delay (DSHUTD)
required: true - UPS Wake Delay (DWAKE)
type: list - UPS Date and Time (END APC)
{% endconfiguration %} - UPS External Batteries (EXTBATTS)
- UPS Firmware Version (FIRMWARE)
### Example - UPS Transfer High (HITRANS)
- UPS Hostname (HOSTNAME)
Given the following output from `apcaccess`: - UPS Ambient Humidity (HUMIDITY)
- UPS Internal Temperature (ITEMP)
```yaml - UPS Last Transfer (LASTXFER)
APC : 001,051,1149 - UPS Input Voltage Status (LINEFAIL)
DATE : 2016-02-09 17:13:31 +0000 - UPS Line Frequency (LINEFREQ)
HOSTNAME : localhost - UPS Input Voltage (LINEV)
VERSION : 3.14.12 (29 March 2014) redhat - UPS Load (LOADPCT)
UPSNAME : netrack - UPS Load Apparent Power (LOADAPNT)
CABLE : Custom Cable Smart - UPS Transfer Low (LOTRANS)
DRIVER : APC Smart UPS (any) - UPS Manufacture Date (MANDATE)
UPSMODE : Stand Alone - UPS Master Update (MASTERUPD)
STARTTIME: 2016-02-09 16:06:47 +0000 - UPS Input Voltage High (MAXLINEV)
MODEL : SMART-UPS 1400 - UPS Battery Timeout (MAXTIME)
STATUS : TRIM ONLINE - UPS Battery Shutdown (MBATTCHG)
LINEV : 247.0 Volts - UPS Input Voltage Low (MINLINEV)
LOADPCT : 13.0 Percent - UPS Shutdown Time (MINTIMEL)
BCHARGE : 100.0 Percent - UPS Model (MODEL)
TIMELEFT : 104.0 Minutes - UPS Battery Nominal Voltage (NOMBATTV)
MBATTCHG : 5 Percent - UPS Nominal Input Voltage (NOMINV)
MINTIMEL : 3 Minutes - UPS Nominal Output Voltage (NOMOUTV)
MAXTIME : 0 Seconds - UPS Nominal Output Power (NOMPOWER)
MAXLINEV : 249.6 Volts - UPS Nominal Apparent Power (NOMAPNT)
MINLINEV : 244.4 Volts - UPS Transfer Count (NUMXFERS)
OUTPUTV : 218.4 Volts - UPS Output Current (OUTCURNT)
[...] - UPS Output Voltage (OUTPUTV)
``` - UPS Register 1 Fault (REG1)
- UPS Register 2 Fault (REG2)
Use the values from the left hand column (lower case required). - UPS Register 3 Fault (REG3)
- UPS Restore Requirement (RETPCT)
Full Example Configuration: - UPS Last Self Test (SELFTEST)
- UPS Sensitivity (SENSE)
```yaml - UPS Serial Number (SERIALNO)
sensor: - UPS Startup Time (STARTTIME)
- platform: apcupsd - UPS Status Flag (STATFLAG)
resources: - UPS Status (STATUS)
- apc - UPS Self Test Interval (STESTI)
- date - UPS Time Left (TIMELEFT)
- hostname - UPS Time on Battery (TONBATT)
- version - UPS Mode (UPSMODE)
- upsname - UPS Name (UPSNAME)
- cable - UPS Daemon Info (VERSION)
- driver - UPS Transfer from Battery (XOFFBAT)
- upsmode - UPS Transfer from Battery (XOFFBATT)
- starttime - UPS Transfer to Battery (XONBATT)
- model
- status
- linev
- loadpct
- bcharge
- timeleft
- mbattchg
- mintimel
- maxtime
- maxlinev
- minlinev
- outputv
```

View File

@ -8,7 +8,7 @@ ha_quality_scale: internal
ha_codeowners: ha_codeowners:
- '@home-assistant/core' - '@home-assistant/core'
ha_domain: api ha_domain: api
ha_integration_type: integration ha_integration_type: system
--- ---
The `api` integration exposes a RESTful API and allows one to interact with a Home Assistant instance that is running headless. This integration depends on the [HTTP integration](/integrations/http/). The `api` integration exposes a RESTful API and allows one to interact with a Home Assistant instance that is running headless. This integration depends on the [HTTP integration](/integrations/http/).

View File

@ -7,7 +7,7 @@ ha_quality_scale: internal
ha_category: [] ha_category: []
ha_codeowners: ha_codeowners:
- '@home-assistant/core' - '@home-assistant/core'
ha_integration_type: integration ha_integration_type: system
--- ---
The Application Credentials integration is used by integrations that use OAuth2 to link your account to Home Assistant. The most common and preferred approach is using account linking with Home Assistant Cloud, however not all cloud providers support that and integrations can use Application Credentials instead. Additionally, users may use Application Credentials if preferred instead of Home Assistant Cloud Account Linking. The Application Credentials integration is used by integrations that use OAuth2 to link your account to Home Assistant. The most common and preferred approach is using account linking with Home Assistant Cloud, however not all cloud providers support that and integrations can use Application Credentials instead. Additionally, users may use Application Credentials if preferred instead of Home Assistant Cloud Account Linking.

View File

@ -1,6 +1,6 @@
--- ---
title: August Bluetooth title: August Bluetooth
description: Instructions on how to integrate August Bluetooth locks into Home Assistant. description: Connect and control your August Bluetooth devices using the Yale Access Bluetooth integration
ha_category: ha_category:
- Binary Sensor - Binary Sensor
- Lock - Lock
@ -25,4 +25,4 @@ Integrates [August](https://august.com/) locks over Bluetooth into Home Assistan
Following Assa Abloy, Yale's parent company, purchasing August in 2017, most newer devices use the Yale Access branding. Following Assa Abloy, Yale's parent company, purchasing August in 2017, most newer devices use the Yale Access branding.
{% include integrations/supported_brand.md %} {% include integrations/supported_brand.md %}

View File

@ -8,7 +8,7 @@ ha_quality_scale: internal
ha_codeowners: ha_codeowners:
- '@home-assistant/core' - '@home-assistant/core'
ha_domain: auth ha_domain: auth
ha_integration_type: integration ha_integration_type: system
--- ---
This integration creates the endpoints for the [authentication system](/docs/authentication/) that is built into Home Assistant. This integration creates the endpoints for the [authentication system](/docs/authentication/) that is built into Home Assistant.

View File

@ -8,7 +8,7 @@ ha_quality_scale: internal
ha_codeowners: ha_codeowners:
- '@home-assistant/core' - '@home-assistant/core'
ha_domain: automation ha_domain: automation
ha_integration_type: integration ha_integration_type: system
--- ---
<script>document.location.href = '/docs/automation/';</script> <script>document.location.href = '/docs/automation/';</script>

View File

@ -9,7 +9,7 @@ ha_domain: backup
ha_codeowners: ha_codeowners:
- '@home-assistant/core' - '@home-assistant/core'
ha_iot_class: Calculated ha_iot_class: Calculated
ha_integration_type: integration ha_integration_type: system
--- ---
The Backup integration allow you to create and download backups for your Home Assistant Core and Home Assistant Container installations. This backup file can be used if you migrate to Home Assistant Operating System. The Backup integration allow you to create and download backups for your Home Assistant Core and Home Assistant Container installations. This backup file can be used if you migrate to Home Assistant Operating System.

View File

@ -11,6 +11,8 @@ ha_domain: bayesian
ha_platforms: ha_platforms:
- binary_sensor - binary_sensor
ha_integration_type: integration ha_integration_type: integration
ha_codeowners:
- '@HarvsG'
--- ---
The `bayesian` binary sensor platform observes the state from multiple sensors and uses [Bayes' rule](https://en.wikipedia.org/wiki/Bayes%27_theorem) to estimate the probability that an event has occurred given the state of the observed sensors. If the estimated posterior probability is above the `probability_threshold`, the sensor is `on` otherwise it is `off`. The `bayesian` binary sensor platform observes the state from multiple sensors and uses [Bayes' rule](https://en.wikipedia.org/wiki/Bayes%27_theorem) to estimate the probability that an event has occurred given the state of the observed sensors. If the estimated posterior probability is above the `probability_threshold`, the sensor is `on` otherwise it is `off`.

View File

@ -8,7 +8,7 @@ ha_quality_scale: internal
ha_domain: binary_sensor ha_domain: binary_sensor
ha_codeowners: ha_codeowners:
- '@home-assistant/core' - '@home-assistant/core'
ha_integration_type: integration ha_integration_type: entity
--- ---
Binary sensors are similar to other [sensors](/integrations/sensor) in that they Binary sensors are similar to other [sensors](/integrations/sensor) in that they

View File

@ -8,7 +8,7 @@ ha_quality_scale: internal
ha_codeowners: ha_codeowners:
- '@home-assistant/core' - '@home-assistant/core'
ha_domain: blueprint ha_domain: blueprint
ha_integration_type: integration ha_integration_type: system
--- ---
<script>document.location.href = '/docs/automation/using_blueprints/';</script> <script>document.location.href = '/docs/automation/using_blueprints/';</script>

View File

@ -2,6 +2,7 @@
title: Sony Bravia TV title: Sony Bravia TV
description: Instructions on how to integrate a Sony Bravia TV into Home Assistant. description: Instructions on how to integrate a Sony Bravia TV into Home Assistant.
ha_category: ha_category:
- Button
- Media Player - Media Player
- Remote - Remote
ha_release: 0.23 ha_release: 0.23
@ -12,8 +13,10 @@ ha_codeowners:
ha_domain: braviatv ha_domain: braviatv
ha_config_flow: true ha_config_flow: true
ha_platforms: ha_platforms:
- button
- media_player - media_player
- remote - remote
ha_ssdp: true
ha_integration_type: integration ha_integration_type: integration
--- ---
@ -23,11 +26,20 @@ Almost all [Sony Bravia TV 2013 and newer](https://info.tvsideview.sony.net/en_w
{% include integrations/config_flow.md %} {% include integrations/config_flow.md %}
## Authentication
The Bravia TV integration supports two types of authentication:
- **PSK (Pre-Shared-Key)** is a user-defined secret key used for access control. This authentication method is recommended as more reliable and stable. To set up and enable PSK on your TV, go to: **Settings -> Network -> Home Network Setup -> IP Control**.
- **PIN Code** authentication is easier and does not require additional settings.
For more information, see [IP Control Authentication](https://pro-bravia.sony.net/develop/integrate/ip-control/index.html#ip-control-authentication).
## Common Issues ## Common Issues
### TV does not generate new pin ### TV does not generate new pin
If you have previously set up your TV with any Home Assistant instances, you must remove Home Assistant from your TV in order for your TV to generate a new pin. To do this, you must do **one** of the following: If you have previously set up your TV with any Home Assistant instances via PIN code, you must remove Home Assistant from your TV in order for your TV to generate a new pin. To do this, you must do **one** of the following:
- On your TV, go to: **Settings** -> **Network** -> **Remote device settings** -> **Deregister remote device**. Disable and re-enable the **Control remotely** after. Menu titles may differ slightly between models. If needed, refer to your specific model's [manual](https://www.sony.com/electronics/support/manuals) for additional guidance. - On your TV, go to: **Settings** -> **Network** -> **Remote device settings** -> **Deregister remote device**. Disable and re-enable the **Control remotely** after. Menu titles may differ slightly between models. If needed, refer to your specific model's [manual](https://www.sony.com/electronics/support/manuals) for additional guidance.
- Reset your TV to factory condition. - Reset your TV to factory condition.
@ -65,6 +77,10 @@ The commands that can be sent to the TV depends on the model of your TV. To disp
{% enddetails %} {% enddetails %}
## Buttons
The integration supports `button` platform and allows you to reboot the device or terminate all running applications.
{% include integrations/option_flow.md %} {% include integrations/option_flow.md %}
The integration allows you to customize the list of ignored sources. The integration allows you to customize the list of ignored sources.

View File

@ -0,0 +1,23 @@
---
title: BSwitch
description: Connect and control your BSwitch devices using the SwitchBee integration
ha_category:
- Button
- Light
- Switch
ha_domain: bswitch
ha_codeowners:
- '@jafar-atili'
ha_integration_type: integration
ha_config_flow: true
ha_platforms:
- button
- light
- switch
ha_iot_class: Local Polling
ha_supporting_domain: switchbee
ha_supporting_integration: SwitchBee
ha_release: '2022.10'
---
{% include integrations/supported_brand.md %}

View File

@ -1,6 +1,6 @@
--- ---
title: BTHome title: BTHome
description: Instructions on how to integrate BThome BLE devices into Home Assistant. description: Instructions on how to integrate BTHome BLE devices into Home Assistant.
ha_category: ha_category:
- Sensor - Sensor
ha_bluetooth: true ha_bluetooth: true
@ -11,6 +11,7 @@ ha_codeowners:
ha_domain: bthome ha_domain: bthome
ha_config_flow: true ha_config_flow: true
ha_platforms: ha_platforms:
- binary_sensor
- sensor - sensor
ha_integration_type: integration ha_integration_type: integration
--- ---
@ -23,10 +24,6 @@ The BTHome BLE integration will automatically discover devices once the [Bluetoo
BTHome is an energy effective but flexible BLE format to broadcast data with Bluetooth and allows you to create your own DIY BLE sensors. More information about the BTHome BLE format and projects that use the format can be found on the [BTHome website](https://bthome.io/). BTHome is an energy effective but flexible BLE format to broadcast data with Bluetooth and allows you to create your own DIY BLE sensors. More information about the BTHome BLE format and projects that use the format can be found on the [BTHome website](https://bthome.io/).
## Supported sensor measurements
The current release only supports sensors, no binary sensors.
## Bindkey ## Bindkey
When using encryption for your BTHome sensor, you will promted to enter your 32 character hexadecimal (16 bytes) encryption key. This key is called the bindkey. More information about the bindkey can be found in the [specifications](https://bthome.io/#encryption). When using encryption for your BTHome sensor, you will promted to enter your 32 character hexadecimal (16 bytes) encryption key. This key is called the bindkey. More information about the bindkey can be found in the [specifications](https://bthome.io/#encryption).

View File

@ -0,0 +1,36 @@
---
title: BTicino
description: Connect and control your BTicino devices using the Netatmo integration
ha_category:
- Camera
- Climate
- Cover
- Environment
- Hub
- Light
- Media Source
- Sensor
- Switch
- Weather
ha_domain: bticino
ha_codeowners:
- '@cgtobi'
ha_integration_type: integration
ha_config_flow: true
ha_platforms:
- camera
- climate
- cover
- diagnostics
- light
- select
- sensor
- switch
ha_iot_class: Cloud Polling
ha_homekit: true
ha_supporting_domain: netatmo
ha_supporting_integration: Netatmo
ha_release: '0.20'
---
{% include integrations/supported_brand.md %}

View File

@ -0,0 +1,36 @@
---
title: Bubendorff
description: Connect and control your Bubendorff devices using the Netatmo integration
ha_category:
- Camera
- Climate
- Cover
- Environment
- Hub
- Light
- Media Source
- Sensor
- Switch
- Weather
ha_domain: bubendorff
ha_codeowners:
- '@cgtobi'
ha_integration_type: integration
ha_config_flow: true
ha_platforms:
- camera
- climate
- cover
- diagnostics
- light
- select
- sensor
- switch
ha_iot_class: Cloud Polling
ha_homekit: true
ha_supporting_domain: netatmo
ha_supporting_integration: Netatmo
ha_release: '0.20'
---
{% include integrations/supported_brand.md %}

View File

@ -8,7 +8,7 @@ ha_quality_scale: internal
ha_domain: button ha_domain: button
ha_codeowners: ha_codeowners:
- '@home-assistant/core' - '@home-assistant/core'
ha_integration_type: integration ha_integration_type: entity
--- ---
A button entity is an entity that can fire an event / trigger an action towards A button entity is an entity that can fire an event / trigger an action towards

View File

@ -7,7 +7,7 @@ ha_quality_scale: internal
ha_category: [] ha_category: []
ha_codeowners: ha_codeowners:
- '@home-assistant/core' - '@home-assistant/core'
ha_integration_type: integration ha_integration_type: entity
--- ---
The calendar integration allows you to integrate your calendars into Home Assistant. Calendars are shown on the calendar dashboard, and can be used with automations. The calendar integration allows you to integrate your calendars into Home Assistant. Calendars are shown on the calendar dashboard, and can be used with automations.

View File

@ -9,7 +9,7 @@ ha_quality_scale: internal
ha_domain: camera ha_domain: camera
ha_codeowners: ha_codeowners:
- '@home-assistant/core' - '@home-assistant/core'
ha_integration_type: integration ha_integration_type: entity
ha_platforms: ha_platforms:
- diagnostics - diagnostics
--- ---

View File

@ -8,7 +8,7 @@ ha_quality_scale: internal
ha_domain: climate ha_domain: climate
ha_codeowners: ha_codeowners:
- '@home-assistant/core' - '@home-assistant/core'
ha_integration_type: integration ha_integration_type: entity
--- ---
The Climate integration allows you to control and monitor HVAC (heating, ventilating, and air conditioning) devices and thermostats. The Climate integration allows you to control and monitor HVAC (heating, ventilating, and air conditioning) devices and thermostats.

View File

@ -10,7 +10,7 @@ ha_codeowners:
ha_domain: config ha_domain: config
ha_platforms: ha_platforms:
- scene - scene
ha_integration_type: integration ha_integration_type: system
--- ---
The `config` integration is designed to display panels in the frontend to configure and manage parts of Home Assistant. The `config` integration is designed to display panels in the frontend to configure and manage parts of Home Assistant.

View File

@ -8,7 +8,7 @@ ha_quality_scale: internal
ha_codeowners: ha_codeowners:
- '@home-assistant/core' - '@home-assistant/core'
ha_domain: configurator ha_domain: configurator
ha_integration_type: integration ha_integration_type: system
--- ---
<div class='note'> <div class='note'>

View File

@ -9,7 +9,7 @@ ha_iot_class: Local Push
ha_codeowners: ha_codeowners:
- '@home-assistant/core' - '@home-assistant/core'
ha_domain: conversation ha_domain: conversation
ha_integration_type: integration ha_integration_type: system
--- ---
The conversation integration allows you to converse with Home Assistant. You can either converse by pressing the microphone in the frontend (supported browsers only (no iOS)) or by calling the `conversation/process` service with the transcribed text. The conversation integration allows you to converse with Home Assistant. You can either converse by pressing the microphone in the frontend (supported browsers only (no iOS)) or by calling the `conversation/process` service with the transcribed text.

View File

@ -8,7 +8,7 @@ ha_quality_scale: internal
ha_codeowners: ha_codeowners:
- '@home-assistant/core' - '@home-assistant/core'
ha_domain: cover ha_domain: cover
ha_integration_type: integration ha_integration_type: entity
--- ---
Home Assistant can give you an interface to control covers such as rollershutters, blinds, and garage doors. Home Assistant can give you an interface to control covers such as rollershutters, blinds, and garage doors.

View File

@ -8,7 +8,7 @@ ha_domain: default_config
ha_quality_scale: internal ha_quality_scale: internal
ha_codeowners: ha_codeowners:
- '@home-assistant/core' - '@home-assistant/core'
ha_integration_type: integration ha_integration_type: system
--- ---
This integration is a meta-component and configures a default set of integrations for Home Assistant to load. The integrations that will be loaded are: This integration is a meta-component and configures a default set of integrations for Home Assistant to load. The integrations that will be loaded are:

View File

@ -7,7 +7,7 @@ ha_quality_scale: internal
ha_codeowners: ha_codeowners:
- '@home-assistant/core' - '@home-assistant/core'
ha_domain: device_automation ha_domain: device_automation
ha_integration_type: integration ha_integration_type: system
--- ---
Device Automations is a plugin for the automation integration to allow other integrations to provide device specific triggers, conditions and actions. Device Automations is a plugin for the automation integration to allow other integrations to provide device specific triggers, conditions and actions.

View File

@ -8,7 +8,7 @@ ha_quality_scale: internal
ha_domain: device_tracker ha_domain: device_tracker
ha_codeowners: ha_codeowners:
- '@home-assistant/core' - '@home-assistant/core'
ha_integration_type: integration ha_integration_type: entity
--- ---
The device tracker allows you to track devices in Home Assistant. This can happen by querying your wireless router or by having applications push location info. The device tracker allows you to track devices in Home Assistant. This can happen by querying your wireless router or by having applications push location info.

View File

@ -9,7 +9,7 @@ ha_domain: dhcp
ha_quality_scale: internal ha_quality_scale: internal
ha_codeowners: ha_codeowners:
- '@bdraco' - '@bdraco'
ha_integration_type: integration ha_integration_type: system
--- ---
The `dhcp` "DHCP Discovery" integration will watch the network for DHCP requests for supported devices and services. Discovered integrations will show up in the discovered section on the integrations page in the configuration panel. The `dhcp` "DHCP Discovery" integration will watch the network for DHCP requests for supported devices and services. Discovered integrations will show up in the discovered section on the integrations page in the configuration panel.

View File

@ -8,7 +8,7 @@ ha_quality_scale: internal
ha_domain: diagnostics ha_domain: diagnostics
ha_codeowners: ha_codeowners:
- '@home-assistant/core' - '@home-assistant/core'
ha_integration_type: integration ha_integration_type: system
--- ---
The diagnostics integration provides a way to download diagnostic data from The diagnostics integration provides a way to download diagnostic data from

View File

@ -8,7 +8,7 @@ ha_quality_scale: internal
ha_domain: discovery ha_domain: discovery
ha_codeowners: ha_codeowners:
- '@home-assistant/core' - '@home-assistant/core'
ha_integration_type: integration ha_integration_type: system
--- ---
This is the legacy discovery integration for Home Assistant. It's use is no longer recommended. Use the [SSDP](/integrations/ssdp/), [Zeroconf](/integrations/zeroconf/) and [USB](/integrations/usb/) integrations instead. This is the legacy discovery integration for Home Assistant. It's use is no longer recommended. Use the [SSDP](/integrations/ssdp/), [Zeroconf](/integrations/zeroconf/) and [USB](/integrations/usb/) integrations instead.

View File

@ -5,9 +5,12 @@ ha_category:
- Energy - Energy
- Sensor - Sensor
ha_iot_class: Local Push ha_iot_class: Local Push
ha_config_flow: true
ha_mqtt: true
ha_release: 0.103 ha_release: 0.103
ha_codeowners: ha_codeowners:
- '@depl0y' - '@depl0y'
- '@glodenox'
ha_domain: dsmr_reader ha_domain: dsmr_reader
ha_platforms: ha_platforms:
- sensor - sensor
@ -18,24 +21,18 @@ The `dsmr_reader` sensor integration allows you to easily add all sensors that [
## Prerequisites ## Prerequisites
- DSMR Reader To use this DSMR Reader sensor integration, you need to have a DSMR Reader instance running and an MQTT broker to send sensor data through.
- MQTT broker
## Setup 1. Add the MQTT broker integration in Home Assistant, if you haven't done so already
2. Configure the MQTT broker in the DSMR Reader application
1. Configure the MQTT broker in DSMR Reader which Home Assistant also connects to 3. Enable the following data sources in the DSMR Reader administration pages with the default mappings:
2. Enable the following data sources in DSMR Reader with the default mapping:
- Day consumption: Split topic - Day consumption: Split topic
- Gas consumption: Split topic - Gas consumption: Split topic
- Meter Statistics: Split topic - Meter Statistics: Split topic
- Telegram: Split topic - Telegram: Split topic
## Configuration {% include integrations/config_flow.md %}
To use this integration in your installation, add the following to your `configuration.yaml` file: ## Difference with the DSMR integration
```yaml This integration relies on the presence of an existing DSMR Reader application setup. It processes the events triggered by the MQTT publishing feature to create sensor entities within Home Assistant. This integration uses the data published on the MQTT broker, no matter how or where the application is installed. By comparison, the [DSMR](/integrations/dsmr/) integration adds a full instance of the DSMR Reader application within Home Assistant. It is possible to have both integrations installed at the same time and working together, but this is not required.
# Example configuration.yaml entry
sensor:
- platform: dsmr_reader
```

View File

@ -10,5 +10,5 @@ ha_codeowners:
ha_domain: energy ha_domain: energy
ha_platforms: ha_platforms:
- sensor - sensor
ha_integration_type: integration ha_integration_type: system
--- ---

View File

@ -8,7 +8,7 @@ ha_quality_scale: internal
ha_domain: fan ha_domain: fan
ha_codeowners: ha_codeowners:
- '@home-assistant/core' - '@home-assistant/core'
ha_integration_type: integration ha_integration_type: entity
--- ---
The Fan integration allows you to control and monitor Fan devices. The Fan integration allows you to control and monitor Fan devices.

View File

@ -4,9 +4,10 @@ description: File upload integration supports various frontend features within H
ha_release: 2022.9 ha_release: 2022.9
ha_quality_scale: internal ha_quality_scale: internal
ha_domain: file_upload ha_domain: file_upload
ha_integration_type: integration ha_integration_type: system
ha_codeowners: ha_codeowners:
- '@home-assistant/core' - '@home-assistant/core'
ha_category: []
--- ---
The file upload integration allows various features in the frontend to upload files. The file upload integration allows various features in the frontend to upload files.

View File

@ -1,44 +0,0 @@
---
title: Flu Near You
description: Instructions on how to use Flu Near You data within Home Assistant
ha_category:
- Health
ha_release: 0.83
ha_iot_class: Cloud Polling
ha_codeowners:
- '@bachya'
ha_domain: flunearyou
ha_config_flow: true
ha_platforms:
- diagnostics
- sensor
ha_integration_type: integration
---
<div class='note warning'>
This integration is pending removal from Home Assistant and will be no longer available as of Home Assistant 2022.10.
</div>
The `flunearyou` sensor platform allows users in the United States and its
territories to get information regarding reported flu symptoms from [Flu Near
You](https://flunearyou.org/). The platform can return user-reported information as well reports from the
Center for Disease Control (CDC).
{% include integrations/config_flow.md %}
## Sensor Types
### User Report
* Number of reported cases of [Avian Flu](https://www.cdc.gov/flu/avianflu/index.htm) symptoms
* Number of reported cases of [Dengue](https://www.cdc.gov/dengue/index.html) symptoms
* Number of reported cases of [Flu](https://www.cdc.gov/flu/) symptoms
* Number of reported cases of [Flu-like](https://en.wikipedia.org/wiki/Influenza-like_illness) symptoms
* Number of reported cases of [Leptospirosis](https://www.cdc.gov/leptospirosis/index.html) symptoms
* Total number of reported cases with symptoms
* Number of reported cases with no symptoms
### CDC Report
* Current CDC level for the state
* Current CDC "Level 2" for the state

View File

@ -8,7 +8,7 @@ ha_quality_scale: internal
ha_codeowners: ha_codeowners:
- '@home-assistant/frontend' - '@home-assistant/frontend'
ha_domain: frontend ha_domain: frontend
ha_integration_type: integration ha_integration_type: system
--- ---
This offers the official frontend to control Home Assistant. This integration is by default enabled, unless you've disabled or removed the [`default_config:`](/integrations/default_config/) line from your configuration. If that is the case, the following example shows you how to enable this integration manually: This offers the official frontend to control Home Assistant. This integration is by default enabled, unless you've disabled or removed the [`default_config:`](/integrations/default_config/) line from your configuration. If that is the case, the following example shows you how to enable this integration manually:

View File

@ -8,7 +8,7 @@ ha_domain: geo_location
ha_quality_scale: internal ha_quality_scale: internal
ha_codeowners: ha_codeowners:
- '@home-assistant/core' - '@home-assistant/core'
ha_integration_type: integration ha_integration_type: entity
--- ---
Geolocation aware entities are typically related to events in the real world in the vicinity of Home Assistant's location, like for example weather events, bush fires or earthquakes. Geolocation aware entities are typically related to events in the real world in the vicinity of Home Assistant's location, like for example weather events, bush fires or earthquakes.

View File

@ -1,5 +1,5 @@
--- ---
title: Google Calendars title: Google Calendar
description: Instructions on how to use Google Calendars in Home Assistant. description: Instructions on how to use Google Calendars in Home Assistant.
ha_category: ha_category:
- Calendar - Calendar

View File

@ -0,0 +1,86 @@
---
title: Google Sheets
description: Instructions on how to use Google Sheets in Home Assistant.
ha_category:
- Utility
ha_iot_class: Cloud Polling
ha_release: '2022.10'
ha_config_flow: true
ha_domain: google_sheets
ha_codeowners:
- '@tkdrob'
ha_integration_type: integration
---
The Google Sheets integration allows you to connect your [Google Drive](https://drive.google.com) to Home Assistant. The integration adds a service to allow you to append rows to a Sheets document. The idea is that you can store data on there for further processing. When you set up a config entry, your drive will have a new sheet called Home Assistant. You can then rename this to whatever you like.
**Note**:
The integration currently only has access to that one document that is created during setup.
## 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.
{% details "Generate Client ID and Client Secret" %}
This section explains how to generate a Client ID and Client Secret on
[Google Developers Console](https://console.developers.google.com/start/api?id=drive).
1. First go to the [Google Developers Console](https://console.developers.google.com/start/api?id=drive)
2. The wizard will ask you to choose a project to manage your application. Select a project and click continue.
3. Verify that your drive API was enabled and click 'Go to credentials'
4. Navigate to APIs & Services (left sidebar) > [Credentials](https://console.cloud.google.com/apis/credentials)
5. Click on the field on the left of the screen, **OAuth Consent Screen**.
6. Select **External** and **Create**.
7. Set the *App Name* (the name of the application asking for consent) to anything you want e.g. *Home Assistant*.
8. You then need to select a *Support email*. To do this, simply click the drop down box and select your email address.
9. You finally need to complete the section: *Developer contact information*. To do this, simply enter your email address (same as above is fine).
10. Scroll to the bottom and click **Save and Continue**. Don't have to fill out anything else or it may enable additional review.
11. You will then be automatically taken to the Scopes page. You do not need to add any scopes here so click Save and Continue to move to the Optional info page. You do not need to add anything to the Optional info page so click Save and Continue which will take you to the Summary page. Click Back to Dashboard.
12. Click **OAuth consent screen** again and set *Publish Status* to **Production** otherwise your credentials will expire every 7 days.
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**.
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.
{% enddetails %}
{% include integrations/config_flow.md %}
The integration setup will next give you instructions to enter the [Application Credentials](/integrations/application_credentials/) (OAuth Client ID and Client Secret) and authorize Home Assistant to access your Google Sheets.
{% details "OAuth and Device Authorization steps" %}
1. Continue through the steps of selecting the account you want to authorize.
2. **NOTE**: You may get a message telling you that the app has not been verified and you will need to acknowledge that in order to proceed.
3. You can now see the details of what you are authorizing Home Assistant to access with two options at the bottom. Click **Continue**.
4. The page will now display *Link account to Home Assistant?*, note *Your instance URL*. If this is not correct, please refer to [My Home Assistant](/integrations/my). If everything looks good, click **Link Account**.
5. You may close the window, and return back to Home Assistant where you should see a *Success!* message from Home Assistant.
{% enddetails %}
## Troubleshooting
If you have an error with your credentials you can delete them in the [Application Credentials](/integrations/application_credentials/) user interface.
### Service `google_sheets.append_sheet`
You can use the service `google_sheets.append_sheet` to add a row of data to the Sheets document created at setup.
{% details "Create Event Service details" %}
| Service data attribute | Optional | Description | Example |
| ---------------------- | -------- | ----------- | --------|
| `config_entry` | no | Config entry to use.
| `worksheet` | yes | Name of the worksheet. Defaults to the first one in the document. | Sheet1
| `data` | no | Data to be appended to the worksheet. This puts the data on a new row, one value per column. | ["foo"]
{% enddetails %}

View File

@ -37,14 +37,6 @@ There is currently support for the following device types within Home Assistant:
## Services ## Services
### `guardian.disable_ap`
Disable the device's onboard access point.
### `guardian.enable_ap`
Enable the device's onboard access point.
### `guardian.pair_sensor` ### `guardian.pair_sensor`
Add a new paired sensor to the valve controller. Add a new paired sensor to the valve controller.

View File

@ -7,7 +7,7 @@ ha_quality_scale: internal
ha_codeowners: ha_codeowners:
- '@home-assistant/core' - '@home-assistant/core'
ha_domain: hardware ha_domain: hardware
ha_integration_type: integration ha_integration_type: system
--- ---
The Hardware integration provides an API which offers information about certain board types, USB dongles, and resource usage. The Hardware integration provides an API which offers information about certain board types, USB dongles, and resource usage.

View File

@ -16,7 +16,7 @@ ha_platforms:
- update - update
ha_codeowners: ha_codeowners:
- '@home-assistant/supervisor' - '@home-assistant/supervisor'
ha_integration_type: integration ha_integration_type: system
--- ---
Supervisor integration allows you to monitor and control Supervisor add-ons and operating system from Home Assistant. Supervisor integration allows you to monitor and control Supervisor add-ons and operating system from Home Assistant.

View File

@ -8,7 +8,7 @@ ha_quality_scale: internal
ha_codeowners: ha_codeowners:
- '@home-assistant/core' - '@home-assistant/core'
ha_domain: history ha_domain: history
ha_integration_type: integration ha_integration_type: system
--- ---
The `history` integration will track everything that is going on within Home The `history` integration will track everything that is going on within Home

View File

@ -10,7 +10,7 @@ ha_codeowners:
ha_domain: homeassistant ha_domain: homeassistant
ha_platforms: ha_platforms:
- scene - scene
ha_integration_type: integration ha_integration_type: system
--- ---
The Home Assistant integration provides generic implementations like the generic `homeassistant.turn_on`. The Home Assistant integration provides generic implementations like the generic `homeassistant.turn_on`.

View File

@ -4,11 +4,11 @@ description: Home Assistant Alerts notifies you about alerts put out by the Home
ha_release: 2022.8 ha_release: 2022.8
ha_category: ha_category:
- Other - Other
ha_iot_class: internal
ha_codeowners: ha_codeowners:
- '@home-assistant/core' - '@home-assistant/core'
ha_domain: homeassistant_alerts ha_domain: homeassistant_alerts
ha_integration_type: integration ha_integration_type: integration
ha_quality_scale: internal
--- ---
The Home Assistant Alerts integration integrates the The Home Assistant Alerts integration integrates the

View File

@ -83,6 +83,14 @@ HomeKit controller will poll your devices, but it will also automatically enable
HomeKit Controller will automatically discover Bluetooth devices once the [Bluetooth](/integrations/bluetooth) integration is enabled and functional. Bluetooth devices may take significantly longer to pair than IP devices. Battery-powered devices may require pressing a button on the device to wake it before pairing can be successful. HomeKit Controller will automatically discover Bluetooth devices once the [Bluetooth](/integrations/bluetooth) integration is enabled and functional. Bluetooth devices may take significantly longer to pair than IP devices. Battery-powered devices may require pressing a button on the device to wake it before pairing can be successful.
## Thread device support
In order to use HomeKit over Thread you need a working border router (like a HomePod mini). Your Home Assistant instance will need to be on the same VLAN as the border router.
HomeKit Controller will automatically discover supported Thread devices using the [Zeroconf](/integrations/zeroconf) integration. Battery powered devices may go to sleep and require a button pressing to wake them up before pairing works.
In order to provision a Thread device onto a mesh network using a HomePod as a border router, first pair it with an iOS device. Then unpair it from the Home app. Don't reset it. This will leave the Thread network details on the device. Home Assistant can now pair with it over Thread.
## 'Stateless' switches and sensors ## 'Stateless' switches and sensors
Some HomeKit devices (like buttons, remotes and doorbells) don't have sensors that can be read like a normal HomeKit device - they only inform Home Assistant when something happens. This means Home Assistant can't show an entity for them, as they have no state. But they are available for use as [device automations](/integrations/device_automation/). Some HomeKit devices (like buttons, remotes and doorbells) don't have sensors that can be read like a normal HomeKit device - they only inform Home Assistant when something happens. This means Home Assistant can't show an entity for them, as they have no state. But they are available for use as [device automations](/integrations/device_automation/).

View File

@ -9,7 +9,7 @@ ha_quality_scale: internal
ha_codeowners: ha_codeowners:
- '@home-assistant/core' - '@home-assistant/core'
ha_domain: http ha_domain: http
ha_integration_type: integration ha_integration_type: system
--- ---
The `http` integration serves all files and data required for the Home Assistant frontend. You only need to add this to your configuration file if you want to change any of the default settings. The `http` integration serves all files and data required for the Home Assistant frontend. You only need to add this to your configuration file if you want to change any of the default settings.

View File

@ -9,7 +9,7 @@ ha_quality_scale: internal
ha_codeowners: ha_codeowners:
- '@home-assistant/core' - '@home-assistant/core'
- '@Shulyaka' - '@Shulyaka'
ha_integration_type: integration ha_integration_type: entity
--- ---
The `humidifier` integration is built for the controlling and monitoring of humidifiers, dehumidifiers, and hygrostat devices. The `humidifier` integration is built for the controlling and monitoring of humidifiers, dehumidifiers, and hygrostat devices.

View File

@ -0,0 +1,93 @@
---
title: iBeacon Tracker
description: Instructions on how to integrate iBeacon devices into Home Assistant.
ha_category:
- Device Tracker
- Presence Detection
- Sensor
ha_release: '2022.10'
ha_iot_class: Local Push
ha_domain: ibeacon
ha_platforms:
- device_tracker
- sensor
ha_bluetooth: true
ha_config_flow: true
ha_integration_type: integration
ha_codeowners:
- '@bdraco'
---
{% include integrations/config_flow.md %}
iBeacons are Bluetooth-enabled devices that advertise identifiers to announce their location. For example, an iBeacon attached to a trash can be used to determine if the trash can is in the garage or on the street. Home Assistant can estimate the distance of an iBeacon device in proximity to the nearest Bluetooth adapter.
iBeacon devices will be automatically detected and added as they are discovered once the integration has been added via the UI and the [Bluetooth](/integrations/bluetooth) integration is enabled and functional.
iBeacon Devices are tracked by a combination of the following data:
- UUID (universally unique identifier) is a 128-bit identifier that is generally set the same for all iBeacons at the same physical location.
- Major is an integer to differentiate between iBeacons with the same UUID.
- Minor is an integer to differentiate between iBeacons with the same UUID and Major value.
- MAC address (except for devices with a randomized MAC address)
Consider setting up your iBeacons with a schema similar to the following:
- uuid=UUID major=1000 minor=1000 Downstairs Front Room
- uuid=UUID major=1000 minor=1001 Downstairs Bathroom
- uuid=UUID major=2000 minor=1001 Upstairs Main Bedroom
- uuid=UUID major=2000 minor=1002 Upstairs Guest Bedroom
- uuid=UUID major=3000 minor=1000 Attic
iBeacon devices that do not have stable Major and Minor values are not supported. The system automatically removes iBeacon devices with unstable Major and Minor values once ten (10) or more Major and Minor values have been seen with the same UUID from an iBeacon device with a fixed MAC address.
## Fixed MAC addresses
iBeacons with a fixed MAC address will get their own set of entities for each UUID, major, minor, and MAC address combination, enabling distance and presence detection per physical device basis. In this type of setup, it is permissible to have multiple iBeacons broadcasting the same UUID, Major, and Minor combination as long as you do not exceed five devices.
## Randomized MAC addresses
iBeacons with a randomized MAC address will be combined into a single set of entities once the integration discovers the same UUID, Major, and Minor combination has been seen coming from 10 or more MAC addresses. This allows distance and presence detection based on the last reporting data. When using randomized MAC addresses, only one device must broadcast the unique UUID, Major, and Minor combination.
## Sensors
The integration will create an Estimated Distance sensor by default. This estimated distance assumes perfect RF conditions and line of sight between the iBeacon and the Bluetooth adapter. Estimated distance is generally only helpful to tell if the iBeacon is in the immediate vicinity, near, or far away from the adapter. If the system has multiple adapters, the adapter with the best RSSI value for the iBeacon will be the one reporting the distance. As this can change, checking the source attribute when considering the distance is essential.
## Known working devices
- [Blue Charm Beacons BC011-MultiBeacon](https://bluecharmbeacons.com/product/bluetooth-ble-multi-beacon-bc011/)
- [Blue Charm Beacons BC021-MultiBeacon](https://bluecharmbeacons.com/product/bluetooth-ble-ibeacon-bc021-multibeacon-with-button-trigger-and-motion-sensor/)
- [Blue Charm Beacons BC037G-GeoPattern-iBeacon](https://bluecharmbeacons.com/product/blue-charm-bc037-ibeacon/)
- [Blue Charm Beacons BC037S-SmoothPattern-iBeacon](https://bluecharmbeacons.com/product/bluetooth-ble-ibeacon-bc037s-ibeacon/)
- [Blue Charm Beacons BC08-MultiBeacon](https://bluecharmbeacons.com/product/blue-charm-beacons-bluetooth-ble-ibeacon-bc08-multibeacon-w-motion-sensor-and-button-trigger-ble-5-0/)
- [Feasycom FSC-BP103B](https://www.feasycom.com/bluetooth-ibeacon-da14531)
- [Feasycom FSC-BP104D](https://www.feasycom.com/dialog-da14531-bluetooth-low-energy-beacon)
- [Feasycom FSC-BP108](https://www.feasycom.com/bluetooth-5-1-waterproof-bluetooth-beacon)
- [Pawscout Tag](https://pawscout.com/shop/pawscout-tag/)
## Example automation
```yaml
alias: "The black trash can has left the building"
mode: single
trigger:
- platform: state
entity_id: sensor.black_trash_bin_estimated_distance
to: "unavailable"
for:
hours: 0
minutes: 5
seconds: 0
- platform: numeric_state
entity_id: sensor.black_trash_bin_estimated_distance
for:
hours: 0
minutes: 5
seconds: 0
above: 20
action:
- service: notify.notify
data:
message: "The black trash can has left the building"
title: "The black trash can has left the building"
```

View File

@ -8,7 +8,7 @@ ha_codeowners:
- '@home-assistant/core' - '@home-assistant/core'
ha_domain: image ha_domain: image
ha_quality_scale: internal ha_quality_scale: internal
ha_integration_type: integration ha_integration_type: system
--- ---
The Image integration allows Home Assistant to handle image assets in Home Assistant, for example, The Image integration allows Home Assistant to handle image assets in Home Assistant, for example,

View File

@ -8,7 +8,7 @@ ha_domain: image_processing
ha_quality_scale: internal ha_quality_scale: internal
ha_codeowners: ha_codeowners:
- '@home-assistant/core' - '@home-assistant/core'
ha_integration_type: integration ha_integration_type: entity
--- ---
Image processing enables Home Assistant to process images from [cameras](/integrations/#camera). Only camera entities are supported as sources. Image processing enables Home Assistant to process images from [cameras](/integrations/#camera). Only camera entities are supported as sources.

View File

@ -4,6 +4,7 @@ description: Instructions on the IntelliFire Fireplace integration for Home Assi
ha_category: ha_category:
- Binary Sensor - Binary Sensor
- Climate - Climate
- Fan
- Sensor - Sensor
- Switch - Switch
ha_iot_class: Local Polling ha_iot_class: Local Polling
@ -15,6 +16,7 @@ ha_config_flow: true
ha_platforms: ha_platforms:
- binary_sensor - binary_sensor
- climate - climate
- fan
- sensor - sensor
- switch - switch
ha_dhcp: true ha_dhcp: true
@ -39,6 +41,10 @@ The following controllable entities are available:
- **Flame** - Turn fireplace on/off. - **Flame** - Turn fireplace on/off.
- **Pilot Light** - Turn pilot light on/off. - **Pilot Light** - Turn pilot light on/off.
### Fan
- **Fan** - If your unit is equipped with a fan - this entry will be present. There are 4 fan speeds (1-4), with 0 being off.
### Climate ### Climate
- **Thermostat** - This entity will be present if your unit has thermostatic control. - **Thermostat** - This entity will be present if your unit has thermostatic control.

View File

@ -0,0 +1,24 @@
---
title: Kegtron
description: Instructions on how to integrate Kegtron Smart Keg Monitor (Gen 1) into Home Assistant.
ha_category:
- Sensor
ha_bluetooth: true
ha_release: '2022.10'
ha_iot_class: Local Push
ha_codeowners:
- '@Ernst79'
ha_domain: kegtron
ha_config_flow: true
ha_platforms:
- sensor
ha_integration_type: integration
---
Integrates [Kegtron](https://kegtron.com/) Smart Keg Monitor (Gen 1) devices into Home Assistant.
{% include integrations/config_flow.md %}
The Kegtron integration will automatically discover devices once the [Bluetooth](/integrations/bluetooth) integration is enabled and functional.
The integration only supports Smart Keg Monitor devices of the 1st generation (KT-100 and KT-200), which communicate data with Bluetooth LE.

View File

@ -0,0 +1,61 @@
---
title: Keymitt MicroBot Push
description: Instructions on how to set up the MicroBot Push.
ha_category:
- Switch
ha_release: '2022.10'
ha_iot_class: Assumed State
ha_codeowners:
- '@spycle'
ha_domain: keymitt_ble
ha_bluetooth: true
ha_platforms:
- switch
ha_config_flow: true
ha_integration_type: integration
---
This integration allows you to locally control a MicroBot Push (previously manufactured by Naran but now under the Keymitt brand).
### Prerequisites
In order to use this integration, it is required to have working [Bluetooth](/integrations/blueooth) set up on the device running Home Assistant. A Naran/Keymitt hub is not required.
The device will need to be in pairing mode before adding to Home Assistant. To reset the MicroBot Push, turn it off, then back on, and immediately hold the push button while the LED is red. After approximately 5 seconds, the LED will flash rapidly, at which point release the button. The LED will blink blue if the pairing mode has been successfully activated.
If you have multiple devices, you will need to know the BTLE MAC address of your device to tell them apart.
Please note, that devices cannot remain paired to the MicroBot app for this integration to function. They will be paired to Home Assistant exclusively.
{% include integrations/config_flow.md %}
### Supported Devices
This Integration is for the MicroBot Push only. The Keymitt lock is not supported.
### Service `keymitt_ble.calibrate`
The Calibration service will locally set the MicroBot Push depth, duration, and mode.
Please note: The push arm will extend or retract (dependent on the mode set) after the service call is invoked. The mode and depth will be demonstrated, but not the duration. The setting is, however, stored and can be confirmed by manually operating the device.
| Service Data Attribute | Required | Description |
| ---------------------- | -------- | --------------------------------------------------------------------------------------------- |
| `depth` | yes | How far (in percent) to extend the push arm. |
| `duration` | yes | Duration (in seconds) to hold the arm extended. |
| `mode` | yes |'Normal' - extend and retract the arm. |
| | |'Invert' - retract then extend the arm. |
| | |'Toggle' - toggle between extend and retract. |
### Error codes and troubleshooting
The integration will automatically discover devices once the [Bluetooth](/integrations/bluetooth) integration is enabled and functional.
Due to the device going into deep sleep after prelonged disuse, the response time can be up to a minute in extreme cases. On average it will be much quicker.
{% configuration_basic %}
"Failed to pair":
description: Make sure your devices are powered on, in range, and in pairing mode. Pressing the button on the MicroBot Push to take it out of deep sleep may also be beneficial.
"No unconfigured devices found":
description: Make sure your devices are powered on, in range, and in pairing mode. Pressing the button on the MicroBot Push to take it out of deep sleep may also be beneficial.
{% endconfiguration_basic %}

View File

@ -18,6 +18,7 @@ ha_platforms:
ha_integration_type: integration ha_integration_type: integration
ha_config_flow: true ha_config_flow: true
ha_ssdp: true ha_ssdp: true
ha_dhcp: true
--- ---
[LaMetric TIME](https://lametric.com/) is a smart clock that can be used to access applications, listen to web radio and display notifications. [LaMetric TIME](https://lametric.com/) is a smart clock that can be used to access applications, listen to web radio and display notifications.

View File

@ -0,0 +1,36 @@
---
title: Legrand
description: Connect and control your Legrand devices using the Netatmo integration
ha_category:
- Camera
- Climate
- Cover
- Environment
- Hub
- Light
- Media Source
- Sensor
- Switch
- Weather
ha_domain: legrand
ha_codeowners:
- '@cgtobi'
ha_integration_type: integration
ha_config_flow: true
ha_platforms:
- camera
- climate
- cover
- diagnostics
- light
- select
- sensor
- switch
ha_iot_class: Cloud Polling
ha_homekit: true
ha_supporting_domain: netatmo
ha_supporting_integration: Netatmo
ha_release: '0.20'
---
{% include integrations/supported_brand.md %}

View File

@ -0,0 +1,29 @@
---
title: Lidarr
description: Instructions on how to integrate Lidarr with Home Assistant
ha_category:
- Downloading
ha_release: '2022.10'
ha_iot_class: Local Polling
ha_domain: lidarr
ha_config_flow: true
ha_codeowners:
- '@tkdrob'
ha_platforms:
- sensor
ha_integration_type: integration
---
The Lidarr integration pulls data from a given [Lidarr](https://lidarr.audio/) instance.
{% include integrations/config_flow.md %}
To retrieve your API key, open your Lidarr web interface and navigate to Settings, then General tab. Your Lidarr API Key will be listed on this page under the Security section.
## Sensors
The Lidarr integration will add the following sensors:
- Available disk space for each root folder.
- The number of episodes in the queue.
- The number of albums still wanted.

View File

@ -13,6 +13,7 @@ ha_platforms:
- binary_sensor - binary_sensor
- button - button
- light - light
- select
ha_integration_type: integration ha_integration_type: integration
ha_codeowners: ha_codeowners:
- '@bdraco' - '@bdraco'
@ -40,13 +41,26 @@ Change the light to a new state.
| `entity_id` | String or list of strings that point at `entity_id`s of lights. Use `entity_id: all` to target all. | `entity_id` | String or list of strings that point at `entity_id`s of lights. Use `entity_id: all` to target all.
| `transition` | Duration (in seconds) for the light to fade to the new state. | `transition` | Duration (in seconds) for the light to fade to the new state.
| `zones` | List of integers for the zone numbers to affect (each LIFX Z strip has 8 zones, starting at 0). | `zones` | List of integers for the zone numbers to affect (each LIFX Z strip has 8 zones, starting at 0).
| `infrared` | Automatic infrared level (0..255) when light brightness is low (for compatible bulbs).
| `power` | Turn the light on (`True`) or off (`False`). Leave out to keep the power as it is. | `power` | Turn the light on (`True`) or off (`False`). Leave out to keep the power as it is.
| `...` | Use `color_name`, `brightness` etc. from [`light.turn_on`](/integrations/light/#service-lightturn_on) to specify the new state. | `...` | Use `color_name`, `brightness` etc. from [`light.turn_on`](/integrations/light/#service-lightturn_on) to specify the new state.
## Set HEV cycle state
You can control the HEV LEDs in LIFX Clean bulbs using the `set_hev_cycle_state` service. The service can start or stop a HEV (or "Clean") cycle either using the default duration configured on the bulb or for a custom duration specified when calling the service. Home Assistant will return or log an error if an incompatible bulb is specified when calling the service.
To determine whether or not a HEV cycle is currently running, Home Assistant exposes a Clean Cycle binary sensor for all HEV-enabled bulbs. This sensor can be used to trigger automations to occur when a HEV cycle starts or stops. To reduce network load, HEV cycle status is only checked every 10 seconds so this sensor may not update instantaneously.
### Service `lifx.set_hev_cycle_state`
| Service data attribute | Description |
| ---------------------- | ----------- |
| `entity_id` | String or list of strings that point at `entity_id`s of LIFX Clean bulbs.
| `power` | Start a HEV cycle (`True`) or stop a cycle (`False`).
| `duration` | Duration (in seconds) for the HEV cycle. The default duration of two hours (7200 seconds) is used if this attribute is omitted.
## Light effects ## Light effects
The LIFX platform supports several light effects. You can start these effects with default options by using the `effect` attribute of the normal [`light.turn_on`](/integrations/light/#service-lightturn_on) service, for example like this: The LIFX platform supports several software-controlled light effects and one hardware based effect. You can start these effects with default options by using the `effect` attribute of the normal [`light.turn_on`](/integrations/light/#service-lightturn_on) service, for example like this:
```yaml ```yaml
automation: automation:
@ -78,7 +92,9 @@ script:
         change: 35          change: 35
``` ```
The available light effects and their options are listed below. The `lifx.effect_move` effect is hardware effect that is only available on LIFX multizone devices like the LIFX Z, Lightstrip or Beam. Note that if all the LEDs of the multizone device are set to the same color, the effect will not be visible. The effect can be stopped and started regardless of the power state of the device, but the default is to turn the device on when starting the effect. Set the `power_on` attribute of the `lifx.effect_move` service to `false` to override the default.
All the available light effects and their options are listed below.
### Service `lifx.effect_pulse` ### Service `lifx.effect_pulse`
@ -109,23 +125,40 @@ Run an effect with colors looping around the color wheel. All participating ligh
| `spread` | Maximum color difference between participating lights, in degrees on a color wheel (ranges from 0 to 359). | `spread` | Maximum color difference between participating lights, in degrees on a color wheel (ranges from 0 to 359).
| `power_on` | Set this to False to skip the effect on lights that are turned off (defaults to True). | `power_on` | Set this to False to skip the effect on lights that are turned off (defaults to True).
### Service `lifx.effect_move`
A harware-based effect available on LIFX multizone devices that creates a movement animation of the colors currently set on the device. The direction and speed of the animation are controlled by the `speed` and `direction` attributes. You can change the colors of the effect while it is running using the `lifx.set_state` service.
The effect will not be visible if all LEDs on the device are set to the same color and is ignored by unsupported devices.
| Service data attribute | Description |
| ---------------------- | ----------- |
| `entity_id` | String or list of strings that point at `entity_id`s of multizone lights.
| `speed` | Duration in seconds for the effect to travel the length of the device (min: 0.1s, max: 60s)
| `direction` | The direction in which the effect will travel, either "right" or "left" (default: right)
| `power_on` | Whether to turn the light on before starting the effect (optional, default: true)
### Service `lifx.effect_stop` ### Service `lifx.effect_stop`
Run an effect that does nothing, thereby stopping any other effect that might be running. Run an effect that does nothing, thereby stopping any software or hardware effect that might be running.
| Service data attribute | Description | | Service data attribute | Description |
| ---------------------- | ----------- | | ---------------------- | ----------- |
| `entity_id` | String or list of strings that point at `entity_id`s of lights. Use `entity_id: all` to target all. | `entity_id` | String or list of strings that point at `entity_id`s of lights. Use `entity_id: all` to target all.
## Infrared brightness
Home Assistant will automatically create an Infrared Brightness configuration entity for LIFX Night Vision bulbs. Changing the state of this entity will change the brightness of the LEDs on the bulb.
## Buttons ## Buttons
The LIFX button platform creates two buttons for each LIFX device. The LIFX button platform creates two buttons for each LIFX device.
### Identify Button ### Identify button
The Identify button will flash the bulb three times at maximum brightness then return the bulb to the state it was in prior. Successful identification requires the bulb to be powered on and already configured in Home Assistant. The Identify button will flash the bulb three times at maximum brightness then return the bulb to the state it was in prior. Successful identification requires the bulb to be powered on and already configured in Home Assistant.
### Restart Button ### Restart button
The Restart button triggers the bulb to restart in exactly the same way as a physical power cycle, which makes it ideal for triggering a new DHCP request from the bulb. The Restart button triggers the bulb to restart in exactly the same way as a physical power cycle, which makes it ideal for triggering a new DHCP request from the bulb.

View File

@ -8,7 +8,7 @@ ha_quality_scale: internal
ha_domain: light ha_domain: light
ha_codeowners: ha_codeowners:
- '@home-assistant/core' - '@home-assistant/core'
ha_integration_type: integration ha_integration_type: entity
--- ---
This integration allows you to track and control various light bulbs. Read the integration documentation for your particular light hardware to learn how to enable it. This integration allows you to track and control various light bulbs. Read the integration documentation for your particular light hardware to learn how to enable it.

View File

@ -7,7 +7,7 @@ ha_category:
- Sensor - Sensor
- Switch - Switch
- Vacuum - Vacuum
ha_iot_class: Cloud Polling ha_iot_class: Cloud Push
ha_release: 2021.3 ha_release: 2021.3
ha_config_flow: true ha_config_flow: true
ha_codeowners: ha_codeowners:
@ -16,6 +16,7 @@ ha_codeowners:
ha_domain: litterrobot ha_domain: litterrobot
ha_dhcp: true ha_dhcp: true
ha_platforms: ha_platforms:
- binary_sensor
- button - button
- select - select
- sensor - sensor
@ -40,6 +41,7 @@ You will need a Litter-Robot account as well as a Wi-Fi-enabled Litter-Robot or
| Night Light Mode | `switch` | When turned on, automatically turns on the night light in darker settings. | | Night Light Mode | `switch` | When turned on, automatically turns on the night light in darker settings. |
| Panel Lockout | `switch` | When turned on, disables the buttons on the unit to prevent changes to settings. | | Panel Lockout | `switch` | When turned on, disables the buttons on the unit to prevent changes to settings. |
| Last Seen | `sensor` | Displays the time the unit was last seen / reported an update. | | Last Seen | `sensor` | Displays the time the unit was last seen / reported an update. |
| Litter level | `sensor` | Displays the litter level, only for Litter-Robot 4. |
| Pet weight | `sensor` | Displays the last measured pet weight, only for Litter-Robot 4. | | Pet weight | `sensor` | Displays the last measured pet weight, only for Litter-Robot 4. |
| Sleep Mode Start Time | `sensor` | When sleep mode is enabled, displays the current or next sleep mode start time. | | Sleep Mode Start Time | `sensor` | When sleep mode is enabled, displays the current or next sleep mode start time. |
| Sleep Mode End Time | `sensor` | When sleep mode is enabled, displays the current or last sleep mode end time. | | Sleep Mode End Time | `sensor` | When sleep mode is enabled, displays the current or last sleep mode end time. |

View File

@ -8,7 +8,7 @@ ha_quality_scale: internal
ha_domain: lock ha_domain: lock
ha_codeowners: ha_codeowners:
- '@home-assistant/core' - '@home-assistant/core'
ha_integration_type: integration ha_integration_type: entity
--- ---
Keeps track which locks are in your environment, their state and allows you to control them. Keeps track which locks are in your environment, their state and allows you to control them.

View File

@ -8,7 +8,7 @@ ha_domain: logbook
ha_quality_scale: internal ha_quality_scale: internal
ha_codeowners: ha_codeowners:
- '@home-assistant/core' - '@home-assistant/core'
ha_integration_type: integration ha_integration_type: system
--- ---
<img src='/images/screenshots/logbook.png' style='margin-left:10px; float: right;' height="100" /> <img src='/images/screenshots/logbook.png' style='margin-left:10px; float: right;' height="100" />

View File

@ -8,7 +8,7 @@ ha_quality_scale: internal
ha_codeowners: ha_codeowners:
- '@home-assistant/core' - '@home-assistant/core'
ha_domain: logger ha_domain: logger
ha_integration_type: integration ha_integration_type: system
--- ---
The `logger` integration lets you define the level of logging activities in Home The `logger` integration lets you define the level of logging activities in Home

View File

@ -33,9 +33,19 @@ ha_integration_type: integration
[Lutron](http://www.lutron.com/) is an American lighting control company. They have several lines of home automation devices that manage light switches, dimmers, occupancy sensors, HVAC controls, etc. The `lutron_caseta` integration in Home Assistant is responsible for communicating with the Lutron Caseta Smart Bridge for the [Caseta](https://www.casetawireless.com/) product line of dimmers, switches, shades, and sensors. It will also communicate with the Lutron Radio RA2 Main Repeater for the [RA2 Select](http://www.lutron.com/en-US/Products/Pages/WholeHomeSystems/RA2Select/Overview.aspx) product line of dimmers, switches, shades, and sensors. [Lutron](http://www.lutron.com/) is an American lighting control company. They have several lines of home automation devices that manage light switches, dimmers, occupancy sensors, HVAC controls, etc. The `lutron_caseta` integration in Home Assistant is responsible for communicating with the Lutron Caseta Smart Bridge for the [Caseta](https://www.casetawireless.com/) product line of dimmers, switches, shades, and sensors. It will also communicate with the Lutron Radio RA2 Main Repeater for the [RA2 Select](http://www.lutron.com/en-US/Products/Pages/WholeHomeSystems/RA2Select/Overview.aspx) product line of dimmers, switches, shades, and sensors.
This integration only supports the [Caseta](https://www.casetawireless.com/) line of products. The Smart Bridge (L-BDG2-WH), Smart Bridge PRO (L-BDGPRO2-WH), and RA2 Select (RR-SEL-REP2-BL) models are supported. For the RadioRA 2 and HomeWorks QS product lines, see the [Lutron component](/integrations/lutron/). This integration supports the [Caséta](https://www.casetawireless.com/), [RA2 Select](https://www.lutron.com/en-US/Products/Pages/WholeHomeSystems/RA2Select/Overview.aspx), [RadioRA 3](https://radiora3.lutron.com/), and [Homeworks QSX](https://www.lutron.com/en-US/Products/Pages/WholeHomeSystems/Homeworks/Overview.aspx) **(not QS)** lines of products.
The currently supported Caseta and RA2 Select devices are: Supports Bridges:
- Lutron Caséta Smart Hub (L-BDG2-WH)
- Lutron Caséta Smart Bridge PRO (L-BDGPRO2-WH)
- RA2 Select Main Repeaters (RR-SEL-REP2-BL)
- QSX Processor (HQP7)
- RadioRA 3 All-in-One Processor (RR-PROC3)
For the RadioRA 2 and HomeWorks QS product lines, see the [Lutron component](/integrations/lutron/).
The currently supported devices are:
- Wall and plug-in dimmers as [lights](#light) - Wall and plug-in dimmers as [lights](#light)
- Wall switches as [switches](#switch) - Wall switches as [switches](#switch)
@ -128,6 +138,8 @@ After setup, scenes will appear in Home Assistant using an `entity_id` based on
For more information on working with scenes in Home Assistant, see the [Scenes component](/integrations/scene/). For more information on working with scenes in Home Assistant, see the [Scenes component](/integrations/scene/).
Scenes are not currently supported on RA3 and QSX models.
Available services: `scene.turn_on`. Available services: `scene.turn_on`.
## Switch ## Switch

View File

@ -5,7 +5,7 @@ ha_release: 0.51
ha_domain: mailbox ha_domain: mailbox
ha_quality_scale: internal ha_quality_scale: internal
ha_category: [] ha_category: []
ha_integration_type: integration ha_integration_type: entity
--- ---
Mailboxes provide a list of messages with short information about each. Mailbox messages appear on a separate panel in the frontend. Mailboxes provide a list of messages with short information about each. Mailbox messages appear on a separate panel in the frontend.

View File

@ -8,7 +8,7 @@ ha_quality_scale: internal
ha_domain: media_player ha_domain: media_player
ha_codeowners: ha_codeowners:
- '@home-assistant/core' - '@home-assistant/core'
ha_integration_type: integration ha_integration_type: entity
--- ---
Interacts with media players on your network. Interacts with media players on your network.

View File

@ -8,7 +8,7 @@ ha_domain: media_source
ha_codeowners: ha_codeowners:
- '@hunterjm' - '@hunterjm'
ha_quality_scale: internal ha_quality_scale: internal
ha_integration_type: integration ha_integration_type: system
--- ---
The Media Source integration platform allows integrations to expose media for The Media Source integration platform allows integrations to expose media for

View File

@ -2,6 +2,7 @@
title: Melnor Bluetooth title: Melnor Bluetooth
description: Instructions on setting up Melnor Bluetooth devices within Home Assistant. description: Instructions on setting up Melnor Bluetooth devices within Home Assistant.
ha_category: ha_category:
- Sensor
- Switch - Switch
ha_iot_class: Local Polling ha_iot_class: Local Polling
ha_bluetooth: true ha_bluetooth: true
@ -11,6 +12,8 @@ ha_codeowners:
- '@vanstinator' - '@vanstinator'
ha_domain: melnor ha_domain: melnor
ha_platforms: ha_platforms:
- number
- sensor
- switch - switch
ha_integration_type: integration ha_integration_type: integration
--- ---

View File

@ -17,7 +17,7 @@ ha_platforms:
ha_integration_type: helper ha_integration_type: helper
--- ---
The Min/Max integration consumes the state from other sensors to determine the minimum, maximum, latest (last), mean and median of the collected states. The Min/Max integration consumes the state from other sensors to determine the minimum, maximum, latest (last), mean, median, and range of the collected states.
The sensor provided by this integration will always show you the lowest/highest/latest value which was received from all monitored sensors. If you have spikes in your values, it's recommended to filter/equalize your values with a [statistics sensor](/integrations/statistics) first. The sensor provided by this integration will always show you the lowest/highest/latest value which was received from all monitored sensors. If you have spikes in your values, it's recommended to filter/equalize your values with a [statistics sensor](/integrations/statistics) first.
@ -30,7 +30,7 @@ Name:
Input entities: Input entities:
description: At least two entities to monitor. All entities must use the same unit of measurement. description: At least two entities to monitor. All entities must use the same unit of measurement.
Type: Type:
description: The type of the sensor, this can be either "min", "max", "last", "mean", or "median". description: The type of the sensor, this can be either "min", "max", "last", "mean", "median", or "range".
Precision: Precision:
description: Round the calculated mean or median value to at most N decimal places. description: Round the calculated mean or median value to at most N decimal places.
{% endconfiguration_basic %} {% endconfiguration_basic %}
@ -57,7 +57,7 @@ entity_ids:
required: true required: true
type: [list, string] type: [list, string]
type: type:
description: "The type of sensor: `min`, `max`, `last`, `mean` or `median`." description: "The type of sensor: `min`, `max`, `last`, `mean`, `median`, or `range`."
required: false required: false
default: max default: max
type: string type: string

View File

@ -8,7 +8,7 @@ ha_domain: my
ha_quality_scale: internal ha_quality_scale: internal
ha_codeowners: ha_codeowners:
- '@home-assistant/core' - '@home-assistant/core'
ha_integration_type: integration ha_integration_type: system
--- ---
This integration handles redirects from the [My Home Assistant](https://my.home-assistant.io) service. This integration handles redirects from the [My Home Assistant](https://my.home-assistant.io) service.

View File

@ -1,5 +1,5 @@
--- ---
title: Nest title: Google Nest
description: Instructions on how to integrate Nest into Home Assistant. description: Instructions on how to integrate Nest into Home Assistant.
ha_category: ha_category:
- Binary Sensor - Binary Sensor

View File

@ -4,11 +4,13 @@ description: Instructions on how to integrate Netatmo integration into Home Assi
ha_category: ha_category:
- Camera - Camera
- Climate - Climate
- Cover
- Environment - Environment
- Hub - Hub
- Light - Light
- Media Source - Media Source
- Sensor - Sensor
- Switch
- Weather - Weather
ha_release: '0.20' ha_release: '0.20'
ha_iot_class: Cloud Polling ha_iot_class: Cloud Polling
@ -20,10 +22,12 @@ ha_homekit: true
ha_platforms: ha_platforms:
- camera - camera
- climate - climate
- cover
- diagnostics - diagnostics
- light - light
- select - select
- sensor - sensor
- switch
ha_integration_type: integration ha_integration_type: integration
--- ---
@ -33,8 +37,10 @@ There is currently support for the following device types within Home Assistant:
- [Camera](#camera) - [Camera](#camera)
- [Climate](#climate) - [Climate](#climate)
- [Cover](#cover)
- [Light](#light) - [Light](#light)
- [Sensor](#sensor) - [Sensor](#sensor)
- [Switch](#switch)
- [Webhook Events](#webhook-events) - [Webhook Events](#webhook-events)
{% include integrations/config_flow.md %} {% include integrations/config_flow.md %}
@ -49,21 +55,30 @@ To edit an existing area, enter its name and follow the dialog.
## Camera ## Camera
The `netatmo` camera platform is consuming the information provided by a [Netatmo Smart Indoor](https://www.netatmo.com/en-gb/security/cam-indoor) or [Outdoor](https://www.netatmo.com/en-gb/security/cam-outdoor) camera. This integration allows you to view the current live stream created by the camera. The `netatmo` camera platform is consuming the information provided by a [Netatmo Smart Indoor](https://www.netatmo.com/en-gb/security/cam-indoor), [Outdoor](https://www.netatmo.com/en-gb/security/cam-outdoor) and [Netatmo Smart Video Doorbell](https://www.netatmo.com/en-gb/security/doorbell) camera. This integration allows you to view the current live stream created by the camera (exception: video doorbell).
## Climate ## Climate
The `netatmo` thermostat platform is consuming the information provided by a [Netatmo Smart Thermostat](https://www.netatmo.com/product/energy/thermostat) or [Netatmo Smart Radiator Valve](https://www.netatmo.com/en-gb/energy/additional-valve). This integration allows you to view the current temperature and control the setpoint. The `netatmo` thermostat platform is consuming the information provided by a [Netatmo Smart Thermostat](https://www.netatmo.com/product/energy/thermostat), [Smart Modulating Thermostat](https://www.netatmo.com/en-gb/energy/modulating-thermostat) and [Netatmo Smart Radiator Valve](https://www.netatmo.com/en-gb/energy/additional-valve). This integration allows you to view the current temperature and control the setpoint.
## Cover
The `netatmo` cover platform provides support for Bubendorff shutters.
## Light ## Light
The `netatmo` light platform is consuming information provided by a [Netatmo Smart Outdoor](https://www.netatmo.com/en-gb/security/cam-outdoor) camera and requires an active webhook. This integration allows you to turn on/off the flood lights. The `netatmo` light platform is consuming information provided by a [Netatmo Smart Outdoor](https://www.netatmo.com/en-gb/security/cam-outdoor) camera and requires an active webhook. This integration allows you to turn on/off the flood lights.
It further provides support for Legrand/BTicino dimmers.
## Sensor ## Sensor
The `netatmo` sensor platform is consuming the information provided by a [Netatmo Smart Home Weather Station](https://www.netatmo.com/en-us/weather/weatherstation) a The `netatmo` sensor platform is consuming the information provided by a [Netatmo Smart Home Weather Station](https://www.netatmo.com/en-us/weather/weatherstation) a
[Netatmo Smart Indoor Air Quality Monitor](https://www.netatmo.com/en-us/aircare/homecoach) device or [Netatmo Public Weather Stations](https://weathermap.netatmo.com/). [Netatmo Smart Indoor Air Quality Monitor](https://www.netatmo.com/en-us/aircare/homecoach) device or [Netatmo Public Weather Stations](https://weathermap.netatmo.com/).
## Switch
The `netatmo` switch platform provides support for Legrand/BTicino switches and power plugs.
## Services ## Services
### Set Outdoor Camera Light Mode ### Set Outdoor Camera Light Mode

View File

@ -35,7 +35,13 @@ Consider_home:
{% endconfiguration_basic %} {% endconfiguration_basic %}
## Router entities ## Router entities
The NETGEAR router will have the following entities: The NETGEAR router will have the following entities.
Note that not all routers support all features, if a router does not support a feature, the corresponding entity will have the unavailable status even when the entity is disabled.
You might also see the following error in the log `404 service '...', method '...' not found`, to prevent these errors, keep the unsupported entities disabled.
All possibly unsupported entities are disabled by default.
### Reboot button ### Reboot button
@ -49,7 +55,19 @@ Update entity to view current and latest firmware version, and install the lates
The total and average amount of downloaded/uploaded data through the router can be tracked per day/week/month. The total and average amount of downloaded/uploaded data through the router can be tracked per day/week/month.
In order for these entities to display the data (instead of 0), the "Traffic Meter" should be enabled in the router settings. In order for these entities to display the data (instead of 0), the "Traffic Meter" should be enabled in the router settings.
Log into your router > Select **ADVANCED** > **Advanced Setup** > **Traffic Meter** > **Enable Traffic Meter** check box. Enable the `Traffic Meter` switch entity and turn it on.
### Router feature switches
The following router features can be turned on/off, and the status can be read:
- Access Control
- Traffic Meter
- Parental Control
- Quality of Service
- 2.4G Guest Wifi
- 5G Guest Wifi
- Smart Connect
### Speed test data ### Speed test data
@ -77,7 +95,7 @@ Displays if the device is currently connected to the router (Home) or not (Away)
Switch that lets you Allow or Block a device on the Network. Switch that lets you Allow or Block a device on the Network.
For this entity to actually Block the device, "Access Control" needs to be turned on in the Router settings. For this entity to actually Block the device, "Access Control" needs to be turned on in the Router settings.
Log into your router > Select **ADVANCED** > **Security** > **Access Control** > **Turn on Access Control** check box. Enable the `Access Control` switch entity and turn it on.
### Signal strength ### Signal strength

View File

@ -9,7 +9,7 @@ ha_iot_class: Local Push
ha_quality_scale: internal ha_quality_scale: internal
ha_codeowners: ha_codeowners:
- '@home-assistant/core' - '@home-assistant/core'
ha_integration_type: integration ha_integration_type: system
--- ---
This integration provides network configuration for integrations such as [Zeroconf](/integrations/zeroconf/). It is managed by going to **{% my network title="Settings >> System >> Network" %}** and is only available to users that have "Advanced Mode" enabled on their {% my profile title="user profile" %}. This integration provides network configuration for integrations such as [Zeroconf](/integrations/zeroconf/). It is managed by going to **{% my network title="Settings >> System >> Network" %}** and is only available to users that have "Advanced Mode" enabled on their {% my profile title="user profile" %}.

View File

@ -0,0 +1,77 @@
---
title: Nibe Heat Pump
description: Instructions on how to integrate a Nibe Heat Pump into Home Assistant.
ha_category:
- Climate
ha_release: '2022.10'
ha_iot_class: Local Polling
ha_config_flow: true
ha_codeowners:
- '@elupus'
ha_domain: nibe_heatpump
ha_platforms:
- binary_sensor
- number
- select
- sensor
- switch
ha_integration_type: integration
---
The Nibe Heat Pump integration allows you to control and monitor [Nibe Heat Pumps](https://www.nibe.eu/en-eu/products/heat-pumps) in Home Assistant.
Supported devices:
- F1145
- F1155
- F1245
- F1255
- F1345
- F1355
- F370
- F470
- F730
- F750
- SMO20
- SMO40
- VVM225
- VVM310
- VVM320
- VVM325
- VVM500
{% include integrations/config_flow.md %}
## Connection Methods
To communicate with the pump there are a few different connection methods available depending on hardware. At the moment the following methods are supported.
- [UDP Gateway using NibeGw](#udp-gateway-using-nibegw)
### UDP Gateway using NibeGw
The heat pump exposes an RS485 interface for communication with extensions. This can be used to speak to the pump by emulating the Nibe MODBUS40 accessory.
Since the pump will go into an error state if the accessory is not responding, dedicated hardware running a gateway software is the preferable choice.
This can be built using a Raspberry Pi with an RS485 hat, an Arduino with RS485 support or an ESP32 with RS485 converters.
#### ESPHome
A ESPHome base hardware solution also works well and integrate nicely into Home Assistant.
- [Homepage](https://github.com/elupus/esphome-nibe)
#### Arduino
An Arduino-based solution has been tested by OpenHAB community with Arduino uno + RS485 and Ethernet shields. The ProDiNo NetBoards are also supported. A ProDiNo has an Ethernet and RS-485 port on the board.
- [Documentation from OpenHAB](https://www.openhab.org/addons/bindings/nibeheatpump/#arduino)
- [Source code in OpenHAB Contrib](https://github.com/openhab/openhab-addons/tree/main/bundles/org.openhab.binding.nibeheatpump/contrib/NibeGW/Arduino/NibeGW)
#### Raspberry Pi / Linux
A standard Linux application for running the Nibe Gateway software is also available.
- [Documentation from OpenHAB](https://www.openhab.org/addons/bindings/nibeheatpump/#raspberry-pi-or-other-linux-unix-based-boards)
- [Source code in OpenHAB Contrib](https://github.com/openhab/openhab-addons/tree/main/bundles/org.openhab.binding.nibeheatpump/contrib/NibeGW/RasPi)

View File

@ -0,0 +1,53 @@
---
title: Nobø Ecohub
description: Instructions on how to integrate Nobø Ecohub into Home Assistant.
ha_category:
- Climate
ha_release: '2022.10'
ha_iot_class: Local Push
ha_config_flow: true
ha_codeowners:
- '@echoromeo'
- '@oyvindwe'
ha_domain: nobo_hub
ha_platforms:
- climate
ha_integration_type: integration
---
Integrates [Nobø Ecohub](https://www.glendimplex.no/produkter/varmestyring/11123610/noboe-hub/c-77/p-330)
into Home Assistant. This integration is not officially supported or endorsed by Glen Dimplex Nordic AS,
and the authors/maintainers are not official partners of Glen Dimplex Nordic AS.
To configure the integration, you need the 3 last digits of the serial number of your hub. These are located
on the back of the hub. If the hub is on a different local network than Home Assistant, you also need the
IP address of the hub.
{% include integrations/config_flow.md %}
## Operation modes
As for now you can see and change operation and preset for zones and set eco/comfort temperatures if you have
a supported thermostat.
The possible operation modes are as follows:
- "Auto" - In this mode, the zone is in the normal setting and preset shows which state the zone is in right now
(according to calendar setup).
- "Heat" - In this mode the zone in the override setting and in the state selected by preset ("Away", "Eco"
or "Comfort").
This can be utilized the following ways:
- Changing preset to "Away", "Eco", or "Comfort" will automatically change operation to "Heat".
- Changing preset to none will automatically change operation to "Auto" and update preset.
- Changing operation to "Auto" will automatically update preset.
- Changing operation to "Heat" will set preset to "Comfort".
### No preset "Off"
Nobø heaters does not support preset "Off". This is not a limitation in the integration, but a safety mechanism in the
Nobø system (maybe they don't want you to accidentally turn off all your heaters and get frozen pipes). "Away"
temperature is fixed to 7°C and cannot be altered. On/off receivers will be off when the zone is in "Away" status.
For more information, see the [Nobø Ecohub manual](https://help.nobo.no/en/user-manual/before-you-start/what-is-a-weekly-program/).

View File

@ -8,7 +8,7 @@ ha_quality_scale: internal
ha_codeowners: ha_codeowners:
- '@home-assistant/core' - '@home-assistant/core'
ha_domain: notify ha_domain: notify
ha_integration_type: integration ha_integration_type: entity
--- ---
The `notify` integration makes it possible to send notifications to a wide variety of platforms. To use it you have to setup at least one notification target (notifier), check the [integrations list](/integrations/#notifications) for one that fits your use case. The `notify` integration makes it possible to send notifications to a wide variety of platforms. To use it you have to setup at least one notification target (notifier), check the [integrations list](/integrations/#notifications) for one that fits your use case.

View File

@ -9,7 +9,7 @@ ha_domain: number
ha_codeowners: ha_codeowners:
- '@home-assistant/core' - '@home-assistant/core'
- '@Shulyaka' - '@Shulyaka'
ha_integration_type: integration ha_integration_type: entity
--- ---
Keeps track on `number` entities in your environment, their state, and allows you to control them. This integration allows other integrations to get a value input from user within a range. Keeps track on `number` entities in your environment, their state, and allows you to control them. This integration allows other integrations to get a value input from user within a range.

View File

@ -1,6 +1,6 @@
--- ---
title: Nutrichef title: Nutrichef
description: Instructions on how to integrate Nutrichef devices into Home Assistant. description: Connect and control your Nutrichef devices using the INKBIRD integration
ha_category: ha_category:
- Sensor - Sensor
ha_bluetooth: true ha_bluetooth: true

View File

@ -8,7 +8,7 @@ ha_quality_scale: internal
ha_codeowners: ha_codeowners:
- '@home-assistant/core' - '@home-assistant/core'
ha_domain: onboarding ha_domain: onboarding
ha_integration_type: integration ha_integration_type: system
--- ---
This integration creates the endpoints for the onboarding that is built into Home Assistant. There are no configuration options for this integration directly. This integration creates the endpoints for the onboarding that is built into Home Assistant. There are no configuration options for this integration directly.

View File

@ -7,7 +7,7 @@ ha_release: 0.88
ha_quality_scale: internal ha_quality_scale: internal
ha_domain: person ha_domain: person
ha_iot_class: Calculated ha_iot_class: Calculated
ha_integration_type: integration ha_integration_type: system
--- ---
The `person` integration allows connecting [device tracker](/integrations/device_tracker/) entities to one or more person entities. The state updates of a connected device tracker will set the state of the person. When multiple device trackers are used, the state of person will be determined in this order: The `person` integration allows connecting [device tracker](/integrations/device_tracker/) entities to one or more person entities. The state updates of a connected device tracker will set the state of the person. When multiple device trackers are used, the state of person will be determined in this order:

View File

@ -176,14 +176,14 @@ script:
The current implementation of the Python module (Plugwise-Smile) includes: The current implementation of the Python module (Plugwise-Smile) includes:
Adam (zone_control): Adam (zone_control) with On/Off, OpenTherm, and Loria/Thermastage heating and cooling support:
- v3.x - v3.x
- v2.3 - v2.3
- Devices supported are Anna, Lisa, Jip, Floor, Tom, Koen and Plug - note a Koen always comes with a Plug (the active part) - Devices supported are Anna, Lisa, Jip, Floor, Tom, Plug, Aqara Smart Plug, and Koen (a Koen always comes with a Plug, the active part)
Anna (thermostat): Anna (thermostat) with OpenTherm heating, and Elga and Loria/Thermastage with heating and cooling support:
- v4.x - v4.x
- v3.x - v3.x

View File

@ -11,6 +11,7 @@ ha_codeowners:
ha_domain: prusalink ha_domain: prusalink
ha_integration_type: integration ha_integration_type: integration
ha_platforms: ha_platforms:
- button
- camera - camera
- sensor - sensor
ha_dhcp: true ha_dhcp: true

View File

@ -9,6 +9,7 @@ ha_release: 2022.9
ha_iot_class: Local Push ha_iot_class: Local Push
ha_codeowners: ha_codeowners:
- '@bdraco' - '@bdraco'
- '@skgsergio'
ha_domain: qingping ha_domain: qingping
ha_config_flow: true ha_config_flow: true
ha_platforms: ha_platforms:

View File

@ -4,157 +4,30 @@ description: Instructions on how to integrate Radarr sensors with Home Assistant
ha_category: ha_category:
- Downloading - Downloading
ha_release: 0.47 ha_release: 0.47
ha_config_flow: true
ha_iot_class: Local Polling ha_iot_class: Local Polling
ha_domain: radarr ha_domain: radarr
ha_platforms: ha_platforms:
- binary_sensor
- sensor - sensor
ha_codeowners:
- '@tkdrob'
ha_integration_type: integration ha_integration_type: integration
--- ---
This `radarr` sensor platform pulls data from a given [Radarr](https://radarr.video/) instance. This Radarr integration pulls data from a given [Radarr](https://radarr.video/) instance.
Your API key can be found in Settings > General in the Radarr Web UI.
## Configuration {% include integrations/config_flow.md %}
To use your Radarr sensor in your installation, add the following to your `configuration.yaml` file: ## Integration Entities
```yaml Each added configuration entry will create the following binary sensor:
# Example configuration.yaml entry
sensor:
- platform: radarr
api_key: YOUR_API_KEY
```
{% configuration %} - **Health**: Shows if the Radarr instance is healthy. This is determined to have a problem if Radarr cannot communicate with any enabled download clients or no indexers are available for RSS feeds or searches.
api_key:
required: true
type: string
description: Your Radarr API key, found in Settings > General in the Radarr Web UI.
host:
required: false
type: string
description: The host Radarr is running on.
default: "`localhost`"
port:
required: false
type: integer
description: The port Radarr is running on.
default: 7878
urlbase:
required: false
type: string
description: The base URL Radarr is running under. Defaults to `/`.
monitored_conditions:
required: false
type: list
description: Conditions to display on the frontend.
default: "`movies`"
keys:
movies:
description: The number of movies in Radarr.
upcoming:
description: The number of upcoming movie releases (physical and in cinemas).
commands:
description: The number of commands being run.
diskspace:
description: The available disk space.
status:
description: The current system status information.
days:
required: false
type: integer
description: How many days to look ahead for the upcoming sensor, 1 means today only.
default: 1
include_paths:
required: false
type: list
description: Array of file paths to include when calculating diskspace. Leave blank to include all.
unit:
required: false
type: string
description: The unit to display disk space in.
default: GB
ssl:
required: false
type: boolean
description: Whether or not to use SSL for Radarr.
default: false
{% endconfiguration %}
## Examples Each added configuration entry will create the following sensors:
In this section you find some real-life examples of how to use this sensor. - **Disk Space**: Shows the disk space available to Radarr.
- **Movies**: Shows the number of movies in the Radarr database. (disabled by default)
### Show upcoming movie releases in the next 2 days - **Start Time**: The time when Radarr was last restarted.
```yaml
# Example configuration.yaml entry
sensor:
- platform: radarr
api_key: YOUR_API_KEY
host: 192.168.1.8
monitored_conditions:
- upcoming
days: 2
```
### Enable SSL
SSL may run on a different port than the default (7878). The SSL port can be bound to any port in Radarr, so it should be set in the configuration here (unless it is changed to 7878).
```yaml
# Example configuration.yaml entry
sensor:
- platform: radarr
api_key: YOUR_API_KEY
host: 192.168.1.8
port: 9898
monitored_conditions:
- upcoming
days: 2
ssl: true
```
### Get disk space for all storage locations
```yaml
# Example configuration.yaml entry
sensor:
- platform: radarr
api_key: YOUR_API_KEY
host: 192.168.1.8
monitored_conditions:
- diskspace
```
### Get disk space for listed storage locations
The storage locations Radarr returns are in the system page and in some cases this can list duplicates if sub paths are mounted separately. By listing paths to include, you can choose what data is reported by the sensor.
```yaml
# Example configuration.yaml entry
sensor:
- platform: radarr
api_key: YOUR_API_KEY
host: 192.168.1.8
monitored_conditions:
- diskspace
include_paths:
- /tank/plex
```
### Get disk space in different unit
The Radarr API returns available space in bytes, but this sensor will default to reporting it in GB to make the number more manageable. This can be overridden if your storage needs require a different unit. All units from bytes (B) to yottabytes (YB) are supported.
*This calculation is done using base 2 math, and may differ from systems calculating using base 10 math.*
```yaml
# Example configuration.yaml entry
sensor:
- platform: radarr
api_key: YOUR_API_KEY
host: 192.168.1.8
monitored_conditions:
- diskspace
unit: TB
```

View File

@ -17,6 +17,7 @@ ha_platforms:
- binary_sensor - binary_sensor
- button - button
- diagnostics - diagnostics
- select
- sensor - sensor
- switch - switch
- update - update

View File

@ -9,7 +9,7 @@ ha_domain: recorder
ha_iot_class: Local Push ha_iot_class: Local Push
ha_codeowners: ha_codeowners:
- '@home-assistant/core' - '@home-assistant/core'
ha_integration_type: integration ha_integration_type: system
--- ---
The `recorder` integration is responsible for storing details in a database, which then are handled by the [`history`](/integrations/history/) integration. The `recorder` integration is responsible for storing details in a database, which then are handled by the [`history`](/integrations/history/) integration.

View File

@ -8,7 +8,7 @@ ha_category:
ha_quality_scale: internal ha_quality_scale: internal
ha_codeowners: ha_codeowners:
- '@home-assistant/core' - '@home-assistant/core'
ha_integration_type: integration ha_integration_type: entity
--- ---
Keeps track which remotes are in your environment, their state and allows you to control them. Keeps track which remotes are in your environment, their state and allows you to control them.

View File

@ -7,7 +7,8 @@ ha_category:
ha_codeowners: ha_codeowners:
- '@home-assistant/core' - '@home-assistant/core'
ha_domain: repairs ha_domain: repairs
ha_integration_type: integration ha_integration_type: system
ha_quality_scale: internal
--- ---
The Home Assistant Repairs integration will inform you about issues it has found The Home Assistant Repairs integration will inform you about issues it has found

View File

@ -1,6 +1,6 @@
--- ---
title: "RESTful" title: RESTful
description: "Instructions on how to integrate REST sensors and binary sensors into Home Assistant." description: Instructions on how to integrate REST sensors and binary sensors into Home Assistant.
ha_category: ha_category:
- Binary Sensor - Binary Sensor
- Sensor - Sensor

View File

@ -42,7 +42,7 @@ If you have multiple sites, only the first site will be used.
The integration will connect locally to your system. The integration will connect locally to your system.
No dependency on the cloud, and instantaneous updates, but is harder to set up. No dependency on the cloud, and instantaneous updates, but is harder to set up.
You will need the master code to your system, and with older models, You will need the panel access code (default 5678) to your system, this access code is NOT the same as the installer/subinstaller code, and with older models,
you might need to either disconnect your system from the cloud, or set up a proxy that will allow you to connect both locally and via the cloud. you might need to either disconnect your system from the cloud, or set up a proxy that will allow you to connect both locally and via the cloud.
The local version of the integration does not support events, and the `arming` state. The local version of the integration does not support events, and the `arming` state.

View File

@ -7,7 +7,7 @@ ha_codeowners:
- '@home-assistant/core' - '@home-assistant/core'
ha_domain: safe_mode ha_domain: safe_mode
ha_quality_scale: internal ha_quality_scale: internal
ha_integration_type: integration ha_integration_type: system
--- ---
The `safe_mode` integration is an internally used integration by the The `safe_mode` integration is an internally used integration by the

Some files were not shown because too many files have changed in this diff Show More