diff --git a/.textlintrc.json b/.textlintrc.json index 1ab82cc45c2..8f6cb6299a0 100644 --- a/.textlintrc.json +++ b/.textlintrc.json @@ -303,6 +303,8 @@ ["colour", "color"], ["config\\b", "configuration"], ["DarkSky", "Dark Sky"], + ["docs\\b", "documentation"], + ["e\\.g\\.", "e.g.,"], ["end ?to ?end", "end-to-end"], ["FRITZ!? ?Box", "FRITZ!Box"], ["grey", "gray"], @@ -313,6 +315,7 @@ ["he or she", "they"], ["he/she", "they"], ["Home-?Ass?s?iss?tt?ant", "Home Assistant"], + ["i\\.e\\.", "i.e.,"], ["IFF?TTT?T?", "IFTTT"], ["ISY ?994", "ISY994"], ["JSONRPC", "JSON-RPC"], diff --git a/CODEOWNERS b/CODEOWNERS index bc253e3d876..222666b945c 100644 --- a/CODEOWNERS +++ b/CODEOWNERS @@ -31,6 +31,7 @@ source/_integrations/arest.markdown @fabaff source/_integrations/asuswrt.markdown @kennedyshead source/_integrations/aten_pe.markdown @mtdcr source/_integrations/atome.markdown @baqs +source/_integrations/august.markdown @bdraco source/_integrations/aurora_abb_powerone.markdown @davet2001 source/_integrations/auth.markdown @home-assistant/core source/_integrations/automatic.markdown @armills @@ -79,6 +80,7 @@ source/_integrations/discogs.markdown @thibmaek source/_integrations/doorbird.markdown @oblogic7 source/_integrations/dsmr_reader.markdown @depl0y source/_integrations/dweet.markdown @fabaff +source/_integrations/dynalite.markdown @ziv1234 source/_integrations/dyson.markdown @etheralm source/_integrations/ecobee.markdown @marthoc source/_integrations/ecovacs.markdown @OverloadUT @@ -113,6 +115,7 @@ source/_integrations/freebox.markdown @snoof85 source/_integrations/fronius.markdown @nielstron source/_integrations/frontend.markdown @home-assistant/frontend source/_integrations/garmin_connect.markdown @cyberjunky +source/_integrations/gdacs.markdown @exxamalte source/_integrations/gearbest.markdown @HerrHofrat source/_integrations/geniushub.markdown @zxdavb source/_integrations/geo_rss_events.markdown @exxamalte @@ -139,7 +142,6 @@ source/_integrations/hikvision.markdown @mezz64 source/_integrations/hikvisioncam.markdown @fbradyirl source/_integrations/hisense_aehw4a1.markdown @bannhead source/_integrations/history.markdown @home-assistant/core -source/_integrations/history_graph.markdown @andrey-git source/_integrations/hive.markdown @Rendili @KJonline source/_integrations/homeassistant.markdown @home-assistant/core source/_integrations/homekit_controller.markdown @Jc2k @@ -178,7 +180,7 @@ source/_integrations/kef.markdown @basnijholt source/_integrations/keyboard_remote.markdown @bendavid source/_integrations/knx.markdown @Julius2342 source/_integrations/kodi.markdown @armills -source/_integrations/konnected.markdown @heythisisnate +source/_integrations/konnected.markdown @heythisisnate @kit-klein source/_integrations/lametric.markdown @robbiet480 source/_integrations/launch_library.markdown @ludeeus source/_integrations/lcn.markdown @alengwenus @@ -196,14 +198,16 @@ source/_integrations/mastodon.markdown @fabaff source/_integrations/matrix.markdown @tinloaf source/_integrations/mcp23017.markdown @jardiamj source/_integrations/mediaroom.markdown @dgomes +source/_integrations/melcloud.markdown @vilppuvuorinen source/_integrations/melissa.markdown @kennedyshead source/_integrations/met.markdown @danielhiversen -source/_integrations/meteo_france.markdown @victorcerutti @oncleben31 +source/_integrations/meteo_france.markdown @victorcerutti @oncleben31 @Quentame source/_integrations/meteoalarm.markdown @rolfberkenbosch source/_integrations/miflora.markdown @danielhiversen @ChristianKuehnel source/_integrations/mikrotik.markdown @engrbm87 source/_integrations/mill.markdown @danielhiversen source/_integrations/min_max.markdown @fabaff +source/_integrations/minecraft_server.markdown @elmurato source/_integrations/minio.markdown @tkislan source/_integrations/mobile_app.markdown @robbiet480 source/_integrations/modbus.markdown @adamchengtkc @@ -241,6 +245,7 @@ source/_integrations/onewire.markdown @garbled1 source/_integrations/opentherm_gw.markdown @mvn23 source/_integrations/openuv.markdown @bachya source/_integrations/openweathermap.markdown @fabaff +source/_integrations/opnsense.markdown @mtreinish source/_integrations/orangepi_gpio.markdown @pascallj source/_integrations/oru.markdown @bvlaicu source/_integrations/panel_custom.markdown @home-assistant/frontend @@ -266,7 +271,7 @@ source/_integrations/quantum_gateway.markdown @cisasteelersfan source/_integrations/qwikswitch.markdown @kellerza source/_integrations/rainbird.markdown @konikvranik source/_integrations/raincloud.markdown @vanstinator -source/_integrations/rainforest_eagle.markdown @gtdiehl +source/_integrations/rainforest_eagle.markdown @gtdiehl @jcalbert source/_integrations/rainmachine.markdown @bachya source/_integrations/random.markdown @fabaff source/_integrations/repetier.markdown @MTrab @@ -276,6 +281,7 @@ source/_integrations/rmvtransport.markdown @cgtobi source/_integrations/roomba.markdown @pschmitt source/_integrations/safe_mode.markdown @home-assistant/core source/_integrations/saj.markdown @fredericvl +source/_integrations/salt.markdown @bjornorri source/_integrations/samsungtv.markdown @escoand source/_integrations/scene.markdown @home-assistant/core source/_integrations/scrape.markdown @fabaff @@ -345,6 +351,7 @@ source/_integrations/time_date.markdown @fabaff source/_integrations/tmb.markdown @alemuro source/_integrations/todoist.markdown @boralyl source/_integrations/toon.markdown @frenck +source/_integrations/totalconnect.markdown @austinmroczek source/_integrations/tplink.markdown @rytilahti source/_integrations/traccar.markdown @ludeeus source/_integrations/tradfri.markdown @ggravlingen @@ -370,13 +377,13 @@ source/_integrations/versasense.markdown @flamm3blemuff1n source/_integrations/version.markdown @fabaff source/_integrations/vesync.markdown @markperdue @webdjoe source/_integrations/vicare.markdown @oischinger +source/_integrations/vilfo.markdown @ManneW source/_integrations/vivotek.markdown @HarlemSquirrel source/_integrations/vizio.markdown @raman325 source/_integrations/vlc_telnet.markdown @rodripf source/_integrations/waqi.markdown @andrey-git source/_integrations/watson_tts.markdown @rutkai source/_integrations/weather.markdown @fabaff -source/_integrations/weblink.markdown @home-assistant/core source/_integrations/webostv.markdown @bendavid source/_integrations/websocket_api.markdown @home-assistant/core source/_integrations/wemo.markdown @sqldiablo diff --git a/Gemfile b/Gemfile index a019375cea6..8de1d420268 100644 --- a/Gemfile +++ b/Gemfile @@ -19,7 +19,7 @@ group :jekyll_plugins do end gem 'sinatra', '2.0.8.1' -gem 'nokogiri', '1.10.8' +gem 'nokogiri', '1.10.9' # Windows and JRuby does not include zoneinfo files, so bundle the tzinfo-data gem # and associated library diff --git a/Gemfile.lock b/Gemfile.lock index fc82e11cd3a..381459ba399 100644 --- a/Gemfile.lock +++ b/Gemfile.lock @@ -72,9 +72,9 @@ GEM multi_json (1.14.1) mustermann (1.1.0) ruby2_keywords (~> 0.0.1) - nokogiri (1.10.8) + nokogiri (1.10.9) mini_portile2 (~> 2.4.0) - nokogiri (1.10.8-x64-mingw32) + nokogiri (1.10.9-x64-mingw32) mini_portile2 (~> 2.4.0) pathutil (0.16.2) forwardable-extended (~> 2.6) @@ -125,7 +125,7 @@ DEPENDENCIES jekyll-redirect-from (= 0.16.0) jekyll-sitemap (= 1.4.0) jekyll-time-to-read (= 0.1.2) - nokogiri (= 1.10.8) + nokogiri (= 1.10.9) rake (= 13.0.1) sass-globbing (= 1.1.5) sinatra (= 2.0.8.1) diff --git a/_config.yml b/_config.yml index 3c967d8ecb7..735d2b72708 100644 --- a/_config.yml +++ b/_config.yml @@ -101,8 +101,8 @@ social: # Home Assistant release details current_major_version: 0 current_minor_version: 106 -current_patch_version: 0 -date_released: 2020-02-26 +current_patch_version: 5 +date_released: 2020-03-03 # Either # or the anchor link to latest release notes in the blog post. # Must be prefixed with a # and have double quotes around it. diff --git a/sass/custom/_component_page.scss b/sass/custom/_component_page.scss index 5cc5f79c75a..c52b3dc6107 100644 --- a/sass/custom/_component_page.scss +++ b/sass/custom/_component_page.scss @@ -1,8 +1,8 @@ -#components-page{ - .component-search{ +#components-page { + .component-search { margin-bottom: 24px; - input{ + input { width: 100%; padding: 10px; @@ -35,8 +35,8 @@ margin-bottom: 8px; &.current { - background-color: #3A5561; - background-image: linear-gradient(to bottom, #3A5561,#3F6B7D); + background-color: #3a5561; + background-image: linear-gradient(to bottom, #3a5561, #3f6b7d); } } } @@ -88,7 +88,7 @@ align-items: flex-start; margin: -4px; // grid trick, has to match option-card's margin - p.note{ + p.note { width: 100%; } @@ -100,20 +100,22 @@ background-color: #fefefe; margin: 4px; border-radius: 2px; - box-shadow: 0 2px 2px 0 rgba(0, 0, 0, 0.14), 0 1px 5px 0 rgba(0, 0, 0, 0.12), 0 3px 1px -2px rgba(0, 0, 0, 0.2); + box-shadow: 0 2px 2px 0 rgba(0, 0, 0, 0.14), 0 1px 5px 0 rgba(0, 0, 0, 0.12), + 0 3px 1px -2px rgba(0, 0, 0, 0.2); padding: 8px; text-align: center; text-decoration: none; .img-container { height: 50px; - margin: 8px 0; + margin: 12px 0; font: 0/0 a; - &:before { /* create a full-height inline block pseudo=element */ - content: ' '; + &:before { + /* create a full-height inline block pseudo=element */ + content: " "; display: inline-block; - vertical-align: middle; /* vertical alignment of the inline element */ + vertical-align: middle; /* vertical alignment of the inline element */ height: 100%; } @@ -127,133 +129,137 @@ } .title { + display: -webkit-box; + -webkit-line-clamp: 2; + -webkit-box-orient: vertical; + overflow: hidden; + text-decoration: none; font-size: 18px; color: #000; line-height: 1.3em; height: 2.6em; - } - - .category { - font-size: 14px; - color: #AAA; + margin-top: 20px; } } // fade-in animation - &.show-items .option-card{ - opacity:0; - -webkit-animation:new-item-animation .2s linear forwards; - -o-animation:new-item-animation .2s linear forwards; - animation:new-item-animation .2s linear forwards; + &.show-items .option-card { + opacity: 0; + -webkit-animation: new-item-animation 0.2s linear forwards; + -o-animation: new-item-animation 0.2s linear forwards; + animation: new-item-animation 0.2s linear forwards; } // fade-out animation - &.remove-items .option-card{ - -webkit-animation:removed-item-animation .2s cubic-bezier(.55,-0.04,.91,.94) forwards; - -o-animation:removed-item-animation .2s cubic-bezier(.55,-0.04,.91,.94) forwards; - animation:removed-item-animation .2s cubic-bezier(.55,-0.04,.91,.94) forwards + &.remove-items .option-card { + -webkit-animation: removed-item-animation 0.2s + cubic-bezier(0.55, -0.04, 0.91, 0.94) forwards; + -o-animation: removed-item-animation 0.2s + cubic-bezier(0.55, -0.04, 0.91, 0.94) forwards; + animation: removed-item-animation 0.2s cubic-bezier(0.55, -0.04, 0.91, 0.94) + forwards; } } // animations for fade-in and fade-out effects of option-cards @keyframes new-item-animation { from { - opacity:0; - -webkit-transform:scale(0); - -ms-transform:scale(0); - -o-transform:scale(0); - transform:scale(0) + opacity: 0; + -webkit-transform: scale(0); + -ms-transform: scale(0); + -o-transform: scale(0); + transform: scale(0); } to { - opacity:1; - -webkit-transform:scale(1); - -ms-transform:scale(1); - -o-transform:scale(1); - transform:scale(1) + opacity: 1; + -webkit-transform: scale(1); + -ms-transform: scale(1); + -o-transform: scale(1); + transform: scale(1); } } @-webkit-keyframes new-item-animation { from { - opacity:0; - -webkit-transform:scale(0); - transform:scale(0) + opacity: 0; + -webkit-transform: scale(0); + transform: scale(0); } to { - opacity:1; - -webkit-transform:scale(1); - transform:scale(1) + opacity: 1; + -webkit-transform: scale(1); + transform: scale(1); } } @-o-keyframes new-item-animation { from { - opacity:0; - -o-transform:scale(0); - transform:scale(0) + opacity: 0; + -o-transform: scale(0); + transform: scale(0); } to { - opacity:1; - -o-transform:scale(1); - transform:scale(1) + opacity: 1; + -o-transform: scale(1); + transform: scale(1); } } // space blocker animation @keyframes openspace { to { - height:auto + height: auto; } } @-webkit-keyframes openspace { to { - height:auto + height: auto; } } @-o-keyframes openspace { to { - height:auto + height: auto; } } // removal animation @keyframes removed-item-animation { from { - opacity:1; - -webkit-transform:scale(1); - -ms-transform:scale(1); - -o-transform:scale(1); - transform:scale(1) + opacity: 1; + -webkit-transform: scale(1); + -ms-transform: scale(1); + -o-transform: scale(1); + transform: scale(1); } to { - -webkit-transform:scale(0); - -ms-transform:scale(0); - -o-transform:scale(0); - transform:scale(0); - opacity:0 + -webkit-transform: scale(0); + -ms-transform: scale(0); + -o-transform: scale(0); + transform: scale(0); + opacity: 0; } } @-webkit-keyframes removed-item-animation { from { - opacity:1; - -webkit-transform:scale(1); - transform:scale(1) + opacity: 1; + -webkit-transform: scale(1); + transform: scale(1); } to { - -webkit-transform:scale(0); - transform:scale(0); - opacity:0 + -webkit-transform: scale(0); + transform: scale(0); + opacity: 0; } } @-o-keyframes removed-item-animation { from { - opacity:1; - -o-transform:scale(1); - transform:scale(1) + opacity: 1; + -o-transform: scale(1); + transform: scale(1); } to { - -o-transform:scale(0); - transform:scale(0); - opacity:0 + -o-transform: scale(0); + transform: scale(0); + opacity: 0; } } diff --git a/source/_docs/asterisk_mbox.markdown b/source/_docs/asterisk_mbox.markdown index 8c6ba581112..a36c5439dcb 100644 --- a/source/_docs/asterisk_mbox.markdown +++ b/source/_docs/asterisk_mbox.markdown @@ -92,7 +92,7 @@ Before beginning make sure that you have the following: Type=simple User=asterisk Group=asterisk - ExecStart=/usr/local/bin/asterisk_mbox_server -cfg /etc/asterisk/asterisk_mbox.ini + ExecStart=/usr/local/bin/asterisk_mbox_server --cfg /etc/asterisk/asterisk_mbox.ini Restart=on-failure [Install] diff --git a/source/_docs/automation/trigger.markdown b/source/_docs/automation/trigger.markdown index 329ad28ea60..7207906f377 100644 --- a/source/_docs/automation/trigger.markdown +++ b/source/_docs/automation/trigger.markdown @@ -130,6 +130,12 @@ The `for` template(s) will be evaluated when an entity changes as specified. Triggers when the state of any of given entities changes. If only `entity_id` is given trigger will activate for all state changes, even if only state attributes change. +
+ +The values you see in your overview will often not be the same as the actual state of the entity. For instance, the overview may show `Connected` when the underlying entity is actually `on`. You should check the state of the entity by looking in the _States_ menu under _Developer tools_. + +
+ ```yaml automation: trigger: @@ -176,9 +182,9 @@ Use quotes around your values for `from` and `to` to avoid the YAML parser inter #### Sunset / Sunrise trigger -Triggers when the sun is setting or rising, i.e. when the sun elevation reaches 0°. +Triggers when the sun is setting or rising, i.e., when the sun elevation reaches 0°. -An optional time offset can be given to have it trigger a set time before or after the sun event (e.g. 45 minutes before sunset). +An optional time offset can be given to have it trigger a set time before or after the sun event (e.g., 45 minutes before sunset).
diff --git a/source/_docs/autostart/systemd.markdown b/source/_docs/autostart/systemd.markdown index ab4ce5ea93c..270fd374e70 100644 --- a/source/_docs/autostart/systemd.markdown +++ b/source/_docs/autostart/systemd.markdown @@ -77,24 +77,24 @@ WantedBy=multi-user.target You need to reload `systemd` to make the daemon aware of the new configuration. ```bash -$ sudo systemctl --system daemon-reload +sudo systemctl --system daemon-reload ``` To have Home Assistant start automatically at boot, enable the service. ```bash -$ sudo systemctl enable home-assistant@YOUR_USER +sudo systemctl enable home-assistant@YOUR_USER ``` To disable the automatic start, use this command. ```bash -$ sudo systemctl disable home-assistant@YOUR_USER +sudo systemctl disable home-assistant@YOUR_USER ``` To start Home Assistant now, use this command. ```bash -$ sudo systemctl start home-assistant@YOUR_USER +sudo systemctl start home-assistant@YOUR_USER ``` You can also substitute the `start` above with `stop` to stop Home Assistant, `restart` to restart Home Assistant, and 'status' to see a brief status report as seen below. @@ -114,18 +114,18 @@ $ sudo systemctl status home-assistant@YOUR_USER To get Home Assistant's logging output, simple use `journalctl`. ```bash -$ sudo journalctl -f -u home-assistant@YOUR_USER +sudo journalctl -f -u home-assistant@YOUR_USER ``` Because the log can scroll quite quickly, you can select to view only the error lines: ```bash -$ sudo journalctl -f -u home-assistant@YOUR_USER | grep -i 'error' +sudo journalctl -f -u home-assistant@YOUR_USER | grep -i 'error' ``` When working on Home Assistant, you can easily restart the system and then watch the log output by combining the above commands using `&&` ```bash -$ sudo systemctl restart home-assistant@YOUR_USER && sudo journalctl -f -u home-assistant@YOUR_USER +sudo systemctl restart home-assistant@YOUR_USER && sudo journalctl -f -u home-assistant@YOUR_USER ``` ### Automatically restarting Home Assistant on failure diff --git a/source/_docs/backend/database.markdown b/source/_docs/backend/database.markdown index e71bc6babf1..2e5964bab9c 100644 --- a/source/_docs/backend/database.markdown +++ b/source/_docs/backend/database.markdown @@ -4,7 +4,7 @@ description: "Details about the database used by Home Assistant." redirect_from: /details/database/ --- -Database is used in by Home Assistant as history and tracker only, to store the events and its parameters. The default database used by Home Assistant is [SQLite](https://www.sqlite.org/), and the database file is stored in your [configuration directory](/getting-started/configuration/) (e.g., `/.homeassistant/home-assistant_v2.db`). If you prefer to run a database server (e.g. PostgreSQL), use the [`recorder` component](/integrations/recorder/). +Database is used in by Home Assistant as history and tracker only, to store the events and its parameters. The default database used by Home Assistant is [SQLite](https://www.sqlite.org/), and the database file is stored in your [configuration directory](/getting-started/configuration/) (e.g., `/.homeassistant/home-assistant_v2.db`). If you prefer to run a database server (e.g., PostgreSQL), use the [`recorder` component](/integrations/recorder/). To work with the SQLite database manually from the command-line, you will need an [installation](http://www.sqlitetutorial.net/download-install-sqlite/) of `sqlite3`. Alternatively [DB Browser for SQLite](http://sqlitebrowser.org/) provides a viewer for exploring the database data and an editor for executing SQL commands. First load your database with `sqlite3`: diff --git a/source/_docs/configuration/templating.markdown b/source/_docs/configuration/templating.markdown index dfca2518f23..6668c9d0886 100644 --- a/source/_docs/configuration/templating.markdown +++ b/source/_docs/configuration/templating.markdown @@ -57,7 +57,7 @@ Extensions allow templates to access all of the Home Assistant specific states a - `states('device_tracker.paulus')` will return the state string (not the object) of the given entity or `unknown` if it doesn't exist. - `is_state('device_tracker.paulus', 'home')` will test if the given entity is the specified state. - `state_attr('device_tracker.paulus', 'battery')` will return the value of the attribute or None if it doesn't exist. -- `is_state_attr('device_tracker.paulus', 'battery', 40)` will test if the given entity attribute is the specified state (in this case, a numeric value). +- `is_state_attr('device_tracker.paulus', 'battery', 40)` will test if the given entity attribute is the specified state (in this case, a numeric value). Note that the attribute can be `None` and you want to check if it is `None`, you need to use `state_attr('sensor.my_sensor', 'attr') == None`.
@@ -175,7 +175,7 @@ The same thing can also be expressed as a filter: - For specific values: `utcnow().second`, `utcnow().minute`, `utcnow().hour`, `utcnow().day`, `utcnow().month`, `utcnow().year`, `utcnow().weekday()` and `utcnow().isoweekday()`. - `as_timestamp()` converts datetime object or string to UNIX timestamp. This function also be used as a filter. - `strptime(string, format)` parses a string based on a [format](https://docs.python.org/3.8/library/datetime.html#strftime-and-strptime-behavior) and returns a datetime object. -- `relative_time` converts datetime object to its human-friendly "age" string. The age can be in second, minute, hour, day, month or year (but only the biggest unit is considered, e.g. if it's 2 days and 3 hours, "2 days" will be returned). Note that it only works for dates _in the past_. +- `relative_time` converts datetime object to its human-friendly "age" string. The age can be in second, minute, hour, day, month or year (but only the biggest unit is considered, e.g., if it's 2 days and 3 hours, "2 days" will be returned). Note that it only works for dates _in the past_. - Filter `timestamp_local` converts an UNIX timestamp to its string representation as date/time in your local timezone. - Filter `timestamp_utc` converts a UNIX timestamp to its string representation representation as date/time in UTC timezone. - Filter `timestamp_custom(format_string, local_time=True)` converts an UNIX timestamp to its string representation based on a custom format, the use of a local timezone is default. Supports the standard [Python time formatting options](https://docs.python.org/3/library/time.html#time.strftime). diff --git a/source/_docs/configuration/yaml.markdown b/source/_docs/configuration/yaml.markdown index fd1ae14b363..4fd7bcf2a70 100644 --- a/source/_docs/configuration/yaml.markdown +++ b/source/_docs/configuration/yaml.markdown @@ -89,7 +89,7 @@ example: To improve readability, you can source out certain domains from your main configuration file with the `!include`-syntax. ```yaml -lights: !include lights.yaml +light: !include lights.yaml ``` More information about this feature can also be found at [splitting configuration](/docs/configuration/splitting_configuration/). diff --git a/source/_docs/ecosystem/appdaemon/api.markdown b/source/_docs/ecosystem/appdaemon/api.markdown index 1cdd701f14f..f3dbef57289 100644 --- a/source/_docs/ecosystem/appdaemon/api.markdown +++ b/source/_docs/ecosystem/appdaemon/api.markdown @@ -1966,7 +1966,7 @@ A list of split devices with 1 or more entries. ```python for sensor in self.split_device_list(self.args["sensors"]): - do_something(sensor) # e.g. make a state subscription + do_something(sensor) # e.g., make a state subscription ``` diff --git a/source/_docs/ecosystem/backup/backup_github.markdown b/source/_docs/ecosystem/backup/backup_github.markdown index 3c2c6d7b568..bc034828740 100644 --- a/source/_docs/ecosystem/backup/backup_github.markdown +++ b/source/_docs/ecosystem/backup/backup_github.markdown @@ -50,7 +50,7 @@ Creating a `.gitignore` file in your repository will tell Git which files NOT to
- If you are creating the `.gitignore` file on Windows, make sure that you save the file with Unix line endings (i.e. by using an editor like Notepad++). + If you are creating the `.gitignore` file on Windows, make sure that you save the file with Unix line endings (i.e., by using an editor like Notepad++).
diff --git a/source/_docs/ecosystem/certificates/lets_encrypt.markdown b/source/_docs/ecosystem/certificates/lets_encrypt.markdown index a75d3cefd74..da31010ba61 100644 --- a/source/_docs/ecosystem/certificates/lets_encrypt.markdown +++ b/source/_docs/ecosystem/certificates/lets_encrypt.markdown @@ -362,7 +362,7 @@ https://YOUR-HA-IP:8123 Some cases such as this are where your router does not allow 'loopback' or where there is a problem with incoming connections due to technical failure. In these cases you can still use your internal connection and safely ignore the warnings. -If you were previously using a webapp on your phone/tablet to access your Home Assistant you should delete the old one and create a new one with the new address. The old one will no longer work as it is not keyed to your new, secure URL. Instructions for creating your new webapp can be found [here](/docs/frontend/mobile/). +If you were previously using a webapp on your phone/tablet to access your Home Assistant you should delete the old one and create a new one with the new address. The old one will no longer work as it is not keyed to your new, secure URL. All done? Accessing your Home Assistant from across the world with your DuckDNS URL and a lovely secure logo on your browser? Ace! Now let's clean up our port forwards so that we are only exposing the parts of our network that are absolutely necessary to the outside world. diff --git a/source/_docs/ecosystem/certificates/tls_self_signed_certificate.markdown b/source/_docs/ecosystem/certificates/tls_self_signed_certificate.markdown index cbd111228d1..7926fedadcb 100644 --- a/source/_docs/ecosystem/certificates/tls_self_signed_certificate.markdown +++ b/source/_docs/ecosystem/certificates/tls_self_signed_certificate.markdown @@ -23,9 +23,11 @@ Change to your Home Assistant [configuration directory](/getting-started/configu The certificate **must** be `.pem` extension. ```bash -openssl req -sha256 -newkey rsa:4096 -nodes -keyout privkey.pem -x509 -days 730 -out fullchain.pem +openssl req -sha256 -addext "subjectAltName = IP:X.X.X.X" -newkey rsa:4096 -nodes -keyout privkey.pem -x509 -days 730 -out fullchain.pem ``` +Where the `X.X.X.X` must be replaced with the IP address of your local machine running Home Assistant (e.g., `192.168.1.20`). + For details about the parameters, please check the OpenSSL documentation. Provide the requested information during the generation process. At the end you will have two files called `privkey.pem` and `fullchain.pem`. The key and the certificate. diff --git a/source/_docs/ecosystem/hass-configurator.markdown b/source/_docs/ecosystem/hass-configurator.markdown deleted file mode 100644 index 5225cc79ab8..00000000000 --- a/source/_docs/ecosystem/hass-configurator.markdown +++ /dev/null @@ -1,116 +0,0 @@ ---- -title: "Configurator" -description: "Instructions on how to install and use the Configurator" -redirect_from: /ecosystem/hass-configurator/ ---- - -### Configuration UI for Home Assistant - -Since there is currently no nice way to edit the YAML files Home Assistant is using through the frontend, here is a small webapp that hopefully makes configuration easier. It is a customized and embedded [Ace editor](https://ace.c9.io/), which has syntax highlighting for YAML, the format used for Home Assistant's configuration files. There is also an integrated file browser to select whatever file you want to edit. When you're done editing the file, simply click the save button and your changes will be applied. -This is essentially a browser-based alternative to modifying your configuration through SSH, Windows + SMB, Github, etc. - -

- -Screenshot of the Configurator. -

- -### Feature list - -- Web-based editor to modify your files -- Upload and download files -- Git integration -- List of available triggers, events, entities, conditions and services. Selected element gets inserted into the editor at the last cursor position. -- Check valid configuration and restart Home Assistant directly with the click of a button -- SSL support -- Optional authentication and IP filtering for additional security -- Direct links to Home Assistant documentation and icons -- Execute shell commands -- Runs on pretty much any machine Home Assistant can run on - -
-This tool allows you to browse your filesystem and modify files. So be careful which files you edit, or you might break critical parts of your system.
-Consider running the configurator as a user with limited privileges to limit possible damage. -
- -### Installation (Linux, macOS) -There are no dependencies on Python modules that are not part of the standard library. All the fancy JavaScript libraries are loaded from CDN (which means this doesn't work when you're offline). -- Copy [configurator.py](https://github.com/danielperna84/hass-configurator/blob/master/configurator.py) to your Home Assistant configuration directory (e.g `/home/homeassistant/.homeassistant`): `wget https://raw.githubusercontent.com/danielperna84/hass-configurator/master/configurator.py` -- Make it executable: `sudo chmod 755 configurator.py` -- (Optional) Set the `GIT` variable in configurator.py to `True` if [GitPython](https://gitpython.readthedocs.io/) is installed on your system. This is required if you want to make use of the Git integration. -- Execute it: `sudo ./configurator.py` -- To terminate the process do the usual `CTRL+C`, maybe once or twice - -### Configuration -Near the top of the `configurator.py` file you will find some global variables you can change to customize the configurator. When setting variables of the type _string_, the string must be within quotation marks. The default settings are fine for just checking out the configurator quickly. For more customized setups it might be advisable to change some settings. -To keep your settings across updates it is also possible to save settings in an external file. In that case copy [settings.conf](https://github.com/danielperna84/hass-configurator/blob/master/settings.conf) wherever you like and append the full path to the file to the command when starting the configurator. e.g., `sudo .configurator.py /home/homeassistant/.homeassistant/mysettings.conf`. This file is in JSON format, so make sure it has a valid syntax (you can set the editor to JSON to get syntax highlighting for the settings). The major difference to the settings in the .py file is that `None` becomes `null`. - -#### LISTENIP (string) -The IP the service is listening on. By default it is binding to `0.0.0.0`, which is every interface on the system. -#### LISTENPORT (integer) -The port the service is listening on. By default it is using `3218`, but you can change this if you need to. -#### BASEPATH (string) -It is possible to place configurator.py somewhere else. Set the `BASEPATH` to something like `"/home/homeassistant/.homeassistant"`, and no matter where you are running the configurator from, it will start serving files from there. This is needed if you plan on running the configurator with systemd or some other way of daemonizing the configurator. -#### SSL_CERTIFICATE / SSL_KEY (string) -If you are using SSL, set the paths to your SSL files here. This is similar to the SSL setup you can do in Home Assistant. -#### HASS_API (string) -The configurator fetches some data from your running Home Assistant instance. If the API is not available through the default URL, modify this variable to fix this. -#### HASS_API_PASSWORD (string) -If you plan on using the restart button, you have to set your API password. Calling the restart service of Home Assistant is prohibited without authentication. -#### CREDENTIALS (string) -Set credentials in the form of `"username:password"` if authentication should be required for access to the configurator. -#### ALLOWED_NETWORKS (list) -Limit access to the configurator by adding allowed IP addresses / networks to the list, e.g `ALLOWED_NETWORKS = ["192.168.0.0/24", "172.16.47.23"]` -#### BANNED_IPS (list) -List of statically banned IP addresses, e.g., `BANNED_IPS = ["1.1.1.1", "2.2.2.2"]` -#### BANLIMIT (integer) -Ban IPs after `n` failed login attempts. Restart the service to reset banning. The default of `0` disables this feature. `CREDENTIALS` has to be set for this to work. -#### IGNORE_PATTERN (list) -Files and folders to ignore in the UI, e.g., `IGNORE_PATTERN = [".*", "*.log", "__pycache__"]`. -#### DIRSFIRST (bool) -If set to `True`, directories will be displayed at the top of the filebrowser. -#### GIT (bool) -Set this variable to `True` to enable Git integration. This feature requires [GitPython](https://gitpython.readthedocs.io) - to be installed on the system that is running the configurator. For technical reasons this feature cannot be enabled with the static settings file. - -__Note regarding `ALLOWED_NETWORKS`, `BANNED_IPS` and `BANLIMIT`__: -The way this is implemented works in the following order: - -1. (Only if `CREDENTIALS` is set) Check credentials - - Failure: Retry `BANLIMIT` times, after that return error 420 (unless you try again without any authentication headers set, such as in a private tab of your browser) - - Success: Continue -2. Check if client IP address is in `BANNED_IPS` - - Yes: Return error 420 - - No: Continue -3. Check if client IP address is in `ALLOWED_NETWORKS` - - Yes: Continue and display UI of configurator - - No: Return error 420 - -### Embedding into Home Assistant -Home Assistant has the [panel_iframe](/integrations/panel_iframe/) component. With this it is possible to embed the configurator directly into Home Assistant, allowing you to modify your configuration through the Home Assistant frontend. -An example configuration would look like this: - -```yaml -panel_iframe: - configurator: - title: Configurator - icon: mdi:wrench - url: http://123.123.132.132:3218 -``` - -
-Be careful when setting up port forwarding to the configurator while embedding it into Home Assistant. If you don't restrict access by requiring authentication and/or blocking based on client IP addresses, your configuration will be exposed to the Internet! -
- -### Daemonizing / Keeping the configurator running -Since the configurator script on its own is not a service, you will have to take some extra steps to keep it running. Here are five options (for Linux), but there are more depending on your usecase. - -1. Fork the process into the background with the command: -`nohup sudo ./configurator.py &` -2. If your system is using systemd (that's usually what you'll find on a Raspberry Pi), there's a [template file](https://github.com/danielperna84/hass-configurator/blob/master/hass-configurator.systemd) you can use and then apply the same process to integrate it as mentioned in the [Home Assistant documentation](/docs/autostart/systemd/). If you use this method you have to set the `BASEPATH` variable according to your environment. -3. If you have [supervisor](http://supervisord.org/) running on your system, [hass-poc-configurator.supervisor](https://github.com/danielperna84/hass-configurator/blob/master/hass-configurator.supervisor) would be an example configuration you could use to control the configurator. -4. A tool called [tmux](https://tmux.github.io/), which should be pre-installed with [HASSbian](/docs/installation/hassbian/). -5. A tool called [screen](http://ss64.com/bash/screen.html) (alternative to tmux). If it's not already installed on your system, you can do `sudo apt-get install screen` or `sudo yum install screen` to get it. When it's installed, start a screen session by executing `screen`. Then navigate to your Home Assistant directory and start the configurator like described above. Put the screen session into the background by pressing `CTRL+A` and then `CTRL+D`. It is now safe to disconnect from your SSH session. -To resume the screen session, log in to your machine and execute `screen -r`. - -### Troubleshooting, Issues etc. -If you encounter difficulties setting up the configurator or stumble upon a possible bug, head over to the [Issues](https://github.com/danielperna84/hass-configurator/issues) section of the configurator repository. Additionally there is a thread at the [Home Assistant Community](https://community.home-assistant.io/t/simplistic-configuration-ui/10175) where common problems may have been discussed already. And if not, there are always friendly people around to help finding solutions. diff --git a/source/_docs/ecosystem/notebooks/api.markdown b/source/_docs/ecosystem/notebooks/api.markdown deleted file mode 100644 index 063510542e2..00000000000 --- a/source/_docs/ecosystem/notebooks/api.markdown +++ /dev/null @@ -1,7 +0,0 @@ ---- -title: "Home Assistant Python API" -description: "Basic example of interacting with Home Assistant live from a Jupyter notebook using the Python API." -redirect_from: /ecosystem/notebooks/api/ ---- - -Python API is deprecated. diff --git a/source/_docs/ecosystem/notebooks/database.markdown b/source/_docs/ecosystem/notebooks/database.markdown deleted file mode 100644 index 11ad7cce37b..00000000000 --- a/source/_docs/ecosystem/notebooks/database.markdown +++ /dev/null @@ -1,7 +0,0 @@ ---- -title: "Database" -description: "Accessing the Home Assistant database from a Jupyter notebook." -redirect_from: /ecosystem/notebooks/database/ ---- - -You can directly access the Home Assistant database from Jupyter notebooks. The [Database example](https://nbviewer.jupyter.org/github/home-assistant/home-assistant-notebooks/blob/master/other/database-examples.ipynb) shows you how you can work with stored database values. diff --git a/source/_docs/ecosystem/notebooks/graph.markdown b/source/_docs/ecosystem/notebooks/graph.markdown deleted file mode 100644 index c48a18a3849..00000000000 --- a/source/_docs/ecosystem/notebooks/graph.markdown +++ /dev/null @@ -1,7 +0,0 @@ ---- -title: "Graph" -description: "Basic example how to create a graph with a Jupyter notebook." -redirect_from: /ecosystem/notebooks/graph/ ---- - -For graphing this [Jupyter notebook](https://nbviewer.jupyter.org/github/home-assistant/home-assistant-notebooks/blob/master/other/graph-single-sensor.ipynb) should get you started. diff --git a/source/_docs/ecosystem/notebooks/installation.markdown b/source/_docs/ecosystem/notebooks/installation.markdown deleted file mode 100644 index 0afed74486d..00000000000 --- a/source/_docs/ecosystem/notebooks/installation.markdown +++ /dev/null @@ -1,45 +0,0 @@ ---- -title: "Installation" -description: "Setup and first steps for Jupyter Notebooks and Home Assistant." -redirect_from: /ecosystem/notebooks/installation/ ---- - -To run Jupyter Notebooks locally, an installation of [Jupyter](http://jupyter.org/) is needed. Consider running Jupyter in a [virtualenv](/docs/installation/virtualenv/) in order to properly manage dependencies. - -```bash -$ pip3 install jupyter matplotlib -``` - -
- -Certain notebooks hosted in the [Home Assistant notebooks repository](https://github.com/home-assistant/home-assistant-notebooks) require access to a running Home Assistant instance or parts of a Home Assistant installation. If you want to run those notebooks, install Home Assistant with `$ pip3 install homeassistant` as well. - -
- -Run Jupyter from the command line. - -```bash -$ jupyter notebook -[I 17:22:18.081 NotebookApp] Writing notebook server cookie secret to /run/user/1000/jupyter/notebook_cookie_secret -[I 17:22:18.921 NotebookApp] Serving notebooks from local directory: /home/fabaff/home-assistant -[I 17:22:18.921 NotebookApp] 0 active kernels -[I 17:22:18.921 NotebookApp] The Jupyter Notebook is running at: http://localhost:8888/ -[I 17:22:18.922 NotebookApp] Use Control-C to stop this server and shut down all kernels (twice to skip confirmation). -``` - -Open `http://localhost:8888/` in your browser. Press "New" -> "Python3" to open a new notebook. - -

- -

- -You will get an empty notebook with one cell. Cells can contain code or text. To get the output of a cell you need to execute them with "Cell" -> "Run Cells" from the menu or by pressing the Play icon. - -

- -

- -The downloadable version of this notebook is available in the [Home Assistant notebooks repository](https://github.com/home-assistant/home-assistant-notebooks/blob/master/other/first-notebook.ipynb). - - -As you can see is the Jupyter notebook workflow is very similar to working directly with a Python shell. One advantage of notebooks is that you can go back and forth between cells as you please and save your work. diff --git a/source/_docs/ecosystem/notebooks/stats.markdown b/source/_docs/ecosystem/notebooks/stats.markdown deleted file mode 100644 index c1232bcb039..00000000000 --- a/source/_docs/ecosystem/notebooks/stats.markdown +++ /dev/null @@ -1,7 +0,0 @@ ---- -title: "Statistics" -description: "Basic example how to create basic statistics with a Jupyter notebook." -redirect_from: /ecosystem/notebooks/stats/ ---- - -The [Statistics notebook](https://nbviewer.jupyter.org/github/home-assistant/home-assistant-notebooks/blob/master/other/database-statistics.ipynb) shows some basic statistical analysis on data in the Home Assistant database. diff --git a/source/_docs/frontend/mobile.markdown b/source/_docs/frontend/mobile.markdown deleted file mode 100644 index b2b6201d606..00000000000 --- a/source/_docs/frontend/mobile.markdown +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: "Getting started on Mobile" -description: "Android/iOS instructions to add Home Assistant to your homescreen." -redirect_from: /getting-started/mobile/ ---- - -Home Assistant has [a companion app for both Android and iOS](/docs/ecosystem/ios/). - -As an alternative to the iOS and Android companion apps, you can add the Home Assistant "web app" to your homescreen as if it was native (Home Assistant leverages the W3C [`manifest.json`](https://w3c.github.io/manifest/) support). - -## Android - - 1. Open Chrome - 2. Navigate to your Home Assistant instance - 3. Tap on the Menu icon (three vertical bars) - 4. Tap on Add to Homescreen - 5. A dialog will popup; tap on Add - -

- -

- -## iOS - - 1. Open Safari - 2. Navigate to your Home Assistant instance - 3. Tap on the Share icon in the middle of the bottom toolbar - 4. Tap on "Add to Home Screen" - 5. A dialog will popup; tap on Add diff --git a/source/_docs/installation.markdown b/source/_docs/installation.markdown index 9a4d7afe43a..94f822f7b73 100644 --- a/source/_docs/installation.markdown +++ b/source/_docs/installation.markdown @@ -47,7 +47,7 @@ These install options are fully supported by Home Assistant's documentation. For
-The only installation methods that allow you to use Home Assistant Add-ons is using the Home Assistant image and [manual Supervised installer](/hassio/installation/#alternative-install-on-a-generic-linux-host). All other methods only install the base Home Assistant packages, however the software from the add-ons may still usually be installed manually like any other program. +The only installation methods that allow you to use Home Assistant Add-ons is using the Home Assistant image and [manual Supervised installer](/hassio/installation/#alternative-install-home-assistant-supervised-on-a-generic-linux-host). All other methods only install the base Home Assistant packages, however the software from the add-ons may still usually be installed manually like any other program.
@@ -96,13 +96,13 @@ These guides are provided as-is. Some of these install methods are more limited
- +
macOS
- +
Synology
@@ -112,9 +112,9 @@ These guides are provided as-is. Some of these install methods are more limited
FreeNAS
- +
- +
Home Assistant Supervised
on generic Linux server
diff --git a/source/_docs/installation/docker.markdown b/source/_docs/installation/docker.markdown index 02139e0cebe..cfbe979ef29 100644 --- a/source/_docs/installation/docker.markdown +++ b/source/_docs/installation/docker.markdown @@ -4,6 +4,14 @@ description: "Instructions to install Home Assistant on a Docker." redirect_from: /getting-started/installation-docker/ --- +
+ +These below instructions are for an installation of Home Assistant Core running in your own Docker environment, which you manage yourself. + +For an installation of Home Assistant Supervised, which includes Home Assistant's add-on ecosystem, see the instructions for installing [Home Assistant Supervised on a generic Linux host](/hassio/installation/#alternative-install-home-assistant-supervised-on-a-generic-linux-host/). + +
+ ## Platform Installation Installation with Docker is straightforward. Adjust the following command so that `/PATH_TO_YOUR_CONFIG` points at the folder where you want to store your configuration and run it: @@ -36,7 +44,7 @@ If you wish to browse directly to `http://localhost:8123` from your macOS host, docker run --init -d --name="home-assistant" -e "TZ=America/Los_Angeles" -v /PATH_TO_YOUR_CONFIG:/config -p 8123:8123 homeassistant/home-assistant:stable ``` -Alternatively, `docker-compose` works with any recent release of `docker-ce` on macOS. Note that (further down this page) we provide an example `docker-compose.yml` however it differs from the `docker run` example above. To make the .yml directives match, you would need to make _two_ changes: first add the equivalent `ports:` directive, then _remove_ the `network_mode: host` section. This is because `Port mapping is incompatible with network_mode: host:`. More details can be found at [Docker networking docs](https://docs.docker.com/network/). Note also the `/dev/tty*` device name used by your Arduino etc. devices will differ from the Linux example, so the compose `mount:` may require updates. +Alternatively, `docker-compose` works with any recent release of `docker-ce` on macOS. Note that (further down this page) we provide an example `docker-compose.yml` however it differs from the `docker run` example above. To make the .yml directives match, you would need to make _two_ changes: first add the equivalent `ports:` directive, then _remove_ the `network_mode: host` section. This is because `Port mapping is incompatible with network_mode: host:`. More details can be found at [Docker networking documentation](https://docs.docker.com/network/). Note also the `/dev/tty*` device name used by your Arduino etc. devices will differ from the Linux example, so the compose `mount:` may require updates. ### Windows diff --git a/source/_docs/installation/updating.markdown b/source/_docs/installation/updating.markdown index ddb57502588..716da0e55bf 100644 --- a/source/_docs/installation/updating.markdown +++ b/source/_docs/installation/updating.markdown @@ -6,15 +6,15 @@ redirect_from: /getting-started/updating/
-The upgrade process differs depending on the installation you have, so please review the documentation that is specific to your install [Home Assistant](/hassio/) or [Home Assistant Core](/docs/installation/virtualenv/#upgrading-home-assistant). +The upgrade process differs depending on the installation you have, so please review the documentation that is specific to your install: [Home Assistant](/hassio/) or [Home Assistant Core](/docs/installation/virtualenv/#upgrading-home-assistant).
-Check what's new in the latest version and potentially impacts your system in [Home Assistant release notes](https://github.com/home-assistant/home-assistant/releases). It is good practice to review these release notes and pay close attention to the **Breaking Changes** that are listed there. If you haven't done an update for a while, you should also check previous release notes as they can also contain relevant **Breaking Changes**. **Breaking Changes** may require configuration updates for your components. If you missed this and Home Assistant refuses to start, check the log file in the [configuration](/docs/configuration/) directory, e.g., `.homeassistant/home-assistant.log`, for details about broken components. +Check what's new in the latest version and potentially impacts your system in the [Home Assistant release notes](https://github.com/home-assistant/home-assistant/releases). It is good practice to review these release notes and pay close attention to the **Breaking Changes** that are listed there. If you haven't done an update for a while, you should also check previous release notes as they can also contain relevant **Breaking Changes**. These **Breaking Changes** may require configuration updates for your components. If you missed this and Home Assistant refuses to start, check the log file in the [configuration](/docs/configuration/) directory, e.g., `.homeassistant/home-assistant.log`, for details about broken components.
-To avoid permission errors, the upgrade must be run as the same user as the installation was completed, again review the documentation specific to your install [Home Assistant](/hassio/) or [Home Assistant Core](/docs/installation/virtualenv). +To avoid permission errors, the upgrade must be run as the same user as was used during the initial installation, again review the documentation specific to your install [Home Assistant](/hassio/) or [Home Assistant Core](/docs/installation/virtualenv).
@@ -36,7 +36,7 @@ For a Raspberry Pi Docker container, simply pull the latest one: sudo docker pull homeassistant/raspberrypi3-homeassistant:latest ``` -After updating, you must start/restart Home Assistant for the changes to take effect. This means that you will have to restart `hass` itself or the [autostarting](/docs/autostart/) daemon (if applicable). Startup can take considerable amount of time (i.e. minutes) depending on your device. This is because all requirements are updated as well. +After updating, you must start/restart Home Assistant for the changes to take effect. This means that you will have to restart `hass` itself or the [autostarting](/docs/autostart/) daemon (if applicable). Startup can take a considerable amount of time (i.e., minutes) depending on your device. This is because all requirements are updated as well. [BRUH automation](https://www.bruhautomation.io/) has created [a tutorial video](https://www.youtube.com/watch?v=tuG2rs1Cl2Y) explaining how to upgrade Home Assistant. @@ -50,7 +50,7 @@ pip3 install homeassistant==0.XX.X #### Run the beta version -If you would like to test next release before anyone else, you can install the beta version released every two weeks: +If you would like to test the next release before anyone else, you can install the beta version released every two weeks: ```bash pip3 install --pre --upgrade homeassistant diff --git a/source/_docs/installation/virtualenv.markdown b/source/_docs/installation/virtualenv.markdown index fe1f5613757..1d19fca3d7d 100644 --- a/source/_docs/installation/virtualenv.markdown +++ b/source/_docs/installation/virtualenv.markdown @@ -98,7 +98,7 @@ pip3 install --upgrade git+git://github.com/home-assistant/home-assistant.git@de - In the future, if you want to start Home Assistant manually again, follow step 2, 3 and 5. - It's recommended to run Home Assistant as a dedicated user. -- If you want Home Assistant to automatically start at boot, check the [autostart docs](/docs/autostart/) +- If you want Home Assistant to automatically start at boot, check the [autostart documentation](/docs/autostart/)
diff --git a/source/_docs/locked_out.md b/source/_docs/locked_out.md index 233492f1198..bf0d7317d77 100644 --- a/source/_docs/locked_out.md +++ b/source/_docs/locked_out.md @@ -10,6 +10,8 @@ or need to recover your data. ### Home Assistant (including Supervised) +If you are still logged in to the web interface with your user, then you are in luck. Add a new user as an administrator and give the new user a password you can remember. Then log out, and log in with this new user. You may then delete the old user account. But this way, your configuration will remain, and you don't have to do a new onboarding process. + If you’ve forgotten your user, then deleting the files mentioned above will be necessary to start a new onboarding process. If you know the user, but not the password and you can access the [Home Assistant console](https://www.home-assistant.io/hassio/commandline/) and use the command below: diff --git a/source/_docs/mqtt/discovery.markdown b/source/_docs/mqtt/discovery.markdown index face99eab89..3bf8c3c04ed 100644 --- a/source/_docs/mqtt/discovery.markdown +++ b/source/_docs/mqtt/discovery.markdown @@ -12,6 +12,7 @@ Supported by MQTT discovery: - [Binary sensors](/integrations/binary_sensor.mqtt/) - [Cameras](/integrations/camera.mqtt/) - [Covers](/integrations/cover.mqtt/) +- [Device Triggers](/integrations/device_trigger.mqtt/) - [Fans](/integrations/fan.mqtt/) - [HVACs](/integrations/climate.mqtt/) - [Lights](/integrations/light.mqtt/) diff --git a/source/_docs/scripts/conditions.markdown b/source/_docs/scripts/conditions.markdown index 754615b555b..561b59a4eb1 100644 --- a/source/_docs/scripts/conditions.markdown +++ b/source/_docs/scripts/conditions.markdown @@ -157,7 +157,9 @@ condition: #### Sunset/sunrise condition -The sun condition can also test if the sun has already set or risen when a trigger occurs. The `before` and `after` keys can only be set to `sunset` or `sunrise`. They have a corresponding optional offset value (`before_offset`, `after_offset`) that can be added, similar to the [sun trigger][sun_trigger]. +The sun condition can also test if the sun has already set or risen when a trigger occurs. The `before` and `after` keys can only be set to `sunset` or `sunrise`. They have a corresponding optional offset value (`before_offset`, `after_offset`) that can be added, similar to the [sun trigger][sun_trigger]. When both keys are used, the result is a logical `and` of separate conditions. + +Note that if only `before` key is used, the condition will be `true` _from midnight_ until sunrise/sunset. If only `after` key is used, the condition will be `true` from sunset/sunrise _until midnight_. Therefore, to cover time between sunset and sunrise one need to use `after: sunset` and `before: sunrise` as 2 separate conditions and combine them using `or`. [sun_trigger]: /docs/automation/trigger/#sun-trigger @@ -171,13 +173,25 @@ In those cases it is advised to use conditions evaluating the solar elevation in condition: condition: sun after: sunset - # Optional offset value - in this case it must from -1 hours relative to sunset, or after after_offset: "-01:00:00" ``` +This is 'when light' - equivalent to a state condition on `sun.sun` of `above_horizon`. + ```yaml condition: - condition: or # 'when dark' condition: either after sunset or before sunrise - equivalent to a state condition on `sun.sun` of `below_horizon` + - condition: sun + after: sunrise + before: sunset +``` + +This is 'when dark' - equivalent to a state condition on `sun.sun` of `below_horizon`. + +We cannot use both keys in this case as it will always be `false`. + +```yaml +condition: + condition: or conditions: - condition: sun after: sunset @@ -185,16 +199,6 @@ condition: before: sunrise ``` -```yaml -condition: - condition: and # 'when light' condition: before sunset and after sunrise - equivalent to a state condition on `sun.sun` of `above_horizon` - conditions: - - condition: sun - before: sunset - - condition: sun - after: sunrise -``` - A visual timeline is provided below showing an example of when these conditions are true. In this chart, sunrise is at 6:00, and sunset is at 18:00 (6:00 PM). The green areas of the chart indicate when the specified conditions are true. Graphic showing an example of sun conditions @@ -241,7 +245,7 @@ A better weekday condition could be by using the [Workday Binary Sensor](/integr ### Zone condition -Zone conditions test if an entity is in a certain zone. For zone automation to work, you need to have set up a device tracker platform that supports reporting GPS coordinates. Currently this is limited to the [OwnTracks platform](/integrations/owntracks/) and the [iCloud platform](/integrations/icloud/). +Zone conditions test if an entity is in a certain zone. For zone automation to work, you need to have set up a device tracker platform that supports reporting GPS coordinates. ```yaml condition: diff --git a/source/_docs/tools/credstash.markdown b/source/_docs/tools/credstash.markdown index cede4f23e0c..c696f102b87 100644 --- a/source/_docs/tools/credstash.markdown +++ b/source/_docs/tools/credstash.markdown @@ -5,7 +5,7 @@ description: "Script to store credentials securely in AWS" Using [Credstash](https://github.com/fugue/credstash) is an alternative way to `secrets.yaml`. They can be managed from the command line via the credstash script. -Before using credstash, you need to set up AWS credentials either via the `aws` command line tool or using environment variables as explained in the [AWS CLI docs](http://docs.aws.amazon.com/cli/latest/userguide/cli-chap-getting-started.html) as well as creating a KMS key named `credstash` as explained in the [credstash Readme](https://github.com/fugue/credstash#setting-up-kms). After that is complete, you can use the provided script to add secrets to your Home Assistant secret store in credstash. +Before using credstash, you need to set up AWS credentials either via the `aws` command line tool or using environment variables as explained in the [AWS CLI documentation](http://docs.aws.amazon.com/cli/latest/userguide/cli-chap-getting-started.html) as well as creating a KMS key named `credstash` as explained in the [credstash Readme](https://github.com/fugue/credstash#setting-up-kms). After that is complete, you can use the provided script to add secrets to your Home Assistant secret store in credstash. ```bash $ hass --script credstash --help diff --git a/source/_docs/z-wave/devices.markdown b/source/_docs/z-wave/devices.markdown index b8c79c760c3..94d36ff44ea 100644 --- a/source/_docs/z-wave/devices.markdown +++ b/source/_docs/z-wave/devices.markdown @@ -59,7 +59,7 @@ Where a device doesn't send updates on status changes to the controller, you can For example, with `polling_interval=60000` (which is the default) if you have 10 devices that are being polled at every interval, and each polling takes one secound (request/response round trip), then it will take 10 seconds to complete the polling list. This only leaves 50 seconds left for normal traffic. The more devices you poll, and the shorter the interval, the less bandwidth that's available for normal traffic. -Polling needs to be enabled per device, you can control this through the *polling intensity* (interval) of the device. See the [Node Management](/docs/z-wave/control-panel#z-wave-node-management) docs for details. +Polling needs to be enabled per device, you can control this through the *polling intensity* (interval) of the device. See the [Node Management](/docs/z-wave/control-panel#z-wave-node-management) documentation for details. ## Central Scene support diff --git a/source/_docs/z-wave/installation.markdown b/source/_docs/z-wave/installation.markdown index d8922f499a6..bfd703af5ea 100644 --- a/source/_docs/z-wave/installation.markdown +++ b/source/_docs/z-wave/installation.markdown @@ -123,7 +123,7 @@ You can also check what hardware has been found using the [`ha` command](/hassio ha hardware info ``` -If you did an alternative install of Home Assistant on Linux (e.g. installing Ubuntu, then Docker, then Home Assistant Supervised) then the `modemmanager` package will interfere with any Z-Wave (or Zigbee) stick and should be removed or disabled in the host OS. Failure to do so will result in random failures of those components, e.g. dead or unreachable Z-Wave nodes, most notably right after Home Assistant restarts. Connect to your host OS via SSH, then you can disable with `sudo systemctl disable ModemManager` and remove with `sudo apt-get purge modemmanager` (commands are for Debian/Ubuntu). +If you did an alternative install of Home Assistant on Linux (e.g., installing Ubuntu, then Docker, then Home Assistant Supervised) then the `modemmanager` package will interfere with any Z-Wave (or Zigbee) stick and should be removed or disabled in the host OS. Failure to do so will result in random failures of those components, e.g., dead or unreachable Z-Wave nodes, most notably right after Home Assistant restarts. Connect to your host OS via SSH, then you can disable with `sudo systemctl disable ModemManager` and remove with `sudo apt-get purge modemmanager` (commands are for Debian/Ubuntu). ### Docker @@ -227,7 +227,7 @@ If this applies to your situation: Then chances are high that the ModemManager in the host OS is causing the issue, claiming or interfering with the USB Z-Wave stick like the much used Aeotec ones. In this case you need to disable ModemManager. -Connect to your host OS (e.g. Ubuntu) through SSH, then execute the following command on your host system to disable the ModemManager: +Connect to your host OS (e.g., Ubuntu) through SSH, then execute the following command on your host system to disable the ModemManager: ```bash systemctl disable ModemManager.service diff --git a/source/_faq/missing-documentation.markdown b/source/_faq/missing-documentation.markdown index cceaf744134..3c5e89e033f 100644 --- a/source/_faq/missing-documentation.markdown +++ b/source/_faq/missing-documentation.markdown @@ -1,6 +1,6 @@ --- title: "Missing Documentation" -description: "The docs are missing or outdated" +description: "The documentation is missing or outdated" ha_category: Documentation --- diff --git a/source/_includes/asides/component_navigation.html b/source/_includes/asides/component_navigation.html index 66e78373bdd..853d4bacd33 100644 --- a/source/_includes/asides/component_navigation.html +++ b/source/_includes/asides/component_navigation.html @@ -1,20 +1,18 @@ -{%- assign github_main_repo = 'https://github.com/home-assistant/home-assistant/blob/dev/homeassistant' -%}
- {%- include edit_github.html -%}
{%- if page.logo -%} + {%- else -%} + {%- endif -%}
- {%- assign file_parts = page.url | split: '/' | last | split: '.' -%} - {%- assign imp_name = file_parts | last -%} - {%- assign imp_url = imp_name | prepend: '/components/' | append: '/' -%} - -
- -
+ {%- if page.ha_domain -%} +
+ +
+ {%- endif -%} {%- if page.ha_iot_class -%}
@@ -50,9 +48,11 @@
{%- endif -%} -
- Source: {{imp_url}} -
+ {%- if page.ha_domain -%} +
+ Source: View on GitHub +
+ {%- endif -%} {%- if page.ha_category.first -%}
diff --git a/source/_includes/asides/docs_navigation.html b/source/_includes/asides/docs_navigation.html index 7a7e113027b..9ad89018186 100644 --- a/source/_includes/asides/docs_navigation.html +++ b/source/_includes/asides/docs_navigation.html @@ -98,9 +98,6 @@
  • {% active_link /docs/frontend/ Frontend %}
      -
    • - {% active_link /docs/frontend/mobile/ Android/iOS Homescreen %} -
    • {% active_link /docs/frontend/browsers/ Browser Compatibility List %} @@ -270,27 +267,6 @@
    • {% active_link /docs/ecosystem/hadashboard/ HADashboard %}
    • -
    • - {% active_link /docs/ecosystem/notebooks/ Notebooks %} -
        -
      • {% active_link /docs/ecosystem/notebooks/ Introduction %}
      • -
      • - {% active_link /docs/ecosystem/notebooks/installation/ - Installation %} -
      • -
      • {% active_link /docs/ecosystem/notebooks/graph/ Graph %}
      • -
      • - {% active_link /docs/ecosystem/notebooks/api/ Home Assistant API - %} -
      • -
      • - {% active_link /docs/ecosystem/notebooks/database/ Database %} -
      • -
      • - {% active_link /docs/ecosystem/notebooks/stats/ Statistics %} -
      • -
      -
    • Remote access
        @@ -342,10 +318,6 @@
    • {% active_link /docs/ecosystem/synology/ Synology %}
    • -
    • - {% active_link /docs/ecosystem/hass-configurator/ Configurator - %} -
  • diff --git a/source/_includes/asides/lovelace_navigation.html b/source/_includes/asides/lovelace_navigation.html index 705cd522a49..b11dff43f86 100644 --- a/source/_includes/asides/lovelace_navigation.html +++ b/source/_includes/asides/lovelace_navigation.html @@ -17,6 +17,7 @@
  • {% active_link /lovelace/header-footer/ Headers & Footers %}
  • {% active_link /lovelace/yaml-mode/ YAML mode %}
  • {% active_link /lovelace/views/ Views %}
  • +
  • {% active_link /lovelace/actions/ Actions %}
  • Developing Custom Cards
  • diff --git a/source/_includes/custom/grid_item_left.html b/source/_includes/custom/grid_item_left.html index 7a0c0cc563c..3f8f2644cdf 100644 --- a/source/_includes/custom/grid_item_left.html +++ b/source/_includes/custom/grid_item_left.html @@ -12,7 +12,7 @@ Philips Hue - Google Cast + Google Cast MQTT @@ -41,9 +41,6 @@ Arduino -

    Browse all »

    diff --git a/source/_includes/site/header.html b/source/_includes/site/header.html index 7dfba15d6f6..be048105ac8 100644 --- a/source/_includes/site/header.html +++ b/source/_includes/site/header.html @@ -24,7 +24,7 @@ {% endcomment %}
  • Getting started
  • Integrations
  • -
  • Docs
  • +
  • Documentation
  • Examples
  • Blog
  • Need help?
  • @@ -35,7 +35,7 @@ diff --git a/source/_integrations/abode.markdown b/source/_integrations/abode.markdown index 8968168c479..faee4860a86 100644 --- a/source/_integrations/abode.markdown +++ b/source/_integrations/abode.markdown @@ -1,7 +1,6 @@ --- title: Abode description: Instructions on integrating Abode home security with Home Assistant. -logo: abode.jpg ha_category: - Hub - Alarm @@ -17,6 +16,7 @@ ha_iot_class: Cloud Push ha_config_flow: true ha_codeowners: - '@shred86' +ha_domain: abode --- The `abode` integration will allow users to integrate their Abode Home Security systems into Home Assistant and use its alarm system and sensors to automate their homes. @@ -26,12 +26,12 @@ Please visit the [Abode website](https://goabode.com/) for further information a There is currently support for the following device types within Home Assistant: - **Alarm Control Panel**: Reports on the current alarm status and can be used to arm and disarm the system. -- [**Binary Sensor**](/integrations/abode/#binary-sensor): Reports on `Quick Actions`, `Door Contacts`, `Connectivity` sensors (remotes, keypads, and status indicators), `Moisture` sensors, and `Motion` or `Occupancy` sensors. Also lists all Abode `Quick Actions` that are set up. You can trigger these quick actions by passing the `entity_id` of your quick action binary sensor to the [trigger_quick_action service](/integrations/abode/#trigger_quick_action). +- [**Binary Sensor**](/integrations/abode/#binary-sensor): Reports on `Quick Actions`, `Door Contacts`, `Connectivity` sensors (remotes, keypads, and status indicators), `Moisture` sensors, and `Motion` or `Occupancy` sensors. - **Camera**: Reports on `Camera` devices and will download and show the latest captured still image. - **Cover**: Reports on `Secure Barriers` and can be used to open and close the cover. - **Lock**: Reports on `Door Locks` and can be used to lock and unlock the door. - [**Light**](/integrations/abode/#light): Reports on `Dimmer` lights and can be used to dim or turn the light on and off. -- [**Switch**](/integrations/abode/#switch): Reports on `Power Switch` and `Water Valve` devices which can be used to turn the devices on and off. Also reports on `Automations` set up in the Abode system and allows you to activate or deactivate them (does not currently work with Abode's CUE automations). +- [**Switch**](/integrations/abode/#switch): Reports on `Power Switch` and `Water Valve` devices which can be turned on and off. Also reports on `Automations` set up in the Abode system and allows you to activate or deactivate them. - **Sensor**: Reports on `Temperature`, `Humidity`, and `Light` sensors. ## Configuration @@ -92,7 +92,7 @@ Field | Description `event_type` | The type of the event. `event_utc` | The UTC timestamp of the event. `user_name` | The Abode user that triggered the event, if applicable. -`app_type` | The Abode app that triggered the event (e.g. web app, iOS app, etc.). +`app_type` | The Abode app that triggered the event (e.g., web app, iOS app, etc.). `event_by` | The keypad user that triggered the event. `date` | The date of the event in the format `MM/DD/YYYY`. `time` | The time of the event in the format `HH:MM AM`. @@ -121,10 +121,10 @@ Request a new still image from your Abode IR camera. | ---------------------- | -------- | ----------- | | `entity_id` | No | String or list of strings that point at `entity_id`s of Abode cameras. -### Service `trigger_quick_action` +### Service `trigger_automation` -Trigger a quick action automation on your Abode system. +Trigger an automation on your Abode system. | Service data attribute | Optional | Description | | ---------------------- | -------- | ----------- | -| `entity_id` | No | String or list of strings that point at `entity_id`s of binary_sensors that represent your Abode quick actions. +| `entity_id` | No | String or list of strings that point at `entity_id`s of switches that represent your Abode automations. diff --git a/source/_integrations/acer_projector.markdown b/source/_integrations/acer_projector.markdown index 04acb894d93..8827d545383 100644 --- a/source/_integrations/acer_projector.markdown +++ b/source/_integrations/acer_projector.markdown @@ -1,11 +1,11 @@ --- title: Acer Projector description: Instructions on how to integrate Acer Projector switches into Home Assistant. -logo: acer.png ha_category: - Multimedia ha_iot_class: Local Polling ha_release: 0.19 +ha_domain: acer_projector --- The `acer_projector` switch platform allows you to control the state of RS232 connected projectors from [Acer](https://www.acer.com/). diff --git a/source/_integrations/actiontec.markdown b/source/_integrations/actiontec.markdown index ba8cae59d30..1cf78c72d1a 100644 --- a/source/_integrations/actiontec.markdown +++ b/source/_integrations/actiontec.markdown @@ -5,6 +5,7 @@ logo: actiontec.png ha_category: - Presence Detection ha_release: 0.7 +ha_domain: actiontec --- This platform allows you to detect presence by looking at connected devices to an [Actiontec](https://www.actiontec.com/) device. diff --git a/source/_integrations/adguard.markdown b/source/_integrations/adguard.markdown index 5b5a4bc66a4..4eb15a9a351 100644 --- a/source/_integrations/adguard.markdown +++ b/source/_integrations/adguard.markdown @@ -1,7 +1,6 @@ --- title: AdGuard Home description: Instructions on how to integrate AdGuard Home with Home Assistant. -logo: adguard.png ha_category: - Network - Sensor @@ -11,6 +10,7 @@ ha_iot_class: Local Polling ha_config_flow: true ha_codeowners: - '@frenck' +ha_domain: adguard --- AdGuard Home is a network-wide ad- and tracker-blocking DNS server with parental diff --git a/source/_integrations/ads.markdown b/source/_integrations/ads.markdown index cd19f4a938b..de369c735ac 100644 --- a/source/_integrations/ads.markdown +++ b/source/_integrations/ads.markdown @@ -11,6 +11,7 @@ ha_category: - Cover ha_release: '0.60' ha_iot_class: Local Push +ha_domain: ads --- The ADS (automation device specification) describes a device-independent and fieldbus independent interface for communication between [Beckhoff](https://www.beckhoff.com/) automation devices running [TwinCAT](https://www.beckhoff.hu/english.asp?twincat/default.htm) and other devices implementing this interface. diff --git a/source/_integrations/aftership.markdown b/source/_integrations/aftership.markdown index f8192a42004..7f1a7942356 100644 --- a/source/_integrations/aftership.markdown +++ b/source/_integrations/aftership.markdown @@ -1,11 +1,11 @@ --- title: AfterShip description: Instructions on how to set up AfterShip sensors within Home Assistant. -logo: aftership.png ha_category: - Postal Service ha_release: 0.85 ha_iot_class: Cloud Polling +ha_domain: aftership --- The `aftership` platform allows one to track deliveries by [AfterShip](https://www.aftership.com), a service that supports 490+ couriers worldwide. It is free to use up to 100 tracked packages per month, after that there is a fee. @@ -49,7 +49,7 @@ api_key: | Service data attribute | Required | Type | Description | | ---------------------- | -------- | -------- | ----------- | | `tracking_number` | `True` | string | Tracking number -| `slug` | `False` | string | Carrier e.g. `fedex` +| `slug` | `False` | string | Carrier e.g., `fedex` | `title` | `False` | string | Friendly name of package ## Service `remove_tracking` @@ -59,7 +59,7 @@ api_key: | Service data attribute | Required | Type | Description | | ---------------------- | -------- | -------- | ----------- | | `tracking_number` | `True` | string | Tracking number -| `slug` | `True` | string | Carrier e.g. `fedex` +| `slug` | `True` | string | Carrier e.g., `fedex`
    This integration retrieves data from AfterShip public REST API, but the integration is not affiliated with AfterShip. diff --git a/source/_integrations/air_quality.markdown b/source/_integrations/air_quality.markdown index 3fe9bfa5c90..b88225b8258 100644 --- a/source/_integrations/air_quality.markdown +++ b/source/_integrations/air_quality.markdown @@ -2,6 +2,7 @@ title: Air Quality description: Instructions on how to add air quality sensors with Home Assistant ha_release: 0.85 +ha_domain: air_quality --- The `air_quality` gather information about the air quality and pollution details. diff --git a/source/_integrations/air_quality.xiaomi_miio.markdown b/source/_integrations/air_quality.xiaomi_miio.markdown index 0cedb56be44..270d0841153 100644 --- a/source/_integrations/air_quality.xiaomi_miio.markdown +++ b/source/_integrations/air_quality.xiaomi_miio.markdown @@ -1,11 +1,11 @@ --- title: "Xiaomi Air Quality Monitor" description: "Instructions how to integrate your Xiaomi Mi Air Quality Monitor within Home Assistant." -logo: xiaomi.png ha_category: - Health ha_iot_class: Local Polling ha_release: 0.102 +ha_domain: xiaomi_miio --- The `xiaomi_miio` sensor platform is observing your Xiaomi Mi Air Quality Monitor and reporting the air quality values. diff --git a/source/_integrations/airly.markdown b/source/_integrations/airly.markdown index c386f7d2e27..6dee218c8fd 100644 --- a/source/_integrations/airly.markdown +++ b/source/_integrations/airly.markdown @@ -1,7 +1,6 @@ --- title: Airly description: Instructions on how to integrate Airly within Home Assistant. -logo: airly.png ha_category: - Health ha_release: 0.101 @@ -9,6 +8,7 @@ ha_iot_class: Cloud Polling ha_config_flow: true ha_codeowners: - '@bieniu' +ha_domain: airly --- The `airly` integration uses the [Airly](https://airly.eu/) web service as a source for air quality data for your location. diff --git a/source/_integrations/airvisual.markdown b/source/_integrations/airvisual.markdown index 74c6595e11f..ce182395af7 100644 --- a/source/_integrations/airvisual.markdown +++ b/source/_integrations/airvisual.markdown @@ -1,16 +1,16 @@ --- title: AirVisual description: Instructions on how to use AirVisual data within Home Assistant -logo: airvisual.jpg ha_category: - Health ha_release: 0.53 ha_iot_class: Cloud Polling ha_codeowners: - '@bachya' +ha_domain: airvisual --- -The `airvisual` sensor platform queries the [AirVisual](https://airvisual.com/) API for air quality data. Data can be collected via latitude/longitude or by city/state/country. The resulting information creates sensors for the Air Quality Index (AQI), the human-friendly air quality level, and the main pollutant of that area. Sensors that conform to either/both the [U.S. and Chinese air quality standards](https://www.clm.com/publication.cfm?ID=366) can be created. +The `airvisual` sensor platform queries the [AirVisual](https://airvisual.com/) API for air quality data. Data can be collected via latitude/longitude or by city/state/country. The resulting information creates sensors for the Air Quality Index (AQI), the human-friendly air quality level, and the main pollutant of that area. Sensors that conform to either/both the [U.S. and Chinese air quality standards](https://www.clm.com/publication.cfm?ID=366) are created. This platform requires an AirVisual API key, which can be obtained [here](https://airvisual.com/api). Note that the platform was designed using the "Community" package; the "Startup" and "Enterprise" package keys should continue to function, but actual results may vary (or not work at all). @@ -18,7 +18,7 @@ The Community API key is valid for 12 months after which it will expire. You mus
    -The "Community" API key is limited to 10,000 calls per month. In order to leave a buffer, the `airvisual` platform queries the API every 10 minutes (600 seconds) by default. Modification of this (via the `scan_interval` key) to a too-low value may result in your API key being deactivated. +The "Community" API key is limited to 10,000 calls per month. In order to leave a buffer, the `airvisual` platform queries the API every 10 minutes (600 seconds) by default. Note that each item in the `geographies` list will consume an API call with each update.
    @@ -27,8 +27,7 @@ The "Community" API key is limited to 10,000 calls per month. In order to leave To enable the platform and gather data via latitude/longitude, add the following lines to your `configuration.yaml` file: ```yaml -sensor: - - platform: airvisual +airvisual: api_key: YOUR_AIRVISUAL_API_KEY ``` @@ -37,74 +36,74 @@ api_key: description: Your AirVisual API key. required: true type: string -monitored_conditions: - description: "The air quality standard(s) to use (`us` for U.S., `cn` for Chinese)." - required: true - type: list - default: ['us', 'cn'] -show_on_map: - description: "Whether to show a marker on the map at the specified location." +geographies: + description: A list of geographical locations to monitor required: false - type: boolean - default: true -scan_interval: - description: "The rate in seconds at which AirVisual should be polled for new data." - required: false - type: integer - default: 600 -latitude: - description: The latitude of the location to monitor. - required: false - type: string - default: "The latitude defined under the `homeassistant` key in `configuration.yaml`." -longitude: - description: The longitude of the location to monitor. - required: false - type: string - default: "The longitude defined under the `homeassistant` key in `configuration.yaml`." -city: - description: The city to monitor. - required: false - type: string -state: - description: The state the city belongs to. - required: false - type: string -country: - description: The country the state belongs to. - required: false - type: string + type: [list, map] + keys: + latitude: + description: The latitude of the location to monitor. + required: inclusive + type: float + longitude: + description: The longitude of the location to monitor. + required: inclusive + type: float + city: + description: The city to monitor. + required: inclusive + type: string + state: + description: The state the city belongs to. + required: inclusive + type: string + country: + description: The country the state belongs to. + required: inclusive + type: string {% endconfiguration %} ## Example Configurations -Configuration using custom Latitude and Longitude: +No explicit configuration (uses the `latitude` and `longitude` defined within `configuration.yaml`): ```yaml -sensor: - - platform: airvisual +airvisual: api_key: YOUR_AIRVISUAL_API_KEY - monitored_conditions: - - cn - show_on_map: false - scan_interval: 300 - latitude: 42.81212 - longitude: 108.12422 ``` -Configuration using city, state, and country: +Configuration using a single custom latitude and longitude: ```yaml -sensor: - - platform: airvisual +airvisual: api_key: YOUR_AIRVISUAL_API_KEY - monitored_conditions: - - us - show_on_map: false + geographies: + latitude: 42.81212 + longitude: 108.12422 scan_interval: 300 - city: Los Angeles - state: California - country: USA +``` + +Configuration using multiple custom latitude and longitude pairs: + +```yaml +airvisual: + api_key: YOUR_AIRVISUAL_API_KEY + geographies: + - latitude: 42.81212 + longitude: 108.12422 + - latitude: 32.87336 + longitude: -117.22743 +``` + +Configuration using a single city, state, and country: + +```yaml +airvisual: + api_key: YOUR_AIRVISUAL_API_KEY + geographies: + city: Los Angeles + state: California + country: USA ``` ## Determining the City/State/Country @@ -114,20 +113,17 @@ To easily determine the proper values for a particular location, use the [AirVis For example, Sao Paulo, Brazil shows a breadcrumb title of `Brazil > Sao Paulo > Sao Paulo`. Thus, the proper configuration would look like this: ```yaml -sensor: - - platform: airvisual - api_key: abc123 - monitored_conditions: - - us - - cn - city: sao-paulo - state: sao-paulo - country: brazil +airvisual: + api_key: YOUR_AIRVISUAL_API_KEY + geographies: + city: sao-paulo + state: sao-paulo + country: brazil ``` ## Sensor Types -When configured, the platform will create three sensors for each configured air quality standard: +When configured, the platform will create three sensors for each air quality standard: ### Air Quality Index diff --git a/source/_integrations/aladdin_connect.markdown b/source/_integrations/aladdin_connect.markdown index 4dc5b4ebef6..71735d6b6dc 100644 --- a/source/_integrations/aladdin_connect.markdown +++ b/source/_integrations/aladdin_connect.markdown @@ -6,6 +6,7 @@ ha_category: - Cover ha_release: 0.75 ha_iot_class: Cloud Polling +ha_domain: aladdin_connect --- The `aladdin_connect` cover platform lets you control Genie Aladdin Connect garage doors through Home Assistant. diff --git a/source/_integrations/alarm_control_panel.ifttt.markdown b/source/_integrations/alarm_control_panel.ifttt.markdown index 0fcf7f4049a..9900fbfc711 100644 --- a/source/_integrations/alarm_control_panel.ifttt.markdown +++ b/source/_integrations/alarm_control_panel.ifttt.markdown @@ -1,10 +1,10 @@ --- title: "IFTTT Alarm Control Panel" description: "Instructions on how to integrate IFTTT-controlled security systems into Home Assistant." -logo: ifttt.png ha_category: - Alarm ha_release: 0.66 +ha_domain: ifttt --- The `ifttt` platform allows you to integrate security systems that have no open API but can be controlled through [IFTTT](https://ifttt.com/discover). diff --git a/source/_integrations/alarm_control_panel.markdown b/source/_integrations/alarm_control_panel.markdown index ca03123b592..f2d52d2aafd 100644 --- a/source/_integrations/alarm_control_panel.markdown +++ b/source/_integrations/alarm_control_panel.markdown @@ -1,11 +1,11 @@ --- title: Alarm Control Panel description: Instructions on how to integrate Alarm Control Panels into Home Assistant. -logo: home-assistant.png ha_category: - Alarm ha_release: 0.7.3 ha_quality_scale: internal +ha_domain: alarm_control_panel --- Home Assistant can give you an interface which is similar to a classic alarm system. diff --git a/source/_integrations/alarm_control_panel.mqtt.markdown b/source/_integrations/alarm_control_panel.mqtt.markdown index 32423b8b6ed..0f5fee56b7d 100644 --- a/source/_integrations/alarm_control_panel.mqtt.markdown +++ b/source/_integrations/alarm_control_panel.mqtt.markdown @@ -1,11 +1,11 @@ --- title: "MQTT Alarm Control Panel" description: "Instructions on how to integrate MQTT capable Alarm Panels into Home Assistant." -logo: mqtt.png ha_category: - Alarm ha_release: 0.7.4 ha_iot_class: Configurable +ha_domain: mqtt --- The `mqtt` alarm panel platform enables the possibility to control MQTT capable alarm panels. The Alarm icon will change state after receiving a new state from `state_topic`. If these messages are published with *RETAIN* flag, the MQTT alarm panel will receive an instant state update after subscription and will start with the correct state. Otherwise, the initial state will be `unknown`. @@ -34,57 +34,10 @@ alarm_control_panel: ``` {% configuration %} -name: - description: The name of the alarm. +availability_topic: + description: The MQTT topic subscribed to receive availability (online/offline) updates. required: false type: string - default: MQTT Alarm -unique_id: - description: An ID that uniquely identifies this alarm panel. If two alarm panels have the same unique ID, Home Assistant will raise an exception. - required: false - type: string -state_topic: - description: The MQTT topic subscribed to receive state updates. - required: true - type: string -command_topic: - description: The MQTT topic to publish commands to change the alarm state. - required: true - type: string -command_template: - description: "The [template](/docs/configuration/templating/#processing-incoming-data) used for the command payload. Available variables: `action` and `code`." - required: false - type: string - default: action -value_template: - description: "Defines a [template](/docs/configuration/templating/#processing-incoming-data) to extract the value." - required: false - type: template -qos: - description: The maximum QoS level of the state topic. - required: false - type: integer - default: 0 -payload_disarm: - description: The payload to disarm your Alarm Panel. - required: false - type: string - default: DISARM -payload_arm_home: - description: The payload to set armed-home mode on your Alarm Panel. - required: false - type: string - default: ARM_HOME -payload_arm_away: - description: The payload to set armed-away mode on your Alarm Panel. - required: false - type: string - default: ARM_AWAY -payload_arm_night: - description: The payload to set armed-night mode on your Alarm Panel. - required: false - type: string - default: ARM_NIGHT code: description: If defined, specifies a code to enable or disable the alarm in the frontend. required: false @@ -99,41 +52,28 @@ code_disarm_required: required: false type: boolean default: true -availability_topic: - description: The MQTT topic subscribed to receive availability (online/offline) updates. +command_template: + description: "The [template](/docs/configuration/templating/#processing-incoming-data) used for the command payload. Available variables: `action` and `code`." required: false type: string -payload_available: - description: The payload that represents the available state. - required: false + default: action +command_topic: + description: The MQTT topic to publish commands to change the alarm state. + required: true type: string - default: online -payload_not_available: - description: The payload that represents the unavailable state. - required: false - type: string - default: offline -json_attributes_topic: - description: The MQTT topic subscribed to receive a JSON dictionary payload and then set as sensor attributes. Usage example can be found in [MQTT sensor](/integrations/sensor.mqtt/#json-attributes-topic-configuration) documentation. - required: false - type: string -json_attributes_template: - description: "Defines a [template](/docs/configuration/templating/#processing-incoming-data) to extract the JSON dictionary from messages received on the `json_attributes_topic`. Usage example can be found in [MQTT sensor](/integrations/sensor.mqtt/#json-attributes-template-configuration) documentation." - required: false - type: template device: description: 'Information about the device this alarm panel is a part of to tie it into the [device registry](https://developers.home-assistant.io/docs/en/device_registry_index.html). Only works through [MQTT discovery](/docs/mqtt/discovery/) and when [`unique_id`](#unique_id) is set.' required: false type: map keys: - identifiers: - description: 'A list of IDs that uniquely identify the device. For example a serial number.' - required: false - type: [list, string] connections: description: 'A list of connections of the device to the outside world as a list of tuples `[connection_type, connection_identifier]`. For example the MAC address of a network interface: `"connections": [["mac", "02:5b:26:a8:dc:12"]]`.' required: false type: list + identifiers: + description: 'A list of IDs that uniquely identify the device. For example a serial number.' + required: false + type: [list, string] manufacturer: description: 'The manufacturer of the device.' required: false @@ -150,4 +90,64 @@ device: description: 'The firmware version of the device.' required: false type: string +json_attributes_template: + description: "Defines a [template](/docs/configuration/templating/#processing-incoming-data) to extract the JSON dictionary from messages received on the `json_attributes_topic`. Usage example can be found in [MQTT sensor](/integrations/sensor.mqtt/#json-attributes-template-configuration) documentation." + required: false + type: template +json_attributes_topic: + description: The MQTT topic subscribed to receive a JSON dictionary payload and then set as sensor attributes. Usage example can be found in [MQTT sensor](/integrations/sensor.mqtt/#json-attributes-topic-configuration) documentation. + required: false + type: string +name: + description: The name of the alarm. + required: false + type: string + default: MQTT Alarm +payload_arm_away: + description: The payload to set armed-away mode on your Alarm Panel. + required: false + type: string + default: ARM_AWAY +payload_arm_home: + description: The payload to set armed-home mode on your Alarm Panel. + required: false + type: string + default: ARM_HOME +payload_arm_night: + description: The payload to set armed-night mode on your Alarm Panel. + required: false + type: string + default: ARM_NIGHT +payload_available: + description: The payload that represents the available state. + required: false + type: string + default: online +payload_disarm: + description: The payload to disarm your Alarm Panel. + required: false + type: string + default: DISARM +payload_not_available: + description: The payload that represents the unavailable state. + required: false + type: string + default: offline +qos: + description: The maximum QoS level of the state topic. + required: false + type: integer + default: 0 +state_topic: + description: The MQTT topic subscribed to receive state updates. + required: true + type: string +unique_id: + description: An ID that uniquely identifies this alarm panel. If two alarm panels have the same unique ID, Home Assistant will raise an exception. + required: false + type: string +value_template: + description: "Defines a [template](/docs/configuration/templating/#processing-incoming-data) to extract the value." + required: false + type: template {% endconfiguration %} diff --git a/source/_integrations/alarm_control_panel.template.markdown b/source/_integrations/alarm_control_panel.template.markdown index c4b1ed0a97a..896be69bd45 100644 --- a/source/_integrations/alarm_control_panel.template.markdown +++ b/source/_integrations/alarm_control_panel.template.markdown @@ -5,8 +5,8 @@ ha_category: - Alarm ha_release: 0.105 ha_iot_class: "Local Push" -logo: home-assistant.png ha_qa_scale: internal +ha_domain: template --- The `template` integrations creates alarm control panels that combine integrations or adds pre-processing logic to actions. diff --git a/source/_integrations/alarmdecoder.markdown b/source/_integrations/alarmdecoder.markdown index d1fcc1aed93..4f34e36f8a8 100644 --- a/source/_integrations/alarmdecoder.markdown +++ b/source/_integrations/alarmdecoder.markdown @@ -8,6 +8,7 @@ ha_category: - Sensor ha_release: 0.43 ha_iot_class: Local Push +ha_domain: alarmdecoder --- The `alarmdecoder` integration will allow Home Assistant users who own either a DSC or Honeywell alarm panel to leverage their alarm system and its sensors to provide Home Assistant with rich information about their homes. Connectivity between Home Assistant and the alarm panel is accomplished through a device produced by Nu Tech Software Solutions, known as the AlarmDecoder. The AlarmDecoder devices provide a serial, TCP/IP socket or USB interface to the alarm panel, where it emulates an alarm keypad. @@ -86,7 +87,7 @@ autobypass: default: false type: boolean zones: - description: "AlarmDecoder has no way to tell us which zones are actually in use, so each zone must be configured in Home Assistant. For each zone, at least a name must be given. For more information on the available zone types, take a look at the [Binary Sensor](/integrations/alarmdecoder) docs. *Note: If no zones are specified, Home Assistant will not load any binary_sensor integrations.*" + description: "AlarmDecoder has no way to tell us which zones are actually in use, so each zone must be configured in Home Assistant. For each zone, at least a name must be given. For more information on the available zone types, take a look at the [Binary Sensor](/integrations/alarmdecoder) documentation. *Note: If no zones are specified, Home Assistant will not load any binary_sensor integrations.*" required: false type: list keys: diff --git a/source/_integrations/alarmdotcom.markdown b/source/_integrations/alarmdotcom.markdown index ffc1bfe73c9..691b952bfe4 100644 --- a/source/_integrations/alarmdotcom.markdown +++ b/source/_integrations/alarmdotcom.markdown @@ -5,6 +5,7 @@ logo: alarmdotcom.png ha_category: - Alarm ha_release: 0.11 +ha_domain: alarmdotcom --- The `alarmdotcom` platform is consuming the information provided by [Alarm.com](https://www.alarm.com/). diff --git a/source/_integrations/alert.markdown b/source/_integrations/alert.markdown index 751584342d8..a8f75b5db61 100644 --- a/source/_integrations/alert.markdown +++ b/source/_integrations/alert.markdown @@ -1,11 +1,11 @@ --- title: Alert description: Instructions on how to setup automatic alerts within Home Assistant. -logo: home-assistant.png ha_category: - Automation ha_release: 0.38 ha_quality_scale: internal +ha_domain: alert --- The `alert` integration is designed to notify you when problematic issues arise. @@ -247,8 +247,8 @@ alert: - 15 - 30 - 60 - can_acknowledge: True # Optional, default is True - skip_first: True # Optional, false is the default + can_acknowledge: true # Optional, default is true + skip_first: true # Optional, false is the default data: inline_keyboard: - 'Close garage:/close_garage, Acknowledge:/garage_acknowledge' diff --git a/source/_integrations/alexa.flash_briefings.markdown b/source/_integrations/alexa.flash_briefings.markdown index e8fd786621f..966a80f001c 100644 --- a/source/_integrations/alexa.flash_briefings.markdown +++ b/source/_integrations/alexa.flash_briefings.markdown @@ -1,10 +1,10 @@ --- title: "Amazon Alexa Flash Briefing" description: "Instructions on how to create your Flash Briefing skills with Home Assistant." -logo: amazon-alexa.png ha_category: - Voice ha_release: "0.31" +ha_domain: alexa --- ## Flash Briefing Skills diff --git a/source/_integrations/alexa.intent.markdown b/source/_integrations/alexa.intent.markdown index 1349c9c55b8..958dac99412 100644 --- a/source/_integrations/alexa.intent.markdown +++ b/source/_integrations/alexa.intent.markdown @@ -1,10 +1,10 @@ --- title: "Amazon Alexa Custom Skill" description: "Instructions on how to build your Alexa/Amazon Echo custom commands to connect with Home Assistant." -logo: amazon-alexa.png ha_category: - Voice ha_release: "0.10" +ha_domain: alexa --- ## I want to build custom commands to use with Echo diff --git a/source/_integrations/alexa.markdown b/source/_integrations/alexa.markdown index 054ef92f738..634767b3a31 100644 --- a/source/_integrations/alexa.markdown +++ b/source/_integrations/alexa.markdown @@ -1,7 +1,6 @@ --- title: Amazon Alexa description: Instructions on how to connect Alexa/Amazon Echo to Home Assistant. -logo: amazon-alexa.png ha_category: - Voice featured: true @@ -9,6 +8,7 @@ ha_release: '0.10' ha_codeowners: - '@home-assistant/cloud' - '@ochlocracy' +ha_domain: alexa --- ## Automatic setup via Home Assistant Cloud diff --git a/source/_integrations/alexa.smart_home.markdown b/source/_integrations/alexa.smart_home.markdown index cb8690c9482..13935cca955 100644 --- a/source/_integrations/alexa.smart_home.markdown +++ b/source/_integrations/alexa.smart_home.markdown @@ -1,13 +1,13 @@ --- title: "Amazon Alexa Smart Home Skill" description: "Instructions on how to build Smart Home skill to connect Amazon Alexa with Home Assistant." -logo: amazon-alexa.png ha_category: - Voice ha_release: "0.54" ha_codeowners: - '@home-assistant/cloud' - '@ochlocracy' +ha_domain: alexa --- Amazon Alexa provides a Smart Home API for richer home automation control without requiring the user to say the skill name, such as: @@ -67,7 +67,7 @@ Steps to Integrate an Amazon Alexa Smart Home Skill with Home Assistant: ## Create an AWS Lambda Function -Alexa Smart Home skill will trigger a AWS Lambda function to process the request, we will write a small piece of code hosted as an Lambda function basically redirect the request to your Home Assistant instance, then Alexa integration integration in Home Assistant will process the request and send back the response. Your Lambda function will delivery the response back to Alexa. +Alexa Smart Home skill will trigger a AWS Lambda function to process the request, we will write a small piece of code hosted as an Lambda function basically redirect the request to your Home Assistant instance, then Alexa integration integration in Home Assistant will process the request and send back the response. Your Lambda function will deliver the response back to Alexa.
    @@ -340,7 +340,7 @@ See [List of Capability Interfaces and Supported Locales][alexa-supported-locale ### Proactive Events -The `endpoint`, `client_id` and `client_secret` are optional, and are only required if you want to enable Alexa's proactive mode (i.e. "Send Alexa Events" enabled). Please note the following if you want to enable proactive mode: +The `endpoint`, `client_id` and `client_secret` are optional, and are only required if you want to enable Alexa's proactive mode (i.e., "Send Alexa Events" enabled). Please note the following if you want to enable proactive mode: - There are different endpoint URLs, depending on the region of your skill. Please check the available endpoints at - The `client_id` and `client_secret` are not the ones used by the skill that have been set up using "Login with Amazon" (in the [Alexa Developer Console][amazon-dev-console]: Build > Account Linking), but rather from the "Alexa Skill Messaging" (in the Alexa Developer Console: Build > Permissions > Alexa Skill Messaging). To get them, you need to enable the "Send Alexa Events" permission. diff --git a/source/_integrations/almond.markdown b/source/_integrations/almond.markdown index 9e9cbcff396..041b13d0a77 100644 --- a/source/_integrations/almond.markdown +++ b/source/_integrations/almond.markdown @@ -1,7 +1,6 @@ --- title: Almond description: Instructions on how to setup Almond within Home Assistant. -logo: almond.png ha_category: - Voice ha_iot_class: Local Polling @@ -10,6 +9,7 @@ ha_config_flow: true ha_codeowners: - '@gcampax' - '@balloob' +ha_domain: almond --- [Almond](https://almond.stanford.edu/) is an open, privacy-preserving virtual assistant by [Stanford Open Virtual Assistant Lab](https://oval.cs.stanford.edu/). It allows you, among other things, to control Home Assistant using natural language. Once installed, it will be available on Lovelace via the microphone icon in the top right. diff --git a/source/_integrations/alpha_vantage.markdown b/source/_integrations/alpha_vantage.markdown index 69348b874b0..f79d83adb9b 100644 --- a/source/_integrations/alpha_vantage.markdown +++ b/source/_integrations/alpha_vantage.markdown @@ -8,6 +8,7 @@ ha_iot_class: Cloud Polling ha_release: '0.60' ha_codeowners: - '@fabaff' +ha_domain: alpha_vantage --- The `alpha_vantage` sensor platform uses [Alpha Vantage](https://www.alphavantage.co) to monitor the stock market. This platform also provides detail about exchange rates. diff --git a/source/_integrations/amazon_polly.markdown b/source/_integrations/amazon_polly.markdown index 46c4f65e3f4..60c3cbc8373 100644 --- a/source/_integrations/amazon_polly.markdown +++ b/source/_integrations/amazon_polly.markdown @@ -1,12 +1,12 @@ --- title: Amazon Polly description: Instructions on how to setup Amazon Polly with Home Assistant. -logo: polly.png ha_category: - Text-to-speech ha_release: 0.37 ha_codeowners: - '@robbiet480' +ha_domain: amazon_polly --- The `amazon_polly` text-to-speech platform that works with [Amazon Polly](https://aws.amazon.com/polly/) to create the spoken output. diff --git a/source/_integrations/ambiclimate.markdown b/source/_integrations/ambiclimate.markdown index 807e1739ba7..e83cfe321d4 100644 --- a/source/_integrations/ambiclimate.markdown +++ b/source/_integrations/ambiclimate.markdown @@ -8,12 +8,13 @@ ha_iot_class: Cloud Polling ha_config_flow: true ha_codeowners: - '@danielhiversen' +ha_domain: ambiclimate --- Integrates [Ambiclimate](https://ambiclimate.com/) Air Conditioning controller into Home Assistant. You must create an application [here](https://api.ambiclimate.com/clients) to obtain a `client_id` and `client_secret`. -The `callback url` should be configured as your Home Assistant `base_url` + `/api/ambiclimate`, e.g. `https://example.com/api/ambiclimate`. +The `callback url` should be configured as your Home Assistant `base_url` + `/api/ambiclimate`, e.g., `https://example.com/api/ambiclimate`. To enable this platform, add the following lines to your `configuration.yaml` file: diff --git a/source/_integrations/ambient_station.markdown b/source/_integrations/ambient_station.markdown index c2c3c9eb364..ba949e6f627 100644 --- a/source/_integrations/ambient_station.markdown +++ b/source/_integrations/ambient_station.markdown @@ -9,6 +9,7 @@ ha_iot_class: Cloud Push ha_config_flow: true ha_codeowners: - '@bachya' +ha_domain: ambient_station --- The `Ambient Weather Station` integration retrieves local weather information diff --git a/source/_integrations/amcrest.markdown b/source/_integrations/amcrest.markdown index 595e6347f23..a12798a46e1 100644 --- a/source/_integrations/amcrest.markdown +++ b/source/_integrations/amcrest.markdown @@ -11,6 +11,7 @@ ha_iot_class: Local Polling ha_release: 0.49 ha_codeowners: - '@pnbruckner' +ha_domain: amcrest --- The `amcrest` camera platform allows you to integrate your [Amcrest](https://amcrest.com/) IP camera in Home Assistant. diff --git a/source/_integrations/ampio.markdown b/source/_integrations/ampio.markdown index 6588dc4cf0e..b0400fa639f 100644 --- a/source/_integrations/ampio.markdown +++ b/source/_integrations/ampio.markdown @@ -7,6 +7,7 @@ ha_category: - Sensor ha_release: 0.92 ha_iot_class: Cloud Polling +ha_domain: ampio --- The `ampio` air quality platform will query the open data API of [ampio.pl](http://smog1.ampio.pl:3050/) to monitor air quality sensor station. diff --git a/source/_integrations/android_ip_webcam.markdown b/source/_integrations/android_ip_webcam.markdown index f6a72df1301..4350bb8db79 100644 --- a/source/_integrations/android_ip_webcam.markdown +++ b/source/_integrations/android_ip_webcam.markdown @@ -1,7 +1,6 @@ --- title: Android IP Webcam description: Connect Android devices as an IP webcam to Home Assistant -logo: android_ip_webcam.png ha_category: - Hub - Binary Sensor @@ -10,6 +9,7 @@ ha_category: - Switch ha_release: '0.40' ha_iot_class: Local Polling +ha_domain: android_ip_webcam --- The `android_ip_webcam` integration turns any Android phone or tablet into a network camera with multiple viewing options. diff --git a/source/_integrations/androidtv.markdown b/source/_integrations/androidtv.markdown index 8bf346be58e..7dd2e517110 100644 --- a/source/_integrations/androidtv.markdown +++ b/source/_integrations/androidtv.markdown @@ -1,13 +1,13 @@ --- title: Android TV description: Instructions on how to integrate Android TV and Fire TV devices into Home Assistant. -logo: androidtv.png ha_category: - Media Player ha_release: 0.7.6 ha_iot_class: Local Polling ha_codeowners: - '@JeffLIrion' +ha_domain: androidtv --- The `androidtv` platform allows you to control an Android TV device or [Amazon Fire TV](https://www.amazon.com/b/?node=8521791011) device. diff --git a/source/_integrations/anel_pwrctrl.markdown b/source/_integrations/anel_pwrctrl.markdown index 509b449b4e5..91d2022aa86 100644 --- a/source/_integrations/anel_pwrctrl.markdown +++ b/source/_integrations/anel_pwrctrl.markdown @@ -6,6 +6,7 @@ ha_category: - Switch ha_iot_class: Local Polling ha_release: '0.30' +ha_domain: anel_pwrctrl --- The `anel_pwrctrl` switch platform allows you to control [ANEL PwrCtrl](https://anel-elektronik.de/SITE/produkte/produkte.htm) devices. diff --git a/source/_integrations/anthemav.markdown b/source/_integrations/anthemav.markdown index 9662b62512e..aa3a533984e 100644 --- a/source/_integrations/anthemav.markdown +++ b/source/_integrations/anthemav.markdown @@ -6,6 +6,7 @@ ha_category: - Media Player ha_iot_class: Local Push ha_release: 0.37 +ha_domain: anthemav --- Both [Anthem]'s current and last generation of A/V Receivers and Processors support IP-based, network control. This Home Assistant platform adds proper "local push" support for any of these receivers on your network. diff --git a/source/_integrations/apache_kafka.markdown b/source/_integrations/apache_kafka.markdown index 51e3325b3b6..9258d1b2802 100644 --- a/source/_integrations/apache_kafka.markdown +++ b/source/_integrations/apache_kafka.markdown @@ -1,12 +1,12 @@ --- title: Apache Kafka description: Send data and events to Apache Kafka. -logo: apache_kafka.png ha_category: - History ha_release: 0.97 ha_codeowners: - '@bachya' +ha_domain: apache_kafka --- The `apache_kafka` integration sends all state changes to a diff --git a/source/_integrations/apcupsd.markdown b/source/_integrations/apcupsd.markdown index 64350610ea0..d431750be82 100644 --- a/source/_integrations/apcupsd.markdown +++ b/source/_integrations/apcupsd.markdown @@ -1,6 +1,6 @@ --- -title: APCUPSd -description: Instructions on how to integrate APCUPSd status with Home Assistant. +title: apcupsd +description: Instructions on how to integrate apcupsd status with Home Assistant. logo: apcupsd.png ha_category: - System Monitor @@ -8,6 +8,7 @@ ha_category: - Sensor ha_release: 0.13 ha_iot_class: Local Polling +ha_domain: apcupsd --- [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. diff --git a/source/_integrations/api.markdown b/source/_integrations/api.markdown index 178ed30aded..a2ac0becc0c 100644 --- a/source/_integrations/api.markdown +++ b/source/_integrations/api.markdown @@ -1,13 +1,13 @@ --- title: Home Assistant API description: Instructions on how to setup the RESTful API within Home Assistant. -logo: home-assistant.png ha_category: - Other ha_release: 0.7 ha_quality_scale: internal ha_codeowners: - '@home-assistant/core' +ha_domain: api --- 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/). diff --git a/source/_integrations/apns.markdown b/source/_integrations/apns.markdown index e2cd6d2746d..d32bcca86a4 100644 --- a/source/_integrations/apns.markdown +++ b/source/_integrations/apns.markdown @@ -1,10 +1,10 @@ --- title: Apple Push Notification Service (APNS) description: Instructions on how to add APNS notifications to Home Assistant. -logo: apple.png ha_category: - Notifications ha_release: 0.31 +ha_domain: apns --- The `apns` platform uses the Apple Push Notification service (APNS) to deliver notifications from Home Assistant. diff --git a/source/_integrations/apple_tv.markdown b/source/_integrations/apple_tv.markdown index ff640007295..881314f5aac 100644 --- a/source/_integrations/apple_tv.markdown +++ b/source/_integrations/apple_tv.markdown @@ -1,13 +1,13 @@ --- title: Apple TV description: Instructions on how to integrate Apple TV devices into Home Assistant. -logo: apple.png ha_category: - Multimedia - Media Player - Remote ha_iot_class: Local Push ha_release: 0.49 +ha_domain: apple_tv --- The `apple_tv` platform allows you to control an Apple TV (3rd and 4th generation). See the [remote platform](/integrations/apple_tv#remote) if you want to send remote control buttons, e.g., arrow keys. diff --git a/source/_integrations/apprise.markdown b/source/_integrations/apprise.markdown index e30a954ee75..0a1b2cad284 100644 --- a/source/_integrations/apprise.markdown +++ b/source/_integrations/apprise.markdown @@ -1,12 +1,12 @@ --- title: Apprise description: Instructions on how to add Apprise notifications to Home Assistant. -logo: apprise.png ha_category: - Notifications ha_release: 0.101 ha_codeowners: - '@caronc' +ha_domain: apprise --- The [Apprise service](https://github.com/caronc/apprise/) is an all-in-one solution to open up Home Assistant to _just about_ every Notification platform (such as Amazon SNS, Discord, Telegram, Slack, MSTeams, Twilio, etc.) diff --git a/source/_integrations/aprs.markdown b/source/_integrations/aprs.markdown index 896c3fc9a97..f2f84e44547 100644 --- a/source/_integrations/aprs.markdown +++ b/source/_integrations/aprs.markdown @@ -1,12 +1,12 @@ --- title: APRS description: Instructions on how to use APRS to track devices in Home Assistant. -logo: aprs.png ha_release: 0.95 ha_category: Presence Detection ha_iot_class: Cloud Push ha_codeowners: - '@PhilRW' +ha_domain: aprs --- The `aprs` [(Automatic Packet Reporting System)](https://en.wikipedia.org/wiki/Automatic_Packet_Reporting_System) device tracker integration connects to the [APRS-IS](http://aprs-is.net/) network for tracking amateur radio devices. diff --git a/source/_integrations/aqualogic.markdown b/source/_integrations/aqualogic.markdown index 7331ea0e519..6cb57dbd9ba 100644 --- a/source/_integrations/aqualogic.markdown +++ b/source/_integrations/aqualogic.markdown @@ -1,13 +1,13 @@ --- title: AquaLogic description: Instructions on how to integrate an AquaLogic controller within Home Assistant. -logo: hayward.png ha_category: - Hub - Sensor - Switch ha_release: '0.80' ha_iot_class: Local Push +ha_domain: aqualogic --- The AquaLogic integration provides connectivity to a Hayward/Goldline AquaLogic/ProLogic pool controller. Note that an RS-485 to Ethernet adapter connected to the pool controller is required. diff --git a/source/_integrations/aquostv.markdown b/source/_integrations/aquostv.markdown index 683ae0f55f9..32cbba65f33 100644 --- a/source/_integrations/aquostv.markdown +++ b/source/_integrations/aquostv.markdown @@ -6,6 +6,7 @@ ha_category: - Media Player ha_release: 0.35 ha_iot_class: Local Polling +ha_domain: aquostv --- The `aquostv` platform allows you to control a [Sharp Aquos TV](http://www.sharp-world.com/aquos/en/index.html). diff --git a/source/_integrations/arcam_fmj.markdown b/source/_integrations/arcam_fmj.markdown index cbbceb53066..91a8bb06f9c 100644 --- a/source/_integrations/arcam_fmj.markdown +++ b/source/_integrations/arcam_fmj.markdown @@ -1,12 +1,12 @@ --- title: Arcam FMJ Receivers description: Instructions on how to integrate Arcam FMJ Receivers into Home Assistant. -logo: arcam.svg ha_category: Media Player ha_release: 0.96 ha_iot_class: Local Polling ha_codeowners: - '@elupus' +ha_domain: arcam_fmj --- The `arcam_fmj` integration allows you to control [Arcam FMJ Receveivers](https://www.arcam.co.uk/range/fmj.htm) from Home Assistant. diff --git a/source/_integrations/arduino.markdown b/source/_integrations/arduino.markdown index f6fb0d18b35..a72b1042527 100644 --- a/source/_integrations/arduino.markdown +++ b/source/_integrations/arduino.markdown @@ -1,7 +1,6 @@ --- title: Arduino description: Instructions on how to setup an Arduino boards within Home Assistant. -logo: arduino.png ha_category: - DIY - Sensor @@ -10,6 +9,7 @@ ha_release: pre 0.7 ha_iot_class: Local Polling ha_codeowners: - '@fabaff' +ha_domain: arduino --- The [Arduino](https://www.arduino.cc/) device family are microcontroller boards that are often based on the ATmega328 chip. They come with digital input/output pins (some can be used as PWM outputs), analog inputs, and a USB connection. diff --git a/source/_integrations/arest.markdown b/source/_integrations/arest.markdown index 3d41220ce18..e1467fc0fa4 100644 --- a/source/_integrations/arest.markdown +++ b/source/_integrations/arest.markdown @@ -11,6 +11,7 @@ ha_iot_class: Local Polling ha_release: 0.9 ha_codeowners: - '@fabaff' +ha_domain: arest --- There is currently support for the following device types within Home Assistant: diff --git a/source/_integrations/arlo.markdown b/source/_integrations/arlo.markdown index 5a60ec23f11..2cbc1cf9206 100644 --- a/source/_integrations/arlo.markdown +++ b/source/_integrations/arlo.markdown @@ -9,6 +9,7 @@ ha_category: - Sensor ha_release: 0.46 ha_iot_class: Cloud Polling +ha_domain: arlo --- The `arlo` implementation allows you to integrate your [Arlo](https://arlo.netgear.com/) devices in Home Assistant. diff --git a/source/_integrations/aruba.markdown b/source/_integrations/aruba.markdown index baa00be6e00..2a8c20e3fbf 100644 --- a/source/_integrations/aruba.markdown +++ b/source/_integrations/aruba.markdown @@ -5,6 +5,7 @@ logo: aruba.png ha_category: - Presence Detection ha_release: 0.7 +ha_domain: aruba --- This platform allows you to detect presence by looking at connected devices to an [Aruba Instant](https://www.arubanetworks.com/products/networking/aruba-instant/) device. diff --git a/source/_integrations/arwn.markdown b/source/_integrations/arwn.markdown index 4df56f890ce..dabc41a205d 100644 --- a/source/_integrations/arwn.markdown +++ b/source/_integrations/arwn.markdown @@ -5,6 +5,7 @@ ha_category: - Sensor ha_release: 0.31 ha_iot_class: Local Polling +ha_domain: arwn --- The `arwn` sensor platform is a client for the [Ambient Radio Weather Network](https://github.com/sdague/arwn) project. This collects weather station data and makes it available in an MQTT subtree. diff --git a/source/_integrations/asterisk_cdr.markdown b/source/_integrations/asterisk_cdr.markdown index a78e34abe66..38a946896d0 100644 --- a/source/_integrations/asterisk_cdr.markdown +++ b/source/_integrations/asterisk_cdr.markdown @@ -5,6 +5,7 @@ logo: asterisk.png ha_category: - Mailbox ha_release: 0.79 +ha_domain: asterisk_cdr --- The Asterisk Call Data Recorder provides access to Asterisk call logs on the Asterisk PBX server. This mailbox is enabled automatically through the [Asterisk Voicemail integration](/integrations/asterisk_mbox/) configuration if the `asterisk_mbox_server` is configured to provide CDR data. More information on configuring the server can be found in the [Asterisk PBX configuration guide](/docs/asterisk_mbox/). diff --git a/source/_integrations/asterisk_mbox.markdown b/source/_integrations/asterisk_mbox.markdown index f71a5ac896c..4bed55d8d02 100644 --- a/source/_integrations/asterisk_mbox.markdown +++ b/source/_integrations/asterisk_mbox.markdown @@ -6,6 +6,7 @@ ha_category: - Mailbox ha_iot_class: Local Push ha_release: 0.51 +ha_domain: asterisk_mbox --- The `asterisk_mbox` Asterisk Voicemail integration for Home Assistant allows you to view, listen to, and delete voicemails from an Asterisk voicemail mailbox. The integration includes a panel on the frontend that provides caller-id and speech-to-text transcription (using Google's API) of messages in addition to playback and message deletion. There is also an included sensor that indicates of the number of available messages. There is no requirement that the Asterisk PBX and Home Assistant are running on the same machine. diff --git a/source/_integrations/asuswrt.markdown b/source/_integrations/asuswrt.markdown index a73d2651802..78ee129a359 100644 --- a/source/_integrations/asuswrt.markdown +++ b/source/_integrations/asuswrt.markdown @@ -10,6 +10,7 @@ ha_release: 0.83 ha_iot_class: Local Polling ha_codeowners: - '@kennedyshead' +ha_domain: asuswrt --- The `asuswrt` integration is the main integration to connect to a [ASUSWRT](https://event.asus.com/2013/nw/ASUSWRT/) based router. @@ -67,6 +68,16 @@ require_ip: required: false type: boolean default: true +interface: + description: "The interface of the router that you want statistics from (e.g. eth0,eth1 etc)" + required: false + type: string + default: eth0 +dnsmasq: + description: "The location of the dnsmasq.leases files" + required: false + type: string + default: /var/lib/misc sensors: description: List of enabled sensors required: false @@ -115,32 +126,5 @@ The example above, creates the following sensors: ## Padavan custom firmware (The rt-n56u project) -The [rt-n56u project](https://bitbucket.org/padavan/rt-n56u) does not store `dnsmasq.leases` which is used to track devices at `/var/lib/misc/` as `asuswrt` do. However this integration can still be used for the rt-n56u project by linking `dnsmasq.leases` during the boot process of the router. - -Follow these steps to setup the link. - -1. SSH or Telnet into the router. (default ssh admin@my.router) -2. Run the following command to find the file: - -```bash -$ find / -name "dnsmasq.leases" -``` -3. Copy or remember the full path of, example: `/tmp/dnsmasq.leases` -4. Create the folder if it does not exist: - -```bash -$ mkdir -p /var/lib/misc -``` -5. Add the linking process to the routers started script (one line): - -```bash -$ echo "/bin/ln -s /tmp/dnsmasq.leases /var/lib/misc/dnsmasq.leases" >> /etc/storage/started_script.sh -``` - -6. Reboot the router or link the file: - -```bash -$ /bin/ln -s /tmp/dnsmasq.leases /var/lib/misc/dnsmasq.leases -``` - -The started script is also accessible and editable in the Router's web interface. `Advanced Settings -> Customization -> Scripts -> Custom User Script -> Run After Router Started` +The [rt-n56u project](https://bitbucket.org/padavan/rt-n56u) does not store `dnsmasq.leases` which is used to track devices at `/var/lib/misc/` as `asuswrt` do. However this integration can still be used for the rt-n56u project by changing the dnsmasq location using the `dnsmasq` variable to `dnsmasq: '/tmp'` +Also, to get the statistics for the `WAN` port, specify `interface: 'eth3'` as this is the interface used in the rt-n56u project diff --git a/source/_integrations/aten_pe.markdown b/source/_integrations/aten_pe.markdown index 7f4a0f7f42f..e05ae4b2476 100644 --- a/source/_integrations/aten_pe.markdown +++ b/source/_integrations/aten_pe.markdown @@ -7,6 +7,7 @@ ha_category: ha_release: 0.103 ha_codeowners: - '@mtdcr' +ha_domain: aten_pe --- The `aten_pe` integration lets you control [ATEN Rack PDUs](https://www.aten.com/eu/en/products/energy-intelligence-pduupsracks/rack-pdu/) from Home Assistant. diff --git a/source/_integrations/atome.markdown b/source/_integrations/atome.markdown index d29470a73fd..2968a2ec223 100644 --- a/source/_integrations/atome.markdown +++ b/source/_integrations/atome.markdown @@ -9,6 +9,7 @@ ha_category: ha_iot_class: Cloud Polling ha_codeowners: - '@baqs' +ha_domain: atome --- The `atome` sensor platform is retrieving the consumption of your home from the [Direct Energy Atome electric meter](https://total.direct-energie.com/particuliers/electricite/compteur-linky/atome). diff --git a/source/_integrations/august.markdown b/source/_integrations/august.markdown index 50aef1be7b4..a55fd764994 100644 --- a/source/_integrations/august.markdown +++ b/source/_integrations/august.markdown @@ -5,10 +5,15 @@ logo: august.png ha_category: - Doorbell - Binary Sensor + - Sensor - Camera - Lock ha_release: 0.64 ha_iot_class: Cloud Polling +ha_config_flow: true +ha_codeowners: + - '@bdraco' +ha_domain: august --- The `august` integration allows you to integrate your [August](https://august.com/) devices in Home Assistant. @@ -17,6 +22,7 @@ There is currently support for the following device types within Home Assistant: - Doorbell - Binary Sensor +- Sensor - Camera - Lock @@ -28,7 +34,9 @@ August Lock 2nd Gen will need either August Connect or Doorbell to connect to Ho You will need your August login information (username (either phone# or email), and password) to use this module. -To set it up, add the following to your `configuration.yaml` file: +To add `August` to your installation, go to **Configuration** >> **Integrations** in the UI, click the button with `+` sign and from the list of integrations select **August**. + +Alternatively, add the following to your `configuration.yaml` file: ```yaml # Example configuration.yaml entry @@ -62,16 +70,30 @@ Once Home Assistant is started, a configurator will pop up asking you to enter v ### Binary Sensor -If you have August Doorbell, once you have enabled the August component, you should see following sensors: +If you have an August Doorbell, once you have enabled the August component, you should see following sensors: - Doorbell ding sensor - Doorbell motion sensor - Doorbell online sensor -If you have August Smart Lock with DoorSense, once you have enabled the August component, you should see the following sensors: +If you have an August Smart Lock with DoorSense, once you have enabled the August component, you should see the following sensors: - Door sensor ### Camera The `august` camera platform allows you to view the latest camera image (triggered by motion) by your [August](https://august.com/) device in Home Assistant. + +### Sensor + +If you have an August Doorbell with a battery, once you have enabled the August component, you should see the following sensors: + +- Doorbell Battery + +If you have an August Smart Lock, once you have enabled the August component, you should see the following sensors: + +- Lock Battery + +If you have an August Keypad, once you have enabled the August component, you should see the following sensors: + +- Keypad Battery diff --git a/source/_integrations/aurora.markdown b/source/_integrations/aurora.markdown index a6e48efd4ef..b3e78330352 100644 --- a/source/_integrations/aurora.markdown +++ b/source/_integrations/aurora.markdown @@ -4,7 +4,7 @@ description: Know when auroras might be visible at your location ha_category: - Environment ha_release: 0.39 -logo: noaa.png +ha_domain: aurora --- The `aurora` platform uses the [NOAA Aurora Forecast](https://www.swpc.noaa.gov/products/aurora-30-minute-forecast) service to let you know if an aurora might be visible at your home location in the next 30 minutes, based off of current solar flare activity. diff --git a/source/_integrations/aurora_abb_powerone.markdown b/source/_integrations/aurora_abb_powerone.markdown index bddef96f725..ca56e1f3098 100644 --- a/source/_integrations/aurora_abb_powerone.markdown +++ b/source/_integrations/aurora_abb_powerone.markdown @@ -9,6 +9,7 @@ ha_release: 0.96 ha_iot_class: Local Polling ha_codeowners: - '@davet2001' +ha_domain: aurora_abb_powerone --- This implements a direct RS485 connection to a solar inverter in the diff --git a/source/_integrations/auth.markdown b/source/_integrations/auth.markdown index 76b5397744f..2d3f7e9bf7c 100644 --- a/source/_integrations/auth.markdown +++ b/source/_integrations/auth.markdown @@ -1,13 +1,13 @@ --- title: Auth description: This integration is responsible for providing the authentication endpoints. -logo: home-assistant.png ha_category: - Other ha_release: 0.73 ha_quality_scale: internal ha_codeowners: - '@home-assistant/core' +ha_domain: auth --- This integration creates the endpoints for the [authentication system](/docs/authentication/) that is built into Home Assistant. diff --git a/source/_integrations/automatic.markdown b/source/_integrations/automatic.markdown index 10cf7958d4a..03b8259ab2a 100644 --- a/source/_integrations/automatic.markdown +++ b/source/_integrations/automatic.markdown @@ -8,6 +8,7 @@ ha_release: 0.28 ha_iot_class: Cloud Push ha_codeowners: - '@armills' +ha_domain: automatic --- The `automatic` device tracker platform offers presence detection by retrieving your car's information from the [Automatic](https://automatic.com/) cloud service. diff --git a/source/_integrations/automation.markdown b/source/_integrations/automation.markdown index 49d765b14f5..8cfee19b4f8 100644 --- a/source/_integrations/automation.markdown +++ b/source/_integrations/automation.markdown @@ -1,16 +1,16 @@ --- title: Automation description: Instructions on how to setup automation within Home Assistant. -logo: home-assistant.png ha_category: - Automation ha_release: 0.7 ha_quality_scale: internal ha_codeowners: - '@home-assistant/core' +ha_domain: automation --- -Please see the [docs section](/docs/automation/) for in-depth +Please see the [automation section](/docs/automation/) for in-depth documentation on how to use the automation integration.

    diff --git a/source/_integrations/avea.markdown b/source/_integrations/avea.markdown index 91e303a981a..807f78f7512 100644 --- a/source/_integrations/avea.markdown +++ b/source/_integrations/avea.markdown @@ -8,6 +8,7 @@ ha_release: 0.97 ha_iot_class: Local Polling ha_codeowners: - '@pattyland' +ha_domain: avea --- [Elgato Avea](https://www.elgato.com/en/news/elgato-avea-transform-your-home) is a Bluetooth light bulb that is no longer supported by the manufacturer. The `avea` integration allows you to control all your Avea bulbs with Home Assistant. diff --git a/source/_integrations/avion.markdown b/source/_integrations/avion.markdown index 7e9df4e04c4..cce0ef0b77f 100644 --- a/source/_integrations/avion.markdown +++ b/source/_integrations/avion.markdown @@ -6,6 +6,7 @@ ha_category: ha_iot_class: Assumed State logo: avi-on.png ha_release: 0.37 +ha_domain: avion --- Support for the Avi-on Bluetooth dimmer switch [Avi-on](https://avi-on.com/). diff --git a/source/_integrations/awair.markdown b/source/_integrations/awair.markdown index 7d075fcb5b5..4c448eddce2 100644 --- a/source/_integrations/awair.markdown +++ b/source/_integrations/awair.markdown @@ -1,13 +1,13 @@ --- title: Awair description: Instructions on how to setup Awair devices in Home Assistant. -logo: awair.jpg ha_category: - Health ha_release: 0.84 ha_iot_class: Cloud Polling ha_codeowners: - '@danielsjf' +ha_domain: awair --- The `awair` sensor platform will fetch data from your [Awair device(s)](https://getawair.com). diff --git a/source/_integrations/aws.markdown b/source/_integrations/aws.markdown index b86c8792049..598d1424e99 100644 --- a/source/_integrations/aws.markdown +++ b/source/_integrations/aws.markdown @@ -1,13 +1,13 @@ --- title: Amazon Web Services (AWS) description: Instructions on how to integrate Amazon Web Services with Home Assistant. -logo: aws.png ha_category: - Notifications ha_release: '0.91' ha_codeowners: - '@awarecan' - '@robbiet480' +ha_domain: aws --- The `aws` integration provides a single place to interact with [Amazon Web Services](https://aws.amazon.com/). Currently it provides a notification platform that can send a message to [AWS SQS](https://aws.amazon.com/sqs/), [AWS SNS](https://aws.amazon.com/sns/), or invoke [AWS Lambda](https://aws.amazon.com/lambda/) functions. @@ -103,7 +103,7 @@ context: ## Lambda Notify Usage -AWS Lambda is a notification platform and thus can be controlled by calling the `notify` service [as described here](/integrations/notify/). It will invoke a Lambda for all targets given in the notification payload. A target can be formatted as a function name, an entire ARN ([Amazon Resource Name](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html)) or a partial ARN. For more information, please see the [botocore docs](https://botocore.amazonaws.com/v1/documentation/api/latest/reference/services/lambda.html#Lambda.Client.invoke). +AWS Lambda is a notification platform and thus can be controlled by calling the `notify` service [as described here](/integrations/notify/). It will invoke a Lambda for all targets given in the notification payload. A target can be formatted as a function name, an entire ARN ([Amazon Resource Name](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html)) or a partial ARN. For more information, please see the [botocore documentation](https://botocore.amazonaws.com/v1/documentation/api/latest/reference/services/lambda.html#Lambda.Client.invoke). The Lambda event payload will contain everything passed in the service call payload. Here is an example payload that would be sent to Lambda: @@ -131,7 +131,7 @@ The context will look like this: ## SNS Notify Usage -AWS SNS is a notification platform and thus can be controlled by calling the `notify` service [as described here](/integrations/notify/). It will publish a message to all targets given in the notification payload. A target must be a SNS topic or endpoint ARN ([Amazon Resource Name](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html)). For more information, please see the [botocore docs](https://botocore.amazonaws.com/v1/documentation/api/latest/reference/services/sns.html#SNS.Client.publish). +AWS SNS is a notification platform and thus can be controlled by calling the `notify` service [as described here](/integrations/notify/). It will publish a message to all targets given in the notification payload. A target must be a SNS topic or endpoint ARN ([Amazon Resource Name](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html)). For more information, please see the [botocore documentation](https://botocore.amazonaws.com/v1/documentation/api/latest/reference/services/sns.html#SNS.Client.publish). If one exists, the SNS Subject will be set to the title. All attributes from the payload, except the message, will be sent as stringified message attributes. @@ -157,7 +157,7 @@ If you do not download them, you will lose them and will have to recreate a new ## SQS Notify Usage -AWS SQS is a notification platform and thus can be controlled by calling the `notify` service [as described here](/integrations/notify/). It will publish a message to the queue for all targets given in the notification payload. A target must be a SQS topic URL. For more information, please see the [SQS docs](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/ImportantIdentifiers.html) and [bototcore docs](https://botocore.amazonaws.com/v1/documentation/api/latest/reference/services/sqs.html#SQS.Client.send_message) +AWS SQS is a notification platform and thus can be controlled by calling the `notify` service [as described here](/integrations/notify/). It will publish a message to the queue for all targets given in the notification payload. A target must be a SQS topic URL. For more information, please see the [SQS documentation](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/ImportantIdentifiers.html) and [bototcore documentation](https://botocore.amazonaws.com/v1/documentation/api/latest/reference/services/sqs.html#SQS.Client.send_message) The SQS event payload will contain everything passed in the service call payload. SQS payloads will be published as stringified JSON. All attributes from the payload, except message, will also be sent as stringified message attributes. Here is an example message that would be published to the SQS queue: diff --git a/source/_integrations/axis.markdown b/source/_integrations/axis.markdown index 6b4befd53cd..4e296522c15 100644 --- a/source/_integrations/axis.markdown +++ b/source/_integrations/axis.markdown @@ -11,6 +11,7 @@ ha_release: 0.45 ha_iot_class: Local Push ha_codeowners: - '@kane610' +ha_domain: axis --- [Axis Communications](https://www.axis.com/) devices are surveillance cameras, speakers, access control and other security-related network connected hardware. Event API works with firmware 5.50 and newer. diff --git a/source/_integrations/azure_event_hub.markdown b/source/_integrations/azure_event_hub.markdown index b8994ad77c9..958be7981e9 100644 --- a/source/_integrations/azure_event_hub.markdown +++ b/source/_integrations/azure_event_hub.markdown @@ -1,12 +1,12 @@ --- title: Azure Event Hub description: Setup for Azure Event Hub integration -logo: azure_event_hub.svg ha_category: - History ha_release: 0.94 ha_codeowners: - '@eavanvalkenburg' +ha_domain: azure_event_hub --- The `Azure Event Hub` integration allows you to hook into the Home Assistant event bus and send events to [Azure Event Hub](https://azure.microsoft.com/en-us/services/event-hubs/) or to a [Azure IoT Hub](https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-devguide-messages-read-builtin). diff --git a/source/_integrations/azure_service_bus.markdown b/source/_integrations/azure_service_bus.markdown index 5c8d23d6dc7..0509c735a21 100644 --- a/source/_integrations/azure_service_bus.markdown +++ b/source/_integrations/azure_service_bus.markdown @@ -1,12 +1,12 @@ --- title: Azure Service Bus description: Setup for Azure Service Bus integration -logo: azure_service_bus.svg ha_category: - Notifications ha_release: 0.102 ha_codeowners: - '@hfurubotten' +ha_domain: azure_service_bus --- The `Azure Service Bus` integration allows you to send messages to [Azure Service Bus](https://azure.microsoft.com/en-us/services/service-bus/) from within Home Assistant. diff --git a/source/_integrations/baidu.markdown b/source/_integrations/baidu.markdown index b56b334b02a..cfec3e92b2e 100644 --- a/source/_integrations/baidu.markdown +++ b/source/_integrations/baidu.markdown @@ -5,6 +5,7 @@ logo: baiducloud.png ha_category: - Text-to-speech ha_release: 0.59 +ha_domain: baidu --- The `baidu` text-to-speech platform uses [Baidu TTS engine](https://cloud.baidu.com/product/speech/tts) to read a text with natural sounding voices. diff --git a/source/_integrations/bayesian.markdown b/source/_integrations/bayesian.markdown index 54868a6d3b6..89403363fd5 100644 --- a/source/_integrations/bayesian.markdown +++ b/source/_integrations/bayesian.markdown @@ -1,12 +1,12 @@ --- title: Bayesian description: Instructions on how to integrate threshold Bayesian sensors into Home Assistant. -logo: home-assistant.png ha_category: - Utility ha_iot_class: Local Polling ha_release: 0.53 ha_quality_scale: internal +ha_domain: bayesian --- 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`. diff --git a/source/_integrations/bbb_gpio.markdown b/source/_integrations/bbb_gpio.markdown index 9585de1f001..eb2e89df87c 100644 --- a/source/_integrations/bbb_gpio.markdown +++ b/source/_integrations/bbb_gpio.markdown @@ -1,13 +1,13 @@ --- title: BeagleBone Black GPIO description: Instructions on how to integrate the GPIO capability of a BeagleBone Black into Home Assistant. -logo: beaglebone-black.png ha_category: - DIY - Binary Sensor - Switch ha_release: 0.36 ha_iot_class: Local Push +ha_domain: bbb_gpio --- The `bbb_gpio` integration is the base for all [BeagleBone Black](https://beagleboard.org/black) related GPIO platforms in Home Assistant. diff --git a/source/_integrations/bbox.markdown b/source/_integrations/bbox.markdown index 7378484c515..6cd532d0dcc 100644 --- a/source/_integrations/bbox.markdown +++ b/source/_integrations/bbox.markdown @@ -8,6 +8,7 @@ ha_category: - Presence Detection ha_release: 0.31 ha_iot_class: Local Polling +ha_domain: bbox --- The `bbox` platform uses the [Bbox Modem Router](https://www.bouyguestelecom.fr/offres-internet/bbox-fit) from the French Internet provider Bouygues Telecom. Sensors are mainly bandwidth measures. diff --git a/source/_integrations/beewi_smartclim.markdown b/source/_integrations/beewi_smartclim.markdown index 70a54b08ad0..6136b733834 100644 --- a/source/_integrations/beewi_smartclim.markdown +++ b/source/_integrations/beewi_smartclim.markdown @@ -1,13 +1,13 @@ --- title: BeeWi SmartClim BLE sensor description: Instructions on how to integrate MBeeWi SmartClim BLE sensor with Home Assistant. -logo: beewi_by_otio.png ha_category: - Sensor ha_release: 0.99 ha_iot_class: Local Polling ha_codeowners: - '@alemuro' +ha_domain: beewi_smartclim --- The `beewi_smartclim` sensor platform allows one to monitor room or external temperature and humidity. The [BeeWi SmartClim BLE](http://www.bee-wi.com/produits/capteurs/capteur-de-temperature/) is a Bluetooth Low Energy sensor device that monitors temperature from a room or a garden from your smartphone by using an APP. Use this integration to track these metrics from any location thanks to Home Assistant, as well as to create some automation scripts based on your room's temperature. diff --git a/source/_integrations/bh1750.markdown b/source/_integrations/bh1750.markdown index 2ba909f0806..bd8b56e819c 100644 --- a/source/_integrations/bh1750.markdown +++ b/source/_integrations/bh1750.markdown @@ -1,11 +1,11 @@ --- title: BH1750 description: Instructions on how to integrate a BH1750 light sensor into Home Assistant. -logo: raspberry-pi.png ha_category: - DIY ha_release: 0.48 ha_iot_class: Local Push +ha_domain: bh1750 --- The `bh1750` sensor platform allows you to read the ambient light level in Lux from a [BH1750FVI sensor](https://www.mouser.com/ds/2/348/bh1750fvi-e-186247.pdf) connected via [I2c](https://en.wikipedia.org/wiki/I²C) bus (SDA, SCL pins). It allows you to use all the resolution modes of the sensor described in its datasheet. diff --git a/source/_integrations/binary_sensor.knx.markdown b/source/_integrations/binary_sensor.knx.markdown index 2818ad36a1b..89ceea46cb0 100644 --- a/source/_integrations/binary_sensor.knx.markdown +++ b/source/_integrations/binary_sensor.knx.markdown @@ -1,11 +1,11 @@ --- title: "KNX Binary Sensor" description: "Instructions on how to setup the KNX binary sensors within Home Assistant." -logo: knx.png ha_category: - Binary Sensor ha_release: 0.24 ha_iot_class: Local Push +ha_domain: knx ---

    diff --git a/source/_integrations/binary_sensor.markdown b/source/_integrations/binary_sensor.markdown index ccf753ae9fa..c312c542114 100644 --- a/source/_integrations/binary_sensor.markdown +++ b/source/_integrations/binary_sensor.markdown @@ -1,11 +1,11 @@ --- title: Binary Sensor description: Instructions on how-to setup binary sensors with Home Assistant. -logo: home-assistant.png ha_category: - Binary Sensor ha_release: 0.9 ha_quality_scale: internal +ha_domain: binary_sensor --- Binary sensors gather information about the state of devices which have a "digital" return value (either 1 or 0). These can be switches, contacts, pins, etc. These sensors only have two states: **0/off/low/closed/false** and **1/on/high/open/true**. Knowing that there are only two states allows Home Assistant to represent these sensors in a better way in the frontend according to their functionality. diff --git a/source/_integrations/binary_sensor.modbus.markdown b/source/_integrations/binary_sensor.modbus.markdown index 7ce37eddd52..429c33517ef 100644 --- a/source/_integrations/binary_sensor.modbus.markdown +++ b/source/_integrations/binary_sensor.modbus.markdown @@ -1,11 +1,11 @@ --- title: "Modbus Binary Sensor" description: "Instructions on how to set up Modbus binary sensors within Home Assistant." -logo: modbus.png ha_category: - Binary Sensor ha_release: 0.28 ha_iot_class: Local Push +ha_domain: modbus --- The `modbus` binary sensor allows you to gather data from [Modbus](http://www.modbus.org/) coils. diff --git a/source/_integrations/binary_sensor.mqtt.markdown b/source/_integrations/binary_sensor.mqtt.markdown index ddfc675a21d..1b551075472 100644 --- a/source/_integrations/binary_sensor.mqtt.markdown +++ b/source/_integrations/binary_sensor.mqtt.markdown @@ -1,11 +1,11 @@ --- title: "MQTT Binary Sensor" description: "Instructions on how to integrate MQTT binary sensors within Home Assistant." -logo: mqtt.png ha_category: - Binary Sensor ha_release: 0.9 ha_iot_class: Configurable +ha_domain: mqtt --- The `mqtt` binary sensor platform uses an MQTT message payload to set the binary sensor to one of two states: `on` or `off`. @@ -14,6 +14,8 @@ The binary sensor state will be updated only after a new message is published on the binary sensor will receive an instant state update after subscription and Home Assistant will display the correct state on startup. Otherwise, the initial state displayed in Home Assistant will be `unknown`. +Stateless devices such as buttons, remote controls etc are better represented by [MQTT device triggers](/integrations/device_trigger.mqtt/) than by binary sensors. + ## Configuration The `mqtt` binary sensor platform optionally supports an `availability_topic` to receive online and offline messages (birth and LWT messages) from the MQTT device. During normal operation, if the MQTT sensor device goes offline (i.e., publishes `payload_not_available` to `availability_topic`), Home Assistant will display the binary sensor as `unavailable`. If these messages are published with the `retain` flag set, the binary sensor will receive an instant update after subscription and Home Assistant will display the correct availability state of the binary sensor when Home Assistant starts up. If the `retain` flag is not set, Home Assistant will display the binary sensor as `unavailable` when Home Assistant starts up. If no `availability_topic` @@ -30,90 +32,23 @@ binary_sensor: ``` {% configuration %} -state_topic: - description: The MQTT topic subscribed to receive sensor values. - required: true - type: string -name: - description: The name of the binary sensor. - required: false - type: string - default: MQTT Binary Sensor -payload_on: - description: The payload that represents the on state. - required: false - type: string - default: "ON" -payload_off: - description: The payload that represents the off state. - required: false - type: string - default: "OFF" availability_topic: description: "The MQTT topic subscribed to receive birth and LWT messages from the MQTT device. If `availability_topic` is not defined, the binary sensor availability state will always be `available`. If `availability_topic` is defined, the binary sensor availability state will be `unavailable` by default." required: false type: string -payload_available: - description: The payload that represents the online state. - required: false - type: string - default: online -payload_not_available: - description: The payload that represents the offline state. - required: false - type: string - default: offline -json_attributes_topic: - description: The MQTT topic subscribed to receive a JSON dictionary payload and then set as sensor attributes. Usage example can be found in [MQTT sensor](/integrations/sensor.mqtt/#json-attributes-topic-configuration) documentation. - required: false - type: string -json_attributes_template: - description: "Defines a [template](/docs/configuration/templating/#processing-incoming-data) to extract the JSON dictionary from messages received on the `json_attributes_topic`. Usage example can be found in [MQTT sensor](/integrations/sensor.mqtt/#json-attributes-template-configuration) documentation." - required: false - type: template -qos: - description: The maximum QoS level to be used when receiving messages. - required: false - type: integer - default: 0 -unique_id: - description: An ID that uniquely identifies this sensor. If two sensors have the same unique ID, Home Assistant will raise an exception. - required: false - type: string -device_class: - description: Sets the [class of the device](/integrations/binary_sensor/#device-class), changing the device state and icon that is displayed on the frontend. - required: false - type: string -expire_after: - description: "Defines the number of seconds after the value expires if it's not updated. After expiry, the value is cleared, and the availability is set to false" - required: false - type: integer -value_template: - description: "Defines a [template](/docs/configuration/templating/#processing-incoming-data) to extract a value from the payload. Available variables: `entity_id`. Remove this option when 'payload_on' and 'payload_off' are sufficient to match your payloads." - required: false - type: string -force_update: - description: Sends update events even if the value hasn't changed. Useful if you want to have meaningful value graphs in history. - required: false - type: boolean - default: false -off_delay: - description: "For sensors that only sends `On` state updates, this variable sets a delay in seconds after which the sensor state will be updated back to `Off`." - required: false - type: integer device: description: "Information about the device this binary sensor is a part of to tie it into the [device registry](https://developers.home-assistant.io/docs/en/device_registry_index.html). Only works through [MQTT discovery](/docs/mqtt/discovery/) and when [`unique_id`](#unique_id) is set." required: false type: map keys: - identifiers: - description: A list of IDs that uniquely identify the device. For example a serial number. - required: false - type: [list, string] connections: description: "A list of connections of the device to the outside world as a list of tuples `[connection_type, connection_identifier]`. For example the MAC address of a network interface: `'connections': ['mac', '02:5b:26:a8:dc:12']`." required: false type: [list, map] + identifiers: + description: A list of IDs that uniquely identify the device. For example a serial number. + required: false + type: [list, string] manufacturer: description: The manufacturer of the device. required: false @@ -130,6 +65,73 @@ device: description: The firmware version of the device. required: false type: string +device_class: + description: Sets the [class of the device](/integrations/binary_sensor/#device-class), changing the device state and icon that is displayed on the frontend. + required: false + type: string +expire_after: + description: "Defines the number of seconds after the value expires if it's not updated. After expiry, the value is cleared, and the availability is set to false" + required: false + type: integer +force_update: + description: Sends update events even if the value hasn't changed. Useful if you want to have meaningful value graphs in history. + required: false + type: boolean + default: false +json_attributes_template: + description: "Defines a [template](/docs/configuration/templating/#processing-incoming-data) to extract the JSON dictionary from messages received on the `json_attributes_topic`. Usage example can be found in [MQTT sensor](/integrations/sensor.mqtt/#json-attributes-template-configuration) documentation." + required: false + type: template +json_attributes_topic: + description: The MQTT topic subscribed to receive a JSON dictionary payload and then set as sensor attributes. Usage example can be found in [MQTT sensor](/integrations/sensor.mqtt/#json-attributes-topic-configuration) documentation. + required: false + type: string +name: + description: The name of the binary sensor. + required: false + type: string + default: MQTT Binary Sensor +off_delay: + description: "For sensors that only sends `On` state updates, this variable sets a delay in seconds after which the sensor state will be updated back to `Off`." + required: false + type: integer +payload_available: + description: The payload that represents the online state. + required: false + type: string + default: online +payload_not_available: + description: The payload that represents the offline state. + required: false + type: string + default: offline +payload_off: + description: The payload that represents the off state. + required: false + type: string + default: "OFF" +payload_on: + description: The payload that represents the on state. + required: false + type: string + default: "ON" +qos: + description: The maximum QoS level to be used when receiving messages. + required: false + type: integer + default: 0 +state_topic: + description: The MQTT topic subscribed to receive sensor values. + required: true + type: string +unique_id: + description: An ID that uniquely identifies this sensor. If two sensors have the same unique ID, Home Assistant will raise an exception. + required: false + type: string +value_template: + description: "Defines a [template](/docs/configuration/templating/#processing-incoming-data) to extract a value from the payload. Available variables: `entity_id`. Remove this option when 'payload_on' and 'payload_off' are sufficient to match your payloads." + required: false + type: string {% endconfiguration %} ## Examples diff --git a/source/_integrations/binary_sensor.mysensors.markdown b/source/_integrations/binary_sensor.mysensors.markdown index 28f19636164..1c0188f9bb4 100644 --- a/source/_integrations/binary_sensor.mysensors.markdown +++ b/source/_integrations/binary_sensor.mysensors.markdown @@ -1,12 +1,12 @@ --- title: "MySensors Binary Sensor" description: "Instructions on how to integrate MySensors binary sensors into Home Assistant." -logo: mysensors.png ha_category: - DIY - Binary Sensor ha_release: 0.14 ha_iot_class: Local Push +ha_domain: mysensors --- Integrates MySensors binary sensors into Home Assistant. See the [main integration](/integrations/mysensors/) for configuration instructions. diff --git a/source/_integrations/binary_sensor.rest.markdown b/source/_integrations/binary_sensor.rest.markdown index 92413461faa..eaa3d8f2e5c 100644 --- a/source/_integrations/binary_sensor.rest.markdown +++ b/source/_integrations/binary_sensor.rest.markdown @@ -1,11 +1,11 @@ --- title: "RESTful Binary Sensor" description: "Instructions on how to integrate REST binary sensors into Home Assistant." -logo: restful.png ha_category: - Binary Sensor ha_release: "0.10" ha_iot_class: Local Polling +ha_domain: rest --- The `rest` binary sensor platform is consuming a given endpoint which is exposed diff --git a/source/_integrations/binary_sensor.rflink.markdown b/source/_integrations/binary_sensor.rflink.markdown index f84c4cf7a44..6f62de60307 100644 --- a/source/_integrations/binary_sensor.rflink.markdown +++ b/source/_integrations/binary_sensor.rflink.markdown @@ -6,6 +6,7 @@ ha_category: - Binary Sensor ha_iot_class: Local Push ha_release: 0.81 +ha_domain: rflink --- The `rflink` integration supports devices that use [RFLink gateway firmware](http://www.nemcon.nl/blog2/), for example the [Nodo RFLink Gateway](https://www.nodo-shop.nl/nl/21-rflink-gateway). RFLink gateway is an Arduino firmware that allows two-way communication with a multitude of RF wireless devices using cheap hardware (Arduino + transceiver). diff --git a/source/_integrations/binary_sensor.rfxtrx.markdown b/source/_integrations/binary_sensor.rfxtrx.markdown index ac7b52e4867..0f5a49c5a91 100644 --- a/source/_integrations/binary_sensor.rfxtrx.markdown +++ b/source/_integrations/binary_sensor.rfxtrx.markdown @@ -1,10 +1,10 @@ --- title: "RFXtrx Binary Sensor" description: "Instructions on how to integrate RFXtrx binary sensors into Home Assistant." -logo: rfxtrx.png ha_category: - Binary Sensor ha_release: 0.48 +ha_domain: rfxtrx --- The `rfxtrx` platform support binary sensors that diff --git a/source/_integrations/binary_sensor.template.markdown b/source/_integrations/binary_sensor.template.markdown index 18d6aa35d5f..37ad46f32b9 100644 --- a/source/_integrations/binary_sensor.template.markdown +++ b/source/_integrations/binary_sensor.template.markdown @@ -5,8 +5,8 @@ ha_category: - Binary Sensor ha_release: 0.12 ha_iot_class: Local Push -logo: home-assistant.png ha_quality_scale: internal +ha_domain: template --- The `template` platform supports binary sensors which get their values from @@ -238,7 +238,7 @@ binary_sensor: ### Device Tracker sensor with Latitude and Longitude Attributes -This example shows how to combine a non-GPS (e.g. NMAP) and GPS device tracker while still including latitude and longitude attributes +This example shows how to combine a non-GPS (e.g., NMAP) and GPS device tracker while still including latitude and longitude attributes {% raw %} ```yaml diff --git a/source/_integrations/binary_sensor.xiaomi_aqara.markdown b/source/_integrations/binary_sensor.xiaomi_aqara.markdown index b25eb39897e..f5e72c23ba0 100644 --- a/source/_integrations/binary_sensor.xiaomi_aqara.markdown +++ b/source/_integrations/binary_sensor.xiaomi_aqara.markdown @@ -1,11 +1,11 @@ --- title: "Xiaomi Binary Sensor" description: "Instructions on how to setup the Xiaomi binary sensors within Home Assistant." -logo: xiaomi.png ha_category: - Binary Sensor ha_release: "0.50" ha_iot_class: Local Push +ha_domain: xiaomi_aqara --- The `xiaomi aqara` binary sensor platform allows you to get data from your [Xiaomi](https://www.mi.com/en/) binary sensors. diff --git a/source/_integrations/bitcoin.markdown b/source/_integrations/bitcoin.markdown index b6a4eb282f0..d07edfaf613 100644 --- a/source/_integrations/bitcoin.markdown +++ b/source/_integrations/bitcoin.markdown @@ -8,6 +8,7 @@ ha_release: pre 0.7 ha_iot_class: Cloud Polling ha_codeowners: - '@fabaff' +ha_domain: bitcoin --- The `bitcoin` sensor platform displays various details about the [Bitcoin](https://bitcoin.org) network. diff --git a/source/_integrations/bizkaibus.markdown b/source/_integrations/bizkaibus.markdown index 8dd4814dcb2..9532d293f97 100644 --- a/source/_integrations/bizkaibus.markdown +++ b/source/_integrations/bizkaibus.markdown @@ -9,6 +9,7 @@ ha_iot_class: Cloud Polling ha_release: 0.93 ha_codeowners: - '@UgaitzEtxebarria' +ha_domain: bizkaibus --- The `bizkaibus` sensor will give you the time until the next bus in the selected stop. diff --git a/source/_integrations/blackbird.markdown b/source/_integrations/blackbird.markdown index ea35b35e64d..194f6643a1b 100644 --- a/source/_integrations/blackbird.markdown +++ b/source/_integrations/blackbird.markdown @@ -1,11 +1,11 @@ --- title: Monoprice Blackbird Matrix Switch description: Instructions on how to integrate Monoprice Blackbird 4k 8x8 HDBaseT Matrix Switch into Home Assistant. -logo: monoprice.svg ha_category: - Media Player ha_release: 0.68 ha_iot_class: Local Polling +ha_domain: blackbird --- The `blackbird` platform allows you to control [Monoprice Blackbird Matrix Switch](https://www.monoprice.com/product?p_id=21819) using a serial connection. diff --git a/source/_integrations/blink.markdown b/source/_integrations/blink.markdown index 14077e84a66..ddeb12925ff 100644 --- a/source/_integrations/blink.markdown +++ b/source/_integrations/blink.markdown @@ -1,7 +1,6 @@ --- title: Blink description: Instructions for how to integrate Blink camera/security system within Home Assistant. -logo: blink.png ha_category: - Hub - Alarm @@ -12,6 +11,7 @@ ha_release: '0.40' ha_iot_class: Cloud Polling ha_codeowners: - '@fronzbot' +ha_domain: blink --- The `blink` integration lets you view camera images and motion events from [Blink](https://blinkforhome.com/) camera and security systems. diff --git a/source/_integrations/blinksticklight.markdown b/source/_integrations/blinksticklight.markdown index 47a599bf547..99ddc358217 100644 --- a/source/_integrations/blinksticklight.markdown +++ b/source/_integrations/blinksticklight.markdown @@ -6,6 +6,7 @@ ha_category: - DIY ha_release: 0.7.5 ha_iot_class: Local Polling +ha_domain: blinksticklight --- The `blinkstick` platform lets you control your [Blinkstick](https://www.blinkstick.com/) lights from within Home Assistant. diff --git a/source/_integrations/blinkt.markdown b/source/_integrations/blinkt.markdown index 70f63f99e0a..d6576e7e174 100644 --- a/source/_integrations/blinkt.markdown +++ b/source/_integrations/blinkt.markdown @@ -1,11 +1,11 @@ --- title: Blinkt! description: Instructions on how to setup Blinkt! RGB LED lights within Home Assistant. -logo: raspberry-pi.png ha_category: - DIY ha_iot_class: Local Push ha_release: 0.44 +ha_domain: blinkt --- The `blinkt` light platform lets you control the [Blinkt!](https://shop.pimoroni.com/products/blinkt) board, featuring eight super-bright RGB LEDs. diff --git a/source/_integrations/blockchain.markdown b/source/_integrations/blockchain.markdown index f9c948a4e9f..55d3638d342 100644 --- a/source/_integrations/blockchain.markdown +++ b/source/_integrations/blockchain.markdown @@ -6,6 +6,7 @@ ha_category: - Finance ha_release: 0.47 ha_iot_class: Cloud Polling +ha_domain: blockchain --- The `Blockchain` sensor platform displays Bitcoin wallet balances from [blockchain.com](https://blockchain.com). diff --git a/source/_integrations/bloomsky.markdown b/source/_integrations/bloomsky.markdown index d05cc8640bf..871d50b0ff2 100644 --- a/source/_integrations/bloomsky.markdown +++ b/source/_integrations/bloomsky.markdown @@ -9,6 +9,7 @@ ha_category: - Sensor ha_release: 0.14 ha_iot_class: Cloud Polling +ha_domain: bloomsky --- The `bloomsky` integration allows you to access your [BloomSky](https://www.bloomsky.com/) weather station's. diff --git a/source/_integrations/bluesound.markdown b/source/_integrations/bluesound.markdown index 744f4535e86..c992a2736d8 100644 --- a/source/_integrations/bluesound.markdown +++ b/source/_integrations/bluesound.markdown @@ -6,6 +6,7 @@ ha_category: - Media Player ha_release: 0.51 ha_iot_class: Local Polling +ha_domain: bluesound --- The `bluesound` platform allows you to control your [Bluesound](https://www.bluesound.com/) HiFi wireless speakers and audio integrations from Home Assistant. diff --git a/source/_integrations/bluetooth_le_tracker.markdown b/source/_integrations/bluetooth_le_tracker.markdown index 8a9f3634116..32745562156 100644 --- a/source/_integrations/bluetooth_le_tracker.markdown +++ b/source/_integrations/bluetooth_le_tracker.markdown @@ -6,6 +6,7 @@ ha_category: - Presence Detection ha_iot_class: Local Polling ha_release: 0.27 +ha_domain: bluetooth_le_tracker --- This tracker discovers new devices on boot and in regular intervals and tracks Bluetooth low-energy devices periodically based on interval_seconds value. It is not required to pair the devices with each other. diff --git a/source/_integrations/bluetooth_tracker.markdown b/source/_integrations/bluetooth_tracker.markdown index 9f3b8dd4cb9..6294fa732d5 100644 --- a/source/_integrations/bluetooth_tracker.markdown +++ b/source/_integrations/bluetooth_tracker.markdown @@ -6,6 +6,7 @@ ha_category: - Presence Detection ha_iot_class: Local Polling ha_release: 0.18 +ha_domain: bluetooth_tracker --- This tracker discovers new devices on boot and tracks Bluetooth devices periodically based on `interval_seconds` value. It is not required to pair the devices with each other! Devices discovered are stored with 'bt_' as the prefix for device MAC addresses in `known_devices.yaml`. diff --git a/source/_integrations/bme280.markdown b/source/_integrations/bme280.markdown index 57efba7c626..bb4fb69dd6b 100644 --- a/source/_integrations/bme280.markdown +++ b/source/_integrations/bme280.markdown @@ -1,11 +1,11 @@ --- title: Bosch BME280 Environmental Sensor description: Instructions on how to integrate a BME280 sensor into Home Assistant. -logo: raspberry-pi.png ha_category: - DIY ha_release: 0.48 ha_iot_class: Local Push +ha_domain: bme280 --- The `bme280` sensor platform allows you to read temperature, humidity and pressure values of a [Bosch BME280 Environmental sensor](https://cdn-shop.adafruit.com/datasheets/BST-BME280_DS001-10.pdf) connected via [I2c](https://en.wikipedia.org/wiki/I²C) bus (SDA, SCL pins). It allows you to use all the operation modes of the sensor described in its datasheet. diff --git a/source/_integrations/bme680.markdown b/source/_integrations/bme680.markdown index e2b3d06eb24..90b9fd3c78f 100644 --- a/source/_integrations/bme680.markdown +++ b/source/_integrations/bme680.markdown @@ -1,11 +1,11 @@ --- title: Bosch BME680 Environmental Sensor description: Instructions on how to integrate a BME680 sensor into Home Assistant. -logo: raspberry-pi.png ha_category: - DIY ha_release: 0.62 ha_iot_class: Local Push +ha_domain: bme680 --- The `bme680` sensor platform allows you to read temperature, humidity, pressure and gas resistance values of a [Bosch BME680 Environmental sensor](https://cdn-shop.adafruit.com/product-files/3660/BME680.pdf) connected via an [I2C](https://en.wikipedia.org/wiki/I²C) bus (SDA, SCL pins). It allows you to use all the operation modes of the sensor described in its datasheet. In addition, it includes a basic air quality calculation that uses gas resistance and humidity measurements to calculate a percentage based air quality measurement. diff --git a/source/_integrations/bmw_connected_drive.markdown b/source/_integrations/bmw_connected_drive.markdown index e063e7ff1ef..c256c7641fa 100644 --- a/source/_integrations/bmw_connected_drive.markdown +++ b/source/_integrations/bmw_connected_drive.markdown @@ -1,7 +1,6 @@ --- title: BMW Connected Drive description: Instructions on how to setup your BMW Connected Drive account with Home Assistant. -logo: bmw.png ha_category: - Car - Binary Sensor @@ -12,6 +11,7 @@ ha_release: 0.64 ha_iot_class: Cloud Polling ha_codeowners: - '@gerard33' +ha_domain: bmw_connected_drive --- The `bmw_connected_drive` integration lets you retrieve data of your BMW vehicle from the BMW Connected Drive portal. You need to have a working BMW Connected Drive account, and a Connected Drive enabled vehicle for this to work. diff --git a/source/_integrations/bom.markdown b/source/_integrations/bom.markdown index 070ebea0163..9068b3910f1 100644 --- a/source/_integrations/bom.markdown +++ b/source/_integrations/bom.markdown @@ -8,6 +8,7 @@ ha_category: - Camera ha_release: 0.36 ha_iot_class: Cloud Polling +ha_domain: bom --- The `bom` weather platform uses the [Australian Bureau of Meteorology (BOM)](http://www.bom.gov.au) as a source for current (half-hourly) meteorological data. @@ -33,7 +34,7 @@ name: required: false type: string station: - description: "The station ID string. See the [`sensor.bom` docs](#sensor) for details on how to find the ID of a station." + description: "The station ID string. See the [`sensor.bom` documentation](#sensor) for details on how to find the ID of a station." required: false type: string default: The closest station @@ -122,7 +123,7 @@ camera: In the event BOM creates a new radar, or a radar's ID changes, you may define a custom `id` along with corresponding `delta` and `frames` values. You may also specify custom `delta` and `frames` values, along with a valid `location`, to override the default values for an existing radar. You may not define `location` and `id` in the same entity; you must specify one or the other. If `id` is specified, then `delta` and `frames` values _must_ be provided. If `location` is specified, `delta` and `frames` _may_ be provided to override the default values. -To find a live radar ID (e.g. for the `Townsville` radar), visit the [BOM website's radars page](http://www.bom.gov.au/australia/radar/), click the link for the radar you are interested in, and note the URL, for example: `http://www.bom.gov.au/products/IDR733.loop.shtml`. The ID is the number following `IDR` (i.e. `733`) in the URL. You can also see, at the bottom of the radar image, a rotating set of times corresponding to the frames of the BOM's JavaScript-driven animation. The number of minutes (in seconds) between these times corresponds to the camera's `delta` value, and the number of frames corresponds to the `frames` value. At the time of this writing, the `Townsville` radar loop is composed of 4 frames at 10-minute (600 second) intervals. Since these are also the default values, this configuration block +To find a live radar ID (e.g., for the `Townsville` radar), visit the [BOM website's radars page](http://www.bom.gov.au/australia/radar/), click the link for the radar you are interested in, and note the URL, for example: `http://www.bom.gov.au/products/IDR733.loop.shtml`. The ID is the number following `IDR` (i.e., `733`) in the URL. You can also see, at the bottom of the radar image, a rotating set of times corresponding to the frames of the BOM's JavaScript-driven animation. The number of minutes (in seconds) between these times corresponds to the camera's `delta` value, and the number of frames corresponds to the `frames` value. At the time of this writing, the `Townsville` radar loop is composed of 4 frames at 10-minute (600 second) intervals. Since these are also the default values, this configuration block ```yaml camera: diff --git a/source/_integrations/braviatv.markdown b/source/_integrations/braviatv.markdown index 0e870319745..5a5de181d0a 100644 --- a/source/_integrations/braviatv.markdown +++ b/source/_integrations/braviatv.markdown @@ -8,6 +8,7 @@ ha_release: 0.23 ha_iot_class: Local Polling ha_codeowners: - '@robbiet480' +ha_domain: braviatv --- The `braviatv` platform allows you to control a [Sony Bravia TV](https://www.sony.com/). diff --git a/source/_integrations/broadlink.markdown b/source/_integrations/broadlink.markdown index d71d66f4f3f..57adc81784d 100644 --- a/source/_integrations/broadlink.markdown +++ b/source/_integrations/broadlink.markdown @@ -11,6 +11,7 @@ ha_iot_class: Local Polling ha_codeowners: - '@danielhiversen' - '@felipediel' +ha_domain: broadlink --- There is currently support for the following device types within Home Assistant: diff --git a/source/_integrations/brother.markdown b/source/_integrations/brother.markdown index 63e171ae097..1102eba19e0 100644 --- a/source/_integrations/brother.markdown +++ b/source/_integrations/brother.markdown @@ -9,6 +9,7 @@ ha_iot_class: Local Polling ha_config_flow: true ha_codeowners: - '@bieniu' +ha_domain: brother --- The `Brother Printer` integration allows you to read current data from your local Brother printer. diff --git a/source/_integrations/brottsplatskartan.markdown b/source/_integrations/brottsplatskartan.markdown index 9ad6dff44ed..9289db32d46 100644 --- a/source/_integrations/brottsplatskartan.markdown +++ b/source/_integrations/brottsplatskartan.markdown @@ -6,6 +6,7 @@ ha_category: logo: brottsplatskartan.png ha_release: 0.85 ha_iot_class: Cloud Polling +ha_domain: brottsplatskartan --- The `brottsplatskartan` sensor allows one to track reported incidents occurring in a given area. Incidents include anything reported to [Brottsplatskartan](https://brottsplatskartan.se). The sensor only counts incidents from the current day. diff --git a/source/_integrations/browser.markdown b/source/_integrations/browser.markdown index f0267f6fb30..9c95044764f 100644 --- a/source/_integrations/browser.markdown +++ b/source/_integrations/browser.markdown @@ -1,11 +1,11 @@ --- title: Browser description: Instructions on how to setup the browser integration with Home Assistant. -logo: home-assistant.png ha_category: - Utility ha_release: pre 0.7 ha_quality_scale: internal +ha_domain: browser --- The `browser` integration provides a service to open URLs in the default browser on the host machine. diff --git a/source/_integrations/brunt.markdown b/source/_integrations/brunt.markdown index ff93f5b165e..513dbea37ac 100644 --- a/source/_integrations/brunt.markdown +++ b/source/_integrations/brunt.markdown @@ -1,13 +1,13 @@ --- title: Brunt Blind Engine description: Instructions on how to set up Brunt Blind Engine within Home Assistant. -logo: brunt.png ha_category: - Cover ha_release: 0.75 ha_iot_class: Cloud Polling ha_codeowners: - '@eavanvalkenburg' +ha_domain: brunt --- The `brunt` platform allows one to control Blind Engines by [Brunt](https://www.brunt.co). To use this sensor, you need a Brunt App Account. All Brunt Blind devices registered to your account are automatically added to your Home Assistant with the names given them through the Brunt app. diff --git a/source/_integrations/bt_home_hub_5.markdown b/source/_integrations/bt_home_hub_5.markdown index fb9a2e7ec6c..1fd7c477691 100644 --- a/source/_integrations/bt_home_hub_5.markdown +++ b/source/_integrations/bt_home_hub_5.markdown @@ -5,6 +5,7 @@ logo: bt.png ha_category: - Presence Detection ha_release: 0.22 +ha_domain: bt_home_hub_5 --- This platform offers presence detection by looking at connected devices to a [BT Home Hub 5](https://en.wikipedia.org/wiki/BT_Home_Hub) based router. diff --git a/source/_integrations/bt_smarthub.markdown b/source/_integrations/bt_smarthub.markdown index 466ed6a5cd2..8290c088476 100644 --- a/source/_integrations/bt_smarthub.markdown +++ b/source/_integrations/bt_smarthub.markdown @@ -8,6 +8,7 @@ ha_release: 0.82 ha_iot_class: Local Polling ha_codeowners: - '@jxwolstenholme' +ha_domain: bt_smarthub --- This platform offers presence detection by looking at connected devices to a [BT Smart Hub](https://en.wikipedia.org/wiki/BT_Smart_Hub) based router. diff --git a/source/_integrations/buienradar.markdown b/source/_integrations/buienradar.markdown index dd92cebddd5..d141dade0c6 100644 --- a/source/_integrations/buienradar.markdown +++ b/source/_integrations/buienradar.markdown @@ -10,6 +10,7 @@ ha_iot_class: Cloud Polling ha_codeowners: - '@mjj4791' - '@ties' +ha_domain: buienradar --- The `buienradar` platform uses [buienradar.nl](https://buienradar.nl/) as a source for current meteorological data for your location. The weather forecast is delivered by Buienradar, who provides a web service that provides detailed weather information for users in The Netherlands. diff --git a/source/_integrations/caldav.markdown b/source/_integrations/caldav.markdown index 05a0d67d05b..e15962d2029 100644 --- a/source/_integrations/caldav.markdown +++ b/source/_integrations/caldav.markdown @@ -5,24 +5,16 @@ ha_category: - Calendar ha_iot_class: Cloud Polling ha_release: '0.60' +ha_domain: caldav --- -The `caldav` platform allows you to connect to your WebDAV calendar and generate -binary sensors. A different sensor will be created for each individual calendar, -or you can specify custom calendars which match a criteria you define (more on -that below). These sensors will be `on` if you have an on going event in that -calendar or `off` if the event is later in time, or if there is no event at all. -The WebDAV calendar get updated roughly every 15 minutes. +The `caldav` platform allows you to connect to your WebDAV calendar and generate binary sensors. A different sensor will be created for each individual calendar, or you can specify custom calendars which match a criteria you define (more on that below). These sensors will be `on` if you have an on going event in that calendar or `off` if the event is later in time, or if there is no event at all. The WebDAV calendar get updated roughly every 15 minutes. ### Prerequisites -You need to have a CalDAV server and credentials for it. This integration was -tested against [Baikal](http://sabre.io/baikal/) but any integration complying -with the RFC4791 should work. [Nextcloud](https://nextcloud.com/) -and [Owncloud](https://owncloud.org/) work fine. +You need to have a CalDAV server and credentials for it. This integration was tested against [Baikal](http://sabre.io/baikal/) but any integration complying with the RFC4791 should work. [Nextcloud](https://nextcloud.com/) and [Owncloud](https://owncloud.org/) work fine. -You might need some additional system packages to compile the -Python CalDAV library. On a Debian based system, install them by: +You might need some additional system packages to compile the Python CalDAV library. On a Debian based system, install them by: ```bash $ sudo apt-get install libxml2-dev libxslt1-dev zlib1g-dev @@ -30,8 +22,7 @@ $ sudo apt-get install libxml2-dev libxslt1-dev zlib1g-dev ### Basic Setup -To integrate a WebDAV calendar in Home Assistant, -add the following section to your `configuration.yaml` file: +To integrate a WebDAV calendar in Home Assistant, add the following section to your `configuration.yaml` file: ```yaml # Example configuration.yaml entry for baikal @@ -51,16 +42,11 @@ calendar: url: https://nextcloud.example.com/remote.php/dav ``` -This example will generate default binary sensors for each calendar you have in -your account. Those calendars will be `on` when there is an ongoing event and -`off` if not. Events that last a whole day are ignored in those calendars. -You have to setup custom calendars in order to take them into account or for -advanced event filtering. +This example will generate default binary sensors for each calendar you have in your account. Those calendars will be `on` when there is an ongoing event and `off` if not. Events that last a whole day are ignored in those calendars. You have to setup custom calendars in order to take them into account or for advanced event filtering. ### Custom calendars -You have the possibility to create multiple binary -sensors for events that match certain conditions. +You have the possibility to create multiple binary sensors for events that match certain conditions. ```yaml # Example configuration.yaml entry @@ -78,13 +64,9 @@ calendar: search: 'Warmup' ``` -This will create two binary sensors for the calendar name Agenda: "HomeOffice" -and "WarmupFlat". Those sensors will be `on` if there is an ongoing event -matching the regular expression specified in `search`. -In custom calendars, events that last a whole day are taken into account. +This will create two binary sensors for the calendar name Agenda: "HomeOffice" and "WarmupFlat". Those sensors will be `on` if there is an ongoing event matching the regular expression specified in `search`. In custom calendars, events that last a whole day are taken into account. -Please note that when you configure custom calendars, -the default ones are not created anymore. +Please note that if you use the `custom_calendars` option, only those calendars will be loaded. You cannot use `calendars` and `custom_calendars` in the same configuration. {% configuration %} url: @@ -101,13 +83,11 @@ password: type: string calendars: required: false - description: > - List of the calendars to filter. - Empty or absent means no filtering, i.e. all calendars will be added. + description: List of the calendars to filter. Empty or absent means no filtering, i.e., all calendars will be added. It cannot be used if `custom_calender` option is used. type: list custom_calendars: required: false - description: Details on any custom binary sensor calendars you want to create. + description: Details on any custom binary sensor calendars you want to create. Using this will only load the custom calendars supplied. No other calendars will load. type: list keys: name: @@ -120,9 +100,7 @@ custom_calendars: type: string search: required: true - description: > - Regular expression for filtering the events based on - the content of their summary, description or location. + description: Regular expression for filtering the events based on the content of their summary, description or location. type: string {% endconfiguration %} @@ -139,6 +117,7 @@ custom_calendars: ### Examples All events of the calendars "private" and "holidays". Note that all day events are not included. + ```yaml # Example configuration.yaml entry for nextcloud calendar: @@ -151,12 +130,9 @@ calendar: - holidays ``` -Full example with automation to wake up to music if not holiday. -Prerequisite: you have a calendar named "work" where -you create calendar entries containing "Holiday". +Full example with automation to wake up to music if not holiday. Prerequisite: you have a calendar named "work" where you create calendar entries containing "Holiday". -Custom calendar names are built from the -main calendar + name of the custom calendar. +Custom calendar names are built from the main calendar + name of the custom calendar. Using the option of `'.*'` will load all calendar events. ```yaml # configuration.yaml @@ -169,6 +145,9 @@ calendar: - name: holiday calendar: work search: 'Holiday' + - name: vacation + calendar: vacation + search: '.*' # automations.yaml - id: wakeup diff --git a/source/_integrations/calendar.google.markdown b/source/_integrations/calendar.google.markdown index 4613dc8bfa6..9c539bbdb79 100644 --- a/source/_integrations/calendar.google.markdown +++ b/source/_integrations/calendar.google.markdown @@ -1,11 +1,11 @@ --- title: "Google Calendar Event" description: "Instructions on how to use Google Calendars in Home Assistant." -logo: google_calendar.png ha_category: - Calendar ha_iot_class: Cloud Polling ha_release: 0.33 +ha_domain: google --- The `google` calendar platform allows you to connect to your diff --git a/source/_integrations/calendar.markdown b/source/_integrations/calendar.markdown index 4fc7a0be0dd..3af6368dcd9 100644 --- a/source/_integrations/calendar.markdown +++ b/source/_integrations/calendar.markdown @@ -2,6 +2,7 @@ title: Calendar description: Instructions on how to integrate calendars within Home Assistant. ha_release: 0.33 +ha_domain: calendar --- The calendar integration allows you to integrate your calendars into Home Assistant. diff --git a/source/_integrations/camera.ffmpeg.markdown b/source/_integrations/camera.ffmpeg.markdown index 4b23c2f5d43..603ee64b893 100644 --- a/source/_integrations/camera.ffmpeg.markdown +++ b/source/_integrations/camera.ffmpeg.markdown @@ -1,11 +1,11 @@ --- title: "FFmpeg Camera" description: "Instructions on how to integrate a video feed via FFmpeg as a camera within Home Assistant." -logo: ffmpeg.png ha_category: - Camera ha_release: 0.26 ha_iot_class: Local Polling +ha_domain: ffmpeg --- The `ffmpeg` platform allows you to use any video feed as a camera in Home Assistant via [FFmpeg](https://www.ffmpeg.org/). This video source must support multiple simultaneous reads, because for every concurrent Home Assistant user, a connection will be made to the source every 10 seconds. Normally this should not be a problem. diff --git a/source/_integrations/camera.markdown b/source/_integrations/camera.markdown index 6e65fd21493..2a6ea0b9884 100644 --- a/source/_integrations/camera.markdown +++ b/source/_integrations/camera.markdown @@ -1,11 +1,11 @@ --- title: Camera description: Instructions on how to integrate cameras within Home Assistant. -logo: home-assistant.png ha_category: - Camera ha_release: 0.7 ha_quality_scale: internal +ha_domain: camera --- The camera integration allows you to use IP cameras with Home Assistant. diff --git a/source/_integrations/camera.mqtt.markdown b/source/_integrations/camera.mqtt.markdown index 76d52029349..d5ddcc1d462 100644 --- a/source/_integrations/camera.mqtt.markdown +++ b/source/_integrations/camera.mqtt.markdown @@ -1,11 +1,11 @@ --- title: "MQTT Camera" description: "Instructions on how to use an MQTT image message as a Camera within Home Assistant." -logo: mqtt.png ha_category: - Camera ha_release: 0.43 ha_iot_class: Configurable +ha_domain: mqtt --- The `mqtt` camera platform allows you to integrate the content of an image file sent through MQTT into Home Assistant as a camera. Every time a message under the `topic` in the configuration is received, the image displayed in Home Assistant will also be updated. @@ -24,31 +24,19 @@ camera: ``` {% configuration %} -topic: - description: The MQTT topic to subscribe to. - required: true - type: string -name: - description: The name of the camera. - required: false - type: string -unique_id: - description: An ID that uniquely identifies this camera. If two cameras have the same unique ID Home Assistant will raise an exception. - required: false - type: string device: description: "Information about the device this camera is a part of to tie it into the [device registry](https://developers.home-assistant.io/docs/en/device_registry_index.html). Only works through [MQTT discovery](/docs/mqtt/discovery/) and when [`unique_id`](#unique_id) is set." required: false type: map keys: - identifiers: - description: 'A list of IDs that uniquely identify the device. For example a serial number.' - required: false - type: [list, string] connections: description: 'A list of connections of the device to the outside world as a list of tuples `[connection_type, connection_identifier]`. For example the MAC address of a network interface: `"connections": ["mac", "02:5b:26:a8:dc:12"]`.' required: false type: list + identifiers: + description: 'A list of IDs that uniquely identify the device. For example a serial number.' + required: false + type: [list, string] manufacturer: description: The manufacturer of the device. required: false @@ -65,4 +53,16 @@ device: description: The firmware version of the device. required: false type: string +name: + description: The name of the camera. + required: false + type: string +topic: + description: The MQTT topic to subscribe to. + required: true + type: string +unique_id: + description: An ID that uniquely identifies this camera. If two cameras have the same unique ID Home Assistant will raise an exception. + required: false + type: string {% endconfiguration %} diff --git a/source/_integrations/canary.markdown b/source/_integrations/canary.markdown index 39ba3aa1cc3..1559c522efb 100644 --- a/source/_integrations/canary.markdown +++ b/source/_integrations/canary.markdown @@ -8,6 +8,7 @@ ha_category: - Sensor ha_release: '0.60' ha_iot_class: Cloud Polling +ha_domain: canary --- The `canary` integration allows you to integrate your [Canary](https://canary.is) devices in Home Assistant. diff --git a/source/_integrations/cast.markdown b/source/_integrations/cast.markdown index 7888edbb168..8a326f576ac 100644 --- a/source/_integrations/cast.markdown +++ b/source/_integrations/cast.markdown @@ -1,13 +1,13 @@ --- title: Google Cast description: Instructions on how to integrate Google Cast into Home Assistant. -logo: google_cast.png ha_category: - Media Player featured: true ha_release: pre 0.7 ha_iot_class: Local Polling ha_config_flow: true +ha_domain: cast --- You can enable the Cast integration by going to the Integrations page inside the configuration panel. diff --git a/source/_integrations/cert_expiry.markdown b/source/_integrations/cert_expiry.markdown index bd9145cd66d..92141d2ff65 100644 --- a/source/_integrations/cert_expiry.markdown +++ b/source/_integrations/cert_expiry.markdown @@ -1,7 +1,6 @@ --- title: Certificate Expiry description: Instructions on how to set up HTTPS (SSL) certificate expiry sensors within Home Assistant. -logo: home-assistant.png ha_category: - Network ha_release: 0.44 @@ -10,6 +9,7 @@ ha_config_flow: true ha_codeowners: - '@Cereal2nd' - '@jjlawren' +ha_domain: cert_expiry --- The `cert_expiry` sensor fetches information from a configured URL and displays the certificate expiry in days. @@ -18,7 +18,7 @@ The `cert_expiry` sensor fetches information from a configured URL and displays There are 2 options in configuring the `cert_expiry` sensor: -- Via the Home Assistant user interface where it will let you enter a name, host and port for the certificate to check. +- Via the Home Assistant user interface where it will let you enter a host and port for the certificate to check. - Via the Home Assistant `configuration.yaml` file. @@ -39,13 +39,17 @@ port: required: false default: 443 type: integer -name: - description: The friendly name for the certificate. - required: false - default: SSL Certificate Expiry - type: string {% endconfiguration %} +## Attributes + +The Certificate Expiry entities provide extra attributes to represent the state of the certificate. + +| Name | Description | +| ---- | ----------- | +| `is_valid` | If the certificate is able to be validated: `True` / `False`. +| `error` | A human-readable error description if the certificate is considered invalid, "None" otherwise. +
    Make sure that the URL exactly matches your endpoint or resource.
    diff --git a/source/_integrations/channels.markdown b/source/_integrations/channels.markdown index 8c6cb579464..0ffdaf671d4 100644 --- a/source/_integrations/channels.markdown +++ b/source/_integrations/channels.markdown @@ -6,6 +6,7 @@ ha_category: - Media Player ha_release: 0.65 ha_iot_class: Local Polling +ha_domain: channels --- The Channels platform allows you to control [Channels](https://getchannels.com/) from Home Assistant. Play, pause, seek, or skip commercials on an instance of Channels that is running on your network. diff --git a/source/_integrations/cisco_ios.markdown b/source/_integrations/cisco_ios.markdown index ef704dbafde..8e5f8d80259 100644 --- a/source/_integrations/cisco_ios.markdown +++ b/source/_integrations/cisco_ios.markdown @@ -7,6 +7,7 @@ ha_category: ha_release: 0.33 ha_codeowners: - '@fbradyirl' +ha_domain: cisco_ios --- This is a presence detection scanner for [Cisco IOS](https://www.cisco.com/) devices. diff --git a/source/_integrations/cisco_mobility_express.markdown b/source/_integrations/cisco_mobility_express.markdown index 901828c5a5a..13047b645a5 100644 --- a/source/_integrations/cisco_mobility_express.markdown +++ b/source/_integrations/cisco_mobility_express.markdown @@ -7,6 +7,7 @@ ha_category: ha_release: '0.90' ha_codeowners: - '@fbradyirl' +ha_domain: cisco_mobility_express --- This is a presence detection scanner for [Cisco](https://www.cisco.com) Mobility Express wireless controllers. diff --git a/source/_integrations/cisco_webex_teams.markdown b/source/_integrations/cisco_webex_teams.markdown index 1b2bce65a11..6d137842a8d 100644 --- a/source/_integrations/cisco_webex_teams.markdown +++ b/source/_integrations/cisco_webex_teams.markdown @@ -1,12 +1,12 @@ --- title: Cisco Webex Teams description: Instructions on how to add Cisco Webex Teams notifications to Home Assistant. -logo: cisco_webex_teams.png ha_category: - Notifications ha_release: '0.40' ha_codeowners: - '@fbradyirl' +ha_domain: cisco_webex_teams --- The `cisco_webex_teams` notification platform allows you to deliver rich notifications from Home Assistant to [Cisco Webex Teams](https://www.webex.com/team-collaboration.html) (formerly known as Cisco Spark). diff --git a/source/_integrations/citybikes.markdown b/source/_integrations/citybikes.markdown index fcffee6f642..380a8a9836b 100644 --- a/source/_integrations/citybikes.markdown +++ b/source/_integrations/citybikes.markdown @@ -1,10 +1,10 @@ --- title: CityBikes description: Instructions on how to integrate data from the CityBikes API into Home Assistant. -logo: citybikes.png ha_category: - Transport ha_release: 0.49 +ha_domain: citybikes --- The `citybikes` sensor platform monitors bike availability at bike sharing stations in a chosen area. The data is provided by [CityBikes](https://citybik.es/#about), which supports bike sharing systems all around the world. diff --git a/source/_integrations/clementine.markdown b/source/_integrations/clementine.markdown index 3ad0039d8c5..052e18cbf0c 100644 --- a/source/_integrations/clementine.markdown +++ b/source/_integrations/clementine.markdown @@ -1,11 +1,11 @@ --- title: Clementine Music Player description: Instructions on how to integrate Clementine Music Player within Home Assistant. -logo: clementine.png ha_category: - Media Player ha_release: 0.39 ha_iot_class: Local Polling +ha_domain: clementine --- The `clementine` platform allows you to control a [Clementine Music Player](https://www.clementine-player.org). diff --git a/source/_integrations/clickatell.markdown b/source/_integrations/clickatell.markdown index e01933cf1df..aecfd822ad6 100644 --- a/source/_integrations/clickatell.markdown +++ b/source/_integrations/clickatell.markdown @@ -5,6 +5,7 @@ logo: clickatell.png ha_category: - Notifications ha_release: 0.56 +ha_domain: clickatell --- The `clickatell` platform uses [Clickatell](https://clickatell.com) to deliver SMS notifications from Home Assistant. diff --git a/source/_integrations/clicksend.markdown b/source/_integrations/clicksend.markdown index 4c2a625f9fd..fe4e6b8290b 100644 --- a/source/_integrations/clicksend.markdown +++ b/source/_integrations/clicksend.markdown @@ -1,10 +1,10 @@ --- title: ClickSend SMS description: Instructions on how to add ClickSend notifications to Home Assistant. -logo: clicksend.png ha_category: - Notifications ha_release: 0.48 +ha_domain: clicksend --- The `clicksend` platform uses [ClickSend](https://clicksend.com) to deliver notifications from Home Assistant. diff --git a/source/_integrations/clicksend_tts.markdown b/source/_integrations/clicksend_tts.markdown index 544c71e9748..c41db4bd76a 100644 --- a/source/_integrations/clicksend_tts.markdown +++ b/source/_integrations/clicksend_tts.markdown @@ -1,10 +1,10 @@ --- title: ClickSend TTS description: Instructions on how to add ClickSend text-to-speech (TTS) notifications to Home Assistant. -logo: clicksend.png ha_category: - Notifications ha_release: 0.55 +ha_domain: clicksend_tts --- The `clicksend_tts` platform uses [ClickSend](https://clicksend.com) to deliver text-to-speech (TTS) notifications from Home Assistant. diff --git a/source/_integrations/climate.knx.markdown b/source/_integrations/climate.knx.markdown index 9274d7acbc6..1c4eb77c596 100644 --- a/source/_integrations/climate.knx.markdown +++ b/source/_integrations/climate.knx.markdown @@ -1,11 +1,11 @@ --- title: "KNX Climate" description: "Instructions on how to integrate KNX thermostats with Home Assistant." -logo: knx.png ha_category: - Climate ha_release: 0.25 ha_iot_class: Local Push +ha_domain: knx ---
    @@ -48,7 +48,7 @@ climate: operation_mode_state_address: '5/1/8' ``` -If your device doesn't support setpoint_shift calculations (i.e. if you don't provide a `setpoint_shift_address` value) please set the `min_temp` and `max_temp` +If your device doesn't support setpoint_shift calculations (i.e., if you don't provide a `setpoint_shift_address` value) please set the `min_temp` and `max_temp` attributes of the climate device to avoid issues with exceeding valid temperature values in the frontend. Please do also make sure to add the `target_temperature_address` to the configuration in this case.: diff --git a/source/_integrations/climate.markdown b/source/_integrations/climate.markdown index a7a4fba80ce..5956c1b6c3f 100644 --- a/source/_integrations/climate.markdown +++ b/source/_integrations/climate.markdown @@ -1,11 +1,11 @@ --- title: Climate description: Instructions on how to setup climate control devices within Home Assistant. -logo: home-assistant.png ha_category: - Climate ha_release: 0.19 ha_quality_scale: internal +ha_domain: climate --- The Climate integration allows you to control and monitor HVAC (heating, ventilating, and air conditioning) devices and thermostats. diff --git a/source/_integrations/climate.modbus.markdown b/source/_integrations/climate.modbus.markdown index 827160891c4..ab74ffeac3f 100644 --- a/source/_integrations/climate.modbus.markdown +++ b/source/_integrations/climate.modbus.markdown @@ -1,11 +1,11 @@ --- title: "Modbus Climate" description: "Instructions how to integrate a Modbus thermostat within Home Assistant." -logo: modbus.png ha_category: - Climate ha_release: 0.68 ha_iot_class: Local Polling +ha_domain: modbus --- diff --git a/source/_integrations/climate.mqtt.markdown b/source/_integrations/climate.mqtt.markdown index 60c84f1e378..fa9b95d703c 100644 --- a/source/_integrations/climate.mqtt.markdown +++ b/source/_integrations/climate.mqtt.markdown @@ -1,11 +1,11 @@ --- title: "MQTT HVAC" description: "Instructions on how to integrate MQTT HVAC into Home Assistant." -logo: mqtt.png ha_category: - Climate ha_release: 0.55 ha_iot_class: Local Polling +ha_domain: mqtt --- The `mqtt` climate platform lets you control your MQTT enabled HVAC devices. @@ -21,259 +21,65 @@ climate: ``` {% configuration %} -name: - description: The name of the HVAC. - required: false - type: string - default: MQTT HVAC -unique_id: - description: An ID that uniquely identifies this HVAC device. If two HVAC devices have the same unique ID, Home Assistant will raise an exception. - required: false - type: string -qos: - description: The maximum QoS level to be used when receiving and publishing messages. - required: false - type: integer - default: 0 -retain: - description: Defines if published messages should have the retain flag set. - required: false - type: boolean - default: false -send_if_off: - description: "Set to `false` to suppress sending of all MQTT messages when the current mode is `Off`." - required: false - type: boolean - default: true -initial: - description: Set the initial target temperature. - required: false - type: integer - default: 21 -payload_on: - description: The payload that represents enabled state. - required: false - type: string - default: "ON" -payload_off: - description: The payload that represents disabled state. - required: false - type: string - default: "OFF" -availability_topic: - description: The MQTT topic subscribed to receive availability (online/offline) updates. - required: false - type: string -payload_available: - description: The payload that represents the available state. - required: false - type: string - default: online -payload_not_available: - description: The payload that represents the unavailable state. - required: false - type: string - default: offline -value_template: - description: Default template to render the payloads on *all* `*_state_topic`s with. - type: template - required: false -current_temperature_topic: - description: The MQTT topic on which to listen for the current temperature. - required: false - type: string -current_temperature_template: - description: A template with which the value received on `current_temperature_topic` will be rendered. +action_template: + description: A template to render the value received on the `action_topic` with. required: false type: template -power_command_topic: - description: The MQTT topic to publish commands to change the power state. This is useful if your device has a separate power toggle in addition to mode. - required: false - type: string action_topic: description: >- The MQTT topic to subscribe for changes of the current action. If this is set, the climate graph uses the value received as data source. Valid values: `off`, `heating`, `cooling`, `drying`, `idle`, `fan`. required: false type: string -action_template: - description: A template to render the value received on the `action_topic` with. - required: false - type: template -mode_command_topic: - description: The MQTT topic to publish commands to change the HVAC operation mode. - required: false - type: string -mode_state_topic: - description: The MQTT topic to subscribe for changes of the HVAC operation mode. If this is not set, the operation mode works in optimistic mode (see below). - required: false - type: string -mode_state_template: - description: A template to render the value received on the `mode_state_topic` with. - required: false - type: template -modes: - description: A list of supported modes. Needs to be a subset of the default values. - required: false - default: ['auto', 'off', 'cool', 'heat', 'dry', 'fan_only'] - type: list -action_topic: - description: The MQTT topic on which to listen for the current action state of the HVAC. Expects `idle`, `cooling`, `heating`, `drying`, or `off`. - required: false - type: string -action_template: - description: A template to render the value received on the `action_topic` with. - required: false - type: template -temperature_command_topic: - description: The MQTT topic to publish commands to change the target temperature. - required: false - type: string -temperature_state_topic: - description: The MQTT topic to subscribe for changes in the target temperature. If this is not set, the target temperature works in optimistic mode (see below). - required: false - type: string -temperature_state_template: - description: A template to render the value received on the `temperature_state_topic` with. - required: false - type: template -temperature_low_command_topic: - description: The MQTT topic to publish commands to change the target low temperature. - required: false - type: string -temperature_low_state_topic: - description: The MQTT topic to subscribe for changes in the target low temperature. If this is not set, the target low temperature works in optimistic mode (see below). - required: false - type: string -temperature_low_state_template: - description: A template to render the value received on the `temperature_low_state_topic` with. - required: false - type: template -temperature_high_command_topic: - description: The MQTT topic to publish commands to change the high target temperature. - required: false - type: string -temperature_high_state_topic: - description: The MQTT topic to subscribe for changes in the target high temperature. If this is not set, the target high temperature works in optimistic mode (see below). - required: false - type: string -temperature_high_state_template: - description: A template to render the value received on the `temperature_high_state_topic` with. - required: false - type: template -precision: - description: The desired precision for this device. Can be used to match your actual thermostat's precision. Supported values are `0.1`, `0.5` and `1.0`. - required: false - type: float - default: 0.1 for Celsius and 1.0 for Fahrenheit. -fan_mode_command_topic: - description: The MQTT topic to publish commands to change the fan mode. - required: false - type: string -fan_mode_state_topic: - description: The MQTT topic to subscribe for changes of the HVAC fan mode. If this is not set, the fan mode works in optimistic mode (see below). - required: false - type: string -fan_mode_state_template: - description: A template to render the value received on the `fan_mode_state_topic` with. - required: false - type: template -fan_modes: - description: A list of supported fan modes. - required: false - default: ['auto', 'low', 'medium', 'high'] - type: list -swing_mode_command_topic: - description: The MQTT topic to publish commands to change the swing mode. - required: false - type: string -swing_mode_state_topic: - description: The MQTT topic to subscribe for changes of the HVAC swing mode. If this is not set, the swing mode works in optimistic mode (see below). - required: false - type: string -swing_mode_state_template: - description: A template to render the value received on the `swing_mode_state_topic` with. - required: false - type: template -swing_modes: - description: A list of supported swing modes. - required: false - default: ['on', 'off'] - type: list -away_mode_command_topic: - description: The MQTT topic to publish commands to change the away mode. - required: false - type: string -away_mode_state_topic: - description: The MQTT topic to subscribe for changes of the HVAC away mode. If this is not set, the away mode works in optimistic mode (see below). - required: false - type: string -away_mode_state_template: - description: A template to render the value received on the `away_mode_state_topic` with. - required: false - type: template -hold_command_topic: - description: The MQTT topic to publish commands to change the hold mode. - required: false - type: string -hold_state_topic: - description: The MQTT topic to subscribe for changes of the HVAC hold mode. If this is not set, the hold mode works in optimistic mode (see below). - required: false - type: string -hold_state_template: - description: A template to render the value received on the `hold_state_topic` with. - required: false - type: template -hold_modes: - description: A list of available hold modes. - required: false - type: list aux_command_topic: description: The MQTT topic to publish commands to switch auxiliary heat. required: false type: string -aux_state_topic: - description: The MQTT topic to subscribe for changes of the auxiliary heat mode. If this is not set, the auxiliary heat mode works in optimistic mode (see below). - required: false - type: string aux_state_template: description: A template to render the value received on the `aux_state_topic` with. required: false type: template -min_temp: - description: Minimum set point available. - type: float - required: false -max_temp: - description: Maximum set point available. - type: float - required: false -temp_step: - description: Step size for temperature set point. - type: float - required: false - default: 1 -json_attributes_topic: - description: The MQTT topic subscribed to receive a JSON dictionary payload and then set as sensor attributes. Usage example can be found in [MQTT sensor](/integrations/sensor.mqtt/#json-attributes-topic-configuration) documentation. +aux_state_topic: + description: The MQTT topic to subscribe for changes of the auxiliary heat mode. If this is not set, the auxiliary heat mode works in optimistic mode (see below). required: false type: string -json_attributes_template: - description: "Defines a [template](/docs/configuration/templating/#processing-incoming-data) to extract the JSON dictionary from messages received on the `json_attributes_topic`. Usage example can be found in [MQTT sensor](/integrations/sensor.mqtt/#json-attributes-template-configuration) documentation." +availability_topic: + description: The MQTT topic subscribed to receive availability (online/offline) updates. + required: false + type: string +away_mode_command_topic: + description: The MQTT topic to publish commands to change the away mode. + required: false + type: string +away_mode_state_template: + description: A template to render the value received on the `away_mode_state_topic` with. required: false type: template +away_mode_state_topic: + description: The MQTT topic to subscribe for changes of the HVAC away mode. If this is not set, the away mode works in optimistic mode (see below). + required: false + type: string +current_temperature_template: + description: A template with which the value received on `current_temperature_topic` will be rendered. + required: false + type: template +current_temperature_topic: + description: The MQTT topic on which to listen for the current temperature. + required: false + type: string device: description: 'Information about the device this HVAC device is a part of to tie it into the [device registry](https://developers.home-assistant.io/docs/en/device_registry_index.html). Only works through [MQTT discovery](/docs/mqtt/discovery/) and when [`unique_id`](#unique_id) is set.' required: false type: map keys: - identifiers: - description: 'A list of IDs that uniquely identify the device. For example a serial number.' - required: false - type: [list, string] connections: description: 'A list of connections of the device to the outside world as a list of tuples `[connection_type, connection_identifier]`. For example the MAC address of a network interface: `"connections": [["mac", "02:5b:26:a8:dc:12"]]`.' required: false type: list + identifiers: + description: 'A list of IDs that uniquely identify the device. For example a serial number.' + required: false + type: [list, string] manufacturer: description: 'The manufacturer of the device.' required: false @@ -290,6 +96,192 @@ device: description: 'The firmware version of the device.' required: false type: string +fan_mode_command_topic: + description: The MQTT topic to publish commands to change the fan mode. + required: false + type: string +fan_mode_state_template: + description: A template to render the value received on the `fan_mode_state_topic` with. + required: false + type: template +fan_mode_state_topic: + description: The MQTT topic to subscribe for changes of the HVAC fan mode. If this is not set, the fan mode works in optimistic mode (see below). + required: false + type: string +fan_modes: + description: A list of supported fan modes. + required: false + default: ['auto', 'low', 'medium', 'high'] + type: list +hold_command_topic: + description: The MQTT topic to publish commands to change the hold mode. + required: false + type: string +hold_state_template: + description: A template to render the value received on the `hold_state_topic` with. + required: false + type: template +hold_state_topic: + description: The MQTT topic to subscribe for changes of the HVAC hold mode. If this is not set, the hold mode works in optimistic mode (see below). + required: false + type: string +hold_modes: + description: A list of available hold modes. + required: false + type: list +initial: + description: Set the initial target temperature. + required: false + type: integer + default: 21 +json_attributes_template: + description: "Defines a [template](/docs/configuration/templating/#processing-incoming-data) to extract the JSON dictionary from messages received on the `json_attributes_topic`. Usage example can be found in [MQTT sensor](/integrations/sensor.mqtt/#json-attributes-template-configuration) documentation." + required: false + type: template +json_attributes_topic: + description: The MQTT topic subscribed to receive a JSON dictionary payload and then set as sensor attributes. Usage example can be found in [MQTT sensor](/integrations/sensor.mqtt/#json-attributes-topic-configuration) documentation. + required: false + type: string +max_temp: + description: Maximum set point available. + type: float + required: false +min_temp: + description: Minimum set point available. + type: float + required: false +mode_command_topic: + description: The MQTT topic to publish commands to change the HVAC operation mode. + required: false + type: string +mode_state_template: + description: A template to render the value received on the `mode_state_topic` with. + required: false + type: template +mode_state_topic: + description: The MQTT topic to subscribe for changes of the HVAC operation mode. If this is not set, the operation mode works in optimistic mode (see below). + required: false + type: string +modes: + description: A list of supported modes. Needs to be a subset of the default values. + required: false + default: ['auto', 'off', 'cool', 'heat', 'dry', 'fan_only'] + type: list +name: + description: The name of the HVAC. + required: false + type: string + default: MQTT HVAC +payload_available: + description: The payload that represents the available state. + required: false + type: string + default: online +payload_not_available: + description: The payload that represents the unavailable state. + required: false + type: string + default: offline +payload_off: + description: The payload that represents disabled state. + required: false + type: string + default: "OFF" +payload_on: + description: The payload that represents enabled state. + required: false + type: string + default: "ON" +power_command_topic: + description: The MQTT topic to publish commands to change the power state. This is useful if your device has a separate power toggle in addition to mode. + required: false + type: string +precision: + description: The desired precision for this device. Can be used to match your actual thermostat's precision. Supported values are `0.1`, `0.5` and `1.0`. + required: false + type: float + default: 0.1 for Celsius and 1.0 for Fahrenheit. +qos: + description: The maximum QoS level to be used when receiving and publishing messages. + required: false + type: integer + default: 0 +retain: + description: Defines if published messages should have the retain flag set. + required: false + type: boolean + default: false +send_if_off: + description: "Set to `false` to suppress sending of all MQTT messages when the current mode is `Off`." + required: false + type: boolean + default: true +swing_mode_command_topic: + description: The MQTT topic to publish commands to change the swing mode. + required: false + type: string +swing_mode_state_template: + description: A template to render the value received on the `swing_mode_state_topic` with. + required: false + type: template +swing_mode_state_topic: + description: The MQTT topic to subscribe for changes of the HVAC swing mode. If this is not set, the swing mode works in optimistic mode (see below). + required: false + type: string +swing_modes: + description: A list of supported swing modes. + required: false + default: ['on', 'off'] + type: list +temperature_command_topic: + description: The MQTT topic to publish commands to change the target temperature. + required: false + type: string +temperature_high_command_topic: + description: The MQTT topic to publish commands to change the high target temperature. + required: false + type: string +temperature_high_state_template: + description: A template to render the value received on the `temperature_high_state_topic` with. + required: false + type: template +temperature_high_state_topic: + description: The MQTT topic to subscribe for changes in the target high temperature. If this is not set, the target high temperature works in optimistic mode (see below). + required: false + type: string +temperature_low_command_topic: + description: The MQTT topic to publish commands to change the target low temperature. + required: false + type: string +temperature_low_state_template: + description: A template to render the value received on the `temperature_low_state_topic` with. + required: false + type: template +temperature_low_state_topic: + description: The MQTT topic to subscribe for changes in the target low temperature. If this is not set, the target low temperature works in optimistic mode (see below). + required: false + type: string +temperature_state_template: + description: A template to render the value received on the `temperature_state_topic` with. + required: false + type: template +temperature_state_topic: + description: The MQTT topic to subscribe for changes in the target temperature. If this is not set, the target temperature works in optimistic mode (see below). + required: false + type: string +temp_step: + description: Step size for temperature set point. + type: float + required: false + default: 1 +unique_id: + description: An ID that uniquely identifies this HVAC device. If two HVAC devices have the same unique ID, Home Assistant will raise an exception. + required: false + type: string +value_template: + description: Default template to render the payloads on *all* `*_state_topic`s with. + type: template + required: false {% endconfiguration %} #### Optimistic mode diff --git a/source/_integrations/climate.mysensors.markdown b/source/_integrations/climate.mysensors.markdown index 9200dffac11..587c0f06491 100644 --- a/source/_integrations/climate.mysensors.markdown +++ b/source/_integrations/climate.mysensors.markdown @@ -1,12 +1,12 @@ --- title: "MySensors HVAC" description: "Instructions on how to integrate MySensors climate into Home Assistant." -logo: mysensors.png ha_category: - DIY - Climate ha_release: 0.29 ha_iot_class: Local Push +ha_domain: mysensors --- Integrates MySensors HVAC into Home Assistant. See the [main integration](/integrations/mysensors/) for configuration instructions. diff --git a/source/_integrations/cloud.markdown b/source/_integrations/cloud.markdown index 89959da111f..ffe34c8cbe9 100644 --- a/source/_integrations/cloud.markdown +++ b/source/_integrations/cloud.markdown @@ -1,13 +1,13 @@ --- title: Home Assistant Cloud description: Enable the Home Assistant Cloud integration. -logo: nabu-casa.svg ha_release: '0.60' ha_category: - Voice ha_iot_class: Cloud Push ha_codeowners: - '@home-assistant/cloud' +ha_domain: cloud --- The Home Assistant Cloud allows you to quickly integrate your local Home Assistant with various cloud services like Amazon Alexa and Google Assistant. [Learn more.](/cloud) diff --git a/source/_integrations/cloudflare.markdown b/source/_integrations/cloudflare.markdown index fb40d370c4e..ad44a482d26 100644 --- a/source/_integrations/cloudflare.markdown +++ b/source/_integrations/cloudflare.markdown @@ -1,12 +1,12 @@ --- title: Cloudflare description: Automatically update your Cloudflare DNS records. -logo: cloudflare.png ha_category: - Network ha_release: 0.74 ha_codeowners: - '@ludeeus' +ha_domain: cloudflare --- With the `cloudflare` integration, you can keep your Cloudflare records up to date. diff --git a/source/_integrations/cmus.markdown b/source/_integrations/cmus.markdown index f995a5d9109..f2fc588361c 100644 --- a/source/_integrations/cmus.markdown +++ b/source/_integrations/cmus.markdown @@ -5,6 +5,7 @@ ha_category: - Media Player ha_iot_class: Local Polling ha_release: 0.23 +ha_domain: cmus --- The `cmus` platform allows you to control a [cmus](https://cmus.github.io/) music player on a remote or local machine from Home Assistant. diff --git a/source/_integrations/co2signal.markdown b/source/_integrations/co2signal.markdown index b51ecea755b..718fa019957 100644 --- a/source/_integrations/co2signal.markdown +++ b/source/_integrations/co2signal.markdown @@ -6,6 +6,7 @@ ha_category: - Environment ha_release: 0.87 ha_iot_class: Cloud Polling +ha_domain: co2signal --- The `co2signal` sensor platform queries the [CO2Signal](https://www.co2signal.com/) API for the CO2 intensity of a specific region. Data can be collected via latitude/longitude or by country code. This API uses the same data as Not all countries/regions in the world are supported so please consult this website to check local availability. diff --git a/source/_integrations/coinbase.markdown b/source/_integrations/coinbase.markdown index 347faa17270..7a9400b074b 100644 --- a/source/_integrations/coinbase.markdown +++ b/source/_integrations/coinbase.markdown @@ -7,6 +7,7 @@ ha_category: - Sensor ha_release: 0.61 ha_iot_class: Cloud Polling +ha_domain: coinbase --- The `coinbase` integration lets you access account balances and exchange rates from [coinbase](https://coinbase.com). @@ -44,7 +45,7 @@ exchange_rate_currencies: type: list {% endconfiguration %} -Possible currencies are codes that conform to the ISO 4217 standard where possible. Currencies which have or had no representation in ISO 4217 may use a custom code (e.g. BTC). A list of values can be obtained via https://api.coinbase.com/v2/currencies, for more information visit [the Coinbase API documentation](https://developers.coinbase.com/api/v2#get-currencies). +Possible currencies are codes that conform to the ISO 4217 standard where possible. Currencies which have or had no representation in ISO 4217 may use a custom code (e.g., BTC). A list of values can be obtained via https://api.coinbase.com/v2/currencies, for more information visit [the Coinbase API documentation](https://developers.coinbase.com/api/v2#get-currencies). ## Full configuration example diff --git a/source/_integrations/coinmarketcap.markdown b/source/_integrations/coinmarketcap.markdown index 6a13cbff593..62e0e833a19 100644 --- a/source/_integrations/coinmarketcap.markdown +++ b/source/_integrations/coinmarketcap.markdown @@ -1,11 +1,11 @@ --- title: CoinMarketCap description: Instructions on how to integrate CoinMarketCap data within Home Assistant. -logo: coinmarketcap.png ha_category: - Finance ha_release: 0.28 ha_iot_class: Cloud Polling +ha_domain: coinmarketcap --- The `coinmarketcap` sensor platform displays various details about a cryptocurrency provided by [CoinMarketCap](https://coinmarketcap.com/). @@ -36,4 +36,4 @@ display_currency_decimals: default: 2 {% endconfiguration %} -All supported currencies can be found [here](https://coinmarketcap.com/api/), a list of currency IDs can be found [here](https://api.coinmarketcap.com/v2/ticker/). +All supported currencies can be found [here](https://coinmarketcap.com/api/documentation/v1/#section/Standards-and-Conventions), a list of currency IDs can be found [here](https://api.coinmarketcap.com/v2/ticker/). diff --git a/source/_integrations/comed_hourly_pricing.markdown b/source/_integrations/comed_hourly_pricing.markdown index 10cb0c14dc1..1c112c28f8b 100644 --- a/source/_integrations/comed_hourly_pricing.markdown +++ b/source/_integrations/comed_hourly_pricing.markdown @@ -6,6 +6,7 @@ ha_category: - Energy ha_release: '0.40' ha_iot_class: Cloud Polling +ha_domain: comed_hourly_pricing --- The ComEd Hourly Pricing program is an optional program available to ComEd electric subscribers which charges customers a variable rate for electricity supply based on current demand rather than a traditional fixed rate. Live prices are published [here](https://hourlypricing.comed.com/live-prices/) and also via an [API](https://hourlypricing.comed.com/hp-api/) which we can integrate as a sensor in Home Assistant. diff --git a/source/_integrations/comfoconnect.markdown b/source/_integrations/comfoconnect.markdown index fbe7434a140..db447944fe9 100644 --- a/source/_integrations/comfoconnect.markdown +++ b/source/_integrations/comfoconnect.markdown @@ -9,6 +9,7 @@ ha_release: 0.48 ha_iot_class: Local Push ha_codeowners: - '@michaelarnauts' +ha_domain: comfoconnect --- The `comfoconnect` integration lets you control Zehnder ComfoAir [Q350](https://www.international.zehnder-systems.com/products-and-systems/comfosystems/zehnder-comfoair-q350-tr)/[Q450](https://www.international.zehnder-systems.com/products-and-systems/comfosystems/zehnder-comfoair-q450-tr)/[Q600](https://www.international.zehnder-systems.com/products-and-systems/comfosystems/zehnder-comfoair-q600-st) diff --git a/source/_integrations/command_line.markdown b/source/_integrations/command_line.markdown index 252344982eb..79984ea78f3 100644 --- a/source/_integrations/command_line.markdown +++ b/source/_integrations/command_line.markdown @@ -1,11 +1,12 @@ --- title: Command Line description: Instructions on how to integrate Command binary sensors within Home Assistant. -logo: command_line.png ha_category: - Utility + - Binary Sensor ha_release: 0.12 ha_iot_class: Local Polling +ha_domain: command_line --- The `command_line` binary sensor platform issues specific commands to get data. diff --git a/source/_integrations/concord232.markdown b/source/_integrations/concord232.markdown index ea0b3bf88ef..34ad9f193ab 100644 --- a/source/_integrations/concord232.markdown +++ b/source/_integrations/concord232.markdown @@ -6,6 +6,7 @@ ha_category: - Alarm - Binary Sensor ha_release: 0.31 +ha_domain: concord232 --- The `concord232` platform provides integration with GE, Interlogix (and other brands) alarm panels that support the RS-232 Automation Control Panel interface module (or have it built in). Supported panels include Concord 4. diff --git a/source/_integrations/config.markdown b/source/_integrations/config.markdown index c20362b7eef..8f24cfdd54b 100644 --- a/source/_integrations/config.markdown +++ b/source/_integrations/config.markdown @@ -1,13 +1,13 @@ --- title: Configuration description: Instructions on how to setup the configuration panel for Home Assistant. -logo: home-assistant.png ha_category: - Front End ha_release: 0.39 ha_quality_scale: internal ha_codeowners: - '@home-assistant/core' +ha_domain: config --- The `config` integration is designed to display panels in the frontend to configure and manage parts of Home Assistant. diff --git a/source/_integrations/configurator.markdown b/source/_integrations/configurator.markdown index 0ba4152338e..679a8bc13ac 100644 --- a/source/_integrations/configurator.markdown +++ b/source/_integrations/configurator.markdown @@ -1,13 +1,13 @@ --- title: Configurator description: Instructions on how to integrate the configurator in your components. -logo: home-assistant.png ha_category: - Other ha_release: 0.7 ha_quality_scale: internal ha_codeowners: - '@home-assistant/core' +ha_domain: configurator ---
    diff --git a/source/_integrations/conversation.markdown b/source/_integrations/conversation.markdown index d7b4a3efcc3..696dd114ab6 100644 --- a/source/_integrations/conversation.markdown +++ b/source/_integrations/conversation.markdown @@ -1,13 +1,13 @@ --- title: Conversation description: Instructions on how to have conversations with your Home Assistant. -logo: home-assistant.png ha_category: - Voice ha_release: 0.7 ha_quality_scale: internal ha_codeowners: - '@home-assistant/core' +ha_domain: conversation --- 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. diff --git a/source/_integrations/coolmaster.markdown b/source/_integrations/coolmaster.markdown index 29723010ca3..f8b54c59fa3 100644 --- a/source/_integrations/coolmaster.markdown +++ b/source/_integrations/coolmaster.markdown @@ -9,6 +9,7 @@ ha_iot_class: Local Polling ha_config_flow: true ha_codeowners: - '@OnFreund' +ha_domain: coolmaster --- The `coolmaster` climate platform lets you control HVAC through [CoolMasterNet](https://coolautomation.com/products/coolmasternet/). diff --git a/source/_integrations/coronavirus.markdown b/source/_integrations/coronavirus.markdown new file mode 100644 index 00000000000..52568b0a9c8 --- /dev/null +++ b/source/_integrations/coronavirus.markdown @@ -0,0 +1,48 @@ +--- +title: Coronavirus (COVID-19) +description: Instructions on how to integrate the Coronavirus sensors within Home Assistant. +ha_category: + - Health +ha_release: 0.106 +ha_iot_class: Cloud Polling +ha_config_flow: true +ha_codeowners: + - '@home_assistant/core' +ha_domain: coronavirus +--- + +In December 2019, an outbreak of a novel Coronavirus, also called severe acute +respiratory syndrome coronavirus-2 (SARS-CoV-2), began in the Wuhan region of +China. This virus can cause the COVID-19 disease. + +This novel Coronavirus is spreading globally at a disturbing rate, which keeps +everybody on top of the news. The media worldwide is covering the spread of +the virus constantly, and a lot of people are tracking the number of cases +in their country. + +The Coronavirus integration tracks the number of people that are confirmed with, +recovered from, and deceased caused by the virus in your country, or worldwide. + +The data is sourced from the [Johns Hopkins University](https://www.arcgis.com/apps/opsdashboard/index.html#/bda7594740fd40299423467b48e9ecf6). + +## Configuration + +This integration can be configured via the Home Assistant frontend. + +- Go to **Configuration** -> **Integrations**. +- Click on the `+` in the bottom right corner to add a new integration. +- Search and select the **Coronavirus** integration form the list. +- Follow the instruction on screen to add the sensors. Either choose for adding + world-wide sensors, or a specific set of sensors for your country. + +If you want to track both world-wide and one or more countries at the same time, +you can repeat the configuration process described above to add multiple +instances of the integration. + +
    +This integration is released in a special release of Home Assistant Core: +0.106.3. + +While this integration is marked as released in 0.106, it is only available +on Home Assistant Core 0.106.3 or newer. +
    diff --git a/source/_integrations/counter.markdown b/source/_integrations/counter.markdown index 0d6b5148b19..026151eaed4 100644 --- a/source/_integrations/counter.markdown +++ b/source/_integrations/counter.markdown @@ -1,13 +1,13 @@ --- title: Counter description: Instructions on how to integrate counters into Home Assistant. -logo: home-assistant.png ha_category: - Automation ha_release: 0.53 ha_quality_scale: internal ha_codeowners: - '@fabaff' +ha_domain: counter --- The `counter` integration allows one to count occurrences fired by automations. diff --git a/source/_integrations/cover.command_line.markdown b/source/_integrations/cover.command_line.markdown index 646fbb5bd82..45103848d00 100644 --- a/source/_integrations/cover.command_line.markdown +++ b/source/_integrations/cover.command_line.markdown @@ -1,11 +1,11 @@ --- title: "Command Line Cover" description: "How to control a cover with the command line." -logo: command_line.png ha_category: - Cover ha_release: 0.14 ha_iot_class: Local Polling +ha_domain: command_line --- A `command_line`cover platform that issues specific commands when it is moved up, down and stopped. It allows anyone to integrate any type of cover into Home Assistant that can be controlled from the command line. diff --git a/source/_integrations/cover.group.markdown b/source/_integrations/cover.group.markdown index 43c7c4c455c..6bd0f652b86 100644 --- a/source/_integrations/cover.group.markdown +++ b/source/_integrations/cover.group.markdown @@ -5,8 +5,8 @@ ha_category: - Cover ha_release: 0.66 ha_iot_class: Local Push -logo: home-assistant.png ha_quality_scale: internal +ha_domain: group --- The `group` platform can create a cover that combines several cover entities into one. diff --git a/source/_integrations/cover.knx.markdown b/source/_integrations/cover.knx.markdown index f2f7df6800a..a3d38d4b279 100644 --- a/source/_integrations/cover.knx.markdown +++ b/source/_integrations/cover.knx.markdown @@ -1,11 +1,11 @@ --- title: "KNX Cover" description: "Instructions on how to integrate KNX covers with Home Assistant." -logo: knx.png ha_category: - Cover ha_release: 0.48 ha_iot_class: Local Push +ha_domain: knx ---
    diff --git a/source/_integrations/cover.markdown b/source/_integrations/cover.markdown index 774ce3a41f5..d3e9901c3f7 100644 --- a/source/_integrations/cover.markdown +++ b/source/_integrations/cover.markdown @@ -1,13 +1,13 @@ --- title: Cover description: Instructions on how to integrate covers into Home Assistant. -logo: home-assistant.png ha_category: - Cover ha_release: 0.27 ha_quality_scale: internal ha_codeowners: - '@home-assistant/core' +ha_domain: cover --- Home Assistant can give you an interface to control covers such as rollershutters, blinds, and garage doors. diff --git a/source/_integrations/cover.mqtt.markdown b/source/_integrations/cover.mqtt.markdown index 3108dcde19e..1c65d259d7a 100644 --- a/source/_integrations/cover.mqtt.markdown +++ b/source/_integrations/cover.mqtt.markdown @@ -1,11 +1,11 @@ --- title: "MQTT Cover" description: "Instructions on how to integrate MQTT covers into Home Assistant." -logo: mqtt.png ha_category: - Cover ha_iot_class: Configurable ha_release: 0.18 +ha_domain: mqtt --- The `mqtt` cover platform allows you to control an MQTT cover (such as blinds, a rollershutter or a garage door). @@ -18,14 +18,14 @@ The device state (`open`, `opening`, `closed` or `closing`) will be updated only For this purpose is `position_topic` which can set state of the cover and position. Default setting are 0 means the device is `closed` and all other intermediate positions means the device is `open`. `position_topic` is managed by `position_open` and `position_closed` -You can set it up in opossite way as well. +You can set it up in opposite way as well. If position topic is defined than state topic is ignored. If a state topic and position topic are not defined, the cover will work in optimistic mode. In this mode, the cover will immediately change state (`open` or `closed`) after every command sent by Home Assistant. If a state topic/position topic is defined, the cover will wait for a message on `state_topic` or `position_topic`. Optimistic mode can be forced, even if a `state_topic` / `position_topic` is defined. Try to enable it if experiencing incorrect cover operation (Google Assistant gauge may need optimistic mode as it often send request to your Home Assistant immediately after send set_cover_position in which case MQTT could be too slow). -The `mqtt` cover platform optionally supports an `availability_topic` to receive online and offline messages (birth and LWT messages) from the MQTT cover device. During normal operation, if the MQTT cover device goes offline (i.e. publishes `payload_not_available` to `availability_topic`), Home Assistant will display the cover as "unavailable". If these messages are published with the `retain` flag set, the cover will receive an instant update after subscription and Home Assistant will display correct availability state of the cover when Home Assistant starts up. If the `retain` flag is not set, Home Assistant will display the cover as "unavailable" when Home Assistant starts up. +The `mqtt` cover platform optionally supports an `availability_topic` to receive online and offline messages (birth and LWT messages) from the MQTT cover device. During normal operation, if the MQTT cover device goes offline (i.e., publishes `payload_not_available` to `availability_topic`), Home Assistant will display the cover as "unavailable". If these messages are published with the `retain` flag set, the cover will receive an instant update after subscription and Home Assistant will display correct availability state of the cover when Home Assistant starts up. If the `retain` flag is not set, Home Assistant will display the cover as "unavailable" when Home Assistant starts up. To use your MQTT cover in your installation, add the following to your `configuration.yaml` file: @@ -37,165 +37,12 @@ cover: ``` {% configuration %} -command_topic: - description: The MQTT topic to publish commands to control the cover. - required: false - type: string -name: - description: The name of the cover. - required: false - type: string - default: MQTT Cover -payload_open: - description: The command payload that opens the cover. - required: false - type: string - default: OPEN -payload_close: - description: The command payload that closes the cover. - required: false - type: string - default: CLOSE -payload_stop: - description: The command payload that stops the cover. - required: false - type: string - default: STOP -state_topic: - description: The MQTT topic subscribed to receive cover state messages. Use only if not using `position_topic`. State topic can only read open/close state. Cannot read position state. If `position_topic` is set `state_topic` is ignored. - required: false - type: string -state_open: - description: The payload that represents the open state. - required: false - type: string - default: open -state_opening: - description: The payload that represents the opening state. - required: false - type: string - default: opening -state_closed: - description: The payload that represents the closed state. - required: false - type: string - default: closed -state_closing: - description: The payload that represents the closing state. - required: false - type: string - default: closing -position_topic: - description: The MQTT topic subscribed to receive cover position messages. If `position_topic` is set `state_topic` is ignored. - required: false - type: string -position_open: - description: Number which represents open position. - required: false - type: integer - default: 100 -position_closed: - description: Number which represents closed position. - required: false - type: integer - default: 0 availability_topic: description: "The MQTT topic subscribed to to receive birth and LWT messages from the MQTT cover device. If `availability_topic` is not defined, the cover availability state will always be `available`. If `availability_topic` is defined, the cover availability state will be `unavailable` by default." required: false type: string -payload_available: - description: The payload that represents the online state. - required: false - type: string - default: online -payload_not_available: - description: The payload that represents the offline state. - required: false - type: string - default: offline -optimistic: - description: Flag that defines if switch works in optimistic mode. - required: false - type: string - default: "`true` if no state topic defined, else `false`." -qos: - description: The maximum QoS level to be used when receiving and publishing messages. - required: false - type: integer - default: 0 -retain: - description: Defines if published messages should have the retain flag set. - required: false - type: boolean - default: false -value_template: - description: "Defines a [template](/docs/configuration/templating/#processing-incoming-data) to extract a value from the payload." - required: false - type: string -set_position_topic: - description: "The MQTT topic to publish position commands to. You need to set position_topic as well if you want to use position topic. Use template if position topic wants different values than within range `position_closed` - `position_open`. If template is not defined and `position_closed != 100` and `position_open != 0` then proper position value is calculated from percentage position." - required: false - type: string -set_position_template: - description: "Defines a [template](/topics/templating/) to define the position to be sent to the `set_position_topic` topic. Incoming position value is available for use in the template `{{position}}`. If no template is defined, the position (0-100) will be calculated according to `position_open` and `position_closed` values." - required: false - type: string -tilt_command_topic: - description: The MQTT topic to publish commands to control the cover tilt. - required: false - type: string -tilt_status_topic: - description: The MQTT topic subscribed to receive tilt status update values. - required: false - type: string -tilt_status_template: - description: "Defines a [template](/topics/templating/) that can be used to extract the payload for the `tilt_status_topic` topic. " - required: false - type: string -tilt_min: - description: The minimum tilt value. - required: false - type: integer - default: 0 -tilt_max: - description: The maximum tilt value - required: false - type: integer - default: 100 -tilt_closed_value: - description: The value that will be sent on a `close_cover_tilt` command. - required: false - type: integer - default: 0 -tilt_opened_value: - description: The value that will be sent on an `open_cover_tilt` command. - required: false - type: integer - default: 100 -tilt_optimistic: - description: Flag that determines if tilt works in optimistic mode. - required: false - type: boolean - default: "`true` if `tilt_status_topic` is not defined, else `false`" -tilt_invert_state: - description: Flag that determines if open/close are flipped; higher values toward closed and lower values toward open. - required: false - type: boolean - default: false -device_class: - description: Sets the [class of the device](/integrations/cover/), changing the device state and icon that is displayed on the frontend. - required: false - type: string -json_attributes_topic: - description: The MQTT topic subscribed to receive a JSON dictionary payload and then set as sensor attributes. Usage example can be found in [MQTT sensor](/integrations/sensor.mqtt/#json-attributes-topic-configuration) documentation. - required: false - type: string -json_attributes_template: - description: "Defines a [template](/docs/configuration/templating/#processing-incoming-data) to extract the JSON dictionary from messages received on the `json_attributes_topic`. Usage example can be found in [MQTT sensor](/integrations/sensor.mqtt/#json-attributes-template-configuration) documentation." - required: false - type: template -unique_id: - description: An ID that uniquely identifies this cover. If two covers have the same unique ID, Home Assistant will raise an exception. +command_topic: + description: The MQTT topic to publish commands to control the cover. required: false type: string device: @@ -203,14 +50,14 @@ device: required: false type: map keys: - identifiers: - description: 'A list of IDs that uniquely identify the device. For example a serial number.' - required: false - type: [list, string] connections: description: 'A list of connections of the device to the outside world as a list of tuples `[connection_type, connection_identifier]`. For example the MAC address of a network interface: `"connections": ["mac", "02:5b:26:a8:dc:12"]`.' required: false type: list + identifiers: + description: 'A list of IDs that uniquely identify the device. For example a serial number.' + required: false + type: [list, string] manufacturer: description: The manufacturer of the device. required: false @@ -227,6 +74,159 @@ device: description: The firmware version of the device. required: false type: string +device_class: + description: Sets the [class of the device](/integrations/cover/), changing the device state and icon that is displayed on the frontend. + required: false + type: string +json_attributes_template: + description: "Defines a [template](/docs/configuration/templating/#processing-incoming-data) to extract the JSON dictionary from messages received on the `json_attributes_topic`. Usage example can be found in [MQTT sensor](/integrations/sensor.mqtt/#json-attributes-template-configuration) documentation." + required: false + type: template +json_attributes_topic: + description: The MQTT topic subscribed to receive a JSON dictionary payload and then set as sensor attributes. Usage example can be found in [MQTT sensor](/integrations/sensor.mqtt/#json-attributes-topic-configuration) documentation. + required: false + type: string +name: + description: The name of the cover. + required: false + type: string + default: MQTT Cover +optimistic: + description: Flag that defines if switch works in optimistic mode. + required: false + type: string + default: "`true` if no state topic defined, else `false`." +payload_available: + description: The payload that represents the online state. + required: false + type: string + default: online +payload_close: + description: The command payload that closes the cover. + required: false + type: string + default: CLOSE +payload_not_available: + description: The payload that represents the offline state. + required: false + type: string + default: offline +payload_open: + description: The command payload that opens the cover. + required: false + type: string + default: OPEN +payload_stop: + description: The command payload that stops the cover. + required: false + type: string + default: STOP +position_closed: + description: Number which represents closed position. + required: false + type: integer + default: 0 +position_open: + description: Number which represents open position. + required: false + type: integer + default: 100 +position_topic: + description: The MQTT topic subscribed to receive cover position messages. If `position_topic` is set `state_topic` is ignored. + required: false + type: string +qos: + description: The maximum QoS level to be used when receiving and publishing messages. + required: false + type: integer + default: 0 +retain: + description: Defines if published messages should have the retain flag set. + required: false + type: boolean + default: false +set_position_template: + description: "Defines a [template](/topics/templating/) to define the position to be sent to the `set_position_topic` topic. Incoming position value is available for use in the template `{{position}}`. If no template is defined, the position (0-100) will be calculated according to `position_open` and `position_closed` values." + required: false + type: string +set_position_topic: + description: "The MQTT topic to publish position commands to. You need to set position_topic as well if you want to use position topic. Use template if position topic wants different values than within range `position_closed` - `position_open`. If template is not defined and `position_closed != 100` and `position_open != 0` then proper position value is calculated from percentage position." + required: false + type: string +state_closed: + description: The payload that represents the closed state. + required: false + type: string + default: closed +state_closing: + description: The payload that represents the closing state. + required: false + type: string + default: closing +state_open: + description: The payload that represents the open state. + required: false + type: string + default: open +state_opening: + description: The payload that represents the opening state. + required: false + type: string + default: opening +state_topic: + description: The MQTT topic subscribed to receive cover state messages. Use only if not using `position_topic`. State topic can only read open/close state. Cannot read position state. If `position_topic` is set `state_topic` is ignored. + required: false + type: string +tilt_closed_value: + description: The value that will be sent on a `close_cover_tilt` command. + required: false + type: integer + default: 0 +tilt_command_topic: + description: The MQTT topic to publish commands to control the cover tilt. + required: false + type: string +tilt_invert_state: + description: Flag that determines if open/close are flipped; higher values toward closed and lower values toward open. + required: false + type: boolean + default: false +tilt_max: + description: The maximum tilt value + required: false + type: integer + default: 100 +tilt_min: + description: The minimum tilt value. + required: false + type: integer + default: 0 +tilt_opened_value: + description: The value that will be sent on an `open_cover_tilt` command. + required: false + type: integer + default: 100 +tilt_optimistic: + description: Flag that determines if tilt works in optimistic mode. + required: false + type: boolean + default: "`true` if `tilt_status_topic` is not defined, else `false`" +tilt_status_template: + description: "Defines a [template](/topics/templating/) that can be used to extract the payload for the `tilt_status_topic` topic. " + required: false + type: string +tilt_status_topic: + description: The MQTT topic subscribed to receive tilt status update values. + required: false + type: string +unique_id: + description: An ID that uniquely identifies this cover. If two covers have the same unique ID, Home Assistant will raise an exception. + required: false + type: string +value_template: + description: "Defines a [template](/docs/configuration/templating/#processing-incoming-data) to extract a value from the payload." + required: false + type: string {% endconfiguration %} ## Examples diff --git a/source/_integrations/cover.mysensors.markdown b/source/_integrations/cover.mysensors.markdown index 917983aae89..48130cbd796 100644 --- a/source/_integrations/cover.mysensors.markdown +++ b/source/_integrations/cover.mysensors.markdown @@ -1,12 +1,12 @@ --- title: "MySensors Cover" description: "Instructions on how to integrate MySensors covers into Home Assistant." -logo: mysensors.png ha_category: - DIY - Cover ha_release: "0.30" ha_iot_class: Local Push +ha_domain: mysensors --- Integrates MySensors covers into Home Assistant. See the [main integration](/integrations/mysensors/) for configuration instructions. diff --git a/source/_integrations/cover.rflink.markdown b/source/_integrations/cover.rflink.markdown index 1352a5266fb..d1892f9f857 100644 --- a/source/_integrations/cover.rflink.markdown +++ b/source/_integrations/cover.rflink.markdown @@ -5,6 +5,7 @@ logo: rflink.png ha_category: - Cover ha_release: 0.55 +ha_domain: rflink --- The `rflink` integration supports devices that use [RFLink gateway firmware](http://www.nemcon.nl/blog2/), for example the [Nodo RFLink Gateway](https://www.nodo-shop.nl/nl/21-rflink-gateway). RFLink gateway is an Arduino firmware that allows two-way communication with a multitude of RF wireless devices using cheap hardware (Arduino + transceiver). diff --git a/source/_integrations/cover.rfxtrx.markdown b/source/_integrations/cover.rfxtrx.markdown index 7459244e759..9e054b35906 100644 --- a/source/_integrations/cover.rfxtrx.markdown +++ b/source/_integrations/cover.rfxtrx.markdown @@ -1,10 +1,10 @@ --- title: "RFXtrx Cover" description: "Instructions on how to integrate RFXtrx covers into Home Assistant." -logo: rfxtrx.png ha_category: - Cover ha_release: 0.27 +ha_domain: rfxtrx --- The `rfxtrx` platform supports Siemens/LightwaveRF and RFY roller shutters that communicate in the frequency range of 433.92 MHz. diff --git a/source/_integrations/cover.template.markdown b/source/_integrations/cover.template.markdown index 94770e9a967..0cb4936a288 100644 --- a/source/_integrations/cover.template.markdown +++ b/source/_integrations/cover.template.markdown @@ -5,8 +5,8 @@ ha_category: - Cover ha_release: 0.48 ha_iot_class: Local Push -logo: home-assistant.png ha_quality_scale: internal +ha_domain: template --- The `template` platform can create covers that combine integrations and provides diff --git a/source/_integrations/cover.xiaomi_aqara.markdown b/source/_integrations/cover.xiaomi_aqara.markdown index d7808d03955..d0d4b65528f 100644 --- a/source/_integrations/cover.xiaomi_aqara.markdown +++ b/source/_integrations/cover.xiaomi_aqara.markdown @@ -1,11 +1,11 @@ --- title: "Xiaomi Cover" description: "Instructions on how to setup the Xiaomi cover within Home Assistant." -logo: xiaomi.png ha_category: - Cover ha_release: "0.50" ha_iot_class: Local Push +ha_domain: xiaomi_aqara --- diff --git a/source/_integrations/cppm_tracker.markdown b/source/_integrations/cppm_tracker.markdown index 3cc1ae5dacd..0acc267dc77 100644 --- a/source/_integrations/cppm_tracker.markdown +++ b/source/_integrations/cppm_tracker.markdown @@ -6,6 +6,7 @@ ha_category: - Presence Detection ha_release: '0.90' ha_iot_class: Local Polling +ha_domain: cppm_tracker --- This platform allows you to detect presence by looking at connected devices to [Aruba Clearpass](https://www.arubanetworks.com/products/security/network-access-control/). diff --git a/source/_integrations/cpuspeed.markdown b/source/_integrations/cpuspeed.markdown index 1ea3b6f3eba..49dcd427d25 100644 --- a/source/_integrations/cpuspeed.markdown +++ b/source/_integrations/cpuspeed.markdown @@ -8,6 +8,7 @@ ha_release: pre 0.7 ha_iot_class: Local Push ha_codeowners: - '@fabaff' +ha_domain: cpuspeed --- The `cpuspeed` sensor platform to allow you to monitor the current CPU speed. diff --git a/source/_integrations/crimereports.markdown b/source/_integrations/crimereports.markdown index b5ba389d2d7..006965860fe 100644 --- a/source/_integrations/crimereports.markdown +++ b/source/_integrations/crimereports.markdown @@ -6,6 +6,7 @@ ha_category: logo: crimereports.png ha_release: 0.42 ha_iot_class: Cloud Polling +ha_domain: crimereports --- The `crimereports` sensor allows one to track reported incidents occurring in a given area. Incidents include anything reported to [Crime Reports](https://www.crimereports.com). Your regional emergency services may or may not report data. The sensor only counts incidents from the current day. diff --git a/source/_integrations/cups.markdown b/source/_integrations/cups.markdown index 6fc1d2efe10..0023de15fad 100644 --- a/source/_integrations/cups.markdown +++ b/source/_integrations/cups.markdown @@ -1,13 +1,13 @@ --- title: CUPS description: Instructions on how to integrate CUPS sensors into Home Assistant. -logo: cups.png ha_category: - System Monitor ha_iot_class: Local Polling ha_release: 0.32 ha_codeowners: - '@fabaff' +ha_domain: cups --- The `cups` sensor platform is using the open source printing system [CUPS](https://www.cups.org/) to show details about your printers, including the ink levels. It can obtain the informations using a CUPS server or communicating directly with the printer with the Internet Printing Protocol. diff --git a/source/_integrations/currencylayer.markdown b/source/_integrations/currencylayer.markdown index 5052c428066..d1b8509d257 100644 --- a/source/_integrations/currencylayer.markdown +++ b/source/_integrations/currencylayer.markdown @@ -6,6 +6,7 @@ ha_category: logo: currencylayer.png ha_iot_class: Cloud Polling ha_release: 0.32 +ha_domain: currencylayer --- The `currencylayer` sensor will show you the current exchange rate from [Currencylayer](https://currencylayer.com/) that provides real-time exchange rates for [170 currencies](https://currencylayer.com/currencies). The free account is limited to only USD as a base currency, allows 1000 requests per month, and updates every hour. diff --git a/source/_integrations/daikin.markdown b/source/_integrations/daikin.markdown index 621834f0299..3424f3df3c4 100644 --- a/source/_integrations/daikin.markdown +++ b/source/_integrations/daikin.markdown @@ -13,6 +13,7 @@ ha_quality_scale: platinum ha_codeowners: - '@fredrike' - '@rofrantz' +ha_domain: daikin --- The `daikin` integration integrates Daikin air conditioning systems into Home Assistant. diff --git a/source/_integrations/danfoss_air.markdown b/source/_integrations/danfoss_air.markdown index e7be8bfe54a..d76eb443c2a 100644 --- a/source/_integrations/danfoss_air.markdown +++ b/source/_integrations/danfoss_air.markdown @@ -7,8 +7,8 @@ ha_category: - Sensor - Switch ha_release: 0.87 -logo: danfoss_air.png ha_iot_class: Local Polling +ha_domain: danfoss_air --- The `danfoss_air` integration allows you to access information from your Danfoss Air HRV unit. diff --git a/source/_integrations/darksky.markdown b/source/_integrations/darksky.markdown index d4fe5874f7c..2dc3ea93873 100644 --- a/source/_integrations/darksky.markdown +++ b/source/_integrations/darksky.markdown @@ -1,13 +1,13 @@ --- title: Dark Sky description: How to integrate Dark Sky within Home Assistant. -logo: dark_sky.png ha_category: - Weather ha_release: '0.30' ha_iot_class: Cloud Polling ha_codeowners: - '@fabaff' +ha_domain: darksky --- The `darksky` platform uses the [Dark Sky](https://darksky.net/) web service as a source for meteorological data for your location. The location is based on the `longitude` and `latitude` coordinates configured in your `configuration.yaml` file. The coordinates are auto-detected but to take advantage of the hyper-local weather reported by Dark Sky, you can refine them down to your exact home address. GPS coordinates can be found by using [Google Maps](https://www.google.com/maps) and clicking on your home or [Openstreetmap](https://www.openstreetmap.org/). diff --git a/source/_integrations/datadog.markdown b/source/_integrations/datadog.markdown index 17aa9f449bd..634a5d8038f 100644 --- a/source/_integrations/datadog.markdown +++ b/source/_integrations/datadog.markdown @@ -1,10 +1,10 @@ --- title: Datadog description: Send data and events to Datadog. -logo: datadog.png ha_category: - History ha_release: 0.45 +ha_domain: datadog --- The `datadog` integration sends all state changes to [Datadog](https://www.datadoghq.com/) using a [Datadog Agent](https://docs.datadoghq.com/guides/basic_agent_usage/). diff --git a/source/_integrations/ddwrt.markdown b/source/_integrations/ddwrt.markdown index 48a991747ef..6dd520fe2fb 100644 --- a/source/_integrations/ddwrt.markdown +++ b/source/_integrations/ddwrt.markdown @@ -5,6 +5,7 @@ logo: ddwrt.png ha_category: - Presence Detection ha_release: pre 0.7 +ha_domain: ddwrt --- This platform offers presence detection by looking at connected devices to a [DD-WRT](https://dd-wrt.com/) based router. diff --git a/source/_integrations/deconz.markdown b/source/_integrations/deconz.markdown index 68ae500ee7f..bc8398dde9a 100644 --- a/source/_integrations/deconz.markdown +++ b/source/_integrations/deconz.markdown @@ -1,7 +1,6 @@ --- title: deCONZ description: Instructions on how to setup ConBee/RaspBee devices with deCONZ from dresden elektronik within Home Assistant. -logo: deconz.jpeg ha_category: - Hub - Binary Sensor @@ -16,6 +15,7 @@ ha_config_flow: true ha_quality_scale: platinum ha_codeowners: - '@kane610' +ha_domain: deconz --- [deCONZ](https://www.dresden-elektronik.de/funk/software/deconz.html) by [dresden elektronik](https://www.dresden-elektronik.de) is a software that communicates with ConBee/RaspBee Zigbee gateways and exposes Zigbee devices that are connected to the gateway. @@ -417,6 +417,8 @@ The `entity_id` name will be `cover.device_name`, where `device_name` is defined ### Verified supported covers +- IKEA Fyrtur +- IKEA Kadrilj - Keen vents - Xiaomi Aqara Curtain controller diff --git a/source/_integrations/decora.markdown b/source/_integrations/decora.markdown index 566f15c131f..7071a770d6f 100644 --- a/source/_integrations/decora.markdown +++ b/source/_integrations/decora.markdown @@ -6,6 +6,7 @@ ha_category: ha_iot_class: Local Polling logo: leviton.png ha_release: 0.37 +ha_domain: decora --- Support for the Decora Bluetooth dimmer switch [Leviton](https://www.leviton.com/en/products/residential/dimmers/automation-smart-home/decora-digital-with-bluetooth-dimmers#t=Products&sort=%40wcs_site_tree_rank%20ascending&layout=card). diff --git a/source/_integrations/decora_wifi.markdown b/source/_integrations/decora_wifi.markdown index d937b006e19..0fc326b3ae6 100644 --- a/source/_integrations/decora_wifi.markdown +++ b/source/_integrations/decora_wifi.markdown @@ -6,6 +6,7 @@ ha_category: ha_iot_class: Cloud Polling logo: leviton.png ha_release: 0.51 +ha_domain: decora_wifi --- Support for [Leviton Decora Wi-Fi](https://www.leviton.com/en/products/lighting-controls/decora-smart-with-wifi) dimmers/switches via the MyLeviton API. diff --git a/source/_integrations/default_config.markdown b/source/_integrations/default_config.markdown index 546cb615c14..546e3186420 100644 --- a/source/_integrations/default_config.markdown +++ b/source/_integrations/default_config.markdown @@ -1,10 +1,10 @@ --- -title: Default Configuration +title: Default Config description: The default configuration integration will initiate a default configuration for Home Assistant. -logo: home-assistant.png ha_category: - Other ha_release: 0.88 +ha_domain: default_config --- 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: diff --git a/source/_integrations/delijn.markdown b/source/_integrations/delijn.markdown index 041d33ec49b..dcfb3f99f04 100644 --- a/source/_integrations/delijn.markdown +++ b/source/_integrations/delijn.markdown @@ -6,9 +6,9 @@ ha_category: - Transport - Sensor ha_iot_class: Cloud Polling -logo: delijn.svg ha_codeowners: - '@bollewolle' +ha_domain: delijn --- The `delijn` sensor will give you the departure time of the next bus, tram or subway at a specific stop of the De Lijn public transport network in Flanders (Belgium). @@ -42,7 +42,7 @@ next_departure: type: list keys: stop_id: - description: "ID of the stop, e.g. `200552`." + description: "ID of the stop, e.g., `200552`." required: true type: string number_of_departures: diff --git a/source/_integrations/deluge.markdown b/source/_integrations/deluge.markdown index 1b1d4d41dea..a63b73380af 100644 --- a/source/_integrations/deluge.markdown +++ b/source/_integrations/deluge.markdown @@ -1,13 +1,13 @@ --- title: Deluge description: Instructions on how to integrate Deluge within Home Assistant. -logo: deluge.png ha_category: - Downloading - Sensor - Switch ha_release: 0.57 ha_iot_class: Local Polling +ha_domain: deluge --- There is currently support for the following device types within Home Assistant: diff --git a/source/_integrations/demo.markdown b/source/_integrations/demo.markdown index 571b2598e2a..86c86f09cd9 100644 --- a/source/_integrations/demo.markdown +++ b/source/_integrations/demo.markdown @@ -1,16 +1,16 @@ --- title: Demo description: Instructions on how to use the Platform demos with Home Assistant. -logo: home-assistant.png ha_category: - Other ha_release: 0.7 ha_quality_scale: internal ha_codeowners: - '@home-assistant/core' +ha_domain: demo --- -The `demo` platform allows you to use integrations which are providing a demo of their implementation. The demo entities are dummies but show you how the actual platform looks like. This way you can run own demonstration instance like the online [Home Assistant demo](/demo/) or `hass --demo-mode` but combined with your own real/functional platforms. +The `demo` platform allows you to use integrations which are providing a demo of their implementation. The demo entities are dummies but show you how the actual platform looks like. This way you can run own demonstration instance like the online [Home Assistant demo](/demo/)but combined with your own real/functional platforms. Available demo platforms: @@ -39,7 +39,12 @@ To integrate a demo platform in Home Assistant, add the following section to you ```yaml # Example configuration.yaml entry -[component]: + +# To load all: +demo: + +# To load for a specific integration: +light: - platform: demo ``` diff --git a/source/_integrations/denon.markdown b/source/_integrations/denon.markdown index 5d8321fa423..ffb1dca5c12 100644 --- a/source/_integrations/denon.markdown +++ b/source/_integrations/denon.markdown @@ -6,6 +6,7 @@ ha_category: - Media Player ha_iot_class: Local Polling ha_release: 0.7.2 +ha_domain: denon --- The `denon` platform allows you to control a [Denon Network Receivers](https://www.denon.co.uk/chg/product/compactsystems/networkmusicsystems/ceolpiccolo) from Home Assistant. It might be that your device is supported by the [Denon AVR] platform. diff --git a/source/_integrations/denonavr.markdown b/source/_integrations/denonavr.markdown index 130e2e7b536..871a3459d4b 100644 --- a/source/_integrations/denonavr.markdown +++ b/source/_integrations/denonavr.markdown @@ -6,6 +6,7 @@ ha_category: - Media Player ha_iot_class: Local Polling ha_release: 0.7.2 +ha_domain: denonavr --- The `denonavr` platform allows you to control a [Denon Network Receivers](https://www.denon.co.uk/chg/product/compactsystems/networkmusicsystems/ceolpiccolo) from Home Assistant. It might be that your device is supported by the [Denon] platform. @@ -97,11 +98,11 @@ A few notes: #### Service `denonavr.get_command` -Generic commands are supported, in particular, any command supported by the telnet protocol can be sent to `/goform/formiPhoneAppDirect.xml`, e.g., `/goform/formiPhoneAppDirect.xml?VSMONI2` to switch HDMI outputs on supported receivers. IR remote codes can also be sent to this endpoint, e.g. "/goform/formiPhoneAppDirect.xml?RCKSK0410370" as a mute toggle. A comprehensive list of telnet protocol commands is available at and a full list of IR codes at +Generic commands are supported, in particular, any command supported by the telnet protocol can be sent to `/goform/formiPhoneAppDirect.xml`, e.g., `/goform/formiPhoneAppDirect.xml?VSMONI2` to switch HDMI outputs on supported receivers. IR remote codes can also be sent to this endpoint, e.g., "/goform/formiPhoneAppDirect.xml?RCKSK0410370" as a mute toggle. A comprehensive list of telnet protocol commands is available at and a full list of IR codes at | Service data attribute | Optional | Description | | ---------------------- | -------- | ---------------------------------------------------- | | `entity_id` | no | Name of entity to send command to. For example `media_player.marantz`| -| `command` | no | Command to send to device, e.g. `/goform/formiPhoneAppDirect.xml?VSMONI2`| +| `command` | no | Command to send to device, e.g., `/goform/formiPhoneAppDirect.xml?VSMONI2`| [Denon]: /integrations/denon diff --git a/source/_integrations/derivative.markdown b/source/_integrations/derivative.markdown index 19caccc3145..95415ec65d1 100644 --- a/source/_integrations/derivative.markdown +++ b/source/_integrations/derivative.markdown @@ -10,6 +10,7 @@ logo: derivative.png ha_qa_scale: internal ha_codeowners: - '@afaucogney' +ha_domain: derivative --- The `derivative` platform creates a sensor that estimates the derivative of the values provided by a source sensor. diff --git a/source/_integrations/deutsche_bahn.markdown b/source/_integrations/deutsche_bahn.markdown index 928500f55e2..6ecb09bfbcf 100644 --- a/source/_integrations/deutsche_bahn.markdown +++ b/source/_integrations/deutsche_bahn.markdown @@ -3,9 +3,9 @@ title: Deutsche Bahn description: Instructions on how to integrate timetable data for traveling in Germany within Home Assistant. ha_category: - Transport -logo: db.png ha_iot_class: Cloud Polling ha_release: 0.14 +ha_domain: deutsche_bahn --- The `deutsche_bahn` sensor will give you the departure time of the next train for the given connection. In case of a delay, the delay is also shown. Additional details are used to inform about, e.g., the type of the train, price, and if it is on time. diff --git a/source/_integrations/device_automation.markdown b/source/_integrations/device_automation.markdown index fe45a9d56b5..90b57539d3f 100644 --- a/source/_integrations/device_automation.markdown +++ b/source/_integrations/device_automation.markdown @@ -1,12 +1,12 @@ --- title: Device Automation -logo: home-assistant.png ha_category: - Automation ha_release: 0.7 ha_quality_scale: internal ha_codeowners: - '@home-assistant/core' +ha_domain: device_automation --- Device Automations is a plugin for the automation integration to allow other integrations to provide device specific triggers, conditions and actions. diff --git a/source/_integrations/device_sun_light_trigger.markdown b/source/_integrations/device_sun_light_trigger.markdown index c49948b3430..6ff8ccde1d2 100644 --- a/source/_integrations/device_sun_light_trigger.markdown +++ b/source/_integrations/device_sun_light_trigger.markdown @@ -1,11 +1,11 @@ --- title: Presence-based Lights description: Instructions on how to automate your lights with Home Assistant. -logo: home-assistant.png ha_category: - Automation ha_release: pre 0.7 ha_quality_scale: internal +ha_domain: device_sun_light_trigger --- Home Assistant has a built-in integration called `device_sun_light_trigger` to help you automate your lights. The integration will: diff --git a/source/_integrations/device_tracker.markdown b/source/_integrations/device_tracker.markdown index 6c9a9bbb57c..608bfa4b033 100644 --- a/source/_integrations/device_tracker.markdown +++ b/source/_integrations/device_tracker.markdown @@ -1,11 +1,11 @@ --- title: Device Tracker description: Instructions on how to setup device tracking within Home Assistant. -logo: home-assistant.png ha_category: - Presence Detection ha_release: 0.7 ha_quality_scale: internal +ha_domain: device_tracker --- 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. @@ -28,12 +28,12 @@ device_tracker: The following optional parameters can be used with any platform:
    - Device tracker will only look for global settings under the configuration of the first configured platform. These 3 are the global settings: + Device tracker will only look for the following global settings under the configuration of the first configured platform:
    | Parameter | Default | Description | |----------------------|---------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| `interval_seconds` | 12 | Seconds between each scan for new devices | +| `interval_seconds` | 12 | Seconds between each scan for new devices. This only applies to local device trackers, not applications that push updates. | | `consider_home` | 180 | Seconds to wait till marking someone as not home after not being seen. This parameter is most useful for households with Apple iOS devices that go into sleep mode while still at home to conserve battery life. iPhones will occasionally drop off the network and then re-appear. `consider_home` helps prevent false alarms in presence detection when using IP scanners such as Nmap. `consider_home` accepts various time representations, (e.g., the following all represents 3 minutes: `180`, `0:03`, `0:03:00`) |
    diff --git a/source/_integrations/device_tracker.mqtt.markdown b/source/_integrations/device_tracker.mqtt.markdown index bdde83a6e2e..678a65cd092 100644 --- a/source/_integrations/device_tracker.mqtt.markdown +++ b/source/_integrations/device_tracker.mqtt.markdown @@ -1,11 +1,11 @@ --- title: "MQTT Device Tracker" description: "Instructions on how to use MQTT to track devices in Home Assistant." -logo: mqtt.png ha_category: - Presence Detection ha_iot_class: Configurable ha_release: 0.7.3 +ha_domain: mqtt --- @@ -54,13 +54,14 @@ source_type: ```yaml # Complete configuration.yaml entry device_tracker: - devices: - paulus_oneplus: 'location/paulus' - annetherese_n4: 'location/annetherese' - qos: 1 - payload_home: 'present' - payload_not_home: 'not present' - source_type: bluetooth + - platform: mqtt + devices: + paulus_oneplus: 'location/paulus' + annetherese_n4: 'location/annetherese' + qos: 1 + payload_home: 'present' + payload_not_home: 'not present' + source_type: bluetooth ``` ## Usage diff --git a/source/_integrations/device_tracker.mysensors.markdown b/source/_integrations/device_tracker.mysensors.markdown index 20f477790f0..b6a14fec11a 100644 --- a/source/_integrations/device_tracker.mysensors.markdown +++ b/source/_integrations/device_tracker.mysensors.markdown @@ -1,12 +1,12 @@ --- title: "MySensors Device Tracker" description: "Instructions on how to use MySensors to track devices in Home Assistant." -logo: mysensors.png ha_category: - DIY - Presence Detection ha_release: 0.38 ha_iot_class: Local Push +ha_domain: mysensors --- Integrates MySensors device trackers into Home Assistant. See the [main integration](/integrations/mysensors/) for configuration instructions. diff --git a/source/_integrations/device_tracker.xiaomi.markdown b/source/_integrations/device_tracker.xiaomi.markdown index 61e6ce8d431..e6e5e8eb2be 100644 --- a/source/_integrations/device_tracker.xiaomi.markdown +++ b/source/_integrations/device_tracker.xiaomi.markdown @@ -1,10 +1,10 @@ --- title: "Xiaomi Router" description: "Instructions on how to integrate Xiaomi routers into Home Assistant." -logo: xiaomi.png ha_category: - Presence Detection ha_release: 0.36 +ha_domain: xiaomi --- The `xiaomi` platform offers presence detection by looking at connected devices to a [Xiaomi](http://miwifi.com) router. diff --git a/source/_integrations/device_trigger.mqtt.markdown b/source/_integrations/device_trigger.mqtt.markdown new file mode 100644 index 00000000000..8a843437826 --- /dev/null +++ b/source/_integrations/device_trigger.mqtt.markdown @@ -0,0 +1,75 @@ +--- +title: "MQTT Device Trigger" +description: "Instructions on how to integrate MQTT device triggers within Home Assistant." +ha_category: + - Device Automation +ha_release: 0.106 +ha_iot_class: Configurable +ha_domain: mqtt +--- + +The `mqtt` device trigger platform uses an MQTT message payload to generate device trigger events. + +An MQTT device trigger is a better option than a [binary sensor](/integrations/binary_sensor.mqtt/) for buttons, remote controls etc. + +## Configuration + +MQTT device triggers are only supported through [MQTT discovery](/docs/mqtt/discovery/), manual setup through `configuration.yaml` is not supported. +The discovery topic needs to be: `/device_automation/[/]/config`. + +{% configuration %} +automation_type: + description: The type of automation, must be 'trigger'. + required: true + type: string +payload: + description: Optional payload to match the payload being sent over the topic. + required: false + type: string +qos: + description: The maximum QoS level to be used when receiving messages. + required: false + type: integer + default: 0 +topic: + description: The MQTT topic subscribed to receive trigger events. + required: true + type: string +type: + description: "The type of the trigger, e.g. `button_short_press`. Entries supported by the frontend: `button_short_press`, `button_short_release`, `button_long_press`, `button_long_release`, `button_double_press`, `button_triple_press`, `button_quadruple_press`, `button_quintuple_press`. If set to an unsupported value, will render as `subtype type`, e.g. `First button spammed` with `type` set to `spammed` and `subtype` set to `button_1`" + required: true + type: string +subtype: + description: "The subtype of the trigger, e.g. `button_1`. Entries supported by the frontend: `turn_on`, `turn_off`, `button_1`, `button_2`, `button_3`, `button_4`, `button_5`, `button_6`. If set to an unsupported value, will render as `subtype type`, e.g. `left_button pressed` with `type` set to `button_short_press` and `subtype` set to `left_button`" + required: true + type: string +device: + description: "Information about the device this device trigger is a part of to tie it into the [device registry](https://developers.home-assistant.io/docs/en/device_registry_index.html)." + required: true + type: map + keys: + connections: + description: "A list of connections of the device to the outside world as a list of tuples `[connection_type, connection_identifier]`. For example the MAC address of a network interface: `'connections': ['mac', '02:5b:26:a8:dc:12']`." + required: false + type: [list, map] + identifiers: + description: A list of IDs that uniquely identify the device. For example a serial number. + required: false + type: [list, string] + manufacturer: + description: The manufacturer of the device. + required: false + type: string + model: + description: The model of the device. + required: false + type: string + name: + description: The name of the device. + required: false + type: string + sw_version: + description: The firmware version of the device. + required: false + type: string +{% endconfiguration %} diff --git a/source/_integrations/dht.markdown b/source/_integrations/dht.markdown index e6b1e55d96b..51984468453 100644 --- a/source/_integrations/dht.markdown +++ b/source/_integrations/dht.markdown @@ -6,6 +6,7 @@ ha_category: ha_release: 0.7 logo: dht.png ha_iot_class: Local Polling +ha_domain: dht --- The `dht` sensor platform allows you to get the current temperature and humidity from a DHT11, DHT22 or AM2302 device. diff --git a/source/_integrations/dialogflow.markdown b/source/_integrations/dialogflow.markdown index 67f0b9c5bd3..2e7b45ec041 100644 --- a/source/_integrations/dialogflow.markdown +++ b/source/_integrations/dialogflow.markdown @@ -6,11 +6,12 @@ ha_category: - Voice ha_release: 0.56 ha_config_flow: true +ha_domain: dialogflow --- The `dialogflow` integration is designed to be used with the [webhook](https://dialogflow.com/docs/fulfillment#webhook) integration of [Dialogflow](https://dialogflow.com/). When a conversation ends with a user, Dialogflow sends an action and parameters to the webhook. -To be able to receive messages from Dialogflow, your Home Assistant instance needs to be accessible from the web and you need to have the `base_url` configured for the HTTP integration ([docs](/integrations/http/#base_url)). Dialogflow will return fallback answers if your server does not answer or takes too long (more than 5 seconds). +To be able to receive messages from Dialogflow, your Home Assistant instance needs to be accessible from the web and you need to have the `base_url` configured for the HTTP integration ([documentation](/integrations/http/#base_url)). Dialogflow will return fallback answers if your server does not answer or takes too long (more than 5 seconds). Dialogflow could be [integrated](https://dialogflow.com/docs/integrations/) with many popular messaging, virtual assistant and IoT platforms. diff --git a/source/_integrations/digital_ocean.markdown b/source/_integrations/digital_ocean.markdown index 1cd0e761993..08453ef1383 100644 --- a/source/_integrations/digital_ocean.markdown +++ b/source/_integrations/digital_ocean.markdown @@ -10,6 +10,7 @@ logo: digital_ocean.png ha_iot_class: Local Polling ha_codeowners: - '@fabaff' +ha_domain: digital_ocean --- The `digital_ocean` integration allows you to access the information about your [Digital Ocean](https://www.digitalocean.com/) droplets from Home Assistant. diff --git a/source/_integrations/digitalloggers.markdown b/source/_integrations/digitalloggers.markdown index 57d8c536cb7..5d0ab4920d2 100644 --- a/source/_integrations/digitalloggers.markdown +++ b/source/_integrations/digitalloggers.markdown @@ -1,11 +1,11 @@ --- title: Digital Loggers description: Instructions on how to integrate Digital Loggers DIN III relays into Home Assistant. -logo: digitalloggers.png ha_category: - Switch ha_release: 0.35 ha_iot_class: Local Polling +ha_domain: digitalloggers --- The `digitalloggers` switch platform allows you to control the state of your [Digital Loggers](https://www.digital-loggers.com/dinfaqs.html) switches. diff --git a/source/_integrations/directv.markdown b/source/_integrations/directv.markdown index fa01c6f1ebd..af10e475b72 100644 --- a/source/_integrations/directv.markdown +++ b/source/_integrations/directv.markdown @@ -6,6 +6,7 @@ ha_category: - Media Player ha_release: 0.25 ha_iot_class: Local Polling +ha_domain: directv --- Master [DirecTV](https://www.directv.com/) receivers (ie: those that have tuners) will be automatically discovered if you enable the [discovery integration](/integrations/discovery/) and the receiver is powered-on. Slave/RVU client/Genie boxes will also be discovered, but only if they are also online at the time of discovery. diff --git a/source/_integrations/discogs.markdown b/source/_integrations/discogs.markdown index 5bbb4fd3d42..d0d1eef93c0 100644 --- a/source/_integrations/discogs.markdown +++ b/source/_integrations/discogs.markdown @@ -8,6 +8,7 @@ logo: discogs.png ha_iot_class: Cloud Polling ha_codeowners: - '@thibmaek' +ha_domain: discogs --- The `discogs` platform allows you to see the current amount of records in your [Discogs](https://www.discogs.com) collection. diff --git a/source/_integrations/discord.markdown b/source/_integrations/discord.markdown index dc5c2ec8894..ac438ce96e4 100644 --- a/source/_integrations/discord.markdown +++ b/source/_integrations/discord.markdown @@ -5,6 +5,7 @@ logo: discord.png ha_category: - Notifications ha_release: 0.37 +ha_domain: discord --- The [Discord service](https://discordapp.com/) is a platform for the notify component. This allows integrations to send messages to the user using Discord. @@ -85,4 +86,4 @@ For more information about creating and authorizing bots, visit the [OAuth2 info To use notifications effectively, please see the [getting started with automation page](/getting-started/automation/). -Images are uploaded to Discord when a message is sent. As such, a local path to the image is required (i.e. `/config/www/garage.jpg` as opposed to `/local/garage.jpg`), and updating an image after sending it in a message will not update the message in Discord. +Images are uploaded to Discord when a message is sent. As such, a local path to the image is required (i.e., `/config/www/garage.jpg` as opposed to `/local/garage.jpg`), and updating an image after sending it in a message will not update the message in Discord. diff --git a/source/_integrations/discovery.markdown b/source/_integrations/discovery.markdown index a553a27d934..fa4c8d2c67f 100644 --- a/source/_integrations/discovery.markdown +++ b/source/_integrations/discovery.markdown @@ -1,11 +1,11 @@ --- title: Discovery description: Instructions on how to setup Home Assistant to discover new devices. -logo: home-assistant.png ha_category: - Other ha_release: 0.7 ha_quality_scale: internal +ha_domain: discovery --- Home Assistant can discover and automatically configure [zeroconf](https://en.wikipedia.org/wiki/Zero-configuration_networking)/[mDNS](https://en.wikipedia.org/wiki/Multicast_DNS) and [UPnP](https://en.wikipedia.org/wiki/Universal_Plug_and_Play) devices on your network. Currently the `discovery` integration can detect: diff --git a/source/_integrations/dlib_face_detect.markdown b/source/_integrations/dlib_face_detect.markdown index 105d1dab1fc..6703775b199 100644 --- a/source/_integrations/dlib_face_detect.markdown +++ b/source/_integrations/dlib_face_detect.markdown @@ -1,10 +1,10 @@ --- title: Dlib Face Detect description: Instructions on how to integrate Dlib Face Detect into Home Assistant. -logo: dlib.png ha_category: - Image Processing ha_release: 0.44 +ha_domain: dlib_face_detect --- The `dlib_face_detect` image processing platform allows you to use the [Dlib](http://www.dlib.net/) through Home Assistant. This platform enables face detection from cameras, and can fire events with attributes. diff --git a/source/_integrations/dlib_face_identify.markdown b/source/_integrations/dlib_face_identify.markdown index 4e5eb22e8ec..bab93409aad 100644 --- a/source/_integrations/dlib_face_identify.markdown +++ b/source/_integrations/dlib_face_identify.markdown @@ -1,10 +1,10 @@ --- title: Dlib Face Identify description: Instructions on how to integrate Dlib Face Identify into Home Assistant. -logo: dlib.png ha_category: - Image Processing ha_release: 0.44 +ha_domain: dlib_face_identify --- The `dlib_face_identify` image processing platform allows you to use the [Dlib](http://www.dlib.net/) through Home Assistant. This platform allow you to identify persons on camera and fire an event with identify persons. diff --git a/source/_integrations/dlink.markdown b/source/_integrations/dlink.markdown index af03708cd1a..caa1b0195df 100644 --- a/source/_integrations/dlink.markdown +++ b/source/_integrations/dlink.markdown @@ -6,6 +6,7 @@ ha_category: - Switch ha_iot_class: Local Polling ha_release: 0.14 +ha_domain: dlink --- The `dlink` switch platform allows you to control the state of your [D-Link Wi-Fi Smart Plugs](https://us.dlink.com/en/consumer/smart-plugs). diff --git a/source/_integrations/dlna_dmr.markdown b/source/_integrations/dlna_dmr.markdown index b6eaba0fd22..a013b832b36 100644 --- a/source/_integrations/dlna_dmr.markdown +++ b/source/_integrations/dlna_dmr.markdown @@ -6,6 +6,7 @@ ha_category: - Media Player ha_release: 0.76 ha_iot_class: Local Push +ha_domain: dlna_dmr --- The `dlna_dmr` platform allows you to control a [DLNA Digital Media Renderer](https://www.dlna.org/), such as DLNA enabled TVs or radios. diff --git a/source/_integrations/dnsip.markdown b/source/_integrations/dnsip.markdown index 1b86cbc2140..66409b61cd1 100644 --- a/source/_integrations/dnsip.markdown +++ b/source/_integrations/dnsip.markdown @@ -1,11 +1,11 @@ --- title: DNS IP description: Instructions on how to integrate a DNS IP sensor into Home Assistant. -logo: home-assistant.png ha_category: - Network ha_iot_class: Cloud Polling ha_release: '0.40' +ha_domain: dnsip --- The `dnsip` sensor will expose an IP address, fetched via DNS resolution, as its value. There are two operational modes: diff --git a/source/_integrations/dominos.markdown b/source/_integrations/dominos.markdown index ad94c933c17..b7c1e84e014 100644 --- a/source/_integrations/dominos.markdown +++ b/source/_integrations/dominos.markdown @@ -6,6 +6,7 @@ ha_category: - Other ha_iot_class: Cloud Polling ha_release: 0.59 +ha_domain: dominos --- The `dominos` integration allows you to order Dominos Pizza from within your Home Assistant scripts and automations. diff --git a/source/_integrations/doods.markdown b/source/_integrations/doods.markdown index 8d927615bb4..178acf3c7f7 100644 --- a/source/_integrations/doods.markdown +++ b/source/_integrations/doods.markdown @@ -5,6 +5,7 @@ ha_category: - Image Processing ha_iot_class: Local Polling ha_release: '0.100' +ha_domain: doods --- The `doods` image processing platform allows you to detect and recognize objects in a camera image using [DOODS](https://github.com/snowzach/doods/). The state of the entity is the number of objects detected, and recognized objects are listed in the `summary` attribute along with quantity. The `matches` attribute provides the confidence `score` for recognition and the bounding `box` of the object for each detection category. diff --git a/source/_integrations/doorbird.markdown b/source/_integrations/doorbird.markdown index 99bbf641af9..b15675ab5b8 100644 --- a/source/_integrations/doorbird.markdown +++ b/source/_integrations/doorbird.markdown @@ -10,6 +10,7 @@ ha_release: 0.54 ha_iot_class: Local Push ha_codeowners: - '@oblogic7' +ha_domain: doorbird --- The `doorbird` implementation allows you to integrate your [DoorBird](https://www.doorbird.com/) device in Home Assistant. diff --git a/source/_integrations/dovado.markdown b/source/_integrations/dovado.markdown index 47046901e98..4f3024e61f2 100644 --- a/source/_integrations/dovado.markdown +++ b/source/_integrations/dovado.markdown @@ -8,6 +8,7 @@ ha_category: logo: dovado.png ha_release: 0.87 ha_iot_class: Local Polling +ha_domain: dovado --- The `dovado` integration manages communication with the [Dovado](https://www.dovado.com/) router. diff --git a/source/_integrations/downloader.markdown b/source/_integrations/downloader.markdown index 3fa20c1162a..2157bfaee00 100644 --- a/source/_integrations/downloader.markdown +++ b/source/_integrations/downloader.markdown @@ -1,11 +1,11 @@ --- title: Downloader description: Instructions on how to setup the downloader integration with Home Assistant. -logo: home-assistant.png ha_category: - Downloading ha_release: pre 0.7 ha_quality_scale: internal +ha_domain: downloader --- The `downloader` integration provides a service to download files. It will raise an error and not continue to set itself up when the download directory does not exist. The directory needs to be writable for the user that is running Home Assistant. diff --git a/source/_integrations/dsmr.markdown b/source/_integrations/dsmr.markdown index 5d75ed56c6d..7d8dcf43006 100644 --- a/source/_integrations/dsmr.markdown +++ b/source/_integrations/dsmr.markdown @@ -6,6 +6,7 @@ ha_category: - Energy ha_release: 0.34 ha_iot_class: Local Push +ha_domain: dsmr --- A sensor platform for Dutch Smart Meters which comply to DSMR (Dutch Smart Meter Requirements), also known as 'Slimme meter' or 'P1 poort'. @@ -53,11 +54,11 @@ sensor: {% configuration %} port: - description: "Serial port to which Smartmeter is connected (default: /dev/ttyUSB0 (connected to USB port)). For remote (i.e. ser2net) connections, use TCP port number to connect to (i.e. 2001)." + description: "Serial port to which Smartmeter is connected (default: /dev/ttyUSB0 (connected to USB port)). For remote (i.e., ser2net) connections, use TCP port number to connect to (i.e., 2001)." required: false type: string host: - description: "Host to which Smartmeter is connected (default: '' (connected via serial or USB, see **port**)). For remote connections, use IP address of host to connect to (i.e. 192.168.1.13)." + description: "Host to which Smartmeter is connected (default: '' (connected via serial or USB, see **port**)). For remote connections, use IP address of host to connect to (i.e., 192.168.1.13)." required: false type: string dsmr_version: @@ -92,7 +93,7 @@ group: ``` ```yaml -# Example configuration.yaml entry for remote (TCP/IP, i.e. via ser2net) connection to host which is connected to Smartmeter +# Example configuration.yaml entry for remote (TCP/IP, i.e., via ser2net) connection to host which is connected to Smartmeter sensor: - platform: dsmr host: 192.168.1.13 diff --git a/source/_integrations/dsmr_reader.markdown b/source/_integrations/dsmr_reader.markdown index 26383c4880c..e27100c403d 100644 --- a/source/_integrations/dsmr_reader.markdown +++ b/source/_integrations/dsmr_reader.markdown @@ -7,6 +7,7 @@ ha_iot_class: Cloud Polling ha_release: 0.103 ha_codeowners: - '@depl0y' +ha_domain: dsmr_reader --- The `dsmr_reader` sensor platform allows you to easily add all sensors that [DSMR Reader](https://dsmr-reader.readthedocs.io/en/latest/) exposes to MQTT. It adds a separate sensor for every field in the MQTT topics. diff --git a/source/_integrations/dte_energy_bridge.markdown b/source/_integrations/dte_energy_bridge.markdown index fa42c7c9509..9c042a992ab 100644 --- a/source/_integrations/dte_energy_bridge.markdown +++ b/source/_integrations/dte_energy_bridge.markdown @@ -6,6 +6,7 @@ ha_category: - Energy ha_release: 0.21 ha_iot_class: Local Polling +ha_domain: dte_energy_bridge --- A sensor platform for the [DTE](https://www.newlook.dteenergy.com/) Energy Bridge. To find out which version of the DTE Energy Bridge sensor you have, find the status LED on your box. diff --git a/source/_integrations/dublin_bus_transport.markdown b/source/_integrations/dublin_bus_transport.markdown index a32f4323725..a6e6bcced2b 100644 --- a/source/_integrations/dublin_bus_transport.markdown +++ b/source/_integrations/dublin_bus_transport.markdown @@ -6,6 +6,7 @@ ha_category: - Transport ha_iot_class: Cloud Polling ha_release: 0.36 +ha_domain: dublin_bus_transport --- The `dublin_bus_transport` sensor will give you the time until the next two departures from a Dublin bus stop using the RTPI information. diff --git a/source/_integrations/duckdns.markdown b/source/_integrations/duckdns.markdown index 709cbc04742..9acec85ae01 100644 --- a/source/_integrations/duckdns.markdown +++ b/source/_integrations/duckdns.markdown @@ -1,10 +1,10 @@ --- title: Duck DNS description: Keep your computer registered with the DuckDNS dynamic DNS. -logo: duckdns.png ha_category: - Network ha_release: 0.55 +ha_domain: duckdns --- With the DuckDNS integration you can keep your DuckDNS record up to date. DuckDNS is a free dynamic DNS service that allows you to point a subdomain under `duckdns.org` at your computer. @@ -44,4 +44,3 @@ Set the TXT record of your DuckDNS subdomain. | Service data attribute | Optional | Description | | ---------------------- | -------- | ----------- | | `txt` | no | Payload for the TXT record. | - diff --git a/source/_integrations/dunehd.markdown b/source/_integrations/dunehd.markdown index 78b09a72806..9dddc6e5dbd 100644 --- a/source/_integrations/dunehd.markdown +++ b/source/_integrations/dunehd.markdown @@ -1,11 +1,11 @@ --- title: DuneHD description: Instructions on how to integrate DuneHD media players into Home Assistant. -logo: dunehd.png ha_category: - Media Player ha_iot_class: Local Polling ha_release: 0.34 +ha_domain: dunehd --- The `dunehd` media player platform allows you to control a [Dune HD media player](https://dune-hd.com/eng/products/full_hd_media_players) from Home Assistant. Support is based on the official [IP protocol](https://dune-hd.com/support/ip_control/dune_ip_control_overview.txt) published by Dune. diff --git a/source/_integrations/dwd_weather_warnings.markdown b/source/_integrations/dwd_weather_warnings.markdown index ec579b36891..69d291cf706 100644 --- a/source/_integrations/dwd_weather_warnings.markdown +++ b/source/_integrations/dwd_weather_warnings.markdown @@ -5,6 +5,7 @@ ha_category: - Weather ha_release: 0.51 ha_iot_class: Cloud Polling +ha_domain: dwd_weather_warnings --- The `dwd_weather_warnings` sensor platform uses the [Deutsche Wetter Dienst (DWD)](https://www.dwd.de) as a source for current and advance warnings. diff --git a/source/_integrations/dweet.markdown b/source/_integrations/dweet.markdown index fd2799d7ac4..af530711f33 100644 --- a/source/_integrations/dweet.markdown +++ b/source/_integrations/dweet.markdown @@ -9,6 +9,7 @@ ha_release: 0.19 ha_iot_class: Cloud Polling ha_codeowners: - '@fabaff' +ha_domain: dweet --- The `dweet` integration makes it possible to transfer details collected with Home Assistant to [Dweet.io](https://dweet.io/) and visualize them with [freeboard.io](https://freeboard.io). Keep in mind that your information will be public! diff --git a/source/_integrations/dynalite.markdown b/source/_integrations/dynalite.markdown index bf0b9203b78..b5a87b91f93 100755 --- a/source/_integrations/dynalite.markdown +++ b/source/_integrations/dynalite.markdown @@ -5,21 +5,27 @@ logo: dynalite.png ha_category: - Hub - Light + - Switch ha_iot_class: Local Push ha_release: 0.106 +ha_codeowners: + - '@ziv1234' +ha_config_flow: true +ha_domain: dynalite --- -Philips Dynalite support is integrated into Home Assistant as a hub that can drive the light platforms. +Philips Dynalite support is integrated into Home Assistant as a hub that can drive the light and switch platforms. There is currently support for the following device types within Home Assistant: - Lights +- Switches A Philips Dynalite hub connects to the Dynet network, which is composed of areas, channels, and preset. A Dynalite area typically (although not necessarily) defines some physical area, such as a room. -Each area can have one or more channels that correspond to the different devices they control. A channel can relate to a dimmable light, or other devices, such as a cover. +Each area can have one or more channels that correspond to the different devices they control. A channel can relate to a dimmable light, or other devices. Additionally, each area can have one or more presets that determine the behavior of all the channels, and sometimes trigger additional actions. Typically, preset 1 in an area means 'on', and preset '4' means off. Additional presets could be used for scenes and dimming. @@ -50,17 +56,17 @@ name: type: string default: dynalite active: - description: Actively query network. When starting, it will query all devices for their current status, and also will send queries when some changes are in progress (e.g., lights dimming or covers moving). Better experience but creates more load on the Dynalite network. + description: "Actively query network. When starting, it will query all devices for their current status, and also will send queries when some changes are in progress (e.g., lights dimming or covers moving). Better experience but creates more load on the Dynalite network. Value can be `on`, `off`, our `init`, where `init` will only send queries during the initial init of Home Assistant." required: false - type: boolean + type: [boolean, string] default: false polltimer: - description: Polling interval for devices in transition. Value in seconds. When devices are in transition (e.g., a light fading), it will ask for a new state every X seconds until it is at the target level. Only relevant when active is set. + description: "Polling interval for devices in transition. Value in seconds. When devices are in transition (e.g., a light fading), it will ask for a new state every X seconds until it is at the target level. Only relevant when active is set to `on`." required: false type: float default: 1.0 autodiscover: - description: Enable auto-discover. As Dynalite does not support autodiscovery, this tracks event on your network, so if you turn on a light, it will be added to Home Assistant. + description: Enable auto-discover. As Dynalite does not support native autodiscovery, this tracks events on your network, so if you turn on a light, it will be added to Home Assistant. required: false type: boolean default: false @@ -78,7 +84,7 @@ area: required: true type: map keys: - 'AREA_NUMBER': + AREA_NUMBER: description: The Dynalite area number, 1-255. required: true type: map @@ -92,12 +98,37 @@ area: required: false type: float default: 2.0 + preset: + description: Specific presets for the area. + required: false + type: map + keys: + PRESET_NUMBER: + description: The Dynalite preset number in the area. + required: true + type: map + keys: + name: + description: Name of the preset. + required: false + type: string + default: AREA_NAME Preset PRESET_NUMBER + fade: + description: Fade time for the preset, in seconds. + required: false + type: float + default: 2.0 + nodefault: + description: Do not use the default presets defined globally, but only the specific ones defined for this area. + required: false + type: boolean + default: false channel: description: Map of the channels in this area. required: false type: map keys: - 'CHANNEL_NUMBER': + CHANNEL_NUMBER: description: The Dynalite channel number in the area, 1-255. required: true type: map @@ -106,12 +137,37 @@ area: description: Name of the channel. required: false type: string - default: \"AREA_NAME Channel CHANNEL_NUMBER\" + default: AREA_NAME Channel CHANNEL_NUMBER + type: + description: "Type of entity this should appear as. Can be either `light` or if this is a device that is not a light (e.g., water heater), can be `switch`." + require: false + type: string + default: light fade: description: Fade time for the channel, in seconds. required: false type: float default: 2.0 +preset: + description: "Default presets for any area without the `nodefault` option." + required: false + type: map + keys: + PRESET_NUMBER: + description: The Dynalite preset number in the area. + required: true + type: map + keys: + name: + description: "Name of the preset. When used in an area, it will be 'AREA_NAME name'. For example, if a room's name is 'Kitchen' and preset 4 is defined with the name `Off`, it will appear in HA as 'Kitchen Off'." + required: false + type: string + default: AREA_NAME Preset PRESET_NUMBER + fade: + description: Fade time for the preset, in seconds. + required: false + type: float + default: 2.0 {% endconfiguration %} ## Examples @@ -124,17 +180,29 @@ dynalite: port: 12345 autodiscover: true polltimer: 1 - areacreate: auto - log_level: debug area: + '1': + name: Office '2': name: Living Room + nodefault: true channel: '2': name: Entrance Spot fade: 10.0 '3': name: Dining Table + preset: + '5': + name: Blinking Lights + '6': + name: All Off + fade: 3.0 + preset: + '1': + name: 'On' + '4': + name: 'Off' ``` ## Initial configuration and discovery diff --git a/source/_integrations/dyson.markdown b/source/_integrations/dyson.markdown index 8aacc824fef..db79855dc25 100644 --- a/source/_integrations/dyson.markdown +++ b/source/_integrations/dyson.markdown @@ -12,6 +12,7 @@ ha_iot_class: Cloud Polling ha_release: 0.47 ha_codeowners: - '@etheralm' +ha_domain: dyson --- The `dyson` integration is the main integration to integrate all [Dyson](https://www.dyson.com) related platforms. diff --git a/source/_integrations/ebox.markdown b/source/_integrations/ebox.markdown index 69c8ee9cc66..e4e352ef6e7 100644 --- a/source/_integrations/ebox.markdown +++ b/source/_integrations/ebox.markdown @@ -6,6 +6,7 @@ ha_category: - Network ha_release: 0.39 ha_iot_class: Cloud Polling +ha_domain: ebox --- Integrate your [EBox](https://client.ebox.ca/) account information into Home Assistant. diff --git a/source/_integrations/ebusd.markdown b/source/_integrations/ebusd.markdown index b304c95e0a6..5045f451091 100644 --- a/source/_integrations/ebusd.markdown +++ b/source/_integrations/ebusd.markdown @@ -5,6 +5,7 @@ ha_category: - Sensor ha_iot_class: Local Polling ha_release: 0.88 +ha_domain: ebusd --- Integration between [ebusd](https://github.com/john30/ebusd/) daemon for communication with eBUS heating systems, and Home Assistant using sensor component. diff --git a/source/_integrations/ecoal_boiler.markdown b/source/_integrations/ecoal_boiler.markdown index 0ca3a3589b7..992726b939a 100644 --- a/source/_integrations/ecoal_boiler.markdown +++ b/source/_integrations/ecoal_boiler.markdown @@ -5,6 +5,7 @@ ha_category: - Water Heater ha_release: 0.87 ha_iot_class: Local Polling +ha_domain: ecoal_boiler --- The `ecoal_boiler` integration is the base for pumps and sensors managed by [esterownik.pl eCoal boiler controller](https://esterownik.pl/nasze-produkty/ecoal). diff --git a/source/_integrations/ecobee.markdown b/source/_integrations/ecobee.markdown index 4e063fe6bb0..319887bb33e 100644 --- a/source/_integrations/ecobee.markdown +++ b/source/_integrations/ecobee.markdown @@ -1,7 +1,6 @@ --- title: ecobee description: Instructions for how to integrate ecobee thermostats and sensors within Home Assistant. -logo: ecobee.png ha_category: - Sensor - Binary Sensor @@ -14,6 +13,7 @@ ha_iot_class: Cloud Poll ha_config_flow: true ha_codeowners: - '@marthoc' +ha_domain: ecobee --- The `ecobee` integration lets you control and view sensor data from [ecobee](https://ecobee.com) thermostats. @@ -205,4 +205,4 @@ Sets the minimum amount of time that the fan will run per hour. | Service data attribute | Optional | Description | | ---------------------- | -------- | ------------------------------------------------------------------------------------------------------ | | `entity_id` | yes | String or list of strings that point at `entity_id`'s of climate devices to control. Use `entity_id: all` to target all. | -| `fan_min_on_time` | no | integer (e.g. 5) | +| `fan_min_on_time` | no | integer (e.g., 5) | diff --git a/source/_integrations/econet.markdown b/source/_integrations/econet.markdown index bace9cc8f0a..b0feccccce0 100644 --- a/source/_integrations/econet.markdown +++ b/source/_integrations/econet.markdown @@ -1,11 +1,11 @@ --- title: Rheem EcoNET Water Products description: Instructions on how to integrate Rheem EcoNet water heaters into Home Assistant. -logo: econet.png ha_category: - Water Heater ha_release: 0.61 ha_iot_class: Cloud Polling +ha_domain: econet --- The `econet` water heater platform is consuming the information provided by a [EcoNet enabled Rheem water heater](https://www.rheem.com/EcoNet/Home). This platform allows you to set the temperature, the operation mode, and enable vacation mode. diff --git a/source/_integrations/ecovacs.markdown b/source/_integrations/ecovacs.markdown index 239c55c8c0a..98fcd6c50b6 100644 --- a/source/_integrations/ecovacs.markdown +++ b/source/_integrations/ecovacs.markdown @@ -9,6 +9,7 @@ ha_iot_class: Cloud Push ha_release: 0.77 ha_codeowners: - '@OverloadUT' +ha_domain: ecovacs --- The `ecovacs` integration is the main integration to integrate all [Ecovacs](https://www.ecovacs.com) (Deebot) vacuums. You will need your Ecovacs account information (username, password) to discover and control vacuums in your account. diff --git a/source/_integrations/eddystone_temperature.markdown b/source/_integrations/eddystone_temperature.markdown index 2fee3c7045c..c84fb515b92 100644 --- a/source/_integrations/eddystone_temperature.markdown +++ b/source/_integrations/eddystone_temperature.markdown @@ -6,6 +6,7 @@ ha_category: - DIY ha_release: 0.42 ha_iot_class: Local Polling +ha_domain: eddystone_temperature --- The `eddystone_temperature` sensor platform reads temperature information from Bluetooth LE advertisements transmitted by [Eddystone](https://en.wikipedia.org/wiki/Eddystone_(Google)) beacons. Your beacons must be configured to transmit UID frames (for identification) and TLM frames (for temperature). diff --git a/source/_integrations/edimax.markdown b/source/_integrations/edimax.markdown index cb03fa8d84a..2df9521494a 100644 --- a/source/_integrations/edimax.markdown +++ b/source/_integrations/edimax.markdown @@ -5,6 +5,7 @@ logo: edimax.png ha_category: - Switch ha_release: pre 0.7 +ha_domain: edimax --- This `edimax` switch platform allows you to control the state of your [Edimax](https://www.edimax.com/edimax/merchandise/merchandise_list/data/edimax/global/home_automation_smart_plug/) switches. diff --git a/source/_integrations/edl21.markdown b/source/_integrations/edl21.markdown new file mode 100644 index 00000000000..cc0af0d410c --- /dev/null +++ b/source/_integrations/edl21.markdown @@ -0,0 +1,37 @@ +--- +title: "EDL21 smart meter" +description: "Instructions on how to integrate SML-based EDL21 smart meters into Home Assistant." +ha_category: + - Sensor +ha_release: 0.107 +--- + +The `edl21` integration lets you read German EDL21 smart meters using [SML](https://de.wikipedia.org/wiki/Smart_Message_Language) from Home Assistant. + +In order to connect to the smart meter, an infrared transceiver is required. + +Compatible transceivers: + +- [DIY](https://wiki.volkszaehler.org/hardware/controllers/ir-schreib-lesekopf-rs232-ausgang) +- [Weidmann Elektronik Schreib-/Lesekopf USB](https://shop.weidmann-elektronik.de/index.php?page=product&info=24) + +Tested smart meters: + +- Iskraemeco MT175 (ISKRA MT175-D2A51-V22-K0t) + +## Configuration + +To set it up, add the following information to your `configuration.yaml` file: + +```yaml +sensor: + - platform: edl21 + serial_port: /dev/ttyUSB0 +``` + +{% configuration %} +serial_port: + description: The device to communicate with. When using ser2net, use socket://host:port. + required: true + type: string +{% endconfiguration %} diff --git a/source/_integrations/ee_brightbox.markdown b/source/_integrations/ee_brightbox.markdown index ecfb6610328..97b20ddb95f 100644 --- a/source/_integrations/ee_brightbox.markdown +++ b/source/_integrations/ee_brightbox.markdown @@ -1,11 +1,11 @@ --- title: EE Bright Box description: Instructions on how to integrate EE Bright Box router into Home Assistant. -logo: ee.png ha_category: - Presence Detection ha_release: 0.87 ha_iot_class: Local Polling +ha_domain: ee_brightbox --- This platform offers presence detection by looking at connected devices to a [EE Bright Box 2](https://ee.co.uk/help/phones-and-device/home-broadband/bright-box-2-wireless-router/bright-box-2-wireless-router) router. diff --git a/source/_integrations/efergy.markdown b/source/_integrations/efergy.markdown index 1a8c255665b..6012d6dea90 100644 --- a/source/_integrations/efergy.markdown +++ b/source/_integrations/efergy.markdown @@ -6,6 +6,7 @@ ha_category: - Energy ha_release: pre 0.7 ha_iot_class: Cloud Polling +ha_domain: efergy --- Integrate your [Efergy](https://efergy.com) meter information into Home Assistant. diff --git a/source/_integrations/egardia.markdown b/source/_integrations/egardia.markdown index 512a6ca0728..50c49c99992 100644 --- a/source/_integrations/egardia.markdown +++ b/source/_integrations/egardia.markdown @@ -10,6 +10,7 @@ ha_release: 0.65 ha_iot_class: Local Polling ha_codeowners: - '@jeroenterheerdt' +ha_domain: egardia --- The `egardia` platform enables the ability to control an [Egardia](https://egardia.com/)/[Woonveilig](https://woonveilig.nl) control panel. These alarm panels are known under different brand names across the world, including Woonveilig in the Netherlands. This was tested on the WL-1716, GATE-01, GATE-02 and GATE-03 versions of the Egardia/Woonveilig platform. Not only will you integrate your alarm control panel, supported sensors (door contacts at this moment) will be added automatically (hidden by default). @@ -99,7 +100,7 @@ There seem to be multiple versions of software running on GATE-02 devices; we ha 1. Log in to your alarm system's control panel. You will need to access http://[IP of your control panel]. You know this already since you need it in the basic configuration from above. Log in to the control panel with your Egardia/Woonveilig username and password. 2. Once logged in, go to *System Settings*, *Report* and change the Server Address for your primary server to the IP or hostname of your Home Assistant machine. You can leave the port number set to 52010 or change it to anything you like. **Make sure to change the settings of the primary server otherwise the messages will not come through. Note that this will limit (or fully stop) the number of alarm messages you will get through Egardia's / Woonveilig services.** Maybe, that is just what you want. Make sure to save your settings by selecting 'OK'. -3. The Egardia integration relies on capturing the status codes that your alarm emits when something happens (status change or trigger). These codes will be unique for every situation - i.e. the code emitted by the alarm when a sensor is triggered is unique to that sensor. Also, if you have multiple users or remotes, each remote has unique codes that are emitted by the alarm when status is changed using that remote or by that user. For the Egardia integration to work correctly you will need to capture the codes. To do this, on your Home Assistant machine run `$ sudo python3 egardiaserver.py`. Refer to the [python-egardia repository](https://github.com/jeroenterheerdt/python-egardia) for detailed documentation on parameters. This will receive status codes from your alarm control panel and display them. Record the codes shown as well as the status they relate to (see step 4 below). Make sure to change the status of your alarm to all states (disarm, arm, home) by all means possible (all users, remotes, web login, app) as well as trigger the alarm in all ways possible to get 100% coverage of all the codes the alarm system generates. You will need to run this script once and stop it once you have captured all the possible codes. Also, if you ever add users, remotes or sensors to your alarm system, make sure to re-run the script to capture the extra codes so you can update your configuration (see step 4 below). **For comfort, before triggering the alarm it might be good to disable the siren temporarily (can be done in Panel Settings).** +3. The Egardia integration relies on capturing the status codes that your alarm emits when something happens (status change or trigger). These codes will be unique for every situation - i.e., the code emitted by the alarm when a sensor is triggered is unique to that sensor. Also, if you have multiple users or remotes, each remote has unique codes that are emitted by the alarm when status is changed using that remote or by that user. For the Egardia integration to work correctly you will need to capture the codes. To do this, on your Home Assistant machine run `$ sudo python3 egardiaserver.py`. Refer to the [python-egardia repository](https://github.com/jeroenterheerdt/python-egardia) for detailed documentation on parameters. This will receive status codes from your alarm control panel and display them. Record the codes shown as well as the status they relate to (see step 4 below). Make sure to change the status of your alarm to all states (disarm, arm, home) by all means possible (all users, remotes, web login, app) as well as trigger the alarm in all ways possible to get 100% coverage of all the codes the alarm system generates. You will need to run this script once and stop it once you have captured all the possible codes. Also, if you ever add users, remotes or sensors to your alarm system, make sure to re-run the script to capture the extra codes so you can update your configuration (see step 4 below). **For comfort, before triggering the alarm it might be good to disable the siren temporarily (can be done in Panel Settings).** 4. Once you have the codes, update your `configuration.yaml`: ```yaml # Example configuration.yaml entry diff --git a/source/_integrations/eight_sleep.markdown b/source/_integrations/eight_sleep.markdown index 15dcc5b0c6d..62409889393 100644 --- a/source/_integrations/eight_sleep.markdown +++ b/source/_integrations/eight_sleep.markdown @@ -10,6 +10,7 @@ ha_release: 0.44 ha_iot_class: Cloud Polling ha_codeowners: - '@mezz64' +ha_domain: eight_sleep --- The `eight_sleep` integration allows Home Assistant to fetch data from your [Eight Sleep](https://eightsleep.com/) smart cover or mattress. diff --git a/source/_integrations/elgato.markdown b/source/_integrations/elgato.markdown index 547fbe0e3c2..3cf25d29310 100644 --- a/source/_integrations/elgato.markdown +++ b/source/_integrations/elgato.markdown @@ -1,7 +1,6 @@ --- title: Elgato Key Light description: Instructions on how to integrate an Elgato Key Light with Home Assistant. -logo: elgato.jpg ha_category: - Light ha_release: 0.104 @@ -11,6 +10,7 @@ ha_config_flow: true ha_codeowners: - '@frenck' ha_quality_scale: platinum +ha_domain: elgato --- The [Elgato Key Light](https://www.elgato.com/en/gaming/key-light) sets the diff --git a/source/_integrations/eliqonline.markdown b/source/_integrations/eliqonline.markdown index aaed08ffeaf..395784027e2 100644 --- a/source/_integrations/eliqonline.markdown +++ b/source/_integrations/eliqonline.markdown @@ -1,11 +1,11 @@ --- title: Eliqonline description: Instructions on how to integrate Eliqonline devices within Home Assistant. -logo: eliq.png ha_category: - Energy ha_release: '0.10' ha_iot_class: Cloud Polling +ha_domain: eliqonline --- Integrate your [ELIQ Online](https://eliq.io/) smart meter information into Home Assistant. To get an [access token](https://my.eliq.io/user/settings/api) and the [Channel ID](https://my.eliq.io/user/settings/locations), log in to your account. diff --git a/source/_integrations/elkm1.markdown b/source/_integrations/elkm1.markdown index 17cbb3cc9c5..603603fcb33 100644 --- a/source/_integrations/elkm1.markdown +++ b/source/_integrations/elkm1.markdown @@ -12,6 +12,7 @@ ha_category: - Sensor - Switch ha_iot_class: Local Push +ha_domain: elkm1 --- The Elk-M1 is a home security and automation controller that is capable of alarm control panel functions and automation. diff --git a/source/_integrations/elv.markdown b/source/_integrations/elv.markdown index e69a0c7b45e..5fedad51a3e 100644 --- a/source/_integrations/elv.markdown +++ b/source/_integrations/elv.markdown @@ -1,12 +1,12 @@ --- title: ELV PCA description: Instructions on how to integrate ELV PCA 301 switches into Home Assistant. -logo: elv.png ha_category: Switch ha_iot_class: Local Polling ha_release: 0.95 ha_codeowners: - '@majuss' +ha_domain: elv --- The `pca` switch platform allows you to control the state of your [ELV PCA 301 smart switch](https://www.elv.de/funkschaltsteckdose-fuer-energiekostenmonitor-pca-301.html). You need an 868 MHz interface like the [JeeLink](https://www.digitalsmarties.net/products/jeelink) flashed with the [pca-hex firmware](https://github.com/mhop/fhem-mirror/blob/master/fhem/FHEM/firmware/JeeLink_PCA301.hex). diff --git a/source/_integrations/emby.markdown b/source/_integrations/emby.markdown index 0379284835b..a8851a12bc8 100644 --- a/source/_integrations/emby.markdown +++ b/source/_integrations/emby.markdown @@ -8,6 +8,7 @@ ha_release: 0.32 ha_iot_class: Local Push ha_codeowners: - '@mezz64' +ha_domain: emby --- The `emby` platform allows you to control a [Emby](https://emby.media/) multimedia system from Home Assistant. diff --git a/source/_integrations/emoncms.markdown b/source/_integrations/emoncms.markdown index 29b79994213..43f0caf2cd3 100644 --- a/source/_integrations/emoncms.markdown +++ b/source/_integrations/emoncms.markdown @@ -6,6 +6,7 @@ ha_category: - Sensor ha_release: 0.29 ha_iot_class: Local Polling +ha_domain: emoncms --- The `emoncms` sensor platform creates sensors for the feeds available in your local or cloud based version of [Emoncms](https://emoncms.org). @@ -21,17 +22,49 @@ sensor: id: 1 ``` +As of Feb 2020, the integration will discover all sensors from Emoncms and will use the unit of measurement specified in the Feed from Emoncms, in preference to the one set in the configuration. Tested with [Emoncms](https://github.com/emoncms/emoncms) V10.1.13 - `unit` was added to the API around version V9.9.1. + ## Configuration variables -- `api_key` (*Required*): The read API key for your Emoncms user. -- `url` (*Required*): The base URL of Emoncms, use for the cloud based version. -- `id` (*Required*): Positive integer identifier for the sensor. Must be unique if you specify multiple Emoncms sensors. -- `include_only_feed_id` (*Optional*): Positive integer list of Emoncms feed IDs. Only the feeds with feed IDs specified here will be displayed. Can not be specified if `exclude_feed_id` is specified. -- `exclude_feed_id` (*Optional*): Positive integer list of Emoncms feed IDs. All the feeds will be displayed as sensors except the ones listed here. Can not be specified if `include_only_feed_id` is specified. -- `sensor_names` (*Optional*): Dictionary of names for the sensors created that are created based on feed ID. The dictionary consists of `feedid: name` pairs. Sensors for feeds with their feed ID mentioned here will get the chosen name instead of the default name -- `value_template` (*Optional*): Defines a [template](/docs/configuration/templating/#processing-incoming-data) to alter the feed value. -- `scan_interval` (*Optional*): Defines the update interval of the sensor in seconds. -- `unit_of_measurement` (*Optional*): Defines the unit of measurement of for all the sensors. default is "W". +{% configuration %} +api_key: + description: The read API key for your Emoncms user. + required: true + type: string +url: + description: "The base URL of Emoncms, use for the cloud-based version. For self-hosted Emoncms or EmonPi you may need a URL of `http://x.x.x.x/emoncms`." + required: true + type: string +id: + description: Positive integer identifier for the sensor. Must be unique if you specify multiple Emoncms sensors. + required: true + type: integer +include_only_feed_id: + description: Positive integer list of Emoncms feed IDs. Only the feeds with feed IDs specified here will be displayed. Can not be specified if `exclude_feed_id` is specified. + required: false + type: list +exclude_feed_id: + description: Positive integer list of Emoncms feed IDs. All the feeds will be displayed as sensors except the ones listed here. Can not be specified if `include_only_feed_id` is specified. + required: false + type: list +sensor_names: + description: "Dictionary of names for the sensors created that are created based on feed ID. The dictionary consists of `feedid: name` pairs. Sensors for feeds with their feed ID mentioned here will get the chosen name instead of the default name." + required: false + type: [integer, list] +value_template: + description: Defines a [template](/docs/configuration/templating/#processing-incoming-data) to alter the feed value. + required: false + type: template +scan_interval: + description: Defines the update interval of the sensor in seconds. + required: false + type: integer +unit_of_measurement: + description: Defines the unit of measurement to be used for any sensor where the unit is *not* set in Emoncms. If no unit is set in Emoncms or in the configuration, the default (W) will be used. + required: false + default: W + type: string +{% endconfiguration %} ## Default naming scheme @@ -45,6 +78,16 @@ If `sensor_names` is used, any feeds with defined names will get those names exa In this section you find some more examples of how this sensor can be used. +Minimal configuration. All Feeds are added as sensors with the unit of measurement being set by the Emoncms Feed or the default unit. + +```yaml +sensor: + platform: emoncms + api_key: API_KEY + url: https://emoncms.org + id: 1 +``` + Display only feeds with their feed IDs specified in `include_only_feed_id`. ```yaml @@ -69,7 +112,7 @@ sensor: api_key: API_KEY url: https://emoncms.org id: 1 - unit_of_measurement: "KWH" + unit_of_measurement: "kWh" exclude_feed_id: - 107 - 105 @@ -84,7 +127,7 @@ sensor: api_key: API_KEY url: https://emoncms.org id: 1 - unit_of_measurement: "KW" + unit_of_measurement: "kW" include_only_feed_id: - 5 - 120 @@ -126,7 +169,7 @@ sensor: - 107 - 106 - platform: emoncms - api_key: put your emoncms read api key here + api_key: API_KEY url: https://emoncms.org id: 2 scan_interval: 60 diff --git a/source/_integrations/emoncms_history.markdown b/source/_integrations/emoncms_history.markdown index 2bb3c0a2b63..124383acba9 100644 --- a/source/_integrations/emoncms_history.markdown +++ b/source/_integrations/emoncms_history.markdown @@ -5,6 +5,7 @@ logo: emoncms.png ha_category: - History ha_release: 0.31 +ha_domain: emoncms_history --- The `emoncms_history` integration makes it possible to transfer details collected with Home Assistant to [Emoncms.org](https://emoncms.org/) or your local running Emoncms instance. It will send the data to a specific input node on Emoncms with the entity IDs as a key. Afterwards you can create feeds and dashboards in Emoncms with the collected data. diff --git a/source/_integrations/emulated_hue.markdown b/source/_integrations/emulated_hue.markdown index 37d163f732f..31d8f2170e0 100644 --- a/source/_integrations/emulated_hue.markdown +++ b/source/_integrations/emulated_hue.markdown @@ -1,12 +1,12 @@ --- title: Emulated Hue description: Instructions on how to emulate a Hue Bridge within Home Assistant. -logo: home-assistant.png ha_category: - Hub ha_release: 0.27 ha_iot_class: Local Push ha_quality_scale: internal +ha_domain: emulated_hue ---
    @@ -148,7 +148,7 @@ You can verify that the `emulated_hue` integration has been loaded and is respon - `http://:80/description.xml` - This URL should return a descriptor file in the form of an XML file. - `http://:80/api/pi/lights` - This will return a list of devices, lights, scenes, groups, etc.. that `emulated_hue` is exposing to Alexa. -Verify that the URLs above are using port 80, rather than port 8300 (i.e. `http://:80/description.xml`). Both Google Home and Amazon Alexa/Echo (as of the 2019-08 firmware) require port 80. +Verify that the URLs above are using port 80, rather than port 8300 (i.e., `http://:80/description.xml`). Both Google Home and Amazon Alexa/Echo (as of the 2019-08 firmware) require port 80. ### Platform specific instructions diff --git a/source/_integrations/emulated_roku.markdown b/source/_integrations/emulated_roku.markdown index 3ed02e9dc5c..c06b44b74f6 100644 --- a/source/_integrations/emulated_roku.markdown +++ b/source/_integrations/emulated_roku.markdown @@ -1,12 +1,12 @@ --- title: Emulated Roku description: Instructions on how to set up Emulated Roku within Home Assistant. -logo: home-assistant.png ha_category: - Hub ha_release: 0.86 ha_iot_class: Local Push ha_config_flow: true +ha_domain: emulated_roku --- This integration integrates an emulated Roku API into Home Assistant, diff --git a/source/_integrations/enigma2.markdown b/source/_integrations/enigma2.markdown index 0666c829220..e195b45756e 100644 --- a/source/_integrations/enigma2.markdown +++ b/source/_integrations/enigma2.markdown @@ -8,6 +8,7 @@ ha_release: '0.90' ha_iot_class: Local Polling ha_codeowners: - '@fbradyirl' +ha_domain: enigma2 --- The `enigma2` platform allows you to control a Linux based set-top box which is running [Enigma2](https://github.com/oe-alliance/oe-alliance-enigma2) with the OpenWebif plugin installed. diff --git a/source/_integrations/enocean.markdown b/source/_integrations/enocean.markdown index d169f707dc3..ae8aefc4caa 100644 --- a/source/_integrations/enocean.markdown +++ b/source/_integrations/enocean.markdown @@ -12,6 +12,7 @@ ha_release: 0.21 ha_iot_class: Local Push ha_codeowners: - '@bdurrer' +ha_domain: enocean --- The [EnOcean](https://en.wikipedia.org/wiki/EnOcean) standard is supported by many different vendors. There are switches and sensors of many different kinds, and typically they employ energy harvesting to get power such that no batteries are necessary. diff --git a/source/_integrations/enphase_envoy.markdown b/source/_integrations/enphase_envoy.markdown index cb86717166d..0a55306f4ff 100644 --- a/source/_integrations/enphase_envoy.markdown +++ b/source/_integrations/enphase_envoy.markdown @@ -1,11 +1,11 @@ --- title: Enphase Envoy description: Instructions on how to setup Enphase Envoy with Home Assistant. -logo: enphase-logo.svg ha_category: - Energy ha_release: 0.76 ha_iot_class: Local Polling +ha_domain: enphase_envoy --- A sensor platform for the [Enphase Envoy](https://enphase.com/en-us/products-and-services/envoy-and-combiner) solar energy gateway. Works with older models that only have production metrics (ie. Envoy-C) and newer models that offer both production and consumption metrics (ie. Envoy-S). diff --git a/source/_integrations/entur_public_transport.markdown b/source/_integrations/entur_public_transport.markdown index b5be18d9409..5d1a9d4ee53 100644 --- a/source/_integrations/entur_public_transport.markdown +++ b/source/_integrations/entur_public_transport.markdown @@ -1,13 +1,13 @@ --- title: Entur description: Instructions for how to set up monitoring of public transport departures in Norway. -logo: entur.svg ha_category: - Transport ha_release: 0.84 ha_iot_class: Cloud Polling ha_codeowners: - '@hfurubotten' +ha_domain: entur_public_transport --- The `entur_public_transport` sensor gives real-time departure information for the next departures from any bus stop, car ferry quay, train station, airport and person ferries quay in Norway. diff --git a/source/_integrations/environment_canada.markdown b/source/_integrations/environment_canada.markdown index d77b41584db..39ff7c889a7 100644 --- a/source/_integrations/environment_canada.markdown +++ b/source/_integrations/environment_canada.markdown @@ -10,6 +10,7 @@ ha_release: 0.95 ha_iot_class: Cloud Polling ha_codeowners: - '@michaeldavie' +ha_domain: environment_canada --- The `environment_canada` weather platforms provide meteorological data for Canadian locations from [Environment Canada](https://weather.gc.ca/index_e.html). @@ -71,7 +72,7 @@ station: required: false type: string name: - description: Name to be used for the entity ID, e.g. `weather.`. + description: Name to be used for the entity ID, e.g., `weather.`. required: false type: string forecast: @@ -99,20 +100,20 @@ sensor: - `wind_chill` - The current wind chill, in ºC. - `humidex` - The current humidex, in ºC. - `pressure` - The current air pressure, in kPa. - - `tendency` - The current air pressure tendency, e.g. "Rising". + - `tendency` - The current air pressure tendency, e.g., "Rising". - `humidity` - The current humidity, in %. - `visibility` - The current visibility, in km. - - `condition` - A brief text statement of the current weather conditions, e.g. "Sunny". + - `condition` - A brief text statement of the current weather conditions, e.g., "Sunny". - `icon_code` - A two-digit number corresponding to a condition icon, as specified in these [image to description](https://dd.weather.gc.ca/citypage_weather/docs/Current_Conditions_Icons-Icones_conditions_actuelles.pdf) and [code to description](https://dd.weather.gc.ca/citypage_weather/docs/current_conditions_icon_code_descriptions_e.csv) mappings. - `wind_speed` - The current sustained wind speed, in km/h. - `wind_gust` - The current wind gust, in km/h. - - `wind_dir` - The current cardinal wind direction, e.g. "SSW". + - `wind_dir` - The current cardinal wind direction, e.g., "SSW". - `wind_bearing` - The current wind direction in degrees. - `high_temp` - The next forecast high temperature, in ºC. - `low_temp` - The next forecast low temperature, in ºC. - `uv_index` - The next forecast UV index. - `pop` - The next forecast probability of precipitation, in %. - - `text_summary` - A textual description of the next forecast period, e.g. "Tonight. Mainly cloudy. Low -12." + - `text_summary` - A textual description of the next forecast period, e.g., "Tonight. Mainly cloudy. Low -12." - `precip_yesterday` - The total amount of precipitation that fell the previous day. - `warnings` - Current warning alerts. - `watches` - Current watch alerts. @@ -199,7 +200,7 @@ station: required: false type: string name: - description: Name to be used for the entity ID, e.g. `camera.`. + description: Name to be used for the entity ID, e.g., `camera.`. required: false type: string loop: diff --git a/source/_integrations/envirophat.markdown b/source/_integrations/envirophat.markdown index 00b6fe55547..6514177e4b6 100644 --- a/source/_integrations/envirophat.markdown +++ b/source/_integrations/envirophat.markdown @@ -1,11 +1,11 @@ --- title: Enviro pHAT description: Instructions on how to integrate the Enviro pHAT within Home Assistant. -logo: raspberry-pi.png ha_category: - DIY ha_iot_class: Local Polling ha_release: 0.44 +ha_domain: envirophat --- The `envirophat` sensor platform allows you to display information collected by an [Enviro pHAT](https://shop.pimoroni.com/products/enviro-phat) add-on board for the Raspberry Pi. The board features a wide range of sensors, such as: diff --git a/source/_integrations/envisalink.markdown b/source/_integrations/envisalink.markdown index 96b4bece4d1..26e348a4a35 100644 --- a/source/_integrations/envisalink.markdown +++ b/source/_integrations/envisalink.markdown @@ -8,6 +8,7 @@ ha_category: - Sensor ha_release: 0.23 ha_iot_class: Local Push +ha_domain: envisalink --- The `envisalink` integration will allow Home Assistant users who own either a DSC or Honeywell alarm panel to leverage their alarm system and its sensors to provide Home Assistant with rich information about their homes. Connectivity between Home Assistant and the alarm panel is accomplished through a device produced by Eyez On, known as the Envisalink. The Envisalink evl3 and evl4 boards provide a TCP/IP interface to the alarm panel, where it emulates an alarm keypad. This board also exposes a raw TCP/IP based API, upon which this integration is built. Currently, the Envisalink version 4 is the latest model. This integration supports both the evl3 and the evl4. @@ -104,7 +105,7 @@ panic_type: default: Police type: string zones: - description: "Envisalink boards have no way to tell us which zones are actually in use, so each zone must be configured in Home Assistant. For each zone, at least a name must be given. For more information on the available zone types, take a look at the [Binary Sensor](/integrations/envisalink) docs. *Note: If no zones are specified, Home Assistant will not load any binary_sensor components.*" + description: "Envisalink boards have no way to tell us which zones are actually in use, so each zone must be configured in Home Assistant. For each zone, at least a name must be given. For more information on the available zone types, take a look at the [Binary Sensor](/integrations/envisalink) documentation. *Note: If no zones are specified, Home Assistant will not load any binary_sensor components.*" required: false type: integer keys: diff --git a/source/_integrations/ephember.markdown b/source/_integrations/ephember.markdown index 3b2e7329bc1..409d5bca350 100644 --- a/source/_integrations/ephember.markdown +++ b/source/_integrations/ephember.markdown @@ -8,6 +8,7 @@ ha_release: 0.57 ha_iot_class: Local Polling ha_codeowners: - '@ttroy50' +ha_domain: ephember --- The `ephember` climate platform lets you control [EPH Controls](https://emberapp.ephcontrols.com/) thermostats. The module only works if you have a Wi-Fi gateway to control your EPH system and an account on the EMBER app. diff --git a/source/_integrations/epson.markdown b/source/_integrations/epson.markdown index 9e334888754..ff8459ff08b 100644 --- a/source/_integrations/epson.markdown +++ b/source/_integrations/epson.markdown @@ -6,6 +6,7 @@ ha_category: - Media Player ha_release: 0.72 ha_iot_class: Local Polling +ha_domain: epson --- The `epson` platform allows you to control a Epson projector from Home diff --git a/source/_integrations/epsonworkforce.markdown b/source/_integrations/epsonworkforce.markdown index a2dc7766bbc..f52d484d892 100644 --- a/source/_integrations/epsonworkforce.markdown +++ b/source/_integrations/epsonworkforce.markdown @@ -8,6 +8,7 @@ ha_release: 0.92 ha_iot_class: Local Polling ha_codeowners: - '@ThaStealth' +ha_domain: epsonworkforce --- The `epson workforce` platform allows you to monitor the ink levels of a Epson Workforce printer from Home diff --git a/source/_integrations/eq3btsmart.markdown b/source/_integrations/eq3btsmart.markdown index d0aeff56923..c35923f11a9 100644 --- a/source/_integrations/eq3btsmart.markdown +++ b/source/_integrations/eq3btsmart.markdown @@ -8,6 +8,7 @@ ha_iot_class: Local Polling ha_release: 0.18 ha_codeowners: - '@rytilahti' +ha_domain: eq3btsmart --- The `eq3btsmart` climate platform allows you to integrate EQ3 Bluetooth Smart Thermostats. diff --git a/source/_integrations/esphome.markdown b/source/_integrations/esphome.markdown index a1f5df856f3..e8d01bc80d7 100644 --- a/source/_integrations/esphome.markdown +++ b/source/_integrations/esphome.markdown @@ -2,7 +2,6 @@ title: ESPHome description: Support for ESPHome devices using the native ESPHome API. featured: true -logo: esphome.png ha_category: - DIY ha_release: 0.85 @@ -10,6 +9,7 @@ ha_iot_class: Local Push ha_config_flow: true ha_codeowners: - '@OttoWinter' +ha_domain: esphome --- This integration allows you to connect your [ESPHome](https://esphome.io) devices directly to Home Assistant with the [native ESPHome API](https://esphome.io/components/api.html). diff --git a/source/_integrations/essent.markdown b/source/_integrations/essent.markdown index d1c37a3d9ed..dffcd83444c 100644 --- a/source/_integrations/essent.markdown +++ b/source/_integrations/essent.markdown @@ -9,6 +9,7 @@ ha_release: 0.93 ha_iot_class: Cloud Polling ha_codeowners: - '@TheLastProject' +ha_domain: essent --- The `essent` platform uses [PyEssent](https://github.com/TheLastProject/PyEssent/) to communicate with the (undocumented) API of Dutch energy provider Essent. It provides sensors for each of your meters and tariffs, updated daily. diff --git a/source/_integrations/etherscan.markdown b/source/_integrations/etherscan.markdown index e9ff5f83810..206fba68dd9 100644 --- a/source/_integrations/etherscan.markdown +++ b/source/_integrations/etherscan.markdown @@ -6,6 +6,7 @@ ha_category: - Finance ha_release: 0.47 ha_iot_class: Cloud Polling +ha_domain: etherscan --- The `Etherscan` sensor platform displays Ether and ERC-20 token balances from [Etherscan.io](https://etherscan.io). diff --git a/source/_integrations/eufy.markdown b/source/_integrations/eufy.markdown index c6413b0a390..24890e2b336 100644 --- a/source/_integrations/eufy.markdown +++ b/source/_integrations/eufy.markdown @@ -8,6 +8,7 @@ ha_category: - Switch ha_release: 0.68 ha_iot_class: Local Polling +ha_domain: eufy --- The `eufy` integration is the main integration to integrate various [eufy](https://www.eufylife.com/) devices with Home Assistant. diff --git a/source/_integrations/everlights.markdown b/source/_integrations/everlights.markdown index 4b91cc58af0..4a3531edf2b 100644 --- a/source/_integrations/everlights.markdown +++ b/source/_integrations/everlights.markdown @@ -6,6 +6,7 @@ ha_category: - Light ha_iot_class: Local Polling ha_release: 0.87 +ha_domain: everlights --- [EverLights](https://myeverlights.com/) are permanent Christmas lights installed on a home's gutters or flashing. This integration can change all LEDs in a zone to a single color or activate a pattern that was previously saved to the control box. diff --git a/source/_integrations/evohome.markdown b/source/_integrations/evohome.markdown index 0fe274fd92a..0ece0adff3c 100644 --- a/source/_integrations/evohome.markdown +++ b/source/_integrations/evohome.markdown @@ -6,10 +6,11 @@ ha_category: - Hub - Climate - Water Heater -ha_release: "0.80" +ha_release: '0.80' ha_iot_class: Cloud Polling ha_codeowners: - '@zxdavb' +ha_domain: evohome --- The `evohome` integration links Home Assistant with all _non-US_ [Honeywell Total Connect Comfort (TCC)](https://international.mytotalconnectcomfort.com/Account/Login) CH/DHW systems, such as: @@ -80,7 +81,7 @@ These systems use an internet gateway rather than an Evohome controller. They us ## Temperature Precision -Note that TCC devices may well measure temperatures with very high precision, but the vendor API will report temperatures rounded _towards_ the setpoint (i.e. either up or down) with a precision of 0.5 °C; this a proxy for the deadband as used by other climate systems. Where possible, this integration will leverage an older vendor API to obtain current temperatures with a precision of 0.01 °C. +Note that TCC devices may well measure temperatures with very high precision, but the vendor API will report temperatures rounded _towards_ the setpoint (i.e., either up or down) with a precision of 0.5 °C; this a proxy for the deadband as used by other climate systems. Where possible, this integration will leverage an older vendor API to obtain current temperatures with a precision of 0.01 °C. Therefore, depending upon the above, Home Assistant will display/record current temperatures with a precision of either 0.5 °C or 0.1 °C (it's highest supported precision). diff --git a/source/_integrations/ezviz.markdown b/source/_integrations/ezviz.markdown new file mode 100644 index 00000000000..232e139e102 --- /dev/null +++ b/source/_integrations/ezviz.markdown @@ -0,0 +1,244 @@ +--- +title: "Ezviz Camera" +description: "Integrate Ezviz camera within Home Assistant." +logo: ezviz.png +ha_release: 0.107 +ha_category: + - Camera +ha_iot_class: Cloud Polling +ha_domain: ezviz +--- + +The `ezviz` sensor platform uses the EzvizLife API to interact with the devices. +It also exposes an RTSP stream, by using the local camera IPs (so the device hosting Home Assistant has to be able to access the local IP of the cameras). + +As there is no official documentation for the API, the component retrieves data from the API used in the Ezviz mobile app, [hosted here](https://apiieu.ezvizlife.com). + +## Configuration + +The configuration (see below) needs your Ezviz username & password you use within the Ezviz mobile application. + +Next, add the Ezviz camera to your `configuration.yaml` file like below: + +```yaml +# Example configuration.yaml entry +camera: + - platform: ezviz + username: YOUR_USERNAME + password: YOUR_PASSWORD + cameras: + D12345678: + username: YOUR_CAMERA_USERNAME + password: YOUR_CAMERA_PASSWORD +``` + +As you see, here is the way to describe the camera credentials. +The password for each camera is usually written underneath the device, near the QR code. It is also code "verification code". + +{% configuration %} +username: + description: The Ezviz account username. + required: true + type: string +password: + description: The Ezviz account password. + required: true + type: string +cameras: + description: A list of cameras + required: false + type: string + serial: + description: The Ezviz camera Serial, usually a letter followed by 8 digits. + required: true + type: string + username: + description: The Ezviz camera RTSP username. + required: true + type: string + password: + description: The Ezviz verification code. + required: true + type: string +{% endconfiguration %} + +## Lovelace + +If you want a shiny Lovelace card, with proper buttons, here is a snippet of a Lovelace card: + +```yaml + +camera_image: camera.c6n_d12345678 +camera_view: live +elements: + - icon: 'mdi:arrow-up' + style: + background: 'rgba(255, 255, 255, 0.5)' + bottom: 50px + right: 25px + tap_action: + action: call-service + service: camera.ezviz_ptz + service_data: + direction: up + entity_id: camera.c6n_d12345678 + type: icon + - icon: 'mdi:arrow-down' + style: + background: 'rgba(255, 255, 255, 0.5)' + bottom: 0px + right: 25px + tap_action: + action: call-service + service: camera.ezviz_ptz + service_data: + direction: down + entity_id: camera.c6n_d12345678 + type: icon + - icon: 'mdi:arrow-left' + style: + background: 'rgba(255, 255, 255, 0.5)' + bottom: 25px + right: 50px + tap_action: + action: call-service + service: camera.ezviz_ptz + service_data: + direction: left + entity_id: camera.c6n_d12345678 + type: icon + - icon: 'mdi:arrow-right' + style: + background: 'rgba(255, 255, 255, 0.5)' + bottom: 25px + right: 0px + tap_action: + action: call-service + service: camera.ezviz_ptz + service_data: + direction: right + entity_id: camera.c6n_d12345678 + type: icon + - icon: 'mdi:run-fast' + style: + background: 'rgba(255, 255, 255, 0.5)' + top: 25px + right: 25px + tap_action: + action: call-service + service: camera.ezviz_switch_follow_move_on + service_data: + entity_id: camera.c6n_d12345678 + confirmation: true + type: icon + - icon: 'mdi:run' + style: + background: 'rgba(255, 255, 255, 0.5)' + top: 25px + right: 0px + tap_action: + action: call-service + service: camera.ezviz_switch_follow_move_off + service_data: + entity_id: camera.c6n_d12345678 + confirmation: true + type: icon + - icon: 'mdi:eye' + style: + background: 'rgba(255, 255, 255, 0.5)' + right: 25px + top: 50px + tap_action: + action: call-service + service: camera.ezviz_switch_privacy_off + service_data: + entity_id: camera.c6n_d12345678 + confirmation: true + type: icon + - icon: 'mdi:eye-off' + style: + background: 'rgba(255, 255, 255, 0.5)' + right: 0px + top: 50px + tap_action: + action: call-service + service: camera.ezviz_switch_privacy_on + service_data: + entity_id: camera.c6n_d12345678 + confirmation: true + type: icon + - icon: 'mdi:volume-high' + style: + background: 'rgba(255, 255, 255, 0.5)' + right: 25px + top: 75px + tap_action: + action: call-service + service: camera.ezviz_switch_audio_off + service_data: + entity_id: camera.c6n_d12345678 + confirmation: true + type: icon + - icon: 'mdi:volume-off' + style: + background: 'rgba(255, 255, 255, 0.5)' + right: 0px + top: 75px + tap_action: + action: call-service + service: camera.ezviz_switch_audio_on + service_data: + entity_id: camera.c6n_d12345678 + confirmation: true + type: icon + - icon: 'mdi:led-on' + style: + background: 'rgba(255, 255, 255, 0.5)' + right: 25px + top: 100px + tap_action: + action: call-service + service: camera.ezviz_switch_state_off + service_data: + entity_id: camera.c6n_d12345678 + confirmation: true + type: icon + - icon: 'mdi:led-off' + style: + background: 'rgba(255, 255, 255, 0.5)' + right: 0px + top: 100px + tap_action: + action: call-service + service: camera.ezviz_switch_state_on + service_data: + entity_id: camera.c6n_d12345678 + confirmation: true + type: icon + - icon: 'mdi:brightness-4' + style: + background: 'rgba(255, 255, 255, 0.5)' + right: 25px + top: 100px + tap_action: + action: call-service + service: camera.ezviz_switch_ir_off + service_data: + entity_id: camera.c6n_d12345678 + confirmation: true + type: icon + - icon: 'mdi:brightness-5' + style: + background: 'rgba(255, 255, 255, 0.5)' + right: 0px + top: 100px + tap_action: + action: call-service + service: camera.ezviz_switch_ir_on + service_data: + entity_id: camera.c6n_d12345678 + confirmation: true + type: icon +entity: camera.c6n_d12345678 +type: picture-elements +``` diff --git a/source/_integrations/facebook.markdown b/source/_integrations/facebook.markdown index 00f287cb5b4..396f927e8da 100644 --- a/source/_integrations/facebook.markdown +++ b/source/_integrations/facebook.markdown @@ -1,10 +1,10 @@ --- title: Facebook Messenger description: Instructions on how to add Facebook user notifications to Home Assistant. -logo: facebook.png ha_category: - Notifications ha_release: 0.36 +ha_domain: facebook --- The `facebook` notification platform enables sending notifications via Facebook Messenger, powered by [Facebook](https://facebook.com). @@ -119,20 +119,3 @@ script: title: Blue payload: DEVELOPER_DEFINED_PAYLOAD_FOR_PICKING_BLUE ``` - -You can now also use Facebook public beta broadcast API to push messages to ALL users who interacted with your chatbot on your page, without having to collect their number. This will scale to thousands of users. Facebook requires that this only be used for non-commercial purposes and they validate every message you send. Also note, your Facebook bot needs to be authorized for "page_subscritions" if you want to make it to all but can be used right away to a selected group of testers of your choice. - -To enable broadcast just use the keyword "BROADCAST" as your target. Only put ONE target BROADCAST as below: - -```yaml -- alias: Facebook Broadcast - trigger: - platform: sun - event: sunset - action: - service: notify.facebook - data: - message: Some text you want to send - target: - - BROADCAST -``` diff --git a/source/_integrations/facebox.markdown b/source/_integrations/facebox.markdown index 5c833bc7b44..3e1b57111e7 100644 --- a/source/_integrations/facebox.markdown +++ b/source/_integrations/facebox.markdown @@ -1,10 +1,10 @@ --- title: Facebox description: Detect and recognize faces with Facebox. -logo: machine-box.png ha_category: - Image Processing ha_release: 0.7 +ha_domain: facebox --- The `facebox` image processing platform allows you to detect and recognize faces in a camera image using [Facebox](https://machinebox.io/docs/facebox). The state of the entity is the number of faces detected, and recognized faces are listed in the `matched_faces` attribute. An `image_processing.detect_face` event is fired for each recognized face, and the event `data` provides the `confidence` of recognition, the `name` of the person, the `image_id` of the image associated with the match, the `bounding_box` that contains the face in the image, and the `entity_id` that processing was performed on. diff --git a/source/_integrations/fail2ban.markdown b/source/_integrations/fail2ban.markdown index 62c24f48e4f..a15b7525ee3 100644 --- a/source/_integrations/fail2ban.markdown +++ b/source/_integrations/fail2ban.markdown @@ -4,8 +4,8 @@ description: Instructions on how to integrate a fail2ban sensor into Home Assist ha_category: - Network ha_iot_class: Local Polling -logo: fail2ban.png ha_release: 0.57 +ha_domain: fail2ban --- The `fail2ban` sensor allows for IPs banned by [fail2ban](https://www.fail2ban.org/wiki/index.php/Main_Page) to be displayed in the Home Assistant frontend. diff --git a/source/_integrations/familyhub.markdown b/source/_integrations/familyhub.markdown index 99495110570..c3519fb3995 100644 --- a/source/_integrations/familyhub.markdown +++ b/source/_integrations/familyhub.markdown @@ -1,11 +1,11 @@ --- title: Samsung Family Hub description: Instructions on how to integrate Samsung Family Hub refrigerator cameras within Home Assistant. -logo: familyhub.png ha_category: - Camera ha_release: '0.70' ha_iot_class: Local Polling +ha_domain: familyhub --- The `familyhub` platform allows you to get images of the inside of your [Samsung Family Hub refrigerator](https://www.samsung.com/us/explore/family-hub-refrigerator/connected-hub/) in Home Assistant. diff --git a/source/_integrations/fan.markdown b/source/_integrations/fan.markdown index 9b1bf790465..648ffb98b66 100644 --- a/source/_integrations/fan.markdown +++ b/source/_integrations/fan.markdown @@ -1,11 +1,109 @@ --- title: Fan description: Instructions on how to setup Fan devices within Home Assistant. -logo: home-assistant.png ha_category: - Fan ha_release: 0.27 ha_quality_scale: internal +ha_domain: fan --- -The `fan` integration is built for the controlling of fan devices. +The Fan integration allows you to control and monitor Fan devices. + +## Services + +### Fan control services + +Available services: +`fan.set_speed`, `fan.set_direction`, `fan.oscillate`, `fan.turn_on`, `fan.turn_off`, `fan.toggle` + +
    + +Not all fan services may be available for your platform. Be sure to check the available services Home Assistant has enabled by checking service developer tool icon **Services**. + +
    + +### Service `fan.set_speed` + +Sets the speed for fan device + +| Service data attribute | Optional | Description | +| ---------------------- | -------- | ----------- | +| `entity_id` | yes | String or list of strings that define the entity ID(s) of fan device(s) to control. To target all fan devices, use `all`. +| `speed` | no | Speed setting + +#### Automation example + +```yaml +automation: + trigger: + platform: time + at: "07:15:00" + action: + - service: fan.set_speed + data: + entity_id: fan.kitchen + speed: low +``` + +### Service `fan.set_direction` + +Sets the rotation for fan device + +| Service data attribute | Optional | Description | +| ---------------------- | -------- | ----------- | +| `entity_id` | yes | String or list of strings that define the entity ID(s) of fan device(s) to control. To target all fan devices, use `all`. +| `direction` | no | The direction to rotate. Either `forward` or `reverse` + +#### Automation example + +```yaml +automation: + trigger: + platform: time + at: "07:15:00" + action: + - service: fan.set_direction + data: + entity_id: fan.kitchen + direction: forward +``` + +### Service `fan.oscillate` + +Sets the oscillation for fan device + +| Service data attribute | Optional | Description | +| ---------------------- | -------- | ----------- | +| `entity_id` | yes | String or list of strings that define the entity ID(s) of fan device(s) to control. To target all fan devices, use `all`. +| `oscillating` | no | Flag to turn on/off oscillation. Either `True` or `False`. + +#### Automation example + +```yaml +automation: + trigger: + platform: time + at: "07:15:00" + action: + - service: fan.oscillate + data: + entity_id: fan.kitchen + oscillating: True +``` + +### Service `fan.turn_on` + +Turn fan device on. This is only supported if the fan device supports being turned off. + +| Service data attribute | Optional | Description | +| ---------------------- | -------- | ----------- | +| `entity_id` | yes | String or list of strings that define the entity ID(s) of fan device(s) to control. To target all fan devices, use `all`. + +### Service `fan.turn_off` + +Turn fan device off. This is only supported if the fan device supports being turned on. + +| Service data attribute | Optional | Description | +| ---------------------- | -------- | ----------- | +| `entity_id` | yes | String or list of strings that define the entity ID(s) of fan device(s) to control. To target all fan devices, use `all`. diff --git a/source/_integrations/fan.mqtt.markdown b/source/_integrations/fan.mqtt.markdown index c5af29e3dab..2a12a35a02b 100644 --- a/source/_integrations/fan.mqtt.markdown +++ b/source/_integrations/fan.mqtt.markdown @@ -1,11 +1,11 @@ --- title: "MQTT Fan" description: "Instructions on how to integrate MQTT fans into Home Assistant." -logo: mqtt.png ha_category: - Fan ha_release: 0.27 ha_iot_class: Configurable +ha_domain: mqtt --- The `mqtt` fan platform lets you control your MQTT enabled fans. @@ -28,140 +28,27 @@ fan: ``` {% configuration %} -command_topic: - description: The MQTT topic to publish commands to change the fan state. - required: true - type: string -name: - description: The name of the fan. - required: false - type: string - default: MQTT Fan -state_topic: - description: The MQTT topic subscribed to receive state updates. - required: false - type: string -payload_on: - description: The payload that represents the running state. - required: false - type: string - default: "ON" -payload_off: - description: The payload that represents the stop state. - required: false - type: string - default: "OFF" -state_value_template: - description: "Defines a [template](/docs/configuration/templating/#processing-incoming-data) to extract a value from the state." - required: false - type: string -qos: - description: The maximum QoS level of the state topic. - required: false - type: integer - default: 0 -optimistic: - description: Flag that defines if lock works in optimistic mode - required: false - type: boolean - default: "`true` if no state topic defined, else `false`." -retain: - description: If the published message should have the retain flag on or not. - required: false - type: boolean - default: true -oscillation_state_topic: - description: The MQTT topic subscribed to receive oscillation state updates. - required: false - type: string -oscillation_command_topic: - description: The MQTT topic to publish commands to change the oscillation state. - required: false - type: string -payload_oscillation_on: - description: The payload that represents the oscillation on state. - required: false - type: string - default: oscillate_on -payload_oscillation_off: - description: The payload that represents the oscillation off state. - required: false - type: string - default: oscillate_off -oscillation_value_template: - description: "Defines a [template](/docs/configuration/templating/#processing-incoming-data) to extract a value from the oscillation." - required: false - type: string -speed_state_topic: - description: The MQTT topic subscribed to receive speed state updates. - required: false - type: string -speed_command_topic: - description: The MQTT topic to publish commands to change speed state. - required: false - type: string -payload_low_speed: - description: The payload that represents the fan's low speed. - required: false - type: string - default: low -payload_medium_speed: - description: The payload that represents the fan's medium speed. - required: false - type: string - default: medium -payload_high_speed: - description: The payload that represents the fan's high speed. - required: false - type: string - default: high -speed_value_template: - description: "Defines a [template](/docs/configuration/templating/#processing-incoming-data) to extract a value from the speed payload." - required: false - type: string -speeds: - description: "List of speeds this fan is capable of running at. Valid entries are `off`, `low`, `medium` and `high`." - required: false - type: [string, list] availability_topic: description: The MQTT topic subscribed to receive availability (online/offline) updates. required: false type: string -payload_available: - description: The payload that represents the available state. - required: false - type: string - default: online -payload_not_available: - description: The payload that represents the unavailable state. - required: false - type: string - default: offline -json_attributes_topic: - description: The MQTT topic subscribed to receive a JSON dictionary payload and then set as sensor attributes. Usage example can be found in [MQTT sensor](/integrations/sensor.mqtt/#json-attributes-topic-configuration) documentation. - required: false - type: string -json_attributes_template: - description: "Defines a [template](/docs/configuration/templating/#processing-incoming-data) to extract the JSON dictionary from messages received on the `json_attributes_topic`. Usage example can be found in [MQTT sensor](/integrations/sensor.mqtt/#json-attributes-template-configuration) documentation." - required: false - type: template -unique_id: - description: An ID that uniquely identifies this fan. If two fans have the same unique ID, Home Assistant will raise an exception. - required: false +command_topic: + description: The MQTT topic to publish commands to change the fan state. + required: true type: string device: description: "Information about the device this fan is a part of to tie it into the [device registry](https://developers.home-assistant.io/docs/en/device_registry_index.html). Only works through [MQTT discovery](/docs/mqtt/discovery/) and when [`unique_id`](#unique_id) is set." required: false type: map keys: - identifiers: - description: A list of IDs that uniquely identify the device. For example a serial number. - required: false - type: [string, list] connections: description: 'A list of connections of the device to the outside world as a list of tuples `[connection_type, connection_identifier]`. For example the MAC address of a network interface: `"connections": [["mac", "02:5b:26:a8:dc:12"]]`.' required: false type: [list, map] + identifiers: + description: A list of IDs that uniquely identify the device. For example a serial number. + required: false + type: [string, list] manufacturer: description: The manufacturer of the device. required: false @@ -178,6 +65,119 @@ device: description: The firmware version of the device. required: false type: string +json_attributes_template: + description: "Defines a [template](/docs/configuration/templating/#processing-incoming-data) to extract the JSON dictionary from messages received on the `json_attributes_topic`. Usage example can be found in [MQTT sensor](/integrations/sensor.mqtt/#json-attributes-template-configuration) documentation." + required: false + type: template +json_attributes_topic: + description: The MQTT topic subscribed to receive a JSON dictionary payload and then set as sensor attributes. Usage example can be found in [MQTT sensor](/integrations/sensor.mqtt/#json-attributes-topic-configuration) documentation. + required: false + type: string +name: + description: The name of the fan. + required: false + type: string + default: MQTT Fan +optimistic: + description: Flag that defines if lock works in optimistic mode + required: false + type: boolean + default: "`true` if no state topic defined, else `false`." +oscillation_command_topic: + description: The MQTT topic to publish commands to change the oscillation state. + required: false + type: string +oscillation_state_topic: + description: The MQTT topic subscribed to receive oscillation state updates. + required: false + type: string +oscillation_value_template: + description: "Defines a [template](/docs/configuration/templating/#processing-incoming-data) to extract a value from the oscillation." + required: false + type: string +payload_available: + description: The payload that represents the available state. + required: false + type: string + default: online +payload_high_speed: + description: The payload that represents the fan's high speed. + required: false + type: string + default: high +payload_low_speed: + description: The payload that represents the fan's low speed. + required: false + type: string + default: low +payload_medium_speed: + description: The payload that represents the fan's medium speed. + required: false + type: string + default: medium +payload_not_available: + description: The payload that represents the unavailable state. + required: false + type: string + default: offline +payload_off: + description: The payload that represents the stop state. + required: false + type: string + default: "OFF" +payload_on: + description: The payload that represents the running state. + required: false + type: string + default: "ON" +payload_oscillation_off: + description: The payload that represents the oscillation off state. + required: false + type: string + default: oscillate_off +payload_oscillation_on: + description: The payload that represents the oscillation on state. + required: false + type: string + default: oscillate_on +qos: + description: The maximum QoS level of the state topic. + required: false + type: integer + default: 0 +retain: + description: If the published message should have the retain flag on or not. + required: false + type: boolean + default: true +speed_command_topic: + description: The MQTT topic to publish commands to change speed state. + required: false + type: string +speed_state_topic: + description: The MQTT topic subscribed to receive speed state updates. + required: false + type: string +speed_value_template: + description: "Defines a [template](/docs/configuration/templating/#processing-incoming-data) to extract a value from the speed payload." + required: false + type: string +speeds: + description: "List of speeds this fan is capable of running at. Valid entries are `off`, `low`, `medium` and `high`." + required: false + type: [string, list] +state_topic: + description: The MQTT topic subscribed to receive state updates. + required: false + type: string +state_value_template: + description: "Defines a [template](/docs/configuration/templating/#processing-incoming-data) to extract a value from the state." + required: false + type: string +unique_id: + description: An ID that uniquely identifies this fan. If two fans have the same unique ID, Home Assistant will raise an exception. + required: false + type: string {% endconfiguration %}
    diff --git a/source/_integrations/fan.template.markdown b/source/_integrations/fan.template.markdown index 5f44f08c756..f470d92ddf1 100644 --- a/source/_integrations/fan.template.markdown +++ b/source/_integrations/fan.template.markdown @@ -5,8 +5,8 @@ ha_category: - Fan ha_release: 0.69 ha_iot_class: Local Push -logo: home-assistant.png ha_quality_scale: internal +ha_domain: template --- The `template` platform creates fans that combine integrations and provides the diff --git a/source/_integrations/fan.xiaomi_miio.markdown b/source/_integrations/fan.xiaomi_miio.markdown index e161c5f590d..b5df2b4d9c3 100644 --- a/source/_integrations/fan.xiaomi_miio.markdown +++ b/source/_integrations/fan.xiaomi_miio.markdown @@ -1,11 +1,11 @@ --- title: "Xiaomi Air Purifier" description: "Instructions on how to integrate your Xiaomi Air Purifier and Xiaomi Air Humidifier within Home Assistant." -logo: xiaomi.png ha_category: - Fan ha_iot_class: Local Polling ha_release: 0.57 +ha_domain: xiaomi_miio --- The `xiaomi_miio` fan platform allows you to control the Xiaomi Air Purifier, Air Humidifier and Air Fresh. diff --git a/source/_integrations/fastdotcom.markdown b/source/_integrations/fastdotcom.markdown index cd8553db916..56ccc951117 100644 --- a/source/_integrations/fastdotcom.markdown +++ b/source/_integrations/fastdotcom.markdown @@ -1,7 +1,6 @@ --- title: Fast.com description: How to integrate Fast.com within Home Assistant. -logo: fastdotcom.png ha_category: - System Monitor - Sensor @@ -9,6 +8,7 @@ ha_release: 0.88 ha_iot_class: Cloud Polling ha_codeowners: - '@rohankapoorcom' +ha_domain: fastdotcom --- The `fastdotcom` integration uses the [Fast.com](https://fast.com/) web service to measure network bandwidth performance. diff --git a/source/_integrations/feedreader.markdown b/source/_integrations/feedreader.markdown index 720518012b8..73652257486 100644 --- a/source/_integrations/feedreader.markdown +++ b/source/_integrations/feedreader.markdown @@ -1,10 +1,10 @@ --- title: Feedreader description: Instructions on how to integrate RSS feeds into Home Assistant. -logo: rss.gif ha_category: - Other ha_release: 0.18 +ha_domain: feedreader --- Add an RSS/Atom feed reader that polls feeds every hour and sends new entries into the event bus. diff --git a/source/_integrations/ffmpeg.markdown b/source/_integrations/ffmpeg.markdown index 88f37659faf..a2f69d7165e 100644 --- a/source/_integrations/ffmpeg.markdown +++ b/source/_integrations/ffmpeg.markdown @@ -1,10 +1,10 @@ --- title: FFmpeg description: Instructions on how to integrate FFmpeg within Home Assistant. -logo: ffmpeg.png ha_category: - Image Processing ha_release: 0.29 +ha_domain: ffmpeg --- The `ffmpeg` integration allows other Home Assistant integrations to process video and audio streams. This integration supports all FFmpeg versions since 3.0.0; if you have an older version, please update. diff --git a/source/_integrations/ffmpeg_motion.markdown b/source/_integrations/ffmpeg_motion.markdown index f194adc67e9..7f0b73b699f 100644 --- a/source/_integrations/ffmpeg_motion.markdown +++ b/source/_integrations/ffmpeg_motion.markdown @@ -1,10 +1,10 @@ --- title: FFmpeg Motion description: Instructions on how to integrate an FFmpeg-based motion binary sensor -logo: ffmpeg.png ha_category: - Image Processing ha_release: 0.27 +ha_domain: ffmpeg_motion --- The `ffmpeg` platform allows you to use any video feed with [FFmpeg](https://www.ffmpeg.org/) for motion sensors in Home Assistant. diff --git a/source/_integrations/ffmpeg_noise.markdown b/source/_integrations/ffmpeg_noise.markdown index 4deb6c8c380..1d147dd09d6 100644 --- a/source/_integrations/ffmpeg_noise.markdown +++ b/source/_integrations/ffmpeg_noise.markdown @@ -1,10 +1,10 @@ --- title: FFmpeg Noise description: Instructions on how to integrate an FFmpeg-based noise binary sensor -logo: ffmpeg.png ha_category: - Image Processing ha_release: 0.27 +ha_domain: ffmpeg_noise --- The `ffmpeg` platform allows you to use any video or audio feed with [FFmpeg](https://www.ffmpeg.org/) for various sensors in Home Assistant. diff --git a/source/_integrations/fibaro.markdown b/source/_integrations/fibaro.markdown index 8355fbe63a5..67c8c0503f2 100644 --- a/source/_integrations/fibaro.markdown +++ b/source/_integrations/fibaro.markdown @@ -1,7 +1,6 @@ --- title: Fibaro description: Instructions on how to setup Fibaro Z-Wave hubs (HCL and HC2) and configure devices within Home Assistant. -logo: fibaro.png ha_category: - Hub - Binary Sensor @@ -13,6 +12,7 @@ ha_category: - Switch ha_release: 0.83 ha_iot_class: Local Push +ha_domain: fibaro --- The [Fibaro](https://fibaro.com/) hub is a controller mainly connecting to Z-Wave devices. diff --git a/source/_integrations/fido.markdown b/source/_integrations/fido.markdown index 5b506ed2ffb..b88742852ef 100644 --- a/source/_integrations/fido.markdown +++ b/source/_integrations/fido.markdown @@ -6,6 +6,7 @@ ha_category: - Network ha_release: 0.39 ha_iot_class: Cloud Polling +ha_domain: fido --- Integrate your [Fido](https://www.fido.ca/) account information into Home Assistant. diff --git a/source/_integrations/file.markdown b/source/_integrations/file.markdown index 77d39890408..ee302225f3e 100644 --- a/source/_integrations/file.markdown +++ b/source/_integrations/file.markdown @@ -1,7 +1,6 @@ --- title: File description: Instructions on how to integrate sensors which read from files into Home Assistant. -logo: file.png ha_category: - Utility - Notifications @@ -10,6 +9,7 @@ ha_release: pre 0.7 ha_iot_class: Local Polling ha_codeowners: - '@fabaff' +ha_domain: file --- There is currently support for the following device types within Home Assistant: diff --git a/source/_integrations/filesize.markdown b/source/_integrations/filesize.markdown index bedeb2aaca1..b71079ea6d2 100644 --- a/source/_integrations/filesize.markdown +++ b/source/_integrations/filesize.markdown @@ -1,11 +1,11 @@ --- title: File Size description: Component for monitoring the size of a file. -logo: file.png ha_category: - Utility ha_iot_class: Local Polling ha_release: 0.64 +ha_domain: filesize --- The `filesize` sensor for displaying the size in MB of a file. Note that paths must be added to [whitelist_external_dirs](/docs/configuration/basic/). diff --git a/source/_integrations/filter.markdown b/source/_integrations/filter.markdown index 4d35aa95a52..5838deeecef 100644 --- a/source/_integrations/filter.markdown +++ b/source/_integrations/filter.markdown @@ -5,10 +5,10 @@ ha_category: - Utility ha_release: 0.65 ha_iot_class: Local Push -logo: home-assistant.png ha_quality_scale: internal ha_codeowners: - '@dgomes' +ha_domain: filter --- The `filter` platform enables sensors that process the states of other entities. @@ -46,7 +46,7 @@ sensor: - filter: lowpass time_constant: 10 - filter: time_simple_moving_average - window_size: 00:05 + window_size: "00:05" precision: 2 ``` @@ -71,7 +71,7 @@ filters: required: true type: string window_size: - description: Size of the window of previous states. Time based filters such as `time_simple_moving_average` will require a time period (size in time), while other filters such as `outlier` will require an integer (size in number of states) + description: Size of the window of previous states. Time based filters such as `time_simple_moving_average` will require a time period (size in time), while other filters such as `outlier` will require an integer (size in number of states). Time periods are in _hh:mm_ format and must be quoted. required: false type: [integer, time] default: 1 @@ -150,7 +150,7 @@ This filter is relevant when you have a sensor which produces states at a very h The Time Throttle filter (`time_throttle`) will only update the state of the sensor for the first state in the window. This means the filter will skip all other values. -To adjust the rate you need to set the window_size. To throttle a sensor down to 1 value per minute, the `window_size` should be set to 00:01. +To adjust the rate you need to set the window_size. To throttle a sensor down to 1 value per minute, the `window_size` should be set to "00:01". This filter is relevant when you have a sensor which produces states at a very high inconstant rate, which you might want to throttle down to some constant rate for storing or visualization purposes. @@ -160,7 +160,7 @@ The Time SMA filter (`time_simple_moving_average`) is based on the paper [Algori The paper defines three types/versions of the Simple Moving Average (SMA): *last*, *next* and *linear*. Currently only *last* is implemented. -Theta, as described in the paper, is the `window_size` parameter, and can be expressed using time notation (e.g., 00:05 for a five minutes time window). +Theta, as described in the paper, is the `window_size` parameter, and can be expressed using time notation (e.g., "00:05" for a five minutes time window). ### Range diff --git a/source/_integrations/fints.markdown b/source/_integrations/fints.markdown index b90521aca08..533b908e9fd 100644 --- a/source/_integrations/fints.markdown +++ b/source/_integrations/fints.markdown @@ -5,6 +5,7 @@ ha_category: - Finance ha_release: '0.70' ha_iot_class: Local Push +ha_domain: fints --- With the FinTS sensor, you can fetch your account information from your bank. This only works with banks that support the FinTS (aka. HBCI) standard. The FinTS standard used by many German banks. So if you do not have a German bank account, this will most likely not work for you. To find out if your bank supports FinTS, check the bank's website or call their hotline. diff --git a/source/_integrations/fitbit.markdown b/source/_integrations/fitbit.markdown index db81c98aab0..df110206e1d 100644 --- a/source/_integrations/fitbit.markdown +++ b/source/_integrations/fitbit.markdown @@ -1,13 +1,13 @@ --- title: Fitbit description: Instructions on how to integrate Fitbit devices within Home Assistant. -logo: fitbit.png ha_category: - Health ha_iot_class: Cloud Polling ha_release: 0.19 ha_codeowners: - '@robbiet480' +ha_domain: fitbit --- The Fitbit sensor allows you to expose data from [Fitbit](https://fitbit.com/) to Home Assistant. diff --git a/source/_integrations/fixer.markdown b/source/_integrations/fixer.markdown index 4062ff6c630..2e7f0040ef3 100644 --- a/source/_integrations/fixer.markdown +++ b/source/_integrations/fixer.markdown @@ -3,11 +3,11 @@ title: Fixer description: Instructions on how to integrate exchange rates from Fixer.io within Home Assistant. ha_category: - Finance -logo: fixer-io.png ha_iot_class: Cloud Polling ha_release: 0.23 ha_codeowners: - '@fabaff' +ha_domain: fixer --- The `fixer` sensor will show you the current exchange rate from [Fixer.io](https://fixer.io/) which is using data from the [European Central Bank (ECB)](https://www.ecb.europa.eu). diff --git a/source/_integrations/fleetgo.markdown b/source/_integrations/fleetgo.markdown index a438f74dbc3..8c99dbd45ad 100644 --- a/source/_integrations/fleetgo.markdown +++ b/source/_integrations/fleetgo.markdown @@ -1,11 +1,11 @@ --- title: FleetGO description: Instructions on how to use a FleetGO as a device tracker. -logo: fleetgo.png ha_category: - Car ha_iot_class: Cloud Polling ha_release: 0.76 +ha_domain: fleetgo --- The `fleetgo` device tracker platform allows you to integrate your vehicles equipped with [FleetGO](https://fleetgo.com) hardware into Home Assistant. It allows you to see certain details about your vehicle, but also shows your vehicle on the map. diff --git a/source/_integrations/flexit.markdown b/source/_integrations/flexit.markdown index 38f9184d17b..5ab4f06bfe9 100644 --- a/source/_integrations/flexit.markdown +++ b/source/_integrations/flexit.markdown @@ -6,6 +6,7 @@ ha_category: - Climate ha_release: 0.47 ha_iot_class: Local Polling +ha_domain: flexit --- Integrates [Flexit](https://www.flexit.no/en/) Air Conditioning unit into Home Assistant. diff --git a/source/_integrations/flic.markdown b/source/_integrations/flic.markdown index a7bc8d284d9..b5ceba3b9b8 100644 --- a/source/_integrations/flic.markdown +++ b/source/_integrations/flic.markdown @@ -6,6 +6,7 @@ ha_category: - Binary Sensor ha_iot_class: Local Push ha_release: 0.35 +ha_domain: flic --- The `flic` platform allows you to receive click events from [flic](https://flic.io) smart buttons. diff --git a/source/_integrations/flock.markdown b/source/_integrations/flock.markdown index 129383a277d..aa992fc2b96 100644 --- a/source/_integrations/flock.markdown +++ b/source/_integrations/flock.markdown @@ -7,6 +7,7 @@ ha_category: ha_release: 0.71 ha_codeowners: - '@fabaff' +ha_domain: flock --- The `flock` platform uses [Flock.com](https://flock.com) to deliver notifications from Home Assistant. diff --git a/source/_integrations/flume.markdown b/source/_integrations/flume.markdown index cf5d8aae048..43838b61976 100644 --- a/source/_integrations/flume.markdown +++ b/source/_integrations/flume.markdown @@ -1,13 +1,13 @@ --- title: flume description: Documentation about the flume sensor. -logo: flume.jpg ha_category: - Sensor ha_iot_class: Cloud Polling ha_release: 0.103 ha_codeowners: - '@ChrisMandich' +ha_domain: flume --- The `flume` sensor will show you the current [flume](https://portal.flumetech.com/) status for the given Device ID. diff --git a/source/_integrations/flunearyou.markdown b/source/_integrations/flunearyou.markdown index f3b2ab49a17..53e3a023e37 100644 --- a/source/_integrations/flunearyou.markdown +++ b/source/_integrations/flunearyou.markdown @@ -8,6 +8,7 @@ ha_release: 0.83 ha_iot_class: Cloud Polling ha_codeowners: - '@bachya' +ha_domain: flunearyou --- The `flunearyou` sensor platform allows users in the United States and its diff --git a/source/_integrations/flux.markdown b/source/_integrations/flux.markdown index 4605a6ad82b..c6bcb3f9050 100644 --- a/source/_integrations/flux.markdown +++ b/source/_integrations/flux.markdown @@ -4,8 +4,8 @@ description: Instructions on how to have switches call command line commands. ha_category: - Automation ha_release: 0.21 -logo: home-assistant.png ha_quality_scale: internal +ha_domain: flux --- The `flux` switch platform will change the temperature of your lights similar to the way flux works on your computer, using circadian rhythm. They will be bright during the day, and gradually fade to a red/orange at night. The `flux` switch restores its last state after startup. diff --git a/source/_integrations/flux_led.markdown b/source/_integrations/flux_led.markdown index 0f633d44383..7581247ef43 100644 --- a/source/_integrations/flux_led.markdown +++ b/source/_integrations/flux_led.markdown @@ -6,6 +6,7 @@ ha_category: - Light ha_iot_class: Local Polling ha_release: 0.25 +ha_domain: flux_led --- The `flux_led` support is integrated into Home Assistant as a light platform. Several brands of both bulbs and controllers use the same protocol and they have the HF-LPB100 chipset in common. The chances are high that your bulb or controller (eg. WiFi LED CONTROLLER) will work if you can control the device with the MagicHome app. diff --git a/source/_integrations/folder.markdown b/source/_integrations/folder.markdown index 20336e6cb83..775a93eee22 100644 --- a/source/_integrations/folder.markdown +++ b/source/_integrations/folder.markdown @@ -1,11 +1,11 @@ --- title: Folder description: Sensor for monitoring the contents of a folder. -logo: file.png ha_category: - Utility ha_iot_class: Local Polling ha_release: 0.64 +ha_domain: folder --- Sensor for monitoring the contents of a folder. Note that folder paths must be added to [whitelist_external_dirs](/docs/configuration/basic/). Optionally a [wildcard filter](https://docs.python.org/3.6/library/fnmatch.html) can be applied to the files considered within the folder. The state of the sensor is the size in MB of files within the folder that meet the filter criteria. diff --git a/source/_integrations/folder_watcher.markdown b/source/_integrations/folder_watcher.markdown index c6637397c1c..f13154692c9 100644 --- a/source/_integrations/folder_watcher.markdown +++ b/source/_integrations/folder_watcher.markdown @@ -1,12 +1,12 @@ --- title: Folder Watcher description: Component for monitoring changes within the filesystem. -logo: home-assistant.png ha_category: - System Monitor ha_iot_class: Local Polling ha_release: 0.67 ha_quality_scale: internal +ha_domain: folder_watcher --- This integration adds [Watchdog](https://pythonhosted.org/watchdog/) file system monitoring, publishing events on the Home Assistant bus on the creation/deletion/modification of files within configured folders. The monitored `event_type` are: diff --git a/source/_integrations/foobot.markdown b/source/_integrations/foobot.markdown index 4fc9a3d4cf6..dae6feb0176 100644 --- a/source/_integrations/foobot.markdown +++ b/source/_integrations/foobot.markdown @@ -1,11 +1,11 @@ --- title: Foobot description: Instructions on how to setup Foobot Air Quality sensor in Home Assistant. -logo: foobot.png ha_category: - Health ha_release: 0.66 ha_iot_class: Cloud Polling +ha_domain: foobot --- The `foobot` sensor platform will fetch air quality data from your or yours [Foobot device(s)](https://foobot.io/features/). diff --git a/source/_integrations/fortigate.markdown b/source/_integrations/fortigate.markdown index 541fcfca958..6a5028fcb9c 100644 --- a/source/_integrations/fortigate.markdown +++ b/source/_integrations/fortigate.markdown @@ -1,13 +1,13 @@ --- title: FortiGate description: Instructions on how to integrate FortiGate Firewalls into Home Assistant. -logo: fortinet.jpg ha_category: - Presence Detection ha_release: 0.97 ha_iot_class: Local Polling ha_codeowners: - '@kifeo' +ha_domain: fortigate --- This is a FortiGate presence sensor based on device detection of the FortiGate API diff --git a/source/_integrations/fortios.markdown b/source/_integrations/fortios.markdown index 1245ef9047c..91f5c413915 100644 --- a/source/_integrations/fortios.markdown +++ b/source/_integrations/fortios.markdown @@ -1,13 +1,13 @@ --- title: Home Assistant Device Tracker to support FortiOS description: Instructions on how to use Fortinet FortiOS to track devices in Home Assistant. -logo: fortinet.jpg ha_category: - Presence Detection ha_release: 0.97 ha_iot_class: Local Polling ha_codeowners: - '@kimfrellsen' +ha_domain: fortios --- This integration enables Home Assistant to do device tracking of devices with a MAC address connected to a FortiGate from [Fortinet](https://www.fortinet.com). diff --git a/source/_integrations/foscam.markdown b/source/_integrations/foscam.markdown index 3805bba44f0..4e677baf85c 100644 --- a/source/_integrations/foscam.markdown +++ b/source/_integrations/foscam.markdown @@ -8,6 +8,7 @@ ha_iot_class: Local Polling ha_release: 0.7.3 ha_codeowners: - '@skgsergio' +ha_domain: foscam --- The `foscam` platform allows you to watch the live stream of your [Foscam](https://www.foscam.com) IP camera in Home Assistant. diff --git a/source/_integrations/foursquare.markdown b/source/_integrations/foursquare.markdown index d2cac644af9..1e4c50b2bc9 100644 --- a/source/_integrations/foursquare.markdown +++ b/source/_integrations/foursquare.markdown @@ -8,6 +8,7 @@ ha_release: 0.26 ha_iot_class: Cloud Polling and Cloud Push ha_codeowners: - '@robbiet480' +ha_domain: foursquare --- The `foursquare` integration accepts pushes from the Foursquare [Real-Time API](https://developer.foursquare.com/overview/realtime) and a service to check users in on Swarm. diff --git a/source/_integrations/free_mobile.markdown b/source/_integrations/free_mobile.markdown index eacaecd716c..4cc588007b9 100644 --- a/source/_integrations/free_mobile.markdown +++ b/source/_integrations/free_mobile.markdown @@ -5,6 +5,7 @@ logo: free_mobile.png ha_category: - Notifications ha_release: 0.11 +ha_domain: free_mobile --- The `free_mobile` platform is using the French mobile operator [Free Mobile](http://mobile.free.fr/) to send SMS to your own cell phone. diff --git a/source/_integrations/freebox.markdown b/source/_integrations/freebox.markdown index bc7b137a7de..226b9ea1e19 100644 --- a/source/_integrations/freebox.markdown +++ b/source/_integrations/freebox.markdown @@ -1,7 +1,6 @@ --- title: Freebox description: Instructions on how to integrate Freebox routers into Home Assistant. -logo: freebox.svg ha_category: - Network - Presence Detection @@ -11,6 +10,7 @@ ha_release: 0.85 ha_iot_class: Local Polling ha_codeowners: - '@snoof85' +ha_domain: freebox --- The `freebox` integration allows you to observe and control [Freebox router](https://www.free.fr/). diff --git a/source/_integrations/freedns.markdown b/source/_integrations/freedns.markdown index 902634fdda8..7e03d2edcb0 100644 --- a/source/_integrations/freedns.markdown +++ b/source/_integrations/freedns.markdown @@ -1,10 +1,10 @@ --- title: FreeDNS description: Keep your DNS record up to date with FreeDNS. -logo: afraid_freedns.png ha_category: - Network ha_release: 0.67 +ha_domain: freedns --- With the `freedns` integration you can keep your [FreeDNS](https://freedns.afraid.org) record up to date. diff --git a/source/_integrations/fritz.markdown b/source/_integrations/fritz.markdown index 498fd8212ff..19741dfe9b6 100644 --- a/source/_integrations/fritz.markdown +++ b/source/_integrations/fritz.markdown @@ -1,10 +1,10 @@ --- title: AVM FRITZ!Box description: Instructions on how to integrate AVM FRITZ!Box based routers into Home Assistant. -logo: avm.png ha_category: - Presence Detection ha_release: '0.10' +ha_domain: fritz --- The `fritz` platform offers presence detection by looking at connected devices to a [AVM FRITZ!Box](https://avm.de/produkte/fritzbox/) based router. diff --git a/source/_integrations/fritzbox.markdown b/source/_integrations/fritzbox.markdown index 25a6fbef9ea..5bb8cb5cb33 100644 --- a/source/_integrations/fritzbox.markdown +++ b/source/_integrations/fritzbox.markdown @@ -1,7 +1,6 @@ --- title: AVM FRITZ!Box description: Instructions on how to integrate the AVM Fritzbox Smart Home components. -logo: avm.png ha_category: - Binary Sensor - Climate @@ -9,6 +8,7 @@ ha_category: - Switch ha_release: 0.68 ha_iot_class: Local Polling +ha_domain: fritzbox --- The [AVM](https://en.avm.de) FRITZ!Box integration for Home Assistant allows you to integrate the switch and climate devices. @@ -24,6 +24,7 @@ There is currently support for the following device types within Home Assistant: - [FRITZ!Box 6490 Cable](https://en.avm.de/products/fritzbox/fritzbox-6490-cable/) - [FRITZ!Box 7590](https://en.avm.de/products/fritzbox/fritzbox-7590/) +- [FRITZ!Box 7490](https://en.avm.de/products/fritzbox/fritzbox-7490/) - [FRITZ!Box 7430](https://en.avm.de/products/fritzbox/fritzbox-7430/) - [FRITZ!DECT 200](https://en.avm.de/products/fritzdect/fritzdect-200/) - [FRITZ!DECT 301](https://en.avm.de/products/fritzdect/fritzdect-301/) @@ -84,7 +85,7 @@ There are several attributes that can be useful for automations and templates. ## Sensor -To get AVM FRITZ!Box temperature sensor (e.g. FRITZ!DECT Repeater 100) follow the instructions for the [FRITZ!Box integration](#setup). +To get AVM FRITZ!Box temperature sensor (e.g., FRITZ!DECT Repeater 100) follow the instructions for the [FRITZ!Box integration](#setup). ### Attributes diff --git a/source/_integrations/fritzbox_callmonitor.markdown b/source/_integrations/fritzbox_callmonitor.markdown index 4e1881cad3c..ebb5dea0ed3 100644 --- a/source/_integrations/fritzbox_callmonitor.markdown +++ b/source/_integrations/fritzbox_callmonitor.markdown @@ -1,11 +1,11 @@ --- title: AVM FRITZ!Box Call Monitor description: Instructions on how to integrate a phone call monitor for AVM FRITZ!Box routers into Home Assistant. -logo: avm.png ha_category: - System Monitor ha_release: 0.27 ha_iot_class: Local Polling +ha_domain: fritzbox_callmonitor --- The `fritzbox_callmonitor` sensor monitors the call monitor exposed by [AVM FRITZ!Box](https://avm.de/produkte/fritzbox/) routers on TCP port 1012. It will assume the values `idle`, `ringing`, `dialing` or `talking` with the phone numbers involved contained in the state attributes. diff --git a/source/_integrations/fritzbox_netmonitor.markdown b/source/_integrations/fritzbox_netmonitor.markdown index 0730c20afb5..5eb68db473b 100644 --- a/source/_integrations/fritzbox_netmonitor.markdown +++ b/source/_integrations/fritzbox_netmonitor.markdown @@ -1,11 +1,11 @@ --- title: AVM FRITZ!Box Net Monitor description: Instructions on how to integrate an AVM FRITZ!Box monitor into Home Assistant. -logo: avm.png ha_category: - System Monitor ha_release: 0.36 ha_iot_class: Local Polling +ha_domain: fritzbox_netmonitor --- The `fritzbox_netmonitor` sensor monitors the network statistics exposed by [AVM FRITZ!Box](https://avm.de/produkte/fritzbox/) routers. diff --git a/source/_integrations/fronius.markdown b/source/_integrations/fronius.markdown index d4e0ff7f2c3..63cd737d46d 100644 --- a/source/_integrations/fronius.markdown +++ b/source/_integrations/fronius.markdown @@ -4,11 +4,11 @@ description: Instructions on how to connect your Fronius Inverter to Home Assist ha_category: - Energy - Sensor -logo: fronius.png ha_iot_class: Local Polling ha_release: 0.96 ha_codeowners: - '@nielstron' +ha_domain: fronius --- The `fronius` sensor polls a [Fronius](https://www.fronius.com/) solar inverter, battery system or smart meter and present the values as sensors in Home Assistant. diff --git a/source/_integrations/frontend.markdown b/source/_integrations/frontend.markdown index 8cd22f36c63..41bf06b7e27 100644 --- a/source/_integrations/frontend.markdown +++ b/source/_integrations/frontend.markdown @@ -1,13 +1,13 @@ --- title: Home Assistant Frontend description: Offers a frontend to Home Assistant. -logo: home-assistant.png ha_category: - Other ha_release: 0.7 ha_quality_scale: internal ha_codeowners: - '@home-assistant/frontend' +ha_domain: frontend --- This offers the official frontend to control Home Assistant. This integration is by default enabled, unless you've disabled or removed the [`default_config:`](https://www.home-assistant.io/integrations/default_config/) line from your configuration. If that is the case, the following example shows you how to enable this integration manually: diff --git a/source/_integrations/frontier_silicon.markdown b/source/_integrations/frontier_silicon.markdown index 4a1ec98a9cd..89b1b30ff66 100644 --- a/source/_integrations/frontier_silicon.markdown +++ b/source/_integrations/frontier_silicon.markdown @@ -1,11 +1,11 @@ --- title: Frontier Silicon description: Instructions on how to integrate Frontier Silicon Internet Radios into Home Assistant. -logo: frontier.png ha_category: - Media Player ha_iot_class: Local Push ha_release: '0.40' +ha_domain: frontier_silicon --- This integration provides support for Internet Radios based on the [Frontier Silicon chipset]. Some of the manufacturers which offer products based on these chips include: Hama, Medion, Slivercrest, Auna, Technisat, Revo, Pinnel, etc. These devices will be usually controlled by the [UNDOK] app. @@ -49,6 +49,11 @@ password: required: false default: 1234 type: string +name: + description: Friendly name of the Internet Radio. If present this will override the friendly name reported by the radio itself. + required: false + default: empty + type: string {% endconfiguration %} Some models use a separate port (2244) for API access, this can be verified by visiting http://[host]:[port]/device. diff --git a/source/_integrations/futurenow.markdown b/source/_integrations/futurenow.markdown index d7f11f41c58..ed726961d70 100644 --- a/source/_integrations/futurenow.markdown +++ b/source/_integrations/futurenow.markdown @@ -5,6 +5,7 @@ logo: p5.png ha_category: - Light ha_release: 0.75 +ha_domain: futurenow --- The `futurenow` light platform allows you to use [P5](https://www.p5.hu/) FutureNow relay/dimmer units as lights. Currently supported units: diff --git a/source/_integrations/garadget.markdown b/source/_integrations/garadget.markdown index a6330b6056b..ad1d3a4ed21 100644 --- a/source/_integrations/garadget.markdown +++ b/source/_integrations/garadget.markdown @@ -6,6 +6,7 @@ ha_category: - Cover ha_release: 0.32 ha_iot_class: Cloud Polling +ha_domain: garadget --- The `garadget` cover platform lets you control [Garadget](https://www.garadget.com/) garage door futurizers through Home Assistant. diff --git a/source/_integrations/garmin_connect.markdown b/source/_integrations/garmin_connect.markdown index 3b76f5f5456..efa7f6692ba 100644 --- a/source/_integrations/garmin_connect.markdown +++ b/source/_integrations/garmin_connect.markdown @@ -9,6 +9,7 @@ ha_release: 0.105 ha_codeowners: - '@cyberjunky' ha_config_flow: true +ha_domain: garmin_connect --- The Garmin Connect sensor allows you to expose data from [Garmin Connect](https://connect.garmin.com) to Home Assistant. diff --git a/source/_integrations/gc100.markdown b/source/_integrations/gc100.markdown index 83197d0ed1c..79a5648b719 100644 --- a/source/_integrations/gc100.markdown +++ b/source/_integrations/gc100.markdown @@ -7,7 +7,7 @@ ha_category: - Switch ha_release: 0.57 ha_iot_class: Local Polling -logo: global-cache.png +ha_domain: gc100 --- The Global Caché [GC-100](https://www.globalcache.com/products/gc-100/) can be integrated into Home Assistant. GC-100 is a TCP-controllable diff --git a/source/_integrations/gdacs.markdown b/source/_integrations/gdacs.markdown index 40157ff0727..bcc229c229a 100644 --- a/source/_integrations/gdacs.markdown +++ b/source/_integrations/gdacs.markdown @@ -10,6 +10,7 @@ ha_config_flow: true ha_quality_scale: platinum ha_codeowners: - '@exxamalte' +ha_domain: gdacs --- The `gdacs` integration lets you use a GeoRSS feed provided by @@ -134,3 +135,7 @@ gdacs: latitude: -41.2 longitude: 174.7 ``` + +## Locations NOT supported: + +- Ireland diff --git a/source/_integrations/gearbest.markdown b/source/_integrations/gearbest.markdown index 40fdafb0274..2cf6ab80b06 100644 --- a/source/_integrations/gearbest.markdown +++ b/source/_integrations/gearbest.markdown @@ -8,6 +8,7 @@ ha_iot_class: Cloud Polling ha_release: '0.60' ha_codeowners: - '@HerrHofrat' +ha_domain: gearbest --- The `gearbest` sensor will track the price of a product from [Gearbest](https://www.gearbest.com). This information can be used in, e.g., automations to notify you when a price drops. The update interval for every item is currently set to 2 hours. diff --git a/source/_integrations/geizhals.markdown b/source/_integrations/geizhals.markdown index c6856f655bf..fd725ccbf52 100644 --- a/source/_integrations/geizhals.markdown +++ b/source/_integrations/geizhals.markdown @@ -6,6 +6,7 @@ ha_category: - Sensor ha_iot_class: Cloud Polling ha_release: 0.51 +ha_domain: geizhals --- The `geizhals` sensor will give you the best price of a product from [Geizhals](https://geizhals.de) or related site. With this information can be used in e.g., automations to notify you when a price drops. diff --git a/source/_integrations/generic_ip_camera.markdown b/source/_integrations/generic_ip_camera.markdown index e003c60f8df..7491b90b5dd 100644 --- a/source/_integrations/generic_ip_camera.markdown +++ b/source/_integrations/generic_ip_camera.markdown @@ -6,6 +6,7 @@ ha_category: logo: home-assistant.png ha_release: pre 0.7 ha_iot_class: Configurable +ha_domain: camera --- The `generic` camera platform allows you to integrate any IP camera or other URL into Home Assistant. Templates can be used to generate the URLs on the fly. diff --git a/source/_integrations/generic_thermostat.markdown b/source/_integrations/generic_thermostat.markdown index 0a560fb39e3..c1f46672399 100644 --- a/source/_integrations/generic_thermostat.markdown +++ b/source/_integrations/generic_thermostat.markdown @@ -1,11 +1,11 @@ --- title: Generic Thermostat description: Turn Home Assistant into a thermostat -logo: home-assistant.png ha_category: - Climate ha_release: pre 0.7 ha_iot_class: Local Polling +ha_domain: generic_thermostat --- The `generic_thermostat` climate platform is a thermostat implemented in Home Assistant. It uses a sensor and a switch connected to a heater or air conditioning under the hood. When in heater mode, if the measured temperature is cooler than the target temperature, the heater will be turned on and turned off when the required temperature is reached. When in air conditioning mode, if the measured temperature is hotter than the target temperature, the air conditioning will be turned on and turned off when required temperature is reached. One Generic Thermostat entity can only control one switch. If you need to activate two switches, one for a heater and one for an air conditioner, you will need two Generic Thermostat entities. diff --git a/source/_integrations/geniushub.markdown b/source/_integrations/geniushub.markdown index b9da60c0041..e78b867e086 100644 --- a/source/_integrations/geniushub.markdown +++ b/source/_integrations/geniushub.markdown @@ -12,6 +12,7 @@ ha_release: 0.92 ha_iot_class: Local Polling ha_codeowners: - '@zxdavb' +ha_domain: geniushub --- The `geniushub` integration links Home Assistant with your Genius Hub CH/DHW system, including its zones, devices, and issues. @@ -30,17 +31,17 @@ Each zone controlled by your Genius Hub will be exposed as either a: Currently, there is no support for altering zone schedules, although entities can be switched to/from geniushub modes that utilize schedules. -There are limitations due to the differences between the Genius Hub and Home Assistant schemas (e.g. HA has no **Footprint** mode) - use the service handlers, below, for this functionality. +There are limitations due to the differences between the Genius Hub and Home Assistant schemas (e.g., HA has no **Footprint** mode) - use the service handlers, below, for this functionality. ### Service Handlers -Home Assistant is obligated to place restrictions upon integrations such as **geniushub** to maintain compatibility with other ecosystems (e.g. Google Home) and so not all of the **geniushub** functionality is available via the web UI. Some of this missing functionality is exposed via integration-specific service handlers: +Home Assistant is obligated to place restrictions upon integrations such as **geniushub** to maintain compatibility with other ecosystems (e.g., Google Home) and so not all of the **geniushub** functionality is available via the web UI. Some of this missing functionality is exposed via integration-specific service handlers: - `set_zone_override`: change the zone's setpoint _for a specified duration_ (up to 24h), and - `set_zone_mode`: change the zone's mode to one of `off`, `timer` or (if supported by the zone) `footprint` ### Climate and Water Heater Entities -Climate and Water Heater entities will report their current temperature, setpoint and mode; other properties (e.g. occupied state) are available via their state attributes (see examples below). The Genius Hub mode will be reported as/set to: +Climate and Water Heater entities will report their current temperature, setpoint and mode; other properties (e.g., occupied state) are available via their state attributes (see examples below). The Genius Hub mode will be reported as/set to: GH mode | HA Operation | HA Preset :---: | :---: | :---: @@ -55,7 +56,7 @@ GH mode | HA Operation | HA Preset Switch entities will report back their state; other properties are available via their state attributes. Currently, HA switches do not have modes/presets, so the Home Assistant `state` will be *reported* as: - `On` for **Override** \ **On**, and -- `Off` otherwise (NB: the zone could still be 'on', e.g. with **Timer** mode) +- `Off` otherwise (NB: the zone could still be 'on', e.g., with **Timer** mode) Note: if you turn a Switch entity `Off` via Home Assistant's web UI, it will revert to **Timer** mode - this may not be the behavior you are expecting. diff --git a/source/_integrations/geo_json_events.markdown b/source/_integrations/geo_json_events.markdown index d738f3cedc9..b4530d73327 100644 --- a/source/_integrations/geo_json_events.markdown +++ b/source/_integrations/geo_json_events.markdown @@ -6,6 +6,7 @@ ha_category: - Geolocation ha_iot_class: Cloud Polling ha_release: 0.79 +ha_domain: geo_json_events --- The `geo_json_events` platform lets you integrate GeoJSON feeds. It retrieves events from a feed and shows information of those events filtered by distance to Home Assistant's location. diff --git a/source/_integrations/geo_location.markdown b/source/_integrations/geo_location.markdown index 81ae7364baf..ce76eeb3a67 100644 --- a/source/_integrations/geo_location.markdown +++ b/source/_integrations/geo_location.markdown @@ -3,6 +3,7 @@ title: Geolocation description: Instructions on how to integrate geolocation aware platforms into Home Assistant. logo: geo_location.png ha_release: 0.78 +ha_domain: geo_location --- 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. diff --git a/source/_integrations/geo_rss_events.markdown b/source/_integrations/geo_rss_events.markdown index 2c6e5af74a0..fabb67fa044 100644 --- a/source/_integrations/geo_rss_events.markdown +++ b/source/_integrations/geo_rss_events.markdown @@ -1,13 +1,13 @@ --- title: GeoRSS description: Instructions on how to set up GeoRSS sensors within Home Assistant. -logo: rss.png ha_category: - Sensor ha_iot_class: Cloud Polling ha_release: 0.55 ha_codeowners: - '@exxamalte' +ha_domain: geo_rss_events --- The `geo_rss_events` sensor retrieves events from a GeoRSS feed and shows information of those events filtered by distance to Home Assistant's location and grouped by category. diff --git a/source/_integrations/geofency.markdown b/source/_integrations/geofency.markdown index 01f4202f243..594d9173e84 100644 --- a/source/_integrations/geofency.markdown +++ b/source/_integrations/geofency.markdown @@ -1,12 +1,12 @@ --- title: Geofency description: Instructions for how to use Geofency to track devices in Home Assistant. -logo: geofency.png ha_category: - Presence Detection ha_release: 0.53 ha_iot_class: Cloud Push ha_config_flow: true +ha_domain: geofency --- This integration sets up integration with [Geofency](https://www.geofency.com/). Geofency is a paid app for iOS that lets users to configure a request that will be sent when a geofence or iBeacon region is entered or exited. This can be configured with Home Assistant to update your location. diff --git a/source/_integrations/geonetnz_quakes.markdown b/source/_integrations/geonetnz_quakes.markdown index 2e8a7e156cd..bee62f90641 100644 --- a/source/_integrations/geonetnz_quakes.markdown +++ b/source/_integrations/geonetnz_quakes.markdown @@ -7,8 +7,10 @@ ha_category: ha_iot_class: Cloud Polling ha_release: 0.98 ha_config_flow: true +ha_quality_scale: platinum ha_codeowners: - '@exxamalte' +ha_domain: geonetnz_quakes --- The `geonetnz_quakes` integration lets you use a GeoJSON feed provided by @@ -25,7 +27,7 @@ on the default map automatically, or on a map card by defining the source converted to the unit (kilometers or miles) configured in Home Assistant.

    - +

    The data is updated every 5 minutes. @@ -110,7 +112,7 @@ some useful attributes that indicate the currentness of the data retrieved from the feed.

    - +

    | Attribute | Description | diff --git a/source/_integrations/geonetnz_volcano.markdown b/source/_integrations/geonetnz_volcano.markdown index 3dfe4b2cddc..5d04d7495e3 100644 --- a/source/_integrations/geonetnz_volcano.markdown +++ b/source/_integrations/geonetnz_volcano.markdown @@ -9,6 +9,7 @@ ha_release: 0.103 ha_config_flow: true ha_codeowners: - '@exxamalte' +ha_domain: geonetnz_volcano --- The `geonetnz_volcano` integration lets you use a GeoJSON feed provided by @@ -91,7 +92,7 @@ the standard ones: ```yaml # Example configuration.yaml entry -geonetnz_quakes: +geonetnz_volcano: radius: 100 latitude: -41.2 longitude: 174.7 diff --git a/source/_integrations/gios.markdown b/source/_integrations/gios.markdown index 26237d8cff9..520804be758 100644 --- a/source/_integrations/gios.markdown +++ b/source/_integrations/gios.markdown @@ -1,7 +1,6 @@ --- title: GIOŚ description: Instructions on how to integrate GIOŚ (Polish Chief Inspectorate Of Environmental Protection) air quality service into Home Assistant. -logo: gios.png ha_category: - Health ha_release: 0.104 @@ -9,6 +8,7 @@ ha_iot_class: Cloud Polling ha_config_flow: true ha_codeowners: - '@bieniu' +ha_domain: gios --- The `gios` integration uses the [GIOŚ](http://powietrze.gios.gov.pl/pjp/current) web service as a source for air quality data for your location. diff --git a/source/_integrations/github.markdown b/source/_integrations/github.markdown index 22b40b1d3a8..8c383d3baac 100644 --- a/source/_integrations/github.markdown +++ b/source/_integrations/github.markdown @@ -6,6 +6,7 @@ ha_category: - Sensor ha_release: 0.88 ha_iot_class: Cloud Polling +ha_domain: github --- The GitHub sensor integrates data from [GitHub](https://github.com/) to monitor your favorite repositories. @@ -24,7 +25,7 @@ sensor: - platform: github access_token: !secret github_access_token repositories: - - path: 'home-assistant/home-assistant' + - path: 'home-assistant/core' ``` {% configuration %} @@ -42,7 +43,7 @@ repositories: type: list keys: path: - description: Path to the repository. For Home Assistant this will be `home-assistant/home-assistant` + description: Path to the repository. For Home Assistant this will be `home-assistant/core` required: true type: string name: diff --git a/source/_integrations/gitlab_ci.markdown b/source/_integrations/gitlab_ci.markdown index 7a9ee6ffd86..81c87e1861f 100644 --- a/source/_integrations/gitlab_ci.markdown +++ b/source/_integrations/gitlab_ci.markdown @@ -1,11 +1,11 @@ --- title: GitLab-CI description: How to integrate GitLab-CI Job status within Home Assistant. -logo: gitlab.png ha_category: - Sensor ha_release: 0.8 ha_iot_class: Cloud Polling +ha_domain: gitlab_ci --- The `gitlab_ci` sensor platform integrates results reported by CI/CD Pipeline Jobs in [GitLab](https://gitlab.com/). diff --git a/source/_integrations/gitter.markdown b/source/_integrations/gitter.markdown index 442f56a7874..714aa4035ac 100644 --- a/source/_integrations/gitter.markdown +++ b/source/_integrations/gitter.markdown @@ -7,6 +7,7 @@ ha_category: ha_release: 0.47 ha_codeowners: - '@fabaff' +ha_domain: gitter --- This `gitter` sensor allows one to monitor a [Gitter.im](https://gitter.im) chatroom for unread messages. diff --git a/source/_integrations/glances.markdown b/source/_integrations/glances.markdown index a91cca13c2d..0c3fe3d9727 100644 --- a/source/_integrations/glances.markdown +++ b/source/_integrations/glances.markdown @@ -1,7 +1,6 @@ --- title: Glances description: Instructions on how to integrate Glances sensors into Home Assistant. -logo: glances.png ha_category: - System Monitor ha_iot_class: Local Polling @@ -10,6 +9,7 @@ ha_config_flow: true ha_codeowners: - '@fabaff' - '@engrbm87' +ha_domain: glances --- The `glances` integration allows you to monitor the system information provided by the [Glances](https://github.com/nicolargo/glances) API. This enables one to track remote host and display their stats in Home Assistant. diff --git a/source/_integrations/gntp.markdown b/source/_integrations/gntp.markdown index 7ea76d6ed64..88191c028c1 100644 --- a/source/_integrations/gntp.markdown +++ b/source/_integrations/gntp.markdown @@ -1,12 +1,12 @@ --- title: Growl (GnGNTP) description: Instructions for adding GNTP/Growl notifications to Home Assistant. -logo: gntp.png ha_category: - Notifications ha_release: 0.16 ha_codeowners: - '@robbiet480' +ha_domain: gntp --- [GNTP](http://growl.info/documentation/developer/gntp.php) is a specification for sending and receiving notifications between computers. The most well known server implementations are [Growl](http://growl.info) for Mac and [Growl for Windows](http://www.growlforwindows.com/). diff --git a/source/_integrations/goalfeed.markdown b/source/_integrations/goalfeed.markdown index 2fa13e1ec73..43c19f889b2 100644 --- a/source/_integrations/goalfeed.markdown +++ b/source/_integrations/goalfeed.markdown @@ -5,6 +5,7 @@ logo: goalfeed.png ha_category: - Other ha_release: 0.63 +ha_domain: goalfeed --- The `goalfeed` integration lets you use your Goalfeed account to trigger events in Home Assistant whenever a NHL or MLB team scores. @@ -42,8 +43,8 @@ Now you can use the goal event type in your automations: Goal events have the following event data: -- **team**: Three letter code representing the team. This is unique within the leagues, but not unique across the leagues (i.e. 'WPG' or 'TOR'). -- **team_name**: The team that scored (i.e. 'Winnipeg Jets' or 'Toronto Blue Jays'). +- **team**: Three letter code representing the team. This is unique within the leagues, but not unique across the leagues (i.e., 'WPG' or 'TOR'). +- **team_name**: The team that scored (i.e., 'Winnipeg Jets' or 'Toronto Blue Jays'). - **team_hash**: A unique hash for the team (you can find these values on https://goalfeed.ca/get-teams). - **league_id**: A unique number for the league. -- **league_name**: A the short name of the league (i.e. 'NHL' or 'MLB'). +- **league_name**: A the short name of the league (i.e., 'NHL' or 'MLB'). diff --git a/source/_integrations/gogogate2.markdown b/source/_integrations/gogogate2.markdown index 6f8a8d9a663..c5dc645db8e 100644 --- a/source/_integrations/gogogate2.markdown +++ b/source/_integrations/gogogate2.markdown @@ -6,6 +6,7 @@ ha_category: - Cover ha_release: 0.67 ha_iot_class: Local Polling +ha_domain: gogogate2 --- The `gogogate2` cover platform lets you control Gogogate2-Enabled garage doors through Home Assistant. Device names in Home Assistant are generated based on the names defined in your Gogogate2 mobile app. diff --git a/source/_integrations/google_assistant.markdown b/source/_integrations/google_assistant.markdown index d198836a78f..689d6de6b3a 100644 --- a/source/_integrations/google_assistant.markdown +++ b/source/_integrations/google_assistant.markdown @@ -1,13 +1,13 @@ --- title: Google Assistant description: Setup for Google Assistant integration -logo: google-assistant.png ha_category: - Voice featured: true ha_release: 0.56 ha_codeowners: - '@home-assistant/cloud' +ha_domain: google_assistant --- The `google_assistant` integration allows you to control things via Google Assistant on your mobile, tablet or Google Home device. @@ -185,7 +185,7 @@ Currently, the following domains are available to be used with Google Assistant, - switch (on/off) - fan (on/off/speed) - light (on/off/brightness/rgb color/color temp) -- lock (lock/unlock (to allow assistant to unlock, set the `allow_unlock` key in configuration)) +- lock - cover (on/off/set position) - media_player (on/off/set volume (via set volume)/source (via set input source)) - climate (temperature setting, hvac_mode) diff --git a/source/_integrations/google_cloud.markdown b/source/_integrations/google_cloud.markdown index 84cab1a9a1b..da8dadfe234 100644 --- a/source/_integrations/google_cloud.markdown +++ b/source/_integrations/google_cloud.markdown @@ -1,11 +1,11 @@ --- title: Google Cloud Platform description: Google Cloud Platform integration. -logo: google_cloud.png ha_category: Text-to-speech ha_release: 0.95 ha_codeowners: - '@lufton' +ha_domain: google_cloud --- The `google_cloud` platform allows you to use [Google Cloud Platform](https://cloud.google.com/) API and integrate them into Home Assistant. @@ -74,17 +74,17 @@ key_file: required: false type: string language: - description: "Default language of the voice, e.g. `en-US`. Supported languages, genders and voices listed [here](https://cloud.google.com/text-to-speech/docs/voices). Also there are extra not documented but supported languages (see dropdown [here](https://cloud.google.com/text-to-speech/#streaming_demo_section))." + description: "Default language of the voice, e.g., `en-US`. Supported languages, genders and voices listed [here](https://cloud.google.com/text-to-speech/docs/voices). Also there are extra not documented but supported languages (see dropdown [here](https://cloud.google.com/text-to-speech/#streaming_demo_section))." required: false type: string default: en-US gender: - description: "Default gender of the voice, e.g. `male`. Supported languages, genders and voices listed [here](https://cloud.google.com/text-to-speech/docs/voices)." + description: "Default gender of the voice, e.g., `male`. Supported languages, genders and voices listed [here](https://cloud.google.com/text-to-speech/docs/voices)." required: false type: string default: neutral voice: - description: "Default voice name, e.g. `en-US-Wavenet-F`. Supported languages, genders and voices listed [here](https://cloud.google.com/text-to-speech/docs/voices). **Important! This parameter will override `language` and `gender` parameters if set**." + description: "Default voice name, e.g., `en-US-Wavenet-F`. Supported languages, genders and voices listed [here](https://cloud.google.com/text-to-speech/docs/voices). **Important! This parameter will override `language` and `gender` parameters if set**." required: false type: string encoding: diff --git a/source/_integrations/google_domains.markdown b/source/_integrations/google_domains.markdown index a324f39c275..34d2e7bc35b 100644 --- a/source/_integrations/google_domains.markdown +++ b/source/_integrations/google_domains.markdown @@ -1,10 +1,10 @@ --- title: Google Domains description: Keep your computer registered with the Google Domains dynamic DNS. -logo: google_domains.png ha_category: - Network ha_release: 0.57 +ha_domain: google_domains --- With the Google Domains integration you can keep your Google Domains record up to date. diff --git a/source/_integrations/google_maps.markdown b/source/_integrations/google_maps.markdown index 51a1a770227..702159ae932 100644 --- a/source/_integrations/google_maps.markdown +++ b/source/_integrations/google_maps.markdown @@ -1,11 +1,11 @@ --- title: Google Maps description: Instructions how to use Google Maps Location Sharing to track devices in Home Assistant. -logo: google_maps.png ha_release: 0.67 ha_category: - Presence Detection ha_iot_class: Cloud Polling +ha_domain: google_maps --- The `google_maps` platform allows you to detect presence using the unofficial API of [Google Maps Location Sharing](https://myaccount.google.com/locationsharing). diff --git a/source/_integrations/google_pubsub.markdown b/source/_integrations/google_pubsub.markdown index 02556f0e999..5dd29729d84 100644 --- a/source/_integrations/google_pubsub.markdown +++ b/source/_integrations/google_pubsub.markdown @@ -1,10 +1,10 @@ --- title: Google Pub/Sub description: Setup for Google Pub/Sub integration -logo: google-pubsub.png ha_category: - History ha_release: 0.88 +ha_domain: google_pubsub --- The `google_pubsub` integration allows you to hook into the Home Assistant event bus and send events to [Google Cloud Pub/Sub](https://cloud.google.com/pubsub/docs/overview). The current [free tier](https://cloud.google.com/free/) of GCP should allow you to sync about 1 event every 2 seconds on average (2 million invocations per month). diff --git a/source/_integrations/google_translate.markdown b/source/_integrations/google_translate.markdown index aef6a211386..eade1d2951a 100644 --- a/source/_integrations/google_translate.markdown +++ b/source/_integrations/google_translate.markdown @@ -1,12 +1,12 @@ --- title: Google Translate Text-to-Speech description: Instructions on how to setup Google Translate Text-to-Speech with Home Assistant. -logo: google.png ha_category: - Text-to-speech ha_release: 0.35 ha_codeowners: - '@awarecan' +ha_domain: google_translate --- The `google_translate` text-to-speech platform uses the unofficial [Google Translate Text-to-Speech engine](https://translate.google.com/) to read a text with natural sounding voices. diff --git a/source/_integrations/google_travel_time.markdown b/source/_integrations/google_travel_time.markdown index 92f3f1dcce0..d12dfc8a675 100644 --- a/source/_integrations/google_travel_time.markdown +++ b/source/_integrations/google_travel_time.markdown @@ -1,13 +1,13 @@ --- title: Google Maps Travel Time description: Instructions on how to add Google Maps travel time to Home Assistant. -logo: google_maps.png ha_category: - Transport ha_iot_class: Cloud Polling ha_release: 0.19 ha_codeowners: - '@robbiet480' +ha_domain: google_travel_time --- The `google_travel_time` sensor provides travel time from the [Google Distance Matrix API](https://developers.google.com/maps/documentation/distance-matrix/). diff --git a/source/_integrations/google_wifi.markdown b/source/_integrations/google_wifi.markdown index 4022bf335b8..de70816021a 100644 --- a/source/_integrations/google_wifi.markdown +++ b/source/_integrations/google_wifi.markdown @@ -3,9 +3,9 @@ title: Google Wifi description: Instructions on how to integrate Google Wifi/OnHub routers into Home Assistant. ha_category: - System Monitor -logo: google_wifi.png ha_iot_class: Local Polling ha_release: '0.50' +ha_domain: google_wifi --- The `google_wifi` sensor platform is displaying the exposed status of a [Google Wifi](https://madeby.google.com/wifi/) (or OnHub) router. diff --git a/source/_integrations/gpmdp.markdown b/source/_integrations/gpmdp.markdown index 39f3064097c..cba4da858be 100644 --- a/source/_integrations/gpmdp.markdown +++ b/source/_integrations/gpmdp.markdown @@ -1,11 +1,11 @@ --- title: Google Play Music Desktop Player (GPMDP) description: Instructions on how to integrate GPMDP into Home Assistant. -logo: gpmdp.png ha_category: - Media Player ha_iot_class: Local Polling ha_release: '0.20' +ha_domain: gpmdp --- The `gpmdp` media player platform allows you to control a [GPMDP](https://www.googleplaymusicdesktopplayer.com/) instance running on a computer from Home Assistant. diff --git a/source/_integrations/gpsd.markdown b/source/_integrations/gpsd.markdown index f319131c95c..0b685920e37 100644 --- a/source/_integrations/gpsd.markdown +++ b/source/_integrations/gpsd.markdown @@ -1,13 +1,13 @@ --- title: GPSD description: Instructions on how to integrate GPSD into Home Assistant. -logo: gpsd.png ha_category: - Utility ha_release: 0.26 ha_iot_class: Local Polling ha_codeowners: - '@fabaff' +ha_domain: gpsd --- The `gpsd` integration is using the GPS information collected by [gpsd](http://catb.org/gpsd/) and a GPS receiver. diff --git a/source/_integrations/gpslogger.markdown b/source/_integrations/gpslogger.markdown index 6c3e9681c4d..a9e756e3bde 100644 --- a/source/_integrations/gpslogger.markdown +++ b/source/_integrations/gpslogger.markdown @@ -1,12 +1,12 @@ --- title: GPSLogger description: Instructions on how to use GPSLogger to track devices in Home Assistant. -logo: gpslogger.png ha_category: - Presence Detection ha_release: 0.34 ha_iot_class: Cloud Push ha_config_flow: true +ha_domain: gpslogger --- This integration sets up integration with [GPSLogger](https://gpslogger.app/). GPSLogger is an open source app for Android that allows users to update your location in Home Assistant. diff --git a/source/_integrations/graphite.markdown b/source/_integrations/graphite.markdown index e49ccf14c0b..2ba430893f6 100644 --- a/source/_integrations/graphite.markdown +++ b/source/_integrations/graphite.markdown @@ -5,6 +5,7 @@ logo: graphite.png ha_category: - History ha_release: 0.13 +ha_domain: graphite --- The `graphite` integration records all events and state changes and feeds the data to a [graphite](http://graphite.wikidot.com/) instance. diff --git a/source/_integrations/greeneye_monitor.markdown b/source/_integrations/greeneye_monitor.markdown index 6ae7309f4ca..14fccfa3ed0 100644 --- a/source/_integrations/greeneye_monitor.markdown +++ b/source/_integrations/greeneye_monitor.markdown @@ -9,6 +9,7 @@ ha_release: 0.82 ha_iot_class: Local Push ha_codeowners: - '@jkeljo' +ha_domain: greeneye_monitor --- The [GreenEye Monitor (GEM)](https://www.brultech.com/greeneye/) integration for Home Assistant allows you to create sensors for the various data channels of the GEM. Each current transformer (CT) channel, pulse counter, and temperature sensor appears in Home Assistant as a sensor, and can be used in automations. diff --git a/source/_integrations/greenwave.markdown b/source/_integrations/greenwave.markdown index 066c8ade251..c4aed6eee57 100644 --- a/source/_integrations/greenwave.markdown +++ b/source/_integrations/greenwave.markdown @@ -6,6 +6,7 @@ ha_category: - Light ha_release: 0.61 ha_iot_class: Local Polling +ha_domain: greenwave --- This integration communicates with the Greenwave Reality (TCP Connected) Gateway to allow control of all lights and fixtures registered to the gateway. Bulbs and Fixtures can be created and modified inside the TCP Lighting App for Android and iOS. diff --git a/source/_integrations/group.markdown b/source/_integrations/group.markdown index 0b4ffbaf6de..1c26b598ef5 100644 --- a/source/_integrations/group.markdown +++ b/source/_integrations/group.markdown @@ -1,13 +1,13 @@ --- title: Group description: Instructions on how to setup groups within Home Assistant. -logo: home-assistant.png ha_category: - Organization ha_release: pre 0.7 ha_quality_scale: internal ha_codeowners: - '@home-assistant/core' +ha_domain: group --- Groups allow the user to combine multiple entities into one. diff --git a/source/_integrations/growatt_server.markdown b/source/_integrations/growatt_server.markdown index dbd701cb16e..eb11a162375 100644 --- a/source/_integrations/growatt_server.markdown +++ b/source/_integrations/growatt_server.markdown @@ -9,6 +9,7 @@ ha_release: 0.99 ha_iot_class: Cloud Polling ha_codeowners: - '@indykoning' +ha_domain: growatt_server --- This is a sensor to collect information from your Growatt inverters using [Growatt server](https://server.growatt.com/). diff --git a/source/_integrations/gstreamer.markdown b/source/_integrations/gstreamer.markdown index 6d8e66ed87d..fe212313f4f 100644 --- a/source/_integrations/gstreamer.markdown +++ b/source/_integrations/gstreamer.markdown @@ -6,6 +6,7 @@ ha_category: logo: gstreamer.png ha_release: 0.39 ha_iot_class: Local Push +ha_domain: gstreamer --- The `gstreamer` platform allows you to play audio via a [gstreamer](https://gstreamer.freedesktop.org/) pipeline. Practically, this means you can play audio directly on the computer running Home Assistant. It is particularly suited for playing TTS. Advanced users can specify a pipeline to transform the audio stream and/or redirect it elsewhere. diff --git a/source/_integrations/gtfs.markdown b/source/_integrations/gtfs.markdown index 6380f8a16c7..a2cf143ed1b 100644 --- a/source/_integrations/gtfs.markdown +++ b/source/_integrations/gtfs.markdown @@ -1,13 +1,13 @@ --- title: General Transit Feed Specification (GTFS) description: Instructions on how to use public transit open data in Home Assistant. -logo: train.png ha_category: - Transport ha_iot_class: Local Polling ha_release: 0.17 ha_codeowners: - '@robbiet480' +ha_domain: gtfs --- The `gtfs` sensor will give you the next departure time and associated data from your public transit station/stop. The data comes from your chosen public transit authority and is formatted as [General Transit Feed Specification](https://developers.google.com/transit/gtfs/) data, commonly known as GTFS. @@ -20,7 +20,7 @@ Here are some examples: - [Metropolitan Transit Authority of New York City (MTA)](http://web.mta.info/developers/) - Provides separate data feeds for subway, bus, LIRR and Metro-North of the greater New York City metropolitan region. - [Official Timetable Switzerland](https://opentransportdata.swiss/en/dataset/timetable-2019-gtfs) - The official timetable data for Switzerland in 2019. -You need to download a GTFS ZIP file and put it into a folder named `gtfs` in your configuration directory. For ease of use, it is suggested that you rename the file to just the agency/data source name (i.e. `bart.zip` instead of `google_transit_20160328_v1.zip`). You can also unzip and place a folder in the `gtfs` folder. +You need to download a GTFS ZIP file and put it into a folder named `gtfs` in your configuration directory. For ease of use, it is suggested that you rename the file to just the agency/data source name (i.e., `bart.zip` instead of `google_transit_20160328_v1.zip`). You can also unzip and place a folder in the `gtfs` folder. The data will be converted into a queryable format and saved as a SQLite3 database alongside the source data. The sensor will check for the existence of this SQLite3 data at every startup and will re-import the ZIP/Folder if none is found. diff --git a/source/_integrations/habitica.markdown b/source/_integrations/habitica.markdown index 33872616eb7..bc5e2bd939b 100644 --- a/source/_integrations/habitica.markdown +++ b/source/_integrations/habitica.markdown @@ -1,12 +1,12 @@ --- title: Habitica description: Instructions on enabling Habitica support for your Home Assistant -logo: habitica.png ha_category: - Hub - Sensor ha_release: 0.78 ha_iot_class: Cloud Polling +ha_domain: habitica --- This integration allows you to monitor and manage your Habitica profile. This integration exposes the [Habitica's API](https://habitica.com/apidoc/) as a Home Assistant service. It supports multiple users and allows you to automate checking out your habits and daily tasks or casting magics using Home Assistant. @@ -73,7 +73,7 @@ A successful call to this service will fire an event `habitica_api_call_success` |----------------------|--------|----------------| | `name` | string | Copied from service data attribute. | | `path` | [string] | Copied from service data attribute. | -| `data` | map | Deserialized `data` field of JSON object Habitica's server returned in response to API call. For more info see [docs](https://habitica.com/apidoc/). | +| `data` | map | Deserialized `data` field of JSON object Habitica's server returned in response to API call. For more info see the [API documentation](https://habitica.com/apidoc/). | #### Let's consider some examples on how to call the service. @@ -87,7 +87,7 @@ So let's call the API on `habitica.api_call`. * Remove `https://habitica.com/api/v3/` at the beginning of the endpoint URL. * Split the remaining on slashes (/) and **append the lowercase method** at the end. * You should get `["tasks", "user", "post"]`. To get a better idea of the API you are recommended to try all of the API calls in IPython console [using this package](https://github.com/ASMfreaK/habitipy/blob/master/README.md). -* The `args` key is more or less described in the [docs](https://habitica.com/apidoc/). +* The `args` key is more or less described in the [API documentation](https://habitica.com/apidoc/). Combining all together: call `habitica.api_call` with data diff --git a/source/_integrations/hangouts.markdown b/source/_integrations/hangouts.markdown index bf30af1c565..5cbba174394 100644 --- a/source/_integrations/hangouts.markdown +++ b/source/_integrations/hangouts.markdown @@ -1,12 +1,12 @@ --- title: Google Hangouts description: Hangouts chatbot support -logo: hangouts.png ha_category: - Hub - Notifications ha_release: 0.77 ha_config_flow: true +ha_domain: hangouts --- This integration allows you to send messages to [Google Hangouts](https://hangouts.google.com) conversations, as well as to react to messages in conversations. Reacting to commands is accomplished by firing an event when one of the configured commands is triggered. Home Assistant will impersonate a Smartisan YQ603 phone which will then show up in your Google devices. diff --git a/source/_integrations/harman_kardon_avr.markdown b/source/_integrations/harman_kardon_avr.markdown index db484f5d9b7..e91244d1eb6 100644 --- a/source/_integrations/harman_kardon_avr.markdown +++ b/source/_integrations/harman_kardon_avr.markdown @@ -6,6 +6,7 @@ ha_category: - Media Player ha_iot_class: Local Polling ha_release: 0.85 +ha_domain: harman_kardon_avr --- The `harman_kardon_avr` platform allows you to control Harman Kardon Network Receivers from Home Assistant. diff --git a/source/_integrations/harmony.markdown b/source/_integrations/harmony.markdown index ad542976fd4..bf442ed432d 100644 --- a/source/_integrations/harmony.markdown +++ b/source/_integrations/harmony.markdown @@ -8,6 +8,7 @@ ha_iot_class: Local Push ha_release: 0.34 ha_codeowners: - '@ehendrix23' +ha_domain: harmony --- The `harmony` remote platform allows you to control the state of your [Harmony Hub Device](https://www.logitech.com/en-us/product/harmony-hub). diff --git a/source/_integrations/haveibeenpwned.markdown b/source/_integrations/haveibeenpwned.markdown index dde84e46006..2acd832aa6f 100644 --- a/source/_integrations/haveibeenpwned.markdown +++ b/source/_integrations/haveibeenpwned.markdown @@ -6,6 +6,7 @@ ha_category: - Sensor ha_release: 0.31 ha_iot_class: Cloud Polling +ha_domain: haveibeenpwned --- The `haveibeenpwned` sensor platform creates sensors that check for breached email accounts on [haveibeenpwned](https://haveibeenpwned.com). diff --git a/source/_integrations/hddtemp.markdown b/source/_integrations/hddtemp.markdown index 64227fa4070..822dda182d6 100644 --- a/source/_integrations/hddtemp.markdown +++ b/source/_integrations/hddtemp.markdown @@ -5,6 +5,7 @@ ha_category: - System Monitor ha_release: 0.32 ha_iot_class: Local Polling +ha_domain: hddtemp --- The `hddtemp` sensor platform is using the data provided by [HDDTemp](https://savannah.nongnu.org/projects/hddtemp). diff --git a/source/_integrations/hdmi_cec.markdown b/source/_integrations/hdmi_cec.markdown index 274597e58ee..df453447f18 100644 --- a/source/_integrations/hdmi_cec.markdown +++ b/source/_integrations/hdmi_cec.markdown @@ -6,6 +6,7 @@ ha_category: logo: hdmi.png ha_release: 0.23 ha_iot_class: Local Push +ha_domain: hdmi_cec --- The `hdmi_cec` integration provides services that allow selecting the active device, powering on all devices, setting all devices to standby and creates switch entities for HDMI devices. Devices are defined in the configuration file by associating HDMI port number and a device name. Connected devices that provide further HDMI ports, such as sound-bars and AVRs are also supported. Devices are listed from the perspective of the CEC-enabled Home Assistant device. Any connected device can be listed, regardless of whether it supports CEC. Ideally the HDMI port number on your device will map correctly the CEC physical address. If it does not, use `cec-client` (part of the `libcec` package) to listen to traffic on the CEC bus and discover the correct numbers. diff --git a/source/_integrations/heatmiser.markdown b/source/_integrations/heatmiser.markdown index be9600c0a93..fc470f45732 100644 --- a/source/_integrations/heatmiser.markdown +++ b/source/_integrations/heatmiser.markdown @@ -8,6 +8,7 @@ ha_release: '0.10' ha_iot_class: Local Polling ha_codeowners: - '@andylockran' +ha_domain: heatmiser --- The `heatmiser` climate platform let you control [Heatmiser DT/DT-E/PRT/PRT-E](https://www.heatmisershop.co.uk/room-thermostats/) thermostats from Heatmiser. The module itself is currently setup to work over a RS232 -> RS485 converter, therefore it connects over IP. diff --git a/source/_integrations/heos.markdown b/source/_integrations/heos.markdown index b57169a25fb..3c9b67b8227 100644 --- a/source/_integrations/heos.markdown +++ b/source/_integrations/heos.markdown @@ -9,6 +9,7 @@ ha_iot_class: Local Push ha_config_flow: true ha_codeowners: - '@andrewsayre' +ha_domain: heos --- The HEOS integration adds support for [HEOS](http://heosbydenon.denon.com) capable products, such as speakers, amps, and receivers (Denon and Marantz) into Home Assistant. Features currently include: @@ -80,7 +81,7 @@ You can play a HEOS favorite by number or name with the `media_player.play_media | ---------------------- | ---------------------------------------------------------| | `entity_id` | `entity_id` of the player | `media_content_type` | Set to the value `favorite` -| `media_content_id` | The nubmer (i.e. `1`) or name (i.e. `Thumbprint Radio`) of the HEOS favorite +| `media_content_id` | The nubmer (i.e., `1`) or name (i.e., `Thumbprint Radio`) of the HEOS favorite #### Play Playlist @@ -116,7 +117,7 @@ You can play a HEOS Quick Select by nubmer or name with the `media_player.play_m | ---------------------- | ---------------------------------------------------------| | `entity_id` | `entity_id` of the player | `media_content_type` | Set to the value `quick_select` -| `media_content_id` | The quick select number (i.e. `1`) or name (i.e. `Quick Select 1`) +| `media_content_id` | The quick select number (i.e., `1`) or name (i.e., `Quick Select 1`) #### Play URL diff --git a/source/_integrations/here_travel_time.markdown b/source/_integrations/here_travel_time.markdown index 1a5face1fd8..a9c3576a26f 100644 --- a/source/_integrations/here_travel_time.markdown +++ b/source/_integrations/here_travel_time.markdown @@ -1,7 +1,6 @@ --- title: HERE Travel Time description: Instructions on how to add HERE travel time to Home Assistant. -logo: HERE_logo.svg ha_category: - Transport - Sensor @@ -9,6 +8,7 @@ ha_iot_class: Cloud Polling ha_release: '0.100' ha_codeowners: - '@eifinger' +ha_domain: here_travel_time --- The `here_travel_time` sensor provides travel time from the [HERE Routing API](https://developer.here.com/documentation/routing/topics/introduction.html). diff --git a/source/_integrations/hikvision.markdown b/source/_integrations/hikvision.markdown index d8b4eb3571c..21834e4cdc0 100644 --- a/source/_integrations/hikvision.markdown +++ b/source/_integrations/hikvision.markdown @@ -1,13 +1,13 @@ --- title: Hikvision description: Instructions on how to set up Hikvision camera binary sensors within Home Assistant. -logo: hikvision.png ha_category: - Binary Sensor ha_release: 0.35 ha_iot_class: Local Push ha_codeowners: - '@mezz64' +ha_domain: hikvision --- The Hikvision Binary Sensor is a platform that parses the event stream of a diff --git a/source/_integrations/hikvisioncam.markdown b/source/_integrations/hikvisioncam.markdown index 996f7850fd5..c2f26809332 100644 --- a/source/_integrations/hikvisioncam.markdown +++ b/source/_integrations/hikvisioncam.markdown @@ -7,6 +7,7 @@ ha_category: ha_release: pre 0.7 ha_codeowners: - '@fbradyirl' +ha_domain: hikvisioncam --- This `hikvisioncam` switch platform allows you to control your motion detection setting on your [Hikvision](https://www.hikvision.com/) camera. diff --git a/source/_integrations/hisense_aehw4a1.markdown b/source/_integrations/hisense_aehw4a1.markdown index 9fa484ca2d8..637870c4f48 100644 --- a/source/_integrations/hisense_aehw4a1.markdown +++ b/source/_integrations/hisense_aehw4a1.markdown @@ -9,6 +9,7 @@ ha_iot_class: Local Poll ha_config_flow: true ha_codeowners: - '@bannhead' +ha_domain: hisense_aehw4a1 --- The Hisense AEH-W4A1 is a Wi-Fi module used to give Wi-Fi connectivity to some Hisense ACs and rebranded models (Smart Cool, Beko and others). diff --git a/source/_integrations/history.markdown b/source/_integrations/history.markdown index 4153c68c9b2..21f1914161b 100644 --- a/source/_integrations/history.markdown +++ b/source/_integrations/history.markdown @@ -1,13 +1,13 @@ --- title: History description: Instructions on how to enable history support for Home Assistant. -logo: home-assistant.png ha_category: - History ha_release: pre 0.7 ha_quality_scale: internal ha_codeowners: - '@home-assistant/core' +ha_domain: history --- The `history` integration will track everything that is going on within Home @@ -71,7 +71,7 @@ Without any `include` or `exclude` configuration the history displays graphs for Define domains and entities to `exclude` (aka. blacklist). This is convenient when you are basically happy with the information displayed, but just want to remove some entities or domains. Usually these are entities/domains which do not -change (like `weblink`) or rarely change (like `updater` or `automation`). +change or rarely change (like `updater` or `automation`). ```yaml # Example configuration.yaml entry with exclude @@ -79,7 +79,6 @@ history: exclude: domains: - automation - - weblink - updater entities: - sensor.last_boot diff --git a/source/_integrations/history_graph.markdown b/source/_integrations/history_graph.markdown deleted file mode 100644 index 211ce8ca2c8..00000000000 --- a/source/_integrations/history_graph.markdown +++ /dev/null @@ -1,78 +0,0 @@ ---- -title: History Graph -description: Instructions for setting up History Graph. -ha_category: - - History -logo: home-assistant.png -ha_release: 0.55 -ha_quality_scale: internal -ha_codeowners: - - '@andrey-git' ---- - -
    - This integration is deprecated and pending removal in Home Assistant 0.107.0, - as it was only used by the old states UI (not our current Lovelace UI). -
    - -

    - -

    - -The `history_graph` integration will make the UI display a graph similar to the graphs in `more-info` popups and the [history](/integrations/history/) panel. If you want to add history graphs to the Lovelace UI, please check the [History Graph Card](/lovelace/history-graph/) configuration as it slightly differs from the component. - -To use this integration in your installation, add the following to your `configuration.yaml` file: - -```yaml -# Minimal configuration.yaml entry -history_graph: - gr1: - entities: - - light.ceiling.lights - -``` - -{% configuration %} -entities: - description: List of entities whose history to show as a graph. - required: true - type: string -name: - description: Name to display. - required: false - default: ID - type: string -hours_to_show: - description: Number of hours to show in the graph. - required: false - default: 24 - type: integer -refresh: - description: Number of seconds between graph refreshes. 0 to disable refreshing. - required: false - default: 0 - type: integer -{% endconfiguration %} - -### Full Example - -```yaml -# Full configuration.yaml entry -history_graph: - gr1: - name: Lights Graph - entities: - - light.ceiling.lights - - light.bed_light - hours_to_show: 240 - refresh: 60 - gr2: - name: Temperature - entities: - - sensor.outside_temperature - - sensor.inside_temperature - hours_to_show: 120 - # refresh: 0 -``` - -For sensors to automatically be combined into one graph they need to have exactly the same unit of measurement. This is important if you have, e.g., a unit-less temperature `state_topic` MQTT sensor and you want to combine this with a weather sensor. `unit_of_measurement:` of the MQTT sensor then needs to be set to `°C`. diff --git a/source/_integrations/history_stats.markdown b/source/_integrations/history_stats.markdown index c73139fe1e9..303efde7fa3 100644 --- a/source/_integrations/history_stats.markdown +++ b/source/_integrations/history_stats.markdown @@ -1,12 +1,12 @@ --- title: History Stats description: Instructions about how to integrate historical statistics into Home Assistant. -logo: home-assistant.png ha_category: - Utility ha_iot_class: Local Polling ha_release: 0.39 ha_quality_scale: internal +ha_domain: history_stats --- The `history_stats` sensor platform provides quick statistics about another integration or platforms, using data from the [history](/integrations/history/). @@ -32,7 +32,7 @@ sensor: entity_id: light.my_lamp state: 'on' type: time - start: '{{ now().replace(hour=0).replace(minute=0).replace(second=0) }}' + start: '{{ now().replace(hour=0, minute=0, second=0) }}' end: '{{ now() }}' ``` {% endraw %} @@ -131,7 +131,7 @@ Here are some examples of periods you could work with, and what to write in your {% raw %} ```yaml - start: '{{ now().replace(hour=0).replace(minute=0).replace(second=0) }}' + start: '{{ now().replace(hour=0, minute=0, second=0) }}' end: '{{ now() }}' ``` {% endraw %} @@ -140,7 +140,7 @@ Here are some examples of periods you could work with, and what to write in your {% raw %} ```yaml - end: '{{ now().replace(hour=0).replace(minute=0).replace(second=0) }}' + end: '{{ now().replace(hour=0, minute=0, second=0) }}' duration: hours: 24 ``` @@ -150,7 +150,7 @@ Here are some examples of periods you could work with, and what to write in your {% raw %} ```yaml - start: '{{ now().replace(hour=6).replace(minute=0).replace(second=0) }}' + start: '{{ now().replace(hour=6, minute=0, second=0) }}' duration: hours: 5 ``` @@ -162,7 +162,7 @@ Here, last Monday is _today_ as a timestamp, minus 86400 times the current weekd {% raw %} ```yaml - start: '{{ as_timestamp( now().replace(hour=0).replace(minute=0).replace(second=0) ) - now().weekday() * 86400 }}' + start: '{{ as_timestamp( now().replace(hour=0, minute=0, second=0) ) - now().weekday() * 86400 }}' end: '{{ now() }}' ``` {% endraw %} @@ -171,7 +171,7 @@ Here, last Monday is _today_ as a timestamp, minus 86400 times the current weekd {% raw %} ```yaml - end: '{{ now().replace(hour=0).replace(minute=0).replace(second=0) }}' + end: '{{ now().replace(hour=0, minute=0, second=0) }}' duration: days: 30 ``` diff --git a/source/_integrations/hitron_coda.markdown b/source/_integrations/hitron_coda.markdown index 6a095817ffa..82176f5956c 100644 --- a/source/_integrations/hitron_coda.markdown +++ b/source/_integrations/hitron_coda.markdown @@ -5,6 +5,7 @@ logo: hitron.png ha_category: - Presence Detection ha_release: 0.58 +ha_domain: hitron_coda --- This integration offers presence detection by examining devices connected to a [Rogers Hitron CODA](https://www.rogers.com/customer/support/article/wi-fi-password-hitron-coda4582-cgn3amr-cgnm3552-cgn3acr-cgn3) diff --git a/source/_integrations/hive.markdown b/source/_integrations/hive.markdown index 70d97ea25ae..3efe2f9862a 100644 --- a/source/_integrations/hive.markdown +++ b/source/_integrations/hive.markdown @@ -1,7 +1,6 @@ --- title: Hive description: Instructions on how to integrate Hive devices with Home Assistant. -logo: hive.png ha_category: - Hub - Binary Sensor @@ -15,6 +14,7 @@ ha_iot_class: Cloud Polling ha_codeowners: - '@Rendili' - '@KJonline' +ha_domain: hive --- The `hive` integration is the main integration to set up and integrate all supported Hive devices. Once configured with the minimum required details it will detect and add all Hive devices into Home Assistant, including support for multi-zone heating. @@ -59,7 +59,7 @@ scan_interval: ### Service `hive.boost_heating` -You can use the service `hive.boost_heating` to set your heating to boost for a period of time at a certain target temperature". +You can use the service `hive.boost_heating` to set your heating to boost for a period of time at a certain target temperature". Individual TRVs can also be boosted in the same way, using this service. | Service data attribute | Optional | Description | | ---------------------- | -------- | ---------------------------------------------------------------------- | diff --git a/source/_integrations/hlk_sw16.markdown b/source/_integrations/hlk_sw16.markdown index 73026c01fc2..991132ee980 100644 --- a/source/_integrations/hlk_sw16.markdown +++ b/source/_integrations/hlk_sw16.markdown @@ -7,6 +7,7 @@ ha_category: - Switch ha_release: 0.84 ha_iot_class: Local Push +ha_domain: hlk_sw16 --- The [HLK-SW16](http://www.hlktech.net/product_detail.php?ProId=48) by [Hi-Link](http://www.hlktech.net/) is a simple networkable 16 port relay device. diff --git a/source/_integrations/homeassistant.markdown b/source/_integrations/homeassistant.markdown index f094458fbe3..94fe5ba02a0 100644 --- a/source/_integrations/homeassistant.markdown +++ b/source/_integrations/homeassistant.markdown @@ -1,11 +1,11 @@ --- title: Home Assistant Core Integration description: Description of the homeassistant integration. -logo: home-assistant.png ha_release: 0.0 ha_quality_scale: internal ha_codeowners: - '@home-assistant/core' +ha_domain: homeassistant --- The Home Assistant integration provides generic implementations like the generic `homeassistant.turn_on`. diff --git a/source/_integrations/homekit.markdown b/source/_integrations/homekit.markdown index 371c9ff7342..a8c726e4e25 100644 --- a/source/_integrations/homekit.markdown +++ b/source/_integrations/homekit.markdown @@ -4,7 +4,7 @@ description: Instructions on how to set up the HomeKit integration in Home Assis ha_category: - Voice ha_release: 0.64 -logo: apple-homekit.png +ha_domain: homekit --- The `homekit` integration allows you to forward entities from Home Assistant to Apple HomeKit, so they can be controlled from Apple's Home app and Siri. Please make sure that you have read the [considerations](#considerations) listed below to save you some trouble later. However if you do encounter issues, check out the [troubleshooting](#troubleshooting) section. diff --git a/source/_integrations/homekit_controller.markdown b/source/_integrations/homekit_controller.markdown index fb37e982d77..203969b0b1d 100644 --- a/source/_integrations/homekit_controller.markdown +++ b/source/_integrations/homekit_controller.markdown @@ -1,7 +1,6 @@ --- title: HomeKit Controller description: Instructions for how to integrate your HomeKit devices within Home Assistant. -logo: apple-homekit.png ha_category: - Hub - Alarm @@ -15,10 +14,11 @@ ha_category: - Fan - Health ha_release: 0.68 -ha_iot_class: Local Polling +ha_iot_class: Local Push ha_config_flow: true ha_codeowners: - '@Jc2k' +ha_domain: homekit_controller --- The [HomeKit](https://developer.apple.com/homekit/) controller integration allows you to connect accessories with the "Works with HomeKit" logo to Home Assistant. This integration should not be confused with the [HomeKit](/integrations/homekit/) integration, which allows you to control Home Assistant devices via HomeKit. @@ -37,7 +37,7 @@ There is currently support for the following device types within Home Assistant: - Light (HomeKit lights) - Lock (HomeKit lock) - Switch (HomeKit switches) -- Binary Sensor (HomeKit motion, contact and smoke sensors) +- Binary Sensor (HomeKit motion, contact, occupancy and smoke sensors) - Sensor (HomeKit humidity, temperature, co2 and light level sensors) - Fan - Air Quality @@ -47,6 +47,8 @@ HomeKit IP accessories for these device types may work with some caveats: - If the device is Wi-Fi based and has no physical controls or screen then you may need an Apple HomeKit device like an iPhone or iPad to get the accessory onto your Wi-Fi network. For example, for a Koogeek LS1 you must add the accessory to HomeKit on your iOS device, then remove it from the iOS device. This leaves the LS1 in an unpaired state but still on your Wi-Fi. Home Assistant can then find it and pair with it. - You need to know the HomeKit PIN. There is no way to recover this if you do not have it. In this case, you will need to contact the manufacturer to see what options you have. +HomeKit controller will poll your devices, but it will also automatically enable push updates for accessories that support it. + Home Assistant does not currently support HomeKit BLE.
    @@ -67,10 +69,6 @@ If your device doesn't have a display and received HomeKit support after it was If you have lost your PIN code, then you may not be able to pair your accessory. You should contact the manufacturer to see if there is anything you can do. -### My accessory isn't updating straight away - -This is normal - HomeKit controller is currently a local polling based integration. It polls your accessory for its latest state once per minute. - ### Home Assistant cannot discover my device For IP accessories, Home Assistant can only find devices that are already on the same network as your device. If an accessory is Wi-Fi based and has no user interface for joining it to your Wi-Fi network, you will need an Apple HomeKit controller device (an iPhone or iPad). You should pair it with the controller and then remove the pairing in the UI (but do not reset the accessory itself). This will leave the accessory on your Wi-Fi network but in an unpaired state, and then Home Assistant can find it. diff --git a/source/_integrations/homematic.markdown b/source/_integrations/homematic.markdown index 703b91bbbad..b7ea20cca01 100644 --- a/source/_integrations/homematic.markdown +++ b/source/_integrations/homematic.markdown @@ -17,6 +17,7 @@ ha_release: 0.23 ha_codeowners: - '@pvizeli' - '@danielperna84' +ha_domain: homematic --- The [Homematic](https://www.homematic.com/) integration provides bi-directional communication with your CCU/Homegear. It uses a XML-RPC connection to set values on devices and subscribes to receive events the devices and the CCU emit. diff --git a/source/_integrations/homematicip_cloud.markdown b/source/_integrations/homematicip_cloud.markdown index 3590b5e1b05..d6431a9c4ad 100644 --- a/source/_integrations/homematicip_cloud.markdown +++ b/source/_integrations/homematicip_cloud.markdown @@ -17,6 +17,7 @@ ha_config_flow: true ha_quality_scale: platinum ha_codeowners: - '@SukramJ' +ha_domain: homematicip_cloud --- The [HomematicIP](https://www.homematic-ip.com/) integration platform is used as an interface to the cloud server. Since there is no official documentation about this API, everything was done via reverse engineering. The [homematicip-rest-api](https://github.com/coreGreenberet/homematicip-rest-api) is used for communicating. Use at your own risk. @@ -184,12 +185,15 @@ Afterward, this device can be implemented into Home Assistant. ## Services +Executable by all users: - `homematicip_cloud.activate_eco_mode_with_duration`: Activate eco mode with duration. - `homematicip_cloud.activate_eco_mode_with_period`: Activate eco mode with period. - `homematicip_cloud.activate_vacation`: Activates the vacation mode until the given time. - `homematicip_cloud.deactivate_eco_mode`: Deactivates the eco mode immediately. - `homematicip_cloud.deactivate_vacation`: Deactivates the vacation mode immediately. - `homematicip_cloud.set_active_climate_profile`: Set the active climate profile index. + +Executable by administrators or within the context of an automation: - `homematicip_cloud.dump_hap_config`: Dump the configuration of the Homematic IP Access Point(s). - `homematicip_cloud.reset_energy_counter`: Reset energy counter of measuring actuators. diff --git a/source/_integrations/homeworks.markdown b/source/_integrations/homeworks.markdown index dde96011ccf..e1ef17d076c 100644 --- a/source/_integrations/homeworks.markdown +++ b/source/_integrations/homeworks.markdown @@ -7,6 +7,7 @@ ha_category: - Light ha_release: 0.85 ha_iot_class: Local Push +ha_domain: homeworks --- [Lutron](http://www.lutron.com/) is an American lighting control company. The Lutron Homeworks Series 4 & 8 systems are relatively old (~2003), and use RS-232 connections to communicate with home automation systems. The `homeworks` integration in Home Assistant is responsible for communicating with the main controller for these systems. Communication is through an ethernet to serial converter (NPort, for example). diff --git a/source/_integrations/honeywell.markdown b/source/_integrations/honeywell.markdown index 854b7902ccb..34a24c8b04f 100644 --- a/source/_integrations/honeywell.markdown +++ b/source/_integrations/honeywell.markdown @@ -8,6 +8,7 @@ ha_release: pre 0.7 ha_iot_class: Cloud Polling ha_codeowners: - '@zxdavb' +ha_domain: honeywell --- The `honeywell` climate platform integrates Home Assistant with _US-based_ [Honeywell Total Connect Comfort (TCC)](https://mytotalconnectcomfort.com/portal/) climate systems. diff --git a/source/_integrations/horizon.markdown b/source/_integrations/horizon.markdown index 19ff8f60377..c6fde98febb 100644 --- a/source/_integrations/horizon.markdown +++ b/source/_integrations/horizon.markdown @@ -6,6 +6,7 @@ ha_category: - Media Player ha_iot_class: Local Polling ha_release: 0.72 +ha_domain: horizon --- The `horizon` integration allows you to control a [Unitymedia](https://www.unitymedia.de) Horizon HD Recorder from Home Assistant. diff --git a/source/_integrations/hp_ilo.markdown b/source/_integrations/hp_ilo.markdown index 19d0de01fef..9b933810174 100644 --- a/source/_integrations/hp_ilo.markdown +++ b/source/_integrations/hp_ilo.markdown @@ -6,6 +6,7 @@ ha_category: - System Monitor ha_release: 0.27 ha_iot_class: Local Polling +ha_domain: hp_ilo --- The `hp_ilo` platform allows you to do an API call to the HP ILO (Integrated Lights-Out) sensor of your server, and use this data in Home Assistant sensors. diff --git a/source/_integrations/html5.markdown b/source/_integrations/html5.markdown index a6b15af0b1d..7c38d3ef9ef 100644 --- a/source/_integrations/html5.markdown +++ b/source/_integrations/html5.markdown @@ -1,12 +1,12 @@ --- title: HTML5 Push Notifications description: Instructions on how to use the HTML5 push notifications platform from Home Assistant. -logo: html5.png ha_category: - Notifications ha_release: 0.27 ha_codeowners: - '@robbiet480' +ha_domain: html5 --- The `html5` notification platform enables you to receive push notifications to Chrome or Firefox, no matter where you are in the world. `html5` also supports Chrome and Firefox on Android, which enables native-app-like integrations without actually needing a native app. @@ -84,13 +84,13 @@ The `html5` platform can only function if all of the following requirements are * You are using Chrome and/or Firefox on any desktop platform, ChromeOS or Android. * Your Home Assistant instance is accessible from outside your network over HTTPS or can perform an alternative [Domain Name Verification Method](https://support.google.com/webmasters/answer/9008080#domain_name_verification) on the domain used by Home Assistant. * If using a proxy, HTTP basic authentication must be off for registering or unregistering for push notifications. It can be re-enabled afterwards. -* If you don't run Hass.io: `pywebpush` must be installed. `libffi-dev`, `libpython-dev` and `libssl-dev` must be installed prior to `pywebpush` (i.e. `pywebpush` probably won't automatically install). -* You have configured SSL/TLS for your Home Assistant. It doesn't need to be configured in Home Assistant though, e.g., you can be running [NGINX](/ecosystem/nginx/) in front of Home Assistant and this will still work. The certificate must be trustworthy (i.e. not self signed). +* If you don't run Hass.io: `pywebpush` must be installed. `libffi-dev`, `libpython-dev` and `libssl-dev` must be installed prior to `pywebpush` (i.e., `pywebpush` probably won't automatically install). +* You have configured SSL/TLS for your Home Assistant. It doesn't need to be configured in Home Assistant though, e.g., you can be running [NGINX](/ecosystem/nginx/) in front of Home Assistant and this will still work. The certificate must be trustworthy (i.e., not self signed). * You are willing to accept the notification permission in your browser. ### Configuring the platform -1. Make sure you can access your Home Assistant installation from outside your network over HTTPS ([see docs](/docs/configuration/remote/)) or can perform an alternative [Domain Name Verification Method](https://support.google.com/webmasters/answer/9008080#domain_name_verification) on the domain used by Home Assistant. +1. Make sure you can access your Home Assistant installation from outside your network over HTTPS ([see documentation](/docs/configuration/remote/)) or can perform an alternative [Domain Name Verification Method](https://support.google.com/webmasters/answer/9008080#domain_name_verification) on the domain used by Home Assistant. 2. Create a new project at [https://console.cloud.google.com/home/dashboard](https://console.cloud.google.com/home/dashboard), this project will be imported into Firebase later (alternatively, the project can also be created during step 4). 3. Go to [https://console.cloud.google.com/apis/credentials/domainverification](https://console.cloud.google.com/apis/credentials/domainverification) and verify your domain via Google Webmaster Central / Search Console - [see below](#verify-your-domain). 4. With the domain verified, go to [https://console.firebase.google.com](https://console.firebase.google.com), select import Google project and select the project you created. @@ -216,7 +216,7 @@ data: url: https://google.com ``` -If no URL or actions are provided, interacting with a notification will open your Home Assistant in the browser. You can use relative URLs to refer to Home Assistant, i.e. `/map` would turn into `https://192.168.1.2:8123/map`. +If no URL or actions are provided, interacting with a notification will open your Home Assistant in the browser. You can use relative URLs to refer to Home Assistant, i.e., `/map` would turn into `https://192.168.1.2:8123/map`. #### TTL and Priority diff --git a/source/_integrations/http.markdown b/source/_integrations/http.markdown index 64038d3bfce..fb15340d193 100644 --- a/source/_integrations/http.markdown +++ b/source/_integrations/http.markdown @@ -1,7 +1,6 @@ --- title: HTTP description: Offers a web framework to serve files. -logo: http.png ha_category: - Other - Binary Sensor @@ -11,6 +10,7 @@ ha_iot_class: Local Push ha_quality_scale: internal ha_codeowners: - '@home-assistant/core' +ha_domain: http --- 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. @@ -60,7 +60,7 @@ ssl_key: required: false type: string cors_allowed_origins: - description: "A list of origin domain names to allow [CORS](https://en.wikipedia.org/wiki/Cross-origin_resource_sharing) requests from. Enabling this will set the `Access-Control-Allow-Origin` header to the Origin header if it is found in the list, and the `Access-Control-Allow-Headers` header to `Origin, Accept, X-Requested-With, Content-type, Authorization`. You must provide the exact Origin, i.e. `https://www.home-assistant.io` will allow requests from `https://www.home-assistant.io` but __not__ `http://www.home-assistant.io`." + description: "A list of origin domain names to allow [CORS](https://en.wikipedia.org/wiki/Cross-origin_resource_sharing) requests from. Enabling this will set the `Access-Control-Allow-Origin` header to the Origin header if it is found in the list, and the `Access-Control-Allow-Headers` header to `Origin, Accept, X-Requested-With, Content-type, Authorization`. You must provide the exact Origin, i.e., `https://www.home-assistant.io` will allow requests from `https://www.home-assistant.io` but __not__ `http://www.home-assistant.io`." required: false type: [string, list] use_x_forwarded_for: diff --git a/source/_integrations/htu21d.markdown b/source/_integrations/htu21d.markdown index 144f8347c64..083bcd5a95f 100644 --- a/source/_integrations/htu21d.markdown +++ b/source/_integrations/htu21d.markdown @@ -1,11 +1,11 @@ --- title: HTU21D(F) Sensor description: Instructions on how to integrate a HTU21D Temperature and humidity sensor into Home Assistant. -logo: raspberry-pi.png ha_category: - DIY ha_release: 0.48 ha_iot_class: Local Push +ha_domain: htu21d --- The `htu21d` sensor platform allows you to read the temperature and humidity from a [HTU21D sensor](https://cdn-shop.adafruit.com/datasheets/1899_HTU21D.pdf) connected via [I2c](https://en.wikipedia.org/wiki/I²C) bus (SDA, SCL pins). diff --git a/source/_integrations/huawei_lte.markdown b/source/_integrations/huawei_lte.markdown index 2218a14c2fd..7082e43c0db 100644 --- a/source/_integrations/huawei_lte.markdown +++ b/source/_integrations/huawei_lte.markdown @@ -1,7 +1,6 @@ --- title: Huawei LTE description: Instructions on how to integrate Huawei LTE router and modem devices with Home Assistant. -logo: huawei.svg ha_category: - Network - Presence Detection @@ -14,6 +13,7 @@ ha_iot_class: Local Polling ha_config_flow: true ha_codeowners: - '@scop' +ha_domain: huawei_lte --- The Huawei LTE router and modem integration for Home Assistant allows you to observe and control [Huawei LTE devices](https://consumer.huawei.com/en/smart-home/). @@ -140,7 +140,7 @@ Reboot router. ### Service `huawei_lte.suspend_integration` Suspend integration. Suspending logs the integration out from the router, and stops accessing it. -Useful e.g. if accessing the router web interface from another source such as a web browser is temporarily required. +Useful e.g., if accessing the router web interface from another source such as a web browser is temporarily required. Invoke the `huawei_lte.resume_integration` service to resume. | Service data attribute | Optional | Description | diff --git a/source/_integrations/huawei_router.markdown b/source/_integrations/huawei_router.markdown index c8aaa0ff666..e869c312e0d 100644 --- a/source/_integrations/huawei_router.markdown +++ b/source/_integrations/huawei_router.markdown @@ -1,12 +1,12 @@ --- title: Huawei Router description: Instructions on how to integrate Huawei Routers into Home Assistant. -logo: huawei.svg ha_category: - Presence Detection ha_release: 0.51 ha_codeowners: - '@abmantis' +ha_domain: huawei_router --- The `huawei` device tracker platform offers presence detection by looking at connected devices to a [Huawei router](http://m.huawei.com/enmobile/enterprise/products/network/access/pon-one/hw-371813.htm). diff --git a/source/_integrations/hue.markdown b/source/_integrations/hue.markdown index 09211bd791d..453d7179f52 100644 --- a/source/_integrations/hue.markdown +++ b/source/_integrations/hue.markdown @@ -1,7 +1,6 @@ ---- +-- title: Philips Hue description: Instructions on setting up Philips Hue within Home Assistant. -logo: philips_hue.png ha_category: - Hub - Light @@ -12,6 +11,7 @@ ha_config_flow: true ha_quality_scale: platinum ha_codeowners: - '@balloob' +ha_domain: hue --- Philips Hue support is integrated into Home Assistant as a hub that can drive the light and sensor platforms. The preferred way to set up the Philips Hue platform is by enabling the [discovery component](/integrations/discovery/). @@ -148,4 +148,4 @@ The Hue API doesn't activate scenes directly; rather, they must be associated wi Neither group names nor scene names are guaranteed unique in Hue. If you are observing unexpected behavior from calling Hue scenes in Home Assistant, make the names of your Hue scenes more specific in the Hue app. -The Hue hub has limited space for scenes and will delete scenes if new ones get created that would overflow that space. The API docs say this is based on the scenes that are "least recently used." +The Hue hub has limited space for scenes and will delete scenes if new ones get created that would overflow that space. The API documentation says this is based on the scenes that are "least recently used." diff --git a/source/_integrations/hunterdouglas_powerview.markdown b/source/_integrations/hunterdouglas_powerview.markdown index ec63b020743..a02ca235614 100644 --- a/source/_integrations/hunterdouglas_powerview.markdown +++ b/source/_integrations/hunterdouglas_powerview.markdown @@ -5,6 +5,7 @@ logo: hunter-douglas-powerview.png ha_category: - Scene ha_release: 0.15 +ha_domain: hunterdouglas_powerview --- Implements the [Hunter Douglas PowerView](https://www.hunterdouglas.com/operating-systems/powerview-motorization/support) platform scene control. It queries the PowerView Hub and Home Assistant displays them as scenes. diff --git a/source/_integrations/hydrawise.markdown b/source/_integrations/hydrawise.markdown index 034ae51ac46..6f82a482181 100644 --- a/source/_integrations/hydrawise.markdown +++ b/source/_integrations/hydrawise.markdown @@ -9,6 +9,7 @@ ha_category: - Switch ha_release: 0.71 ha_iot_class: Cloud Polling +ha_domain: hydrawise --- The `hydrawise` integration allows you to integrate your [Hunter Hydrawise](https://hydrawise.com) Wi-Fi irrigation controller system in Home Assistant. diff --git a/source/_integrations/hyperion.markdown b/source/_integrations/hyperion.markdown index 16606dfef50..836366442a7 100644 --- a/source/_integrations/hyperion.markdown +++ b/source/_integrations/hyperion.markdown @@ -1,11 +1,11 @@ --- title: Hyperion description: Instructions on how to integrate Hyperion into Home Assistant. -logo: hyperion.png ha_category: - Light ha_release: 0.7.6 ha_iot_class: Local Polling +ha_domain: hyperion --- The `hyperion` platform allows you to integrate your [Hyperion](https://hyperion-project.org/wiki) into Home Assistant. Hyperion is an open source Ambilight implementation which runs on many platforms. diff --git a/source/_integrations/ialarm.markdown b/source/_integrations/ialarm.markdown index 83f2db4613c..e66a83f9415 100644 --- a/source/_integrations/ialarm.markdown +++ b/source/_integrations/ialarm.markdown @@ -5,6 +5,7 @@ logo: antifurto365-ialarm.png ha_category: - Alarm ha_release: '0.60' +ha_domain: ialarm --- The `ialarm` platform provides connectivity with the [Antifurto365](https://www.antifurtocasa365.it/) iAlarm alarm systems. diff --git a/source/_integrations/iammeter.markdown b/source/_integrations/iammeter.markdown new file mode 100644 index 00000000000..a799893f78e --- /dev/null +++ b/source/_integrations/iammeter.markdown @@ -0,0 +1,83 @@ +--- +title: "iammeter" +description: "Instructions on how to integrate IAMMETER sensor within Home Assistant." +logo: iammeter-logo.png +ha_category: + - Energy + - Sensor +ha_release: 0.107 +ha_iot_class: Local Polling +ha_domain: iammeter +--- + +`iammeter` provides real-time readings of single-phase (WEM3080, WEM3162) and three-phase (WEM3080T) meters from [IAMMETER](https://www.iammeter.com) over Wi-Fi. + +## Configuration + +To use this sensor in your installation, add the following to your `configuration.yaml` file: + +```yaml +# Example configuration.yaml entry +sensor: + - platform: iammeter + host: IP_ADDRESS_OF_HOST +``` + +{% configuration %} +host: + description: The IP address of your IAMMETER. + required: true + type: string +port: + description: port of your IAMMETER. + required: false + default: 80 + type: integer +name: + description: Name for the sensor entity. + required: false + type: string + default: IamMeter +{% endconfiguration %} + +## Sensors + +Sensors available in the library: + +### Single-phase energy meter (WEM3080/WEM3162) + +| name | Unit | Description | +|--------------------|------|:-----------------------------------------------------------------------------| +| wem3080_voltage | V | Voltage. | +| wem3080_current | A | current. | +| wem3080_power | W | active power. | +| wem3080_importenergy | kWh | Energy consumption from gird | +| wem3080_exportgrid | kWh | Energy export to grid | + +### Three-phase energy meter (WEM3080T) + +| name | Unit | Description | +|--------------------|------|:-----------------------------------------------------------------------------| +| wem3080t_voltage_a | V | A phase voltage | +| wem3080t_current_a | A | A phase current | +| wem3080t_power_a | W | A phase active power | +| wem3080t_importenergy_a | kWh | A phase import energy | +| wem3080t_exportgrid_a | kWh | A phase export energy | +| wem3080t_frequency_a | kWh | A phase frequency | +| wem3080t_pf_a | kWh | A phase power factor | +| | | | +| wem3080t_voltage_b | V | B phase voltage | +| wem3080t_current_b | A | B phase current | +| wem3080t_power_b | W | B phase active power | +| wem3080t_importenergy_b | kWh | B phase import energy | +| wem3080t_exportgrid_b | kWh | B phase export energy | +| wem3080t_frequency_b | kWh | B phase frequency | +| wem3080t_pf_b | kWh | B phase power factor | +| | | | +| wem3080t_voltage_c | V | C phase voltage | +| wem3080t_current_c | A | C phase current | +| wem3080t_power_c | W | C phase active power | +| wem3080t_importenergy_c | kWh | C phase import energy | +| wem3080t_exportgrid_c | kWh | C phase export energy | +| wem3080t_frequency_c | kWh | C phase frequency | +| wem3080t_pf_c | kWh | C phase power factor | diff --git a/source/_integrations/iaqualink.markdown b/source/_integrations/iaqualink.markdown index 30a8411515d..4e16dc4fd69 100644 --- a/source/_integrations/iaqualink.markdown +++ b/source/_integrations/iaqualink.markdown @@ -1,7 +1,6 @@ --- title: Jandy iAqualink description: Instructions on how to configure Jandy iAqualink integration. -logo: iaqualink.png ha_category: - Binary Sensor - Climate @@ -13,6 +12,7 @@ ha_iot_class: Cloud Polling ha_config_flow: true ha_codeowners: - '@flz' +ha_domain: iaqualink --- [iAqualink](https://www.iaqualink.com/) by [Jandy](https://www.jandy.com/) allows you to control your pool anytime, anywhere. diff --git a/source/_integrations/icloud.markdown b/source/_integrations/icloud.markdown index 3bb2c8ccc11..538211d62ba 100644 --- a/source/_integrations/icloud.markdown +++ b/source/_integrations/icloud.markdown @@ -1,7 +1,6 @@ --- title: Apple iCloud description: Instructions on how to use iCloud to track devices in Home Assistant. -logo: icloud.png ha_category: - Presence Detection - Sensor @@ -10,6 +9,7 @@ ha_release: '0.10' ha_config_flow: true ha_codeowners: - '@Quentame' +ha_domain: icloud --- The `icloud` integration allows you to detect presence using the [iCloud](https://www.icloud.com/) service. iCloud allows users to track their location on iOS devices. diff --git a/source/_integrations/idteck_prox.markdown b/source/_integrations/idteck_prox.markdown index 1553305ceaa..70e7c22b3b7 100644 --- a/source/_integrations/idteck_prox.markdown +++ b/source/_integrations/idteck_prox.markdown @@ -1,11 +1,11 @@ --- title: IDTECK Proximity Reader description: How to use IDTECK proximity card readers. -logo: idteck.jpg ha_category: - Other ha_release: 0.85 ha_iot_class: Local Push +ha_domain: idteck_prox --- [IDTECK](http://www.idteck.com) makes ID systems used to control access and identify users. This integration works with [Proximity Readers](http://www.idteck.com/en/products/proximity-reader-__-card-%26-tag-__125khz) (RFID card readers). The device is connected to Home Assistant through a serial to ethernet converter (NPort). diff --git a/source/_integrations/ifttt.markdown b/source/_integrations/ifttt.markdown index 803f44c5837..c7af255d885 100644 --- a/source/_integrations/ifttt.markdown +++ b/source/_integrations/ifttt.markdown @@ -1,20 +1,20 @@ --- title: IFTTT description: Instructions on how to setup IFTTT within Home Assistant. -logo: ifttt.png ha_category: - Automation featured: true ha_iot_class: Cloud Push ha_release: 0.8 ha_config_flow: true +ha_domain: ifttt --- [IFTTT](https://ifttt.com) is a web service that allows users to create chains of simple conditional statements, so-called "Applets". With the IFTTT component, you can trigger applets through the **"Webhooks"** service (which was previously the **"Maker"** channel). ## Sending events from IFTTT to Home Assistant -To be able to receive events from IFTTT, your Home Assistant instance needs to be accessible from the web and you need to have the `base_url` configured for the HTTP integration ([docs](/integrations/http/#base_url)). +To be able to receive events from IFTTT, your Home Assistant instance needs to be accessible from the web and you need to have the `base_url` configured for the HTTP integration ([documentation](/integrations/http/#base_url)). ### Setting up the integration diff --git a/source/_integrations/iglo.markdown b/source/_integrations/iglo.markdown index b209e451139..93ee75fc2c1 100644 --- a/source/_integrations/iglo.markdown +++ b/source/_integrations/iglo.markdown @@ -6,6 +6,7 @@ ha_category: - Light ha_iot_class: Local Polling ha_release: 0.61 +ha_domain: iglo --- The `iglo` platform allows you to integrate your [iGlo Lights](https://www.youtube.com/watch?v=oHTS9ji_v-s) into Home Assistant. diff --git a/source/_integrations/ign_sismologia.markdown b/source/_integrations/ign_sismologia.markdown index 30ac27c9be1..2c976e21462 100644 --- a/source/_integrations/ign_sismologia.markdown +++ b/source/_integrations/ign_sismologia.markdown @@ -1,13 +1,13 @@ --- title: IGN Sismología description: Instructions on how to integrate the Instituto Geográfico Nacional Sismología (Earthquakes) Feed feed into Home Assistant. -logo: ign-sismologia.png ha_category: - Geolocation ha_iot_class: Cloud Polling ha_release: 0.92 ha_codeowners: - '@exxamalte' +ha_domain: ign_sismologia --- The `ign_sismologia` platform lets you integrate a GeoRSS feed provided by the diff --git a/source/_integrations/ihc.markdown b/source/_integrations/ihc.markdown index 5c552394214..d89995039f9 100644 --- a/source/_integrations/ihc.markdown +++ b/source/_integrations/ihc.markdown @@ -1,7 +1,6 @@ --- title: IHC Controller description: Instructions on how to integrate the IHC integrations with Home Assistant -logo: ihc.png ha_category: - Hub - Binary Sensor @@ -10,6 +9,7 @@ ha_category: - Switch ha_release: 0.62 ha_iot_class: Local Push +ha_domain: ihc --- IHC Controller integration for Home Assistant allows you to connect the LK IHC controller to Home Assistant. The controller is sold under other names in different countries - "ELKO Living system" in Sweden and Norway. diff --git a/source/_integrations/image_processing.markdown b/source/_integrations/image_processing.markdown index 4c78e8c67b1..dcb253a0102 100644 --- a/source/_integrations/image_processing.markdown +++ b/source/_integrations/image_processing.markdown @@ -2,6 +2,7 @@ title: Image Processing description: Instructions on how to setup image processing with Home Assistant. ha_release: 0.36 +ha_domain: image_processing --- Image processing enables Home Assistant to process images from [cameras](/integrations/#camera). Only camera entities are supported as sources. diff --git a/source/_integrations/imap.markdown b/source/_integrations/imap.markdown index 4468cf5f8fc..69ab4df1c7d 100644 --- a/source/_integrations/imap.markdown +++ b/source/_integrations/imap.markdown @@ -1,11 +1,11 @@ --- title: IMAP description: Instructions on how to integrate IMAP unread email into Home Assistant. -logo: smtp.png ha_category: - Mailbox ha_release: 0.25 ha_iot_class: Cloud Push +ha_domain: imap --- The `imap` integration is observing your [IMAP server](https://en.wikipedia.org/wiki/Internet_Message_Access_Protocol) and reporting the amount of unread emails. diff --git a/source/_integrations/imap_email_content.markdown b/source/_integrations/imap_email_content.markdown index c6d3c34f1dc..859e995035f 100644 --- a/source/_integrations/imap_email_content.markdown +++ b/source/_integrations/imap_email_content.markdown @@ -1,11 +1,11 @@ --- title: IMAP Email Content description: Instructions on how to integrate IMAP email content sensor into Home Assistant. -logo: smtp.png ha_category: - Mailbox ha_iot_class: Cloud Push ha_release: 0.25 +ha_domain: imap_email_content --- The `imap_email_content` integration will read emails from an IMAP email server and report them as a state change within Home Assistant. This is useful if you have a device that only reports its state via email. diff --git a/source/_integrations/incomfort.markdown b/source/_integrations/incomfort.markdown index 9ff53bda70a..b287a7ce2fb 100644 --- a/source/_integrations/incomfort.markdown +++ b/source/_integrations/incomfort.markdown @@ -1,7 +1,6 @@ --- title: Intergas InComfort/Intouch Lan2RF gateway description: Instructions on how to integrate an Intergas Lan2RF gateway with Home Assistant. -logo: incomfort.png ha_category: - Water Heater - Climate @@ -11,6 +10,7 @@ ha_release: 0.93 ha_iot_class: Local Polling ha_codeowners: - '@zxdavb' +ha_domain: incomfort --- The `incomfort` integration links Home Assistant with your Intergas Lan2RF gateway, including the boiler and any room thermostats attached to it. diff --git a/source/_integrations/influxdb.markdown b/source/_integrations/influxdb.markdown index 171f6588401..9f944b7df70 100644 --- a/source/_integrations/influxdb.markdown +++ b/source/_integrations/influxdb.markdown @@ -9,6 +9,7 @@ ha_release: 0.9 ha_iot_class: Configurable ha_codeowners: - '@fabaff' +ha_domain: influxdb --- The `influxdb` integration makes it possible to transfer all state changes to an external [InfluxDB](https://influxdb.com/) database. See the [official installation documentation](https://docs.influxdata.com/influxdb/v1.7/introduction/installation/) for how to set up an InfluxDB database, or if you're using Hass.io, [there is a community add-on](https://community.home-assistant.io/t/community-hass-io-add-on-influxdb/54491) available. @@ -194,7 +195,7 @@ sensor: {% configuration %} host: - description: IP address of your database host, e.g. 192.168.1.10. + description: IP address of your database host, e.g., 192.168.1.10. required: false default: localhost type: string diff --git a/source/_integrations/input_boolean.markdown b/source/_integrations/input_boolean.markdown index 241341506b0..6aeecdc9503 100644 --- a/source/_integrations/input_boolean.markdown +++ b/source/_integrations/input_boolean.markdown @@ -1,13 +1,13 @@ --- title: Input Boolean description: Instructions on how to integrate the Input Boolean integration into Home Assistant. -logo: home-assistant.png ha_category: - Automation ha_release: 0.11 ha_quality_scale: internal ha_codeowners: - '@home-assistant/core' +ha_domain: input_boolean --- The `input_boolean` integration allows the user to define boolean values that can be controlled via the frontend and can be used within conditions of automation. This can for example be used to disable or enable certain automations. diff --git a/source/_integrations/input_datetime.markdown b/source/_integrations/input_datetime.markdown index daa33d3108b..3fe4fb11592 100644 --- a/source/_integrations/input_datetime.markdown +++ b/source/_integrations/input_datetime.markdown @@ -1,13 +1,13 @@ --- title: Input Datetime description: Instructions on how to integrate the Input Datetime integration into Home Assistant. -logo: home-assistant.png ha_category: - Automation ha_release: 0.55 ha_quality_scale: internal ha_codeowners: - '@home-assistant/core' +ha_domain: input_datetime --- The `input_datetime` integration allows the user to define date and time values diff --git a/source/_integrations/input_number.markdown b/source/_integrations/input_number.markdown index 5bee95ec089..144b5a4c138 100644 --- a/source/_integrations/input_number.markdown +++ b/source/_integrations/input_number.markdown @@ -1,13 +1,13 @@ --- title: Input Number description: Instructions on how to integrate the Input Number integration into Home Assistant. -logo: home-assistant.png ha_category: - Automation ha_release: 0.55 ha_quality_scale: internal ha_codeowners: - '@home-assistant/core' +ha_domain: input_number --- The `input_number` integration allows the user to define values that can be controlled via the frontend and can be used within conditions of automation. The frontend can display a slider, or a numeric input box. Changes to the slider or numeric input box generate state events. These state events can be utilized as `automation` triggers as well. diff --git a/source/_integrations/input_select.markdown b/source/_integrations/input_select.markdown index 6bcb92e7b8e..7bb89b97095 100644 --- a/source/_integrations/input_select.markdown +++ b/source/_integrations/input_select.markdown @@ -1,13 +1,13 @@ --- title: Input Select description: Instructions on how to integrate the Input Select integration into Home Assistant. -logo: home-assistant.png ha_category: - Automation ha_release: 0.13 ha_quality_scale: internal ha_codeowners: - '@home-assistant/core' +ha_domain: input_select --- The `input_select` integration allows the user to define a list of values that can be selected via the frontend and can be used within conditions of automation. When a user selects a new item, a state transition event is generated. This state event can be used in an `automation` trigger. diff --git a/source/_integrations/input_text.markdown b/source/_integrations/input_text.markdown index 96161c987d1..c27bd6a013f 100644 --- a/source/_integrations/input_text.markdown +++ b/source/_integrations/input_text.markdown @@ -1,13 +1,13 @@ --- title: Input Text description: Instructions on how to integrate the Input Text integration into Home Assistant. -logo: home-assistant.png ha_category: - Automation ha_release: 0.53 ha_quality_scale: internal ha_codeowners: - '@home-assistant/core' +ha_domain: input_text --- The `input_text` integration allows the user to define values that can be controlled via the frontend and can be used within conditions of automation. Changes to the value stored in the text box generate state events. These state events can be utilized as `automation` triggers as well. It can also be configured in password mode (obscured text). diff --git a/source/_integrations/insteon.markdown b/source/_integrations/insteon.markdown index 784c9fb1fb6..1603cdec73e 100644 --- a/source/_integrations/insteon.markdown +++ b/source/_integrations/insteon.markdown @@ -12,6 +12,7 @@ ha_category: - Switch ha_iot_class: Local Push ha_release: 0.39 +ha_domain: insteon --- This integration adds "local push" support for INSTEON Modems allowing linked INSTEON devices to be used within Home Assistant. @@ -96,7 +97,7 @@ host: required: false type: string ip_port: - description: The IP port number of the Hub. For Hub model [2245] (i.e. Hub version 2) the default port is 25105. For the Hub model [2242] (i.e. Hub version 1) the default port is 9761. Use the Insteon app to find the port number for your specific Hub. Optional with Hub. + description: The IP port number of the Hub. For Hub model [2245] (i.e., Hub version 2) the default port is 25105. For the Hub model [2242] (i.e., Hub version 1) the default port is 9761. Use the Insteon app to find the port number for your specific Hub. Optional with Hub. required: true type: integer username: diff --git a/source/_integrations/integration.markdown b/source/_integrations/integration.markdown index 585f83b52d3..1f08e847cc3 100644 --- a/source/_integrations/integration.markdown +++ b/source/_integrations/integration.markdown @@ -10,6 +10,7 @@ logo: integral.png ha_quality_scale: internal ha_codeowners: - '@dgomes' +ha_domain: integration --- The `integration` platform provides the [Riemann sum](https://en.wikipedia.org/wiki/Riemann_sum) of the values provided by a source sensor. The Riemann sum is an approximation of an **integral** by a finite sum. The integration sensors is updated upon changes of the **source**. Fast sampling source sensors provide better results. In this implementation, the default is the Trapezoidal method, but Left and Right methods can optionally be used. diff --git a/source/_integrations/intent_script.markdown b/source/_integrations/intent_script.markdown index b5c39705146..48d66bfb960 100644 --- a/source/_integrations/intent_script.markdown +++ b/source/_integrations/intent_script.markdown @@ -1,11 +1,11 @@ --- title: Intent Script description: Instructions on how to setup scripts to run on intents. -logo: home-assistant.png ha_category: - Intent ha_release: '0.50' ha_quality_scale: internal +ha_domain: intent_script --- The `intent_script` integration allows users to configure actions and responses to intents. Intents can be fired by any integration that supports it. Examples are [Alexa](/integrations/alexa/) (Amazon Echo), [Dialogflow](/integrations/dialogflow/) (Google Assistant) and [Snips](/integrations/snips/). diff --git a/source/_integrations/intesishome.markdown b/source/_integrations/intesishome.markdown index bc383775ad0..22152b91f95 100644 --- a/source/_integrations/intesishome.markdown +++ b/source/_integrations/intesishome.markdown @@ -7,6 +7,7 @@ ha_release: 0.104 ha_iot_class: Cloud Push ha_codeowners: - '@jnimmo' +ha_domain: intesishome --- The `IntesisHome` climate platform lets you control [IntesisHome](https://www.intesishome.com) and [Airconwithme](https://www.airconwithme.com) devices. IntesisHome provides integrations with air conditioners, including Panasonic, Daikin, Fujitsu, Toshiba, LG and more. diff --git a/source/_integrations/ios.markdown b/source/_integrations/ios.markdown index c1edb27575b..4aeefb50749 100644 --- a/source/_integrations/ios.markdown +++ b/source/_integrations/ios.markdown @@ -1,7 +1,6 @@ --- title: Apple iOS description: Instructions on how to use the iOS companion app with Home Assistant. -logo: apple.png ha_category: - Hub ha_release: 0.31 @@ -9,6 +8,7 @@ ha_iot_class: Configurable ha_config_flow: true ha_codeowners: - '@robbiet480' +ha_domain: ios --- The `ios` integration is the Home Assistant part for using the iOS companion app. For further details please check the [iOS section](/docs/ecosystem/ios/) in the documentation for further details. diff --git a/source/_integrations/iota.markdown b/source/_integrations/iota.markdown index e1ee6c74064..67bbc744817 100644 --- a/source/_integrations/iota.markdown +++ b/source/_integrations/iota.markdown @@ -7,6 +7,7 @@ ha_category: - Sensor ha_release: 0.62 ha_iot_class: Cloud Polling +ha_domain: iota --- [IOTA](https://iota.org/) is a new blockless distributed ledger which is scalable, lightweight and makes it possible to transfer value without any fees. diff --git a/source/_integrations/iperf3.markdown b/source/_integrations/iperf3.markdown index a32d2da62b2..84f04b742f4 100644 --- a/source/_integrations/iperf3.markdown +++ b/source/_integrations/iperf3.markdown @@ -1,7 +1,6 @@ --- title: Iperf3 description: How to use Iperf3 within Home Assistant to measure your network bandwidth. -logo: iperf3.png ha_category: - System Monitor - Sensor @@ -9,6 +8,7 @@ ha_release: 0.71 ha_iot_class: Local Polling ha_codeowners: - '@rohankapoorcom' +ha_domain: iperf3 --- The `iperf3` sensor integration allows you to measure network bandwidth performance against a private or public [Iperf3](https://software.es.net/iperf/index.html) server. diff --git a/source/_integrations/ipma.markdown b/source/_integrations/ipma.markdown index cfe40bb619f..0f6620dc02f 100644 --- a/source/_integrations/ipma.markdown +++ b/source/_integrations/ipma.markdown @@ -10,6 +10,7 @@ ha_config_flow: true ha_codeowners: - '@dgomes' - '@abmantis' +ha_domain: ipma --- The `ipma` weather platform uses the [Instituto Português do Mar e Atmosfera](https://www.ipma.pt/) as a source for current and forecast meteorological data. diff --git a/source/_integrations/iqvia.markdown b/source/_integrations/iqvia.markdown index fca24f1c3c5..b64bd5ecfbb 100644 --- a/source/_integrations/iqvia.markdown +++ b/source/_integrations/iqvia.markdown @@ -1,7 +1,6 @@ --- title: IQVIA description: Instructions on how to use IQVIA data within Home Assistant -logo: iqvia.png ha_category: - Health ha_release: 0.63 @@ -9,6 +8,7 @@ ha_iot_class: Cloud Polling ha_config_flow: true ha_codeowners: - '@bachya' +ha_domain: iqvia --- The `iqvia` sensor platform collects and displays allergy, asthma and disease @@ -29,15 +29,6 @@ liking): ```yaml iqvia: zip_code: "00544" - monitored_conditions: - - allergy_average_forecasted - - allergy_index_today - - allergy_index_tomorrow - - asthma_average_forecasted - - asthma_index_today - - asthma_index_tomorrow - - disease_average_forecasted - - disease_index_today ``` {% configuration %} @@ -45,27 +36,6 @@ zip_code: description: The U.S. ZIP code to gather data for (as a quoted string). required: true type: string -monitored_conditions: - description: The metric types to monitor. - required: true - type: list - keys: - allergy_average_forecasted: - description: "The average forecasted allergy index over the next 5 days." - allergy_index_today: - description: "The allergy index for today." - allergy_index_tomorrow: - description: "The allergy index for tomorrow." - asthma_average_forecasted: - description: "The average forecasted asthma index over the next 5 days." - asthma_index_today: - description: "The asthma index for today." - asthma_index_tomorrow: - description: "The asthma index for tomorrow." - disease_average_forecasted: - description: "The average forecasted cold/flu index over the next 5 days." - disease_index_today: - description: "The cold/flu index for today." {% endconfiguration %}
    diff --git a/source/_integrations/irish_rail_transport.markdown b/source/_integrations/irish_rail_transport.markdown index f61d4e61ef3..1c3011e35ee 100644 --- a/source/_integrations/irish_rail_transport.markdown +++ b/source/_integrations/irish_rail_transport.markdown @@ -8,6 +8,7 @@ ha_iot_class: Cloud Polling ha_release: 0.57 ha_codeowners: - '@ttroy50' +ha_domain: irish_rail_transport --- The `irish_rail_transport` sensor will give you the time until the next two departures (within 90 minutes) from an Irish Rail station using the RTPI information. diff --git a/source/_integrations/islamic_prayer_times.markdown b/source/_integrations/islamic_prayer_times.markdown index 89d5c5ee458..dc46065bdfa 100644 --- a/source/_integrations/islamic_prayer_times.markdown +++ b/source/_integrations/islamic_prayer_times.markdown @@ -5,6 +5,7 @@ ha_category: - Sensor ha_iot_class: Cloud Polling ha_release: 0.85 +ha_domain: islamic_prayer_times --- The Islamic Prayer Times (`islamic_prayer_times`) sensor platform displays the various prayer times for Muslims as sensors. diff --git a/source/_integrations/iss.markdown b/source/_integrations/iss.markdown index a2323e1d04e..4db2a0a5bda 100644 --- a/source/_integrations/iss.markdown +++ b/source/_integrations/iss.markdown @@ -1,10 +1,10 @@ --- title: International Space Station (ISS) description: Know if or when ISS will be above your home location -logo: nasa.png ha_category: - Binary Sensor ha_release: 0.36 +ha_domain: iss --- The `iss` platform uses the diff --git a/source/_integrations/isy994.markdown b/source/_integrations/isy994.markdown index 51191ff5696..179e66c56e1 100644 --- a/source/_integrations/isy994.markdown +++ b/source/_integrations/isy994.markdown @@ -13,6 +13,7 @@ ha_category: - Switch ha_release: 0.28 ha_iot_class: Local Push +ha_domain: isy994 --- The ISY994 is a home automation controller that is capable of controlling Insteon and X10 devices. Some models of the ISY994 can even control Z-Wave devices. diff --git a/source/_integrations/itach.markdown b/source/_integrations/itach.markdown index 0607e4afb4d..34707e82c13 100644 --- a/source/_integrations/itach.markdown +++ b/source/_integrations/itach.markdown @@ -6,6 +6,7 @@ ha_category: - Remote ha_iot_class: Assumed State ha_release: 0.39 +ha_domain: itach --- The `itach` remote platform allows you to control IR devices with a [Global Caché iTach Device](https://www.globalcache.com/products/itach/ip2irspecs) and GC-100 devices. The Global Cache IR API are similar across their product line. See API documentation links at the end of this page. diff --git a/source/_integrations/itunes.markdown b/source/_integrations/itunes.markdown index a578ea71bda..eef80440d25 100644 --- a/source/_integrations/itunes.markdown +++ b/source/_integrations/itunes.markdown @@ -1,11 +1,11 @@ --- title: Apple iTunes description: Instructions on how to integrate iTunes into Home Assistant. -logo: itunes.png ha_category: - Media Player ha_release: 0.7.3 ha_iot_class: Local Polling +ha_domain: itunes --- The `itunes` media player platform allows you to control [iTunes](https://apple.com/itunes/) from Home Assistant. It uses a 3rd party server that you run on your Mac called [itunes-api](https://github.com/maddox/itunes-api). Play, pause or skip songs remotely on iTunes running on your Mac. diff --git a/source/_integrations/izone.markdown b/source/_integrations/izone.markdown index 6975626885b..57d4bece130 100644 --- a/source/_integrations/izone.markdown +++ b/source/_integrations/izone.markdown @@ -8,6 +8,7 @@ ha_iot_class: Local Push ha_config_flow: true ha_codeowners: - '@Swamp-Ig' +ha_domain: izone --- The `iZone` integration allows access of control of a local [iZone](https://izone.com.au/) ducted reverse-cycle climate control devices. These are largely available in Australia. diff --git a/source/_integrations/jewish_calendar.markdown b/source/_integrations/jewish_calendar.markdown index 07a689fac81..066efb965c5 100644 --- a/source/_integrations/jewish_calendar.markdown +++ b/source/_integrations/jewish_calendar.markdown @@ -7,6 +7,7 @@ ha_iot_class: Local Polling ha_release: 0.79 ha_codeowners: - '@tsvi' +ha_domain: jewish_calendar --- The Jewish Calendar (`jewish_calendar`) sensor platform displays a variety of information related to the Jewish Calendar as a variety of sensors. @@ -81,7 +82,7 @@ For easier use in automations, all time sensors have a `timestamp` attribute, wh - sunset: Sunset (Shkiya) - first_stars: Time at which the first stars are visible (Tseit Hakochavim - צאת הכוכבים). - upcoming_shabbat_candle_lighting: The time of candle lighting for either the current Shabbat (if it is currently Shabbat) or the immediately upcoming Shabbat. -- upcoming_shabbat_havdalah: The time of havdalah for either the current Shabbat (if it is currently Shabbat) or the immediately upcoming Shabbat. If it is currently a three-day holiday, this value *could* be None (i.e. if holiday is Sat./Sun./Mon. and it's Saturday, there will be no shabbat_havdalah value. See comments in hdate library for details.) +- upcoming_shabbat_havdalah: The time of havdalah for either the current Shabbat (if it is currently Shabbat) or the immediately upcoming Shabbat. If it is currently a three-day holiday, this value *could* be None (i.e., if holiday is Sat./Sun./Mon. and it's Saturday, there will be no shabbat_havdalah value. See comments in hdate library for details.) - upcoming_candle_lighting: The time of candle lighting for either the current Shabbat OR Yom Tov, or the immediately upcoming Shabbat OR Yom Tov. If, for example, today is Sunday, and Rosh Hashana is Monday night through Wednesday night, this reports the candle lighting for Rosh Hashana on Monday night. This avoids a situation of triggering pre-candle-lighting automations while it is currently Yom Tov. To always get the Shabbat times, use the upcoming_shabbat_candle_lighting sensor. - upcoming_havdalah: The time of havdalah for either the current Shabbat OR Yom Tov, or the immediately upcoming Shabbat OR Yom Tov. If, for example, today is Sunday, and Rosh Hashana is Monday night through Wednesday night, this reports the havdalah for Rosh Hashana on Wednesday night. To always get the Shabbat times, use the upcoming_shabbat_havdalah sensor. diff --git a/source/_integrations/joaoapps_join.markdown b/source/_integrations/joaoapps_join.markdown index 0f923ff761c..f9b73fcdc39 100644 --- a/source/_integrations/joaoapps_join.markdown +++ b/source/_integrations/joaoapps_join.markdown @@ -1,11 +1,11 @@ --- title: Joaoapps Join description: Instructions for how to integrate the Join by Joaoapps service within Home Assistant. -logo: joaoapps_join.png ha_category: - Hub - Notifications ha_release: 0.24 +ha_domain: joaoapps_join --- The `joaoapps_join` integration exposes services from diff --git a/source/_integrations/juicenet.markdown b/source/_integrations/juicenet.markdown index ea7a6ab5c50..2eec56c6ca4 100644 --- a/source/_integrations/juicenet.markdown +++ b/source/_integrations/juicenet.markdown @@ -11,6 +11,7 @@ ha_iot_class: Cloud Polling ha_release: 0.47 ha_codeowners: - '@jesserockz' +ha_domain: juicenet --- The `juicenet` sensor platform pulls data from a [JuiceNet](https://emotorwerks.com/products/juicenet/) charging station equipped with a Wi-Fi connection. It will access and make available all of the devices attached to your account. It also exposes a switch allowing you to charge your car now instead of waiting for the pre-set schedule. diff --git a/source/_integrations/kaiterra.markdown b/source/_integrations/kaiterra.markdown index ffc56575f6d..ec9626cb431 100644 --- a/source/_integrations/kaiterra.markdown +++ b/source/_integrations/kaiterra.markdown @@ -1,13 +1,13 @@ --- title: Kaiterra description: Instructions on how to integrate your Kaiterra device into Home Assistant. -logo: kaiterra.svg ha_iot_class: Cloud Polling ha_category: - Health ha_release: '0.100' ha_codeowners: - '@Michsior14' +ha_domain: kaiterra --- The `kaiterra` integration allows you to view the readings from your Laser Egg or Sensedge device using the [Kaiterra REST API](https://www.kaiterra.com/dev/). diff --git a/source/_integrations/kankun.markdown b/source/_integrations/kankun.markdown index 13f6d888e97..7dc3aa4f7c0 100644 --- a/source/_integrations/kankun.markdown +++ b/source/_integrations/kankun.markdown @@ -5,6 +5,7 @@ ha_category: - Switch ha_release: 0.36 ha_iot_class: Local Polling +ha_domain: kankun --- The `kankun` switch platform allows you to toggle customized Kankun SP3 Wi-Fi switches. Switches are diff --git a/source/_integrations/keba.markdown b/source/_integrations/keba.markdown index 80e7a9e06a3..fd41c73073c 100644 --- a/source/_integrations/keba.markdown +++ b/source/_integrations/keba.markdown @@ -9,6 +9,7 @@ ha_category: ha_release: 0.98 ha_codeowners: - '@dannerph' +ha_domain: keba --- The `keba` integrates your Keba charging station (wallbox) into your Home Assistant instance. It was tested with a BMW Wallbox but should also work with a Keba P20/P30 according to the developers [manual](https://www.keba.com/web/downloads/e-mobility/KeContact_P20_P30_UDP_ProgrGuide_en.pdf). The fetching interval to the charging station is set to 5 seconds, same as in the official mobile app. diff --git a/source/_integrations/keenetic_ndms2.markdown b/source/_integrations/keenetic_ndms2.markdown index 113b0d97fe1..ed6e47b195c 100644 --- a/source/_integrations/keenetic_ndms2.markdown +++ b/source/_integrations/keenetic_ndms2.markdown @@ -7,6 +7,7 @@ ha_category: ha_release: 0.54 ha_codeowners: - '@foxel' +ha_domain: keenetic_ndms2 --- This integration offers presence detection by examining devices connected to a [Keenetic](https://keenetic.net/) diff --git a/source/_integrations/kef.markdown b/source/_integrations/kef.markdown index bd7a5389d31..fddf9941b9b 100644 --- a/source/_integrations/kef.markdown +++ b/source/_integrations/kef.markdown @@ -1,13 +1,13 @@ --- title: KEF description: Instructions on how to integrate KEF Speakers into Home Assistant. -logo: kef.png ha_category: - Media Player ha_iot_class: Local Polling ha_release: 0.104 ha_codeowners: - '@basnijholt' +ha_domain: kef --- The `kef` platform allows you to control the [KEF LS50 Wireless](https://international.kef.com/products/ls50-wireless) and [KEF LSX](https://international.kef.com/products/lsx) speakers from Home Assistant. diff --git a/source/_integrations/keyboard.markdown b/source/_integrations/keyboard.markdown index 0aa71836b3b..8c4a4bf91f6 100644 --- a/source/_integrations/keyboard.markdown +++ b/source/_integrations/keyboard.markdown @@ -1,10 +1,10 @@ --- title: Keyboard description: Instructions on how to simulate key presses with Home Assistant. -logo: keyboard.png ha_category: - Automation ha_release: pre 0.7 +ha_domain: keyboard --- The `keyboard` integration simulates key presses on the host machine. It currently offers the following Buttons as a Service (BaaS): diff --git a/source/_integrations/keyboard_remote.markdown b/source/_integrations/keyboard_remote.markdown index 69e928ebfd8..7dd54f8c307 100644 --- a/source/_integrations/keyboard_remote.markdown +++ b/source/_integrations/keyboard_remote.markdown @@ -1,13 +1,13 @@ --- title: Keyboard Remote description: Instructions on how to use a keyboard to remote control Home Assistant. -logo: keyboard.png ha_category: - Other ha_release: 0.29 ha_iot_class: Local Push ha_codeowners: - '@bendavid' +ha_domain: keyboard_remote --- Receive signals from a keyboard and use it as a remote control. diff --git a/source/_integrations/kira.markdown b/source/_integrations/kira.markdown index 88c69594478..b469a682be4 100644 --- a/source/_integrations/kira.markdown +++ b/source/_integrations/kira.markdown @@ -7,6 +7,7 @@ ha_category: - Remote - Sensor ha_release: 0.45 +ha_domain: kira --- The `kira` integration is the main integration to integrate Keene Electronics IR over IP [Kira](https://www.keene.co.uk/keene-ir-anywhere-single-worldwide.html) modules with Home Assistant. diff --git a/source/_integrations/kiwi.markdown b/source/_integrations/kiwi.markdown index b739ce3257a..521da671033 100644 --- a/source/_integrations/kiwi.markdown +++ b/source/_integrations/kiwi.markdown @@ -1,11 +1,11 @@ --- title: KIWI description: Instructions on how to integrate KIWI Smart Lock and Smart Entry. -logo: kiwi.png ha_category: - Lock ha_release: 0.72 ha_iot_class: Cloud Polling +ha_domain: kiwi --- The `KIWI` platform allows you to open your KIWI Smart Locks and Smart Entry Devices. diff --git a/source/_integrations/knx.markdown b/source/_integrations/knx.markdown index 88b468bfcf9..cf0e0a9e67f 100644 --- a/source/_integrations/knx.markdown +++ b/source/_integrations/knx.markdown @@ -1,13 +1,13 @@ --- title: KNX description: Instructions on how to integrate KNX components with Home Assistant. -logo: knx.png ha_category: - Hub ha_release: 0.24 ha_iot_class: Local Push ha_codeowners: - '@Julius2342' +ha_domain: knx --- The [KNX](https://www.knx.org) integration for Home Assistant allows you to connect to a KNX/IP devices. diff --git a/source/_integrations/kodi.markdown b/source/_integrations/kodi.markdown index 03e41d3f45f..ccddd381eca 100644 --- a/source/_integrations/kodi.markdown +++ b/source/_integrations/kodi.markdown @@ -9,6 +9,7 @@ ha_release: pre 0.7 ha_iot_class: Local Push ha_codeowners: - '@armills' +ha_domain: kodi --- The `kodi` platform allows you to control a [Kodi](https://kodi.tv/) multimedia system from Home Assistant. @@ -87,7 +88,7 @@ timeout: #### Service `kodi.add_to_playlist` -Add music to the default playlist (i.e. playlistid=0). +Add music to the default playlist (i.e., playlistid=0). | Service data attribute | Optional | Description | | ---------------------- | -------- | ----------- | diff --git a/source/_integrations/konnected.markdown b/source/_integrations/konnected.markdown index 65084bad9fb..8849ee4be7a 100644 --- a/source/_integrations/konnected.markdown +++ b/source/_integrations/konnected.markdown @@ -10,19 +10,28 @@ ha_category: ha_release: '0.70' ha_codeowners: - '@heythisisnate' + - '@kit-klein' +ha_config_flow: true +ha_domain: konnected --- The `konnected` integration lets you connect wired sensors and switches to a Konnected Alarm Panel, or NodeMCU ESP8226 based device running the [open source Konnected software](https://github.com/konnected-io/konnected-security). Reuse the wired sensors and siren from an old or pre-wired alarm system installation and integrate them directly into Home Assistant. Visit the [Konnected.io website](https://konnected.io) for more information about the Konnected Alarm Panel board and compatible hardware. +
    + +Always ensure your panel is running the [latest firmware](https://help.konnected.io/support/solutions/folders/32000035066) before connecting it to Home Assistant. + +
    + The integration currently supports the following device types in Home Assistant: - Binary Sensor: Wired door and window sensors, motion detectors, glass-break detectors, leak sensors, smoke & CO detectors or any open/close switch. - Switch: Actuate a siren, strobe, buzzer or relay module. - Sensor: Periodic measurements from DHT temperature/humidity sensors and DS18B20 temperature sensors. -This integration uses the [SSDP](/integrations/ssdp) integration, which must be enabled for device discovery to work. If you don't want to use discovery, set the _host_ and _port_ for each device in the description. +This integration uses the [SSDP](/integrations/ssdp) integration, which must be enabled for device discovery to work. If you don't want to use SSDP you'll need to manually provide the IP and Port information for each Konnected Panel. The IP/Port info can be found using the Konnected mobile app.
    @@ -32,14 +41,53 @@ Konnected devices communicate with Home Assistant over your local LAN -- there i ## Configuration -Home Assistant offers Konnected integration through **Configuration** -> **Integrations** -> **Konnected.io**. +### Web Interface -The configuration flow will guide you through a setup process that lets you connect to the panel and generate a configuration entry. You can then utilize the options flow to configure or modify the behavior of each zone. +Starting with 0.106.0 Home Assistant requires UI based configuration of Konnected via **Configuration** -> **Integrations** in the Home Assistant (web) frontend. If you have Konnected Alarm Panels on your LAN, or in your configuration.yaml, you will see one or more **Konnected.io** entries appear in the **Discovered** integrations list. -If you prefer you can also utilize a `konnected` section in the `configuration.yaml` file that specifies the Konnected devices on the network and the sensors or actuators attached to them. If using `configuration.yaml` the configuration will automatically be imported and used to start a configuration flow. **Note that you must still complete the configuration/options flow before the configuration entry will be finalized.** +Selecting one of these discovered panels will guide you through connecting and configuring the panel. If your panel was discovered via SSDP, you shouldn't need any information to complete configuration - simply confirm that the information displayed is correct. If the UI prompts you for IP/Port, you'll need to enter it. IP/Port info can be found using the Konnected mobile app. -Details of the configuration fields and values can be found below - these apply to both the configuration flow and the YAML. +
    +If you have an existing `configuration.yaml` completing the UI configuration will do a one time import of the settings contained in `configuration.yaml`. Once the import creates a **Configured** integration the Konnected section of the `configuration.yaml` is no longer used - it is recommended to remove the `konnected` section of `configuration.yaml` and after the import occurs. Any future changes to settings should occur via the settings provided in the Home Assistant web interface. + +If you want to retain `configuration.yaml` and need to re-import any changes or updates you will need to delete the entry in **Configuration** -> **Integrations** -> **Configured** and repeat the UI configuration for that device. + +
    + +Once configuration is completed you'll see a Konnected.io entry in **Configuration** -> **Integrations** => **Configured**. If you imported settings from `configuration.yaml` you are now done! If you are setting up a new Konnected Alarm Panel or modifying settings, you'll need to utilize the settings UI to configure zone behavior. + +#### Using Settings UI to Configure Zone Behavior + +The settings for each panel can be accessed by selecting the entry in **Configuration** -> **Integrations** => **Configured** and then clicking on the gear icon in the upper right corner. You can reconfigure these settings at any time and once completed the settings will be immediately applied. + +The settings UI starts by having you configure the general behavior of each zone. You need to specify `Disabled`, `Binary Sensor`, `Digital Sensor`, or `Switchable Output` for each zone. After that, you'll be prompted, for each zone that is not disabled, to configure details of the zones' behavior. All zones will allow entry of a Name. Additional fields depend on how you configured the general behavior of the zone. + +##### Binary Sensor: + +**Binary Sensor Type:** The type of sensor connected to the zone. +**Name (optional)** The friendly name for the entity associated with the zone. +**Invert the open/close state:** Inverts the open/closed meaning of a binary sensor circuit. Commonly needed for normally open wired smoke alarm circuits. + +##### Digital Sensor: + +**Sensor Type:** The type of sensor connected to the zone - either `dht` or `ds18b20`. +**Name (optional)** The friendly name for the entities associated with the zone. +**Poll Interval (optional):** How often in minutes to poll the sensor for updates. + +##### Switchable Output: + +**Name: (optional)** The friendly name for the entity associated with the zone. +**Output when on:** The state of the switch when activated. +**Pulse Duration (optional):** The duration in ms to pulse the switch once activated. +**Pause between pulses (optional):** The duration in ms to wait between pulses when activated. +**Times to repeat (optional):** The number of times to repeat the pulse each time the switch is activated. + +### YAML Configuration + +If you prefer you can utilize a `konnected` section in the `configuration.yaml` file that specifies the Konnected devices on the network and the sensors or actuators attached to them. If using `configuration.yaml` the configuration will be one-time imported when going through the Configuration Flow for the panel. **Note that you must still complete the UI based setup before the integration will be configured and entities created/accessible.** + +Details of the configuration fields and values can be found below. ```yaml # Example configuration.yaml entry konnected: @@ -266,6 +314,10 @@ Konnected runs on an ESP8266 board with the NodeMCU firmware. It is commonly use ## Revision History +### 0.106 + +- Added information on configuration and options flow. Mention that alarm panel FW should be updated before connecting. + ### 0.91 - Improved Unique ID generation for Konnected switches diff --git a/source/_integrations/kwb.markdown b/source/_integrations/kwb.markdown index 54cff2e662d..3ba769a4e5b 100644 --- a/source/_integrations/kwb.markdown +++ b/source/_integrations/kwb.markdown @@ -1,11 +1,11 @@ --- title: KWB Easyfire description: Instructions on how to integrate the KWB Easyfire sensor into Home Assistant. -logo: kwb.png ha_category: - Sensor ha_iot_class: Local Polling ha_release: '0.40' +ha_domain: kwb --- The `kwb` integration integrates the sensors of KWB Easyfire pellet central heating units with the Comfort3 controller (https://www.kwb.net/produkte/) into Home Assistant. diff --git a/source/_integrations/lacrosse.markdown b/source/_integrations/lacrosse.markdown index bbc034a6ac3..a9350f3a47c 100644 --- a/source/_integrations/lacrosse.markdown +++ b/source/_integrations/lacrosse.markdown @@ -1,11 +1,11 @@ --- title: LaCrosse description: Instructions on how to integrate LaCrosse sensor data received from Jeelink into Home Assistant. -logo: home-assistant.png ha_category: - DIY ha_release: 0.58 ha_iot_class: Local Polling +ha_domain: lacrosse --- The `lacrosse` sensor platform is using the data provided by a [Jeelink](https://www.digitalsmarties.net/products/jeelink) USB dongle or this [Arduino sketch](https://svn.fhem.de/trac/browser/trunk/fhem/contrib/arduino/36_LaCrosse-LaCrosseITPlusReader.zip). diff --git a/source/_integrations/lametric.markdown b/source/_integrations/lametric.markdown index fbb78b631f0..bf920d155dd 100644 --- a/source/_integrations/lametric.markdown +++ b/source/_integrations/lametric.markdown @@ -8,6 +8,7 @@ ha_category: ha_release: 0.49 ha_codeowners: - '@robbiet480' +ha_domain: lametric --- [LaMetric Time](https://lametric.com/) is a smart clock that can be used to access applications, listen to web radio and display notifications. diff --git a/source/_integrations/lannouncer.markdown b/source/_integrations/lannouncer.markdown index 973387d10a5..576f996bc66 100644 --- a/source/_integrations/lannouncer.markdown +++ b/source/_integrations/lannouncer.markdown @@ -5,6 +5,7 @@ logo: lannouncer.png ha_category: - Notifications ha_release: 0.36 +ha_domain: lannouncer --- The `lannouncer` notification platform allows you to play spoken messages (TTS) or sounds on an Android device running [Lannouncer](https://www.keybounce.com/lannouncer/). This can be useful when you have a wall mounted Android tablet, or an Android device that is permanently powered and turned on and want to use that to play notifications. diff --git a/source/_integrations/lastfm.markdown b/source/_integrations/lastfm.markdown index b0b04627c5e..45348a13d7b 100644 --- a/source/_integrations/lastfm.markdown +++ b/source/_integrations/lastfm.markdown @@ -6,6 +6,7 @@ ha_category: - Social ha_iot_class: Cloud Polling ha_release: '0.20' +ha_domain: lastfm --- The `lastfm` sensor platform will allow you to see whenever a user starts scrobbling, their play count, last song played, and top song played on [Last.fm](https://www.last.fm/). diff --git a/source/_integrations/launch_library.markdown b/source/_integrations/launch_library.markdown index aa94baab894..c823e0dc73e 100644 --- a/source/_integrations/launch_library.markdown +++ b/source/_integrations/launch_library.markdown @@ -8,6 +8,7 @@ ha_iot_class: Cloud Polling ha_release: 0.83 ha_codeowners: - '@ludeeus' +ha_domain: launch_library --- The `launch_library` sensor will provide you with information about the next planned space launch. diff --git a/source/_integrations/lcn.markdown b/source/_integrations/lcn.markdown index f3b81fb26da..d39547064dc 100644 --- a/source/_integrations/lcn.markdown +++ b/source/_integrations/lcn.markdown @@ -15,6 +15,7 @@ ha_release: 0.85 ha_iot_class: Local Push ha_codeowners: - '@alengwenus' +ha_domain: lcn --- The `lcn` integration for Home Assistant allows you to connect to [LCN](https://www.lcn.eu/) hardware devices. diff --git a/source/_integrations/lg_netcast.markdown b/source/_integrations/lg_netcast.markdown index c5adcce8902..891a963883a 100644 --- a/source/_integrations/lg_netcast.markdown +++ b/source/_integrations/lg_netcast.markdown @@ -5,7 +5,8 @@ logo: lg.png ha_category: - Media Player ha_iot_class: Local Polling -ha_release: 0.20 +ha_release: '0.20' +ha_domain: lg_netcast --- The `lg_netcast` platform allows you to control a LG Smart TV running NetCast 3.0 (LG Smart TV models released in 2012) and NetCast 4.0 (LG Smart TV models released in 2013). For the new LG WebOS TV's use the [webostv](/integrations/webostv#media-player) platform. diff --git a/source/_integrations/lg_soundbar.markdown b/source/_integrations/lg_soundbar.markdown index 4f558d84c30..fe38a9c748e 100644 --- a/source/_integrations/lg_soundbar.markdown +++ b/source/_integrations/lg_soundbar.markdown @@ -6,6 +6,7 @@ ha_category: - Media Player ha_iot_class: Local Polling ha_release: 0.81 +ha_domain: lg_soundbar --- The `lg_soundbar` platform allows you to control [LG Soundbars](https://www.lg.com/us/sound-bars) from Home Assistant. diff --git a/source/_integrations/life360.markdown b/source/_integrations/life360.markdown index 3f9756e6a21..a0cc57b0b75 100644 --- a/source/_integrations/life360.markdown +++ b/source/_integrations/life360.markdown @@ -9,6 +9,7 @@ ha_category: ha_iot_class: Cloud Polling ha_codeowners: - '@pnbruckner' +ha_domain: life360 --- The `life360` integration allows you to detect presence using the [unofficial API](#disclaimer) of [Life360](https://www.life360.com/). diff --git a/source/_integrations/lifx.markdown b/source/_integrations/lifx.markdown index c31de1f2b4f..19108162ed4 100644 --- a/source/_integrations/lifx.markdown +++ b/source/_integrations/lifx.markdown @@ -7,6 +7,7 @@ ha_category: ha_iot_class: Local Polling ha_release: 0.81 ha_config_flow: true +ha_domain: lifx --- The `lifx` integration allows you to integrate your [LIFX](https://www.lifx.com) into Home Assistant. diff --git a/source/_integrations/lifx_cloud.markdown b/source/_integrations/lifx_cloud.markdown index bc7e58024b2..992047dd37f 100644 --- a/source/_integrations/lifx_cloud.markdown +++ b/source/_integrations/lifx_cloud.markdown @@ -5,6 +5,7 @@ logo: lifx.png ha_category: - Scene ha_release: 0.43 +ha_domain: lifx_cloud --- The `lifx_cloud` scene platform allows you to activate the scenes that LIFX smartphone apps store in the LIFX cloud. diff --git a/source/_integrations/light.group.markdown b/source/_integrations/light.group.markdown index c4362cff627..4be4de0486c 100644 --- a/source/_integrations/light.group.markdown +++ b/source/_integrations/light.group.markdown @@ -5,8 +5,8 @@ ha_category: - Light ha_release: 0.65 ha_iot_class: Local Push -logo: home-assistant.png ha_quality_scale: internal +ha_domain: group --- The group light platform lets you combine multiple lights into one entity. All child lights of a light group can still be used as usual, but controlling the state of the grouped light will forward the command to each child light. diff --git a/source/_integrations/light.knx.markdown b/source/_integrations/light.knx.markdown index ba9d102c38c..05caf7841c1 100644 --- a/source/_integrations/light.knx.markdown +++ b/source/_integrations/light.knx.markdown @@ -1,11 +1,11 @@ --- title: "KNX Light" description: "Instructions on how to integrate KNX lights with Home Assistant." -logo: knx.png ha_category: - Light ha_release: 0.44 ha_iot_class: Local Push +ha_domain: knx ---
    diff --git a/source/_integrations/light.markdown b/source/_integrations/light.markdown index f5f2aad10f0..895b943ed9e 100644 --- a/source/_integrations/light.markdown +++ b/source/_integrations/light.markdown @@ -1,11 +1,11 @@ --- title: Light description: Instructions on how to setup your lights with Home Assistant. -logo: home-assistant.png ha_category: - Light ha_release: pre 0.7 ha_quality_scale: internal +ha_domain: light --- 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. diff --git a/source/_integrations/light.mqtt.markdown b/source/_integrations/light.mqtt.markdown index 85f0260e417..2712d5d1a78 100644 --- a/source/_integrations/light.mqtt.markdown +++ b/source/_integrations/light.mqtt.markdown @@ -1,14 +1,14 @@ --- title: "MQTT Light" description: "Instructions on how to setup MQTT lights using default schema within Home Assistant." -logo: mqtt.png ha_category: - Light ha_iot_class: Configurable ha_release: 0.8 +ha_domain: mqtt --- -The `mqtt` light platform lets you control your MQTT enabled lights through one of the supported message schemas. +The `mqtt` light platform lets you control your MQTT enabled lights through one of the supported message schemas, `default`, `json` or `template`. ## Comparison of light MQTT schemas @@ -45,25 +45,16 @@ light: ``` {% configuration %} -name: - description: The name of the light. +availability_topic: + description: The MQTT topic subscribed to receive availability (online/offline) updates. required: false type: string - default: MQTT Light -unique_id: - description: An ID that uniquely identifies this light. If two lights have the same unique ID, Home Assistant will raise an exception. - required: false - type: string -command_topic: - description: The MQTT topic to publish commands to change the switch state. - required: true - type: string brightness_command_topic: description: The MQTT topic to publish commands to change the light’s brightness. required: false type: string brightness_scale: - description: "Defines the maximum brightness value (i.e. 100%) of the MQTT device." + description: "Defines the maximum brightness value (i.e., 100%) of the MQTT device." required: false type: integer default: 255 @@ -91,10 +82,47 @@ color_temp_value_template: description: "Defines a [template](/docs/configuration/templating/#processing-incoming-data) to extract the color temperature value." required: false type: string +command_topic: + description: The MQTT topic to publish commands to change the switch state. + required: true + type: string +device: + description: 'Information about the device this light is a part of to tie it into the [device registry](https://developers.home-assistant.io/docs/en/device_registry_index.html). Only works through [MQTT discovery](/docs/mqtt/discovery/) and when [`unique_id`](#unique_id) is set.' + required: false + type: map + keys: + connections: + description: 'A list of connections of the device to the outside world as a list of tuples `[connection_type, connection_identifier]`. For example the MAC address of a network interface: `"connections": [["mac", "02:5b:26:a8:dc:12"]]`.' + required: false + type: list + identifiers: + description: 'A list of IDs that uniquely identify the device. For example a serial number.' + required: false + type: [string, list] + manufacturer: + description: 'The manufacturer of the device.' + required: false + type: string + model: + description: 'The model of the device.' + required: false + type: string + name: + description: 'The name of the device.' + required: false + type: string + sw_version: + description: 'The firmware version of the device.' + required: false + type: string effect_command_topic: description: "The MQTT topic to publish commands to change the light's effect state." required: false type: string +effect_list: + description: The list of effects the light supports. + required: false + type: [string, list] effect_state_topic: description: The MQTT topic subscribed to receive effect state updates. required: false @@ -103,10 +131,6 @@ effect_value_template: description: "Defines a [template](/docs/configuration/templating/#processing-incoming-data) to extract the effect value." required: false type: string -effect_list: - description: The list of effects the light supports. - required: false - type: [string, list] hs_command_topic: description: "The MQTT topic to publish commands to change the light's color state in HS format (Hue Saturation). Range for Hue: 0° .. 360°, Range of Saturation: 0..100. @@ -122,6 +146,19 @@ hs_value_template: description: "Defines a [template](/docs/configuration/templating/#processing-incoming-data) to extract the HS value." required: false type: string +json_attributes_template: + description: "Defines a [template](/docs/configuration/templating/#processing-incoming-data) to extract the JSON dictionary from messages received on the `json_attributes_topic`. Usage example can be found in [MQTT sensor](/integrations/sensor.mqtt/#json-attributes-template-configuration) documentation." + required: false + type: template +json_attributes_topic: + description: The MQTT topic subscribed to receive a JSON dictionary payload and then set as sensor attributes. Usage example can be found in [MQTT sensor](/integrations/sensor.mqtt/#json-attributes-topic-configuration) documentation. + required: false + type: string +name: + description: The name of the light. + required: false + type: string + default: MQTT Light on_command_type: description: "Defines when on the payload_on is sent. Using `last` (the default) will send any style (brightness, color, etc) topics first and then a `payload_on` to the `command_topic`. Using `first` will send the `payload_on` and then any style topics. Using `brightness` will only send brightness commands instead of the `payload_on` to turn the light on." required: false @@ -131,16 +168,26 @@ optimistic: required: false type: boolean default: "`true` if no state topic defined, else `false`." -payload_on: - description: The payload that represents enabled state. +payload_available: + description: The payload that represents the available state. required: false type: string - default: "ON" + default: online +payload_not_available: + description: The payload that represents the unavailable state. + required: false + type: string + default: offline payload_off: description: The payload that represents disabled state. required: false type: string default: "OFF" +payload_on: + description: The payload that represents enabled state. + required: false + type: string + default: "ON" qos: description: The maximum QoS level of the state topic. required: false @@ -167,6 +214,11 @@ rgb_value_template: description: "Defines a [template](/docs/configuration/templating/#processing-incoming-data) to extract the RGB value." required: false type: string +schema: + description: The schema to use. Must be `default` or omitted to select the default schema". + required: false + type: string + default: default state_topic: description: The MQTT topic subscribed to receive state updates. required: false @@ -175,12 +227,16 @@ state_value_template: description: "Defines a [template](/docs/configuration/templating/#processing-incoming-data) to extract the state value. The template should match the payload `on` and `off` values, so if your light uses `power on` to turn on, your `state_value_template` string should return `power on` when the switch is on. For example if the message is just `on`, your `state_value_template` should be `power {{ value }}`." required: false type: string +unique_id: + description: An ID that uniquely identifies this light. If two lights have the same unique ID, Home Assistant will raise an exception. + required: false + type: string white_value_command_topic: description: "The MQTT topic to publish commands to change the light's white value." required: false type: string white_value_scale: - description: "Defines the maximum white value (i.e. 100%) of the MQTT device." + description: "Defines the maximum white value (i.e., 100%) of the MQTT device." required: false type: integer default: 255 @@ -204,57 +260,6 @@ xy_value_template: description: "Defines a [template](/docs/configuration/templating/#processing-incoming-data) to extract the XY value." required: false type: string -availability_topic: - description: The MQTT topic subscribed to receive availability (online/offline) updates. - required: false - type: string -payload_available: - description: The payload that represents the available state. - required: false - type: string - default: online -payload_not_available: - description: The payload that represents the unavailable state. - required: false - type: string - default: offline -json_attributes_topic: - description: The MQTT topic subscribed to receive a JSON dictionary payload and then set as sensor attributes. Usage example can be found in [MQTT sensor](/integrations/sensor.mqtt/#json-attributes-topic-configuration) documentation. - required: false - type: string -json_attributes_template: - description: "Defines a [template](/docs/configuration/templating/#processing-incoming-data) to extract the JSON dictionary from messages received on the `json_attributes_topic`. Usage example can be found in [MQTT sensor](/integrations/sensor.mqtt/#json-attributes-template-configuration) documentation." - required: false - type: template -device: - description: 'Information about the device this light is a part of to tie it into the [device registry](https://developers.home-assistant.io/docs/en/device_registry_index.html). Only works through [MQTT discovery](/docs/mqtt/discovery/) and when [`unique_id`](#unique_id) is set.' - required: false - type: map - keys: - identifiers: - description: 'A list of IDs that uniquely identify the device. For example a serial number.' - required: false - type: [string, list] - connections: - description: 'A list of connections of the device to the outside world as a list of tuples `[connection_type, connection_identifier]`. For example the MAC address of a network interface: `"connections": [["mac", "02:5b:26:a8:dc:12"]]`.' - required: false - type: list - manufacturer: - description: 'The manufacturer of the device.' - required: false - type: string - model: - description: 'The model of the device.' - required: false - type: string - name: - description: 'The name of the device.' - required: false - type: string - sw_version: - description: 'The firmware version of the device.' - required: false - type: string {% endconfiguration %}
    @@ -382,26 +387,17 @@ light: ``` {% configuration %} -name: - description: The name of the light. +availability_topic: + description: The MQTT topic subscribed to receive availability (online/offline) updates. required: false type: string - default: MQTT JSON Light -unique_id: - description: An ID that uniquely identifies this light. If two lights have the same unique ID, Home Assistant will raise an exception. - required: false - type: string -command_topic: - description: The MQTT topic to publish commands to change the light’s state. - required: true - type: string brightness: description: Flag that defines if the light supports brightness. required: false type: boolean default: false brightness_scale: - description: "Defines the maximum brightness value (i.e. 100%) of the MQTT device." + description: "Defines the maximum brightness value (i.e., 100%) of the MQTT device." required: false type: integer default: 255 @@ -410,6 +406,39 @@ color_temp: required: false type: boolean default: false +command_topic: + description: The MQTT topic to publish commands to change the light’s state. + required: true + type: string +device: + description: 'Information about the device this light is a part of to tie it into the [device registry](https://developers.home-assistant.io/docs/en/device_registry_index.html). Only works through [MQTT discovery](/docs/mqtt/discovery/) and when [`unique_id`](#unique_id) is set.' + required: false + type: map + keys: + connections: + description: 'A list of connections of the device to the outside world as a list of tuples `[connection_type, connection_identifier]`. For example the MAC address of a network interface: `"connections": [["mac", "02:5b:26:a8:dc:12"]]`.' + required: false + type: list + identifiers: + description: 'A list of IDs that uniquely identify the device. For example a serial number.' + required: false + type: [string, list] + manufacturer: + description: 'The manufacturer of the device.' + required: false + type: string + model: + description: 'The model of the device.' + required: false + type: string + name: + description: 'The name of the device.' + required: false + type: string + sw_version: + description: 'The firmware version of the device.' + required: false + type: string effect: description: Flag that defines if the light supports effects. required: false @@ -429,11 +458,39 @@ flash_time_short: required: false type: integer default: 2 +hs: + description: Flag that defines if the light supports HS colors. + required: false + type: boolean + default: false +json_attributes_template: + description: "Defines a [template](/docs/configuration/templating/#processing-incoming-data) to extract the JSON dictionary from messages received on the `json_attributes_topic`. Usage example can be found in [MQTT sensor](/integrations/sensor.mqtt/#json-attributes-template-configuration) documentation." + required: false + type: template +json_attributes_topic: + description: The MQTT topic subscribed to receive a JSON dictionary payload and then set as sensor attributes. Usage example can be found in [MQTT sensor](/integrations/sensor.mqtt/#json-attributes-topic-configuration) documentation. + required: false + type: string +name: + description: The name of the light. + required: false + type: string + default: MQTT JSON Light optimistic: description: Flag that defines if the light works in optimistic mode. required: false type: boolean default: "`true` if no state topic defined, else `false`." +payload_available: + description: The payload that represents the available state. + required: false + type: string + default: online +payload_not_available: + description: The payload that represents the unavailable state. + required: false + type: string + default: offline qos: description: The maximum QoS level of the state topic. required: false @@ -449,10 +506,19 @@ rgb: required: false type: boolean default: false +schema: + description: The schema to use. Must be `json` to select the JSON schema". + required: false + type: string + default: default state_topic: description: The MQTT topic subscribed to receive state updates. required: false type: string +unique_id: + description: An ID that uniquely identifies this light. If two lights have the same unique ID, Home Assistant will raise an exception. + required: false + type: string white_value: description: Flag that defines if the light supports white values. required: false @@ -463,62 +529,6 @@ xy: required: false type: boolean default: false -hs: - description: Flag that defines if the light supports HS colors. - required: false - type: boolean - default: false -availability_topic: - description: The MQTT topic subscribed to receive availability (online/offline) updates. - required: false - type: string -payload_available: - description: The payload that represents the available state. - required: false - type: string - default: online -payload_not_available: - description: The payload that represents the unavailable state. - required: false - type: string - default: offline -json_attributes_topic: - description: The MQTT topic subscribed to receive a JSON dictionary payload and then set as sensor attributes. Usage example can be found in [MQTT sensor](/integrations/sensor.mqtt/#json-attributes-topic-configuration) documentation. - required: false - type: string -json_attributes_template: - description: "Defines a [template](/docs/configuration/templating/#processing-incoming-data) to extract the JSON dictionary from messages received on the `json_attributes_topic`. Usage example can be found in [MQTT sensor](/integrations/sensor.mqtt/#json-attributes-template-configuration) documentation." - required: false - type: template -device: - description: 'Information about the device this light is a part of to tie it into the [device registry](https://developers.home-assistant.io/docs/en/device_registry_index.html). Only works through [MQTT discovery](/docs/mqtt/discovery/) and when [`unique_id`](#unique_id) is set.' - required: false - type: map - keys: - identifiers: - description: 'A list of IDs that uniquely identify the device. For example a serial number.' - required: false - type: [string, list] - connections: - description: 'A list of connections of the device to the outside world as a list of tuples `[connection_type, connection_identifier]`. For example the MAC address of a network interface: `"connections": [["mac", "02:5b:26:a8:dc:12"]]`.' - required: false - type: list - manufacturer: - description: 'The manufacturer of the device.' - required: false - type: string - model: - description: 'The model of the device.' - required: false - type: string - name: - description: 'The name of the device.' - required: false - type: string - sw_version: - description: 'The firmware version of the device.' - required: false - type: string {% endconfiguration %}
    @@ -655,7 +665,7 @@ light: ## Template schema The `mqtt` light platform with template schema lets you control a MQTT-enabled light that receive commands on a command topic and optionally sends status update on a state topic. -It is format-agnostic so you can use any data format you want (i.e. string, JSON), just configure it with templating. +It is format-agnostic so you can use any data format you want (i.e., string, JSON), just configure it with templating. This schema supports on/off, brightness, RGB colors, XY colors, color temperature, transitions, short/long flashing, effects and white values. @@ -678,112 +688,47 @@ light: ``` {% configuration %} -name: - description: The name of the light. - required: false - type: string - default: MQTT Template Light -unique_id: - description: An ID that uniquely identifies this light. If two lights have the same unique ID, Home Assistant will raise an exception. - required: false - type: string -effect_list: - description: List of possible effects. - required: false - type: [string, list] -command_topic: - description: The MQTT topic to publish commands to change the light’s state. - required: true - type: string -state_topic: - description: The MQTT topic subscribed to receive state updates. - required: false - type: string -command_on_template: - description: "The [template](/docs/configuration/templating/#processing-incoming-data) for *on* state changes. Available variables: `state`, `brightness`, `red`, `green`, `blue`, `white_value`, `flash`, `transition` and `effect`." - required: true - type: string -command_off_template: - description: "The [template](/docs/configuration/templating/#processing-incoming-data) for *off* state changes. Available variables: `state` and `transition`." - required: true - type: string -state_template: - description: "[Template](/docs/configuration/templating/#processing-incoming-data) to extract state from the state payload value." - required: false - type: string -brightness_template: - description: "[Template](/docs/configuration/templating/#processing-incoming-data) to extract brightness from the state payload value." - required: false - type: string -red_template: - description: "[Template](/docs/configuration/templating/#processing-incoming-data) to extract red color from the state payload value." - required: false - type: string -green_template: - description: "[Template](/docs/configuration/templating/#processing-incoming-data) to extract green color from the state payload value." +availability_topic: + description: The MQTT topic subscribed to receive availability (online/offline) updates. required: false type: string blue_template: description: "[Template](/docs/configuration/templating/#processing-incoming-data) to extract blue color from the state payload value." required: false type: string +brightness_template: + description: "[Template](/docs/configuration/templating/#processing-incoming-data) to extract brightness from the state payload value." + required: false + type: string color_temp_template: description: "[Template](/docs/configuration/templating/#processing-incoming-data) to extract color temperature from the state payload value." required: false type: string -effect_template: - description: "[Template](/docs/configuration/templating/#processing-incoming-data) to extract effect from the state payload value." - required: false +command_off_template: + description: "The [template](/docs/configuration/templating/#processing-incoming-data) for *off* state changes. Available variables: `state` and `transition`." + required: true type: string -white_value_template: - description: "[Template](/docs/configuration/templating/#processing-incoming-data) to extract white value from the state payload value." - required: false +command_on_template: + description: "The [template](/docs/configuration/templating/#processing-incoming-data) for *on* state changes. Available variables: `state`, `brightness`, `red`, `green`, `blue`, `white_value`, `flash`, `transition` and `effect`." + required: true type: string -optimistic: - description: Flag that defines if the light works in optimistic mode. - required: false +command_topic: + description: The MQTT topic to publish commands to change the light’s state. + required: true type: string - default: "`true` if no state topic or state template is defined, else `false`." -qos: - description: The maximum QoS level of the state topic. - required: false - type: integer - default: 0 -availability_topic: - description: The MQTT topic subscribed to receive availability (online/offline) updates. - required: false - type: string -payload_available: - description: The payload that represents the available state. - required: false - type: string - default: online -payload_not_available: - description: The payload that represents the unavailable state. - required: false - type: string - default: offline -json_attributes_topic: - description: The MQTT topic subscribed to receive a JSON dictionary payload and then set as sensor attributes. Usage example can be found in [MQTT sensor](/integrations/sensor.mqtt/#json-attributes-topic-configuration) documentation. - required: false - type: string -json_attributes_template: - description: "Defines a [template](/docs/configuration/templating/#processing-incoming-data) to extract the JSON dictionary from messages received on the `json_attributes_topic`. Usage example can be found in [MQTT sensor](/integrations/sensor.mqtt/#json-attributes-template-configuration) documentation." - required: false - type: template device: description: 'Information about the device this light is a part of to tie it into the [device registry](https://developers.home-assistant.io/docs/en/device_registry_index.html). Only works through [MQTT discovery](/docs/mqtt/discovery/) and when [`unique_id`](#unique_id) is set.' required: false type: map keys: - identifiers: - description: 'A list of IDs that uniquely identify the device. For example a serial number.' - required: false - type: [string, list] connections: description: 'A list of connections of the device to the outside world as a list of tuples `[connection_type, connection_identifier]`. For example the MAC address of a network interface: `"connections": [["mac", "02:5b:26:a8:dc:12"]]`.' required: false type: list + identifiers: + description: 'A list of IDs that uniquely identify the device. For example a serial number.' + required: false + type: [string, list] manufacturer: description: 'The manufacturer of the device.' required: false @@ -800,6 +745,76 @@ device: description: 'The firmware version of the device.' required: false type: string +effect_list: + description: List of possible effects. + required: false + type: [string, list] +effect_template: + description: "[Template](/docs/configuration/templating/#processing-incoming-data) to extract effect from the state payload value." + required: false + type: string +green_template: + description: "[Template](/docs/configuration/templating/#processing-incoming-data) to extract green color from the state payload value." + required: false + type: string +json_attributes_template: + description: "Defines a [template](/docs/configuration/templating/#processing-incoming-data) to extract the JSON dictionary from messages received on the `json_attributes_topic`. Usage example can be found in [MQTT sensor](/integrations/sensor.mqtt/#json-attributes-template-configuration) documentation." + required: false + type: template +json_attributes_topic: + description: The MQTT topic subscribed to receive a JSON dictionary payload and then set as sensor attributes. Usage example can be found in [MQTT sensor](/integrations/sensor.mqtt/#json-attributes-topic-configuration) documentation. + required: false + type: string +name: + description: The name of the light. + required: false + type: string + default: MQTT Template Light +optimistic: + description: Flag that defines if the light works in optimistic mode. + required: false + type: string + default: "`true` if no state topic or state template is defined, else `false`." +payload_available: + description: The payload that represents the available state. + required: false + type: string + default: online +payload_not_available: + description: The payload that represents the unavailable state. + required: false + type: string + default: offline +qos: + description: The maximum QoS level of the state topic. + required: false + type: integer + default: 0 +red_template: + description: "[Template](/docs/configuration/templating/#processing-incoming-data) to extract red color from the state payload value." + required: false + type: string +schema: + description: The schema to use. Must be `template` to select the template schema". + required: false + type: string + default: default +state_template: + description: "[Template](/docs/configuration/templating/#processing-incoming-data) to extract state from the state payload value." + required: false + type: string +state_topic: + description: The MQTT topic subscribed to receive state updates. + required: false + type: string +unique_id: + description: An ID that uniquely identifies this light. If two lights have the same unique ID, Home Assistant will raise an exception. + required: false + type: string +white_value_template: + description: "[Template](/docs/configuration/templating/#processing-incoming-data) to extract white value from the state payload value." + required: false + type: string {% endconfiguration %}
    diff --git a/source/_integrations/light.mysensors.markdown b/source/_integrations/light.mysensors.markdown index 8d3ff74d05e..468a7c6a420 100644 --- a/source/_integrations/light.mysensors.markdown +++ b/source/_integrations/light.mysensors.markdown @@ -1,12 +1,12 @@ --- title: "MySensors Light" description: "Instructions on how to integrate MySensors lights into Home Assistant." -logo: mysensors.png ha_category: - DIY - Light ha_release: 0.13 ha_iot_class: Local Push +ha_domain: mysensors --- Integrates MySensors lights into Home Assistant. See the [main integration](/integrations/mysensors/) for configuration instructions. diff --git a/source/_integrations/light.rflink.markdown b/source/_integrations/light.rflink.markdown index 98852be2d27..89170dc512f 100644 --- a/source/_integrations/light.rflink.markdown +++ b/source/_integrations/light.rflink.markdown @@ -6,6 +6,7 @@ ha_category: - Light ha_release: 0.38 ha_iot_class: Assumed State +ha_domain: rflink --- The `rflink` integration supports devices that use [RFLink gateway firmware](http://www.nemcon.nl/blog2/), for example the [Nodo RFLink Gateway](https://www.nodo-shop.nl/nl/21-rflink-gateway). RFLink gateway is an Arduino firmware that allows two-way communication with a multitude of RF wireless devices using cheap hardware (Arduino + transceiver). diff --git a/source/_integrations/light.rfxtrx.markdown b/source/_integrations/light.rfxtrx.markdown index 0fb5be5b2c9..9a782a63764 100644 --- a/source/_integrations/light.rfxtrx.markdown +++ b/source/_integrations/light.rfxtrx.markdown @@ -1,11 +1,11 @@ --- title: "RFXtrx Light" description: "Instructions on how to integrate RFXtrx lights into Home Assistant." -logo: rfxtrx.png ha_category: - Light ha_release: 0.7.5 ha_iot_class: Assumed State +ha_domain: rfxtrx --- The `rfxtrx` platform support lights that communicate in the frequency range of 433.92 MHz. diff --git a/source/_integrations/light.switch.markdown b/source/_integrations/light.switch.markdown index 95ff6a8d4e2..4b6457b8c51 100644 --- a/source/_integrations/light.switch.markdown +++ b/source/_integrations/light.switch.markdown @@ -5,8 +5,8 @@ ha_category: - Light ha_release: 0.83 ha_iot_class: Local Push -logo: home-assistant.png ha_quality_scale: internal +ha_domain: light --- The light switch platform lets you control an existing switch, allowing you diff --git a/source/_integrations/light.template.markdown b/source/_integrations/light.template.markdown index 1fd33225e13..9ed60901d72 100644 --- a/source/_integrations/light.template.markdown +++ b/source/_integrations/light.template.markdown @@ -5,8 +5,8 @@ ha_category: - Light ha_release: 0.46 ha_iot_class: Local Push -logo: home-assistant.png ha_quality_scale: internal +ha_domain: template --- The `template` platform creates lights that combine integrations and provides the @@ -90,7 +90,7 @@ light: type: template default: optimistic icon_template: - description: Defines a template for an icon or picture, e.g. showing a different icon for different states. + description: Defines a template for an icon or picture, e.g., showing a different icon for different states. required: false type: template availability_template: diff --git a/source/_integrations/light.xiaomi_aqara.markdown b/source/_integrations/light.xiaomi_aqara.markdown index cbf96cf2f6e..4989d4c6cf0 100644 --- a/source/_integrations/light.xiaomi_aqara.markdown +++ b/source/_integrations/light.xiaomi_aqara.markdown @@ -1,11 +1,11 @@ --- title: "Xiaomi Light" description: "Instructions on how to setup the Xiaomi light within Home Assistant." -logo: xiaomi.png ha_category: - Light ha_release: "0.50" ha_iot_class: Local Push +ha_domain: xiaomi_aqara --- diff --git a/source/_integrations/light.xiaomi_miio.markdown b/source/_integrations/light.xiaomi_miio.markdown index 27484aa390a..833d6dceb5f 100644 --- a/source/_integrations/light.xiaomi_miio.markdown +++ b/source/_integrations/light.xiaomi_miio.markdown @@ -1,11 +1,11 @@ --- title: "Xiaomi Philips Light" description: "Instructions on how to integrate your Xiaomi Philips Lights within Home Assistant." -logo: philips.png ha_category: - Light ha_iot_class: Local Polling ha_release: 0.53 +ha_domain: xiaomi_miio --- The `xiaomi_miio` platform allows you to control the state of your Xiaomi Philips LED Ball Lamp, Xiaomi Philips Zhirui LED Bulb E14 Candle Lamp, Xiaomi Philips Zhirui Downlight, Xiaomi Philips LED Ceiling Lamp, Xiaomi Philips Eyecare Lamp 2, Xiaomi Philips Moonlight Bedside Lamp and Philips Zhirui Desk Lamp. diff --git a/source/_integrations/lightwave.markdown b/source/_integrations/lightwave.markdown index 264e2ec0eb4..e0c3fc38514 100644 --- a/source/_integrations/lightwave.markdown +++ b/source/_integrations/lightwave.markdown @@ -8,6 +8,7 @@ ha_category: - Switch ha_release: 0.84 ha_iot_class: Assumed State +ha_domain: lightwave --- The `lightwave` integration links Home Assistant with your Lightwave WiFi link for controlling Lightwave lights and switches. diff --git a/source/_integrations/limitlessled.markdown b/source/_integrations/limitlessled.markdown index fe19d1cd0c1..d94d5800f9d 100644 --- a/source/_integrations/limitlessled.markdown +++ b/source/_integrations/limitlessled.markdown @@ -6,6 +6,7 @@ ha_category: - Light ha_iot_class: Assumed State ha_release: pre 0.7 +ha_domain: limitlessled --- `limitlessled` can control your LimitlessLED lights from within Home Assistant. The lights are also known as EasyBulb, AppLight, AppLamp, MiLight, LEDme, dekolight, or iLight. diff --git a/source/_integrations/linksys_smart.markdown b/source/_integrations/linksys_smart.markdown index b7c9b6ae913..db84d987931 100644 --- a/source/_integrations/linksys_smart.markdown +++ b/source/_integrations/linksys_smart.markdown @@ -5,6 +5,7 @@ ha_category: - Presence Detection logo: linksys.png ha_release: 0.48 +ha_domain: linksys_smart --- The `linksys_smart` platform offers presence detection by looking at connected devices to a Linksys Smart Wi-Fi based router. diff --git a/source/_integrations/linky.markdown b/source/_integrations/linky.markdown index 913563e68eb..7361f19dc45 100644 --- a/source/_integrations/linky.markdown +++ b/source/_integrations/linky.markdown @@ -1,7 +1,6 @@ --- title: Enedis Linky description: Instructions on how to integrate Linky consumption data within Home Assistant. -logo: enedis.png ha_release: 0.79 ha_category: - Energy @@ -10,6 +9,7 @@ ha_iot_class: Cloud Polling ha_config_flow: true ha_codeowners: - '@Quentame' +ha_domain: linky --- The `linky` sensor platform is retrieving the consumption of your home from the [Linky electric meter](https://www.enedis.fr/linky-compteur-communicant). diff --git a/source/_integrations/linode.markdown b/source/_integrations/linode.markdown index 281c12f5ebe..cefdb5e8a7f 100644 --- a/source/_integrations/linode.markdown +++ b/source/_integrations/linode.markdown @@ -8,6 +8,7 @@ ha_category: logo: linode.png ha_release: 0.57 ha_iot_class: Cloud Polling +ha_domain: linode --- The `linode` integration allows you to access the information about your [Linode](https://linode.com) systems from Home Assistant. diff --git a/source/_integrations/linux_battery.markdown b/source/_integrations/linux_battery.markdown index 2fe86fbe4a5..e12d119bccc 100644 --- a/source/_integrations/linux_battery.markdown +++ b/source/_integrations/linux_battery.markdown @@ -8,6 +8,7 @@ ha_release: 0.28 ha_iot_class: Local Polling ha_codeowners: - '@fabaff' +ha_domain: linux_battery --- The `linux_battery` sensor platform is using the information stored in `/sys/class/power_supply/` on your local Linux system to display details about the current state of your battery. diff --git a/source/_integrations/lirc.markdown b/source/_integrations/lirc.markdown index 630f429501b..16352ee4862 100644 --- a/source/_integrations/lirc.markdown +++ b/source/_integrations/lirc.markdown @@ -6,6 +6,7 @@ ha_category: - Automation ha_release: 0.21 ha_iot_class: Local Push +ha_domain: lirc --- [LIRC](http://www.lirc.org/) integration for Home Assistant allows you to receive signals from an infrared remote control and control actions based on the buttons you press. You can use them to set scenes or trigger any other [automation](/integrations/automation/). diff --git a/source/_integrations/litejet.markdown b/source/_integrations/litejet.markdown index fb6b8c9fadc..751bdbeb688 100644 --- a/source/_integrations/litejet.markdown +++ b/source/_integrations/litejet.markdown @@ -1,13 +1,13 @@ --- title: LiteJet description: Instructions on how to setup the LiteJet hub within Home Assistant. -logo: centralite.svg ha_category: - Light - Scene - Switch ha_iot_class: Local Push ha_release: 0.32 +ha_domain: litejet --- LiteJet is a centralized lighting system that predates most home automation technology. All lights and wall switches are wired to a central panel. This central panel has a serial port interface that allows a computer to control the system via LiteJet's third party protocol. diff --git a/source/_integrations/llamalab_automate.markdown b/source/_integrations/llamalab_automate.markdown index 5b082e41200..6e367dd1a7f 100644 --- a/source/_integrations/llamalab_automate.markdown +++ b/source/_integrations/llamalab_automate.markdown @@ -1,10 +1,10 @@ --- title: LlamaLab Automate description: Instructions on how to add user notifications to Home Assistant. -logo: llamalab_automate.png ha_category: - Notifications ha_release: 0.27 +ha_domain: llamalab_automate --- The `llamalab_automate` platform uses Googles Cloud Messaging Services to push messages from Home Assistant to your Android device running the LlamaLab [Automate](https://llamalab.com/automate/) app. This can serve as an alternative to Tasker + AutoRemote. diff --git a/source/_integrations/local_file.markdown b/source/_integrations/local_file.markdown index 71830eb98b1..c1437eb277a 100644 --- a/source/_integrations/local_file.markdown +++ b/source/_integrations/local_file.markdown @@ -1,11 +1,11 @@ --- title: Local File description: Instructions how to use Local File as a Camera within Home Assistant. -logo: file.png ha_category: - Camera ha_iot_class: Local Polling ha_release: 0.22 +ha_domain: local_file --- The `local_file` camera platform allows you to integrate an image file from disk into Home Assistant as a camera. If the image is updated on the file system the image displayed in Home Assistant will also be updated. The service `local_file_update_file_path` can be used to update the image using an automation. diff --git a/source/_integrations/local_ip.markdown b/source/_integrations/local_ip.markdown index 239f72650b6..d6d12b3623d 100644 --- a/source/_integrations/local_ip.markdown +++ b/source/_integrations/local_ip.markdown @@ -1,7 +1,6 @@ --- title: Local IP Address description: Instructions on how to integrate the Local IP Address sensor into Home Assistant. -logo: home-assistant.png ha_category: - Network ha_iot_class: Local Polling @@ -9,6 +8,7 @@ ha_release: 0.104 ha_config_flow: true ha_codeowners: - '@issacg' +ha_domain: local_ip --- The `local_ip` sensor will expose the local (LAN) IP address of your Home Assistant instance. This can be useful when your instance has a static public hostname (for example, if you use the Nabu Casa service), but have a dynamically allocated local LAN address (for example, configured via DHCP). diff --git a/source/_integrations/locative.md b/source/_integrations/locative.md index e8fcfd49e7d..e07784c7914 100644 --- a/source/_integrations/locative.md +++ b/source/_integrations/locative.md @@ -6,6 +6,7 @@ ha_category: - Presence Detection ha_release: 0.86 ha_iot_class: Cloud Push +ha_domain: locative --- This platform allows you to detect presence using [Locative](https://www.locative.io/). Locative is an open source app for [iOS](https://apps.apple.com/us/app/locative/id725198453?ign-mpt=uo%3D4) that allows users to set up a `GET` or `POST` request when a geofence is entered or exited. This can be configured with Home Assistant to update your location. diff --git a/source/_integrations/lock.markdown b/source/_integrations/lock.markdown index 3e963d1cac2..187ce2f915f 100644 --- a/source/_integrations/lock.markdown +++ b/source/_integrations/lock.markdown @@ -1,11 +1,11 @@ --- title: Lock description: Instructions on how to setup your locks with Home Assistant. -logo: home-assistant.png ha_category: - Lock ha_release: 0.9 ha_quality_scale: internal +ha_domain: lock --- Keeps track which locks are in your environment, their state and allows you to control them. diff --git a/source/_integrations/lock.mqtt.markdown b/source/_integrations/lock.mqtt.markdown index 54ff19b31a4..f4eae2dc7ee 100644 --- a/source/_integrations/lock.mqtt.markdown +++ b/source/_integrations/lock.mqtt.markdown @@ -1,11 +1,11 @@ --- title: "MQTT Lock" description: "Instructions on how to integrate MQTT locks into Home Assistant." -logo: mqtt.png ha_category: - Lock ha_release: 0.15 ha_iot_class: Configurable +ha_domain: mqtt --- The `mqtt` lock platform lets you control your MQTT enabled locks. @@ -28,97 +28,27 @@ lock: ``` {% configuration %} -command_topic: - description: The MQTT topic to publish commands to change the lock state. - required: true - type: string -state_topic: - description: The MQTT topic subscribed to receive state updates. - required: false - type: string -name: - description: The name of the lock. - required: false - type: string - default: MQTT Lock -payload_lock: - description: The payload that represents enabled/locked state. - required: false - type: string - default: LOCK -payload_unlock: - description: The payload that represents disabled/unlocked state. - required: false - type: string - default: UNLOCK -state_locked: - description: The value that represents the lock to be in locked state - required: false - type: string - default: LOCKED -state_unlocked: - description: The value that represents the lock to be in unlocked state - required: false - type: string - default: UNLOCKED -optimistic: - description: Flag that defines if lock works in optimistic mode. - required: false - type: string - default: "`true` if no `state_topic` defined, else `false`." -qos: - description: The maximum QoS level of the state topic. - required: false - type: integer - default: 0 -retain: - description: If the published message should have the retain flag on or not. - required: false - type: boolean - default: false -value_template: - description: "Defines a [template](/docs/configuration/templating/#processing-incoming-data) to extract a value from the payload." - required: false - type: string availability_topic: description: The MQTT topic subscribed to receive availability (online/offline) updates. required: false type: string -payload_available: - description: The payload that represents the available state. - required: false +command_topic: + description: The MQTT topic to publish commands to change the lock state. + required: true type: string - default: online -payload_not_available: - description: The payload that represents the unavailable state. - required: false - type: string - default: offline -json_attributes_topic: - description: The MQTT topic subscribed to receive a JSON dictionary payload and then set as sensor attributes. Usage example can be found in [MQTT sensor](/integrations/sensor.mqtt/#json-attributes-topic-configuration) documentation. - required: false - type: string -json_attributes_template: - description: "Defines a [template](/docs/configuration/templating/#processing-incoming-data) to extract the JSON dictionary from messages received on the `json_attributes_topic`. Usage example can be found in [MQTT sensor](/integrations/sensor.mqtt/#json-attributes-template-configuration) documentation." - required: false - type: template -unique_id: - description: An ID that uniquely identifies this lock. If two locks have the same unique ID, Home Assistant will raise an exception. - required: false - type: string device: description: 'Information about the device this lock is a part of to tie it into the [device registry](https://developers.home-assistant.io/docs/en/device_registry_index.html). Only works through [MQTT discovery](/docs/mqtt/discovery/) and when [`unique_id`](#unique_id) is set.' required: false type: map keys: - identifiers: - description: 'A list of IDs that uniquely identify the device. For example a serial number.' - required: false - type: [string, list] connections: description: 'A list of connections of the device to the outside world as a list of tuples `[connection_type, connection_identifier]`. For example the MAC address of a network interface: `"connections": [["mac", "02:5b:26:a8:dc:12"]]`.' required: false type: list + identifiers: + description: 'A list of IDs that uniquely identify the device. For example a serial number.' + required: false + type: [string, list] manufacturer: description: 'The manufacturer of the device.' required: false @@ -135,6 +65,76 @@ device: description: 'The firmware version of the device.' required: false type: string +json_attributes_template: + description: "Defines a [template](/docs/configuration/templating/#processing-incoming-data) to extract the JSON dictionary from messages received on the `json_attributes_topic`. Usage example can be found in [MQTT sensor](/integrations/sensor.mqtt/#json-attributes-template-configuration) documentation." + required: false + type: template +json_attributes_topic: + description: The MQTT topic subscribed to receive a JSON dictionary payload and then set as sensor attributes. Usage example can be found in [MQTT sensor](/integrations/sensor.mqtt/#json-attributes-topic-configuration) documentation. + required: false + type: string +name: + description: The name of the lock. + required: false + type: string + default: MQTT Lock +optimistic: + description: Flag that defines if lock works in optimistic mode. + required: false + type: string + default: "`true` if no `state_topic` defined, else `false`." +payload_available: + description: The payload that represents the available state. + required: false + type: string + default: online +payload_lock: + description: The payload that represents enabled/locked state. + required: false + type: string + default: LOCK +payload_not_available: + description: The payload that represents the unavailable state. + required: false + type: string + default: offline +payload_unlock: + description: The payload that represents disabled/unlocked state. + required: false + type: string + default: UNLOCK +qos: + description: The maximum QoS level of the state topic. + required: false + type: integer + default: 0 +retain: + description: If the published message should have the retain flag on or not. + required: false + type: boolean + default: false +state_locked: + description: The value that represents the lock to be in locked state + required: false + type: string + default: LOCKED +state_topic: + description: The MQTT topic subscribed to receive state updates. + required: false + type: string +state_unlocked: + description: The value that represents the lock to be in unlocked state + required: false + type: string + default: UNLOCKED +unique_id: + description: An ID that uniquely identifies this lock. If two locks have the same unique ID, Home Assistant will raise an exception. + required: false + type: string +value_template: + description: "Defines a [template](/docs/configuration/templating/#processing-incoming-data) to extract a value from the payload." + required: false + type: string {% endconfiguration %}
    diff --git a/source/_integrations/lock.template.markdown b/source/_integrations/lock.template.markdown index 204df904ffe..81a597977ee 100644 --- a/source/_integrations/lock.template.markdown +++ b/source/_integrations/lock.template.markdown @@ -5,8 +5,8 @@ ha_category: - Lock ha_release: 0.81 ha_iot_class: Local Push -logo: home-assistant.png ha_quality_scale: internal +ha_domain: template --- The `template` platform creates locks that combines components. diff --git a/source/_integrations/lock.xiaomi_aqara.markdown b/source/_integrations/lock.xiaomi_aqara.markdown index 2e5773ea1d9..07ed1573f5d 100644 --- a/source/_integrations/lock.xiaomi_aqara.markdown +++ b/source/_integrations/lock.xiaomi_aqara.markdown @@ -1,11 +1,11 @@ --- title: "Xiaomi Aqara Lock" description: "Instructions on how to setup the Xiaomi Aqara Lock within Home Assistant." -logo: xiaomi.png ha_category: - Lock ha_release: 0.71 ha_iot_class: Local Push +ha_domain: xiaomi_aqara --- diff --git a/source/_integrations/lockitron.markdown b/source/_integrations/lockitron.markdown index 672801edf64..80e5224fe09 100644 --- a/source/_integrations/lockitron.markdown +++ b/source/_integrations/lockitron.markdown @@ -6,6 +6,7 @@ ha_category: - Lock ha_iot_class: Cloud Polling ha_release: 0.42 +ha_domain: lockitron --- The `lockitron` platform allows you to control your [Lockitron](https://lockitron.com/) lock from within Home Assistant. diff --git a/source/_integrations/logbook.markdown b/source/_integrations/logbook.markdown index 23d20b8c37b..69c0dafe39d 100644 --- a/source/_integrations/logbook.markdown +++ b/source/_integrations/logbook.markdown @@ -1,10 +1,10 @@ --- title: Logbook description: Instructions on how to enable the logbook integration for Home Assistant. -logo: logbook.png ha_category: - History ha_release: 0.7 +ha_domain: logbook --- @@ -65,7 +65,6 @@ logbook: - sensor.date domains: - sun - - weblink ``` In case you just want to see messages from some specific entities or domains use diff --git a/source/_integrations/logentries.markdown b/source/_integrations/logentries.markdown index bb4f4f7a4dc..ab62a2148df 100644 --- a/source/_integrations/logentries.markdown +++ b/source/_integrations/logentries.markdown @@ -1,10 +1,10 @@ --- title: Logentries description: Send events to Logentries. -logo: logentries.png ha_category: - History ha_release: 0.13 +ha_domain: logentries --- The `logentries` integration makes it possible to log all state changes to [Logentries](http://logentries.com/) using Logentries Webhook endpoint. diff --git a/source/_integrations/logger.markdown b/source/_integrations/logger.markdown index 38d2320776e..8bca5f4fcba 100644 --- a/source/_integrations/logger.markdown +++ b/source/_integrations/logger.markdown @@ -1,13 +1,13 @@ --- title: Logger description: Instructions on how to enable the logger integration for Home Assistant. -logo: home-assistant.png ha_category: - Utility ha_release: 0.8 ha_quality_scale: internal ha_codeowners: - '@home-assistant/core' +ha_domain: logger --- The `logger` integration lets you define the level of logging activities in Home diff --git a/source/_integrations/logi_circle.markdown b/source/_integrations/logi_circle.markdown index d7612456f05..e252a8d592d 100644 --- a/source/_integrations/logi_circle.markdown +++ b/source/_integrations/logi_circle.markdown @@ -1,7 +1,6 @@ --- title: Logi Circle description: Instructions on how to integrate your Logi Circle cameras within Home Assistant. -logo: logi_circle.png ha_category: - Camera - Sensor @@ -10,6 +9,7 @@ ha_iot_class: Cloud Polling ha_config_flow: true ha_codeowners: - '@evanjd' +ha_domain: logi_circle --- The `logi_circle` implementation allows you to integrate your [Logi Circle](https://circle.logi.com/) cameras in Home Assistant. To connect Logi Circle, you will have to [sign up for API access](#requesting-api-access) and get a `client_id`, `client_secret` and `api_key`. diff --git a/source/_integrations/london_air.markdown b/source/_integrations/london_air.markdown index 9a011d0e5ca..a658cd136df 100644 --- a/source/_integrations/london_air.markdown +++ b/source/_integrations/london_air.markdown @@ -1,11 +1,11 @@ --- title: London Air description: Display the current status of London air quality by area and pollution type. -logo: waqi.png ha_category: - Health ha_iot_class: Cloud Polling ha_release: 0.52 +ha_domain: london_air --- The `london_air` integration [queries](https://api.erg.kcl.ac.uk/AirQuality/Hourly/MonitoringIndex/GroupName=London/Json) the London air quality [data feed](https://www.londonair.org.uk/LondonAir/API/) provided by Kings College London. A single sensor will be added for each `location` ([local authority district or borough](https://en.wikipedia.org/wiki/List_of_London_boroughs)) specified in the configuration file. The state of each sensor is the overall air quality in that borough. Note that only 28 of the 32 boroughs have data available. diff --git a/source/_integrations/london_underground.markdown b/source/_integrations/london_underground.markdown index cb2e1ecdb23..fbbb898bafb 100644 --- a/source/_integrations/london_underground.markdown +++ b/source/_integrations/london_underground.markdown @@ -1,11 +1,11 @@ --- title: London Underground description: Display the current status of London underground & overground lines within Home Assistant. -logo: london_underground.png ha_category: - Transport ha_iot_class: Cloud Polling ha_release: 0.49 +ha_domain: london_underground --- The `london_underground` sensor will display the status of London underground lines, as well as the Overground, DLR and Tfl rail. diff --git a/source/_integrations/loopenergy.markdown b/source/_integrations/loopenergy.markdown index c56d4ef8fb4..30fc4c5e7fe 100644 --- a/source/_integrations/loopenergy.markdown +++ b/source/_integrations/loopenergy.markdown @@ -1,11 +1,11 @@ --- title: Loop Energy description: Instructions on how to integrate Loop Energy devices within Home Assistant. -logo: loop.png ha_category: - Energy ha_release: 0.17 ha_iot_class: Cloud Push +ha_domain: loopenergy --- Integrate your [Loop Energy](https://www.your-loop.com/) meter information into Home Assistant. To use this sensor you need the client serial number and secret keys for your devices. diff --git a/source/_integrations/luci.markdown b/source/_integrations/luci.markdown index 0b459c82500..61383e46d71 100644 --- a/source/_integrations/luci.markdown +++ b/source/_integrations/luci.markdown @@ -8,6 +8,7 @@ ha_release: pre 0.7 ha_codeowners: - '@fbradyirl' - '@mzdrale' +ha_domain: luci --- _This is one of multiple ways we support OpenWrt. For an overview, see [OpenWrt](/integrations/openwrt/)._ diff --git a/source/_integrations/luftdaten.markdown b/source/_integrations/luftdaten.markdown index b6f46f8cb81..442b57fd1b6 100644 --- a/source/_integrations/luftdaten.markdown +++ b/source/_integrations/luftdaten.markdown @@ -1,7 +1,6 @@ --- title: Luftdaten description: Instructions on how to setup Luftdaten sensors in Home Assistant. -logo: luftdaten.png ha_category: - Health - Sensor @@ -11,6 +10,7 @@ ha_config_flow: true ha_quality_scale: gold ha_codeowners: - '@fabaff' +ha_domain: luftdaten --- The `luftdaten` integration will query the open data API of [luftdaten.info](https://luftdaten.info/) to monitor air quality and other weather data from a specific (self build) sensor station. diff --git a/source/_integrations/lupusec.markdown b/source/_integrations/lupusec.markdown index fecabb37fce..86f9b84d3d8 100644 --- a/source/_integrations/lupusec.markdown +++ b/source/_integrations/lupusec.markdown @@ -11,6 +11,7 @@ ha_release: 0.83 ha_iot_class: Local Polling ha_codeowners: - '@majuss' +ha_domain: lupusec --- The `lupusec` integration allows the user to integrate their Lupusec alarm control panel and ultimately all connected sensors and other devices. For more information about the LUPUS-Electronics security system please visit their [website](https://www.lupus-electronics.de). diff --git a/source/_integrations/lutron.markdown b/source/_integrations/lutron.markdown index ae9988f9570..32237caff57 100644 --- a/source/_integrations/lutron.markdown +++ b/source/_integrations/lutron.markdown @@ -12,6 +12,7 @@ ha_release: 0.37 ha_iot_class: Local Polling ha_codeowners: - '@JonGilmore' +ha_domain: lutron --- [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` integration in Home Assistant is responsible for communicating with the main hub for these systems. diff --git a/source/_integrations/lutron_caseta.markdown b/source/_integrations/lutron_caseta.markdown index 3b35920e0f8..f087344f856 100644 --- a/source/_integrations/lutron_caseta.markdown +++ b/source/_integrations/lutron_caseta.markdown @@ -11,6 +11,7 @@ ha_category: - Fan ha_release: 0.41 ha_iot_class: Local Polling +ha_domain: lutron_caseta --- [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 and shades. diff --git a/source/_integrations/lw12wifi.markdown b/source/_integrations/lw12wifi.markdown index 3b1a10f1466..00baebaf9d6 100644 --- a/source/_integrations/lw12wifi.markdown +++ b/source/_integrations/lw12wifi.markdown @@ -6,6 +6,7 @@ ha_category: ha_iot_class: Local Polling logo: lagute.png ha_release: 0.71 +ha_domain: lw12wifi --- The `lw12wifi` light platform supports Lagute LW-12 Wifi LED controller. diff --git a/source/_integrations/lyft.markdown b/source/_integrations/lyft.markdown index 504e4174d27..afd295bd80c 100644 --- a/source/_integrations/lyft.markdown +++ b/source/_integrations/lyft.markdown @@ -1,11 +1,11 @@ --- title: Lyft description: How to integrate Lyft in Home Assistant -logo: lyft.png ha_category: - Transport ha_iot_class: Cloud Polling ha_release: 0.41 +ha_domain: lyft --- The `lyft` sensor will give you time and price estimates for all available [Lyft](https://lyft.com) products at the given `start_latitude` and `start_longitude`.The `ATTRIBUTES` are used to provide extra information about products, such as vehicle capacity and fare rates. If an `end_latitude` and `end_longitude` are specified, a price estimate will also be provided. One sensor will be created for each product at the given `start` location, for pickup time. A second sensor for each product, for estimated price, will be created if a destination is specified. The sensor is powered by the official Lyft [API](https://developer.lyft.com/reference/). diff --git a/source/_integrations/magicseaweed.markdown b/source/_integrations/magicseaweed.markdown index 5bd4da3446f..a1827e9ace7 100644 --- a/source/_integrations/magicseaweed.markdown +++ b/source/_integrations/magicseaweed.markdown @@ -6,6 +6,7 @@ ha_category: - Sensor ha_release: 0.75 ha_iot_class: Cloud Polling +ha_domain: magicseaweed --- The `magicseaweed` platform uses the [Magicseaweed Forecast API](https://magicseaweed.com/developer/forecast-api) as a source for surf forecasting data for the surf spots of your choice. diff --git a/source/_integrations/mailbox.markdown b/source/_integrations/mailbox.markdown index 5cf36250816..b59f062feb1 100644 --- a/source/_integrations/mailbox.markdown +++ b/source/_integrations/mailbox.markdown @@ -2,6 +2,7 @@ title: Mailbox description: Instructions on how to setup your mailboxes with Home Assistant. ha_release: 0.51 +ha_domain: mailbox --- Mailboxes provide a list of messages with short information about each. Mailbox messages appear on a separate panel in the frontend. diff --git a/source/_integrations/mailgun.markdown b/source/_integrations/mailgun.markdown index 97808d3cf9f..e4414ce9370 100644 --- a/source/_integrations/mailgun.markdown +++ b/source/_integrations/mailgun.markdown @@ -6,9 +6,10 @@ ha_category: - Notifications ha_release: 0.38 ha_config_flow: true +ha_domain: mailgun --- -To be able to receive webhooks from Mailgun, your Home Assistant instance needs to be accessible from the web and you need to have the `base_url` configured for the HTTP integration ([docs](/integrations/http/#base_url)). +To be able to receive webhooks from Mailgun, your Home Assistant instance needs to be accessible from the web and you need to have the `base_url` configured for the HTTP integration ([documentation](/integrations/http/#base_url)). To set it up, go to the integrations page in the configuration screen and find Mailgun. Click on configure. Follow the instructions on the screen to configure Mailgun. diff --git a/source/_integrations/manual.markdown b/source/_integrations/manual.markdown index cea79d6c9f9..ed33d84527c 100644 --- a/source/_integrations/manual.markdown +++ b/source/_integrations/manual.markdown @@ -1,11 +1,11 @@ --- title: Manual description: Instructions on how to integrate manual alarms into Home Assistant. -logo: home-assistant.png ha_category: - Alarm ha_release: 0.7.6 ha_quality_scale: internal +ha_domain: manual --- The `manual` alarm control panel platform enables you to set manual alarms in Home Assistant. diff --git a/source/_integrations/manual_mqtt.markdown b/source/_integrations/manual_mqtt.markdown index b73920ed819..89e89943fed 100644 --- a/source/_integrations/manual_mqtt.markdown +++ b/source/_integrations/manual_mqtt.markdown @@ -1,10 +1,10 @@ --- title: Manual MQTT description: Instructions on how to integrate manual alarms into Home Assistant with MQTT support. -logo: home-assistant.png ha_category: - Alarm ha_release: '0.50' +ha_domain: manual_mqtt --- The `mqtt` platform extends the [manual alarm](/integrations/manual) by adding support for MQTT control of the alarm by a remote device. It can be used to create external keypads which simply change the state of the manual alarm in Home Assistant. diff --git a/source/_integrations/map.markdown b/source/_integrations/map.markdown index 98c8e62d986..33c096743c6 100644 --- a/source/_integrations/map.markdown +++ b/source/_integrations/map.markdown @@ -1,11 +1,11 @@ --- title: Map description: Offers a map to show tracked devices. -logo: home-assistant.png ha_category: - Other ha_release: 0.56 ha_quality_scale: internal +ha_domain: map --- This offers a map on the frontend to display the location of tracked devices. To set up tracked devices, look at the [device tracker](/integrations/device_tracker/) documentation. This integration is by default enabled, unless you've disabled or removed the [`default_config:`](https://www.home-assistant.io/integrations/default_config/) line from your configuration. If that is the case, the following example shows you how to enable this integration manually: @@ -18,3 +18,7 @@ map:
    Devices that are currently at home won't show on the map.
    + +
    +This map always shows the location of all tracked devices. If you want to hide certain entities, you should look into the [Map Card](/lovelace/map). +
    diff --git a/source/_integrations/marytts.markdown b/source/_integrations/marytts.markdown index 9533c8dbeda..b7afa22c8d4 100644 --- a/source/_integrations/marytts.markdown +++ b/source/_integrations/marytts.markdown @@ -5,6 +5,7 @@ logo: marytts.png ha_category: - Text-to-speech ha_release: 0.43 +ha_domain: marytts --- The `marytts` text-to-speech platform uses [MaryTTS](http://mary.dfki.de/) Text-to-Speech engine to read a text with natural sounding voices. diff --git a/source/_integrations/mastodon.markdown b/source/_integrations/mastodon.markdown index ab0336fd893..54af064ebe9 100644 --- a/source/_integrations/mastodon.markdown +++ b/source/_integrations/mastodon.markdown @@ -1,12 +1,12 @@ --- title: Mastodon description: Instructions on how to add Instapush notifications to Home Assistant. -logo: mastodon.png ha_category: - Notifications ha_release: 0.67 ha_codeowners: - '@fabaff' +ha_domain: mastodon --- The `mastodon` platform uses [Mastodon](https://joinmastodon.org/) to deliver notifications from Home Assistant. diff --git a/source/_integrations/matrix.markdown b/source/_integrations/matrix.markdown index fa4ccd4e343..dea7dbda403 100644 --- a/source/_integrations/matrix.markdown +++ b/source/_integrations/matrix.markdown @@ -8,6 +8,7 @@ ha_category: ha_release: 0.69 ha_codeowners: - '@tinloaf' +ha_domain: matrix --- This integration allows you to send messages to matrix rooms, as well as to react to messages in matrix rooms. Reacting to commands is accomplished by firing an event when one of the configured commands is triggered. diff --git a/source/_integrations/maxcube.markdown b/source/_integrations/maxcube.markdown index e2172141231..f76aa4ab07a 100644 --- a/source/_integrations/maxcube.markdown +++ b/source/_integrations/maxcube.markdown @@ -7,6 +7,7 @@ ha_category: - Binary Sensor ha_release: '0.40' ha_iot_class: Local Polling +ha_domain: maxcube --- [eQ-3 MAX!](https://www.eq-3.com/products/max.html) integration for Home Assistant allows you to connect eQ-3 MAX! components via the eQ-3 MAX! Cube. The components connects to the eQ-3 MAX! Cube via TCP and automatically makes all supported integrations available in Home Assistant. The name for each device is created by concatenating the MAX! room and device names. diff --git a/source/_integrations/mcp23017.markdown b/source/_integrations/mcp23017.markdown index 0bd216f2caf..0b6ff164661 100644 --- a/source/_integrations/mcp23017.markdown +++ b/source/_integrations/mcp23017.markdown @@ -1,7 +1,6 @@ --- title: MCP23017 I/O Expander description: Instructions on how to integrate the MCP23017 GPIO pin expander with I2C interface into Home Assistant. -logo: raspberry-pi.png ha_category: - DIY - Binary Sensor @@ -10,6 +9,7 @@ ha_release: 0.94 ha_iot_class: Local Polling ha_codeowners: - '@jardiamj' +ha_domain: mcp23017 --- The `mcp23017` integration is the base for all related mcp23017 platforms in Home Assistant. There is no setup needed for the integration itself, for the platforms please check their corresponding sections. diff --git a/source/_integrations/media_extractor.markdown b/source/_integrations/media_extractor.markdown index 7a013b889e9..3c5bf906962 100644 --- a/source/_integrations/media_extractor.markdown +++ b/source/_integrations/media_extractor.markdown @@ -1,11 +1,11 @@ --- title: Media Extractor description: Instructions on how to integrate the Media Extractor into Home Assistant. -logo: home-assistant.png ha_category: - Media Player ha_release: 0.49 ha_quality_scale: internal +ha_domain: media_extractor --- The `media_extractor` integration gets a stream URL and sends it to a media player entity. This integration can extract entity specific streams if configured accordingly. diff --git a/source/_integrations/media_player.markdown b/source/_integrations/media_player.markdown index 8ea3e3c525c..3c72259e7d9 100644 --- a/source/_integrations/media_player.markdown +++ b/source/_integrations/media_player.markdown @@ -1,11 +1,11 @@ --- title: Media Player description: Instructions on how to setup your media players with Home Assistant. -logo: home-assistant.png ha_category: - Media Player ha_release: 0.7 ha_quality_scale: internal +ha_domain: media_player --- Interacts with media players on your network. diff --git a/source/_integrations/mediaroom.markdown b/source/_integrations/mediaroom.markdown index d6ebf946b46..6c83e6c02e5 100644 --- a/source/_integrations/mediaroom.markdown +++ b/source/_integrations/mediaroom.markdown @@ -1,13 +1,13 @@ --- title: Mediaroom description: Instructions on how to integrate Mediaroom Set-Top Boxes into Home Assistant. -logo: mediaroom.png ha_category: - Media Player ha_iot_class: Local Polling ha_release: 0.63 ha_codeowners: - '@dgomes' +ha_domain: mediaroom --- The `mediaroom` integration allows you to control a [Mediaroom](https://en.wikipedia.org/wiki/Ericsson_Mediaroom) Set-Top Box (STB) from Home Assistant. diff --git a/source/_integrations/melcloud.markdown b/source/_integrations/melcloud.markdown index 9233cfd0cff..578d02d1389 100644 --- a/source/_integrations/melcloud.markdown +++ b/source/_integrations/melcloud.markdown @@ -1,7 +1,6 @@ --- title: MELCloud description: MELCloud integration -logo: melcloud.png ha_category: - Climate ha_release: 0.106 @@ -9,6 +8,7 @@ ha_iot_class: Cloud Polling ha_config_flow: true ha_codeowners: - '@vilppuvuorinen' +ha_domain: melcloud --- The `melcloud` integration integrates Mitsubishi Electric's [MELCloud](https://www.melcloud.com/) enabled devices into Home Assistant. diff --git a/source/_integrations/melissa.markdown b/source/_integrations/melissa.markdown index 1ac03359ddd..40e25593c06 100644 --- a/source/_integrations/melissa.markdown +++ b/source/_integrations/melissa.markdown @@ -9,6 +9,7 @@ ha_release: 0.63 ha_iot_class: Cloud Polling ha_codeowners: - '@kennedyshead' +ha_domain: melissa --- The `melissa` integration is the main integration to connect to a [Melissa Climate](https://seemelissa.com/) A/C control. diff --git a/source/_integrations/meraki.markdown b/source/_integrations/meraki.markdown index 84e3f80a1cf..0c25fd67ca1 100644 --- a/source/_integrations/meraki.markdown +++ b/source/_integrations/meraki.markdown @@ -5,6 +5,7 @@ logo: meraki.png ha_category: - Presence Detection ha_release: '0.60' +ha_domain: meraki --- Use your Meraki AP as device tracker. Note that Meraki will see all devices, not only connected to the network. diff --git a/source/_integrations/message_bird.markdown b/source/_integrations/message_bird.markdown index 20cd621a85f..4bf0975be1f 100644 --- a/source/_integrations/message_bird.markdown +++ b/source/_integrations/message_bird.markdown @@ -5,6 +5,7 @@ logo: message_bird.png ha_category: - Notifications ha_release: 0.16 +ha_domain: message_bird --- The `MessageBird` notification platform sends notifications as SMS messages using [MessageBird](https://www.messagebird.com/) to your mobile phone. diff --git a/source/_integrations/met.markdown b/source/_integrations/met.markdown index 0ba8d0c4a78..433bd0450bb 100644 --- a/source/_integrations/met.markdown +++ b/source/_integrations/met.markdown @@ -1,7 +1,6 @@ --- title: Meteorologisk institutt (Met.no) description: Instructions on how to integrate Met.no within Home Assistant. -logo: metno.png ha_category: - Weather ha_release: 0.79 @@ -9,6 +8,7 @@ ha_iot_class: Cloud Polling ha_config_flow: true ha_codeowners: - '@danielhiversen' +ha_domain: met --- The `met` platform uses the [Met.no](https://met.no/) web service as a source for meteorological data for your location. The weather forecast is delivered by the Norwegian Meteorological Institute and the NRK. diff --git a/source/_integrations/meteo_france.markdown b/source/_integrations/meteo_france.markdown index 63b6d67d4d0..7cd3dec3012 100644 --- a/source/_integrations/meteo_france.markdown +++ b/source/_integrations/meteo_france.markdown @@ -1,7 +1,6 @@ --- title: Météo-France description: Instructions on how to integrate Météo-France within Home Assistant. -logo: meteo-france.png ha_release: 0.89 ha_iot_class: Cloud Polling ha_category: @@ -12,6 +11,7 @@ ha_codeowners: - '@oncleben31' - '@Quentame' ha_config_flow: true +ha_domain: meteo_france --- The `meteo_france` integration uses the [Météo-France](http://www.meteofrance.com/) web service as a source for meteorological data for your location. The location is based on the `city` configured in your `configuration.yaml` file. diff --git a/source/_integrations/meteoalarm.markdown b/source/_integrations/meteoalarm.markdown index 058e6d3cc5b..e9923e082cf 100644 --- a/source/_integrations/meteoalarm.markdown +++ b/source/_integrations/meteoalarm.markdown @@ -7,6 +7,7 @@ ha_release: 0.93 ha_iot_class: Local Polling ha_codeowners: - '@rolfberkenbosch' +ha_domain: meteoalarm --- The `MeteoAlarm` platform allows one to watch for weather alerts in europe from [MeteoAlarm](https://www.meteoalarm.eu) (EUMETNET). To use this binary sensor, you need the two digits of your country and the province name from [MeteoAlarm](https://www.meteoalarm.eu). Please note that you need to write the exact details from the website with capitals. diff --git a/source/_integrations/metoffice.markdown b/source/_integrations/metoffice.markdown index 3b8f26a4d6c..8a24816d562 100644 --- a/source/_integrations/metoffice.markdown +++ b/source/_integrations/metoffice.markdown @@ -1,11 +1,11 @@ --- title: Met Office description: Instructions on how to integrate Met Office weather conditions into Home Assistant. -logo: metoffice.jpg ha_category: - Weather ha_release: 0.42 ha_iot_class: Cloud Polling +ha_domain: metoffice --- The `metoffice` weather platform uses the Met Office's [DataPoint API](https://www.metoffice.gov.uk/datapoint) for weather data. diff --git a/source/_integrations/mfi.markdown b/source/_integrations/mfi.markdown index fdb475653fe..ad369ac77b0 100644 --- a/source/_integrations/mfi.markdown +++ b/source/_integrations/mfi.markdown @@ -8,6 +8,7 @@ ha_category: - Switch ha_iot_class: Local Polling ha_release: 0.13 +ha_domain: mfi --- There is currently support for the following device types within Home Assistant: diff --git a/source/_integrations/mhz19.markdown b/source/_integrations/mhz19.markdown index 34c02aa2969..3f0b078666c 100644 --- a/source/_integrations/mhz19.markdown +++ b/source/_integrations/mhz19.markdown @@ -1,11 +1,11 @@ --- title: MH-Z19 CO2 Sensor description: Instructions on how to integrate the MH-Z19 CO2 sensor with Home Assistant. -logo: mhz19_logo.png ha_category: - DIY ha_release: 0.27 ha_iot_class: Local Polling +ha_domain: mhz19 --- The MH-Z19 is a small non-dispersive infrared sensor that can measure CO2 level. High CO2 levels can lead to drowsiness, poor concentration, loss of attention or increased heart rate. The CO2 level outside is around 400ppm, but inside levels can reach between 1000 and 5000 ppm. High CO2 levels indicate that you should increase ventilation. diff --git a/source/_integrations/microsoft.markdown b/source/_integrations/microsoft.markdown index c8f49d73ed3..8768d3d4281 100644 --- a/source/_integrations/microsoft.markdown +++ b/source/_integrations/microsoft.markdown @@ -1,10 +1,10 @@ --- title: Microsoft Text-to-Speech (TTS) description: Instructions on how to set up Microsoft Text-to-Speech with Home Assistant. -logo: microsoft.png ha_category: - Text-to-speech ha_release: 0.57 +ha_domain: microsoft --- The `microsoft` text-to-speech platform uses [Microsoft Text-to-Speech engine](https://docs.microsoft.com/en-us/azure/cognitive-services/speech/home) to read a text with natural sounding voices. This integration uses an API that is part of the Cognitive Services offering and is known as the Bing Speech API. diff --git a/source/_integrations/microsoft_face.markdown b/source/_integrations/microsoft_face.markdown index 512cdf252c4..21661f1b54b 100644 --- a/source/_integrations/microsoft_face.markdown +++ b/source/_integrations/microsoft_face.markdown @@ -1,10 +1,10 @@ --- title: Microsoft Face description: Instructions on how to integrate Microsoft Face integration into Home Assistant. -logo: microsoft.png ha_category: - Image Processing ha_release: 0.37 +ha_domain: microsoft_face --- The `microsoft_face` integration platform is the main integration for Microsoft diff --git a/source/_integrations/microsoft_face_detect.markdown b/source/_integrations/microsoft_face_detect.markdown index 44ea10d97a7..55147bcedc4 100644 --- a/source/_integrations/microsoft_face_detect.markdown +++ b/source/_integrations/microsoft_face_detect.markdown @@ -1,10 +1,10 @@ --- title: Microsoft Face Detect description: Instructions on how to integrate Microsoft Face Detect into Home Assistant. -logo: microsoft.png ha_category: - Image Processing ha_release: 0.38 +ha_domain: microsoft_face_detect --- The `microsoft_face_detect` image processing platform allows you to use the diff --git a/source/_integrations/microsoft_face_identify.markdown b/source/_integrations/microsoft_face_identify.markdown index da2b371a135..7612453d49d 100644 --- a/source/_integrations/microsoft_face_identify.markdown +++ b/source/_integrations/microsoft_face_identify.markdown @@ -1,10 +1,10 @@ --- title: Microsoft Face Identify description: Instructions on how to integrate Microsoft Face Identify into Home Assistant. -logo: microsoft.png ha_category: - Image Processing ha_release: 0.37 +ha_domain: microsoft_face_identify --- The `microsoft_face_identify` image processing platform lets you use diff --git a/source/_integrations/miflora.markdown b/source/_integrations/miflora.markdown index 40cd9a68e7e..162dbd89979 100644 --- a/source/_integrations/miflora.markdown +++ b/source/_integrations/miflora.markdown @@ -9,6 +9,7 @@ ha_iot_class: Local Polling ha_codeowners: - '@danielhiversen' - '@ChristianKuehnel' +ha_domain: miflora --- The `miflora` sensor platform allows one to monitor plant soil and air conditions. The [Mi Flora plant sensor](https://gadget-freakz.com/product/xiaomi-mi-flora-plant-sensor/) is a small Bluetooth Low Energy device that monitors the moisture and conductivity of the soil as well as ambient light and temperature. Since only one BLE device can be polled at a time, the library implements locking to prevent polling more than one device at a time. diff --git a/source/_integrations/mikrotik.markdown b/source/_integrations/mikrotik.markdown index 67bf3acf40e..3ad46a5651a 100644 --- a/source/_integrations/mikrotik.markdown +++ b/source/_integrations/mikrotik.markdown @@ -9,6 +9,7 @@ ha_release: 0.44 ha_codeowners: - '@engrbm87' ha_config_flow: true +ha_domain: mikrotik --- The `mikrotik` platform offers presence detection by looking at connected devices to a [MikroTik RouterOS](https://mikrotik.com) based router. diff --git a/source/_integrations/mill.markdown b/source/_integrations/mill.markdown index 72b5b96beb8..5ef94e83975 100644 --- a/source/_integrations/mill.markdown +++ b/source/_integrations/mill.markdown @@ -1,13 +1,13 @@ --- title: Mill description: Instructions on how to integrate Mill heater into Home Assistant. -logo: mill.png ha_category: - Climate ha_release: 0.81 ha_iot_class: Cloud Polling ha_codeowners: - '@danielhiversen' +ha_domain: mill --- Integrates Mill heater into Home Assistant. diff --git a/source/_integrations/min_max.markdown b/source/_integrations/min_max.markdown index 4bc00b42ee8..09a610c1e28 100644 --- a/source/_integrations/min_max.markdown +++ b/source/_integrations/min_max.markdown @@ -1,7 +1,6 @@ --- title: Min/Max description: Instructions on how to integrate min/max sensors into Home Assistant. -logo: home-assistant.png ha_category: - Utility ha_iot_class: Local Polling @@ -9,6 +8,7 @@ ha_release: 0.31 ha_quality_scale: internal ha_codeowners: - '@fabaff' +ha_domain: min_max --- The `min_max` sensor platform consumes the state from other sensors to determine the minimum, maximum, latest (last) and the mean of the collected states. The sensor 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. diff --git a/source/_integrations/minecraft_server.markdown b/source/_integrations/minecraft_server.markdown index 4fd0695dfc3..ddb57fc7b2a 100644 --- a/source/_integrations/minecraft_server.markdown +++ b/source/_integrations/minecraft_server.markdown @@ -1,9 +1,8 @@ --- title: Minecraft Server description: Instructions on how to integrate a Minecraft server into Home Assistant. -logo: minecraft.png ha_release: 0.106 -ha_category: +ha_category: - Binary Sensor - Sensor ha_iot_class: Local Polling @@ -11,6 +10,7 @@ ha_quality_scale: silver ha_config_flow: true ha_codeowners: - '@elmurato' +ha_domain: minecraft_server --- Minecraft servers allow players to play the sandbox video game [Minecraft](https://www.minecraft.net) by [Mojang AB](https://www.mojang.com) online or via a local area network with other players. The `Minecraft Server` integration lets you retrieve information from a Minecraft server (Java edition) within Home Assistant. diff --git a/source/_integrations/minio.markdown b/source/_integrations/minio.markdown index 0f3fbc9c3b5..3c9d486cec6 100644 --- a/source/_integrations/minio.markdown +++ b/source/_integrations/minio.markdown @@ -1,16 +1,16 @@ --- title: Minio description: Integration for interacting with Minio object storage. -logo: minio.png ha_category: Utility ha_iot_class: Cloud Push ha_release: 0.98 ha_codeowners: - '@tkislan' +ha_domain: minio --- This integration adds interaction with [Minio](https://min.io). -Also enables to listen for bucket notifications: [watch docs](https://docs.min.io/docs/minio-client-complete-guide.html#watch) +It also enables listening for bucket notifications: [see documentation](https://docs.min.io/docs/minio-client-complete-guide.html#watch) To download or upload files, folders must be added to [whitelist_external_dirs](/docs/configuration/basic/). diff --git a/source/_integrations/mitemp_bt.markdown b/source/_integrations/mitemp_bt.markdown index 5defcfe1d80..353c28a14d7 100644 --- a/source/_integrations/mitemp_bt.markdown +++ b/source/_integrations/mitemp_bt.markdown @@ -1,11 +1,11 @@ --- title: Xiaomi Mijia BLE Temperature and Humidity Sensor description: Instructions on how to integrate MiTemp BLE temperature and humidity sensor with Home Assistant. -logo: xiaomi.png ha_category: - DIY ha_release: 0.69 ha_iot_class: Local Polling +ha_domain: mitemp_bt --- The `mitemp_bt` sensor platform allows one to monitor room temperature and humidity. The [Xiaomi Mijia BLE Temperature and Humidity sensor with LCD](https://www.amazon.com/Temperature-Humidity-Xiaomi-Bluetooth-Screen-Remote/dp/B079L6N6PC) is a small Bluetooth Low Energy device that monitors the room temperature and humidity. As only a single BLE device can be polled at the same time, the library employs locking to make sure this is the case. diff --git a/source/_integrations/mjpeg.markdown b/source/_integrations/mjpeg.markdown index 4beabb56a8e..f27adfb474f 100644 --- a/source/_integrations/mjpeg.markdown +++ b/source/_integrations/mjpeg.markdown @@ -1,11 +1,11 @@ --- title: MJPEG IP Camera description: Instructions on how to integrate IP cameras within Home Assistant. -logo: home-assistant.png ha_category: - Camera ha_release: pre 0.7 ha_iot_class: Configurable +ha_domain: mjpeg --- The `mjpeg` camera platform allows you to integrate IP cameras which are capable diff --git a/source/_integrations/mobile_app.markdown b/source/_integrations/mobile_app.markdown index 9ca3ddcdcdb..4ca7b318007 100644 --- a/source/_integrations/mobile_app.markdown +++ b/source/_integrations/mobile_app.markdown @@ -1,7 +1,6 @@ --- title: Home Assistant Mobile App Support description: The Mobile App integration allows a generic platform for integrating with mobile apps. -logo: home-assistant.png ha_category: - Other ha_release: 0.89 @@ -9,6 +8,7 @@ ha_config_flow: true ha_quality_scale: internal ha_codeowners: - '@robbiet480' +ha_domain: mobile_app --- The Mobile App integration allows Home Assistant mobile apps to easily integrate with Home Assistant. diff --git a/source/_integrations/mochad.markdown b/source/_integrations/mochad.markdown index 73d6d43548a..f0a9f561c19 100644 --- a/source/_integrations/mochad.markdown +++ b/source/_integrations/mochad.markdown @@ -6,6 +6,7 @@ ha_category: - Light - Switch ha_release: 0.32 +ha_domain: mochad --- The `mochad` integration is the main integration to integrate all X10 platforms being controlled by [mochad](https://sourceforge.net/projects/mochad/). Besides this integration you will have to setup your X10 devices separately. diff --git a/source/_integrations/modbus.markdown b/source/_integrations/modbus.markdown index a143bc7c937..fa6950f7ecc 100644 --- a/source/_integrations/modbus.markdown +++ b/source/_integrations/modbus.markdown @@ -1,13 +1,13 @@ --- title: Modbus description: Instructions on how to integrate Modbus within Home Assistant. -logo: modbus.png ha_category: - Hub ha_release: pre 0.7 ha_iot_class: Local Push ha_codeowners: - '@adamchengtkc' +ha_domain: modbus --- [Modbus](http://www.modbus.org/) is a serial communication protocol to control PLCs (Programmable logic controller). diff --git a/source/_integrations/modem_callerid.markdown b/source/_integrations/modem_callerid.markdown index 016e3571945..1e17a676600 100644 --- a/source/_integrations/modem_callerid.markdown +++ b/source/_integrations/modem_callerid.markdown @@ -5,6 +5,7 @@ ha_category: - Sensor ha_release: '0.40' ha_iot_class: Local Polling +ha_domain: modem_callerid --- The `modem_callerid` integration uses an available modem for collecting caller ID information. It requires a Hayes AT compatible modem that supports caller ID detection (via AT+VCID=1). diff --git a/source/_integrations/mold_indicator.markdown b/source/_integrations/mold_indicator.markdown index e3bb135a255..3c8755b24fd 100644 --- a/source/_integrations/mold_indicator.markdown +++ b/source/_integrations/mold_indicator.markdown @@ -1,12 +1,12 @@ --- title: Mold Indicator description: How to use the mold growth indication integration in Home Assistant -logo: home-assistant.png ha_category: - Environment ha_release: '0.20' ha_iot_class: Local Polling ha_quality_scale: internal +ha_domain: mold_indicator --- The Mold Indicator sensor integration consumes information of two temperature sensors and a humidity sensor to give an indication for possible mold growth in your home. In case of bad ventilation and insulation, the indoor humidity may lead to condensation on cold surfaces as the windows or even walls. Condensation or a high relative humidity near those cold surfaces leads to a higher risk for mold growth. This sensor integration estimates the temperature at a pre-calibrated critical point in the room (the coldest surface) and calculates the relative humidity of the air at that point. If the sensor value rises above approximately 70 percent, mold growth might occur and the room should be ventilated. At 100%, the air humidity condensates at the critical point. diff --git a/source/_integrations/monoprice.markdown b/source/_integrations/monoprice.markdown index a780bb4b9a8..a0214da2b0f 100644 --- a/source/_integrations/monoprice.markdown +++ b/source/_integrations/monoprice.markdown @@ -1,13 +1,13 @@ --- title: Monoprice 6-Zone Amplifier description: Instructions on how to integrate Monoprice 6-Zone Home Audio Controller into Home Assistant. -logo: monoprice.svg ha_category: - Media Player ha_release: 0.56 ha_iot_class: Local Polling ha_codeowners: - '@etsinko' +ha_domain: monoprice --- The `monoprice` platform allows you to control [Monoprice 6-Zone Amplifier](https://www.monoprice.com/product?p_id=10761) using a serial connection. diff --git a/source/_integrations/moon.markdown b/source/_integrations/moon.markdown index c93ffb3738c..562843002d0 100644 --- a/source/_integrations/moon.markdown +++ b/source/_integrations/moon.markdown @@ -1,7 +1,6 @@ --- title: Moon description: Instructions on how to integrate the moon sensor into Home Assistant. -logo: home-assistant.png ha_category: - Environment ha_iot_class: Local Polling @@ -9,6 +8,7 @@ ha_release: 0.38 ha_quality_scale: internal ha_codeowners: - '@fabaff' +ha_domain: moon --- The `moon` integration tracks the phases of the moon. diff --git a/source/_integrations/mopar.markdown b/source/_integrations/mopar.markdown index ef58fe9ec3f..4662f83085b 100644 --- a/source/_integrations/mopar.markdown +++ b/source/_integrations/mopar.markdown @@ -1,7 +1,6 @@ --- title: Mopar description: Instructions on how to integrate Mopar vehicles into Home Assistant. -logo: mopar.png ha_category: - Car - Sensor @@ -9,6 +8,7 @@ ha_category: - Lock ha_release: 0.53 ha_iot_class: Cloud Polling +ha_domain: mopar --- The `mopar` integration provides the following for owners of FCA vehicles with a uConnect subscription: diff --git a/source/_integrations/mpchc.markdown b/source/_integrations/mpchc.markdown index bb6df94ca09..b0e105ec25c 100644 --- a/source/_integrations/mpchc.markdown +++ b/source/_integrations/mpchc.markdown @@ -1,11 +1,11 @@ --- title: Media Player Classic Home Cinema (MPC-HC) description: Instructions on how to integrate MPC-HC into Home Assistant. -logo: mpchc.png ha_category: - Media Player ha_release: 0.25 ha_iot_class: Local Polling +ha_domain: mpchc --- The `mpchc` platform allows you to connect a [Media Player Classic Home Cinema](https://mpc-hc.org/) to Home Assistant. It will allow you to see the current playing item, and respond to changes in the player's state. diff --git a/source/_integrations/mpd.markdown b/source/_integrations/mpd.markdown index ee82fbb7391..6661ced5b3d 100644 --- a/source/_integrations/mpd.markdown +++ b/source/_integrations/mpd.markdown @@ -1,13 +1,13 @@ --- title: Music Player Daemon (MPD) description: Instructions on how to integrate Music Player Daemon into Home Assistant. -logo: mpd.png ha_category: - Media Player ha_release: pre 0.7 ha_iot_class: Local Polling ha_codeowners: - '@fabaff' +ha_domain: mpd --- The `mpd` platform allows you to control a [Music Player Daemon](https://www.musicpd.org/) from Home Assistant. Unfortunately you will not be able to manipulate the playlist (add or delete songs) or add transitions between the songs. diff --git a/source/_integrations/mqtt.markdown b/source/_integrations/mqtt.markdown index ff854cbf556..290d2d79b53 100644 --- a/source/_integrations/mqtt.markdown +++ b/source/_integrations/mqtt.markdown @@ -1,7 +1,6 @@ --- title: MQTT description: Instructions on how to setup MQTT within Home Assistant. -logo: mqtt.png ha_category: - Hub featured: true @@ -10,6 +9,7 @@ ha_iot_class: Local Push ha_config_flow: true ha_codeowners: - '@home-assistant/core' +ha_domain: mqtt --- MQTT (aka MQ Telemetry Transport) is a machine-to-machine or "Internet of Things" connectivity protocol on top of TCP/IP. It allows extremely lightweight publish/subscribe messaging transport. diff --git a/source/_integrations/mqtt_eventstream.markdown b/source/_integrations/mqtt_eventstream.markdown index 0029193b9c1..ce6eab477bb 100644 --- a/source/_integrations/mqtt_eventstream.markdown +++ b/source/_integrations/mqtt_eventstream.markdown @@ -6,6 +6,7 @@ ha_category: - Other ha_release: 0.11 ha_iot_class: Configurable +ha_domain: mqtt_eventstream --- The `mqtt_eventstream` integration connects two Home Assistant instances via MQTT. diff --git a/source/_integrations/mqtt_json.markdown b/source/_integrations/mqtt_json.markdown index 02623659e4a..0ab8730c6c6 100644 --- a/source/_integrations/mqtt_json.markdown +++ b/source/_integrations/mqtt_json.markdown @@ -6,6 +6,7 @@ ha_category: - Presence Detection ha_iot_class: Configurable ha_release: 0.44 +ha_domain: mqtt_json --- The `mqtt_json` device tracker platform allows you to detect presence by monitoring an MQTT topic for new locations. To use this platform, you specify a unique topic for each device. diff --git a/source/_integrations/mqtt_room.markdown b/source/_integrations/mqtt_room.markdown index 50dcf3d21be..93e7f3d563e 100644 --- a/source/_integrations/mqtt_room.markdown +++ b/source/_integrations/mqtt_room.markdown @@ -6,6 +6,7 @@ ha_category: - Presence Detection ha_release: 0.27 ha_iot_class: Configurable +ha_domain: mqtt_room --- The `mqtt_room` sensor platform allows you to detect the indoor location of devices using MQTT clients. diff --git a/source/_integrations/mqtt_statestream.markdown b/source/_integrations/mqtt_statestream.markdown index 08ab4acd335..2e1453a6038 100644 --- a/source/_integrations/mqtt_statestream.markdown +++ b/source/_integrations/mqtt_statestream.markdown @@ -6,6 +6,7 @@ ha_category: - Other ha_release: 0.54 ha_iot_class: Configurable +ha_domain: mqtt_statestream --- The `mqtt_statestream` integration publishes state changes in Home Assistant to individual MQTT topics. diff --git a/source/_integrations/msteams.markdown b/source/_integrations/msteams.markdown index 6b989097562..aa9694e235b 100644 --- a/source/_integrations/msteams.markdown +++ b/source/_integrations/msteams.markdown @@ -1,12 +1,12 @@ --- title: Microsoft Teams description: Instructions on how to send a notification to a Microsoft Teams channel. -logo: msteams.jpg ha_category: - Notifications ha_release: 0.101 ha_codeowners: - '@peroyvind' +ha_domain: msteams --- The `Microsoft Teams` platform allows you to send notifications from Home Assistant to a team channel in [Microsoft Teams](https://products.office.com/en-us/microsoft-teams/group-chat-software). diff --git a/source/_integrations/mvglive.markdown b/source/_integrations/mvglive.markdown index 200ce0e556e..9b9e66fc2e9 100644 --- a/source/_integrations/mvglive.markdown +++ b/source/_integrations/mvglive.markdown @@ -6,6 +6,7 @@ ha_category: - Transport ha_release: 0.42 ha_iot_class: Cloud Polling +ha_domain: mvglive --- The `mvglive` sensor will give you the departure time of the next bus, tram, subway, or train at the next station or stop in the Munich public transport network. Additional details such as the line number and destination are present in the attributes. @@ -24,7 +25,7 @@ sensor: {% configuration %} station: - description: Name of the stop or station. Visit [the MVG live web site](https://www.mvg-live.de/ims/dfiStaticAuswahl.svc) to find valid names. Be aware, that not all data of interest might be available (i.e. bus departure-times in Haar). + description: Name of the stop or station. Visit [the MVG live web site](https://www.mvg-live.de/ims/dfiStaticAuswahl.svc) to find valid names. Be aware, that not all data of interest might be available (i.e., bus departure-times in Haar). required: true type: string destinations: diff --git a/source/_integrations/mychevy.markdown b/source/_integrations/mychevy.markdown index dbd4ff8f540..d7759022563 100644 --- a/source/_integrations/mychevy.markdown +++ b/source/_integrations/mychevy.markdown @@ -6,6 +6,7 @@ ha_category: - Car ha_release: 0.62 ha_iot_class: Cloud Polling +ha_domain: mychevy --- The `mychevy` integration communicates with the [my.chevrolet](https://my.chevrolet.com) website using the javascript API that the website uses (as of Dec 2018). The MyChevy website has been known to be both unstable (interfaces changing somewhat willy nilly) and has substantial outages. So be forwarned in using this component. diff --git a/source/_integrations/mycroft.markdown b/source/_integrations/mycroft.markdown index 30679751b75..23934118d83 100644 --- a/source/_integrations/mycroft.markdown +++ b/source/_integrations/mycroft.markdown @@ -6,6 +6,7 @@ ha_category: - Voice - Notifications ha_release: 0.53 +ha_domain: mycroft --- [Mycroft](https://mycroft.ai) is an open source voice assistant that allows you to send notifications and more to Mycroft from Home Assistant. diff --git a/source/_integrations/myq.markdown b/source/_integrations/myq.markdown index 7d702540931..36624971423 100644 --- a/source/_integrations/myq.markdown +++ b/source/_integrations/myq.markdown @@ -6,6 +6,7 @@ ha_category: - Cover ha_release: 0.39 ha_iot_class: Cloud Polling +ha_domain: myq --- The `myq` cover platform lets you control MyQ-Enabled garage doors through Home Assistant. Device names in Home Assistant are generated based on the names defined in your MyQ Device mobile app. diff --git a/source/_integrations/mysensors.markdown b/source/_integrations/mysensors.markdown index 86849fcc0c7..d4b4319ca92 100644 --- a/source/_integrations/mysensors.markdown +++ b/source/_integrations/mysensors.markdown @@ -1,13 +1,13 @@ --- title: MySensors description: Instructions on how to integrate MySensors sensors into Home Assistant. -logo: mysensors.png ha_category: - DIY ha_iot_class: Local Push ha_release: 0.73 ha_codeowners: - '@MartinHjelmare' +ha_domain: mysensors --- The [MySensors](https://www.mysensors.org) project combines devices like Arduino, ESP8266, Raspberry Pi, NRF24L01+ and RFM69 to build affordable sensor networks. This integration will automatically add all available devices to Home Assistant, after [presentation](#presentation) is done. That is, you do not need to add anything to your configuration for the devices for them to be added. Go to the **states** section of the developer tools to find the devices that have been identified. @@ -59,7 +59,7 @@ mysensors: type: string default: '' nodes: - description: A mapping of node ids to node settings, e.g. custom name. + description: A mapping of node ids to node settings, e.g., custom name. required: false type: map keys: @@ -243,7 +243,7 @@ In MySensors version 2.2 the serial API changed from using `I_HEARTBEAT_RESPONSE Messages sent to or from Home Assistant from or to a MySensors device will be validated according to the MySensors [serial API](https://www.mysensors.org/download/serial_api_20). If a message doesn't pass validation, it will be dropped and not be passed forward either to or from Home Assistant. Make sure you follow the serial API for your version of MySensors when writing your Arduino sketch. -The log should warn you of messages that failed validation or if a child value is missing that is required for a certain child type. Home Assistant will log failed validations of child values at warning level if e.g. one required value type for a platform has been received, but other required value types are missing. +The log should warn you of messages that failed validation or if a child value is missing that is required for a certain child type. Home Assistant will log failed validations of child values at warning level if e.g., one required value type for a platform has been received, but other required value types are missing. Message validation was introduced in version 0.52 of Home Assistant. diff --git a/source/_integrations/mystrom.markdown b/source/_integrations/mystrom.markdown index c284299d48a..09c5d3cd284 100644 --- a/source/_integrations/mystrom.markdown +++ b/source/_integrations/mystrom.markdown @@ -1,7 +1,6 @@ --- title: myStrom description: Instructions on how to integrate myStrom WiFi Bulbs into Home Assistant. -logo: mystrom.png ha_category: - Light - Binary Sensor @@ -10,6 +9,7 @@ ha_release: 0.43 ha_iot_class: Local Polling ha_codeowners: - '@fabaff' +ha_domain: mystrom --- The `mystrom` light platform allows you to control your [myStrom](https://mystrom.ch/en/) WiFi Bulbs. diff --git a/source/_integrations/mythicbeastsdns.markdown b/source/_integrations/mythicbeastsdns.markdown index dd2869e2481..b8ac18df210 100644 --- a/source/_integrations/mythicbeastsdns.markdown +++ b/source/_integrations/mythicbeastsdns.markdown @@ -6,6 +6,7 @@ ha_category: ha_release: 0.85 ha_iot_class: Cloud Push logo: mythic_beasts.png +ha_domain: mythicbeastsdns --- With the `mythicbeastsdns` integration you can automatically update your dynamic DNS entry at [Mythic Beasts](https://www.mythic-beasts.com/). diff --git a/source/_integrations/n26.markdown b/source/_integrations/n26.markdown index 2483522cc63..9495093fe88 100644 --- a/source/_integrations/n26.markdown +++ b/source/_integrations/n26.markdown @@ -1,13 +1,13 @@ --- title: N26 description: Instructions on how to integrate N26 integration within Home Assistant. -logo: n26.png ha_category: - Finance - Sensor - Switch ha_release: 0.92 ha_iot_class: Cloud Polling +ha_domain: n26 --- The [N26](https://n26.com) integration for Home Assistant allows you to track your N26 account. diff --git a/source/_integrations/nad.markdown b/source/_integrations/nad.markdown index 57e3a40da74..e3b9f7a3bc1 100644 --- a/source/_integrations/nad.markdown +++ b/source/_integrations/nad.markdown @@ -1,11 +1,11 @@ --- title: NAD description: Instructions on how to integrate NAD receivers into Home Assistant. -logo: nad.png ha_category: - Media Player ha_release: 0.36 ha_iot_class: Local Polling +ha_domain: nad --- The `nad` platform allows you to control a [NAD receiver](https://nadelectronics.com/) through RS232, TCP and Telnet from Home Assistant. diff --git a/source/_integrations/namecheapdns.markdown b/source/_integrations/namecheapdns.markdown index 485830db8d5..b9c8e20f29e 100644 --- a/source/_integrations/namecheapdns.markdown +++ b/source/_integrations/namecheapdns.markdown @@ -5,6 +5,7 @@ logo: namecheap.png ha_category: - Network ha_release: 0.56 +ha_domain: namecheapdns --- With the `namecheapdns` integration you can automatically update your dynamic DNS entry at [namecheapdns](https://www.namecheap.com/store/domains/freedns/). diff --git a/source/_integrations/nanoleaf.markdown b/source/_integrations/nanoleaf.markdown index d1a5dc8d948..2fd39e57b03 100644 --- a/source/_integrations/nanoleaf.markdown +++ b/source/_integrations/nanoleaf.markdown @@ -6,6 +6,7 @@ ha_category: - Light ha_iot_class: Local Polling ha_release: 0.67 +ha_domain: nanoleaf --- ### Configuration Sample diff --git a/source/_integrations/neato.markdown b/source/_integrations/neato.markdown index 10dede4388a..4beffd87bf9 100644 --- a/source/_integrations/neato.markdown +++ b/source/_integrations/neato.markdown @@ -13,6 +13,7 @@ ha_config_flow: true ha_codeowners: - '@dshokouhi' - '@Santobert' +ha_domain: neato --- The `neato` integration allows you to control your [Neato Botvac Connected Robots](https://www.neatorobotics.com/robot-vacuum/botvac-connected-series/). @@ -101,8 +102,8 @@ Some information about the capabilities might be found on the [Neato Developer P | `entity_id` | no | Only act on a specific robot | | `mode` | yes | Set the cleaning mode: 1 for eco and 2 for turbo. Defaults to turbo if not set. | | `navigation` | yes | Set the navigation mode: 1 for normal, 2 for extra care, 3 for deep. Defaults to normal if not set. Deep cleaning is only supported on the Botvac D7. | -| `category` | yes | Whether to use a persistent map or not for cleaning (i.e. No go lines): 2 for no map, 4 for map. Default to using map if not set (and fallback to no map if no map is found). | -| `zone` | yes | Only supported on the Botvac D7. Name of the zone to clean from the Neato app. Use unique names for the zones to avoid the wrong zone from running. Defaults to no zone i.e. complete house cleanup. | +| `category` | yes | Whether to use a persistent map or not for cleaning (i.e., No go lines): 2 for no map, 4 for map. Default to using map if not set (and fallback to no map if no map is found). | +| `zone` | yes | Only supported on the Botvac D7. Name of the zone to clean from the Neato app. Use unique names for the zones to avoid the wrong zone from running. Defaults to no zone i.e., complete house cleanup. | ## Camera diff --git a/source/_integrations/nederlandse_spoorwegen.markdown b/source/_integrations/nederlandse_spoorwegen.markdown index 9560709542e..fff91654d82 100644 --- a/source/_integrations/nederlandse_spoorwegen.markdown +++ b/source/_integrations/nederlandse_spoorwegen.markdown @@ -8,6 +8,7 @@ ha_iot_class: Cloud Polling ha_release: 0.57 ha_codeowners: - '@YarmoM' +ha_domain: nederlandse_spoorwegen --- This sensor will provide you with time table information of the [Nederlandse Spoorwegen](https://www.ns.nl/) train service in the Netherlands. diff --git a/source/_integrations/nello.markdown b/source/_integrations/nello.markdown index d2112f39426..8664d2d366b 100644 --- a/source/_integrations/nello.markdown +++ b/source/_integrations/nello.markdown @@ -8,6 +8,7 @@ ha_release: 0.52 ha_iot_class: Cloud Polling ha_codeowners: - '@pschmitt' +ha_domain: nello --- The `nello` platform allows you to control [Nello](https://www.nello.io) intercoms. diff --git a/source/_integrations/ness_alarm.markdown b/source/_integrations/ness_alarm.markdown index c86b738f584..91fb30324d4 100644 --- a/source/_integrations/ness_alarm.markdown +++ b/source/_integrations/ness_alarm.markdown @@ -1,7 +1,6 @@ --- title: Ness Alarm description: Instructions on how to integrate a Ness D8x/D16x alarm system with Home Assistant. -logo: ness.png ha_category: - Alarm - Binary Sensor @@ -9,6 +8,7 @@ ha_release: 0.85 ha_iot_class: Local Push ha_codeowners: - '@nickw444' +ha_domain: ness_alarm --- The `ness_alarm` integration will allow Home Assistant users who own a Ness D8x/D16x alarm system to leverage their alarm system and its sensors to provide Home Assistant with information about their homes. Connectivity between Home Assistant and the alarm is accomplished through a IP232 module that must be connected to the alarm. diff --git a/source/_integrations/nest.markdown b/source/_integrations/nest.markdown index 3a8b098cc42..4370256db98 100644 --- a/source/_integrations/nest.markdown +++ b/source/_integrations/nest.markdown @@ -13,6 +13,7 @@ ha_release: 0.7 ha_config_flow: true ha_codeowners: - '@awarecan' +ha_domain: nest --- The Nest integration is the main integration to integrate all [Nest](https://nest.com/) related platforms. To connect Nest, you will have to [sign up for a developer account](https://developers.nest.com/products) and get a `client_id` and `client_secret`. diff --git a/source/_integrations/netatmo.markdown b/source/_integrations/netatmo.markdown index f98fab48afc..ec1412cda1d 100644 --- a/source/_integrations/netatmo.markdown +++ b/source/_integrations/netatmo.markdown @@ -15,6 +15,7 @@ ha_iot_class: Cloud Polling ha_codeowners: - '@cgtobi' ha_config_flow: true +ha_domain: netatmo --- The `netatmo` integration platform is the main integration to integrate all Netatmo related platforms. diff --git a/source/_integrations/netdata.markdown b/source/_integrations/netdata.markdown index e81a0c47d9a..a687df52991 100644 --- a/source/_integrations/netdata.markdown +++ b/source/_integrations/netdata.markdown @@ -1,13 +1,13 @@ --- title: Netdata description: Instructions on how to integrate Netdata within Home Assistant. -logo: netdata.png ha_category: - System Monitor ha_release: 0.35 ha_iot_class: Local Polling ha_codeowners: - '@fabaff' +ha_domain: netdata --- The `netdata` sensor platform allows you to display information collected by [Netdata](https://my-netdata.io/). diff --git a/source/_integrations/netgear.markdown b/source/_integrations/netgear.markdown index 01e55ca0515..46ec42f856a 100644 --- a/source/_integrations/netgear.markdown +++ b/source/_integrations/netgear.markdown @@ -1,11 +1,12 @@ --- -title: Netgear -description: Instructions on how to integrate Netgear routers into Home Assistant. +title: NETGEAR +description: Instructions on how to integrate NETGEAR routers into Home Assistant. logo: netgear.png ha_category: - Presence Detection ha_iot_class: Local Polling ha_release: pre 0.7 +ha_domain: netgear --- This platform allows you to detect presence by looking at connected devices to a [NETGEAR](https://www.netgear.com/) device. diff --git a/source/_integrations/netgear_lte.markdown b/source/_integrations/netgear_lte.markdown index c340dd6cb98..bfb0e56f9b9 100644 --- a/source/_integrations/netgear_lte.markdown +++ b/source/_integrations/netgear_lte.markdown @@ -1,6 +1,6 @@ --- -title: Netgear LTE -description: Instructions on how to integrate your Netgear LTE modem within Home Assistant. +title: NETGEAR LTE +description: Instructions on how to integrate your NETGEAR LTE modem within Home Assistant. logo: netgear.png ha_release: 0.72 ha_category: @@ -9,6 +9,7 @@ ha_category: - Sensor - Binary Sensor ha_iot_class: Local Polling +ha_domain: netgear_lte --- The NETGEAR LTE integration for Home Assistant allows you to observe and control [NETGEAR LTE modems](https://www.netgear.com/home/products/mobile-broadband/lte-modems/default.aspx). @@ -92,7 +93,7 @@ sensor: current_band: description: The radio band used, e.g., "LTE B3". current_ps_service_type: - description: The service type, e.g. "LTE". + description: The service type, e.g., "LTE". radio_quality: description: A number with the radio quality in percent, e.g., "55" register_network_display: diff --git a/source/_integrations/netio.markdown b/source/_integrations/netio.markdown index f2001c6c57d..97f5fd696b4 100644 --- a/source/_integrations/netio.markdown +++ b/source/_integrations/netio.markdown @@ -6,6 +6,7 @@ ha_category: - Switch ha_iot_class: Local Polling ha_release: 0.24 +ha_domain: netio --- The `netio` switch platform allows you to control your [Netio](https://www.netio-products.com/en/overview/) Netio4, Netio4 All, and Netio 230B. These are smart outlets controllable through Ethernet and/or Wi-Fi that reports consumptions (Netio4all). diff --git a/source/_integrations/neurio_energy.markdown b/source/_integrations/neurio_energy.markdown index 5787bad8502..cb08b5cf867 100644 --- a/source/_integrations/neurio_energy.markdown +++ b/source/_integrations/neurio_energy.markdown @@ -6,6 +6,7 @@ ha_category: - Energy ha_iot_class: Cloud Polling ha_release: 0.14 +ha_domain: neurio_energy --- Integrate your [Neurio](https://neur.io/) meter information into Home Assistant. To get an API key and secret, login to your [Neurio account](https://my.neur.io/#settings/applications/register) and register an application. Note the Homepage URL and Callback URL are optional. diff --git a/source/_integrations/nextbus.markdown b/source/_integrations/nextbus.markdown index b566cc6432b..103886653f7 100644 --- a/source/_integrations/nextbus.markdown +++ b/source/_integrations/nextbus.markdown @@ -1,7 +1,6 @@ --- title: NextBus description: Instructions on how to use public transit data from Nextbus in Home Assistant. -logo: train.png ha_category: - Transport - Sensor @@ -9,6 +8,7 @@ ha_iot_class: Local Polling ha_release: 0.93 ha_codeowners: - '@vividboarder' +ha_domain: nextbus --- The `nextbus` sensor will give you the next departure time and associated data from your public transit station/stop. The data comes from [NextBus](https://www.nextbus.com), which provides real time transit data for a number of transit authorities. diff --git a/source/_integrations/nfandroidtv.markdown b/source/_integrations/nfandroidtv.markdown index a4cdb5fe67e..e36db452f75 100644 --- a/source/_integrations/nfandroidtv.markdown +++ b/source/_integrations/nfandroidtv.markdown @@ -1,10 +1,10 @@ --- title: Notifications for Android TV / FireTV description: Notifications for Android TV / FireTV -logo: nfandroidtv.png ha_category: - Notifications ha_release: 0.32 +ha_domain: nfandroidtv --- Notification platform for [Notifications for Android TV](https://play.google.com/store/apps/details?id=de.cyberdream.androidtv.notifications.google) and [Notifications for FireTV](https://play.google.com/store/apps/details?id=de.cyberdream.firenotifications.google). You can use this plarform to send notifications to your Android TV device. An overlay with the message content will appear for a configurable amount of seconds and then disapper again. Sending images (e.g., security cam) is supported too. diff --git a/source/_integrations/niko_home_control.markdown b/source/_integrations/niko_home_control.markdown index 27d34f039ce..f2a1ef75d67 100644 --- a/source/_integrations/niko_home_control.markdown +++ b/source/_integrations/niko_home_control.markdown @@ -6,6 +6,7 @@ ha_category: - Light ha_iot_class: Local Polling ha_release: 0.82 +ha_domain: niko_home_control --- The `niko_home_control` platform allows you to integrate your [Niko Home Control](https://www.niko.eu/enus/products/niko-home-control) into Home Assistant. diff --git a/source/_integrations/nilu.markdown b/source/_integrations/nilu.markdown index f93dbb238df..9dfce24be8c 100644 --- a/source/_integrations/nilu.markdown +++ b/source/_integrations/nilu.markdown @@ -8,6 +8,7 @@ ha_iot_class: Cloud Polling ha_release: 0.87 ha_codeowners: - '@hfurubotten' +ha_domain: nilu --- The `nilu` air quality platform shows measurements of current air quality from NILU (Norsk Institutt for luftforskning/Norwegian Institute for Air Research) sensor stations within Norway. Makes data from the open API at [luftkvalitet.info](http://luftkvalitet.info/) and [nilu.no](https://nilu.no/) available in Home Assistant. diff --git a/source/_integrations/nissan_leaf.markdown b/source/_integrations/nissan_leaf.markdown index 17570ddd14f..140b619f242 100644 --- a/source/_integrations/nissan_leaf.markdown +++ b/source/_integrations/nissan_leaf.markdown @@ -1,13 +1,13 @@ --- title: Nissan Leaf description: Instructions for how to integrate Nissan Leaf(s) into Home Assistant. -logo: nissan.png ha_category: - Car ha_release: 0.89 ha_iot_class: Cloud Polling ha_codeowners: - '@filcole' +ha_domain: nissan_leaf --- The `nissan_leaf` integration offers integration with the [NissanConnect EV](https://youplus.nissan.co.uk/GB/en/YouPlus/ConnectedServices.html) cloud service. NissanConnect EV was previously known as Nissan Carwings. It offers: @@ -41,7 +41,7 @@ region: required: true type: string update_interval: - description: The interval between updates if the climate control is off and the car is not charging. Set in any time unit (e.g. minutes, hours, days!). + description: The interval between updates if the climate control is off and the car is not charging. Set in any time unit (e.g., minutes, hours, days!). required: false default: 1 hour type: time diff --git a/source/_integrations/nmap_tracker.markdown b/source/_integrations/nmap_tracker.markdown index dbe44deb1fb..12b252d2cf7 100644 --- a/source/_integrations/nmap_tracker.markdown +++ b/source/_integrations/nmap_tracker.markdown @@ -1,10 +1,10 @@ --- title: Nmap Tracker description: Instructions on how to integrate Nmap into Home Assistant. -logo: nmap.png ha_category: - Presence Detection ha_release: 0.7 +ha_domain: nmap_tracker --- As an alternative to the router-based device tracking, it is possible to directly scan the network for devices by using Nmap. The IP addresses to scan can be specified in any format that Nmap understands, including the network-prefix notation (`192.168.1.1/24`) and the range notation (`192.168.1.1-255`). diff --git a/source/_integrations/nmbs.markdown b/source/_integrations/nmbs.markdown index 44bd236d168..b353dabe94c 100644 --- a/source/_integrations/nmbs.markdown +++ b/source/_integrations/nmbs.markdown @@ -1,13 +1,13 @@ --- title: NMBS description: Instructions on how to integrate timetable data for traveling on the NMBS Belgian Railway within Home Assistant. -logo: sncb_nmbs.gif ha_category: - Transport ha_iot_class: Cloud Polling ha_release: 0.85 ha_codeowners: - '@thibmaek' +ha_domain: nmbs --- The `nmbs` platform will create sensors for monitoring travel time and information between 2 stations. diff --git a/source/_integrations/no_ip.markdown b/source/_integrations/no_ip.markdown index 249e6c0d81b..a01faf6267a 100644 --- a/source/_integrations/no_ip.markdown +++ b/source/_integrations/no_ip.markdown @@ -7,6 +7,7 @@ ha_category: ha_release: 0.57 ha_codeowners: - '@fabaff' +ha_domain: no_ip --- With the `no_ip` integration you can keep your current IP address in sync with your [NO-IP.com](https://www.noip.com) hostname or domain. diff --git a/source/_integrations/noaa_tides.markdown b/source/_integrations/noaa_tides.markdown index c52b1f783bc..8c3b18a42e2 100644 --- a/source/_integrations/noaa_tides.markdown +++ b/source/_integrations/noaa_tides.markdown @@ -4,7 +4,7 @@ description: Instructions to add NOAA Tide information to Home Assistant. ha_category: - Environment ha_release: 0.75 -logo: noaa.png +ha_domain: noaa_tides --- The `noaa_tides` sensor platform uses details from [NOAA Tides and Currents](https://tidesandcurrents.noaa.gov/api/) to provide information about the prediction for the tides for any location in the United States. diff --git a/source/_integrations/norway_air.markdown b/source/_integrations/norway_air.markdown index e2fe99deaf2..5f7b2a1bf21 100644 --- a/source/_integrations/norway_air.markdown +++ b/source/_integrations/norway_air.markdown @@ -1,11 +1,11 @@ --- title: Om Luftkvalitet i Norge (Norway Air) description: Display the current status of Norway air quality. -logo: metno.png ha_category: - Health ha_iot_class: Cloud Polling ha_release: 0.88 +ha_domain: norway_air --- The `norway_air` integration [queries](https://luftkvalitet.miljostatus.no/) the Norway air quality [data feed](https://api.met.no/weatherapi/airqualityforecast/0.1/documentation) provided by the Norwegian Meteorological Institute. diff --git a/source/_integrations/notify.command_line.markdown b/source/_integrations/notify.command_line.markdown index 44c6db4e684..bfdea7bc706 100644 --- a/source/_integrations/notify.command_line.markdown +++ b/source/_integrations/notify.command_line.markdown @@ -1,10 +1,10 @@ --- title: "Command line Notify" description: "Instructions on how to add command line notifications to Home Assistant." -logo: command_line.png ha_category: - Notifications ha_release: 0.14 +ha_domain: command_line --- The `command_line` platform allows you to use external tools for notifications from Home Assistant. The message will be passed in as STDIN. diff --git a/source/_integrations/notify.group.markdown b/source/_integrations/notify.group.markdown index 818118ee923..e14e8d0f829 100644 --- a/source/_integrations/notify.group.markdown +++ b/source/_integrations/notify.group.markdown @@ -1,11 +1,11 @@ --- title: "Notify Group" description: "Instructions on how to setup the notify group platform." -logo: home-assistant.png ha_category: - Notifications ha_release: 0.26 ha_quality_scale: internal +ha_domain: group --- The `group` notification platform allows you to combine multiple `notify` platforms into a single service. @@ -35,7 +35,7 @@ services: type: list keys: service: - description: The service part of an entity ID, e.g. if you use `notify.html5` normally, just put `html5`. Note that you must put everything in lower case here. Although you might have capitals written in the actual notification services! + description: The service part of an entity ID, e.g., if you use `notify.html5` normally, just put `html5`. Note that you must put everything in lower case here. Although you might have capitals written in the actual notification services! required: true type: string data: diff --git a/source/_integrations/notify.knx.markdown b/source/_integrations/notify.knx.markdown index 1d536fd88d0..770735557d1 100644 --- a/source/_integrations/notify.knx.markdown +++ b/source/_integrations/notify.knx.markdown @@ -1,11 +1,11 @@ --- title: "KNX Notify" description: "Instructions on how to use the KNX notify with Home Assistant." -logo: knx.png ha_category: - Notifications ha_release: 0.53 ha_iot_class: Local Push +ha_domain: knx ---
    diff --git a/source/_integrations/notify.markdown b/source/_integrations/notify.markdown index a698217140f..8173f18abad 100644 --- a/source/_integrations/notify.markdown +++ b/source/_integrations/notify.markdown @@ -1,13 +1,13 @@ --- title: Notifications description: Instructions on how to add user notifications to Home Assistant. -logo: home-assistant.png ha_category: - Notifications ha_release: 0.7 ha_quality_scale: internal ha_codeowners: - '@home-assistant/core' +ha_domain: notify --- 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. diff --git a/source/_integrations/notify.mysensors.markdown b/source/_integrations/notify.mysensors.markdown index b5f9628e0ed..927dc3b3e7a 100644 --- a/source/_integrations/notify.mysensors.markdown +++ b/source/_integrations/notify.mysensors.markdown @@ -1,12 +1,12 @@ --- title: "MySensors Notify" description: "Instructions on how to integrate MySensors notifications into Home Assistant." -logo: mysensors.png ha_category: - DIY - Notifications ha_release: 0.36 ha_iot_class: Local Push +ha_domain: mysensors --- Integrates MySensors notifications into Home Assistant. See the [main integration](/integrations/mysensors/) for configuration instructions. diff --git a/source/_integrations/notify.rest.markdown b/source/_integrations/notify.rest.markdown index 2c36aaec529..3a937a3d8a5 100644 --- a/source/_integrations/notify.rest.markdown +++ b/source/_integrations/notify.rest.markdown @@ -1,10 +1,10 @@ --- title: "REST" description: "Instructions on how to add RESTful notifications to Home Assistant." -logo: restful.png ha_category: - Notifications ha_release: 0.13 +ha_domain: rest --- The `rest` notification platform allows you to deliver [RESTful](https://en.wikipedia.org/wiki/Representational_state_transfer) notifications from Home Assistant to another party. diff --git a/source/_integrations/notion.markdown b/source/_integrations/notion.markdown index 10e7bf5b8ac..9a3ca95e265 100644 --- a/source/_integrations/notion.markdown +++ b/source/_integrations/notion.markdown @@ -11,6 +11,7 @@ ha_iot_class: Cloud Polling ha_config_flow: true ha_codeowners: - '@bachya' +ha_domain: notion --- The `Notion` component retrieves data from [Notion](https://getnotion.com) wireless diff --git a/source/_integrations/nsw_fuel_station.markdown b/source/_integrations/nsw_fuel_station.markdown index 187e32b5bf8..6c75b42c306 100644 --- a/source/_integrations/nsw_fuel_station.markdown +++ b/source/_integrations/nsw_fuel_station.markdown @@ -1,13 +1,13 @@ --- title: NSW Fuel Station Price description: Instructions on how to integrate NSW fuel station prices into Home Assistant. -logo: fuelcheck.png ha_category: - Car ha_release: 0.72 ha_iot_class: Cloud Polling ha_codeowners: - '@nickw444' +ha_domain: nsw_fuel_station --- The `nsw_fuel_station` sensor platform uses the [NSW Fuel Check App](https://www.fuelcheck.nsw.gov.au/app) data as a source for current fuel price data. diff --git a/source/_integrations/nsw_rural_fire_service_feed.markdown b/source/_integrations/nsw_rural_fire_service_feed.markdown index 3cb81cea930..594c787cdba 100644 --- a/source/_integrations/nsw_rural_fire_service_feed.markdown +++ b/source/_integrations/nsw_rural_fire_service_feed.markdown @@ -1,13 +1,13 @@ --- title: NSW Rural Fire Service Incidents description: Instructions on how to integrate the NSW Rural Fire Service Incidents feed into Home Assistant. -logo: nsw-rural-fire-service.png ha_category: - Geolocation ha_iot_class: Cloud Polling ha_release: 0.81 ha_codeowners: - '@exxamalte' +ha_domain: nsw_rural_fire_service_feed --- The `nsw_rural_fire_service_feed` platform lets you integrate a GeoJSON feed provided by the [NSW Rural Fire Service](https://www.rfs.nsw.gov.au/fire-information/fires-near-me) with information about bush fires, grass fires, hazard reductions and more. It retrieves incidents from a feed and shows information of those incidents filtered by distance to Home Assistant's location. diff --git a/source/_integrations/nuheat.markdown b/source/_integrations/nuheat.markdown index 5331e6676a3..76ec7bb89ef 100644 --- a/source/_integrations/nuheat.markdown +++ b/source/_integrations/nuheat.markdown @@ -1,11 +1,11 @@ --- title: NuHeat description: Instructions on how to integrate your NuHeat Signature thermostats within Home Assistant. -logo: nuheat.png ha_category: - Climate ha_release: 0.61 ha_iot_class: Cloud Polling +ha_domain: nuheat --- The `nuheat` integration lets control your connected [NuHeat Signature](https://www.nuheat.com/products/thermostats/signature-thermostat) floor heating thermostats from [NuHeat](https://www.nuheat.com/). diff --git a/source/_integrations/nuimo_controller.markdown b/source/_integrations/nuimo_controller.markdown index 5e61ab57a3f..0d628bd7256 100644 --- a/source/_integrations/nuimo_controller.markdown +++ b/source/_integrations/nuimo_controller.markdown @@ -6,6 +6,7 @@ ha_category: - Hub ha_release: 0.29 ha_iot_class: Local Polling +ha_domain: nuimo_controller --- The `nuimo_controller` integration allows you to connect to a [Nuimo](https://www.senic.com/) device for receiving input events and displaying on the LED matrix via the [Nuimo SDK for Python on Linux](https://github.com/getSenic/nuimo-linux-python). diff --git a/source/_integrations/nuki.markdown b/source/_integrations/nuki.markdown index 159c40f6935..7eae26f0355 100644 --- a/source/_integrations/nuki.markdown +++ b/source/_integrations/nuki.markdown @@ -8,6 +8,7 @@ ha_release: 0.38 ha_iot_class: Local Polling ha_codeowners: - '@pvizeli' +ha_domain: nuki --- The `nuki` platform allows you to control [Nuki Smart Locks](https://nuki.io/en/smart-lock/) via either a [software bridge](https://play.google.com/store/apps/details?id=io.nuki.bridge) or a [physical bridge](https://nuki.io/en/bridge/). diff --git a/source/_integrations/nut.markdown b/source/_integrations/nut.markdown index 2e01891eed5..d467b8299eb 100644 --- a/source/_integrations/nut.markdown +++ b/source/_integrations/nut.markdown @@ -1,11 +1,11 @@ --- title: Network UPS Tools (NUT) description: Instructions on how to set up NUT sensors within Home Assistant. -logo: nut.png ha_category: - System Monitor ha_iot_class: Local Polling ha_release: 0.34 +ha_domain: nut --- The `nut` sensor platform allows you to monitor a UPS (battery backup) by using data from a [NUT](https://networkupstools.org/) (Network UPS Tools) server. @@ -85,7 +85,7 @@ ups.firmware: 868.L3 -P.D battery.mfr.ups.serial: 3B1519X19994 ups.productid: 0002 battery.runtime: 2552 -battery.battery.voltage.nominal: 24.0 +battery.voltage.nominal: 24.0 battery.type: PbAc ups.mfr.ups.status: OL ups.model: Back-UPS RS1000G diff --git a/source/_integrations/nws.markdown b/source/_integrations/nws.markdown index dce83748050..faf3cba885e 100644 --- a/source/_integrations/nws.markdown +++ b/source/_integrations/nws.markdown @@ -1,12 +1,12 @@ --- title: National Weather Service (NWS) description: Instructions on how to integrate National Weather Service data within Home Assistant. -logo: nws.png ha_category: Weather ha_release: 0.99 ha_iot_class: Cloud Polling ha_codeowners: - '@MatthewFlamm' +ha_domain: nws --- The `nws` platform uses the [National Weather Service](https://www.weather.gov) web API as a source for meteorological data for your location. diff --git a/source/_integrations/nx584.markdown b/source/_integrations/nx584.markdown index f7a30d8de03..83e28e2fdac 100644 --- a/source/_integrations/nx584.markdown +++ b/source/_integrations/nx584.markdown @@ -7,6 +7,7 @@ ha_category: - Binary Sensor ha_release: 0.13 ha_iot_class: Local Push +ha_domain: nx584 --- The `nx584` platform provides integration with GE, Caddx, Interlogix (and other brands) alarm panels that support the NX584 interface module (or have it built in). Supported panels include NX4/6/8/8E. Actual integration is done through [pynx584](https://github.com/kk7ds/pynx584) which is required for this to work. diff --git a/source/_integrations/nzbget.markdown b/source/_integrations/nzbget.markdown index 73227fcca4f..04493d42663 100644 --- a/source/_integrations/nzbget.markdown +++ b/source/_integrations/nzbget.markdown @@ -8,6 +8,7 @@ ha_iot_class: Local Polling ha_release: 0.17 ha_codeowners: - '@chriscla' +ha_domain: nzbget --- The `nzbget` platform will allow you to monitor and control your downloads with [NZBGet](https://nzbget.net/) from within Home Assistant and setup automation based on the information. diff --git a/source/_integrations/oasa_telematics.markdown b/source/_integrations/oasa_telematics.markdown index c196a43cf11..22d16469f0c 100644 --- a/source/_integrations/oasa_telematics.markdown +++ b/source/_integrations/oasa_telematics.markdown @@ -1,12 +1,12 @@ --- title: OASA Telematics description: Instructions on how to integrate bus and trolley arrival data for Greek OASA Telematics within Home Assistant. -logo: oasa.png ha_category: - Transport - Sensor ha_iot_class: Cloud Polling ha_release: 0.92 +ha_domain: oasa_telematics --- The `oasa_telematics` sensor will provide you with bus and trolley arrival times for Greek public transport for Athens, using real-time data from [OASA Telematics](http://telematics.oasa.gr/en/). diff --git a/source/_integrations/obihai.markdown b/source/_integrations/obihai.markdown index 5ce241dac60..7c85b4e8711 100644 --- a/source/_integrations/obihai.markdown +++ b/source/_integrations/obihai.markdown @@ -8,6 +8,7 @@ ha_category: ha_release: 0.99 ha_codeowners: - '@dshokouhi' +ha_domain: obihai --- The `obihai` integration allows you to view the call status for your [Obihai devices](https://www.obitalk.com/info/products#home_section). diff --git a/source/_integrations/octoprint.markdown b/source/_integrations/octoprint.markdown index 1e02df05718..b259aa96cd9 100644 --- a/source/_integrations/octoprint.markdown +++ b/source/_integrations/octoprint.markdown @@ -1,13 +1,13 @@ --- title: OctoPrint description: Instructions on how to setup the OctoPrint in Home Assistant. -logo: octoprint.png ha_category: - Hub - Binary Sensor - Sensor ha_release: 0.19 ha_iot_class: Local Polling +ha_domain: octoprint --- [OctoPrint](https://octoprint.org/) is a web interface for your 3D printer. This is the main integration to integrate OctoPrint sensors. diff --git a/source/_integrations/oem.markdown b/source/_integrations/oem.markdown index 0ea4552f154..4c20c40dc43 100644 --- a/source/_integrations/oem.markdown +++ b/source/_integrations/oem.markdown @@ -1,11 +1,11 @@ --- title: OpenEnergyMonitor WiFi Thermostat description: Instructions on how to integrate an OpenEnergyMonitor thermostat with Home Assistant. -logo: oem.png ha_category: - Climate ha_release: 0.39 ha_iot_class: Local Polling +ha_domain: oem --- This platform supports the ESP8266 based "WiFi MQTT Relay / Thermostat" sold by [OpenEnergyMonitor](https://shop.openenergymonitor.com/wifi-mqtt-relay-thermostat/). The underlying [library](https://oemthermostat.readthedocs.io/) only supports this single relay variant of the [original device](https://harizanov.com/2014/12/wifi-iot-3-channel-relay-board-with-mqtt-and-http-api-using-esp8266/). diff --git a/source/_integrations/ohmconnect.markdown b/source/_integrations/ohmconnect.markdown index 49318b7cc66..5375baeed78 100644 --- a/source/_integrations/ohmconnect.markdown +++ b/source/_integrations/ohmconnect.markdown @@ -8,6 +8,7 @@ ha_iot_class: Cloud Polling ha_release: 0.26 ha_codeowners: - '@robbiet480' +ha_domain: ohmconnect --- The `ohmconnect` sensor will show you the current [OhmConnect](https://www.ohmconnect.com/) status for the given OhmConnect ID. diff --git a/source/_integrations/ombi.markdown b/source/_integrations/ombi.markdown index 97e8dc7c888..6bba7f8a41a 100644 --- a/source/_integrations/ombi.markdown +++ b/source/_integrations/ombi.markdown @@ -1,13 +1,13 @@ --- title: Ombi description: Instructions on how to set up the Ombi integration in Home Assistant. -logo: ombi.png ha_category: - Sensor ha_release: '0.100' ha_iot_class: Local Polling ha_codeowners: - '@larssont' +ha_domain: ombi --- The `Ombi` integration monitors data from your [Ombi](https://ombi.io) instance. diff --git a/source/_integrations/onboarding.markdown b/source/_integrations/onboarding.markdown index 0b388c10b1f..81e5bc85ef3 100644 --- a/source/_integrations/onboarding.markdown +++ b/source/_integrations/onboarding.markdown @@ -1,13 +1,13 @@ --- title: Home Assistant Onboarding description: This integration is responsible for providing the onboarding endpoints. -logo: home-assistant.png ha_category: - Other ha_release: 0.73 ha_quality_scale: internal ha_codeowners: - '@home-assistant/core' +ha_domain: onboarding --- This integration creates the endpoints for the onboarding that is built into Home Assistant. There are no configuration options for this integration directly. diff --git a/source/_integrations/onewire.markdown b/source/_integrations/onewire.markdown index 410f1b5b8e5..2e73d9fb71b 100644 --- a/source/_integrations/onewire.markdown +++ b/source/_integrations/onewire.markdown @@ -1,13 +1,13 @@ --- title: 1-Wire description: Instructions on how to integrate One wire (1-wire) sensors into Home Assistant. -logo: onewire.png ha_category: - DIY ha_release: 0.12 ha_iot_class: Local Polling ha_codeowners: - '@garbled1' +ha_domain: onewire --- The `onewire` platform supports sensors which that using the One wire (1-wire) bus for communication. diff --git a/source/_integrations/onkyo.markdown b/source/_integrations/onkyo.markdown index 11ed3559705..f53461ff286 100644 --- a/source/_integrations/onkyo.markdown +++ b/source/_integrations/onkyo.markdown @@ -6,6 +6,7 @@ ha_category: - Media Player ha_release: 0.17 ha_iot_class: Local Polling +ha_domain: onkyo --- The `onkyo` platform allows you to control a [Onkyo](http://www.onkyo.com/), [Integra](http://www.integrahometheater.com/) @@ -38,7 +39,7 @@ name: required: false type: string max_volume: - description: Maximum volume as a percentage. Often the maximum volume of the receiver is far too loud. Setting this wil set Home Assistant's 100% volume to be this setting on the amp. i.e. if you set this to 50% when you set Home Assistant to be 100% then your receiver will be set to 50% of it's maximum volume. + description: Maximum volume as a percentage. Often the maximum volume of the receiver is far too loud. Setting this wil set Home Assistant's 100% volume to be this setting on the amp. i.e., if you set this to 50% when you set Home Assistant to be 100% then your receiver will be set to 50% of it's maximum volume. required: false default: 100 type: integer diff --git a/source/_integrations/onvif.markdown b/source/_integrations/onvif.markdown index 119ca5a7fd3..4ac96c9aea8 100644 --- a/source/_integrations/onvif.markdown +++ b/source/_integrations/onvif.markdown @@ -5,6 +5,7 @@ logo: onvif.png ha_category: - Camera ha_release: 0.47 +ha_domain: onvif --- The `onvif` camera platform allows you to use an [ONVIF](https://www.onvif.org/) camera in Home Assistant. This requires the [`ffmpeg` component](/integrations/ffmpeg/) to be already configured. @@ -59,7 +60,7 @@ extra_arguments: Most of the ONVIF cameras support more than one audio/video profile. Each profile provides different image quality. Usually, the first profile has the highest quality and it is the profile used by default. However, you may want to use a lower quality image. One of the reasons may be that your hardware isn't able to render the highest quality image in real-time, especially when running on Raspberry Pi. Therefore you can choose which profile do you want to use by setting in configuration `profile` variable. -### Service `camera.onvif_ptz` +### Service `onvif.ptz` If your ONVIF camera supports PTZ, you will be able to pan, tilt or zoom your camera. @@ -69,5 +70,9 @@ If your ONVIF camera supports PTZ, you will be able to pan, tilt or zoom your ca | `tilt` | Tilt direction. Allowed values: `UP`, `DOWN`, `NONE` | `pan` | Pan direction. Allowed values: `RIGHT`, `LEFT`, `NONE` | `zoom` | Zoom. Allowed values: `ZOOM_IN`, `ZOOM_OUT`, `NONE` +| `distance` | Distance coefficient. Sets how much PTZ should be executed in one request. Allowed values: floating point numbers, 0 to 1. Default : 0.1 +| `speed` | Speed coefficient. Sets how fast PTZ will be executed. Allowed values: floating point numbers, 0 to 1. Default : 0.5 +| `move_mode` | PTZ moving mode. Allowed values: `ContinuousMove`, `RelativeMove`, `AbsoluteMove`. Default :`RelativeMove` +| `continuous_duration` | Set ContinuousMove delay in seconds before stoping the move. Allowed values: floating point numbers or integer. Default : 0.5 If you are running into trouble with this sensor, please refer to the [Troubleshooting section](/integrations/ffmpeg/#troubleshooting). diff --git a/source/_integrations/openalpr_cloud.markdown b/source/_integrations/openalpr_cloud.markdown index ed50164be1c..bc134b3ae3c 100644 --- a/source/_integrations/openalpr_cloud.markdown +++ b/source/_integrations/openalpr_cloud.markdown @@ -1,10 +1,10 @@ --- title: OpenALPR Cloud description: Instructions on how to integrate licences plates with OpenALPR cloud into Home Assistant. -logo: openalpr.png ha_category: - Image Processing ha_release: 0.36 +ha_domain: openalpr_cloud --- [OpenALPR](https://www.openalpr.com/) integration for Home Assistant allows you diff --git a/source/_integrations/openalpr_local.markdown b/source/_integrations/openalpr_local.markdown index 25af79e4481..1c136d8e017 100644 --- a/source/_integrations/openalpr_local.markdown +++ b/source/_integrations/openalpr_local.markdown @@ -1,10 +1,10 @@ --- title: OpenALPR Local description: Instructions on how to integrate licences plates with OpenALPR local into Home Assistant. -logo: openalpr.png ha_category: - Image Processing ha_release: 0.36 +ha_domain: openalpr_local --- [OpenALPR](https://www.openalpr.com/) integration for Home Assistant allows you diff --git a/source/_integrations/opencv.markdown b/source/_integrations/opencv.markdown index e6ba96bb72d..468fc4528f3 100644 --- a/source/_integrations/opencv.markdown +++ b/source/_integrations/opencv.markdown @@ -1,10 +1,10 @@ --- title: OpenCV description: Instructions on how to integrate OpenCV image processing into Home Assistant. -logo: opencv.png ha_category: - Image Processing ha_release: 0.47 +ha_domain: opencv --- [OpenCV](https://www.opencv.org/) is an open source computer vision image and video processing library. diff --git a/source/_integrations/openevse.markdown b/source/_integrations/openevse.markdown index 9b7d532e17f..1ef6dfe6582 100644 --- a/source/_integrations/openevse.markdown +++ b/source/_integrations/openevse.markdown @@ -6,6 +6,7 @@ ha_category: - Car ha_release: 0.38 ha_iot_class: Local Polling +ha_domain: openevse --- This `openevse` sensor platform pulls data from an [OpenEVSE](https://www.openevse.com/) Charging station equipped with an ESP8266-based Wi-Fi connection. diff --git a/source/_integrations/openexchangerates.markdown b/source/_integrations/openexchangerates.markdown index 8f9d67f5d28..3c89d3283d9 100644 --- a/source/_integrations/openexchangerates.markdown +++ b/source/_integrations/openexchangerates.markdown @@ -6,6 +6,7 @@ ha_category: logo: openexchangerates.png ha_iot_class: Cloud Polling ha_release: 0.23 +ha_domain: openexchangerates --- The `openexchangerates` sensor will show you the current exchange rate from [Open Exchange Rates](https://openexchangerates.org) that provides realtime exchange rates for [170 currencies](https://openexchangerates.org/currencies). The free account is limited to only USD as a base currency, allows 1000 requests per month, and updates every hour. diff --git a/source/_integrations/opengarage.markdown b/source/_integrations/opengarage.markdown index 43145cb8cb1..0d01ed9f00c 100644 --- a/source/_integrations/opengarage.markdown +++ b/source/_integrations/opengarage.markdown @@ -5,6 +5,7 @@ logo: opengarage.png ha_category: - DIY ha_release: 0.44 +ha_domain: opengarage --- The `opengarage` cover platform lets you control the open-source [OpenGarage.io](https://opengarage.io/) device through Home Assistant. diff --git a/source/_integrations/openhardwaremonitor.markdown b/source/_integrations/openhardwaremonitor.markdown index 15a6f3c9cae..273810aee66 100644 --- a/source/_integrations/openhardwaremonitor.markdown +++ b/source/_integrations/openhardwaremonitor.markdown @@ -1,11 +1,11 @@ --- title: Open Hardware Monitor description: Instructions on how to integrate Open Hardware Monitor within Home Assistant. -logo: openhardwaremonitor.png ha_category: - System Monitor ha_release: 0.48 ha_iot_class: Local Polling +ha_domain: openhardwaremonitor --- The `openhardwaremonitor` platform uses your [Open Hardware Monitor](https://openhardwaremonitor.org/) installation as a source for sensors that will display system information. diff --git a/source/_integrations/openhome.markdown b/source/_integrations/openhome.markdown index aa1c3b80b61..83ab3b9a533 100644 --- a/source/_integrations/openhome.markdown +++ b/source/_integrations/openhome.markdown @@ -1,11 +1,11 @@ --- title: Linn / OpenHome description: Instructions on how to integrate Linn Ds and Openhome renderers into Home Assistant. -logo: linn.png ha_category: - Media Player ha_release: 0.39 ha_iot_class: Local Polling +ha_domain: openhome --- The `openhome` platform allows you to connect an [Openhome Compliant Renderer](http://openhome.org/) to Home Assistant such as a [Linn Products Ltd](https://www.linn.co.uk) HiFi streamer. It will allow you to control media playback, volume, source and see the current playing item. Openhome devices should be discovered by using the [the discovery component](/integrations/discovery/), their device names are taken from the name of the room configured on the device. diff --git a/source/_integrations/opensensemap.markdown b/source/_integrations/opensensemap.markdown index d4fc4740335..d6805ba6d19 100644 --- a/source/_integrations/opensensemap.markdown +++ b/source/_integrations/opensensemap.markdown @@ -1,11 +1,11 @@ --- title: openSenseMap description: Instructions on how to setup openSenseMap sensors in Home Assistant. -logo: opensensemap.png ha_category: - Health ha_release: 0.85 ha_iot_class: Cloud Polling +ha_domain: opensensemap --- The `opensensemap` air quality platform will query the open data API of [openSenseMap.org](https://opensensemap.org/) to monitor air quality sensor station. diff --git a/source/_integrations/opensky.markdown b/source/_integrations/opensky.markdown index e0c42edada5..833cca573ff 100644 --- a/source/_integrations/opensky.markdown +++ b/source/_integrations/opensky.markdown @@ -6,6 +6,7 @@ ha_category: - Transport ha_release: 0.43 ha_iot_class: Cloud Polling +ha_domain: opensky --- The `opensky` sensor allows one to track overhead flights in a given region. It uses crowd-sourced data from the [OpenSky Network](https://opensky-network.org/) public API. It will also fire Home Assistant events when flights enter and exit the defined region. diff --git a/source/_integrations/opentherm_gw.markdown b/source/_integrations/opentherm_gw.markdown index c950c25b75d..8340840900b 100644 --- a/source/_integrations/opentherm_gw.markdown +++ b/source/_integrations/opentherm_gw.markdown @@ -1,7 +1,6 @@ --- title: OpenTherm Gateway description: Control your OpenTherm Gateway from Home Assistant. -logo: opentherm.png ha_category: - Hub - Binary Sensor @@ -12,6 +11,7 @@ ha_iot_class: Local Push ha_config_flow: true ha_codeowners: - '@mvn23' +ha_domain: opentherm_gw --- The `opentherm_gw` integration is used to control the [OpenTherm Gateway](http://otgw.tclcode.com/) from Home Assistant. diff --git a/source/_integrations/openuv.markdown b/source/_integrations/openuv.markdown index 1f9cb3f2de5..550d5a1de09 100644 --- a/source/_integrations/openuv.markdown +++ b/source/_integrations/openuv.markdown @@ -1,7 +1,6 @@ --- title: Openuv description: Instructions on how to integrate OpenUV within Home Assistant. -logo: openuv.jpg ha_category: - Health - Binary Sensor @@ -11,6 +10,7 @@ ha_iot_class: Cloud Polling ha_config_flow: true ha_codeowners: - '@bachya' +ha_domain: openuv --- The `openuv` integration displays UV and Ozone data from [openuv.io](https://www.openuv.io/). diff --git a/source/_integrations/openweathermap.markdown b/source/_integrations/openweathermap.markdown index 89a59a0a943..c72d30c3e39 100644 --- a/source/_integrations/openweathermap.markdown +++ b/source/_integrations/openweathermap.markdown @@ -1,7 +1,6 @@ --- title: Openweathermap description: Instructions on how to integrate OpenWeatherMap within Home Assistant. -logo: openweathermap.png ha_category: - Weather - Sensor @@ -9,6 +8,7 @@ ha_release: 0.32 ha_iot_class: Cloud Polling ha_codeowners: - '@fabaff' +ha_domain: openweathermap --- The `openweathermap` weather platform uses [OpenWeatherMap](https://openweathermap.org/) as a source for current meteorological data for your location. diff --git a/source/_integrations/openwrt.markdown b/source/_integrations/openwrt.markdown deleted file mode 100644 index 90fee925772..00000000000 --- a/source/_integrations/openwrt.markdown +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: "OpenWRT" -description: "Instructions on how to integrate OpenWrt routers into Home Assistant." -logo: openwrt.png -ha_category: - - Presence Detection -ha_release: pre 0.7 ---- - -There are _multiple_ ways of integrating an OpenWrt router for presence detection. A broad distinction can be made between presence detection methods which actively scan for devices (by default every 12 seconds) and those that are notified by some external service on changes. It is essentially a problem of synchronizing states between two remote machines. - -* __active scanning__ - Scan for devices regularly. - * Advantages: - * robust on an unreliable set-up where the the router may not be reachable occasionally - * Disadvantages: - * average six-second delay between connecting and being registered as `home` - * lots of unnecessary network requests - * Examples: - * [ubus](/integrations/ubus) - * [luci](/integrations/luci) -* __passive/event-based__ - External services which notify Home Assistant of devices via the [REST API endpoint](https://developers.home-assistant.io/docs/en/external_api_rest.html). - * Advantages: - * devices typically registered in under one second when they connect - * very few network requests - * Disadvantages: - * prone to missed events when connectivity between Home Assistant and the router is not guaranteed - * Examples: - * [openwrt_hass_devicetracker](https://github.com/mueslo/openwrt_hass_devicetracker) - * your own custom script - -### Event-based device tracker - -This can be achieved by running a simple shell script on the OpenWrt router which calls the appropriate Home Assistant service. An OpenWrt package which does this is listed above. As this method directly calls the [service API](https://developers.home-assistant.io/docs/en/external_api_rest.html#post-api-services-lt-domain-lt-service), no special configuration is necessary on the Home Assistant side, except for ensuring the device_tracker API is running, which is achieved by adding the following to your `configuration.yaml` file: - -```yaml -device_tracker: -``` - -To get the best of both worlds, you can combine the two approaches, running both a periodic device scanner and an event-based device tracker. - -See the [device tracker integration page](/integrations/device_tracker/) for instructions how to configure the people to be tracked. diff --git a/source/_integrations/opnsense.markdown b/source/_integrations/opnsense.markdown index e9c3e7c3e72..df643f73c88 100644 --- a/source/_integrations/opnsense.markdown +++ b/source/_integrations/opnsense.markdown @@ -1,11 +1,13 @@ --- -title: "OPNsense" -description: "Instructions on how to configure OPNsense integration" -logo: opnsense.png +title: OPNSense +description: Instructions on how to configure OPNsense integration ha_category: - Hub - Presence Detection ha_release: 0.105 +ha_codeowners: + - '@mtreinish' +ha_domain: opnsense --- [OPNsense](https://opnsense.org/) is an open source HardenedBSD based firewall diff --git a/source/_integrations/opple.markdown b/source/_integrations/opple.markdown index 7efcdeda8d3..bc915a40a09 100644 --- a/source/_integrations/opple.markdown +++ b/source/_integrations/opple.markdown @@ -1,11 +1,11 @@ --- title: Opple description: Instructions on how to integrate Opple lights into Home Assistant. -logo: opple.png ha_category: - Light ha_release: '0.80' ha_iot_class: Local Polling +ha_domain: opple --- The `opple` light platform allows you to control the state of your Opple smart light. diff --git a/source/_integrations/orangepi_gpio.markdown b/source/_integrations/orangepi_gpio.markdown index fa8fee4ba6b..4ec19164383 100644 --- a/source/_integrations/orangepi_gpio.markdown +++ b/source/_integrations/orangepi_gpio.markdown @@ -6,9 +6,9 @@ ha_category: - Binary Sensor ha_release: 0.93 ha_iot_class: Local Push -logo: orange-pi.png ha_codeowners: - '@pascallj' +ha_domain: orangepi_gpio --- The `orangepi_gpio` integration is the base for all related GPIO platforms in Home Assistant. There is no setup needed for the integration itself, for the platforms please check their corresponding pages. diff --git a/source/_integrations/oru.markdown b/source/_integrations/oru.markdown index 05188fb9e14..3f10f1fec37 100644 --- a/source/_integrations/oru.markdown +++ b/source/_integrations/oru.markdown @@ -1,13 +1,13 @@ --- title: Orange and Rockland Utility (ORU) description: Instructions on how to integrate the Orange and Rockland Utility real-time energy usage sensor within Home Assistant. -logo: oru.png ha_release: 0.101 ha_category: - Sensor ha_iot_class: Cloud Polling ha_codeowners: - '@bvlaicu' +ha_domain: oru --- [Orange and Rockland Utility](https://oru.com) is an energy provider in NY and NJ, USA. diff --git a/source/_integrations/orvibo.markdown b/source/_integrations/orvibo.markdown index 2c3287ae2aa..61a8d7e0985 100644 --- a/source/_integrations/orvibo.markdown +++ b/source/_integrations/orvibo.markdown @@ -5,6 +5,7 @@ logo: orvibo.png ha_category: - Switch ha_release: 0.8 +ha_domain: orvibo ---
    diff --git a/source/_integrations/osramlightify.markdown b/source/_integrations/osramlightify.markdown index 2986096ef80..921cccf1f38 100644 --- a/source/_integrations/osramlightify.markdown +++ b/source/_integrations/osramlightify.markdown @@ -1,10 +1,10 @@ --- title: Osramlightify description: Instructions on how to integrate Osram Lightify into Home Assistant. -logo: osramlightify.png ha_category: - Light ha_release: 0.21 +ha_domain: osramlightify --- The `osramlightify` platform allows you to integrate your [Osram Lightify](https://www.osram.com/cb/lightify/index.jsp) into Home Assistant. diff --git a/source/_integrations/otp.markdown b/source/_integrations/otp.markdown index ad9ae1b99d6..1d3e701aeed 100644 --- a/source/_integrations/otp.markdown +++ b/source/_integrations/otp.markdown @@ -1,12 +1,12 @@ --- title: One-Time Password (OTP) description: Instructions on how to add One-Time Password (OTP) sensors into Home Assistant. -logo: home-assistant.png ha_category: - Utility ha_iot_class: Local Polling ha_release: 0.49 ha_quality_scale: internal +ha_domain: otp --- The `otp` sensor generates One-Time Passwords according to [RFC6238](https://tools.ietf.org/html/rfc6238) that is compatible with most OTP generators available, including Google Authenticator. You can use this when building custom security solutions and want to use "rolling codes", that change every 30 seconds. diff --git a/source/_integrations/owntracks.markdown b/source/_integrations/owntracks.markdown index 4a8280a8eff..697a7708399 100644 --- a/source/_integrations/owntracks.markdown +++ b/source/_integrations/owntracks.markdown @@ -1,16 +1,16 @@ --- title: OwnTracks description: Instructions on how to use Owntracks to track devices in Home Assistant. -logo: owntracks.png ha_category: - Presence Detection ha_release: 0.7.4 ha_config_flow: true +ha_domain: owntracks --- [OwnTracks](https://owntracks.org/) is a free and open source application for iOS and Android that allow you to track your location and send it directly to Home Assistant. It can be set up via the integrations panel in the configuration screen. -By default the integration will listen for incoming messages from OwnTracks via HTTP. It will also listen for MQTT messages if Home Assistant is configured to use MQTT. +By default the integration will listen for incoming messages from OwnTracks via HTTP. It will also listen for MQTT messages if Home Assistant is configured to use MQTT. When a location is submitted via HTTP, Home Assistant will return all [Persons](/integrations/person/)' last known locations and they will be displayed within the OwnTracks app.
    diff --git a/source/_integrations/panasonic_bluray.markdown b/source/_integrations/panasonic_bluray.markdown index 8737679e01c..75531dc0bad 100644 --- a/source/_integrations/panasonic_bluray.markdown +++ b/source/_integrations/panasonic_bluray.markdown @@ -6,6 +6,7 @@ ha_category: - Media Player ha_iot_class: Local Polling ha_release: 0.83 +ha_domain: panasonic_bluray --- The `panasonic_bluray` platform allows you to control a Panasonic Blu-Ray player. Note that the device must be on the same subnet as Home Assistant; connections from a different subnet will return an error. diff --git a/source/_integrations/panasonic_viera.markdown b/source/_integrations/panasonic_viera.markdown index 7ac2b9d288d..1186b4e91e3 100644 --- a/source/_integrations/panasonic_viera.markdown +++ b/source/_integrations/panasonic_viera.markdown @@ -6,6 +6,7 @@ ha_category: - Media Player ha_release: 0.17 ha_iot_class: Local Polling +ha_domain: panasonic_viera --- The `panasonic_viera` platform allows you to control a Panasonic Viera TV. diff --git a/source/_integrations/pandora.markdown b/source/_integrations/pandora.markdown index 28871c2f6f4..bf7a7532fd1 100644 --- a/source/_integrations/pandora.markdown +++ b/source/_integrations/pandora.markdown @@ -6,6 +6,7 @@ ha_category: - Media Player ha_release: 0.22 ha_iot_class: Local Polling +ha_domain: pandora --- If you have a Pandora account, you can control it from Home Assistant with this media player. diff --git a/source/_integrations/panel_custom.markdown b/source/_integrations/panel_custom.markdown index 83fd4ee8388..f2e9a24093d 100644 --- a/source/_integrations/panel_custom.markdown +++ b/source/_integrations/panel_custom.markdown @@ -1,13 +1,13 @@ --- title: Custom Panel description: Instructions on how to add customized panels to the frontend of Home Assistant. -logo: home-assistant.png ha_category: - Front End ha_release: 0.26 ha_quality_scale: internal ha_codeowners: - '@home-assistant/frontend' +ha_domain: panel_custom --- The `panel_custom` support allows you to add additional panels to your Home Assistant frontend. The panels are listed in the sidebar if wished and can be highly customized. See the developer documentation on [instructions how to build your own panels](https://developers.home-assistant.io/docs/en/frontend_creating_custom_panels.html). diff --git a/source/_integrations/panel_iframe.markdown b/source/_integrations/panel_iframe.markdown index 8ca1c97e80f..e22bfd49c24 100644 --- a/source/_integrations/panel_iframe.markdown +++ b/source/_integrations/panel_iframe.markdown @@ -1,13 +1,13 @@ --- title: iframe Panel description: Instructions on how to add iFrames in the frontend of Home Assistant. -logo: home-assistant.png ha_category: - Front End ha_release: 0.25 ha_quality_scale: internal ha_codeowners: - '@home-assistant/frontend' +ha_domain: panel_iframe --- The `panel_iframe` support allows you to add additional panels to your Home Assistant frontend. The panels are listed in the sidebar and can contain external resources like the web frontend of your router, your monitoring system, or your media server. diff --git a/source/_integrations/pcal9535a.markdown b/source/_integrations/pcal9535a.markdown index e53dddbad8c..a7d782220b6 100644 --- a/source/_integrations/pcal9535a.markdown +++ b/source/_integrations/pcal9535a.markdown @@ -1,7 +1,6 @@ --- title: PCAL9535A I/O Expander description: Instructions on how to integrate the PCAL9535A GPIO pin expander with I2C interface into Home Assistant. -logo: raspberry-pi.png ha_category: - DIY - Binary Sensor @@ -10,6 +9,7 @@ ha_release: 0.102 ha_iot_class: Local Polling ha_codeowners: - '@Shulyaka' +ha_domain: pcal9535a --- The `pcal9535a` integration is the base for all related pcal9535a platforms in Home Assistant. There is no setup needed for the integration itself, for the platforms, please check their corresponding sections. diff --git a/source/_integrations/pencom.markdown b/source/_integrations/pencom.markdown index abbd993282a..6f4d0c685c0 100644 --- a/source/_integrations/pencom.markdown +++ b/source/_integrations/pencom.markdown @@ -6,6 +6,7 @@ ha_category: - Switch ha_release: 0.85 ha_iot_class: Local Polling +ha_domain: pencom --- [Pencom Design](https://www.pencomdesign.com/) is a manufacturer of computer-controlled relay, I/O and custom boards for commercial and industrial applications. This interface to [Pencom's Relay Control Boards](https://www.pencomdesign.com/relay-boards) is designed to work over an ethernet to serial adapter (NPort). Each switch (relay) can be turned on/off, and the state of the relay can be read. diff --git a/source/_integrations/persistent_notification.markdown b/source/_integrations/persistent_notification.markdown index d35450625a5..097a1f7ab74 100644 --- a/source/_integrations/persistent_notification.markdown +++ b/source/_integrations/persistent_notification.markdown @@ -1,13 +1,13 @@ --- title: Persistent Notification description: Instructions on how to integrate persistent notifications into Home Assistant. -logo: home-assistant.png ha_category: - Other ha_release: 0.23 ha_quality_scale: internal ha_codeowners: - '@home-assistant/core' +ha_domain: persistent_notification --- The `persistent_notification` integration can be used to show a notification on the frontend that has to be dismissed by the user. diff --git a/source/_integrations/person.markdown b/source/_integrations/person.markdown index b1690fe65c0..f725b40350b 100644 --- a/source/_integrations/person.markdown +++ b/source/_integrations/person.markdown @@ -1,11 +1,11 @@ --- title: Person description: Instructions on how to set up people tracking within Home Assistant. -logo: home-assistant.png ha_category: - Presence Detection ha_release: 0.88 ha_quality_scale: internal +ha_domain: person --- 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: diff --git a/source/_integrations/philips_js.markdown b/source/_integrations/philips_js.markdown index de761e932fb..3c31b13d14a 100644 --- a/source/_integrations/philips_js.markdown +++ b/source/_integrations/philips_js.markdown @@ -8,6 +8,7 @@ ha_iot_class: Local Polling ha_release: 0.34 ha_codeowners: - '@elupus' +ha_domain: philips_js --- The `philips_js` platform allows you to control Philips TVs which expose the [jointSPACE](http://jointspace.sourceforge.net/) JSON-API. Instructions on how to activate the API and if your model is supported can be found [here](http://jointspace.sourceforge.net/download.html). Note that not all listed, jointSPACE-enabled devices won't have JSON-interface running on port 1925. This is true at least for some models before year 2011. diff --git a/source/_integrations/pi_hole.markdown b/source/_integrations/pi_hole.markdown index 86729d56da2..c0afe1be90b 100644 --- a/source/_integrations/pi_hole.markdown +++ b/source/_integrations/pi_hole.markdown @@ -4,11 +4,11 @@ description: Instructions on how to integrate Pi-hole with Home Assistant. ha_category: - System Monitor ha_iot_class: Local Polling -logo: pi_hole.png ha_release: 0.28 ha_codeowners: - '@fabaff' - '@johnluetke' +ha_domain: pi_hole --- The `pi_hole` integration allows you to retrieve statistics and interact with a [Pi-hole](https://pi-hole.net/) system. @@ -26,12 +26,12 @@ pi_hole: {% configuration %} host: description: > - The hostname (and port), e.g. '192.168.0.3:4865' of the host where Pi-hole is running. Home Assistant add-on users should be sure to specify port `4865`. + The hostname (and port), e.g., '192.168.0.3:4865' of the host where Pi-hole is running. Home Assistant add-on users should be sure to specify port `4865`. required: true type: string name: description: > - The name for this Pi-hole. This name will be a part of the sensors created, e.g. `name: My Awesome Pi-hole` would result in sensor names beginning with `sensor.my_awesome_pi_hole_`. + The name for this Pi-hole. This name will be a part of the sensors created, e.g., `name: My Awesome Pi-hole` would result in sensor names beginning with `sensor.my_awesome_pi_hole_`. **Note:** If you configure multiple Pi-Holes, each one *must* have a unique name. required: false diff --git a/source/_integrations/picotts.markdown b/source/_integrations/picotts.markdown index 20aa2b554e2..9c55c8bb32a 100644 --- a/source/_integrations/picotts.markdown +++ b/source/_integrations/picotts.markdown @@ -1,10 +1,10 @@ --- title: Pico TTS description: Instructions on how to setup Pico Text-to-Speech with Home Assistant. -logo: home-assistant.png ha_category: - Text-to-speech ha_release: 0.36 +ha_domain: picotts --- The `picotts` text-to-speech platform uses offline pico Text-to-Speech engine to read a text with natural sounding voices. diff --git a/source/_integrations/piglow.markdown b/source/_integrations/piglow.markdown index e47e438137a..5d4d9abedef 100644 --- a/source/_integrations/piglow.markdown +++ b/source/_integrations/piglow.markdown @@ -1,11 +1,11 @@ --- title: Piglow description: Instructions on how to setup Piglow LED's within Home Assistant. -logo: raspberry-pi.png ha_category: - DIY ha_release: 0.37 ha_iot_class: Local Polling +ha_domain: piglow --- The `piglow` platform lets you control the [Piglow](https://shop.pimoroni.com/products/piglow) lights on your Raspberry Pi from within Home Assistant. diff --git a/source/_integrations/pilight.markdown b/source/_integrations/pilight.markdown index a28d59d1579..0ecc2b2397f 100644 --- a/source/_integrations/pilight.markdown +++ b/source/_integrations/pilight.markdown @@ -11,6 +11,7 @@ ha_release: 0.26 ha_iot_class: Local Push ha_codeowners: - '@trekky12' +ha_domain: pilight --- [Pilight](https://www.pilight.org/) is a modular and open source solution to communicate with 433 MHz devices and runs on various small form factor computers. A lot of common [protocols](https://manual.pilight.org/protocols/index.html) are already available. diff --git a/source/_integrations/ping.markdown b/source/_integrations/ping.markdown index ccdbcf83e14..245b9c15be4 100644 --- a/source/_integrations/ping.markdown +++ b/source/_integrations/ping.markdown @@ -1,13 +1,13 @@ --- title: Ping (ICMP) description: Instructions on how to integrate Ping (ICMP)-based into Home Assistant. -logo: home-assistant.png ha_category: - Network - Binary Sensor - Presence Detection ha_release: 0.43 ha_quality_scale: internal +ha_domain: ping --- There is currently support for the following device types within Home Assistant: @@ -89,7 +89,7 @@ device_tracker: {% configuration %} hosts: - description: List of device names and their corresponding IP address or hostname. + description: List of device names and their corresponding IP address or hostname. Device names must conform to the standard requirements of lower case, numbers and underscore only - see [entity names](/docs/configuration/troubleshooting/#entity-names). required: true type: list count: diff --git a/source/_integrations/pioneer.markdown b/source/_integrations/pioneer.markdown index fec895ea74a..afdbe6f12f3 100644 --- a/source/_integrations/pioneer.markdown +++ b/source/_integrations/pioneer.markdown @@ -6,6 +6,7 @@ ha_category: - Media Player ha_release: 0.19 ha_iot_class: Local Polling +ha_domain: pioneer --- The `pioneer` platform allows you to control Pioneer Network Receivers. Please note, however, that the more recent Pioneer models work with [Onkyo](/integrations/onkyo) platform instead. @@ -39,9 +40,9 @@ timeout: required: false type: float sources: - description: A list of mappings from source friendly name to the source code (e.g. `TV:'05'`). Valid source codes depend on the receiver (some known codes can be found below). Codes must be defined as strings (between single or double quotation marks) so that `05` is not implicitly transformed to `5`, which wouldn't be valid source code. + description: A list of mappings from source friendly name to the source code (e.g., `TV:'05'`). Valid source codes depend on the receiver (some known codes can be found below). Codes must be defined as strings (between single or double quotation marks) so that `05` is not implicitly transformed to `5`, which wouldn't be valid source code. required: false - default: Empty list (i.e. no source selection will be possible) + default: Empty list (i.e., no source selection will be possible) type: list {% endconfiguration %} @@ -52,7 +53,7 @@ Notes: ### Source codes -Under these lines, you can find some sample `sources` lists per receiver model. Here we use the source names as shown on the remote as key for each code. However these are for display purposes only, so you could rename inputs to better match your set-up (e.g. `HDMI: '19'` to `Kodi: '19'`. +Under these lines, you can find some sample `sources` lists per receiver model. Here we use the source names as shown on the remote as key for each code. However these are for display purposes only, so you could rename inputs to better match your set-up (e.g., `HDMI: '19'` to `Kodi: '19'`. Codes must be defined as strings (between single or double quotation marks) so that `05` is not implicitly transformed to `5`, which wouldn't be valid source code. diff --git a/source/_integrations/pjlink.markdown b/source/_integrations/pjlink.markdown index 9fbb40cc3fc..415ed9f8d05 100644 --- a/source/_integrations/pjlink.markdown +++ b/source/_integrations/pjlink.markdown @@ -6,6 +6,7 @@ ha_category: - Media Player ha_release: 0.76 ha_iot_class: Local Polling +ha_domain: pjlink --- The `pjlink` platform allows you to control from Home Assistant, projectors with support for the [PJLink protocol](https://pjlink.jbmia.or.jp/english/index.html). diff --git a/source/_integrations/plaato.markdown b/source/_integrations/plaato.markdown index 16fdf4cdb68..b76c3b8c218 100644 --- a/source/_integrations/plaato.markdown +++ b/source/_integrations/plaato.markdown @@ -1,7 +1,6 @@ --- title: Plaato Airlock description: Instructions on how to integrate Plaato Airlock sensors within Home Assistant. -logo: plaato.png ha_release: 0.95 ha_category: - Sensor @@ -9,6 +8,7 @@ ha_iot_class: Cloud Push ha_config_flow: true ha_codeowners: - '@JohNan' +ha_domain: plaato --- This integration sets up integration with [Plaato Airlock](https://www.plaato.io/). diff --git a/source/_integrations/plant.markdown b/source/_integrations/plant.markdown index 1f389173ee2..4202260abe6 100644 --- a/source/_integrations/plant.markdown +++ b/source/_integrations/plant.markdown @@ -1,13 +1,13 @@ --- title: Plant Monitor description: Instructions on how to setup plant monitoring with Home Assistant. -logo: home-assistant.png ha_category: - Environment ha_release: 0.44 ha_quality_scale: internal ha_codeowners: - '@ChristianKuehnel' +ha_domain: plant --- This`plant`component lets you merge moisture, conductivity, light intensity, temperature and battery level for a plant into a single UI element. It also supports setting minimum and maximum values for each measurement and will change its state to "problem" if it is not within those limits. diff --git a/source/_integrations/plex.markdown b/source/_integrations/plex.markdown index 9b564ddab80..8dfeb8a36bd 100644 --- a/source/_integrations/plex.markdown +++ b/source/_integrations/plex.markdown @@ -1,7 +1,6 @@ --- title: Plex Media Server description: Instructions on how to integrate Plex into Home Assistant. -logo: plex.png ha_category: - Media Player - Sensor @@ -11,6 +10,7 @@ ha_iot_class: Local Push ha_config_flow: true ha_codeowners: - '@jjlawren' +ha_domain: plex --- The `plex` integration allows you to connect to a [Plex Media Server](https://plex.tv). Once connected, [Plex Clients](https://www.plex.tv/apps-devices/) playing media from the connected Plex Media Server will show up as [Media Players](/integrations/media_player/) and report playback status via a [Sensor](/integrations/sensor/) in Home Assistant. The Media Players will allow you to control media playback and see the current playing item. @@ -30,8 +30,6 @@ Local and secure connections are preferred when setting up an Integration. After
    -If [discovery](/integrations/discovery/) is enabled and a local Plex server is found, a legacy `media_player` configuration (i.e., a `plex.conf` file) will be imported. GDM can be enabled via the Plex Web App under **Settings** -> **(Server Name)** -> **Settings** -> **Network** and choosing **Enable local network discovery (GDM)**. - The `plex` integration can also be configured via `configuration.yaml`: ```yaml @@ -79,11 +77,6 @@ media_player: required: false type: map keys: - show_all_controls: - description: Forces all controls to display. Ignores dynamic controls (ex. show volume controls for client A but not for client B) based on detected client capabilities. This option allows you to override this detection if you suspect it to be incorrect. - required: false - default: false - type: boolean use_episode_art: description: Display TV episode art instead of TV show art. required: false @@ -106,7 +99,6 @@ plex: verify_ssl: true media_player: use_episode_art: true - show_all_controls: false ignore_new_shared_users: false ``` @@ -159,11 +151,10 @@ Plays a song, playlist, TV episode, or video on a connected client. | Any (when all controls disabled) | A stop button will appear but is not functional. | | Any (when casting) | Controlling playback will work but with error logging. | | Any (remote client) | Controls disabled. | -| Apple TV (PlexConnect) | Controls disabled. Music does not work. | +| Apple TV | None | | iOS | None | -| NVidia Shield | Mute disabled. Volume set below 2 will cause error logging. Controlling playback when the Shield is both a client and a server will work but with error logging | +| NVidia Shield | Controlling playback when the Shield is both a client and a server will work but with error logging | | Plex Web | None | -| Tivo Plex App | Only play, pause, stop/off controls enabled | ### Notes diff --git a/source/_integrations/plugwise.markdown b/source/_integrations/plugwise.markdown index af7da0bec7d..2ad497f4fd2 100644 --- a/source/_integrations/plugwise.markdown +++ b/source/_integrations/plugwise.markdown @@ -1,7 +1,6 @@ --- title: Plugwise Anna description: Plugwise Climate integration. -logo: plugwise.png ha_category: Climate ha_iot_class: Local Polling ha_release: 0.98 @@ -9,6 +8,7 @@ ha_codeowners: - '@laetificat' - '@CoMPaTech' - '@bouwew' +ha_domain: plugwise --- This enables [Plugwise](https://plugwise.com) [Anna](https://www.plugwise.com/en_US/products/anna) thermostats to be integrated. This integration talks locally to your **Smile** interface, and you will need its password and IP address. diff --git a/source/_integrations/plum_lightpad.markdown b/source/_integrations/plum_lightpad.markdown index 73f1accb295..8260f8d0197 100644 --- a/source/_integrations/plum_lightpad.markdown +++ b/source/_integrations/plum_lightpad.markdown @@ -6,6 +6,7 @@ ha_category: ha_iot_class: Local Push logo: plum.png ha_release: 0.85 +ha_domain: plum_lightpad --- Configurable/Dimmable Wi-Fi Lightswitch diff --git a/source/_integrations/pocketcasts.markdown b/source/_integrations/pocketcasts.markdown index c7c03e96729..6b19fa321da 100644 --- a/source/_integrations/pocketcasts.markdown +++ b/source/_integrations/pocketcasts.markdown @@ -1,11 +1,11 @@ --- title: Pocket Casts description: Instructions on how to set up Pocket Casts sensors within Home Assistant. -logo: pocketcasts.png ha_category: - Multimedia ha_release: 0.39 ha_iot_class: Cloud Polling +ha_domain: pocketcasts --- The `pocketcasts` sensor platform lets you monitor how many unplayed episodes you have of your favorite podcasts at [Pocket Casts](https://play.pocketcasts.com/). diff --git a/source/_integrations/point.markdown b/source/_integrations/point.markdown index 56b3165f155..11e27eeff31 100644 --- a/source/_integrations/point.markdown +++ b/source/_integrations/point.markdown @@ -1,7 +1,6 @@ --- title: Minut Point description: Instructions on how to integrate Minut Point into Home Assistant. -logo: minut.svg ha_category: - Hub - Alarm @@ -13,9 +12,10 @@ ha_iot_class: Cloud Polling ha_quality_scale: gold ha_codeowners: - '@fredrike' +ha_domain: point --- -The Point hub enables integration with the [Minut Point](https://minut.com/). To connect with Point, you will have to [sign up for a developer account](https://minut.com/community/developers/) and get a `client_id` and `client_secret` with the `callback url` configured as your Home Assistant `base_url` + `/api/minut`, e.g. `http://localhost:8123/api/minut`. The `client_id` and `client_secret` should be used as below. +The Point hub enables integration with the [Minut Point](https://minut.com/). To connect with Point, you will have to [sign up for a developer account](https://minut.com/community/developers/) and get a `client_id` and `client_secret` with the `callback url` configured as your Home Assistant `base_url` + `/api/minut`, e.g., `http://localhost:8123/api/minut`. The `client_id` and `client_secret` should be used as below. Once Home Assistant is started, a configurator will pop up asking you to Authenticate your Point account via a link. When you follow the link and click on **Accept** you will be redirected to the `callback url` and the Point integration will be automatically configured and you can go back to the original dialog and press **Submit**. diff --git a/source/_integrations/prezzibenzina.markdown b/source/_integrations/prezzibenzina.markdown index 18e381c33c0..31dcd8c7f33 100644 --- a/source/_integrations/prezzibenzina.markdown +++ b/source/_integrations/prezzibenzina.markdown @@ -1,11 +1,11 @@ --- title: Prezzi Benzina description: Instructions on how to integrate PrezziBenzina sensors within Home Assistant. -logo: prezzibenzina.png ha_category: - Energy ha_release: 0.85 ha_iot_class: Cloud Polling +ha_domain: prezzibenzina --- The `prezzibenzina` platform allows you to monitor the fuel prices with [PrezziBenzina.it](https://www.prezzibenzina.it/) from within Home Assistant and setup automations based on the information. diff --git a/source/_integrations/proliphix.markdown b/source/_integrations/proliphix.markdown index 54debd019cb..f9dcdd602a0 100644 --- a/source/_integrations/proliphix.markdown +++ b/source/_integrations/proliphix.markdown @@ -6,6 +6,7 @@ ha_category: - Climate ha_release: 0.11 ha_iot_class: Local Polling +ha_domain: proliphix --- The `proliphix` climate platform let you control [Proliphix](http://www.proliphix.com) thermostat from Home Assistant. diff --git a/source/_integrations/prometheus.markdown b/source/_integrations/prometheus.markdown index ce1b519a260..cc07f73ff6c 100644 --- a/source/_integrations/prometheus.markdown +++ b/source/_integrations/prometheus.markdown @@ -1,10 +1,10 @@ --- title: Prometheus description: Record events in Prometheus. -logo: prometheus.png ha_category: - History ha_release: 0.49 +ha_domain: prometheus --- The `prometheus` integration exposes metrics in a format which [Prometheus](https://prometheus.io/) can read. diff --git a/source/_integrations/prowl.markdown b/source/_integrations/prowl.markdown index 7415395b719..fd567c9221c 100644 --- a/source/_integrations/prowl.markdown +++ b/source/_integrations/prowl.markdown @@ -1,10 +1,10 @@ --- title: Prowl description: Instructions on how to add Prowl notifications to Home Assistant. -logo: prowl.png ha_category: - Notifications ha_release: 0.52 +ha_domain: prowl --- The `prowl` platform uses [Prowl](https://www.prowlapp.com/) to deliver push notifications from Home Assistant to your iOS device. diff --git a/source/_integrations/proximity.markdown b/source/_integrations/proximity.markdown index 64c8bd3335e..f60bada2fe3 100644 --- a/source/_integrations/proximity.markdown +++ b/source/_integrations/proximity.markdown @@ -1,11 +1,11 @@ --- title: Proximity description: Instructions on how to setup Proximity monitoring within Home Assistant. -logo: home-assistant.png ha_category: - Automation ha_release: 0.13 ha_quality_scale: internal +ha_domain: proximity --- The `proximity` integration allows you to monitor the proximity of devices to a particular [zone](/integrations/zone/) and the direction of travel. The result is an entity created in Home Assistant which maintains the proximity data. diff --git a/source/_integrations/proxmoxve.markdown b/source/_integrations/proxmoxve.markdown index 51c62580890..f65b274ec56 100644 --- a/source/_integrations/proxmoxve.markdown +++ b/source/_integrations/proxmoxve.markdown @@ -1,13 +1,13 @@ --- title: Proxmox VE description: Access your ProxmoxVE instance in Home Assistant. -logo: proxmoxve.png ha_category: - Binary Sensor ha_release: 0.103 ha_iot_class: Local Polling ha_codeowners: - '@k4ds3' +ha_domain: proxmoxve --- [Proxmox VE](https://www.proxmox.com/en/) is an open-source server virtualization environment. This integration allows you to poll various data from your instance. @@ -114,7 +114,7 @@ Before creating the user, we need to create a permissions role for the user. * Click `Datacenter` * Open `Permissions` and click `Roles` * Click the `Create` button above all the existing roles -* name the new role (e.g. "home-assistant") +* name the new role (e.g., "home-assistant") * Click the arrow next to privileges and select `VM.Audit` in the dropdown * Click `Create` @@ -125,7 +125,7 @@ Creating a dedicated user for Home Assistant, limited to only the role just crea * Click `Datacenter` * Open `Permissions` and click `Users` * Click `Add` -* Enter a username (e.g. "hass") +* Enter a username (e.g., "hass") * Enter a secure password (it can be complex as you will only need to copy/paste it into your Home Assistant configuration) * Set the realm to "Proxmox VE authentication server" * Ensure `Enabled` is checked and `Expire` is set to "never" diff --git a/source/_integrations/proxy.markdown b/source/_integrations/proxy.markdown index e0f1eb61cda..72833db12a7 100644 --- a/source/_integrations/proxy.markdown +++ b/source/_integrations/proxy.markdown @@ -4,6 +4,7 @@ description: Instructions on how to integrate a camera proxy within Home Assista ha_category: - Camera ha_release: 0.65 +ha_domain: proxy --- The `proxy` camera platform allows you to pass another camera's output through post-processing routines and generate a new camera with the post-processed output. diff --git a/source/_integrations/ps4.markdown b/source/_integrations/ps4.markdown index 1dd2f2a5784..3ee83d4c6ee 100644 --- a/source/_integrations/ps4.markdown +++ b/source/_integrations/ps4.markdown @@ -9,6 +9,7 @@ ha_config_flow: true ha_iot_class: Local Polling ha_codeowners: - '@ktnrg45' +ha_domain: ps4 --- The `ps4` integration allows you to control a diff --git a/source/_integrations/ptvsd.markdown b/source/_integrations/ptvsd.markdown index ee4984f8485..47c38940df4 100644 --- a/source/_integrations/ptvsd.markdown +++ b/source/_integrations/ptvsd.markdown @@ -1,12 +1,12 @@ --- title: PTVSD - Python Tools for Visual Studio Debug Server description: Debugging from Visual Studio Code. -logo: visual-studio.png ha_category: - Utility ha_release: 0.93 ha_codeowners: - '@swamp-ig' +ha_domain: ptvsd --- The `ptvsd` integration allows you to use the Visual Studio Code PTVSD debugger with Home Assistant. diff --git a/source/_integrations/pulseaudio_loopback.markdown b/source/_integrations/pulseaudio_loopback.markdown index 305503d29c8..e701ae2f19b 100644 --- a/source/_integrations/pulseaudio_loopback.markdown +++ b/source/_integrations/pulseaudio_loopback.markdown @@ -6,6 +6,7 @@ ha_category: - Switch ha_release: 0.16 ha_iot_class: Local Polling +ha_domain: pulseaudio_loopback --- The goal behind this switch is to allow a very flexible whole home audio system based upon [PulseAudio](https://www.freedesktop.org/wiki/Software/PulseAudio/). diff --git a/source/_integrations/push.markdown b/source/_integrations/push.markdown index e0b4b8f64dc..bbf552209fa 100644 --- a/source/_integrations/push.markdown +++ b/source/_integrations/push.markdown @@ -1,13 +1,13 @@ --- title: Push description: Instructions how to use Push Camera within Home Assistant. -logo: camcorder.png ha_category: - Camera ha_iot_class: Local Push ha_release: 0.74 ha_codeowners: - '@dgomes' +ha_domain: push --- The `push` camera platform allows you to integrate images sent over HTTP POST to Home Assistant as a camera. External applications/daemons/scripts are therefore able to "stream" images through Home Assistant. diff --git a/source/_integrations/pushbullet.markdown b/source/_integrations/pushbullet.markdown index 8169511baef..1d376eb6028 100644 --- a/source/_integrations/pushbullet.markdown +++ b/source/_integrations/pushbullet.markdown @@ -1,12 +1,12 @@ --- title: Pushbullet description: Instructions on how to read user pushes in Home Assistant -logo: pushbullet.png ha_category: - Sensor - Notifications ha_release: 0.44 ha_iot_class: Cloud Polling +ha_domain: pushbullet --- There is currently support for the following device types within Home Assistant: @@ -113,20 +113,21 @@ Type | Prefix | Suffix | Example Device | `device/` | Device nickname | `device/iphone` Channel | `channel/` | Channel tag | `channel/my_home` Email | `email/` | Contact's email address | `email/email@example.com` +SMS | `sms/` | Contact's phone number | `sms/0612345678` If using targets, your own account's email address functions as 'send to all devices'. All targets are verified (if exists) before sending, except email. #### Example service payload -```json -{ - "message": "A message for many people", - "target": [ - "device/telephone", - "email/hello@example.com", - "channel/my_home" - ] -} +```yaml + + message: A message for many people + target: + - device/telephone + - email/hello@example.com + - channel/my_home + - sms/0612345678 + ``` To use notifications, please see the [getting started with automation page](/getting-started/automation/). diff --git a/source/_integrations/pushetta.markdown b/source/_integrations/pushetta.markdown index b818ac6b7d8..05ead757fc5 100644 --- a/source/_integrations/pushetta.markdown +++ b/source/_integrations/pushetta.markdown @@ -1,10 +1,10 @@ --- title: Pushetta description: Instructions on how to add Pushetta notifications to Home Assistant. -logo: pushetta.png ha_category: - Notifications ha_release: pre 0.7 +ha_domain: pushetta --- The `pushetta` notify platform uses [Pushetta](http://www.pushetta.com) to delivery notifications from Home Assistant to your devices. diff --git a/source/_integrations/pushover.markdown b/source/_integrations/pushover.markdown index a51e1e2784e..4581aeca170 100644 --- a/source/_integrations/pushover.markdown +++ b/source/_integrations/pushover.markdown @@ -1,10 +1,10 @@ --- title: Pushover description: Instructions on how to add Pushover notifications to Home Assistant. -logo: pushover.png ha_category: - Notifications ha_release: pre 0.7 +ha_domain: pushover --- The [Pushover service](https://pushover.net/) is a platform for the notify component. This allows integrations to send messages to the user using Pushover. diff --git a/source/_integrations/pushsafer.markdown b/source/_integrations/pushsafer.markdown index 7d015a92da6..ac7a4a7f070 100644 --- a/source/_integrations/pushsafer.markdown +++ b/source/_integrations/pushsafer.markdown @@ -5,6 +5,7 @@ logo: pushsafer.png ha_category: - Notifications ha_release: 0.39 +ha_domain: pushsafer --- The [Pushsafer service](https://www.pushsafer.com/) is a platform for the notify component. This allows you to send messages to the user using Pushsafer. diff --git a/source/_integrations/pvoutput.markdown b/source/_integrations/pvoutput.markdown index 6be1310a183..ee8aaaa9929 100644 --- a/source/_integrations/pvoutput.markdown +++ b/source/_integrations/pvoutput.markdown @@ -8,6 +8,7 @@ ha_release: 0.33 ha_iot_class: Cloud Polling ha_codeowners: - '@fabaff' +ha_domain: pvoutput --- The `pvoutput` sensor platform consumes information from [PVOutput](https://pvoutput.org/) which were uploaded by your solar photovoltaic (PV) system. diff --git a/source/_integrations/pyload.markdown b/source/_integrations/pyload.markdown index 881cc72d552..26a954af583 100644 --- a/source/_integrations/pyload.markdown +++ b/source/_integrations/pyload.markdown @@ -1,11 +1,11 @@ --- title: pyLoad description: Instructions on how to integrate pyLoad download sensor within Home Assistant. -logo: pyload.png ha_category: - Downloading ha_release: 0.58 ha_iot_class: Local Polling +ha_domain: pyload --- The `pyload` platform allows you to monitor your downloads with [pyLoad](https://pyload.net/) from within Home Assistant and setup automation based on the information. diff --git a/source/_integrations/python_script.markdown b/source/_integrations/python_script.markdown index 498d8fff07c..3e9312a9619 100644 --- a/source/_integrations/python_script.markdown +++ b/source/_integrations/python_script.markdown @@ -1,11 +1,11 @@ --- title: Python Scripts description: Instructions on how to setup Python scripts within Home Assistant. -logo: home-assistant.png ha_category: - Automation ha_release: 0.47 ha_quality_scale: internal +ha_domain: python_script --- This integration allows you to write Python scripts that are exposed as services in Home Assistant. Each Python file created in the `/python_scripts/` folder will be exposed as a service. The content is not cached so you can easily develop: edit file, save changes, call service. The scripts are run in a sandboxed environment. The following variables are available in the sandbox: @@ -65,8 +65,10 @@ if entity_id is not None: The above `python_script` can be called using the following YAML as an input. ```yaml -entity_id: light.bedroom -rgb_color: [255, 0, 0] +service: python_script.turn_on_light + data: + entity_id: light.bedroom + rgb_color: [255, 0, 0] ``` ## Documenting your Python scripts diff --git a/source/_integrations/qbittorrent.markdown b/source/_integrations/qbittorrent.markdown index d5b577d3150..b0d96a502af 100644 --- a/source/_integrations/qbittorrent.markdown +++ b/source/_integrations/qbittorrent.markdown @@ -1,11 +1,11 @@ --- title: qBittorrent description: Instructions on how to integrate qBittorrent sensors within Home Assistant. -logo: qbittorrent.png ha_category: - Downloading ha_release: 0.84 ha_iot_class: Local Polling +ha_domain: qbittorrent --- The `qbittorrent` platform allows you to monitor your downloads with [qBittorrent](https://www.qbittorrent.org/) from within Home Assistant and setup automations based on the information. diff --git a/source/_integrations/qld_bushfire.markdown b/source/_integrations/qld_bushfire.markdown index 1eb7c0835db..801ce5629fd 100644 --- a/source/_integrations/qld_bushfire.markdown +++ b/source/_integrations/qld_bushfire.markdown @@ -7,6 +7,7 @@ ha_iot_class: Cloud Polling ha_release: 0.95 ha_codeowners: - '@exxamalte' +ha_domain: qld_bushfire --- The `qld_bushfire` platform lets you integrate a diff --git a/source/_integrations/qnap.markdown b/source/_integrations/qnap.markdown index 9710c342fce..2700ee6061e 100644 --- a/source/_integrations/qnap.markdown +++ b/source/_integrations/qnap.markdown @@ -8,6 +8,7 @@ ha_release: 0.38 ha_iot_class: Local Polling ha_codeowners: - '@colinodell' +ha_domain: qnap --- This `qnap` sensor allows getting various statistics from your [QNAP NAS](https://www.qnap.com/en-us/). diff --git a/source/_integrations/qrcode.markdown b/source/_integrations/qrcode.markdown index 75a76d9ae22..c5315c4c796 100644 --- a/source/_integrations/qrcode.markdown +++ b/source/_integrations/qrcode.markdown @@ -1,10 +1,10 @@ --- title: QR Code description: Instructions on how to integrate QR Code Recognition into Home Assistant. -logo: home-assistant.png ha_category: - Image Processing ha_release: 0.87 +ha_domain: qrcode --- The `qrcode` image processing platform enables QR code recognition from cameras. diff --git a/source/_integrations/quantum_gateway.markdown b/source/_integrations/quantum_gateway.markdown index 45e0502ce14..09ddb63a763 100644 --- a/source/_integrations/quantum_gateway.markdown +++ b/source/_integrations/quantum_gateway.markdown @@ -3,10 +3,10 @@ title: Quantum Gateway description: Instructions on how to integrate Quantum Gateways into Home Assistant. ha_category: - Presence Detection -logo: fios.svg ha_release: 0.81 ha_codeowners: - '@cisasteelersfan' +ha_domain: quantum_gateway --- The `quantum_gateway` device tracker platform offers presence detection by looking at connected devices to a Verizon Fios gateway. diff --git a/source/_integrations/qvr_pro.markdown b/source/_integrations/qvr_pro.markdown new file mode 100644 index 00000000000..96db24e5ce9 --- /dev/null +++ b/source/_integrations/qvr_pro.markdown @@ -0,0 +1,54 @@ +--- +title: "QVR Pro" +description: "Instructions on how to integrate QVR Pro within Home Assistant." +logo: qvr_pro.png +ha_category: + - Camera +ha_release: "0.107" +--- + +[QVR Pro](https://www.qnap.com/solution/qvr-pro-official) allows you to create +an independent and expandable surveillance environment on your QNAP NAS. The +`qvr_pro` component allows you to view your QVR Pro channels in Home Assistant. + +Currently, only cameras are supported by this integration. + +## Configuration + +To enable QVR Pro integration, add the following to your +`configuration.yaml` file: + +```yaml +# Example configuration.yaml entry +qvr_pro: + host: YOUR_HOST + username: YOUR_USERNAME + password: YOUR_PASSWORD +``` + +{% configuration %} +host: + description: The IP address where QVR Pro is accessible. + required: true + type: string +username: + description: The username for accessing your Ring account. + required: true + type: string +password: + description: The password for accessing your Ring account. + required: true + type: string +exclude_channels: + description: Comma separated list of channel numbers to be excluded. + required: false + type: list +{% endconfiguration %} + +Enabling the QVR Pro camera platform will add all QVR Pro channels by +default. Please see `exclude_channels` if you would like to exclude +specific channels from showing up in Home Assistant. + +

    +The QVR Pro user must have Surveillance Management permission. +

    diff --git a/source/_integrations/qwikswitch.markdown b/source/_integrations/qwikswitch.markdown index ebceff31cd5..aadfc1c54f9 100644 --- a/source/_integrations/qwikswitch.markdown +++ b/source/_integrations/qwikswitch.markdown @@ -11,6 +11,7 @@ ha_category: ha_release: '0.20' ha_codeowners: - '@kellerza' +ha_domain: qwikswitch --- The `qwikswitch` integration is the main integration to integrate various [QwikSwitch](https://www.qwikswitch.co.za/) devices with Home Assistant. The integration requires the QSUSB Modem device and connects to the QS Mobile application. @@ -48,7 +49,7 @@ button_events: default: TOGGLE,SCENE EXE,LEVEL type: string switches: - description: A list of device QS_id's that should be switches, and not lights (i.e. `['@0dev01', '@0dev02']`) + description: A list of device QS_id's that should be switches, and not lights (i.e., `['@0dev01', '@0dev02']`) required: false type: list sensors: diff --git a/source/_integrations/rachio.markdown b/source/_integrations/rachio.markdown index 9642ba9f698..469bfba989a 100644 --- a/source/_integrations/rachio.markdown +++ b/source/_integrations/rachio.markdown @@ -8,6 +8,7 @@ ha_category: - Switch ha_iot_class: Cloud Push ha_release: 0.73 +ha_domain: rachio --- The `rachio` platform allows you to control your [Rachio irrigation system](https://rachio.com/). diff --git a/source/_integrations/radarr.markdown b/source/_integrations/radarr.markdown index 91368831d8f..aca49c1bac8 100644 --- a/source/_integrations/radarr.markdown +++ b/source/_integrations/radarr.markdown @@ -1,10 +1,10 @@ --- title: Radarr description: Instructions on how to integrate Radarr sensors with Home Assistant -logo: radarr.png ha_category: - Downloading ha_release: 0.47 +ha_domain: radarr --- This `radarr` sensor platform pulls data from a given [Radarr](https://radarr.video/) instance. diff --git a/source/_integrations/radiotherm.markdown b/source/_integrations/radiotherm.markdown index c5f81b08bfe..3623c7fb3fb 100644 --- a/source/_integrations/radiotherm.markdown +++ b/source/_integrations/radiotherm.markdown @@ -6,6 +6,7 @@ ha_category: - Climate ha_iot_class: Local Polling ha_release: 0.7.6 +ha_domain: radiotherm --- The `radiotherm` climate platform let you control a thermostat from [Radio Thermostat](https://www.radiothermostat.com/) or [3M Filtrete](https://www.filtrete.com/). Your thermostat must have the Wi-Fi module installed and connected to your network. diff --git a/source/_integrations/rainbird.markdown b/source/_integrations/rainbird.markdown index 3bcda2c5109..6ed3cbdf444 100644 --- a/source/_integrations/rainbird.markdown +++ b/source/_integrations/rainbird.markdown @@ -10,6 +10,7 @@ ha_release: 0.61 ha_iot_class: Local Polling ha_codeowners: - '@konikvranik' +ha_domain: rainbird --- This `rainbird` integration allows interacting with [LNK WiFi](https://www.rainbird.com/products/lnk-wifi-module) module of the Rain Bird Irrigation system in Home Assistant. diff --git a/source/_integrations/raincloud.markdown b/source/_integrations/raincloud.markdown index 03be231d021..dcb6b3b5063 100644 --- a/source/_integrations/raincloud.markdown +++ b/source/_integrations/raincloud.markdown @@ -11,6 +11,7 @@ ha_release: 0.55 ha_iot_class: Cloud Polling ha_codeowners: - '@vanstinator' +ha_domain: raincloud --- The `raincloud` integration allows you to integrate your [Melnor RainCloud](https://wifiaquatimer.com) sprinkler system in Home Assistant. diff --git a/source/_integrations/rainforest_eagle.markdown b/source/_integrations/rainforest_eagle.markdown index 1ef1cc76d49..c6ebf9c7ecb 100644 --- a/source/_integrations/rainforest_eagle.markdown +++ b/source/_integrations/rainforest_eagle.markdown @@ -1,7 +1,6 @@ --- -title: "Rainforest Eagle" -description: "Instructions on how to setup the Rainforest Eagle with Home Assistant." -logo: rainforest_automation_logo.png +title: Rainforest Eagle-200 +description: Instructions on how to setup the Rainforest Eagle with Home Assistant. ha_category: - Energy - Sensor @@ -9,6 +8,8 @@ ha_release: 0.97 ha_iot_class: Local Polling ha_codeowners: - '@gtdiehl' + - '@jcalbert' +ha_domain: rainforest_eagle --- A `sensor` platform for the Rainforest Automation's [Eagle-200](https://rainforestautomation.com/rfa-z114-eagle-200/) diff --git a/source/_integrations/rainmachine.markdown b/source/_integrations/rainmachine.markdown index 6c0fe882932..318391070c4 100644 --- a/source/_integrations/rainmachine.markdown +++ b/source/_integrations/rainmachine.markdown @@ -1,7 +1,6 @@ --- title: RainMachine description: Instructions on how to integrate RainMachine units within Home Assistant. -logo: rainmachine.png ha_category: - Irrigation - Binary Sensor @@ -12,6 +11,7 @@ ha_iot_class: Local Polling ha_config_flow: true ha_codeowners: - '@bachya' +ha_domain: rainmachine --- The `rainmachine` integration is the main integration to integrate all platforms related to [RainMachine smart Wi-Fi sprinkler controllers](https://www.rainmachine.com/). diff --git a/source/_integrations/random.markdown b/source/_integrations/random.markdown index ca2ab90c4e1..ef708b1f7a2 100644 --- a/source/_integrations/random.markdown +++ b/source/_integrations/random.markdown @@ -1,7 +1,6 @@ --- title: Random description: Instructions on how to integrate random numbers into Home Assistant. -logo: home-assistant.png ha_category: - Utility - Sensor @@ -11,6 +10,7 @@ ha_release: 0.32 ha_quality_scale: internal ha_codeowners: - '@fabaff' +ha_domain: random --- The `random` integration simply creates random values or state. This can be useful if you want to test automation rules or run an interactive demo. It generates a new state every time it is polled. diff --git a/source/_integrations/raspihats.markdown b/source/_integrations/raspihats.markdown index eb22f0e719c..85f65646b80 100644 --- a/source/_integrations/raspihats.markdown +++ b/source/_integrations/raspihats.markdown @@ -8,6 +8,7 @@ ha_category: - Switch ha_release: 0.45 ha_iot_class: Local Push +ha_domain: raspihats --- The `raspihats` integration is the base for all related Raspihats platforms in Home Assistant. There is no setup needed for the integration itself. diff --git a/source/_integrations/raspyrfm.markdown b/source/_integrations/raspyrfm.markdown index 9d22260d7ca..c411791997f 100644 --- a/source/_integrations/raspyrfm.markdown +++ b/source/_integrations/raspyrfm.markdown @@ -6,6 +6,7 @@ ha_category: - Switch ha_release: 0.85 ha_iot_class: Assumed State +ha_domain: raspyrfm --- The `raspyrfm` integration adds support for cheap RC 433 MHz outlets via one of the supported gateways. diff --git a/source/_integrations/recollect_waste.markdown b/source/_integrations/recollect_waste.markdown index 06fc4da938d..3a7b7d92fe8 100644 --- a/source/_integrations/recollect_waste.markdown +++ b/source/_integrations/recollect_waste.markdown @@ -6,6 +6,7 @@ ha_category: - Sensor ha_release: 0.87 ha_iot_class: Cloud Polling +ha_domain: recollect_waste --- The `recollect_waste` integration allows you to track the next scheduled waste pickup and what type of waste from [Recollect](https://recollect.net/private-waste-haulers/). To use this sensor your city's waste company must be Recollect and you will need to find your place_id and service_id. diff --git a/source/_integrations/recorder.markdown b/source/_integrations/recorder.markdown index 3292d62cb27..5396e2c1aeb 100644 --- a/source/_integrations/recorder.markdown +++ b/source/_integrations/recorder.markdown @@ -1,15 +1,21 @@ --- title: Recorder description: Instructions on how to configure the data recorder for Home Assistant. -logo: home-assistant.png ha_category: - History ha_release: pre 0.7 ha_quality_scale: internal +ha_domain: recorder --- The `recorder` integration is responsible for storing details in a database, which then are handled by the [`history` integration](/integrations/history/). +
    + +This integration constantly saves data. If you use the default configuration, the data will be saved on the media Home Assistant is installed on. In case of Raspberry Pi with an SD card, it might affect your system's reaction time and life expectancy of the storage medium (the SD card). It is therefore recommended to store the data elsewhere (e.g., another system) or limit the amount of stored data (e.g., by excluding devices). + +
    + Home Assistant uses [SQLAlchemy](https://www.sqlalchemy.org/), which is an Object Relational Mapper (ORM). This means that you can use **any** SQL backend for the recorder that is supported by SQLAlchemy, like [MySQL](https://www.mysql.com/), [MariaDB](https://mariadb.org/), [PostgreSQL](https://www.postgresql.org/), or [MS SQL Server](https://www.microsoft.com/en-us/sql-server/). The default database engine is [SQLite](https://www.sqlite.org/) which doesn't require any configuration. The database is stored in your Home Assistant configuration directory (`.homeassistant` or '/config/' in Hass.io) and called `home-assistant_v2.db`. @@ -51,6 +57,11 @@ recorder: required: false default: 1 type: integer + commit_interval: + description: How often (in seconds) the events and state changes are committed to the database. The default of `1` allows events to be committed almost right away without trashing the disk when an event storm happens. Increasing this will reduce disk I/O and may prolong disk (SD card) lifetime with the trade-off being that the logbook and history will lag. If this is set to `0` (zero), commit are made as soon as possible after an event is processed. + required: false + default: 1 + type: integer exclude: description: Configure which integrations should be excluded from recordings. required: false @@ -83,7 +94,7 @@ recorder: type: list {% endconfiguration %} -Defining domains and entities to `exclude` (aka. blacklist) is convenient when you are basically happy with the information recorded, but just want to remove some entities or domains. Usually, these are entities/domains that do not change (like `weblink`) or rarely change (like `updater` or `automation`). +Defining domains and entities to `exclude` (aka. blacklist) is convenient when you are basically happy with the information recorded, but just want to remove some entities or domains. Usually, these are entities/domains that do not change or rarely change (like `updater` or `automation`). ```yaml # Example configuration.yaml entry with exclude @@ -93,7 +104,6 @@ recorder: exclude: domains: - automation - - weblink - updater entities: - sun.sun # Don't record sun data @@ -171,7 +181,7 @@ If using an external MariaDB backend (e.g., running on a separate NAS) with Home
    -Unix Socket connections always bring performance advantages over TCP, if the database is on the same host as the `recorder` instance (i.e. `localhost`). +Unix Socket connections always bring performance advantages over TCP, if the database is on the same host as the `recorder` instance (i.e., `localhost`).
    diff --git a/source/_integrations/recswitch.markdown b/source/_integrations/recswitch.markdown index 22682597b9f..24baa51b8ac 100644 --- a/source/_integrations/recswitch.markdown +++ b/source/_integrations/recswitch.markdown @@ -6,6 +6,7 @@ ha_release: 0.81 ha_category: - Switch ha_iot_class: Local Polling +ha_domain: recswitch --- The `recswitch` switch platform allows you to control the Ankuoo REC Switch devices. diff --git a/source/_integrations/reddit.markdown b/source/_integrations/reddit.markdown index 1f253beace2..9791463488f 100644 --- a/source/_integrations/reddit.markdown +++ b/source/_integrations/reddit.markdown @@ -1,11 +1,11 @@ --- title: Reddit description: How to integrate the Reddit sensor into Home Assistant. -logo: reddit.png ha_category: - Sensor ha_release: 0.89 ha_iot_class: Cloud Polling +ha_domain: reddit --- The Reddit sensor integrates data from [Reddit](https://reddit.com/) to monitor your favorite subreddits. diff --git a/source/_integrations/rejseplanen.markdown b/source/_integrations/rejseplanen.markdown index 94ab6d883ab..a7ee68fe009 100644 --- a/source/_integrations/rejseplanen.markdown +++ b/source/_integrations/rejseplanen.markdown @@ -6,6 +6,7 @@ ha_category: - Transport ha_iot_class: Cloud Polling ha_release: 0.88 +ha_domain: rejseplanen --- The `rejseplanen` sensor will provide you with travel details for Danish public transport, using timetable data from [Rejseplanen](https://www.rejseplanen.dk/). diff --git a/source/_integrations/remember_the_milk.markdown b/source/_integrations/remember_the_milk.markdown index 6f62afc077b..715a955ce0e 100644 --- a/source/_integrations/remember_the_milk.markdown +++ b/source/_integrations/remember_the_milk.markdown @@ -5,6 +5,7 @@ logo: rememberthemilk.png ha_category: - Calendar ha_release: 0.57 +ha_domain: remember_the_milk --- The `Remember The Milk` (RTM) integration allows you to create tasks in [remember_the_milk](https://www.rememberthemilk.com) from Home Assistant. You can use this if you want Home Assistant to send you a task that you should not forget, e.g., water the plants. The integration allows you to have several RTM accounts in parallel. diff --git a/source/_integrations/remote.markdown b/source/_integrations/remote.markdown index 07053b6e00c..169aa9abe45 100644 --- a/source/_integrations/remote.markdown +++ b/source/_integrations/remote.markdown @@ -2,6 +2,7 @@ title: Remote description: Instructions on how to setup your remotes with Home Assistant. ha_release: 0.34 +ha_domain: remote --- Keeps track which remotes are in your environment, their state and allows you to control them. diff --git a/source/_integrations/remote.xiaomi_miio.markdown b/source/_integrations/remote.xiaomi_miio.markdown index 79aeb661f5c..20913669fcd 100644 --- a/source/_integrations/remote.xiaomi_miio.markdown +++ b/source/_integrations/remote.xiaomi_miio.markdown @@ -1,11 +1,11 @@ --- title: "Xiaomi IR Remote" description: "Instructions for how to integrate the Xiaomi IR Remote within Home Assistant." -logo: xiaomi.png ha_category: - Remote ha_release: 0.63 ha_iot_class: Local Polling +ha_domain: xiaomi_miio --- The `xiaomi miio` remote platform allows you to send IR commands from your Xiaomi IR Remote (ChuangmiIr). diff --git a/source/_integrations/remote_rpi_gpio.markdown b/source/_integrations/remote_rpi_gpio.markdown index d2d7cf01695..118a39410b4 100644 --- a/source/_integrations/remote_rpi_gpio.markdown +++ b/source/_integrations/remote_rpi_gpio.markdown @@ -1,13 +1,13 @@ --- title: remote_rpi_gpio description: Instructions on how to integrate the GPIO capability of a Remote Raspberry Pi into Home Assistant. -logo: raspberry-pi.png ha_category: - DIY - Binary Sensor - Switch ha_release: 0.94 ha_iot_class: Local Push +ha_domain: remote_rpi_gpio --- The `rpi_gpio` integration is the base for all related GPIO platforms in Home Assistant. For the platform configurations, please check their corresponding sections. diff --git a/source/_integrations/repetier.markdown b/source/_integrations/repetier.markdown index e0bb5eaed4c..140ad355fc9 100644 --- a/source/_integrations/repetier.markdown +++ b/source/_integrations/repetier.markdown @@ -1,7 +1,6 @@ --- title: Repetier-Server description: Instructions how to add Repetier-Server sensors to Home Assistant. -logo: repetier.png ha_category: - Hub - Sensor @@ -9,6 +8,7 @@ ha_release: 0.94 ha_iot_class: Local Polling ha_codeowners: - '@MTrab' +ha_domain: repetier --- [Repetier-Server](https://www.repetier-server.com/) is a 3D printer/CNC server, able to control multiple devices on the same server. diff --git a/source/_integrations/rest.markdown b/source/_integrations/rest.markdown index 77cdd9402f2..7aa7b332deb 100644 --- a/source/_integrations/rest.markdown +++ b/source/_integrations/rest.markdown @@ -1,11 +1,11 @@ --- title: RESTful description: Instructions on how to integrate REST sensors into Home Assistant. -logo: restful.png ha_category: - Sensor ha_release: 0.7.4 ha_iot_class: Local Polling +ha_domain: rest --- The `rest` sensor platform is consuming a given endpoint which is exposed by a [RESTful API](https://en.wikipedia.org/wiki/Representational_state_transfer) of a device, an application, or a web service. The sensor has support for GET and POST requests. @@ -105,10 +105,10 @@ headers: required: false type: [string, list] json_attributes: - description: A list of keys to extract values from a JSON dictionary result and then set as sensor attributes. If the endpoint returns XML with the "text/xml" content type, it will automatically be converted to JSON according to this [specification](https://www.xml.com/pub/a/2006/05/31/converting-between-xml-and-json.html) + description: A list of keys to extract values from a JSON dictionary result and then set as sensor attributes. If the endpoint returns XML with the "text/xml" or "application/xml" content type, it will automatically be converted to JSON according to this [specification](https://www.xml.com/pub/a/2006/05/31/converting-between-xml-and-json.html) required: false type: [string, list] -json_path_attributes: +json_attributes_path: description: A [JSONPath](https://goessner.net/articles/JsonPath/) that references the location of the `json_attributes` in the JSON content. required: false type: string diff --git a/source/_integrations/rest_command.markdown b/source/_integrations/rest_command.markdown index e115b186647..29772718572 100644 --- a/source/_integrations/rest_command.markdown +++ b/source/_integrations/rest_command.markdown @@ -1,11 +1,11 @@ --- title: RESTful Command description: Instructions on how to integrate REST commands into Home Assistant. -logo: restful.png ha_category: - Automation ha_release: 0.36 ha_iot_class: Local Push +ha_domain: rest_command --- This integration can expose regular REST commands as services. Services can be called from a [script] or in [automation]. diff --git a/source/_integrations/rflink.markdown b/source/_integrations/rflink.markdown index 31cda0c343f..f8233270643 100644 --- a/source/_integrations/rflink.markdown +++ b/source/_integrations/rflink.markdown @@ -5,6 +5,7 @@ logo: rflink.png ha_category: - Hub ha_release: 0.38 +ha_domain: rflink --- The `rflink` integration supports devices that use [RFLink gateway firmware](http://www.rflink.nl/blog2/download), for example, the [Nodo RFLink Gateway](https://www.nodo-shop.nl/nl/21-rflink-gateway). RFLink Gateway is an Arduino Mega firmware that allows two-way communication with a multitude of RF wireless devices using cheap hardware (Arduino + transceiver). diff --git a/source/_integrations/rfxtrx.markdown b/source/_integrations/rfxtrx.markdown index 459db92a14c..98bf36747b9 100644 --- a/source/_integrations/rfxtrx.markdown +++ b/source/_integrations/rfxtrx.markdown @@ -1,12 +1,12 @@ --- title: RFXCOM RFXtrx description: Instructions on how to integrate RFXtrx into Home Assistant. -logo: rfxtrx.png ha_category: - Hub ha_release: pre 0.7 ha_codeowners: - '@danielhiversen' +ha_domain: rfxtrx --- The `rfxtrx` integration supports RFXtrx devices by [RFXCOM](http://www.rfxcom.com), which communicate in the frequency range of 433.92 MHz. diff --git a/source/_integrations/ring.markdown b/source/_integrations/ring.markdown index e907909898d..dbc1bdaa62d 100644 --- a/source/_integrations/ring.markdown +++ b/source/_integrations/ring.markdown @@ -14,9 +14,10 @@ ha_iot_class: Cloud Polling ha_config_flow: true ha_codeowners: - '@balloob' +ha_domain: ring --- -The `ring` implementation allows you to integrate your [Ring.com](https://ring.com/) devices in Home Assistant. +The `ring` implementation allows you to integrate your [Ring.com](https://ring.com/) devices in Home Assistant. Due to recent authentication changes of Ring, you will need to run at least Home Assistant 0.104. There is currently support for the following device types within Home Assistant: @@ -33,29 +34,7 @@ This component does NOT allow for live viewing of your Ring camera within Home A Go to the integrations page in your configuration and click on new integration -> Ring. -## YAML configuration - -YAML configuration is around for people that prefer YAML, but it's not preferred! The YAML method does not work with two-factor authentication and it requires you to store your username/password. The normal method only requires you to enter username/password once. - -To enable device linked in your [Ring.com](https://ring.com/) account, add the following to your `configuration.yaml` file: - -```yaml -# Example configuration.yaml entry -ring: - username: YOUR_USERNAME - password: YOUR_PASSWORD -``` - -{% configuration %} -username: - description: The username for accessing your Ring account. - required: true - type: string -password: - description: The password for accessing your Ring account. - required: true - type: string -{% endconfiguration %} +YAML configuration is no longer available because it cannot handle two-factor authentication. ## Binary Sensor diff --git a/source/_integrations/ripple.markdown b/source/_integrations/ripple.markdown index f1d9d973089..52f209cf638 100644 --- a/source/_integrations/ripple.markdown +++ b/source/_integrations/ripple.markdown @@ -6,6 +6,7 @@ ha_category: - Finance ha_release: 0.47 ha_iot_class: Cloud Polling +ha_domain: ripple --- The `ripple` sensor platform displays Ripple wallet balances from [Ripple.com](https://ripple.com). diff --git a/source/_integrations/rmvtransport.markdown b/source/_integrations/rmvtransport.markdown index fb479608d39..ae5ca0cab3f 100644 --- a/source/_integrations/rmvtransport.markdown +++ b/source/_integrations/rmvtransport.markdown @@ -8,6 +8,7 @@ ha_release: 0.76 ha_iot_class: Cloud Polling ha_codeowners: - '@cgtobi' +ha_domain: rmvtransport --- The `rvmtransport` sensor will give you the departure time of the next bus, tram, subway or train at the next station or stop in the Rhein-Main area public transport network. Additional details such as the line number and destination are present in the attributes. @@ -45,7 +46,7 @@ next_departure: default: The default is the station name. type: string station: - description: "ID of the stop or station, e.g. `3000010`." + description: "ID of the stop or station, e.g., `3000010`." required: true type: string destinations: diff --git a/source/_integrations/rocketchat.markdown b/source/_integrations/rocketchat.markdown index cf87d79359d..6fec23d8cfc 100644 --- a/source/_integrations/rocketchat.markdown +++ b/source/_integrations/rocketchat.markdown @@ -1,10 +1,10 @@ --- title: Rocket.Chat description: Instructions on how to add Rocket.Chat notifications to Home Assistant. -logo: rocketchat.png ha_category: - Notifications ha_release: 0.56 +ha_domain: rocketchat --- The `rocketchat` notify platform allows you to send messages to your [Rocket.Chat](https://rocket.chat/) instance from Home Assistant. @@ -45,6 +45,6 @@ rocketchat_notification: #### Message variables - **message** (*Required*): Message to be displayed. -- **data** (*Optional*): Dictionary containing any of the variables defined in the [Rocket.Chat docs](https://rocket.chat/docs/developer-guides/rest-api/chat/postmessage#message-object-example) +- **data** (*Optional*): Dictionary containing any of the variables defined in the [Rocket.Chat documentation](https://rocket.chat/docs/developer-guides/rest-api/chat/postmessage#message-object-example) To use notifications, please see the [getting started with automation page](/getting-started/automation/). diff --git a/source/_integrations/roku.markdown b/source/_integrations/roku.markdown index b11c0569b9e..262cfa2f13b 100644 --- a/source/_integrations/roku.markdown +++ b/source/_integrations/roku.markdown @@ -8,6 +8,7 @@ ha_category: - Remote ha_iot_class: Local Polling ha_release: 0.86 +ha_domain: roku --- The [Roku](https://www.roku.com/) integration allows integration of Roku, which will be automatically discovered if you enable the [discovery component](/integrations/discovery/). diff --git a/source/_integrations/roomba.markdown b/source/_integrations/roomba.markdown index 2b926c97d94..323c8ebb40a 100644 --- a/source/_integrations/roomba.markdown +++ b/source/_integrations/roomba.markdown @@ -7,6 +7,7 @@ ha_category: ha_release: 0.51 ha_codeowners: - '@pschmitt' +ha_domain: roomba --- The `roomba` integration allows you to control your [iRobot Roomba](https://www.irobot.com/For-the-Home/Vacuuming/Roomba.aspx) vacuum. diff --git a/source/_integrations/route53.markdown b/source/_integrations/route53.markdown index 05da97c2454..edea87353ad 100644 --- a/source/_integrations/route53.markdown +++ b/source/_integrations/route53.markdown @@ -1,10 +1,10 @@ --- title: AWS Route53 description: Automatically update your AWS Route53 DNS records. -logo: route53.png ha_category: - Network ha_release: 0.81 +ha_domain: route53 --- With the `route53` integration can you keep your AWS Route53 DNS records up to date. diff --git a/source/_integrations/rova.markdown b/source/_integrations/rova.markdown index 0414d86e5a3..5b691ff87cd 100644 --- a/source/_integrations/rova.markdown +++ b/source/_integrations/rova.markdown @@ -1,11 +1,11 @@ --- title: ROVA description: Instructions on how to integrate ROVA sensor within Home Assistant. -logo: rova.jpg ha_category: - Sensor ha_release: 0.87 ha_iot_class: Cloud Polling +ha_domain: rova --- [ROVA](https://rova.nl) is a waste collection company that operates in the center and east of the Netherlands. The `rova` platform uses an unofficial [ROVA](https://rova.nl) API to allow you to get your waste collection schedule and integrate this in your Home Assistant installation. diff --git a/source/_integrations/rpi_camera.markdown b/source/_integrations/rpi_camera.markdown index 372650bba2c..9a690faa564 100644 --- a/source/_integrations/rpi_camera.markdown +++ b/source/_integrations/rpi_camera.markdown @@ -1,11 +1,11 @@ --- title: Raspberry Pi Camera description: Instructions on how to integrate Raspberry Pi within Home Assistant. -logo: raspberry-pi.png ha_category: - DIY ha_iot_class: Local Polling ha_release: 0.17 +ha_domain: rpi_camera --- The `rpi_camera` platform allows you to integrate the Raspberry Pi camera into Home Assistant. This integration uses the application [`raspistill`](https://www.raspberrypi.org/documentation/usage/camera/raspicam/raspistill.md) to store the image from camera. diff --git a/source/_integrations/rpi_gpio.markdown b/source/_integrations/rpi_gpio.markdown index b84ef02f1aa..193021f2dd0 100644 --- a/source/_integrations/rpi_gpio.markdown +++ b/source/_integrations/rpi_gpio.markdown @@ -1,7 +1,6 @@ --- title: Raspberry Pi GPIO description: Instructions on how to integrate the GPIO capability of a Raspberry Pi into Home Assistant. -logo: raspberry-pi.png ha_category: - DIY - Binary Sensor @@ -9,6 +8,7 @@ ha_category: - Switch ha_release: pre 0.7 ha_iot_class: Local Push +ha_domain: rpi_gpio --- The `rpi_gpio` integration is the base for all related GPIO platforms in Home Assistant. There is no setup needed for the integration itself, for the platforms please check their corresponding pages. diff --git a/source/_integrations/rpi_gpio_pwm.markdown b/source/_integrations/rpi_gpio_pwm.markdown index bd0ad3aa114..5ee45f9c42b 100644 --- a/source/_integrations/rpi_gpio_pwm.markdown +++ b/source/_integrations/rpi_gpio_pwm.markdown @@ -5,7 +5,7 @@ ha_category: - DIY ha_iot_class: Local Push ha_release: 0.43 -logo: raspberry-pi.png +ha_domain: rpi_gpio_pwm --- The `rpi_gpio_pwm` platform allows to control multiple lights using pulse-width modulation, for example LED strips. It supports one-color, RGB and RGBW LEDs driven by GPIOs of a Raspberry Pi (same host or remote) or a PCA9685 controller. diff --git a/source/_integrations/rpi_pfio.markdown b/source/_integrations/rpi_pfio.markdown index 23d94d78d9c..2859b933210 100644 --- a/source/_integrations/rpi_pfio.markdown +++ b/source/_integrations/rpi_pfio.markdown @@ -1,13 +1,13 @@ --- title: PiFace Digital I/O (PFIO) description: Instructions on how to integrate the PiFace Digital I/O module into Home Assistant. -logo: raspberry-pi.png ha_category: - DIY - Binary Sensor - Switch ha_release: 0.45 ha_iot_class: Local Push +ha_domain: rpi_pfio --- The `rpi_pfio` integration is the base for all related [PiFace Digital I/O (PFIO)](http://www.piface.org.uk/) platforms in Home Assistant. There is no setup needed for the integration itself; for the platforms, please check their corresponding pages. diff --git a/source/_integrations/rpi_rf.markdown b/source/_integrations/rpi_rf.markdown index 3c98dc88ba1..c7aafb19a8e 100644 --- a/source/_integrations/rpi_rf.markdown +++ b/source/_integrations/rpi_rf.markdown @@ -1,11 +1,11 @@ --- title: Raspberry Pi RF description: Instructions on how to integrate devices controlled via codes sent with low-cost GPIO RF modules on a Raspberry Pi into Home Assistant as a switch. -logo: raspberry-pi.png ha_category: - DIY ha_release: 0.19 ha_iot_class: Assumed State +ha_domain: rpi_rf --- The `rpi_rf` switch platform allows you to control devices over 433/315MHz LPD/SRD signals with generic low-cost GPIO RF modules on a [Raspberry Pi](https://www.raspberrypi.org/). diff --git a/source/_integrations/rss_feed_template.markdown b/source/_integrations/rss_feed_template.markdown index 8698d709526..869fde85757 100644 --- a/source/_integrations/rss_feed_template.markdown +++ b/source/_integrations/rss_feed_template.markdown @@ -1,11 +1,11 @@ --- title: RSS Feed Template description: Use this integration to generate RSS feeds showing your latest data. -logo: home-assistant.png ha_category: - Front End ha_release: 0.44 ha_quality_scale: internal +ha_domain: rss_feed_template --- The `rss_feed_template` integration can export any information from Home Assistant as a static RSS feed. This can be used to display that information on many types of devices using an RSS reader. While native apps for Home Assistant are not widely available, native RSS readers exist for almost any platform. diff --git a/source/_integrations/rtorrent.markdown b/source/_integrations/rtorrent.markdown index 63490bcea8c..cbef77ef873 100644 --- a/source/_integrations/rtorrent.markdown +++ b/source/_integrations/rtorrent.markdown @@ -1,11 +1,11 @@ --- title: rTorrent description: Instructions on how to integrate rTorrent sensors within Home Assistant. -logo: rtorrent.png ha_category: - Downloading ha_release: 0.81 ha_iot_class: Local Polling +ha_domain: rtorrent --- The `rtorrent` platform allows you to monitor your downloads with [rTorrent](https://rakshasa.github.io/rtorrent/) from within Home Assistant and setup automations based on the information. diff --git a/source/_integrations/russound_rio.markdown b/source/_integrations/russound_rio.markdown index eabc2ada17d..962be81e8b6 100644 --- a/source/_integrations/russound_rio.markdown +++ b/source/_integrations/russound_rio.markdown @@ -1,11 +1,11 @@ --- title: Russound RIO description: Instructions on how to integrate Russound RIO devices into Home Assistant. -logo: russound.png ha_category: - Media Player ha_release: 0.49 ha_iot_class: Local Push +ha_domain: russound_rio --- The `russound_rio` platform allows you to control Russound devices that make use of the RIO protocol. diff --git a/source/_integrations/russound_rnet.markdown b/source/_integrations/russound_rnet.markdown index 5583c0beef2..5385c91cca9 100644 --- a/source/_integrations/russound_rnet.markdown +++ b/source/_integrations/russound_rnet.markdown @@ -1,11 +1,11 @@ --- title: Russound RNET description: Instructions on how to integrate Russound RNET devices into Home Assistant. -logo: russound.png ha_category: - Media Player ha_release: 0.25 ha_iot_class: Local Polling +ha_domain: russound_rnet --- The `russound_rnet` platform allows you to control Russound devices that make use of the RNET protocol. diff --git a/source/_integrations/sabnzbd.markdown b/source/_integrations/sabnzbd.markdown index 7841cc8f53a..d1c127e77a4 100644 --- a/source/_integrations/sabnzbd.markdown +++ b/source/_integrations/sabnzbd.markdown @@ -7,6 +7,7 @@ ha_category: - Sensor ha_release: 0.7 ha_iot_class: Local Polling +ha_domain: sabnzbd --- The `sabnzbd` integration will allow you to monitor and control your downloads with [SABnzbd](https://sabnzbd.org) from within Home Assistant and setup automations based on the information. diff --git a/source/_integrations/safe_mode.markdown b/source/_integrations/safe_mode.markdown index 8158b2db981..25bcc4a9b6a 100644 --- a/source/_integrations/safe_mode.markdown +++ b/source/_integrations/safe_mode.markdown @@ -3,9 +3,9 @@ title: Safe Mode description: Allows Home Assistant to start up in safe mode. ha_category: [] ha_release: 0.105 -logo: home-assistant.png ha_codeowners: - '@home-assistant/core' +ha_domain: safe_mode --- The `safe_mode` integration is an internally used integration by the @@ -15,7 +15,7 @@ You don't have to configure it in any way since it is automatically always available when Home Assistant needs it. If, during startup, Home Assistant has problems reading your configuration, -it will still continue to start using bit and pieces from the configuration +it will still continue to start using bits and pieces from the configuration of the last time it did start. When this happens, Home Assistant will start in "Safe mode" using this diff --git a/source/_integrations/saj.markdown b/source/_integrations/saj.markdown index 6c8a033d019..f1187fb95ca 100644 --- a/source/_integrations/saj.markdown +++ b/source/_integrations/saj.markdown @@ -8,6 +8,7 @@ ha_iot_class: Local Polling ha_release: '0.100' ha_codeowners: - '@fredericvl' +ha_domain: saj --- The `saj` sensor will poll a [SAJ](https://www.saj-electric.com/) solar inverter and present the values as sensors in Home Assistant. diff --git a/source/_integrations/salt.markdown b/source/_integrations/salt.markdown index b1ac3c5ca6c..3e348821e44 100644 --- a/source/_integrations/salt.markdown +++ b/source/_integrations/salt.markdown @@ -8,6 +8,7 @@ ha_iot_class: Local Polling ha_codeowners: - '@bjornorri' ha_release: 0.106 +ha_domain: salt --- The `salt` platform offers presence detection by looking at connected devices to a [Salt Fiber Box](https://fiber.salt.ch/en/fiber/equipment/fiber-box) router from [Salt](https://www.salt.ch), which is an internet provider in Switzerland. diff --git a/source/_integrations/samsungtv.markdown b/source/_integrations/samsungtv.markdown index 3f59a1bf7ee..b56288376bd 100644 --- a/source/_integrations/samsungtv.markdown +++ b/source/_integrations/samsungtv.markdown @@ -9,6 +9,7 @@ ha_iot_class: Local Polling ha_config_flow: true ha_codeowners: - '@escoand' +ha_domain: samsungtv --- The `samsungtv` platform allows you to control a [Samsung Smart TV](https://www.samsung.com/uk/tvs/all-tvs/). @@ -36,11 +37,6 @@ host: description: "The hostname or IP of the Samsung Smart TV, e.g., `192.168.0.10`." required: true type: string -port: - description: The port of the Samsung Smart TV. If set to 8001, the new websocket connection will be used (required for 2016+ TVs) - For Home Assistant Core installations, you may need to install a Python package, see below. - required: false - type: integer - default: automatically detected name: description: The name you would like to give to the Samsung Smart TV. required: false @@ -101,29 +97,29 @@ For example: for model `UN55NU7100`, the `UN55` would mean it's an LED, North Am - F6500 - F7000 - F8000BF -- K5579 (port must be set to 8001, On/Off, Forward/Backward, Volume control, but no Play button) +- K5579 (On/Off, Forward/Backward, Volume control, but no Play button) - K5600AK (partially supported, turn on works but state is not updated) -- K6500AF (port must be set to 8001) -- KS7005 (port must be set to 8001, MAC address must be provided, On/Off, Volume are OK, no channel change) -- KS7502 (port must be set to 8001, turn on doesn't work, turn off works fine) -- KS8000 (port must be set to 8001) -- KS8005 (port must be set to 8001) -- KS8500 (port must be set to 8001) -- KU6020 (port must be set to 8001) -- KU6100 (port must be set to 8001) -- KU6290 (port must be set to 8001) -- KU6400U (port must be set to 8001) -- KU7000 (port must be set to 8001) -- M5620 (port must be set to 8001) -- MU6170UXZG (port must be set to 8001) -- NU7090 (port must be set to 8801, On/Off, MAC must be specified for Power On) -- NU7400 (port set to 8001) +- K6500AF +- KS7005 (MAC address must be provided, On/Off, Volume are OK, no channel change) +- KS7502 (turn on doesn't work, turn off works fine) +- KS8000 +- KS8005 +- KS8500 +- KU6020 +- KU6100 +- KU6290 +- KU6400U +- KU7000 +- M5620 +- MU6170UXZG +- NU7090 (On/Off, MAC must be specified for Power On) +- NU7400 - NU8000 -- U6000 (port must be set to 8001) -- U6300 (port must be set to 8001) -- UE6199UXZG (port must be set to 8001, On/Off, Forward/Backward, Volume control, but no Play button) -- UE65KS8005 (port must be set to 8001, On/Off, Forward/Backward, Volume are OK, but no Play button) -- UE49KU6470 (port must be set to 8001, On/Off, Forward/Backward, Volume are OK, but no Play button) +- U6000 +- U6300 +- UE6199UXZG (On/Off, Forward/Backward, Volume control, but no Play button) +- UE65KS8005 (On/Off, Forward/Backward, Volume are OK, but no Play button) +- UE49KU6470 (On/Off, Forward/Backward, Volume are OK, but no Play button) - UE46ES5500 (partially supported, turn on doesn't work) #### Models tested but not yet working diff --git a/source/_integrations/satel_integra.markdown b/source/_integrations/satel_integra.markdown index e04dc7514b0..b0bfaa4cf90 100644 --- a/source/_integrations/satel_integra.markdown +++ b/source/_integrations/satel_integra.markdown @@ -9,6 +9,7 @@ ha_category: - Switch ha_release: 0.54 ha_iot_class: Local Push +ha_domain: satel_integra --- The `satel_integra` integration will allow Home Assistant users who own a Satel Integra alarm panel to leverage their alarm system and its sensors to provide Home Assistant with information about their homes. Connectivity between Home Assistant and the alarm is accomplished through a ETHM extension module that must be installed in the alarm. Compatible with ETHM-1 Plus module with firmware version > 2.00 (version 2.04 confirmed). diff --git a/source/_integrations/scene.knx.markdown b/source/_integrations/scene.knx.markdown index 741c4e6039b..bc82cb9e5cc 100644 --- a/source/_integrations/scene.knx.markdown +++ b/source/_integrations/scene.knx.markdown @@ -1,10 +1,10 @@ --- title: "KNX Scene" description: "Instructions on how to integrate KNX Scenes into Home Assistant." -logo: knx.png ha_category: - Scene ha_release: 0.63 +ha_domain: knx ---
    diff --git a/source/_integrations/scene.markdown b/source/_integrations/scene.markdown index 043015406c2..4c2435f34c5 100644 --- a/source/_integrations/scene.markdown +++ b/source/_integrations/scene.markdown @@ -1,13 +1,13 @@ --- title: Scenes description: Instructions on how to setup scenes within Home Assistant. -logo: home-assistant.png ha_category: - Organization ha_release: 0.15 ha_quality_scale: internal ha_codeowners: - '@home-assistant/core' +ha_domain: scene --- You can create scenes that capture the states you want certain entities to be. For example, a scene can specify that light A should be turned on and light B should be bright red. diff --git a/source/_integrations/scrape.markdown b/source/_integrations/scrape.markdown index 5364b178c11..793998ff6d4 100644 --- a/source/_integrations/scrape.markdown +++ b/source/_integrations/scrape.markdown @@ -1,13 +1,13 @@ --- title: Scrape description: Instructions on how to integrate Web scrape sensors into Home Assistant. -logo: home-assistant.png ha_category: - Sensor ha_release: 0.31 ha_iot_class: Cloud Polling ha_codeowners: - '@fabaff' +ha_domain: scrape --- The `scrape` sensor platform is scraping information from websites. The sensor loads a HTML page and gives you the option to search and split out a value. As this is not a full-blown web scraper like [scrapy](https://scrapy.org/), it will most likely only work with simple web pages and it can be time-consuming to get the right section. diff --git a/source/_integrations/script.markdown b/source/_integrations/script.markdown index e619cabb0db..da0e28d634d 100644 --- a/source/_integrations/script.markdown +++ b/source/_integrations/script.markdown @@ -1,13 +1,13 @@ --- title: Scripts description: Instructions on how to setup scripts within Home Assistant. -logo: home-assistant.png ha_category: - Automation ha_release: 0.7 ha_quality_scale: internal ha_codeowners: - '@home-assistant/core' +ha_domain: script --- The `script` integration allows users to specify a sequence of actions to be executed by Home Assistant. These are run when you turn the script on. The script integration will create an entity for each script and allow them to be controlled via services. @@ -29,7 +29,7 @@ script:
    -Script names (e.g., `message_temperature` in the example above) are not allowed to contain capital letters, or dash (minus) characters, i.e. `-`. The preferred way to separate words for better readability is to use underscore (`_`) characters. +Script names (e.g., `message_temperature` in the example above) are not allowed to contain capital letters, or dash (minus) characters, i.e., `-`. The preferred way to separate words for better readability is to use underscore (`_`) characters.
    diff --git a/source/_integrations/scsgate.markdown b/source/_integrations/scsgate.markdown index 082b1c3775e..fd763b674cf 100644 --- a/source/_integrations/scsgate.markdown +++ b/source/_integrations/scsgate.markdown @@ -9,6 +9,7 @@ ha_category: - Switch ha_release: 0.13 ha_iot_class: Local Polling +ha_domain: scsgate --- The SCSGate integration support the [SCSGate](https://translate.google.com/translate?hl=en&sl=it&tl=en&u=http%3A%2F%2Fguidopic.altervista.org%2Feibscsgt%2Finterface.html) device. This a home-brew device allows to interact with the MyHome system from BTicino/Legrande. diff --git a/source/_integrations/search.markdown b/source/_integrations/search.markdown index 381382cee5a..f27d6df2ee7 100644 --- a/source/_integrations/search.markdown +++ b/source/_integrations/search.markdown @@ -3,9 +3,9 @@ title: Search description: Internal search module for Home Assistant. ha_category: [] ha_release: 0.105 -logo: home-assistant.png ha_codeowners: - '@home-assistant/core' +ha_domain: search --- The `search` integration is an internally used integration by the diff --git a/source/_integrations/season.markdown b/source/_integrations/season.markdown index 1a87f68e96d..4288a6a90f3 100644 --- a/source/_integrations/season.markdown +++ b/source/_integrations/season.markdown @@ -3,10 +3,10 @@ title: Season description: Instructions on how to add season sensors into Home Assistant. ha_category: - Utility -logo: home-assistant.png ha_iot_class: Local Polling ha_release: 0.53 ha_quality_scale: internal +ha_domain: season --- The `season` sensor will display the current astronomical or meteorological season (Spring, Summer, Autumn, Winter) based on the user's setting in the configuration file. diff --git a/source/_integrations/sendgrid.markdown b/source/_integrations/sendgrid.markdown index 0ff5dd07dcc..1f0db84fc57 100644 --- a/source/_integrations/sendgrid.markdown +++ b/source/_integrations/sendgrid.markdown @@ -5,6 +5,7 @@ logo: sendgrid.png ha_category: - Notifications ha_release: 0.14 +ha_domain: sendgrid --- The `sendgrid` notification platform sends email notifications via [SendGrid](https://sendgrid.com/), a proven cloud-based email platform. diff --git a/source/_integrations/sense.markdown b/source/_integrations/sense.markdown index 7b547e153f4..493fef0189e 100644 --- a/source/_integrations/sense.markdown +++ b/source/_integrations/sense.markdown @@ -8,8 +8,10 @@ ha_category: - Sensor ha_iot_class: Cloud Polling ha_release: 0.82 +ha_config_flow: true ha_codeowners: - '@kbickar' +ha_domain: sense --- Integrate your [Sense](https://sense.com) meter information into Home Assistant. @@ -21,7 +23,9 @@ There is currently support for the following device types within Home Assistant: ## Configuration -To enable this sensor in your installation, add the following to your `configuration.yaml` file: +To add `Sense` to your installation, go to **Configuration** >> **Integrations** in the UI, click the button with `+` sign and from the list of integrations select **Sense**. + +Alternatively, to enable this sensor in your installation, add the following to your `configuration.yaml` file: ```yaml # Example configuration.yaml entry @@ -51,3 +55,5 @@ Sensors are added for both usage and production with the following names: - **Daily/Weekly/Monthly Usage/Production**: Daily/Weekly/Monthly power usage/production in kWh. Updated every 5 minutes. Binary sensors are created for each of the devices detected by your Sense monitor to show their power state. + +Sensors are created for each of the devices detected by your Sense monitor to show their power usage in Watts. diff --git a/source/_integrations/sensehat.markdown b/source/_integrations/sensehat.markdown index 964dca115eb..7f34b1217e9 100644 --- a/source/_integrations/sensehat.markdown +++ b/source/_integrations/sensehat.markdown @@ -8,6 +8,7 @@ ha_category: - Sensor ha_iot_class: Assumed State ha_release: 0.44 +ha_domain: sensehat --- There is currently support for the following device types within Home Assistant: diff --git a/source/_integrations/sensibo.markdown b/source/_integrations/sensibo.markdown index 8a3bbb08741..ba1ac6f2bf3 100644 --- a/source/_integrations/sensibo.markdown +++ b/source/_integrations/sensibo.markdown @@ -8,6 +8,7 @@ ha_release: 0.44 ha_iot_class: Cloud Polling ha_codeowners: - '@andrey-git' +ha_domain: sensibo --- Integrates [Sensibo](https://sensibo.com) Air Conditioning controller into Home Assistant. diff --git a/source/_integrations/sensor.avri.markdown b/source/_integrations/sensor.avri.markdown new file mode 100644 index 00000000000..9dc0a735293 --- /dev/null +++ b/source/_integrations/sensor.avri.markdown @@ -0,0 +1,51 @@ +--- +title: Avri +description: Instructions on how to set up Avri Waste sensor within Home Assistant. +logo: avri.jpeg +ha_category: + - Sensor +ha_iot_class: Cloud Polling +ha_release: 0.107 +ha_codeowners: + - '@timvancann' +--- + +The `Avri Waste` platform allows you to track the next scheduled waste pickup and the type of waste from [Avri](https://www.avri.nl/). + +## Configuration + +To enable this sensor, add the following lines to your `configuration.yaml`: + +```yaml +# Example configuration.yaml entry +sensor: + - platform: avri + zip_code: YOUR_ZIP_CODE + house_number: YOUR_HOUSE_NUMBER +``` + +{% configuration %} +zip_code: + description: Your zip code + required: true + type: string +house_number: + description: Your house number + required: true + type: integer +house_number_extension: + description: Your house number extension + required: false + type: string +county_code: + description: Your country code + required: false + type: string + default: NL +{% endconfiguration %} + +The default frequency for pulling data from the Avri API is once every 4 hours. If the Avri API does not return any pickup days the state of the sensor is set to `unknown`. + +

    +The Avri sensor uses an unofficial API to obtain data. Use it at your own risk. +

    diff --git a/source/_integrations/sensor.buienradar.markdown b/source/_integrations/sensor.buienradar.markdown index d9497a56a4f..6546f29fa36 100644 --- a/source/_integrations/sensor.buienradar.markdown +++ b/source/_integrations/sensor.buienradar.markdown @@ -6,6 +6,7 @@ ha_category: - Weather ha_release: 0.47 ha_iot_class: Cloud Polling +ha_domain: buienradar --- The `buienradar` platform uses [buienradar.nl](https://buienradar.nl/) as a source for current meteorological data for your location. The weather forecast is delivered by Buienradar, who provides a webservice that provides detailed weather information for users in The Netherlands. The relevant weather station used will be automatically selected based on the location specified in the Home Assistant configuration (or in the buienradar weather/sensor component). A map of all available weather stations can be found [here](https://www.google.com/maps/d/embed?mid=1NivHkTGQUOs0dwQTnTMZi8Uatj0). diff --git a/source/_integrations/sensor.command_line.markdown b/source/_integrations/sensor.command_line.markdown index fb5b2c78f72..90e908941e8 100644 --- a/source/_integrations/sensor.command_line.markdown +++ b/source/_integrations/sensor.command_line.markdown @@ -1,11 +1,11 @@ --- title: "Command line Sensor" description: "Instructions on how to integrate command line sensors into Home Assistant." -logo: command_line.png ha_category: - Utility ha_release: pre 0.7 ha_iot_class: Local Polling +ha_domain: command_line --- diff --git a/source/_integrations/sensor.ios.markdown b/source/_integrations/sensor.ios.markdown index d80d2198582..c3a766f6337 100644 --- a/source/_integrations/sensor.ios.markdown +++ b/source/_integrations/sensor.ios.markdown @@ -1,11 +1,11 @@ --- title: "iOS Sensor" description: "Instructions on how to use the iOS sensors with Home Assistant." -logo: apple.png ha_category: - Sensor ha_release: 0.31 ha_iot_class: Local Push +ha_domain: ios --- The `ios` sensor platform is the Home Assistant part for using the iOS companion app. For further details please check the [iOS section](/docs/ecosystem/ios/) in the documentation for further details. diff --git a/source/_integrations/sensor.knx.markdown b/source/_integrations/sensor.knx.markdown index c68015799d5..a60c3a0aa38 100644 --- a/source/_integrations/sensor.knx.markdown +++ b/source/_integrations/sensor.knx.markdown @@ -1,11 +1,11 @@ --- title: "KNX Sensor" description: "Instructions on how to use a KNX Sensor with Home Assistant." -logo: knx.png ha_category: - Sensor ha_release: 0.29 ha_iot_class: Local Push +ha_domain: knx ---
    diff --git a/source/_integrations/sensor.markdown b/source/_integrations/sensor.markdown index 8a85255f098..9bd443e6720 100644 --- a/source/_integrations/sensor.markdown +++ b/source/_integrations/sensor.markdown @@ -1,11 +1,11 @@ --- title: Sensor description: Instructions on how to setup your sensors with Home Assistant. -logo: home-assistant.png ha_category: - Sensor ha_release: 0.7 ha_quality_scale: internal +ha_domain: sensor --- Sensors are gathering information about states and conditions. diff --git a/source/_integrations/sensor.metoffice.markdown b/source/_integrations/sensor.metoffice.markdown index 83d1f53fcf2..9a717d95332 100644 --- a/source/_integrations/sensor.metoffice.markdown +++ b/source/_integrations/sensor.metoffice.markdown @@ -1,11 +1,11 @@ --- title: "Met Office Sensor" description: "Instructions on how to integrate Met Office weather conditions into Home Assistant." -logo: metoffice.jpg ha_category: - Weather ha_release: 0.42 ha_iot_class: Cloud Polling +ha_domain: metoffice --- The `metoffice` sensor platform uses the Met Office's [DataPoint API](https://www.metoffice.gov.uk/datapoint) for weather data. diff --git a/source/_integrations/sensor.modbus.markdown b/source/_integrations/sensor.modbus.markdown index a1549c7f35f..17ed91eb7c2 100644 --- a/source/_integrations/sensor.modbus.markdown +++ b/source/_integrations/sensor.modbus.markdown @@ -1,11 +1,11 @@ --- title: Modbus Sensor description: "Instructions on how to integrate Modbus sensors into Home Assistant." -logo: modbus.png ha_category: - Sensor ha_release: pre 0.7 ha_iot_class: Local Push +ha_domain: modbus --- The `modbus` sensor allows you to gather data from [Modbus](http://www.modbus.org/) registers. diff --git a/source/_integrations/sensor.mqtt.markdown b/source/_integrations/sensor.mqtt.markdown index f2629506fc8..3a9ca27d2a3 100644 --- a/source/_integrations/sensor.mqtt.markdown +++ b/source/_integrations/sensor.mqtt.markdown @@ -1,11 +1,11 @@ --- title: "MQTT Sensor" description: "Instructions on how to integrate MQTT sensors within Home Assistant." -logo: mqtt.png ha_category: - Sensor ha_release: 0.7 ha_iot_class: Configurable +ha_domain: mqtt --- This `mqtt` sensor platform uses the MQTT message payload as the sensor value. If messages in this `state_topic` are published with *RETAIN* flag, the sensor will receive an instant update with last known value. Otherwise, the initial state will be undefined. @@ -22,90 +22,23 @@ sensor: ``` {% configuration %} -state_topic: - description: The MQTT topic subscribed to receive sensor values. - required: true - type: string -name: - description: The name of the MQTT sensor. - required: false - type: string - default: MQTT Sensor -qos: - description: The maximum QoS level of the state topic. - required: false - type: integer - default: 0 -unit_of_measurement: - description: Defines the units of measurement of the sensor, if any. - required: false - type: string -icon: - description: The icon for the sensor. - required: false - type: icon -expire_after: - description: Defines the number of seconds after the value expires if it's not updated. - required: false - type: integer - default: 0 -value_template: - description: "Defines a [template](/docs/configuration/templating/#processing-incoming-data) to extract the value." - required: false - type: template -force_update: - description: Sends update events even if the value hasn't changed. Useful if you want to have meaningful value graphs in history. - reqired: false - type: boolean - default: false availability_topic: description: The MQTT topic subscribed to receive availability (online/offline) updates. required: false type: string -payload_available: - description: The payload that represents the available state. - required: false - type: string - default: online -payload_not_available: - description: The payload that represents the unavailable state. - required: false - type: string - default: offline -json_attributes_topic: - description: The MQTT topic subscribed to receive a JSON dictionary payload and then set as sensor attributes. Implies `force_update` of the current sensor state when a message is received on this topic. - required: false - type: string -json_attributes_template: - description: "Defines a [template](/docs/configuration/templating/#processing-incoming-data) to extract the JSON dictionary from messages received on the `json_attributes_topic`." - required: false - type: template -json_attributes: - description: (Deprecated, replaced by json_attributes_topic) A list of keys to extract values from a JSON dictionary payload and then set as sensor attributes. - required: false - type: [string, list] -unique_id: - description: "An ID that uniquely identifies this sensor. If two sensors have the same unique ID, Home Assistant will raise an exception." - required: false - type: string -device_class: - description: The [type/class](/integrations/sensor/#device-class) of the sensor to set the icon in the frontend. - required: false - type: device_class - default: None device: description: "Information about the device this sensor is a part of to tie it into the [device registry](https://developers.home-assistant.io/docs/en/device_registry_index.html). Only works through [MQTT discovery](/docs/mqtt/discovery/) and when [`unique_id`](#unique_id) is set." required: false type: map keys: - identifiers: - description: A list of IDs that uniquely identify the device. For example a serial number. - required: false - type: [string, list] connections: description: 'A list of connections of the device to the outside world as a list of tuples `[connection_type, connection_identifier]`. For example the MAC address of a network interface: `"connections": [["mac", "02:5b:26:a8:dc:12"]]`.' required: false type: list + identifiers: + description: A list of IDs that uniquely identify the device. For example a serial number. + required: false + type: [string, list] manufacturer: description: The manufacturer of the device. required: false @@ -122,6 +55,73 @@ device: description: The firmware version of the device. required: false type: string +device_class: + description: The [type/class](/integrations/sensor/#device-class) of the sensor to set the icon in the frontend. + required: false + type: device_class + default: None +expire_after: + description: Defines the number of seconds after the value expires if it's not updated. + required: false + type: integer + default: 0 +force_update: + description: Sends update events even if the value hasn't changed. Useful if you want to have meaningful value graphs in history. + reqired: false + type: boolean + default: false +icon: + description: The icon for the sensor. + required: false + type: icon +json_attributes: + description: (Deprecated, replaced by json_attributes_topic) A list of keys to extract values from a JSON dictionary payload and then set as sensor attributes. + required: false + type: [string, list] +json_attributes_template: + description: "Defines a [template](/docs/configuration/templating/#processing-incoming-data) to extract the JSON dictionary from messages received on the `json_attributes_topic`." + required: false + type: template +json_attributes_topic: + description: The MQTT topic subscribed to receive a JSON dictionary payload and then set as sensor attributes. Implies `force_update` of the current sensor state when a message is received on this topic. + required: false + type: string +name: + description: The name of the MQTT sensor. + required: false + type: string + default: MQTT Sensor +payload_available: + description: The payload that represents the available state. + required: false + type: string + default: online +payload_not_available: + description: The payload that represents the unavailable state. + required: false + type: string + default: offline +qos: + description: The maximum QoS level of the state topic. + required: false + type: integer + default: 0 +state_topic: + description: The MQTT topic subscribed to receive sensor values. + required: true + type: string +unique_id: + description: "An ID that uniquely identifies this sensor. If two sensors have the same unique ID, Home Assistant will raise an exception." + required: false + type: string +unit_of_measurement: + description: Defines the units of measurement of the sensor, if any. + required: false + type: string +value_template: + description: "Defines a [template](/docs/configuration/templating/#processing-incoming-data) to extract the value." + required: false + type: template {% endconfiguration %} ## Examples diff --git a/source/_integrations/sensor.mysensors.markdown b/source/_integrations/sensor.mysensors.markdown index 908228b1d3c..6b6010b8fbf 100644 --- a/source/_integrations/sensor.mysensors.markdown +++ b/source/_integrations/sensor.mysensors.markdown @@ -1,12 +1,12 @@ --- title: "MySensors Sensor" description: "Instructions on how to integrate MySensors sensors into Home Assistant." -logo: mysensors.png ha_category: - DIY - Sensor ha_iot_class: Local Push ha_release: 0.7 +ha_domain: mysensors --- Integrates MySensors sensors into Home Assistant. See the [main integration](/integrations/mysensors/) for configuration instructions. diff --git a/source/_integrations/sensor.rflink.markdown b/source/_integrations/sensor.rflink.markdown index 5db5a1a7e61..32a74659580 100644 --- a/source/_integrations/sensor.rflink.markdown +++ b/source/_integrations/sensor.rflink.markdown @@ -6,6 +6,7 @@ ha_category: - Sensor ha_release: 0.38 ha_iot_class: Local Polling +ha_domain: rflink --- The `rflink` integration supports devices that use [RFLink gateway firmware](http://www.nemcon.nl/blog2/), for example the [Nodo RFLink Gateway](https://www.nodo-shop.nl/nl/21-rflink-gateway). RFLink gateway is an Arduino firmware that allows two-way communication with a multitude of RF wireless devices using cheap hardware (Arduino + transceiver). diff --git a/source/_integrations/sensor.rfxtrx.markdown b/source/_integrations/sensor.rfxtrx.markdown index fc4a797d977..3045d859ffe 100644 --- a/source/_integrations/sensor.rfxtrx.markdown +++ b/source/_integrations/sensor.rfxtrx.markdown @@ -1,11 +1,11 @@ --- title: "RFXtrx Sensor" description: "Instructions on how to integrate RFXtrx sensors into Home Assistant." -logo: rfxtrx.png ha_category: - Sensor ha_iot_class: Local Polling ha_release: 0.7 +ha_domain: rfxtrx --- The `rfxtrx` platform support sensors that communicate in the frequency range of 433.92 MHz. diff --git a/source/_integrations/sensor.websocket_api.markdown b/source/_integrations/sensor.websocket_api.markdown index 987d1717dd8..156f3fbd780 100644 --- a/source/_integrations/sensor.websocket_api.markdown +++ b/source/_integrations/sensor.websocket_api.markdown @@ -7,6 +7,7 @@ ha_category: ha_release: 0.33 ha_iot_class: Local Push ha_quality_scale: internal +ha_domain: websocket_api --- The `websocket_api` sensor platform shows how many clients are connected to the stream API. diff --git a/source/_integrations/sensor.xiaomi_aqara.markdown b/source/_integrations/sensor.xiaomi_aqara.markdown index d877edb9eaf..b49dd76f345 100644 --- a/source/_integrations/sensor.xiaomi_aqara.markdown +++ b/source/_integrations/sensor.xiaomi_aqara.markdown @@ -1,11 +1,11 @@ --- title: "Xiaomi Sensor" description: "Instructions on how to setup the Xiaomi sensor within Home Assistant." -logo: xiaomi.png ha_category: - Sensor ha_release: "0.50" ha_iot_class: Local Push +ha_domain: xiaomi_aqara --- The `xiaomi aqara` sensor platform allows you to get data from your [Xiaomi](https://www.mi.com/en/) sensors. diff --git a/source/_integrations/sensor.xiaomi_miio.markdown b/source/_integrations/sensor.xiaomi_miio.markdown index 04f18298eeb..a432e741605 100644 --- a/source/_integrations/sensor.xiaomi_miio.markdown +++ b/source/_integrations/sensor.xiaomi_miio.markdown @@ -1,11 +1,11 @@ --- title: "Xiaomi Air Quality Index Monitor" description: "Instructions how to integrate your Xiaomi Mi Air Quality Index Monitor within Home Assistant." -logo: xiaomi.png ha_category: - Health ha_iot_class: Local Polling ha_release: 0.66 +ha_domain: xiaomi_miio --- The `xiaomi_miio` sensor platform is observing your Xiaomi Mi Air Quality Monitor (PM2.5) and reporting the air quality index. diff --git a/source/_integrations/sentry.markdown b/source/_integrations/sentry.markdown index 6991dc9e755..a1a5dafbbe1 100644 --- a/source/_integrations/sentry.markdown +++ b/source/_integrations/sentry.markdown @@ -1,7 +1,6 @@ --- title: Sentry description: Record errors to Sentry. -logo: sentry.svg ha_category: - System Monitor ha_iot_class: Cloud Polling @@ -9,6 +8,7 @@ ha_release: 0.104 ha_config_flow: true ha_codeowners: - '@dcramer' +ha_domain: sentry ---
    diff --git a/source/_integrations/serial.markdown b/source/_integrations/serial.markdown index e405e87b5ac..abf12d281c4 100644 --- a/source/_integrations/serial.markdown +++ b/source/_integrations/serial.markdown @@ -1,13 +1,13 @@ --- title: Serial description: Instructions on how to integrate data from serial connected sensors into Home Assistant. -logo: home-assistant.png ha_category: - Sensor ha_release: 0.56 ha_iot_class: Local Polling ha_codeowners: - '@fabaff' +ha_domain: serial --- The `serial` sensor platform is using the data provided by a device connected to the serial port of the system where Home Assistant is running. With [`ser2net`](http://ser2net.sourceforge.net/) and [`socat`](http://www.dest-unreach.org/socat/) would it also work for sensors connected to a remote system. diff --git a/source/_integrations/serial_pm.markdown b/source/_integrations/serial_pm.markdown index 2b156485676..f5848d33bba 100644 --- a/source/_integrations/serial_pm.markdown +++ b/source/_integrations/serial_pm.markdown @@ -6,6 +6,7 @@ ha_category: - DIY ha_release: 0.26 ha_iot_class: Local Polling +ha_domain: serial_pm --- Particulate matter sensors measure the amount of very small particles in the air. A short introduction how these sensors work can be found on [Open Home Automation](https://www.open-homeautomation.com/2016/07/19/measuring-air-quality/). diff --git a/source/_integrations/sesame.markdown b/source/_integrations/sesame.markdown index c3599028536..8ec2919733c 100644 --- a/source/_integrations/sesame.markdown +++ b/source/_integrations/sesame.markdown @@ -6,6 +6,7 @@ ha_category: - Lock ha_iot_class: Cloud Polling ha_release: 0.47 +ha_domain: sesame --- The `sesame` platform allows you to control your [Sesame](https://candyhouse.co/) smart locks made by CANDY HOUSE, Inc. diff --git a/source/_integrations/seven_segments.markdown b/source/_integrations/seven_segments.markdown index 47d1ce6e8e8..95821ce5c4e 100644 --- a/source/_integrations/seven_segments.markdown +++ b/source/_integrations/seven_segments.markdown @@ -1,12 +1,12 @@ --- title: Seven Segments OCR description: Instructions on how to use OCR for seven segments displays into Home Assistant. -logo: home-assistant.png ha_category: - Image Processing ha_release: 0.45 og_image: /images/screenshots/ssocr.png ha_iot_class: Local Polling +ha_domain: seven_segments --- The `seven_segments` image processing platform allows you to read physical seven segments displays through Home Assistant. [`ssocr`](https://www.unix-ag.uni-kl.de/~auerswal/ssocr/) is used to extract the value shown on the display which is observed by a [camera](/integrations/camera/). diff --git a/source/_integrations/seventeentrack.markdown b/source/_integrations/seventeentrack.markdown index 21a56a4ff76..1eabbfd3993 100644 --- a/source/_integrations/seventeentrack.markdown +++ b/source/_integrations/seventeentrack.markdown @@ -1,13 +1,13 @@ --- title: 17TRACK description: Instructions on how to use 17track.net data within Home Assistant -logo: 17track.png ha_category: - Postal Service ha_release: 0.83 ha_iot_class: Cloud Polling ha_codeowners: - '@bachya' +ha_domain: seventeentrack --- The `seventeentrack` sensor platform allows users to get package data tied to their [17track.net](https://www.17track.net/en) account. The platform creates both summary sensors, which show the number of packages in a current state (e.g., "In Transit"), as well as individual sensors for each package within the account. diff --git a/source/_integrations/shell_command.markdown b/source/_integrations/shell_command.markdown index 8ba7d934d54..296903b2446 100644 --- a/source/_integrations/shell_command.markdown +++ b/source/_integrations/shell_command.markdown @@ -3,11 +3,11 @@ title: Shell Command description: Instructions on how to integrate Shell commands into Home Assistant. ha_category: - Automation -logo: home-assistant.png ha_release: 0.7.6 ha_quality_scale: internal ha_codeowners: - '@home-assistant/core' +ha_domain: shell_command --- This integration can expose regular shell commands as services. Services can be called from a [script] or in [automation]. diff --git a/source/_integrations/shiftr.markdown b/source/_integrations/shiftr.markdown index cbb91afefb2..ed40227b0cc 100644 --- a/source/_integrations/shiftr.markdown +++ b/source/_integrations/shiftr.markdown @@ -1,12 +1,12 @@ --- title: shiftr.io description: Transfer events to Shiftr.io. -logo: shiftr.png ha_category: - History ha_release: 0.48 ha_codeowners: - '@fabaff' +ha_domain: shiftr --- The `shiftr` integration makes it possible to transfer details collected with Home Assistant to [Shiftr.io](https://shiftr.io) and visualize the flow of the information. Keep in mind that your details will be public! diff --git a/source/_integrations/shodan.markdown b/source/_integrations/shodan.markdown index 3032528dff8..f939242e866 100644 --- a/source/_integrations/shodan.markdown +++ b/source/_integrations/shodan.markdown @@ -8,6 +8,7 @@ logo: shodan.png ha_release: 0.51 ha_codeowners: - '@fabaff' +ha_domain: shodan --- The `shodan` sensor platform is displaying the total of result of a diff --git a/source/_integrations/shopping_list.markdown b/source/_integrations/shopping_list.markdown index 49dade52144..e959fde4780 100644 --- a/source/_integrations/shopping_list.markdown +++ b/source/_integrations/shopping_list.markdown @@ -1,16 +1,28 @@ --- title: Shopping List description: Instructions on how to integrate a Shopping list into Home Assistant using Intent. -logo: home-assistant.png ha_category: - Intent ha_release: '0.50' +ha_config_flow: true ha_quality_scale: internal +ha_domain: shopping_list --- The `shopping_list` integration allows you to keep track of shopping list items. Includes the ability to add items via your voice using the sentence "Add eggs to my shopping list". -## Configuration +## Configuration - GUI + +From the Home Assistant front page go to **Configuration** and then select **Integrations** from the list. + +Use the plus button in the bottom right to add a new integration called **Shopping List**. + +In the popup: +- Submit + +The success dialog will appear or an error will be displayed in the popup. + +## Configuration - Manual ```yaml # Example configuration.yaml entry diff --git a/source/_integrations/sht31.markdown b/source/_integrations/sht31.markdown index ca4ee6756f8..072f17e12b0 100644 --- a/source/_integrations/sht31.markdown +++ b/source/_integrations/sht31.markdown @@ -4,8 +4,8 @@ description: Instructions on how to integrate SHT31 sensors within Home Assistan ha_category: - DIY ha_release: 0.68 -logo: sensirion.png ha_iot_class: Local Polling +ha_domain: sht31 --- The `sht31` sensor platform allows you to get the current temperature and humidity from a Sensirion SHT31 device. diff --git a/source/_integrations/sigfox.markdown b/source/_integrations/sigfox.markdown index 352080c94ce..4b76b45825c 100644 --- a/source/_integrations/sigfox.markdown +++ b/source/_integrations/sigfox.markdown @@ -6,6 +6,7 @@ ha_category: - Sensor ha_iot_class: Cloud Polling ha_release: 0.68 +ha_domain: sigfox --- [SigFox](https://www.sigfox.com/en) integration adding a sensor for each Sigfox device registered with your account. The default name of sensors is `sigfox_{DEVICE_ID}` where `DEVICE_ID` is the devices Sigfox ID. The state of an added Sigfox sensor is the payload of the last message published by that device. Additionally, there are attributes for the latitude and longitude coordinates of the device, as well as the signal-to-noise ratio ([snr](https://en.wikipedia.org/wiki/Signal-to-noise_ratio)). diff --git a/source/_integrations/sighthound.markdown b/source/_integrations/sighthound.markdown index 8b18c50fe7d..360cf885989 100644 --- a/source/_integrations/sighthound.markdown +++ b/source/_integrations/sighthound.markdown @@ -8,13 +8,16 @@ ha_release: 0.105 ha_iot_class: Cloud Polling ha_codeowners: - '@robmarkcole' +ha_domain: sighthound --- Detect people in camera images using [Sighthound Cloud](https://www.sighthound.com/products/cloud). The Sighthound Developer tier (free for non-commercial use) allows 5000 images to be processed per month. If you need more processing per month you will need to sign up for a production account (i.e., a Basic or Pro account). This integration adds an image processing entity where the state of the entity is the number of people detected in an image. For each person detected, an `sighthound.person_detected` event is fired. The event data includes the entity_id of the image processing entity firing the event, and the bounding box around the detected person. -**Note** that by default the component will not automatically scan images, but requires you to call the `image_processing.scan` service e.g. using an automation triggered by motion. +If `save_file_folder` is configured, on each new detection of a person, an annotated image with the name `sighthound_{camera_name}_latest.jpg` is saved in the configured folder if it doesn't already exist, and overwritten if it does exist. The saved image shows the bounding box around detected people and can be displayed on the Home Assistant front end using a [Local File](/integrations/local_file/) camera, and used in notifications. If `save_timestamped_file` is configured as `true`, then the annotated image is saved with a file name that includes the time of detection. + +**Note** that by default the component will not automatically scan images, but requires you to call the `image_processing.scan` service, e.g., using an automation triggered by motion. ## Configuration @@ -25,6 +28,8 @@ To enable this platform in your installation, add the following to your `configu image_processing: - platform: sighthound api_key: some_key + save_file_folder: /my_dir/ + save_timestamped_file: True source: - entity_id: camera.my_cam ``` @@ -38,6 +43,14 @@ account_type: description: If you have a paid account, used `prod`. required: false type: string +save_file_folder: + description: The folder to save annotated images to. + required: false + type: string +save_timestamped_file: + description: Save the processed image with the time of detection in the filename. Requires save_file_folder to be configured. + required: false + type: string source: description: The list of image sources. required: true diff --git a/source/_integrations/signal_messenger.markdown b/source/_integrations/signal_messenger.markdown index 905642736f1..10ff747cc09 100644 --- a/source/_integrations/signal_messenger.markdown +++ b/source/_integrations/signal_messenger.markdown @@ -1,12 +1,12 @@ --- title: Signal Messenger description: Instructions on how to integrate Signal Messenger within Home Assistant. -logo: signal_messenger.png ha_category: - Notifications ha_release: 0.104 ha_codeowners: - '@bbernhard' +ha_domain: signal_messenger --- The `signal_messenger` integration uses the [Signal Messenger REST API](https://github.com/bbernhard/signal-cli-rest-api) to deliver notifications from Home Assistant to your Android or iOS device. diff --git a/source/_integrations/simplepush.markdown b/source/_integrations/simplepush.markdown index 05fcbfd6834..419219b3151 100644 --- a/source/_integrations/simplepush.markdown +++ b/source/_integrations/simplepush.markdown @@ -5,6 +5,7 @@ logo: simplepush.png ha_category: - Notifications ha_release: 0.29 +ha_domain: simplepush --- The `simplepush` platform uses [Simplepush](https://simplepush.io/) to delivery notifications from Home Assistant to your Android device. Unlike similar apps the Simplepush app requires no registration. diff --git a/source/_integrations/simplisafe.markdown b/source/_integrations/simplisafe.markdown index 715cc2b57f4..91f809e5ace 100644 --- a/source/_integrations/simplisafe.markdown +++ b/source/_integrations/simplisafe.markdown @@ -9,6 +9,7 @@ ha_category: ha_config_flow: true ha_codeowners: - '@bachya' +ha_domain: simplisafe --- The `simplisafe` integration integrates [SimpliSafe home security](https://simplisafe.com) (V2 and V3) systems into Home Assistant. Multiple SimpliSafe accounts can be accommodated. diff --git a/source/_integrations/simulated.markdown b/source/_integrations/simulated.markdown index 79bc4a947b9..d6080164207 100644 --- a/source/_integrations/simulated.markdown +++ b/source/_integrations/simulated.markdown @@ -1,12 +1,12 @@ --- title: Simulated description: Component for simulating a numerical sensor. -logo: home-assistant.png ha_category: - Utility ha_iot_class: Local Polling ha_release: 0.65 ha_quality_scale: internal +ha_domain: simulated --- The `simulated` sensor platform provides a simulated sensor that generates a time-varying signal `V(t)` given by the [function](https://en.wikipedia.org/wiki/Sine_wave): diff --git a/source/_integrations/sinch.markdown b/source/_integrations/sinch.markdown index ab425eb9c00..fc728328eff 100644 --- a/source/_integrations/sinch.markdown +++ b/source/_integrations/sinch.markdown @@ -7,6 +7,7 @@ ha_category: ha_release: 0.101 ha_codeowners: - '@bendikrb' +ha_domain: sinch --- The `sinch` platform uses [Sinch](https://www.sinch.com/products/messaging/sms/) to deliver notifications from Home Assistant. diff --git a/source/_integrations/sisyphus.markdown b/source/_integrations/sisyphus.markdown index 96cc73ceee1..a4b0a866f7d 100644 --- a/source/_integrations/sisyphus.markdown +++ b/source/_integrations/sisyphus.markdown @@ -1,7 +1,6 @@ --- title: Sisyphus description: Instructions on how to integrate your Sisyphus Kinetic Art Table within Home Assistant. -logo: sisyphus.png ha_category: - Hub - Light @@ -10,6 +9,7 @@ ha_release: 0.75 ha_iot_class: Local Push ha_codeowners: - '@jkeljo' +ha_domain: sisyphus --- The [Sisyphus](https://sisyphus-industries.com/) integration for Home Assistant allows you to observe and control your Sisyphus Kinetic Art Table. diff --git a/source/_integrations/sky_hub.markdown b/source/_integrations/sky_hub.markdown index c499f7f3a94..60d43e6a48f 100644 --- a/source/_integrations/sky_hub.markdown +++ b/source/_integrations/sky_hub.markdown @@ -5,6 +5,7 @@ logo: sky.png ha_category: - Presence Detection ha_release: 0.37 +ha_domain: sky_hub --- The `sky_hub` platform offers presence detection by looking at connected devices to a [Sky Hub router](https://www.sky.com/shop/broadband-talk/sky-hub/) based router. diff --git a/source/_integrations/skybeacon.markdown b/source/_integrations/skybeacon.markdown index 21dd1af3852..dfa888e492c 100644 --- a/source/_integrations/skybeacon.markdown +++ b/source/_integrations/skybeacon.markdown @@ -5,6 +5,7 @@ ha_category: - DIY ha_release: 0.37 ha_iot_class: Local Polling +ha_domain: skybeacon --- The `skybeacon` sensor platform supports [CR2477](https://cnsky9.en.alibaba.com/)-powered [iBeacon](https://en.wikipedia.org/wiki/IBeacon)/eddystone sensors that come with temperature/sensor module. diff --git a/source/_integrations/skybell.markdown b/source/_integrations/skybell.markdown index a820c3e3ef6..2ea4573c73e 100644 --- a/source/_integrations/skybell.markdown +++ b/source/_integrations/skybell.markdown @@ -1,7 +1,6 @@ --- title: SkyBell description: Instructions on how to integrate your Skybell HD devices within Home Assistant. -logo: skybell.png ha_category: - Doorbell - Binary Sensor @@ -11,6 +10,7 @@ ha_category: - Switch ha_release: 0.56 ha_iot_class: Cloud Polling +ha_domain: skybell --- The `skybell` implementation allows you to integrate your [Skybell.com](http://www.skybell.com/) doorbells in Home Assistant. diff --git a/source/_integrations/slack.markdown b/source/_integrations/slack.markdown index e89f5ed0376..d9e099061eb 100644 --- a/source/_integrations/slack.markdown +++ b/source/_integrations/slack.markdown @@ -5,6 +5,7 @@ logo: slack.png ha_category: - Notifications ha_release: pre 0.7 +ha_domain: slack --- The `slack` platform allows you to deliver notifications from Home Assistant to [Slack](https://slack.com/). @@ -13,11 +14,11 @@ The `slack` platform allows you to deliver notifications from Home Assistant to ### Bot posting as you -1. Create a [new app](https://api.slack.com/apps) under your Slack.com account -2. Click the `OAuth & Permissions` link in the sidebar, under the Features heading -2. In the Scopes section, add the `chat:write:user` scope, `Send messages as user` -3. Scroll up to `OAuth Tokens & Redirect URLs` and click `Install App` -4. Copy your `OAuth Access Token` and put that key into your `configuration.yaml` file -- see below +1. Create a [new app](https://api.slack.com/apps) under your Slack.com account. +2. Click the `OAuth & Permissions` link in the sidebar, under the Features heading. +3. In the Scopes section, add the `chat:write` scope, `Send messages as user`. If you get a `missing_scope` error when trying to send a message, check these permissions. +4. Scroll up to `OAuth Tokens & Redirect URLs` and click `Install App`. +5. Copy your `OAuth Access Token` and put that key into your `configuration.yaml` file -- see below.
    @@ -132,6 +133,21 @@ Example for posting formatted attachment: } ``` +You can also use YAML to send messages from your automations + +```yaml + + - service: notify.slack + data: + message: "Latest notification" + title: "Latest image" + target: ["#home-assistant"] + data: + file: + path: "/myfile.jpg" +``` Please note that both `message` is a required key, but is always shown, so use an empty (`""`) string for `message` if you don't want the extra text. To use notifications, please see the [getting started with automation page](/getting-started/automation/). + +Extra information: You must add the bot to your Slack channel, otherwise you can't send messages in this channel. diff --git a/source/_integrations/sleepiq.markdown b/source/_integrations/sleepiq.markdown index aa243ab2d56..9fcae8edbf4 100644 --- a/source/_integrations/sleepiq.markdown +++ b/source/_integrations/sleepiq.markdown @@ -9,6 +9,7 @@ ha_category: - Light ha_release: 0.29 ha_iot_class: Local Polling +ha_domain: sleepiq --- The SleepIQ implementation lets you view sensor data from [SleepIQ by SleepNumber](https://www.sleepnumber.com/sleepiq-sleep-tracker). In particular, it lets you see the occupancy and current SleepNumber (ie current firmness) of each side of a SleepNumber bed. Control of the lights included in the FlexFit platform is available as well. diff --git a/source/_integrations/slide.markdown b/source/_integrations/slide.markdown index d14afc1436f..d6e2c7ab360 100644 --- a/source/_integrations/slide.markdown +++ b/source/_integrations/slide.markdown @@ -9,6 +9,7 @@ ha_iot_class: Cloud Polling ha_release: 0.99 ha_codeowners: - '@ualex73' +ha_domain: slide --- The `slide` implementation allows you to integrate your [slide.store](https://slide.store/) devices in Home Assistant using the [official API](https://documenter.getpostman.com/view/6223391/S1Lu2pSf?version=latest). diff --git a/source/_integrations/sma.markdown b/source/_integrations/sma.markdown index 07c708eeabe..f3932e472ec 100644 --- a/source/_integrations/sma.markdown +++ b/source/_integrations/sma.markdown @@ -8,6 +8,7 @@ ha_iot_class: Local Polling ha_release: 0.36 ha_codeowners: - '@kellerza' +ha_domain: sma --- The `sma` sensor will poll a [SMA](http://www.sma-solar.com/) [(US)](https://www.sma-america.com/) solar inverter and present the values as sensors (or attributes of sensors) in Home Assistant. diff --git a/source/_integrations/smappee.markdown b/source/_integrations/smappee.markdown index 0b66df6971a..8a12de328fe 100644 --- a/source/_integrations/smappee.markdown +++ b/source/_integrations/smappee.markdown @@ -9,6 +9,7 @@ ha_category: - Sensor - Switch ha_iot_class: Local Push +ha_domain: smappee --- The `smappee` integration adds support for the [Smappee](https://www.smappee.com/) controller for energy monitoring and Comport plug switches. diff --git a/source/_integrations/smarthab.markdown b/source/_integrations/smarthab.markdown index 5cf38554f1f..866f7c87f4a 100644 --- a/source/_integrations/smarthab.markdown +++ b/source/_integrations/smarthab.markdown @@ -1,7 +1,6 @@ --- title: SmartHab description: Instructions on how to integrate SmartHab devices into Home Assistant -logo: smarthab.png ha_release: 0.94 ha_category: - Hub @@ -10,6 +9,7 @@ ha_category: ha_iot_class: Cloud Polling ha_codeowners: - '@outadoc' +ha_domain: smarthab --- If your home is fitted with [SmartHab](https://www.smarthab.fr/en/home/)'s diff --git a/source/_integrations/smartthings.markdown b/source/_integrations/smartthings.markdown index 72fdd161a86..700f3a163b1 100644 --- a/source/_integrations/smartthings.markdown +++ b/source/_integrations/smartthings.markdown @@ -19,6 +19,7 @@ ha_iot_class: Cloud Push ha_config_flow: true ha_codeowners: - '@andrewsayre' +ha_domain: smartthings --- Samsung SmartThings is integrated into Home Assistant through the SmartThings Cloud API. The SmartThings integration is the main integration to integrate all SmartThings related platforms. The basic features of this integration include: diff --git a/source/_integrations/smarty.markdown b/source/_integrations/smarty.markdown index 9057156506d..6f8747d1f55 100644 --- a/source/_integrations/smarty.markdown +++ b/source/_integrations/smarty.markdown @@ -9,6 +9,7 @@ ha_category: ha_release: 0.95 ha_codeowners: - '@z0mbieprocess' +ha_domain: smarty --- The `smarty` integration lets you control Salda [Smarty](http://www.salda.lt/en/products/category/compact-counter-flow-units) ventilation units from Home Assistant. You need a [MB-GATEWAY](http://www.salda.lt/en/products/item/5637227077) or something similar to connect to your local network. diff --git a/source/_integrations/smhi.markdown b/source/_integrations/smhi.markdown index fe0804a6628..8195f15145e 100644 --- a/source/_integrations/smhi.markdown +++ b/source/_integrations/smhi.markdown @@ -8,6 +8,7 @@ ha_category: ha_release: 0.81 ha_iot_class: Cloud Polling ha_config_flow: true +ha_domain: smhi --- The `smhi` integration adds support for the [SMHI.se](https://www.smhi.se/) web service as a source for meteorological data for your location. diff --git a/source/_integrations/sms.markdown b/source/_integrations/sms.markdown index dfd8bf976ed..03ec45959d5 100644 --- a/source/_integrations/sms.markdown +++ b/source/_integrations/sms.markdown @@ -8,6 +8,7 @@ ha_release: 0.105 ha_iot_class: Local Polling ha_codeowners: - '@ocalvo' +ha_domain: sms --- The `sms` integration allows having a local execution SMS notification via [Gammu](https://wammu.eu/gammu/). This is ideal when the internet is offline or when the power goes out. diff --git a/source/_integrations/smtp.markdown b/source/_integrations/smtp.markdown index ee22f40b293..e85b8242cba 100644 --- a/source/_integrations/smtp.markdown +++ b/source/_integrations/smtp.markdown @@ -1,12 +1,12 @@ --- title: SMTP description: Instructions on how to add e-mail notifications to Home Assistant. -logo: smtp.png ha_category: - Notifications ha_release: pre 0.7 ha_codeowners: - '@fabaff' +ha_domain: smtp --- The `smtp` platform allows you to deliver notifications from Home Assistant to an e-mail recipient. diff --git a/source/_integrations/snapcast.markdown b/source/_integrations/snapcast.markdown index 8dc4d17ca90..9e249ad7697 100644 --- a/source/_integrations/snapcast.markdown +++ b/source/_integrations/snapcast.markdown @@ -6,6 +6,7 @@ ha_category: - Media Player ha_release: 0.13 ha_iot_class: Local Polling +ha_domain: snapcast --- The `snapcast` platform allows you to control [Snapcast](https://github.com/badaix/snapcast) from Home Assistant. diff --git a/source/_integrations/snips.markdown b/source/_integrations/snips.markdown index 837ee40e53e..b401005a4fa 100644 --- a/source/_integrations/snips.markdown +++ b/source/_integrations/snips.markdown @@ -5,6 +5,7 @@ logo: snips.png ha_category: - Voice ha_release: 0.48 +ha_domain: snips ---
    diff --git a/source/_integrations/snmp.markdown b/source/_integrations/snmp.markdown index be68efffd4a..38dfbe74249 100644 --- a/source/_integrations/snmp.markdown +++ b/source/_integrations/snmp.markdown @@ -1,7 +1,6 @@ --- title: SNMP description: Instructions on how to integrate SNMP into Home Assistant. -logo: network-snmp.png ha_category: - Network - Switch @@ -9,6 +8,7 @@ ha_category: - Sensor ha_iot_class: Local Polling ha_release: 0.57 +ha_domain: snmp --- A lot of Wi-Fi access points and Wi-Fi routers support the Simple Network Management Protocol (SNMP). This is a standardized method for monitoring/manageing network connected devices. SNMP uses a tree-like hierarchy where each node is an object. Many of these objects contain (live) lists of instances and metrics, like network interfaces, disks and Wi-Fi registrations. diff --git a/source/_integrations/sochain.markdown b/source/_integrations/sochain.markdown index d007e06c2f6..ad8d84fdac6 100644 --- a/source/_integrations/sochain.markdown +++ b/source/_integrations/sochain.markdown @@ -6,6 +6,7 @@ ha_category: - Finance ha_release: 0.61 ha_iot_class: Cloud Polling +ha_domain: sochain --- The `SoChain` sensor platform displays supported cryptocurrency wallet balances from [SoChain](https://chain.so). diff --git a/source/_integrations/socialblade.markdown b/source/_integrations/socialblade.markdown index 676c9b1a2be..73cf67594c2 100644 --- a/source/_integrations/socialblade.markdown +++ b/source/_integrations/socialblade.markdown @@ -6,6 +6,7 @@ ha_category: - Multimedia ha_release: 0.69 ha_iot_class: Cloud Polling +ha_domain: socialblade --- The `socialblade` sensor platform allows you to monitor a YouTube channels subscriber count and total views count. The sensor retrieves data from the [Social Blade website](https://socialblade.com). diff --git a/source/_integrations/solaredge.markdown b/source/_integrations/solaredge.markdown index 65b4600da30..d1667ede6d1 100644 --- a/source/_integrations/solaredge.markdown +++ b/source/_integrations/solaredge.markdown @@ -7,6 +7,7 @@ ha_category: ha_release: 0.85 ha_iot_class: Cloud Polling ha_config_flow: true +ha_domain: solaredge --- The `solaredge` platform uses the [SolarEdge Monitoring API](https://www.solaredge.com/sites/default/files/se_monitoring_api.pdf) to allow you to get details from your SolarEdge solar power setup and integrate these in your Home Assistant installation. diff --git a/source/_integrations/solaredge_local.markdown b/source/_integrations/solaredge_local.markdown index 40aacdfa225..033ec8325ad 100644 --- a/source/_integrations/solaredge_local.markdown +++ b/source/_integrations/solaredge_local.markdown @@ -10,6 +10,7 @@ ha_iot_class: Local Polling ha_codeowners: - '@drobtravels' - '@scheric' +ha_domain: solaredge_local --- The `solaredge_local` platform uses the local API available on some SolarEdge Inverters to allow you to get details from your SolarEdge solar power setup and integrate these into your Home Assistant installation. diff --git a/source/_integrations/solarlog.markdown b/source/_integrations/solarlog.markdown index 7e6ea1a1176..7f824213d77 100644 --- a/source/_integrations/solarlog.markdown +++ b/source/_integrations/solarlog.markdown @@ -8,6 +8,7 @@ ha_iot_class: Local Polling ha_config_flow: true ha_codeowners: - '@Ernst79' +ha_domain: solarlog --- The `solarlog` integration uses the open JSON interface on [Solar-Log PV monitoring systems](https://www.solar-log.com/) to allow you to get details from your Solar-Log device and integrate these into your Home Assistant installation. diff --git a/source/_integrations/solax.markdown b/source/_integrations/solax.markdown index 349ffa98235..7ed262eecf1 100644 --- a/source/_integrations/solax.markdown +++ b/source/_integrations/solax.markdown @@ -1,7 +1,6 @@ --- title: SolaX Power description: Instructions on how to integrate Solax sensor within Home Assistant. -logo: solax-logo.png ha_category: - Energy - Sensor @@ -9,6 +8,7 @@ ha_release: 0.94 ha_iot_class: Local Polling ha_codeowners: - '@squishykid' +ha_domain: solax --- The `solax` integration connects Home Assistant to Solax solar power inverters. Solax inverters may be connected to a home Wi-Fi network and expose a REST API. This integration retrieves information such as photovoltaic power production, battery levels and power, and how much power is being fed back into the grid. diff --git a/source/_integrations/soma.markdown b/source/_integrations/soma.markdown index 74b060d1f89..79c119981f2 100644 --- a/source/_integrations/soma.markdown +++ b/source/_integrations/soma.markdown @@ -1,7 +1,6 @@ --- title: Soma Connect description: Instructions on how to set up the Soma Connect within Home Assistant. -logo: soma.png ha_category: - Cover ha_iot_class: Local Polling @@ -9,6 +8,7 @@ ha_config_flow: true ha_release: '0.100' ha_codeowners: - '@ratsept' +ha_domain: soma --- The Soma integration will allow users to integrate their Soma Smarthome devices into Home Assistant using the Soma Connect hub. diff --git a/source/_integrations/somfy.markdown b/source/_integrations/somfy.markdown index 7ccf01c1bb9..9ee44af9d3c 100644 --- a/source/_integrations/somfy.markdown +++ b/source/_integrations/somfy.markdown @@ -1,7 +1,6 @@ --- title: Somfy Open API description: Instructions on how to set up the Somfy hub within Home Assistant. -logo: somfy.png ha_category: - Hub ha_iot_class: Cloud Polling @@ -9,6 +8,7 @@ ha_release: 0.95 ha_config_flow: true ha_codeowners: - '@tetienne' +ha_domain: somfy --- The Somfy integration will allow users to integrate their Somfy devices into Home Assistant using the [official API](https://developer.somfy.com/somfy-open-api/apis), unlike the [Tahoma](/integrations/tahoma/) integration. @@ -18,7 +18,7 @@ The Somfy integration will allow users to integrate their Somfy devices into Hom Somfy is leveraging the new account linking service. This means that to set up Somfy, you only need to go to the integrations page and click on add new integration.
    - +
    ## Installation with own developer account @@ -58,8 +58,15 @@ client_secret: description: Your Somfy consumer secret. required: true type: string +optimistic: + description: Set optimistic mode. + required: false + default: false + type: boolean {% endconfiguration %} +**optimistic** mode should only be used when the integration is not able to gain information on whether a cover is open or closed (e.g., [RTS](https://www.somfysystems.com/en-us/discover-somfy/technology/radio-technology-somfy) devices). It will attempt to track the status within Home Assistant. This mode should only be used if Home Assistant is the only way you operate the blind. If you also use the physical remote control or the Somfy app, Home Assistant will become out of sync. + ### Potential duplicate with the Tahoma integration If you use the [Tahoma](/integrations/tahoma) integration, you will have to exclude the covers added by this one. Otherwise, they will be added twice. diff --git a/source/_integrations/somfy_mylink.markdown b/source/_integrations/somfy_mylink.markdown index 8efe11fcf24..586fa5d767c 100644 --- a/source/_integrations/somfy_mylink.markdown +++ b/source/_integrations/somfy_mylink.markdown @@ -7,6 +7,7 @@ ha_category: - Cover ha_release: 0.92 ha_iot_class: Assumed State +ha_domain: somfy_mylink --- The `Somfy MyLink` integration is used as an interface to a compatible Somfy MyLink hub utilizing the `Synergy` API. It allows the addition of covers from the Somfy MyLink platform to Home Assistant. diff --git a/source/_integrations/sonarr.markdown b/source/_integrations/sonarr.markdown index 2d0b63ad3b8..11ab929e026 100644 --- a/source/_integrations/sonarr.markdown +++ b/source/_integrations/sonarr.markdown @@ -1,11 +1,11 @@ --- title: Sonarr description: Instructions on how to integrate Sonarr sensors with Home Assistant -logo: sonarr.png ha_category: - Downloading ha_release: 0.34 ha_iot_class: Local Polling +ha_domain: sonarr --- This `sonarr` sensor platform pulls data from a given [Sonarr](https://sonarr.tv/) instance. diff --git a/source/_integrations/songpal.markdown b/source/_integrations/songpal.markdown index 6ec8ebc69a0..9cee6055350 100644 --- a/source/_integrations/songpal.markdown +++ b/source/_integrations/songpal.markdown @@ -8,6 +8,7 @@ ha_iot_class: Local Push ha_release: 0.65 ha_codeowners: - '@rytilahti' +ha_domain: songpal --- The `songpal` platform allows you to control Sony's Songpal ("[Audio Control API](https://developer.sony.com/develop/audio-control-api/)") compatible devices such as soundbars, AV receivers and wireless speakers from Home Assistant. @@ -19,7 +20,7 @@ If the platform works with your non-listed device, or you encounter bugs, please A few notes: - The quick start-up mode has to be enabled in order to turn the device on. -- Supports currently only one output terminal, i.e. the volume control works only on the first volume controller as reported by the backend library. +- Supports currently only one output terminal, i.e., the volume control works only on the first volume controller as reported by the backend library. - Some devices, e.g., HT-XT3, do not support decreasing the volume step-by-step correctly. - Feel free to improve the available services! diff --git a/source/_integrations/sonos.markdown b/source/_integrations/sonos.markdown index 3332613ac07..638f56c4566 100644 --- a/source/_integrations/sonos.markdown +++ b/source/_integrations/sonos.markdown @@ -8,6 +8,7 @@ featured: true ha_release: 0.7.3 ha_iot_class: Local Push ha_config_flow: true +ha_domain: sonos --- The `sonos` integration allows you to control your [Sonos](https://www.sonos.com) wireless speakers from Home Assistant. It also works with IKEA Symfonisk speakers. @@ -30,7 +31,7 @@ The queue is not snapshotted and must be left untouched until the restore. Using | Service data attribute | Optional | Description | | ---------------------- | -------- | ----------- | -| `entity_id` | yes | The speakers to snapshot. +| `entity_id` | no | The speakers to snapshot. To target all Sonos devices, use `all`. | `with_group` | yes | Should we also snapshot the group layout and the state of other speakers in the group, defaults to true. ### Service `sonos.restore` @@ -49,7 +50,7 @@ A cloud queue cannot be restarted. This includes queues started from within Spot | Service data attribute | Optional | Description | | ---------------------- | -------- | ----------- | -| `entity_id` | yes | String or list of `entity_id`s that should have their snapshot restored. +| `entity_id` | no | String or list of `entity_id`s that should have their snapshot restored. To target all Sonos devices, use `all`. | `with_group` | yes | Should we also restore the group layout and the state of other speakers in the group, defaults to true. ### Service `sonos.join` diff --git a/source/_integrations/sony_projector.markdown b/source/_integrations/sony_projector.markdown index 47cd3687945..9ca5efa21ba 100644 --- a/source/_integrations/sony_projector.markdown +++ b/source/_integrations/sony_projector.markdown @@ -6,6 +6,7 @@ ha_category: - Multimedia ha_iot_class: Local Polling ha_release: 0.89 +ha_domain: sony_projector --- The `sony_projector` switch platform allows you to control the state of SDCP compatible network-connected projectors from [Sony](https://www.sony.com/). diff --git a/source/_integrations/soundtouch.markdown b/source/_integrations/soundtouch.markdown index 62831cad630..b7c107c9cc6 100644 --- a/source/_integrations/soundtouch.markdown +++ b/source/_integrations/soundtouch.markdown @@ -6,6 +6,7 @@ ha_category: - Media Player ha_release: 0.34 ha_iot_class: Local Polling +ha_domain: soundtouch --- The `soundtouch` platform allows you to control your [Bose Soundtouch](https://www.soundtouch.com/) speakers from Home Assistant. diff --git a/source/_integrations/spaceapi.markdown b/source/_integrations/spaceapi.markdown index 58945e46fa8..72dc4e986ff 100644 --- a/source/_integrations/spaceapi.markdown +++ b/source/_integrations/spaceapi.markdown @@ -1,12 +1,12 @@ --- title: Space API description: Instructions on how to configure the SpaceAPI for Home Assistant. -logo: spaceapi.png ha_category: - Social ha_release: '0.70' ha_codeowners: - '@fabaff' +ha_domain: spaceapi --- The `spaceapi` integration allow Hackerspaces to expose information to web apps or any other application with the [SpaceAPI](http://spaceapi.net/). diff --git a/source/_integrations/spc.markdown b/source/_integrations/spc.markdown index 7f097eda38f..a9410db6b34 100644 --- a/source/_integrations/spc.markdown +++ b/source/_integrations/spc.markdown @@ -8,6 +8,7 @@ ha_category: ha_release: 0.47 logo: vanderbilt_spc.png ha_iot_class: Local Push +ha_domain: spc --- Home Assistant has support to integrate your [Vanderbilt SPC](https://www.spcsupportinfo.com/SPCConnectPro/) alarm panel and any connected motion, door, smoke and technical sensors. diff --git a/source/_integrations/speedtestdotnet.markdown b/source/_integrations/speedtestdotnet.markdown index 2832e271426..5480f99c02a 100644 --- a/source/_integrations/speedtestdotnet.markdown +++ b/source/_integrations/speedtestdotnet.markdown @@ -9,6 +9,7 @@ ha_release: 0.13 ha_iot_class: Cloud Polling ha_codeowners: - '@rohankapoorcom' +ha_domain: speedtestdotnet --- The `speedtestdotnet` integration uses the [Speedtest.net](https://speedtest.net/) web service to measure network bandwidth performance. diff --git a/source/_integrations/spider.markdown b/source/_integrations/spider.markdown index 19c9502dad9..0facc7c617d 100644 --- a/source/_integrations/spider.markdown +++ b/source/_integrations/spider.markdown @@ -1,7 +1,6 @@ --- title: Itho Daalderop Spider description: Instructions on how to setup the Spider hub within Home Assistant. -logo: spider.png ha_category: - Hub - Climate @@ -10,6 +9,7 @@ ha_iot_class: Cloud Polling ha_release: 0.75 ha_codeowners: - '@peternijssen' +ha_domain: spider --- The `spider` integration is the main integration to integrate all [Itho Daalderop Spider](https://www.ithodaalderop.nl/spider-thermostaat) related platforms. You will need your Spider account information (username, password) to discover and control devices which are related to your account. diff --git a/source/_integrations/splunk.markdown b/source/_integrations/splunk.markdown index 4c4ddd11b8c..eefe69f2344 100644 --- a/source/_integrations/splunk.markdown +++ b/source/_integrations/splunk.markdown @@ -5,6 +5,7 @@ logo: splunk.png ha_category: - History ha_release: 0.13 +ha_domain: splunk --- The `splunk` integration makes it possible to log all state changes to an external [Splunk](https://splunk.com/) database using Splunk's HTTP Event Collector (HEC) feature. You can either use this alone, or with the Home Assistant for Splunk [app](https://github.com/miniconfig/splunk-homeassistant). Since the HEC feature is new to Splunk, you will need to use at least version 6.3. diff --git a/source/_integrations/spotcrime.markdown b/source/_integrations/spotcrime.markdown index 6512f2efdf6..1d3734f60a4 100644 --- a/source/_integrations/spotcrime.markdown +++ b/source/_integrations/spotcrime.markdown @@ -3,6 +3,7 @@ title: Spot Crime description: Instructions on how to integrate spotcrime.com into Home Assistant. ha_release: 0.65 ha_iot_class: Cloud Polling +ha_domain: spotcrime ---
    diff --git a/source/_integrations/spotify.markdown b/source/_integrations/spotify.markdown index f26af0627ee..75678b97aeb 100644 --- a/source/_integrations/spotify.markdown +++ b/source/_integrations/spotify.markdown @@ -1,7 +1,6 @@ --- title: Spotify description: Instructions on how to integrate Spotify into Home Assistant. -logo: spotify.png ha_category: - Media Player ha_release: 0.43 @@ -10,6 +9,7 @@ ha_config_flow: true ha_quality_scale: silver ha_codeowners: - '@frenck' +ha_domain: spotify --- The `spotify` media player integration allows you to control [Spotify](https://www.spotify.com/) playback from Home Assistant. diff --git a/source/_integrations/sql.markdown b/source/_integrations/sql.markdown index 09ecabb4a61..c7d5dbcd5b5 100644 --- a/source/_integrations/sql.markdown +++ b/source/_integrations/sql.markdown @@ -1,12 +1,12 @@ --- title: SQL description: Instructions how to integrate SQL sensors into Home Assistant. -logo: sql.png ha_category: - Utility ha_release: 0.63 ha_codeowners: - '@dgomes' +ha_domain: sql --- The `sql` sensor platform enables you to use values from an [SQL](https://en.wikipedia.org/wiki/SQL) database supported by the [sqlalchemy](https://www.sqlalchemy.org) library, to populate a sensor state (and attributes). diff --git a/source/_integrations/squeezebox.markdown b/source/_integrations/squeezebox.markdown index c47723a0615..76ef3d514a7 100644 --- a/source/_integrations/squeezebox.markdown +++ b/source/_integrations/squeezebox.markdown @@ -6,6 +6,7 @@ ha_category: - Media Player ha_release: pre 0.7 ha_iot_class: Local Polling +ha_domain: squeezebox --- The `squeezebox` platform allows you to control a [Logitech Squeezebox](https://en.wikipedia.org/wiki/Squeezebox_%28network_music_player%29) music player from Home Assistant. This lets you control Squeezebox hardware like the Classic, Transporter, Duet, Boom, Radio and Touch and of software players like [SoftSqueeze](http://softsqueeze.sourceforge.net/), [SqueezePlayer](https://play.google.com/store/apps/details?id=de.bluegaspode.squeezeplayer) and [SqueezeSlave](https://forums.slimdevices.com/showthread.php?93607-ANNOUNCE-Squeezeslave-1-2-released). diff --git a/source/_integrations/ssdp.markdown b/source/_integrations/ssdp.markdown index 67c5f6b53b2..7bdf9839852 100644 --- a/source/_integrations/ssdp.markdown +++ b/source/_integrations/ssdp.markdown @@ -4,10 +4,10 @@ description: Discover integrations on the network using the SSDP protocol. ha_category: - Network ha_release: 0.94 -logo: home-assistant.png +ha_domain: ssdp --- -The `ssdp` "Simple Service Discovery Protocol" integration will scan the network for supported devices and services. Discovered integrations will show up in the discovered section on the integrations page in the configuration panel. +The `ssdp` "Simple Service Discovery Protocol" (part of UPnP) integration will scan the network for supported devices and services. Discovered integrations will show up in the discovered section on the integrations page in the configuration panel. Integrations can opt-in to be found by adding [an SSDP section](https://developers.home-assistant.io/docs/en/next/creating_integration_manifest.html#ssdp) to their `manifest.json`. diff --git a/source/_integrations/starline.markdown b/source/_integrations/starline.markdown index e9d3037865a..93ebd7e3e37 100644 --- a/source/_integrations/starline.markdown +++ b/source/_integrations/starline.markdown @@ -1,7 +1,6 @@ --- title: StarLine description: Instructions on how to setup your StarLine account with Home Assistant. -logo: starline.png ha_category: - Car - Binary Sensor @@ -14,6 +13,7 @@ ha_iot_class: Cloud Polling ha_config_flow: true ha_codeowners: - '@anonym-tsk' +ha_domain: starline --- The `starline` integration lets you retrieve data of your StarLine security system from the StarLine portal. You will need a working StarLine account. diff --git a/source/_integrations/starlingbank.markdown b/source/_integrations/starlingbank.markdown index dbc503b2b46..440fccb3508 100644 --- a/source/_integrations/starlingbank.markdown +++ b/source/_integrations/starlingbank.markdown @@ -1,11 +1,11 @@ --- title: Starling Bank description: How to integrate your Starling Bank account within Home Assistant. -logo: starlingbank.png ha_category: - Finance ha_release: 0.79 ha_iot_class: Cloud Polling +ha_domain: starlingbank --- The Starling Bank sensor platform allows you to monitor your account balance data as sensors in Home Assistant. diff --git a/source/_integrations/startca.markdown b/source/_integrations/startca.markdown index 86070175189..0f7f77437f0 100644 --- a/source/_integrations/startca.markdown +++ b/source/_integrations/startca.markdown @@ -6,6 +6,7 @@ ha_category: - Network ha_release: 0.64 ha_iot_class: Cloud Polling +ha_domain: startca --- Integrate your [Start.ca](https://www.start.ca/) account information into Home Assistant. diff --git a/source/_integrations/statistics.markdown b/source/_integrations/statistics.markdown index 5db21438799..cc64dc68dbd 100644 --- a/source/_integrations/statistics.markdown +++ b/source/_integrations/statistics.markdown @@ -1,7 +1,6 @@ --- title: Statistics description: Instructions on how to integrate statistical sensors into Home Assistant. -logo: home-assistant.png ha_category: - Utility ha_iot_class: Local Polling @@ -9,6 +8,7 @@ ha_release: '0.30' ha_quality_scale: internal ha_codeowners: - '@fabaff' +ha_domain: statistics --- The `statistics` sensor platform consumes the state from other sensors. It exports the `mean` value as state and the following values as attributes: `count`, `mean`, `median`, `stdev`, `variance`, `total`, `min_value`, `max_value`, `min_age`, `max_age`, `change`, `average_change` and `change_rate`. If it's a binary sensor then only state changes are counted. diff --git a/source/_integrations/statsd.markdown b/source/_integrations/statsd.markdown index f5e1e658f20..0082e2033b4 100644 --- a/source/_integrations/statsd.markdown +++ b/source/_integrations/statsd.markdown @@ -1,10 +1,10 @@ --- title: StatsD description: Record events in StatsD. -logo: statsd.png ha_category: - History ha_release: 0.12 +ha_domain: statsd --- The `statsd` integration makes it possible to transfer all state changes to an external [StatsD](https://github.com/etsy/statsd) instance. diff --git a/source/_integrations/steam_online.markdown b/source/_integrations/steam_online.markdown index 96f19308b87..c51ca7a3263 100644 --- a/source/_integrations/steam_online.markdown +++ b/source/_integrations/steam_online.markdown @@ -1,11 +1,11 @@ --- title: Steam description: Instructions on how to set up Steam sensors in Home Assistant. -logo: steam.png ha_category: - Social ha_iot_class: Cloud Polling ha_release: 0.14 +ha_domain: steam_online --- The `steam` sensor platform will allow you to track the online status of public [Steam](https://steamcommunity.com) accounts. diff --git a/source/_integrations/stiebel_eltron.markdown b/source/_integrations/stiebel_eltron.markdown index e8113c27878..d5453b75c95 100644 --- a/source/_integrations/stiebel_eltron.markdown +++ b/source/_integrations/stiebel_eltron.markdown @@ -8,6 +8,7 @@ ha_release: 0.92 ha_iot_class: Local Polling ha_codeowners: - '@fucm' +ha_domain: stiebel_eltron --- The `stiebel_eltron` integration lets you control integral ventilation or heat pump units of [STIEBEL ELTRON](https://www.stiebel-eltron.com). diff --git a/source/_integrations/stookalert.markdown b/source/_integrations/stookalert.markdown index abdba5f4de7..49993895eab 100644 --- a/source/_integrations/stookalert.markdown +++ b/source/_integrations/stookalert.markdown @@ -1,7 +1,6 @@ --- title: RIVM Stookalert description: Instructions on how to use Stookalert data within Home Assistant -logo: stookalert.png ha_category: - Binary Sensor - Environment @@ -9,6 +8,7 @@ ha_release: 0.104 ha_iot_class: Cloud Polling ha_codeowners: - '@fwestenberg' +ha_domain: stookalert --- The `stookalert` sensor platform queries the [RIVM Stookalert](https://www.rivm.nl/stookalert) API for unfavorable weather conditions or poor air quality. With a Stookalert, the RIVM calls on people not to burn wood. This can prevent health problems in people in the area. diff --git a/source/_integrations/stream.markdown b/source/_integrations/stream.markdown index 1331b7d170b..42f34c02134 100644 --- a/source/_integrations/stream.markdown +++ b/source/_integrations/stream.markdown @@ -1,7 +1,6 @@ --- title: Stream description: Instructions on how to integrate live streams within Home Assistant. -logo: home-assistant.png ha_category: - Other ha_release: '0.90' @@ -9,6 +8,7 @@ ha_iot_class: Local Push ha_quality_scale: internal ha_codeowners: - '@hunterjm' +ha_domain: stream --- The `stream` integration provides a way to proxy live streams through Home Assistant. The integration currently only supports proxying H.264 source streams to the HLS format and requires at least FFmpeg >= 3.2. diff --git a/source/_integrations/streamlabswater.markdown b/source/_integrations/streamlabswater.markdown index 9f7f1263500..382a06c6eab 100644 --- a/source/_integrations/streamlabswater.markdown +++ b/source/_integrations/streamlabswater.markdown @@ -1,12 +1,12 @@ --- title: StreamLabs description: Instructions on how to integrate Streamlabs Water devices with Home Assistant. -logo: streamlabswater.png ha_category: - Binary Sensor - Sensor ha_release: '0.95' ha_iot_class: Cloud Polling +ha_domain: streamlabswater --- The `Streamlabs Water` integration platform is used to interact with [StreamLabs water monitoring devices](https://www.streamlabswater.com/) in order to retrieve usage information and manage the away mode of the device. The [StreamLabs Water API](https://developer.streamlabswater.com) is used to retrieve daily, monthly, and yearly water usage along with the current away mode. diff --git a/source/_integrations/stt.markdown b/source/_integrations/stt.markdown index 277f22afdc2..c86e859ad20 100644 --- a/source/_integrations/stt.markdown +++ b/source/_integrations/stt.markdown @@ -4,6 +4,7 @@ description: Instructions on how to set up Speech-to-Text (STT) with Home Assist ha_release: '0.102' ha_codeowners: - '@pvizeli' +ha_domain: stt --- Speech-to-Text (STT) allows you to stream speech data to the STT API and get text back. diff --git a/source/_integrations/suez_water.markdown b/source/_integrations/suez_water.markdown index dd49bd37d8f..4373b097a57 100644 --- a/source/_integrations/suez_water.markdown +++ b/source/_integrations/suez_water.markdown @@ -1,13 +1,13 @@ --- title: Suez Water description: Instructions on how to integrate Suez Water daily data within Home Assistant. -logo: suez.png ha_release: 0.97 ha_category: - Sensor ha_iot_class: Cloud Polling ha_codeowners: - '@ooii' +ha_domain: suez_water --- The `suez_water` sensor platform fetches your last day consumption of water from the French water provider [Tout Sur Mon Eau](https://www.toutsurmoneau.fr) website. diff --git a/source/_integrations/sun.markdown b/source/_integrations/sun.markdown index 19a7165cffe..56d34e62b23 100644 --- a/source/_integrations/sun.markdown +++ b/source/_integrations/sun.markdown @@ -1,13 +1,13 @@ --- title: Sun description: Instructions on how to track the sun within Home Assistant. -logo: home-assistant.png ha_category: - Environment ha_release: pre 0.7 ha_quality_scale: internal ha_codeowners: - '@Swamp-Ig' +ha_domain: sun --- The sun integration will use your current location to track if the sun is above or diff --git a/source/_integrations/supervisord.markdown b/source/_integrations/supervisord.markdown index 143a831e232..d304456b01f 100644 --- a/source/_integrations/supervisord.markdown +++ b/source/_integrations/supervisord.markdown @@ -6,6 +6,7 @@ ha_category: - System Monitor ha_release: '0.20' ha_iot_class: Local Polling +ha_domain: supervisord --- The `supervisord` platform allows you to track the states of [Supervisord](http://supervisord.org/). diff --git a/source/_integrations/supla.markdown b/source/_integrations/supla.markdown index 1ca79a2ce0b..37bfe54d127 100644 --- a/source/_integrations/supla.markdown +++ b/source/_integrations/supla.markdown @@ -1,7 +1,6 @@ --- title: Supla description: Instructions for integration with Supla Cloud's Web API -logo: supla.png ha_release: 0.92 ha_category: - Hub @@ -9,13 +8,15 @@ ha_category: ha_iot_class: Cloud Polling ha_codeowners: - '@mwegrzynek' +ha_domain: supla --- -The [Supla](https://supla.org/) is an Open Source home automation system for ESP8266 based devices. It has its own set of protocols, it's own firmware and commercially available devices (produced for example by [Zamel](https://supla.zamel.pl/)) +The [Supla](https://supla.org/) is an Open Source home automation system for ESP8266 based devices. It has its own set of protocols, its own firmware and commercially available devices (produced for example by [Zamel](https://supla.zamel.pl/)) -Currently only covers (shutters in Supla's lingo) and switches are supported, but, thanks to comprehensive and universal REST API, it's pretty easy to add more. +Currently only covers (shutters in Supla's lingo), gates and switches are supported, but, thanks to comprehensive and universal REST API, it's pretty easy to add more. -Right now it's impossible to add single devices -- all of them are discovered from Supla Cloud's servers or yours. +Right now it's impossible to add a device -- all of them are discovered from Supla Cloud's servers or yours. +Devices disabled on Supla Cloud will not be loaded into Home Assistant. ## Configuration diff --git a/source/_integrations/surepetcare.markdown b/source/_integrations/surepetcare.markdown index af8beb7d840..f97a07445d3 100644 --- a/source/_integrations/surepetcare.markdown +++ b/source/_integrations/surepetcare.markdown @@ -1,7 +1,6 @@ --- title: Sure Petcare description: Instructions on how to integrate the Sure Petcare cat and pet flaps into Home Assistant. -logo: sure_petcare.png ha_category: - Binary Sensor - Sensor @@ -9,13 +8,14 @@ ha_release: 0.104 ha_iot_class: Cloud Polling ha_codeowners: - '@benleb' +ha_domain: surepetcare --- The `surepetcare` component allows you to get information on your Sure Petcare Connect Pet or Cat Flap. ## Configuration -To add a flap and pet, add the following to your `configuration.yaml` file: +To add a flap, feeder or pet, add the following to your `configuration.yaml` file. The Hubs a flap or feeder is connected to, will be discovered automatically. ```yaml # Example configuration.yaml entry @@ -37,59 +37,22 @@ surepetcare: required: true type: string flaps: - description: The Sure Petcare flaps - required: true - type: map - keys: - id: - description: The Sure Petcare id of a flap - required: true - type: integer - name: - description: A name for the flap - required: true - type: string - feeders: - description: The Sure Petcare flaps - required: true - type: map - keys: - id: - description: The Sure Petcare id of a flap - required: true - type: integer - name: - description: A name for the flap - required: true - type: string - pets: - description: Pets managed by Sure Petcare flap(s) - required: true - type: map - keys: - id: - description: The Sure Petcare id of a pet - required: true - type: integer - name: - description: The name of the pet - required: true - type: string - icon: - description: "Icon to display (e.g., `mdi:cat`)" + description: The IDs of the Sure Petcare flaps required: false - default: "mdi:cat" - type: string + type: list + feeders: + description: The IDs of the Sure Petcare feeders + required: false + type: list + pets: + description: The Sure Petcare IDs of the Pets to show + required: false + type: list scan_interval: description: "Minimum time interval between updates. Supported formats: `scan_interval: 'HH:MM:SS'`, `scan_interval: 'HH:MM'` and Time period dictionary (see example below)." required: false default: 3 minutes type: time - device_class: - description: The type/class of the sensor to set the icon in the frontend. - required: false - default: lock - type: device_class {% endconfiguration %} ## Getting the IDs of your flaps, feeders and pets diff --git a/source/_integrations/swiss_hydrological_data.markdown b/source/_integrations/swiss_hydrological_data.markdown index ddbbefd241a..e9c0b083f36 100644 --- a/source/_integrations/swiss_hydrological_data.markdown +++ b/source/_integrations/swiss_hydrological_data.markdown @@ -1,13 +1,13 @@ --- title: Swiss Hydrological Data description: Instructions on how to integrate hydrological data of Swiss waters within Home Assistant. -logo: swiss-hydrological-data.png ha_category: - Environment ha_iot_class: Cloud Polling ha_release: 0.22 ha_codeowners: - '@fabaff' +ha_domain: swiss_hydrological_data --- The `swiss_hydrological_data` sensor will show you details (temperature, level, and discharge) of rivers and lakes in Switzerland. diff --git a/source/_integrations/swiss_public_transport.markdown b/source/_integrations/swiss_public_transport.markdown index d98ce930e2b..6b28d4ab153 100644 --- a/source/_integrations/swiss_public_transport.markdown +++ b/source/_integrations/swiss_public_transport.markdown @@ -1,13 +1,13 @@ --- title: Swiss public transport description: Instructions on how to integrate timetable data for traveling in Switzerland within Home Assistant. -logo: train.png ha_category: - Transport ha_iot_class: Cloud Polling ha_release: pre 0.7 ha_codeowners: - '@fabaff' +ha_domain: swiss_public_transport --- The `swiss_public_transport` sensor will give you the next three departure times from a given location to another one in Switzerland. diff --git a/source/_integrations/swisscom.markdown b/source/_integrations/swisscom.markdown index cde48414aa1..82a35ee8836 100644 --- a/source/_integrations/swisscom.markdown +++ b/source/_integrations/swisscom.markdown @@ -5,6 +5,7 @@ logo: swisscom.png ha_category: - Presence Detection ha_release: 0.32 +ha_domain: swisscom --- The `swisscom` platform offers presence detection by looking at connected devices to an [Internet-Box](https://www.swisscom.ch/en/residential/help/device/internet-router.html) router from [Swisscom](https://www.swisscom.ch) which is an Internet provider in Switzerland. diff --git a/source/_integrations/switch.command_line.markdown b/source/_integrations/switch.command_line.markdown index ad9a637b6a4..16551f82d0f 100644 --- a/source/_integrations/switch.command_line.markdown +++ b/source/_integrations/switch.command_line.markdown @@ -1,11 +1,11 @@ --- title: "Command line Switch" description: "Instructions on how to have switches call command line commands." -logo: command_line.png ha_category: - Switch ha_release: pre 0.7 ha_iot_class: Local Polling +ha_domain: command_line --- The `command_line` switch platform issues specific commands when it is turned on diff --git a/source/_integrations/switch.knx.markdown b/source/_integrations/switch.knx.markdown index 3a26d28dc8d..ce529244208 100644 --- a/source/_integrations/switch.knx.markdown +++ b/source/_integrations/switch.knx.markdown @@ -1,11 +1,11 @@ --- title: "KNX Switch" description: "Instructions on how to integrate KNX switches with Home Assistant." -logo: knx.png ha_category: - Switch ha_release: 0.24 ha_iot_class: Local Push +ha_domain: knx ---
    diff --git a/source/_integrations/switch.markdown b/source/_integrations/switch.markdown index 778934ddbdd..46b5bae9f4d 100644 --- a/source/_integrations/switch.markdown +++ b/source/_integrations/switch.markdown @@ -1,11 +1,11 @@ --- title: Switch description: Instructions on how to set up your switches with Home Assistant. -logo: home-assistant.png ha_category: - Switch ha_release: 0.7 ha_quality_scale: internal +ha_domain: switch --- Keeps track which switches are in your environment, their state and allows you to control them. diff --git a/source/_integrations/switch.modbus.markdown b/source/_integrations/switch.modbus.markdown index 6d4a64fed20..067148d940a 100644 --- a/source/_integrations/switch.modbus.markdown +++ b/source/_integrations/switch.modbus.markdown @@ -1,11 +1,11 @@ --- title: "Modbus Switch" description: "Instructions on how to integrate Modbus switches into Home Assistant." -logo: modbus.png ha_category: - Switch ha_release: pre 0.7 ha_iot_class: Local Push +ha_domain: modbus --- The `modbus` switch platform allows you to control [Modbus](http://www.modbus.org/) coils or registers. diff --git a/source/_integrations/switch.mqtt.markdown b/source/_integrations/switch.mqtt.markdown index 001b70f7d3f..4f4016de406 100644 --- a/source/_integrations/switch.mqtt.markdown +++ b/source/_integrations/switch.mqtt.markdown @@ -1,11 +1,11 @@ --- title: "MQTT Switch" description: "Instructions on how to integrate MQTT switches into Home Assistant." -logo: mqtt.png ha_category: - Switch ha_release: 0.7 ha_iot_class: Configurable +ha_domain: mqtt --- The `mqtt` switch platform lets you control your MQTT enabled switches. @@ -28,97 +28,27 @@ switch: ``` {% configuration %} -command_topic: - description: The MQTT topic to publish commands to change the switch state. - required: false - type: string -name: - description: The name to use when displaying this switch. - required: false - type: string - default: MQTT Switch -icon: - description: Icon for the switch. - required: false - type: icon -state_topic: - description: The MQTT topic subscribed to receive state updates. - required: false - type: string -state_on: - description: The payload that represents the on state. - required: false - type: string - default: "`payload_on` if defined, else ON" -state_off: - description: The payload that represents the off state. - required: false - type: string - default: "`payload_off` if defined, else OFF" availability_topic: description: The MQTT topic subscribed to receive availability (online/offline) updates. required: false type: string -payload_on: - description: The payload that represents enabled state. +command_topic: + description: The MQTT topic to publish commands to change the switch state. required: false type: string - default: "ON" -payload_off: - description: The payload that represents disabled state. - required: false - type: string - default: "OFF" -payload_available: - description: The payload that represents the available state. - required: false - type: string - default: online -payload_not_available: - description: The payload that represents the unavailable state. - required: false - type: string - default: offline -optimistic: - description: Flag that defines if switch works in optimistic mode. - required: false - type: boolean - default: "`true` if no `state_topic` defined, else `false`." -qos: - description: The maximum QoS level of the state topic. Default is 0 and will also be used to publishing messages. - required: false - type: integer - default: 0 -retain: - description: If the published message should have the retain flag on or not. - required: false - type: boolean - default: false -value_template: - description: "Defines a [template](/docs/configuration/templating/#processing-incoming-data) to extract a value from the payload." - required: false - type: string -json_attributes_topic: - description: The MQTT topic subscribed to receive a JSON dictionary payload and then set as sensor attributes. Usage example can be found in [MQTT sensor](/integrations/sensor.mqtt/#json-attributes-topic-configuration) documentation. - required: false - type: string -json_attributes_template: - description: "Defines a [template](/docs/configuration/templating/#processing-incoming-data) to extract the JSON dictionary from messages received on the `json_attributes_topic`. Usage example can be found in [MQTT sensor](/integrations/sensor.mqtt/#json-attributes-template-configuration) documentation." - required: false - type: template device: description: "Information about the device this switch is a part of to tie it into the [device registry](https://developers.home-assistant.io/docs/en/device_registry_index.html). Only works through [MQTT discovery](/docs/mqtt/discovery/) and when [`unique_id`](#unique_id) is set." required: false type: map keys: - identifiers: - description: A list of IDs that uniquely identify the device. For example a serial number. - required: false - type: [string, list] connections: description: 'A list of connections of the device to the outside world as a list of tuples `[connection_type, connection_identifier]`. For example the MAC address of a network interface: `"connections": [["mac", "02:5b:26:a8:dc:12"]]`.' required: false type: list + identifiers: + description: A list of IDs that uniquely identify the device. For example a serial number. + required: false + type: [string, list] manufacturer: description: The manufacturer of the device. required: false @@ -135,6 +65,76 @@ device: description: The firmware version of the device. required: false type: string +icon: + description: Icon for the switch. + required: false + type: icon +json_attributes_template: + description: "Defines a [template](/docs/configuration/templating/#processing-incoming-data) to extract the JSON dictionary from messages received on the `json_attributes_topic`. Usage example can be found in [MQTT sensor](/integrations/sensor.mqtt/#json-attributes-template-configuration) documentation." + required: false + type: template +json_attributes_topic: + description: The MQTT topic subscribed to receive a JSON dictionary payload and then set as sensor attributes. Usage example can be found in [MQTT sensor](/integrations/sensor.mqtt/#json-attributes-topic-configuration) documentation. + required: false + type: string +name: + description: The name to use when displaying this switch. + required: false + type: string + default: MQTT Switch +optimistic: + description: Flag that defines if switch works in optimistic mode. + required: false + type: boolean + default: "`true` if no `state_topic` defined, else `false`." +payload_available: + description: The payload that represents the available state. + required: false + type: string + default: online +payload_not_available: + description: The payload that represents the unavailable state. + required: false + type: string + default: offline +payload_off: + description: The payload that represents `off` state. If specified, will be used for both comparing to the value in the `state_topic` (see `value_template` and `state_off` for details) and sending as `off` command to the `command_topic`. + required: false + type: string + default: "OFF" +payload_on: + description: The payload that represents `on` state. If specified, will be used for both comparing to the value in the `state_topic` (see `value_template` and `state_on` for details) and sending as `on` command to the `command_topic`. + required: false + type: string + default: "ON" +qos: + description: The maximum QoS level of the state topic. Default is 0 and will also be used to publishing messages. + required: false + type: integer + default: 0 +retain: + description: If the published message should have the retain flag on or not. + required: false + type: boolean + default: false +state_off: + description: The payload that represents the `off` state. Used when value that represents `off` state in the `state_topic` is different from value that should be sent to the `command_topic` to turn the device `off`. + required: false + type: string + default: "`payload_off` if defined, else OFF" +state_on: + description: The payload that represents the `on` state. Used when value that represents `on` state in the `state_topic` is different from value that should be sent to the `command_topic` to turn the device `on`. + required: false + type: string + default: "`payload_on` if defined, else ON" +state_topic: + description: The MQTT topic subscribed to receive state updates. + required: false + type: string +value_template: + description: "Defines a [template](/docs/configuration/templating/#processing-incoming-data) to extract device's state from the `state_topic`. To determine the switches's state result of this template will be compared to `state_on` and `state_off`." + required: false + type: string {% endconfiguration %}
    diff --git a/source/_integrations/switch.mysensors.markdown b/source/_integrations/switch.mysensors.markdown index 362adb0a4c9..4c6240447b4 100644 --- a/source/_integrations/switch.mysensors.markdown +++ b/source/_integrations/switch.mysensors.markdown @@ -1,12 +1,12 @@ --- title: "MySensors Switch" description: "Instructions on how to integrate MySensors switches into Home Assistant." -logo: mysensors.png ha_category: - DIY - Switch ha_iot_class: Local Push ha_release: 0.11 +ha_domain: mysensors --- Integrates MySensors switches into Home Assistant. See the [main integration](/integrations/mysensors/) for configuration instructions. diff --git a/source/_integrations/switch.rest.markdown b/source/_integrations/switch.rest.markdown index 2fec6559fbb..e26b90a2a38 100644 --- a/source/_integrations/switch.rest.markdown +++ b/source/_integrations/switch.rest.markdown @@ -1,11 +1,11 @@ --- title: "RESTful Switch" description: "Instructions on how to integrate REST switches into Home Assistant." -logo: restful.png ha_category: - Switch ha_release: 0.7.6 ha_iot_class: Local Polling +ha_domain: rest --- The `rest` switch platform allows you to control a given endpoint that supports a [RESTful API](https://en.wikipedia.org/wiki/Representational_state_transfer). The switch can get the state via GET and set the state via POST on a given REST resource. diff --git a/source/_integrations/switch.rflink.markdown b/source/_integrations/switch.rflink.markdown index cc46fb0915c..635759a4536 100644 --- a/source/_integrations/switch.rflink.markdown +++ b/source/_integrations/switch.rflink.markdown @@ -5,6 +5,7 @@ logo: rflink.png ha_category: - Switch ha_release: 0.38 +ha_domain: rflink --- The `rflink` integration supports devices that use [RFLink gateway firmware](http://www.nemcon.nl/blog2/), for example, the [Nodo RFLink Gateway](https://www.nodo-shop.nl/nl/21-rflink-gateway). RFLink gateway is an Arduino firmware that allows two-way communication with a multitude of RF wireless devices using cheap hardware (Arduino + transceiver). diff --git a/source/_integrations/switch.rfxtrx.markdown b/source/_integrations/switch.rfxtrx.markdown index f61d08f1373..3f9e35fba82 100644 --- a/source/_integrations/switch.rfxtrx.markdown +++ b/source/_integrations/switch.rfxtrx.markdown @@ -1,10 +1,10 @@ --- title: "RFXtrx Switch" description: "Instructions on how to integrate RFXtrx switches into Home Assistant." -logo: rfxtrx.png ha_category: - Switch ha_release: 0.7.5 +ha_domain: rfxtrx --- The `rfxtrx` platform support switches that communicate in the frequency range of 433.92 MHz. @@ -90,7 +90,7 @@ If you need to generate codes for switches you can use a template (useful for ex - Use this code to add a new switch in your `configuration.yaml` - Launch your Home Assistant and go to the website. -- Enable learning mode on your switch (i.e. push learn button or plug it in a wall socket) +- Enable learning mode on your switch (i.e., push learn button or plug it in a wall socket) - Toggle your new switch in the Home Assistant interface ## Examples diff --git a/source/_integrations/switch.template.markdown b/source/_integrations/switch.template.markdown index 86b42952907..3901272e8bf 100644 --- a/source/_integrations/switch.template.markdown +++ b/source/_integrations/switch.template.markdown @@ -5,8 +5,8 @@ ha_category: - Switch ha_release: 0.13 ha_iot_class: Local Push -logo: home-assistant.png ha_quality_scale: internal +ha_domain: template --- The `template` platform creates switches that combines components. diff --git a/source/_integrations/switch.xiaomi_aqara.markdown b/source/_integrations/switch.xiaomi_aqara.markdown index f6016df9043..06789827df8 100644 --- a/source/_integrations/switch.xiaomi_aqara.markdown +++ b/source/_integrations/switch.xiaomi_aqara.markdown @@ -1,11 +1,11 @@ --- title: "Xiaomi Switch" description: "Instructions on how to set up the Xiaomi switch within Home Assistant." -logo: xiaomi.png ha_category: - Switch ha_release: "0.50" ha_iot_class: Local Push +ha_domain: xiaomi_aqara --- The `xiaomi_aqara` switch platform allows you to get data from your [Xiaomi aqara](https://www.mi.com/en/) switches. diff --git a/source/_integrations/switch.xiaomi_miio.markdown b/source/_integrations/switch.xiaomi_miio.markdown index ac8bd31df4c..62d6f10d974 100644 --- a/source/_integrations/switch.xiaomi_miio.markdown +++ b/source/_integrations/switch.xiaomi_miio.markdown @@ -1,11 +1,11 @@ --- title: "Xiaomi Smart WiFi Socket and Smart Power Strip" description: "Instructions on how to integrate your Xiaomi Smart WiFi Socket aka Plug or Xiaomi Smart Power Strip within Home Assistant." -logo: xiaomi.png ha_category: - Switch ha_iot_class: Local Polling ha_release: 0.56 +ha_domain: xiaomi_miio --- The `xiaomi_miio` switch platform allows you to control the state of your Xiaomi Smart WiFi Socket aka Plug, Xiaomi Smart Power Strip and Xiaomi Chuangmi Plug V1. diff --git a/source/_integrations/switchbot.markdown b/source/_integrations/switchbot.markdown index 053ad161f71..7952a9e7015 100644 --- a/source/_integrations/switchbot.markdown +++ b/source/_integrations/switchbot.markdown @@ -1,13 +1,13 @@ --- title: SwitchBot description: Instructions on how to set up Switchbot switches. -logo: switchbot.png ha_category: - Switch ha_release: 0.78 ha_iot_class: Local Polling ha_codeowners: - '@danielhiversen' +ha_domain: switchbot --- The `switchbot` switch platform allows you to control SwitchBot [devices](https://www.switch-bot.com/). diff --git a/source/_integrations/switcher_kis.markdown b/source/_integrations/switcher_kis.markdown index 57af9f7ec7f..191f50eb0bd 100644 --- a/source/_integrations/switcher_kis.markdown +++ b/source/_integrations/switcher_kis.markdown @@ -1,13 +1,13 @@ --- title: Switcher description: Controlling your Switcher V2 Water Heater. -logo: switcher_boiler.png ha_category: - Switch ha_release: 0.93 ha_iot_class: Local Push ha_codeowners: - '@tomerfi' +ha_domain: switcher_kis --- This `Switcher` integration allows you to control the [Switcher V2 Water Heater](https://www.switcher.co.il/). @@ -24,12 +24,6 @@ To retrieve your device's details, please follow the instructions [here](https:/ Please note, for the Switcher-V2-Python script to run successfully, you need to configure your device to work locally.
    -
    - - Please note, on the original script repository, users recently reported difficulties controlling the device after upgrading the firmware to the new 3.0 version.As this integration is based on that script, please do not upgrade to version 3.0 until this issue is resolved. You can follow the issue [here](https://github.com/NightRang3r/Switcher-V2-Python/issues/3). - -
    - ```yaml switcher_kis: phone_id: 'REPLACE_WITH_PHONE_ID' diff --git a/source/_integrations/switchmate.markdown b/source/_integrations/switchmate.markdown index cdbe3d98aff..4030da9efa3 100644 --- a/source/_integrations/switchmate.markdown +++ b/source/_integrations/switchmate.markdown @@ -1,13 +1,13 @@ --- title: Switchmate SimplySmart Home description: Instructions on how to set up Switchmate switches. -logo: switchmate-logo-rgb.png ha_category: - Switch ha_release: 0.78 ha_iot_class: Local Polling ha_codeowners: - '@danielhiversen' +ha_domain: switchmate --- This `Switchmate` switch platform allows you to control Switchmate [devices]( https://www.mysimplysmarthome.com/products/switchmate-switches/). diff --git a/source/_integrations/syncthru.markdown b/source/_integrations/syncthru.markdown index ac76359d81a..8ed1ffab0da 100644 --- a/source/_integrations/syncthru.markdown +++ b/source/_integrations/syncthru.markdown @@ -8,6 +8,7 @@ ha_iot_class: Local Polling ha_release: 0.66 ha_codeowners: - '@nielstron' +ha_domain: syncthru --- The Samsung SyncThru Printer platform allows you to read current data from your local Samsung printer. diff --git a/source/_integrations/synology.markdown b/source/_integrations/synology.markdown index 5a702d775b7..916695f0a0d 100644 --- a/source/_integrations/synology.markdown +++ b/source/_integrations/synology.markdown @@ -6,6 +6,7 @@ ha_category: - Camera ha_release: 0.31 ha_iot_class: Local Polling +ha_domain: synology --- The `synology` camera platform allows you to watch the live streams of your [Synology](https://www.synology.com/) Surveillance Station based IP cameras in Home Assistant. diff --git a/source/_integrations/synology_chat.markdown b/source/_integrations/synology_chat.markdown index 2a8bfccbb33..840708ac7ed 100644 --- a/source/_integrations/synology_chat.markdown +++ b/source/_integrations/synology_chat.markdown @@ -5,6 +5,7 @@ ha_release: 0.65 logo: synology.png ha_category: - Notifications +ha_domain: synology_chat --- The `synology_chat` notification platform allows you to deliver notifications to your [Synology Chat](https://www.synology.com/en-us/dsm/feature/chat) install as a Synology Chat bot. diff --git a/source/_integrations/synology_srm.markdown b/source/_integrations/synology_srm.markdown index 926da5dac91..e83d38cdbd9 100644 --- a/source/_integrations/synology_srm.markdown +++ b/source/_integrations/synology_srm.markdown @@ -7,6 +7,7 @@ ha_category: ha_release: 0.87 ha_codeowners: - '@aerialls' +ha_domain: synology_srm --- This platform allows you to detect presence by looking at connected devices to a [Synology SRM](https://www.synology.com/en-us/srm) router. diff --git a/source/_integrations/synologydsm.markdown b/source/_integrations/synologydsm.markdown index c8dfed7962a..9c751343648 100644 --- a/source/_integrations/synologydsm.markdown +++ b/source/_integrations/synologydsm.markdown @@ -6,6 +6,7 @@ ha_category: - System Monitor ha_release: 0.32 ha_iot_class: Local Polling +ha_domain: synologydsm --- The `synologydsm` sensor platform allows getting various statistics from your [Synology NAS](https://www.synology.com). diff --git a/source/_integrations/syslog.markdown b/source/_integrations/syslog.markdown index 3a396fc66c3..9f9c716ffb4 100644 --- a/source/_integrations/syslog.markdown +++ b/source/_integrations/syslog.markdown @@ -1,12 +1,12 @@ --- title: Syslog description: Instructions on how to add syslog notifications to Home Assistant. -logo: syslog.png ha_category: - Notifications ha_release: pre 0.7 ha_codeowners: - '@fabaff' +ha_domain: syslog --- The `syslog` platform allows you to deliver notifications from Home Assistant to the local syslog. diff --git a/source/_integrations/system_health.markdown b/source/_integrations/system_health.markdown index f19aa2d9965..53b55ab484f 100644 --- a/source/_integrations/system_health.markdown +++ b/source/_integrations/system_health.markdown @@ -1,11 +1,11 @@ --- title: System Health description: System Health integration will report system info and allow to run system diagnostics. -logo: home-assistant.png ha_category: - Other ha_release: 0.87 ha_quality_scale: internal +ha_domain: system_health --- The System Health integration provides an API to offer information on the system and its components. It also allows to run diagnostic tools to diagnose problems. diff --git a/source/_integrations/system_log.markdown b/source/_integrations/system_log.markdown index 8ca64765809..136c184b0f9 100644 --- a/source/_integrations/system_log.markdown +++ b/source/_integrations/system_log.markdown @@ -1,11 +1,11 @@ --- title: System Log description: Summary of errors and warnings in Home Assistant during runtime. -logo: home-assistant.png ha_category: - Other ha_release: 0.58 ha_quality_scale: internal +ha_domain: system_log --- The `system_log` integration stores information about all logged errors and warnings in Home Assistant. All collected information is accessible directly in the frontend, just navigate to the `Info` section under `Developer Tools`. In order to not overload Home Assistant with log data, only the 50 last errors and warnings will be stored. Older entries are automatically discarded from the log. It is possible to change the number of stored log entries using the parameter `max_entries`. diff --git a/source/_integrations/systemmonitor.markdown b/source/_integrations/systemmonitor.markdown index 5bc06777a2a..27f6e5d13cf 100644 --- a/source/_integrations/systemmonitor.markdown +++ b/source/_integrations/systemmonitor.markdown @@ -1,11 +1,11 @@ --- title: System Monitor description: Instructions on how to monitor the Home Assistant host. -logo: system_monitor.png ha_category: - System Monitor ha_release: pre 0.7 ha_iot_class: Local Push +ha_domain: systemmonitor --- The `systemmonitor` sensor platform allows you to monitor disk usage, diff --git a/source/_integrations/tado.markdown b/source/_integrations/tado.markdown index a70560f8015..8a1eea5e113 100644 --- a/source/_integrations/tado.markdown +++ b/source/_integrations/tado.markdown @@ -12,6 +12,7 @@ ha_release: 0.41 ha_iot_class: Cloud Polling ha_codeowners: - '@michaelarnauts' +ha_domain: tado --- The `tado` integration platform is used as an interface to the [my.tado.com](https://my.tado.com/) website. diff --git a/source/_integrations/tahoma.markdown b/source/_integrations/tahoma.markdown index 2e5a522304a..1f519361f69 100644 --- a/source/_integrations/tahoma.markdown +++ b/source/_integrations/tahoma.markdown @@ -14,6 +14,7 @@ ha_release: 0.59 ha_iot_class: Cloud Polling ha_codeowners: - '@philklei' +ha_domain: tahoma --- The `Tahoma` integration platform is used as an interface to the [tahomalink.com](https://www.tahomalink.com) website. It adds covers, scenes and a sun sensor from the Tahoma platform. diff --git a/source/_integrations/tank_utility.markdown b/source/_integrations/tank_utility.markdown index e281551dc68..d0e40e41304 100644 --- a/source/_integrations/tank_utility.markdown +++ b/source/_integrations/tank_utility.markdown @@ -5,6 +5,7 @@ logo: tank_utility.png ha_category: - Energy ha_release: 0.53 +ha_domain: tank_utility --- Add [Tank Utility](https://www.tankutility.com/) propane tank monitors to Home Assistant. diff --git a/source/_integrations/tankerkoenig.markdown b/source/_integrations/tankerkoenig.markdown new file mode 100755 index 00000000000..c12536d9448 --- /dev/null +++ b/source/_integrations/tankerkoenig.markdown @@ -0,0 +1,94 @@ +--- +title: "Tankerkoenig Sensor" +description: "Instructions on how to integrate Tankerkoenig sensors within Home Assistant." +logo: tankerkoenig.png +ha_category: + - Energy + - Sensor +ha_release: 0.102 +ha_iot_class: Cloud Polling +--- + +The `tankerkoenig` platform allows you to monitor the fuel prices with [tankerkoenig.de](https://www.tankerkoenig.de/) from within Home Assistant and setup automations based on the information. +One sensor entity will be created for each fuel station within the given radius and for each configured fuel type in it. + +You can also add additional stations manually, referencing them via their IDs. To find out the ID for a given fuel station, you can use the [TankstellenFinder](https://creativecommons.tankerkoenig.de/TankstellenFinder/index.html) tool. + +## Setup + +To use this sensor you need an API key from [tankerkoenig](https://creativecommons.tankerkoenig.de). Go to [api-key](https://creativecommons.tankerkoenig.de/api-key), fill out the form and request a key. The API is free, but requests should be limited to less than once every 5 minutes. + +## Configuration + +To enable this platform, add the following lines to your `configuration.yaml`: + +```yaml +# Example configuration.yaml entry +tankerkoenig: + api_key: YOUR_API_KEY + radius: 1 + fuel_type: + - "diesel" +``` + +{% configuration %} +api_key: + description: The api key you got when you registered. + required: true + type: string +fuel_types: + description: The types of fuels you want to track. Allowed values are `e5`, `e10` and `diesel`. + required: false + default: ["e5", "e10", "diesel"] + type: list +latitude: + description: The latitude of the gas station to list. + required: inclusive + type: float + default: latitude of your home zone +longitude: + description: The longitude of the gas station to list. + required: inclusive + type: float + default: longitude of your home zone +radius: + description: The radius in km. in which to search for gas stations. Cannot be less than 1. + required: false + default: 5 + type: integer +scan_interval: + description: The time interval to poll the server for new data. You should not put values lower than 5 minutes here; otherwise you risk your API key being blocked. + required: false + default: 0:30 + type: time +stations: + description: List of additional fuel stations to create entities for. + required: false + type: list +{% endconfiguration %} + +## Full example + +This is a full example of the platform: + +```yaml +tankerkoenig: + api_key: YOUR_API_KEY + fuel_types: + - "diesel" + - "e10" + latitude: 52.51627 + longitude: 13.3777 + radius: 1 + scan_interval: "0:10:01" + stations: + - 8531b393-1e42-423b-cb4d-e4b98cff8a0c +``` + +Assuming there are two fuel stations within the specified range and location, you would get six sensor entities: + * sensor.tankerkoenig_berlin_paulstrasse_20_diesel + * sensor.tankerkoenig_berlin_paulstrasse_20_e10 + * sensor.tankerkoenig_aral_tankstelle_diesel + * sensor.tankerkoenig_aral_tankstelle_e10 + * sensor.tankerkoenig_svg_hamburg_strassen>_diesel + * sensor.tankerkoenig_svg_hamburg_strassen_e10 diff --git a/source/_integrations/tapsaff.markdown b/source/_integrations/tapsaff.markdown index a39810fd179..3c9eb0d7323 100644 --- a/source/_integrations/tapsaff.markdown +++ b/source/_integrations/tapsaff.markdown @@ -6,6 +6,7 @@ ha_category: - Weather ha_release: 0.47 ha_iot_class: Local Polling +ha_domain: tapsaff --- The `tapsaff` binary sensor provides the 'Taps Aff' status for a given location within the UK using [Taps Aff](https://www.taps-aff.co.uk/). diff --git a/source/_integrations/tautulli.markdown b/source/_integrations/tautulli.markdown index 0d54a07aff4..e1050e10289 100644 --- a/source/_integrations/tautulli.markdown +++ b/source/_integrations/tautulli.markdown @@ -1,13 +1,13 @@ --- title: Tautulli description: Instructions on how to set up Tautulli sensors in Home Assistant. -logo: tautulli.png ha_category: - Sensor ha_release: 0.82 ha_iot_class: Local Polling ha_codeowners: - '@ludeeus' +ha_domain: tautulli --- The `tautulli` sensor platform will monitor activity on a given [Tautulli Server][tautulli]. It will create a sensor that shows the number of currently active streams as the state. If you click the sensor for more details it will show you more statistics, the following stats are available by default: diff --git a/source/_integrations/tcp.markdown b/source/_integrations/tcp.markdown index 90dc92e9e4b..b57289c0a1e 100644 --- a/source/_integrations/tcp.markdown +++ b/source/_integrations/tcp.markdown @@ -1,12 +1,12 @@ --- title: TCP description: Instructions on how to set up TCP within Home Assistant. -logo: tcp_ip.png ha_category: - Binary Sensor - Sensor ha_release: 0.14 ha_iot_class: Local Polling +ha_domain: tcp --- The TCP integration allows the integration of some services for which a specific Home Assistant integration does not exist. If the service communicates over a TCP socket with a simple request/reply mechanism then the chances are that this integration will allow integration with it. diff --git a/source/_integrations/ted5000.markdown b/source/_integrations/ted5000.markdown index 784e11fbd11..1736d429bd8 100644 --- a/source/_integrations/ted5000.markdown +++ b/source/_integrations/ted5000.markdown @@ -6,6 +6,7 @@ ha_category: - Energy ha_release: '0.30' ha_iot_class: Local Polling +ha_domain: ted5000 --- The `ted 5000` monitors electricity consumption/production by connecting to the [TED](https://www.theenergydetective.com/home) gateway, itself connected to one or several Measuring Transmitting Units (MTU). The platform creates up to two sensors per MTU, one for Wattage the other for Voltage. diff --git a/source/_integrations/teksavvy.markdown b/source/_integrations/teksavvy.markdown index 3d033787cef..cc1dc2b54a1 100644 --- a/source/_integrations/teksavvy.markdown +++ b/source/_integrations/teksavvy.markdown @@ -6,6 +6,7 @@ ha_category: - Network ha_release: 0.62 ha_iot_class: Cloud Polling +ha_domain: teksavvy --- Integrate your [TekSavvy](https://myaccount.teksavvy.com/) account information into Home Assistant. diff --git a/source/_integrations/telegram.markdown b/source/_integrations/telegram.markdown index c0cd71ba42a..67b0991aff0 100644 --- a/source/_integrations/telegram.markdown +++ b/source/_integrations/telegram.markdown @@ -1,10 +1,10 @@ --- title: Telegram description: Instructions on how to add Telegram notifications to Home Assistant. -logo: telegram.png ha_category: - Notifications ha_release: 0.7.5 +ha_domain: telegram --- The `telegram` platform uses [Telegram](https://web.telegram.org) to deliver notifications from Home Assistant to your Android device, your Windows phone, or your iOS device. @@ -14,7 +14,7 @@ The `telegram` platform uses [Telegram](https://web.telegram.org) to deliver not The requirements are: - You need a [Telegram bot](https://core.telegram.org/bots). Please follow those [instructions](https://core.telegram.org/bots#6-botfather) to create one and get the token for your bot. Keep in mind that bots are not allowed to contact users. You need to make the first contact with your user. Meaning that you need to send a message to the bot from your user. -- You need to configure a [Telegram bot in Home Assistant](/integrations/telegram_chatbot) and define there your API key and the allowed chat ids to interact with. +- You need to configure a [Telegram bot in Home Assistant](/integrations/telegram_bot) and define there your API key and the allowed chat ids to interact with. - The `chat_id` of an allowed user. **Method 1:** You can get your `chat_id` by sending any message to the [GetIDs bot](https://t.me/getidsbot). @@ -87,7 +87,7 @@ notify: ``` Refer to the platforms mentioned in the -[Telegram chatbot page](/integrations/telegram_chatbot/) for +[Telegram chatbot page](/integrations/telegram_bot/) for `telegram_bot` configuration. {% configuration %} @@ -155,7 +155,7 @@ action: - file: /tmp/picture.jpg caption: Picture Title xy - url: http://somebla.ie/video.png - caption: I.e. for a Title + caption: i.e., for a Title ``` {% configuration %} @@ -231,7 +231,7 @@ action: - file: /tmp/video.mp4 caption: Video Title xy - url: http://somebla.ie/video.mp4 - caption: I.e. for a Title + caption: i.e., for a Title ``` {% configuration %} diff --git a/source/_integrations/telegram_chatbot.markdown b/source/_integrations/telegram_bot.markdown similarity index 99% rename from source/_integrations/telegram_chatbot.markdown rename to source/_integrations/telegram_bot.markdown index 0a7fd78863a..d64b52b4d99 100644 --- a/source/_integrations/telegram_chatbot.markdown +++ b/source/_integrations/telegram_bot.markdown @@ -1,11 +1,11 @@ --- -title: "Telegram chatbot" -description: "Telegram chatbot support" -logo: telegram.png +title: Telegram bot +description: Telegram bot support ha_category: - Hub ha_release: 0.42 ha_iot_class: Cloud Push +ha_domain: telegram_bot --- Use Telegram on your mobile or desktop device to send and receive messages or commands to/from your Home Assistant. diff --git a/source/_integrations/telegram_broadcast.markdown b/source/_integrations/telegram_broadcast.markdown index 17464649bd5..0e3f9c0d865 100644 --- a/source/_integrations/telegram_broadcast.markdown +++ b/source/_integrations/telegram_broadcast.markdown @@ -1,10 +1,10 @@ --- title: "Telegram broadcast" description: "Telegram support to send messages only" -logo: telegram.png ha_category: - Notifications ha_release: 0.48 +ha_domain: telegram_bot --- Telegram implementation to support **sending messages only**. Your Home Assistant instance does not have to be exposed to the Internet and there is no polling to receive messages sent to the bot. diff --git a/source/_integrations/telegram_polling.markdown b/source/_integrations/telegram_polling.markdown index 38dbfd928b1..58081ec887d 100644 --- a/source/_integrations/telegram_polling.markdown +++ b/source/_integrations/telegram_polling.markdown @@ -1,10 +1,10 @@ --- title: "Telegram polling" description: "Telegram polling support" -logo: telegram.png ha_category: - Notifications ha_release: 0.42 +ha_domain: telegram_bot --- Telegram chatbot polling implementation. diff --git a/source/_integrations/telegram_webhooks.markdown b/source/_integrations/telegram_webhooks.markdown index 091dfacec4d..ecbb54833cc 100644 --- a/source/_integrations/telegram_webhooks.markdown +++ b/source/_integrations/telegram_webhooks.markdown @@ -1,10 +1,10 @@ --- title: "Telegram webhooks" description: "Telegram webhooks support" -logo: telegram.png ha_category: - Notifications ha_release: 0.42 +ha_domain: telegram_bot --- Telegram chatbot webhooks implementation as described in the Telegram [documentation](https://core.telegram.org/bots/webhooks). diff --git a/source/_integrations/tellduslive.markdown b/source/_integrations/tellduslive.markdown index fe46884c340..cbb188f5469 100644 --- a/source/_integrations/tellduslive.markdown +++ b/source/_integrations/tellduslive.markdown @@ -1,7 +1,6 @@ --- title: Telldus Live description: Instructions on how to integrate Telldus Live into Home Assistant. -logo: tellduslive.svg ha_category: - Hub - Binary Sensor @@ -15,6 +14,7 @@ ha_iot_class: Cloud Polling ha_quality_scale: gold ha_codeowners: - '@fredrike' +ha_domain: tellduslive --- The `tellduslive` integration let you connect to [Telldus Live](https://live.telldus.com). It's cloud platform that connects to your Tellstick Net or Tellstick ZNet connected gear at home. diff --git a/source/_integrations/tellstick.markdown b/source/_integrations/tellstick.markdown index 65d9428db29..2d144805521 100644 --- a/source/_integrations/tellstick.markdown +++ b/source/_integrations/tellstick.markdown @@ -10,6 +10,7 @@ ha_category: - Sensor - Switch ha_iot_class: Assumed State +ha_domain: tellstick --- The `tellstick` integration integrates [TellStick][tellstick-gateway] devices into Home Assistant. This integration allows users to add switches, lights, and sensors which are communicating with 433 MHz. There are a number of vendors (Capidi Elro, Intertechno, Nexa, Proove, Sartano, and Viking) who are selling products that work with TellStick. For more details, please check the TellStick [protocol list](http://developer.telldus.com/wiki/TellStick_conf). diff --git a/source/_integrations/telnet.markdown b/source/_integrations/telnet.markdown index 5f91f2f895b..26696454e4d 100644 --- a/source/_integrations/telnet.markdown +++ b/source/_integrations/telnet.markdown @@ -5,6 +5,7 @@ ha_category: - Switch ha_release: 0.54 ha_iot_class: Local Polling +ha_domain: telnet --- The `telnet` switch platform allows you to control devices with telnet commands. diff --git a/source/_integrations/temper.markdown b/source/_integrations/temper.markdown index 352b1a51764..3c419d21c35 100644 --- a/source/_integrations/temper.markdown +++ b/source/_integrations/temper.markdown @@ -5,6 +5,7 @@ ha_category: - DIY ha_iot_class: Local Push ha_release: pre 0.7 +ha_domain: temper --- This `temper` sensor platform allows you to get the current temperature from a TEMPer device. diff --git a/source/_integrations/template.markdown b/source/_integrations/template.markdown index 3899d5ced3b..f8a857f5693 100644 --- a/source/_integrations/template.markdown +++ b/source/_integrations/template.markdown @@ -5,11 +5,11 @@ ha_category: - Sensor ha_release: 0.12 ha_iot_class: Local Push -logo: home-assistant.png ha_quality_scale: internal ha_codeowners: - '@PhracturedBlue' - '@tetienne' +ha_domain: template --- The `template` platform supports sensors which get their values from other entities. diff --git a/source/_integrations/tensorflow.markdown b/source/_integrations/tensorflow.markdown index 4fe8feb8f6d..7c51761d28c 100644 --- a/source/_integrations/tensorflow.markdown +++ b/source/_integrations/tensorflow.markdown @@ -1,11 +1,11 @@ --- title: TensorFlow description: Detect and recognize objects with TensorFlow. -logo: tensorflow.png ha_category: - Image Processing ha_iot_class: Local Polling ha_release: 0.82 +ha_domain: tensorflow --- The `tensorflow` image processing platform allows you to detect and recognize objects in a camera image using [TensorFlow](https://www.tensorflow.org/). The state of the entity is the number of objects detected, and recognized objects are listed in the `summary` attribute along with quantity. The `matches` attribute provides the confidence `score` for recognition and the bounding `box` of the object for each detection category. diff --git a/source/_integrations/tesla.markdown b/source/_integrations/tesla.markdown index ae1d96c8b80..d5cdae6d051 100644 --- a/source/_integrations/tesla.markdown +++ b/source/_integrations/tesla.markdown @@ -1,7 +1,6 @@ --- title: Tesla description: Instructions on how to integrate Tesla car into Home Assistant. -logo: tesla.png ha_category: - Car - Binary Sensor @@ -16,6 +15,7 @@ ha_config_flow: true ha_codeowners: - '@zabuldon' - '@alandtse' +ha_domain: tesla --- The `Tesla` integration offers integration with the [Tesla](https://auth.tesla.com/login) cloud service and provides presence detection as well as sensors such as charger state and temperature. diff --git a/source/_integrations/tfiac.markdown b/source/_integrations/tfiac.markdown index 3bf4d9590db..9154e4483f8 100644 --- a/source/_integrations/tfiac.markdown +++ b/source/_integrations/tfiac.markdown @@ -1,7 +1,6 @@ --- title: Tfiac description: Instructions on how to integrate Tfiac AC devices with Home Assistant. -logo: tfiac.png ha_category: - Climate ha_release: 0.91 @@ -9,6 +8,7 @@ ha_iot_class: Local Polling ha_codeowners: - '@fredrike' - '@mellado' +ha_domain: tfiac --- The `tfiac` integration integrates several vendors air conditioning systems, that uses the Tfiac mobile app, into Home Assistant. App currently available at [Play Store](https://play.google.com/store/apps/details?id=com.tcl.export) and [App Store](https://itunes.apple.com/app/tfiac/id1059938398). diff --git a/source/_integrations/thermoworks_smoke.markdown b/source/_integrations/thermoworks_smoke.markdown index 946a67169de..af147f0fe79 100644 --- a/source/_integrations/thermoworks_smoke.markdown +++ b/source/_integrations/thermoworks_smoke.markdown @@ -6,6 +6,7 @@ ha_category: - Sensor ha_release: 0.81 ha_iot_class: Cloud Polling +ha_domain: thermoworks_smoke --- The `thermoworks_smoke` sensor platform pulls data for your [ThermoWorks Smoke Thermometer](https://www.thermoworks.com/Smoke). diff --git a/source/_integrations/thethingsnetwork.markdown b/source/_integrations/thethingsnetwork.markdown index 5f6b24d94b2..35c7f20879e 100644 --- a/source/_integrations/thethingsnetwork.markdown +++ b/source/_integrations/thethingsnetwork.markdown @@ -1,7 +1,6 @@ --- title: The Things Network description: Instructions for how to integrate The Things Network within Home Assistant. -logo: thethingsnetwork.png ha_category: - Hub - Sensor @@ -9,6 +8,7 @@ ha_release: 0.55 ha_iot_class: Configurable ha_codeowners: - '@fabaff' +ha_domain: thethingsnetwork --- The `thethingsnetwork` integration allows one to interact with the [The Things Network](https://www.thethingsnetwork.org). This community-driven and open network supports [LoRaWAN](https://www.lora-alliance.org/) for long range (~5 to 15km) communication with a low bandwidth (51 bytes/message). [Gateways](https://www.thethingsnetwork.org/docs/gateways/) transfers the received data from the sensors to the The Things Network. diff --git a/source/_integrations/thingspeak.markdown b/source/_integrations/thingspeak.markdown index 158d4ff2446..552ca382464 100644 --- a/source/_integrations/thingspeak.markdown +++ b/source/_integrations/thingspeak.markdown @@ -5,6 +5,7 @@ logo: thingspeak.png ha_category: - History ha_release: 0.32 +ha_domain: thingspeak --- The `thingspeak` integrations makes Home Assistant communicate with the [ThingSpeak API](https://thingspeak.com/). diff --git a/source/_integrations/thinkingcleaner.markdown b/source/_integrations/thinkingcleaner.markdown index f5439aaba61..a375506d4f3 100644 --- a/source/_integrations/thinkingcleaner.markdown +++ b/source/_integrations/thinkingcleaner.markdown @@ -1,12 +1,12 @@ --- title: Thinking Cleaner description: Instructions on how to integrate a ThinkingCleaner within Home Assistant. -logo: thinkingcleaner.png ha_category: - Sensor - Switch ha_iot_class: Local Polling ha_release: 0.18 +ha_domain: thinkingcleaner --- There is currently support for the following device types within Home Assistant: @@ -21,23 +21,51 @@ The `thinkingcleaner` sensor platform simple displays information about your [Th To enable this sensor in your installation, add the following to your `configuration.yaml` file: ```yaml -# Example configuration.yaml entry sensor: - platform: thinkingcleaner ``` +{% configuration %} +host: + description: IP address of Thinking Cleaner device + required: false + type: string +{% endconfiguration %} + + This will automatically add sensors for each Thinking Cleaner in your network. -## switch +## Switch The `thinkingcleaner` switch platform allows you to control your [Thinking Cleaner](https://www.thinkingcleaner.com/) add-on. To enable this switch in your installation, add the following to your `configuration.yaml` file: ```yaml -# Example configuration.yaml entry switch: - platform: thinkingcleaner ``` +{% configuration %} +host: + description: IP address of Thinking Cleaner device + required: false + type: string +{% endconfiguration %} + + This will automatically add switches for each Thinking Cleaner in your network. + +## Example configuration using a Roomba with a static IP + +If your `thinkingcleaner` device has a static IP address, you can also supply this to the sensor and switch using the host parameter. This is optional and will disable the automatic lookup. + +```yaml +sensor: + - platform: thinkingcleaner + host: 10.0.0.55 +switch: + - platform: thinkingcleaner + host: 10.0.0.55 +``` + diff --git a/source/_integrations/thomson.markdown b/source/_integrations/thomson.markdown index a212f0366d2..f35594df439 100644 --- a/source/_integrations/thomson.markdown +++ b/source/_integrations/thomson.markdown @@ -5,6 +5,7 @@ logo: technicolor.png ha_category: - Presence Detection ha_release: 0.7 +ha_domain: thomson --- Thomson produced networking equipment (under the brand name SpeedTouch) till 2010 and was then renamed to Technicolor. diff --git a/source/_integrations/threshold.markdown b/source/_integrations/threshold.markdown index 378432b7294..7e6be5db352 100644 --- a/source/_integrations/threshold.markdown +++ b/source/_integrations/threshold.markdown @@ -1,7 +1,6 @@ --- title: Threshold description: Instructions on how to integrate threshold binary sensors into Home Assistant. -logo: home-assistant.png ha_category: - Utility ha_iot_class: Local Polling @@ -9,6 +8,7 @@ ha_release: 0.34 ha_quality_scale: internal ha_codeowners: - '@fabaff' +ha_domain: threshold --- The `threshold` binary sensor platform observes the state of another sensor. If the value is below (`lower`) or higher (`upper`) than the given threshold then state of the threshold sensor is changed. It support also a range if `lower` and `upper` are given. diff --git a/source/_integrations/tibber.markdown b/source/_integrations/tibber.markdown index d1fd2602576..27d99b63bce 100644 --- a/source/_integrations/tibber.markdown +++ b/source/_integrations/tibber.markdown @@ -11,6 +11,7 @@ ha_iot_class: Cloud Polling ha_quality_scale: silver ha_codeowners: - '@danielhiversen' +ha_domain: tibber --- The `tibber` integration provides a sensor with the current electricity price if you are a [Tibber](https://tibber.com/) customer. diff --git a/source/_integrations/tikteck.markdown b/source/_integrations/tikteck.markdown index c091a5fe2ff..90b5253671a 100644 --- a/source/_integrations/tikteck.markdown +++ b/source/_integrations/tikteck.markdown @@ -6,6 +6,7 @@ ha_category: ha_iot_class: Local Polling logo: tikteck.png ha_release: 0.36 +ha_domain: tikteck --- Support for the Bluetooth smart bulb from [Tikteck](https://www.tikteck.com/). To enable these lights, add the following lines to your `configuration.yaml` file: diff --git a/source/_integrations/tile.markdown b/source/_integrations/tile.markdown index 9946c45f511..7b20223c985 100644 --- a/source/_integrations/tile.markdown +++ b/source/_integrations/tile.markdown @@ -1,13 +1,13 @@ --- title: Tile description: Instructions on how to use Tile to track devices in Home Assistant. -logo: tile.png ha_release: 0.58 ha_category: - Presence Detection ha_iot_class: Cloud Polling ha_codeowners: - '@bachya' +ha_domain: tile --- The `tile` platform allows Home Assistant to utilize [Tile® Bluetooth trackers](https://www.thetileapp.com). diff --git a/source/_integrations/time_date.markdown b/source/_integrations/time_date.markdown index a446e4ce245..2be41354a75 100644 --- a/source/_integrations/time_date.markdown +++ b/source/_integrations/time_date.markdown @@ -1,7 +1,6 @@ --- title: Time & Date description: Instructions on how to integrate the time and the date within Home Assistant. -logo: home-assistant.png ha_category: - Calendar ha_iot_class: Local Push @@ -9,10 +8,11 @@ ha_release: pre 0.7 ha_quality_scale: internal ha_codeowners: - '@fabaff' +ha_domain: time_date --- The time and date (`time_date`) sensor platform adds one or more sensors to your Home Assistant state machine. -To have these sensors available in your installation, add the following to your `configuration.yaml` file (each option creates a separate sensor that contains appropriate data, e.g. `sensor.date` for the `date` option): +To have these sensors available in your installation, add the following to your `configuration.yaml` file (each option creates a separate sensor that contains appropriate data, e.g., `sensor.date` for the `date` option): ```yaml # Example configuration.yaml entry diff --git a/source/_integrations/timer.markdown b/source/_integrations/timer.markdown index b5e5d1b5789..6df5a78919a 100644 --- a/source/_integrations/timer.markdown +++ b/source/_integrations/timer.markdown @@ -1,11 +1,11 @@ --- title: Timer description: Instructions on how to integrate timers into Home Assistant. -logo: home-assistant.png ha_category: - Automation ha_release: 0.57 ha_quality_scale: internal +ha_domain: timer --- The `timer` integration aims to simplify automations based on (dynamic) durations. diff --git a/source/_integrations/tmb.markdown b/source/_integrations/tmb.markdown index a5d8f73642f..8d0c8533223 100644 --- a/source/_integrations/tmb.markdown +++ b/source/_integrations/tmb.markdown @@ -8,6 +8,7 @@ ha_release: 0.104 ha_iot_class: Local Polling ha_codeowners: - '@alemuro' +ha_domain: tmb --- This sensor will provide you the remaining time, in minutes, for the next bus in a specific stop by using the [iBus service](https://www.tmb.cat/en/barcelona/tmb-ibus). diff --git a/source/_integrations/tod.markdown b/source/_integrations/tod.markdown index 50ae48c4260..31084a6c20c 100644 --- a/source/_integrations/tod.markdown +++ b/source/_integrations/tod.markdown @@ -5,8 +5,8 @@ ha_category: - Binary Sensor ha_release: 0.89 ha_iot_class: Local Push -logo: home-assistant.png ha_quality_scale: internal +ha_domain: tod --- The `tod` platform supports binary sensors which get their values by checking if the current time is within defined time ranges. diff --git a/source/_integrations/todoist.markdown b/source/_integrations/todoist.markdown index 3caaddd898e..7ae7a723e76 100644 --- a/source/_integrations/todoist.markdown +++ b/source/_integrations/todoist.markdown @@ -8,6 +8,7 @@ ha_iot_class: Cloud Polling ha_release: 0.54 ha_codeowners: - '@boralyl' +ha_domain: todoist --- This platform allows you to connect to your [Todoist Projects](https://todoist.com) and generate binary sensors. A different sensor will be created for each individual project, or you can specify "custom" projects which match against criteria you set (more on that below). These sensors will be `on` if you have a task due in that project or `off` if all the tasks in the project are completed or if the project doesn't have any tasks at all. All tasks get updated roughly every 15 minutes. diff --git a/source/_integrations/tof.markdown b/source/_integrations/tof.markdown index 34a8e05480d..f56eec6bd4f 100644 --- a/source/_integrations/tof.markdown +++ b/source/_integrations/tof.markdown @@ -1,12 +1,12 @@ --- title: Time of Flight description: Instructions on how to integrate a VL53L1X ToF sensor into Home Assistant. -logo: raspberry-pi.png ha_category: - DIY - Sensor ha_release: '0.90' ha_iot_class: Local Polling +ha_domain: tof --- The Time of Flight sensor uses an invisible laser to measure distance with millimeter resolution. diff --git a/source/_integrations/tomato.markdown b/source/_integrations/tomato.markdown index 2e3b4c2a92f..9cbaabdc816 100644 --- a/source/_integrations/tomato.markdown +++ b/source/_integrations/tomato.markdown @@ -1,10 +1,10 @@ --- title: Tomato description: Instructions on how to integrate Tomato routers into Home Assistant. -logo: tomato.png ha_category: - Presence Detection ha_release: pre 0.7 +ha_domain: tomato --- The `tomato` platform requires an extra configuration variable called `http_id`. The diff --git a/source/_integrations/toon.markdown b/source/_integrations/toon.markdown index c7c6ab73b93..59ffe07b397 100644 --- a/source/_integrations/toon.markdown +++ b/source/_integrations/toon.markdown @@ -12,6 +12,7 @@ ha_iot_class: Cloud Polling ha_config_flow: true ha_codeowners: - '@frenck' +ha_domain: toon --- The `toon` integration platform can be used to control your Toon thermostat. This integration adds a climate device for your Toon thermostat, sensors for power and gas consumption, sensors for solar production and several binary sensors for things like boiler burner on/off, hot tap water and boiler health status. diff --git a/source/_integrations/torque.markdown b/source/_integrations/torque.markdown index 3b43b9c0bca..fb72efccf26 100644 --- a/source/_integrations/torque.markdown +++ b/source/_integrations/torque.markdown @@ -6,6 +6,7 @@ ha_category: - Car ha_release: '0.10' ha_iot_class: Cloud Polling +ha_domain: torque --- The `torque` platform will allow you to monitor [Torque](https://torque-bhp.com/) data relayed from a Bluetooth OBD2 stick via the Torque mobile application. diff --git a/source/_integrations/totalconnect.markdown b/source/_integrations/totalconnect.markdown index 2b2ab3d5c47..8b041f4a88f 100644 --- a/source/_integrations/totalconnect.markdown +++ b/source/_integrations/totalconnect.markdown @@ -6,6 +6,9 @@ ha_category: - Alarm - Binary Sensor ha_release: 0.42 +ha_codeowners: + - '@austinmroczek' +ha_domain: totalconnect --- The `totalconnect` integration provides connectivity with the Honeywell TotalConnect alarm systems used by many alarm companies. diff --git a/source/_integrations/touchline.markdown b/source/_integrations/touchline.markdown index d6674e4a5a2..32353bd9fe9 100644 --- a/source/_integrations/touchline.markdown +++ b/source/_integrations/touchline.markdown @@ -6,6 +6,7 @@ ha_category: - Climate ha_release: 0.61 ha_iot_class: Local Polling +ha_domain: touchline --- The `touchline` climate platform let you control [ROTH Touchline](http://www.roth-nordic.dk/dk/roth-touchline-tradloes-gulvvarmeregulering-1475.htm) floor heating thermostats from Roth. diff --git a/source/_integrations/tplink.markdown b/source/_integrations/tplink.markdown index b2f10f3157a..1b0ac783fb9 100644 --- a/source/_integrations/tplink.markdown +++ b/source/_integrations/tplink.markdown @@ -11,6 +11,7 @@ ha_iot_class: Local Polling ha_config_flow: true ha_codeowners: - '@rytilahti' +ha_domain: tplink --- The `tplink` integration allows you to control your [TP-Link Smart Home Devices](https://www.tp-link.com/kasa-smart/) such as smart plugs and smart bulbs. diff --git a/source/_integrations/tplink_lte.markdown b/source/_integrations/tplink_lte.markdown index ea1959588bd..8f435c97cf2 100644 --- a/source/_integrations/tplink_lte.markdown +++ b/source/_integrations/tplink_lte.markdown @@ -7,6 +7,7 @@ ha_category: - Network - Notifications ha_iot_class: Local Polling +ha_domain: tplink_lte --- The TP-Link LTE integration for Home Assistant allows you to observe and control TP-Link LTE routers, currently only tested with TL-MR6400 (firmware 1.4.0). diff --git a/source/_integrations/traccar.markdown b/source/_integrations/traccar.markdown index 775b7cc1f08..2a4ace76419 100644 --- a/source/_integrations/traccar.markdown +++ b/source/_integrations/traccar.markdown @@ -9,6 +9,7 @@ ha_iot_class: Local Polling ha_config_flow: true ha_codeowners: - '@ludeeus' +ha_domain: traccar --- `Traccar` uses GPS for tracking and has support for over 1500 different types of devices. One option is to track the [Traccar Client](https://www.traccar.org/client/) app on a smartphone via `webhook`. The other option is to connect to an existing [Traccar Server](https://www.traccar.org/server/) installation which is also available as Home Assistant add-on. diff --git a/source/_integrations/trackr.markdown b/source/_integrations/trackr.markdown index 82ffc9be6a8..ff8135be05f 100644 --- a/source/_integrations/trackr.markdown +++ b/source/_integrations/trackr.markdown @@ -1,11 +1,11 @@ --- title: TrackR description: Instructions on how to use TrackR to track devices in Home Assistant. -logo: trackr.png ha_release: 0.36 ha_category: - Presence Detection ha_iot_class: Cloud Polling +ha_domain: trackr --- The `trackr` platform allows you to detect presence using [TrackR](https://www.thetrackr.com/) devices. diff --git a/source/_integrations/tradfri.markdown b/source/_integrations/tradfri.markdown index cf2ba725149..c4658b64ff3 100644 --- a/source/_integrations/tradfri.markdown +++ b/source/_integrations/tradfri.markdown @@ -2,7 +2,6 @@ title: IKEA TRÅDFRI (TRADFRI) description: Access and control your IKEA Trådfri Gateway and its connected Zigbee-based devices. featured: true -logo: ikea.svg ha_iot_class: Local Polling ha_config_flow: true ha_release: 0.43 @@ -13,6 +12,7 @@ ha_category: - Switch ha_codeowners: - '@ggravlingen' +ha_domain: tradfri --- The `tradfri` integration allows you to connect your IKEA Trådfri Gateway to Home Assistant. The gateway can control compatible Zigbee-based lights (certified Zigbee Light Link products) connected to it. Home Assistant will automatically discover the gateway's presence on your local network if `discovery:` is present in your `configuration.yaml` file. diff --git a/source/_integrations/trafikverket_train.markdown b/source/_integrations/trafikverket_train.markdown index ba783b7432d..4a28136f4f4 100644 --- a/source/_integrations/trafikverket_train.markdown +++ b/source/_integrations/trafikverket_train.markdown @@ -9,6 +9,7 @@ ha_release: 0.96 ha_iot_class: Cloud Polling ha_codeowners: - '@endor-force' +ha_domain: trafikverket_train --- Retrieve train departure information from [Trafikverket](https://www.trafikverket.se/). diff --git a/source/_integrations/trafikverket_weatherstation.markdown b/source/_integrations/trafikverket_weatherstation.markdown index 9b8604a5b30..49b25451d16 100644 --- a/source/_integrations/trafikverket_weatherstation.markdown +++ b/source/_integrations/trafikverket_weatherstation.markdown @@ -6,6 +6,7 @@ ha_category: - Weather ha_release: 0.66 ha_iot_class: Cloud Polling +ha_domain: trafikverket_weatherstation --- Showing weather information provided by [Trafikverket](https://www.trafikverket.se/) weather stations in Sweden. diff --git a/source/_integrations/transmission.markdown b/source/_integrations/transmission.markdown index bc81ae4f094..f5a0bfc72df 100644 --- a/source/_integrations/transmission.markdown +++ b/source/_integrations/transmission.markdown @@ -1,7 +1,6 @@ --- title: Transmission description: Instructions on how to integrate Transmission within Home Assistant. -logo: transmission.png ha_category: - Downloading - Switch @@ -12,6 +11,7 @@ ha_config_flow: true ha_codeowners: - '@engrbm87' - '@JPHutchins' +ha_domain: transmission --- The `transmission` integration allows you to monitor your downloads with [Transmission](https://www.transmissionbt.com/) from within Home Assistant and setup automation based on the information. diff --git a/source/_integrations/transport_nsw.markdown b/source/_integrations/transport_nsw.markdown index 6b2ec21b6e6..8d2cbaf7d09 100644 --- a/source/_integrations/transport_nsw.markdown +++ b/source/_integrations/transport_nsw.markdown @@ -6,6 +6,7 @@ ha_category: - Transport ha_iot_class: Cloud Polling ha_release: 0.81 +ha_domain: transport_nsw --- The `transport_nsw` sensor will give you the time until the next departure from a Transport NSW stop for bus, train, light rail or ferry. @@ -46,7 +47,7 @@ route: required: false type: string destination: - description: Useful for ferry or train stops to filter the destination of the sensor, e.g. `Circular Quay`. + description: Useful for ferry or train stops to filter the destination of the sensor, e.g., `Circular Quay`. required: false type: string name: diff --git a/source/_integrations/travisci.markdown b/source/_integrations/travisci.markdown index 13cd4306ece..d4089dace5e 100644 --- a/source/_integrations/travisci.markdown +++ b/source/_integrations/travisci.markdown @@ -1,11 +1,11 @@ --- title: Travis-CI description: Instructions on how to integrate the test build results reported by Travis-CI within Home Assistant. -logo: travisci.svg ha_category: - Sensor ha_release: 0.56 ha_iot_class: Cloud Polling +ha_domain: travisci --- With this sensor platform, you will be able to integrate the test build results reported by [Travis-CI](https://travis-ci.org/) working within Home Assistant. diff --git a/source/_integrations/trend.markdown b/source/_integrations/trend.markdown index 90f78990765..83ffcda9d65 100644 --- a/source/_integrations/trend.markdown +++ b/source/_integrations/trend.markdown @@ -3,10 +3,10 @@ title: Trend description: Instructions on how to integrate Trend binary sensors into Home Assistant. ha_category: - Utility -logo: home-assistant.png ha_release: 0.28 ha_iot_class: Local Push ha_quality_scale: internal +ha_domain: trend --- The `trend` platform allows you to create sensors which show the trend of diff --git a/source/_integrations/tts.markdown b/source/_integrations/tts.markdown index 2337e0b94c9..e1132d25f7f 100644 --- a/source/_integrations/tts.markdown +++ b/source/_integrations/tts.markdown @@ -4,6 +4,7 @@ description: Instructions on how to set up Text-to-Speech (TTS) with Home Assist ha_release: 0.35 ha_codeowners: - '@robbiet480' +ha_domain: tts --- Text-to-Speech (TTS) enables Home Assistant to speak to you. diff --git a/source/_integrations/tuya.markdown b/source/_integrations/tuya.markdown index d0ccc92aab3..bd95d59a855 100644 --- a/source/_integrations/tuya.markdown +++ b/source/_integrations/tuya.markdown @@ -12,6 +12,7 @@ ha_category: - Switch ha_iot_class: Cloud Polling ha_release: 0.74 +ha_domain: tuya --- The `tuya` integration is the main integration to integrate all [Tuya Smart](https://www.tuya.com) related platforms. You will need your Tuya account information (username, password and account country code) to discover and control devices which related to your account. diff --git a/source/_integrations/twentemilieu.markdown b/source/_integrations/twentemilieu.markdown index 2a7aac0451b..a9bcecc16d6 100644 --- a/source/_integrations/twentemilieu.markdown +++ b/source/_integrations/twentemilieu.markdown @@ -10,6 +10,7 @@ ha_iot_class: Cloud Polling ha_config_flow: true ha_codeowners: - '@frenck' +ha_domain: twentemilieu --- The Twente Milieu integration allows you to track the next scheduled waste diff --git a/source/_integrations/twilio.markdown b/source/_integrations/twilio.markdown index 6a2c761f8c7..b06dbfd1c63 100644 --- a/source/_integrations/twilio.markdown +++ b/source/_integrations/twilio.markdown @@ -1,11 +1,11 @@ --- title: Twilio description: Instructions on how to add Twilio notifications to Home Assistant. -logo: twilio.png ha_category: - Hub ha_release: '0.40' ha_config_flow: true +ha_domain: twilio --- The `twilio` integration enables the sending of notifications via SMS and the creation of calls with [Twilio](https://twilio.com). @@ -39,7 +39,7 @@ auth_token: After configuring the base Twilio component, add and configure either or both of the [Twilio SMS](/integrations/twilio_sms) and [Twilio Phone](/integrations/twilio_call) integrations to utilize the notification functionality. -To be able to receive events from Twilio, your Home Assistant instance needs to be accessible from the web and you need to have the `base_url` configured for the HTTP integration ([docs](/integrations/http/#base_url)). +To be able to receive events from Twilio, your Home Assistant instance needs to be accessible from the web and you need to have the `base_url` configured for the HTTP integration ([documentation](/integrations/http/#base_url)). To set it up, go to the integrations page in the configuration screen and find Twilio. Click on configure. Follow the instructions on the screen to configure Twilio. diff --git a/source/_integrations/twilio_call.markdown b/source/_integrations/twilio_call.markdown index ef47f677134..b9eeec9070c 100644 --- a/source/_integrations/twilio_call.markdown +++ b/source/_integrations/twilio_call.markdown @@ -1,12 +1,12 @@ --- title: Twilio Call description: Instructions on how to add user notifications to Home Assistant. -logo: twilio.png ha_category: - Notifications ha_release: 0.37 ha_codeowners: - '@robbiet480' +ha_domain: twilio_call --- The `twilio_call` notification platform enables sending notifications via Voice, powered by [Twilio](https://twilio.com). diff --git a/source/_integrations/twilio_sms.markdown b/source/_integrations/twilio_sms.markdown index f81b5eaa6c7..780eec8f372 100644 --- a/source/_integrations/twilio_sms.markdown +++ b/source/_integrations/twilio_sms.markdown @@ -1,12 +1,12 @@ --- title: Twilio SMS description: Instructions on how to add user notifications to Home Assistant. -logo: twilio.png ha_category: - Notifications ha_release: '0.20' ha_codeowners: - '@robbiet480' +ha_domain: twilio_sms --- The `twilio` notification platform enables sending notifications via SMS, powered by [Twilio](https://twilio.com). diff --git a/source/_integrations/twitch.markdown b/source/_integrations/twitch.markdown index 38fab3d6634..b399b0dbbf0 100644 --- a/source/_integrations/twitch.markdown +++ b/source/_integrations/twitch.markdown @@ -6,6 +6,7 @@ ha_category: - Social ha_release: '0.10' ha_iot_class: Cloud Polling +ha_domain: twitch --- The `twitch` platform will allow you to monitor [Twitch](https://www.twitch.tv/) channel status from within Home Assistant and setup automation based on the information. diff --git a/source/_integrations/twitter.markdown b/source/_integrations/twitter.markdown index d7094e4747d..e63d4287f46 100644 --- a/source/_integrations/twitter.markdown +++ b/source/_integrations/twitter.markdown @@ -1,10 +1,10 @@ --- title: Twitter description: Instructions on how to add Twitter notifications to Home Assistant. -logo: twitter.png ha_category: - Notifications ha_release: 0.12 +ha_domain: twitter --- The `twitter` notification platform uses [Twitter](https://twitter.com) to deliver notifications from Home Assistant. diff --git a/source/_integrations/ubee.markdown b/source/_integrations/ubee.markdown index 6d6c97def53..3549c574cd8 100644 --- a/source/_integrations/ubee.markdown +++ b/source/_integrations/ubee.markdown @@ -7,6 +7,7 @@ ha_category: ha_release: 0.89 ha_codeowners: - '@mzdrale' +ha_domain: ubee --- This platform offers presence detection by looking at connected devices to a [Ubee Router](https://www.ubeeinteractive.com/). @@ -24,12 +25,12 @@ device_tracker: {% configuration %} model: - description: Ubee Router model, e.g. `EVW32C-0N`. If omitted, model will be detected automatically. + description: Ubee Router model, e.g., `EVW32C-0N`. If omitted, model will be detected automatically. required: false default: detect type: string host: - description: The IP address of your router, e.g. `192.168.1.1`. + description: The IP address of your router, e.g., `192.168.1.1`. required: true type: string username: @@ -48,6 +49,7 @@ Supported models: - EVW321B - EVW32C-0N - EVW3226@UPC +- DVW32CB
    diff --git a/source/_integrations/ubus.markdown b/source/_integrations/ubus.markdown index 07a1a966782..6604efa3c96 100644 --- a/source/_integrations/ubus.markdown +++ b/source/_integrations/ubus.markdown @@ -5,6 +5,7 @@ logo: openwrt.png ha_category: - Presence Detection ha_release: 0.7.6 +ha_domain: ubus --- _This is one of multiple ways we support OpenWrt. For an overview, see [OpenWrt](/integrations/openwrt)._ diff --git a/source/_integrations/ue_smart_radio.markdown b/source/_integrations/ue_smart_radio.markdown index 26f314bcf11..3055b1ba32e 100644 --- a/source/_integrations/ue_smart_radio.markdown +++ b/source/_integrations/ue_smart_radio.markdown @@ -6,6 +6,7 @@ ha_category: - Media Player ha_release: '0.60' ha_iot_class: Cloud Polling +ha_domain: ue_smart_radio --- The `ue_radio` platform allows you to control a [Logitech UE Smart Radio](https://www.uesmartradio.com) from Home Assistant. This lets you control both Logitech UE Smart Radios and Logitech Squeezebox Radios that have been updated with the UE Smart Radio update. diff --git a/source/_integrations/uk_transport.markdown b/source/_integrations/uk_transport.markdown index 294a06a8713..10247ffe356 100644 --- a/source/_integrations/uk_transport.markdown +++ b/source/_integrations/uk_transport.markdown @@ -1,11 +1,11 @@ --- title: UK Transport description: Display the current status of UK train and bus departures. -logo: train.png ha_category: - Transport ha_iot_class: Cloud Polling ha_release: '0.50' +ha_domain: uk_transport --- The `uk_transport` sensor will display the time in minutes until the next departure in a specified direction from of a configured train station or bus stop. The sensor uses [transportAPI](https://www.transportapi.com/) to query live departure data and requires a developer application ID and key which can be obtained [here](https://developer.transportapi.com/). The [free tier](https://www.transportapi.com/plans/) allows 1000 requests daily, which is sufficient for a single sensor refreshing every 87 seconds. @@ -78,27 +78,36 @@ Refer to the [API reference webpage](https://developer.transportapi.com/docs?ram Attributes can be accessed using the [template sensor](/integrations/template) as per this example: +{% raw %} + ```yaml # Example configuration.yaml entry for a template sensor to access the attributes of the next departing train. - platform: template sensors: next_train_status: friendly_name: 'Next train status' - value_template: {% raw %}"{{state_attr('sensor.next_train_to_wat', 'next_trains')[0].status}}"{% endraw %} + value_template: >- + {{state_attr('sensor.next_train_to_wat', 'next_trains')[0].status}} next_trains_origin: friendly_name: 'Next train origin' - value_template: {% raw %}"{{state_attr('sensor.next_train_to_wat', 'next_trains')[0].origin_name}}"{% endraw %} + value_template: >- + {{state_attr('sensor.next_train_to_wat', 'next_trains')[0].origin_name}} next_trains_estimated: friendly_name: 'Next train estimated' - value_template: {% raw %}"{{state_attr('sensor.next_train_to_wat', 'next_trains')[0].estimated}}"{% endraw %} + value_template: >- + {{state_attr('sensor.next_train_to_wat', 'next_trains')[0].estimated}} next_trains_scheduled: friendly_name: 'Next train scheduled' - value_template: {% raw %}"{{state_attr('sensor.next_train_to_wat', 'next_trains')[0].scheduled}}"{% endraw %} + value_template: >- + {{state_attr('sensor.next_train_to_wat', 'next_trains')[0].scheduled}} next_trains_platform: friendly_name: 'Next train platform' - value_template: {% raw %}"{{state_attr('sensor.next_train_to_wat', 'next_trains')[0].platform}}"{% endraw %} + value_template: >- + {{state_attr('sensor.next_train_to_wat', 'next_trains')[0].platform}} ``` +{% endraw %} + Bus sensors require as their `origin` a bus stop ATCO code which can be found by browsing OpenStreetMap data as follows: diff --git a/source/_integrations/unifi.markdown b/source/_integrations/unifi.markdown index b226bb6f3d2..510e4191eb7 100644 --- a/source/_integrations/unifi.markdown +++ b/source/_integrations/unifi.markdown @@ -12,6 +12,7 @@ ha_config_flow: true ha_quality_scale: platinum ha_codeowners: - '@kane610' +ha_domain: unifi --- [UniFi](https://unifi-sdn.ubnt.com/) by [Ubiquiti Networks, inc.](https://www.ubnt.com/) is a software that binds gateways, switches and wireless access points together with one graphical front end. diff --git a/source/_integrations/unifi_direct.markdown b/source/_integrations/unifi_direct.markdown index 5fd06268816..f8cf49b3f77 100644 --- a/source/_integrations/unifi_direct.markdown +++ b/source/_integrations/unifi_direct.markdown @@ -6,6 +6,7 @@ ha_category: - Presence Detection ha_iot_class: Local Polling ha_release: 0.59 +ha_domain: unifi_direct --- This platform allows you to detect presence by looking at devices connected to a [UniFi AP](https://www.ubnt.com/products/#unifi). This device tracker differs form [Ubiquiti UniFi WAP](/integrations/unifi) because it doesn't require the UniFi controller software. diff --git a/source/_integrations/unifiled.markdown b/source/_integrations/unifiled.markdown index 5f0661bfdc6..c39a8cc575e 100644 --- a/source/_integrations/unifiled.markdown +++ b/source/_integrations/unifiled.markdown @@ -8,6 +8,7 @@ ha_release: 0.102 ha_iot_class: Local Polling ha_codeowners: - '@florisvdk' +ha_domain: unifiled --- [UniFi LED](https://unifi-led.ui.com/) by [Ubiquiti Networks, inc.](https://www.ubnt.com/) is a system of controller managed LED light panels and dimmers. diff --git a/source/_integrations/universal.markdown b/source/_integrations/universal.markdown index 6a0a7ba1635..3c2ab8fe5f0 100644 --- a/source/_integrations/universal.markdown +++ b/source/_integrations/universal.markdown @@ -1,11 +1,11 @@ --- title: Universal Media Player description: Instructions on how to create a universal media player in Home Assistant. -logo: home-assistant.png ha_category: - Media Player ha_release: 0.11 ha_quality_scale: internal +ha_domain: universal --- Universal Media Players combine multiple existing entities in Home Assistant into one media player entity. This is used for creating a single entity that controls an entire media center. diff --git a/source/_integrations/upc_connect.markdown b/source/_integrations/upc_connect.markdown index 7f0c928191e..bfe1d16ea61 100644 --- a/source/_integrations/upc_connect.markdown +++ b/source/_integrations/upc_connect.markdown @@ -1,12 +1,12 @@ --- title: UPC Connect Box description: Instructions on how to integrate UPC ConnectBox into Home Assistant. -logo: upc.png ha_category: - Presence Detection ha_release: 0.36 ha_codeowners: - '@pvizeli' +ha_domain: upc_connect --- The `upc_connect` platform offers presence detection by looking at connected devices to a [Connect Box](https://www.upc.ch/en/internet/learn-about-internet/) from [Liberty Global](https://www.libertyglobal.com) (also known as UPC Cablecom in Switzerland) which is an Internet provider in Switzerland, Austria and the Netherlands (under Ziggo). diff --git a/source/_integrations/upcloud.markdown b/source/_integrations/upcloud.markdown index f4fb46245d5..b92abf0662f 100644 --- a/source/_integrations/upcloud.markdown +++ b/source/_integrations/upcloud.markdown @@ -10,6 +10,7 @@ logo: upcloud.png ha_iot_class: Cloud Polling ha_codeowners: - '@scop' +ha_domain: upcloud --- The `upcloud` integration allows you to access the information about your [UpCloud](https://upcloud.com/) servers from Home Assistant. diff --git a/source/_integrations/updater.markdown b/source/_integrations/updater.markdown index aa6593e9a59..b57fe012f66 100644 --- a/source/_integrations/updater.markdown +++ b/source/_integrations/updater.markdown @@ -1,25 +1,19 @@ --- title: Updater description: Detecting when Home Assistant updates are available. -logo: home-assistant.png ha_category: - Binary Sensor ha_release: 0.8 ha_quality_scale: internal ha_codeowners: - '@home-assistant/core' +ha_domain: updater --- The `updater` binary sensor will check daily for new releases. The state will be "on" when an update is available. Otherwise, the state will be "off". The newer version, as well as the link to the release notes, are attributes of the updater. The updater integration will also collect basic information about the running Home Assistant instance and its environment. The information includes the current Home Assistant version, the time zone, Python version and operating system information. No identifiable information (i.e., IP address, GPS coordinates, etc.) will ever be collected. If you are concerned about your privacy, you are welcome to scrutinize the Python [source code](https://github.com/home-assistant/home-assistant/tree/dev/homeassistant/components/updater). -
    - -The `updater` binary sensor will wait one hour after startup until it performs the first update. For this period it will be in the state `unavailable`. After that it will check once a day for new releases. - -
    - ## Configuration This integration is by default enabled, unless you've disabled or removed the [`default_config:`](https://www.home-assistant.io/integrations/default_config/) line from your configuration. If that is the case, the following example shows you how to enable this integration manually: diff --git a/source/_integrations/upnp.markdown b/source/_integrations/upnp.markdown index 3f1ad5e288d..cdf4535bb39 100644 --- a/source/_integrations/upnp.markdown +++ b/source/_integrations/upnp.markdown @@ -10,6 +10,7 @@ ha_iot_class: Local Polling ha_config_flow: true ha_codeowners: - '@robbiet480' +ha_domain: upnp --- The `upnp` integration enables you to collect network statistics from your router such as bytes in/out and packets in/out. This information is provided by the [UPnP](https://en.wikipedia.org/wiki/Universal_Plug_and_Play)/[Internet Gateway Device (IGD) Protocol](https://en.wikipedia.org/wiki/Internet_Gateway_Device_Protocol) if enabled on your router. diff --git a/source/_integrations/uptime.markdown b/source/_integrations/uptime.markdown index cb958e0d7da..105953348bc 100644 --- a/source/_integrations/uptime.markdown +++ b/source/_integrations/uptime.markdown @@ -4,9 +4,9 @@ description: Instructions on how to integrate an uptime sensor into Home Assista ha_category: - Utility ha_iot_class: Local Push -logo: home-assistant.png ha_release: 0.56 ha_quality_scale: internal +ha_domain: uptime --- The `uptime` sensor platform displays the time since the last Home Assistant restart. diff --git a/source/_integrations/uptimerobot.markdown b/source/_integrations/uptimerobot.markdown index b36465b53fd..d18b4cf82ea 100644 --- a/source/_integrations/uptimerobot.markdown +++ b/source/_integrations/uptimerobot.markdown @@ -8,6 +8,7 @@ ha_release: 0.72 ha_iot_class: Cloud Polling ha_codeowners: - '@ludeeus' +ha_domain: uptimerobot --- The `uptimerobot` binary sensor platform allows you get the status for all of your monitors from your account on [Uptime Robot]( https://uptimerobot.com). diff --git a/source/_integrations/uscis.markdown b/source/_integrations/uscis.markdown index 5aecd9650a1..d44a345b295 100644 --- a/source/_integrations/uscis.markdown +++ b/source/_integrations/uscis.markdown @@ -1,11 +1,11 @@ --- title: U.S. Citizenship and Immigration Services (USCIS) description: Instructions on how to set up USCIS within Home Assistant. -logo: uscis.png ha_category: - Sensor ha_release: 0.68 ha_iot_class: Cloud Polling +ha_domain: uscis --- The `uscis` sensor integration allows you get updates on your USCIS case using your case/receipt number. The sensor gets the case information from [USCIS Website]( https://egov.uscis.gov/casestatus/landing.do) diff --git a/source/_integrations/usgs_earthquakes_feed.markdown b/source/_integrations/usgs_earthquakes_feed.markdown index 7e7f878f357..49f2ae9911e 100644 --- a/source/_integrations/usgs_earthquakes_feed.markdown +++ b/source/_integrations/usgs_earthquakes_feed.markdown @@ -8,6 +8,7 @@ ha_iot_class: Cloud Polling ha_release: 0.84 ha_codeowners: - '@exxamalte' +ha_domain: usgs_earthquakes_feed --- The `usgs_earthquakes_feed` platform lets you integrate a GeoJSON feed provided by the [U.S. Geological Survey](https://earthquake.usgs.gov/) with information about seismic events like earthquakes. It retrieves incidents from a feed and shows information of those incidents filtered by distance to Home Assistant's location. diff --git a/source/_integrations/utility_meter.markdown b/source/_integrations/utility_meter.markdown index c8a4b0cf95e..d64b6a80774 100644 --- a/source/_integrations/utility_meter.markdown +++ b/source/_integrations/utility_meter.markdown @@ -5,10 +5,10 @@ ha_category: - Sensor ha_release: 0.87 ha_iot_class: Local Push -logo: energy_meter.png ha_quality_scale: internal ha_codeowners: - '@dgomes' +ha_domain: utility_meter --- The `utility meter` integration provides functionality to track consumptions of various utilities (e.g., energy, gas, water, heating). @@ -18,7 +18,7 @@ From a user perspective, utility meters operate in cycles (usually monthly) for Some utility providers have different tariffs according to time/resource availability/etc. The utility meter enables you to define the various tariffs supported by your utility provider and accounts your consumptions in accordance. When tariffs are defined a new entity will show up indicating the current tariff. In order to change the tariff, the user must call a service, usually through an automation that can be based in time or other external source (eg. a REST sensor).
    -Sensors created with this integration are persistent, so values are retained across restarts of Home Assistant. The first cycle for each sensor, will be incomplete; a sensor tracking daily usage, will start to be accurate the next day after the integration was activated. A sensor tracking monthly usage, will present accurate data starting the first of the next month after being added to Home Assistant. +Sensors created with this integration are persistent, so values are retained across restarts of Home Assistant. The first cycle for each sensor will be incomplete; a sensor tracking daily usage will start to be accurate the next day after the integration was activated. A sensor tracking monthly usage will present accurate data starting the first of the next month after being added to Home Assistant.
    ## Configuration @@ -83,7 +83,7 @@ Reset the Utility Meter. All sensors tracking tariffs will be reset to 0. ### Service `utility_meter.next_tariff` Change the current tariff to the next in the list. -This service must be called by the user for the tariff switching logic to occur (e.g. using an automation) +This service must be called by the user for the tariff switching logic to occur (e.g., using an automation) | Service data attribute | Optional | Description | | ---------------------- | -------- | ----------- | @@ -92,7 +92,7 @@ This service must be called by the user for the tariff switching logic to occur ### Service `utility_meter.select_tariff` Change the current tariff to the given tariff. -This service must be called by the user for the tariff switching logic to occur (e.g. using an automation) +This service must be called by the user for the tariff switching logic to occur (e.g., using an automation) | Service data attribute | Optional | Description | | ---------------------- | -------- | ----------- | diff --git a/source/_integrations/uvc.markdown b/source/_integrations/uvc.markdown index 44d02b547dd..c076f7ee627 100644 --- a/source/_integrations/uvc.markdown +++ b/source/_integrations/uvc.markdown @@ -6,6 +6,7 @@ ha_category: - Camera ha_release: 0.13 ha_iot_class: Local Polling +ha_domain: uvc --- The `uvc` camera platform allows you to integrate [UniFi Video Camera (UVC)](https://www.ubnt.com/products/#unifivideo) into Home Assistant. diff --git a/source/_integrations/vacuum.markdown b/source/_integrations/vacuum.markdown index 891f0995f1b..efc4e1771b9 100644 --- a/source/_integrations/vacuum.markdown +++ b/source/_integrations/vacuum.markdown @@ -2,6 +2,7 @@ title: Vacuum description: Instructions on how to setup and use vacuum's in Home Assistant. ha_release: 0.51 +ha_domain: vacuum --- The `vacuum` integration enables the ability to control home cleaning robots within Home Assistant. diff --git a/source/_integrations/vacuum.mqtt.markdown b/source/_integrations/vacuum.mqtt.markdown index e7d8048fbfe..a3417ae0069 100644 --- a/source/_integrations/vacuum.mqtt.markdown +++ b/source/_integrations/vacuum.mqtt.markdown @@ -1,14 +1,14 @@ --- title: "MQTT Vacuum" description: "Instructions on how to integrate your MQTT enabled Vacuum within Home Assistant." -logo: mqtt.png ha_category: - Vacuum ha_release: 0.54 +ha_domain: mqtt --- The `mqtt` vacuum integration allows you to control your MQTT-enabled vacuum. -There are two possible message schemas - `legacy` and `state`. +There are two possible message schemas - `legacy` and `state`, chosen by setting the `schema` configuration parameter. New installations should use the `state` schema as `legacy` is deprecated and might be removed someday in the future. The `state` schema is preferred because the vacuum will then be represented as a `StateVacuumDevice` which is the preferred parent vacuum entity. @@ -29,55 +29,84 @@ vacuum: Legacy MQTT vacuum configuration section. {% configuration %} +availability_topic: + description: The MQTT topic subscribed to receive availability (online/offline) updates. + required: false + type: string +battery_level_template: + description: Defines a [template](/topics/templating/) to define the battery level of the vacuum. This is required if `battery_level_topic` is set. + required: false + type: string +battery_level_topic: + description: The MQTT topic subscribed to receive battery level values from the vacuum. + required: false + type: string +charging_template: + description: Defines a [template](/topics/templating/) to define the charging state of the vacuum. This is required if `charging_topic` is set. + required: false + type: string +charging_topic: + description: The MQTT topic subscribed to receive charging state values from the vacuum. + required: false + type: string +cleaning_template: + description: Defines a [template](/topics/templating/) to define the cleaning state of the vacuum. This is required if `cleaning_topic` is set. + required: false + type: string +cleaning_topic: + description: The MQTT topic subscribed to receive cleaning state values from the vacuum. + required: false + type: string +command_topic: + description: The MQTT topic to publish commands to control the vacuum. + required: false + type: string +docked_template: + description: Defines a [template](/topics/templating/) to define the docked state of the vacuum. This is required if `docked_topic` is set. + required: false + type: string +docked_topic: + description: The MQTT topic subscribed to receive docked state values from the vacuum. + required: false + type: string +error_template: + description: Defines a [template](/topics/templating/) to define potential error messages emitted by the vacuum. This is required if `error_topic` is set. + required: false + type: string +error_topic: + description: The MQTT topic subscribed to receive error messages from the vacuum. + required: false + type: string +fan_speed_list: + description: List of possible fan speeds for the vacuum. + required: false + type: [string, list] +fan_speed_template: + description: Defines a [template](/topics/templating/) to define the fan speed of the vacuum. This is required if `fan_speed_topic` is set. + required: false + type: string +fan_speed_topic: + description: The MQTT topic subscribed to receive fan speed values from the vacuum. + required: false + type: string +json_attributes_template: + description: "Defines a [template](/docs/configuration/templating/#processing-incoming-data) to extract the JSON dictionary from messages received on the `json_attributes_topic`. Usage example can be found in [MQTT sensor](/integrations/sensor.mqtt/#json-attributes-template-configuration) documentation." + required: false + type: template +json_attributes_topic: + description: The MQTT topic subscribed to receive a JSON dictionary payload and then set as sensor attributes. Usage example can be found in [MQTT sensor](/integrations/sensor.mqtt/#json-attributes-topic-configuration) documentation. + required: false + type: string name: description: The name of the vacuum. required: false type: string default: MQTT Vacuum -schema: - description: The schema to use. +payload_available: + description: The payload that represents the available state. required: false type: string - default: legacy -supported_features: - description: List of features that the vacuum supports (possible values are `turn_on`, `turn_off`, `pause`, `stop`, `return_home`, `battery`, `status`, `locate`, `clean_spot`, `fan_speed`, `send_command`)." - required: false - type: [string, list] - default: "`turn_on`, `turn_off`, `stop`, `return_home`, `status`, `battery`, `clean_spot`" -command_topic: - description: The MQTT topic to publish commands to control the vacuum. - required: false - type: string -qos: - description: The maximum QoS level of the state topic. - required: false - type: integer - default: 0 -retain: - description: If the published message should have the retain flag on or not. - required: false - type: boolean - default: false -payload_turn_on: - description: The payload to send to the `command_topic` to begin the cleaning cycle. - required: false - type: string - default: turn_on -payload_turn_off: - description: The payload to send to the `command_topic` to turn the vacuum off. - required: false - type: string - default: turn_off -payload_return_to_base: - description: The payload to send to the `command_topic` to tell the vacuum to return to base. - required: false - type: string - default: return_to_base -payload_stop: - description: The payload to send to the `command_topic` to stop the vacuum. - required: false - type: string - default: stop + default: online payload_clean_spot: description: The payload to send to the `command_topic` to begin a spot cleaning cycle. required: false @@ -88,93 +117,64 @@ payload_locate: required: false type: string default: locate +payload_not_available: + description: The payload that represents the unavailable state. + required: false + type: string + default: offline +payload_return_to_base: + description: The payload to send to the `command_topic` to tell the vacuum to return to base. + required: false + type: string + default: return_to_base payload_start_pause: description: The payload to send to the `command_topic` to start or pause the vacuum. required: false type: string default: start_pause -battery_level_topic: - description: The MQTT topic subscribed to receive battery level values from the vacuum. +payload_stop: + description: The payload to send to the `command_topic` to stop the vacuum. required: false type: string -battery_level_template: - description: Defines a [template](/topics/templating/) to define the battery level of the vacuum. This is required if `battery_level_topic` is set. + default: stop +payload_turn_off: + description: The payload to send to the `command_topic` to turn the vacuum off. required: false type: string -charging_topic: - description: The MQTT topic subscribed to receive charging state values from the vacuum. + default: turn_off +payload_turn_on: + description: The payload to send to the `command_topic` to begin the cleaning cycle. required: false type: string -charging_template: - description: Defines a [template](/topics/templating/) to define the charging state of the vacuum. This is required if `charging_topic` is set. + default: turn_on +qos: + description: The maximum QoS level of the state topic. + required: false + type: integer + default: 0 +retain: + description: If the published message should have the retain flag on or not. + required: false + type: boolean + default: false +schema: + description: The schema to use. Must be `legacy` or omitted to select the legacy schema". required: false type: string -cleaning_topic: - description: The MQTT topic subscribed to receive cleaning state values from the vacuum. - required: false - type: string -cleaning_template: - description: Defines a [template](/topics/templating/) to define the cleaning state of the vacuum. This is required if `cleaning_topic` is set. - required: false - type: string -docked_topic: - description: The MQTT topic subscribed to receive docked state values from the vacuum. - required: false - type: string -docked_template: - description: Defines a [template](/topics/templating/) to define the docked state of the vacuum. This is required if `docked_topic` is set. - required: false - type: string -error_topic: - description: The MQTT topic subscribed to receive error messages from the vacuum. - required: false - type: string -error_template: - description: Defines a [template](/topics/templating/) to define potential error messages emitted by the vacuum. This is required if `error_topic` is set. - required: false - type: string -fan_speed_topic: - description: The MQTT topic subscribed to receive fan speed values from the vacuum. - required: false - type: string -fan_speed_template: - description: Defines a [template](/topics/templating/) to define the fan speed of the vacuum. This is required if `fan_speed_topic` is set. + default: legacy +send_command_topic: + description: The MQTT topic to publish custom commands to the vacuum. required: false type: string set_fan_speed_topic: description: The MQTT topic to publish commands to control the vacuum's fan speed. required: false type: string -fan_speed_list: - description: List of possible fan speeds for the vacuum. +supported_features: + description: List of features that the vacuum supports (possible values are `turn_on`, `turn_off`, `pause`, `stop`, `return_home`, `battery`, `status`, `locate`, `clean_spot`, `fan_speed`, `send_command`)." required: false type: [string, list] -send_command_topic: - description: The MQTT topic to publish custom commands to the vacuum. - required: false - type: string -availability_topic: - description: The MQTT topic subscribed to receive availability (online/offline) updates. - required: false - type: string -payload_available: - description: The payload that represents the available state. - required: false - type: string - default: online -payload_not_available: - description: The payload that represents the unavailable state. - required: false - type: string - default: offline -json_attributes_topic: - description: The MQTT topic subscribed to receive a JSON dictionary payload and then set as sensor attributes. Usage example can be found in [MQTT sensor](/integrations/sensor.mqtt/#json-attributes-topic-configuration) documentation. - required: false - type: string -json_attributes_template: - description: "Defines a [template](/docs/configuration/templating/#processing-incoming-data) to extract the JSON dictionary from messages received on the `json_attributes_topic`. Usage example can be found in [MQTT sensor](/integrations/sensor.mqtt/#json-attributes-template-configuration) documentation." - required: false - type: template + default: "`turn_on`, `turn_off`, `stop`, `return_home`, `status`, `battery`, `clean_spot`" {% endconfiguration %} ### Legacy configuration example @@ -260,50 +260,36 @@ MQTT payload: State MQTT vacuum configuration section. {% configuration %} +availability_topic: + description: The MQTT topic subscribed to receive availability (online/offline) updates. + required: false + type: string +command_topic: + description: The MQTT topic to publish commands to control the vacuum. + required: false + type: string +fan_speed_list: + description: List of possible fan speeds for the vacuum. + required: false + type: [string, list] +json_attributes_template: + description: "Defines a [template](/docs/configuration/templating/#processing-incoming-data) to extract the JSON dictionary from messages received on the `json_attributes_topic`. Usage example can be found in [MQTT sensor](/integrations/sensor.mqtt/#json-attributes-template-configuration) documentation." + required: false + type: template +json_attributes_topic: + description: The MQTT topic subscribed to receive a JSON dictionary payload and then set as sensor attributes. Usage example can be found in [MQTT sensor](/integrations/sensor.mqtt/#json-attributes-topic-configuration) documentation. + required: false + type: string name: description: The name of the vacuum. required: false type: string default: MQTT Vacuum -schema: - description: The schema to use. +payload_available: + description: The payload that represents the available state. required: false type: string - default: legacy -supported_features: - description: "List of features that the vacuum supports (possible values are `start`, `stop`, `pause`, `return_home`, `battery`, `status`, `locate`, `clean_spot`, `fan_speed`, `send_command`)." - required: false - type: [string, list] - default: "`start`, `stop`, `return_home`, `status`, `battery`, `clean_spot`" -command_topic: - description: The MQTT topic to publish commands to control the vacuum. - required: false - type: string -qos: - description: The maximum QoS level of the state topic. - required: false - type: integer - default: 0 -retain: - description: If the published message should have the retain flag on or not. - required: false - type: boolean - default: false -payload_start: - description: "The payload to send to the `command_topic` to begin the cleaning cycle." - required: false - type: string - default: start -payload_stop: - description: "The payload to send to the `command_topic` to stop cleaning." - required: false - type: string - default: stop -payload_return_to_base: - description: The payload to send to the `command_topic` to tell the vacuum to return to base. - required: false - type: string - default: return_to_base + default: online payload_clean_spot: description: The payload to send to the `command_topic` to begin a spot cleaning cycle. required: false @@ -314,47 +300,65 @@ payload_locate: required: false type: string default: locate +payload_not_available: + description: The payload that represents the unavailable state. + required: false + type: string + default: offline payload_pause: description: The payload to send to the `command_topic` to pause the vacuum. required: false type: string default: pause -state_topic: - description: The MQTT topic subscribed to receive state messages from the vacuum. State topic is extracting JSON if no `value_template` is defined. +payload_return_to_base: + description: The payload to send to the `command_topic` to tell the vacuum to return to base. required: false type: string -value_template: - description: "Defines a [template](/topics/templating/) to extract possible states from the vacuum." + default: return_to_base +payload_start: + description: "The payload to send to the `command_topic` to begin the cleaning cycle." + required: false + type: string + default: start +payload_stop: + description: "The payload to send to the `command_topic` to stop cleaning." + required: false + type: string + default: stop +qos: + description: The maximum QoS level of the state topic. + required: false + type: integer + default: 0 +retain: + description: If the published message should have the retain flag on or not. + required: false + type: boolean + default: false +schema: + description: The schema to use. Must be `state` to select the state schema". + required: false + type: string + default: legacy +send_command_topic: + description: The MQTT topic to publish custom commands to the vacuum. required: false type: string set_fan_speed_topic: description: The MQTT topic to publish commands to control the vacuum's fan speed. required: false type: string -fan_speed_list: - description: List of possible fan speeds for the vacuum. +state_topic: + description: The MQTT topic subscribed to receive state messages from the vacuum. State topic is extracting JSON if no `value_template` is defined. + required: false + type: string +supported_features: + description: "List of features that the vacuum supports (possible values are `start`, `stop`, `pause`, `return_home`, `battery`, `status`, `locate`, `clean_spot`, `fan_speed`, `send_command`)." required: false type: [string, list] -send_command_topic: - description: The MQTT topic to publish custom commands to the vacuum. - required: false - type: string -availability_topic: - description: The MQTT topic subscribed to receive availability (online/offline) updates. - required: false - type: string -payload_available: - description: The payload that represents the available state. - required: false - type: string - default: online -payload_not_available: - description: The payload that represents the unavailable state. - required: false - type: string - default: offline -json_attributes_topic: - description: The MQTT topic subscribed to receive a JSON dictionary payload and then set as sensor attributes. Usage example can be found in [MQTT sensor](/integrations/sensor.mqtt/#json-attributes-topic-configuration) documentation. + default: "`start`, `stop`, `return_home`, `status`, `battery`, `clean_spot`" +value_template: + description: "Defines a [template](/topics/templating/) to extract possible states from the vacuum." required: false type: string {% endconfiguration %} diff --git a/source/_integrations/vacuum.template.markdown b/source/_integrations/vacuum.template.markdown index 5fe3ebb8ea4..4cc89d1b6f8 100644 --- a/source/_integrations/vacuum.template.markdown +++ b/source/_integrations/vacuum.template.markdown @@ -4,8 +4,8 @@ description: "Instructions how to setup Template vacuums within Home Assistant." ha_category: Vacuum ha_release: 0.96 ha_iot_class: Local Push -logo: home-assistant.png ha_quality_scale: internal +ha_domain: template --- The `template` platform creates vacuums that combine integrations and provides the diff --git a/source/_integrations/vacuum.xiaomi_miio.markdown b/source/_integrations/vacuum.xiaomi_miio.markdown index bae683ab8a3..b8a20c924d1 100644 --- a/source/_integrations/vacuum.xiaomi_miio.markdown +++ b/source/_integrations/vacuum.xiaomi_miio.markdown @@ -1,11 +1,11 @@ --- title: "Xiaomi Mi Robot Vacuum" description: "Instructions on how to integrate your Xiaomi Mi Robot Vacuum within Home Assistant." -logo: xiaomi.png ha_category: - Vacuum ha_release: 0.51 ha_iot_class: Local Polling +ha_domain: xiaomi_miio --- The `xiaomi_miio` vacuum platform allows you to control the state of your [Xiaomi Mi Robot Vacuum](https://www.mi.com/roomrobot/). diff --git a/source/_integrations/vallox.markdown b/source/_integrations/vallox.markdown index 14da1096117..d67e96d2273 100644 --- a/source/_integrations/vallox.markdown +++ b/source/_integrations/vallox.markdown @@ -1,12 +1,12 @@ --- title: Valloxs description: Instructions on how to integrate Vallox ventilation units into Home Assistant. -logo: vallox.png ha_category: - Fan - Sensor ha_release: 0.96 ha_iot_class: Local Polling +ha_domain: vallox --- The `vallox` integration lets you control any Vallox ventilation unit that is supported by the [vallox_websocket_api](https://github.com/yozik04/vallox_websocket_api) (follow the link for a list of supported units). diff --git a/source/_integrations/vasttrafik.markdown b/source/_integrations/vasttrafik.markdown index d74232f47c0..5a93e80ea4a 100644 --- a/source/_integrations/vasttrafik.markdown +++ b/source/_integrations/vasttrafik.markdown @@ -6,6 +6,7 @@ ha_category: - Transport ha_iot_class: Cloud Polling ha_release: '0.30' +ha_domain: vasttrafik --- The `vasttrafik` sensor will provide you traveling details for the larger Göteborg area in Sweden from the [Västtrafik](https://vasttrafik.se/) public transportation service. diff --git a/source/_integrations/velbus.markdown b/source/_integrations/velbus.markdown index acd515fb6b2..fbc73816bde 100644 --- a/source/_integrations/velbus.markdown +++ b/source/_integrations/velbus.markdown @@ -15,6 +15,7 @@ ha_config_flow: true ha_codeowners: - '@Cereal2nd' - '@brefra' +ha_domain: velbus --- The `velbus` integration is used to control [Velbus](https://www.velbus.eu/?lang=en) modules. It supports the Velbus USB, Velbus serial and a TCP/IP gateway. diff --git a/source/_integrations/velux.markdown b/source/_integrations/velux.markdown index f39209275db..c25eaac9adf 100644 --- a/source/_integrations/velux.markdown +++ b/source/_integrations/velux.markdown @@ -9,6 +9,7 @@ ha_release: 0.49 ha_iot_class: Local Polling ha_codeowners: - '@Julius2342' +ha_domain: velux --- [Velux](https://www.velux.com/) integration for Home Assistant allows you to connect to a Velux KLF 200 interface, to control [io-homecontrol](http://www.io-homecontrol.com) devices like windows and blinds. The module allows you to start scenes configured within KLF 200. diff --git a/source/_integrations/venstar.markdown b/source/_integrations/venstar.markdown index 56e8e220074..d1793746f85 100644 --- a/source/_integrations/venstar.markdown +++ b/source/_integrations/venstar.markdown @@ -6,6 +6,7 @@ ha_category: - Climate ha_release: 0.62 ha_iot_class: Local Polling +ha_domain: venstar --- The `venstar` climate platform allows you to control [Venstar](https://www.venstar.com/) thermostats from Home Assistant. diff --git a/source/_integrations/vera.markdown b/source/_integrations/vera.markdown index c5038161d69..25a14b4cccd 100644 --- a/source/_integrations/vera.markdown +++ b/source/_integrations/vera.markdown @@ -13,6 +13,7 @@ ha_category: - Switch - Climate ha_release: pre 0.7 +ha_domain: vera --- The [Vera](https://getvera.com/) hub is a controller mainly for connecting to Z-Wave devices. diff --git a/source/_integrations/verisure.markdown b/source/_integrations/verisure.markdown index e6cb3bebcb7..d16d01e6af1 100644 --- a/source/_integrations/verisure.markdown +++ b/source/_integrations/verisure.markdown @@ -12,6 +12,7 @@ ha_category: - Switch ha_release: pre 0.7 ha_iot_class: Cloud Polling +ha_domain: verisure --- Home Assistant has support to integrate your [Verisure](https://www.verisure.com/) devices. diff --git a/source/_integrations/versasense.markdown b/source/_integrations/versasense.markdown index 0add4a8ec1e..e41461bd51e 100644 --- a/source/_integrations/versasense.markdown +++ b/source/_integrations/versasense.markdown @@ -2,7 +2,6 @@ title: VersaSense description: Integrate your VersaSense MicroPnP devices. date: 2019-11-19 14:00 -logo: versasense.png ha_release: 0.103 ha_category: - Hub @@ -11,6 +10,7 @@ ha_category: ha_iot_class: Local Polling ha_codeowners: - '@flamm3blemuff1n' +ha_domain: versasense --- The `VersaSense` integration supports the VersaSense Edge Gateway. The gateway is able to control hubs and their peripherals (sensors and actuators) in the mesh network. diff --git a/source/_integrations/version.markdown b/source/_integrations/version.markdown index cfe399ea2e5..b0cb092b89e 100644 --- a/source/_integrations/version.markdown +++ b/source/_integrations/version.markdown @@ -4,11 +4,11 @@ description: Instructions on how to integrate a version sensor into Home Assista ha_category: - Utility ha_iot_class: Local Push -logo: home-assistant.png ha_release: 0.52 ha_quality_scale: internal ha_codeowners: - '@fabaff' +ha_domain: version --- The `version` sensor platform that can display the current Home Assistant versions. diff --git a/source/_integrations/vesync.markdown b/source/_integrations/vesync.markdown index a6d9071b0aa..e954274312e 100644 --- a/source/_integrations/vesync.markdown +++ b/source/_integrations/vesync.markdown @@ -1,7 +1,6 @@ --- title: Etekcity VeSync description: Instructions on how to set up Etekcity VeSync switches and outlets within Home Assistant. -logo: vesync.png ha_category: - Switch ha_release: 0.66 @@ -9,6 +8,7 @@ ha_config_flow: true ha_codeowners: - '@markperdue' - '@webdjoe' +ha_domain: vesync --- The `vesync` integration enables you to control Etekcity smart switches and outlets connected to the VeSync App. diff --git a/source/_integrations/viaggiatreno.markdown b/source/_integrations/viaggiatreno.markdown index b2548ee731e..963f24bf50e 100644 --- a/source/_integrations/viaggiatreno.markdown +++ b/source/_integrations/viaggiatreno.markdown @@ -1,11 +1,11 @@ --- title: Trenitalia ViaggiaTreno description: Instructions on how to integrate Italian Railroads data (from ViaggiaTreno API) into Home Assistant. -logo: train.png ha_category: - Transport ha_iot_class: Cloud Polling ha_release: 0.58 +ha_domain: viaggiatreno --- The `viaggiatreno` sensor will give you information about configured train ids and stations using the public [ViaggiaTreno](http://viaggiatreno.it) API. diff --git a/source/_integrations/vicare.markdown b/source/_integrations/vicare.markdown index 4a43f2a6e06..075ad9406b5 100644 --- a/source/_integrations/vicare.markdown +++ b/source/_integrations/vicare.markdown @@ -7,6 +7,7 @@ ha_release: 0.99 ha_iot_class: Cloud Polling ha_codeowners: - '@oischinger' +ha_domain: vicare --- The `ViCare` integration lets you control [Viessmann](https://www.viessmann.com) devices via the Viessmann ViCare (REST) API. diff --git a/source/_integrations/vilfo.markdown b/source/_integrations/vilfo.markdown index 18a52ee2694..1f29efe5531 100644 --- a/source/_integrations/vilfo.markdown +++ b/source/_integrations/vilfo.markdown @@ -1,16 +1,16 @@ --- -title: "Vilfo Router" -description: "Instructions on how to integrate a Vilfo Router into Home Assistant." -logo: vilfo.png -ha_release: "0.106" +title: Vilfo Router +description: Instructions on how to integrate a Vilfo Router into Home Assistant. +ha_release: '0.106' ha_category: - - Network - - System Monitor - - Sensor -ha_iot_class: "Local Polling" + - Network + - System Monitor + - Sensor +ha_iot_class: Local Polling ha_config_flow: true ha_codeowners: - '@ManneW' +ha_domain: vilfo --- The `Vilfo Router` integration allows you to observe the state of your [Vilfo Router](https://www.vilfo.com) from Home Assistant. diff --git a/source/_integrations/vivotek.markdown b/source/_integrations/vivotek.markdown index af3b7bff23b..e2328235de8 100644 --- a/source/_integrations/vivotek.markdown +++ b/source/_integrations/vivotek.markdown @@ -1,13 +1,13 @@ --- -title: Vivotek +title: VIVOTEK description: Instructions on how to integrate VIVOTEK cameras within Home Assistant. ha_category: - Camera -logo: vivotek.jpg ha_release: 0.99 ha_iot_class: Local Polling ha_codeowners: - '@HarlemSquirrel' +ha_domain: vivotek --- The `vivotek` camera platform allows you to integrate a VIVOTEK IP camera into Home Assistant. diff --git a/source/_integrations/vizio.markdown b/source/_integrations/vizio.markdown index 780d0cddc80..a80f4fd314b 100644 --- a/source/_integrations/vizio.markdown +++ b/source/_integrations/vizio.markdown @@ -1,23 +1,31 @@ --- -title: Vizio SmartCast TV +title: Vizio SmartCast description: Instructions on how to integrate Vizio SmartCast TVs and sound bars into Home Assistant. -logo: vizio-smartcast.png ha_category: - Media Player ha_release: 0.49 ha_iot_class: Local Polling ha_config_flow: true +ha_quality_scale: platinum ha_codeowners: - '@raman325' +ha_quality_scale: platinum +ha_domain: vizio --- The `vizio` integration allows you to control [SmartCast](https://www.vizio.com/smartcast-app)-compatible TVs and sound bars (2016+ models). ## Find your device -### Install pyvizio locally +If `zeroconf` discovery is enabled, your device will get discovered automatically. To discover your device manually, read the subsections below. -> NOTE: If the `pip3` command is not found, try `pip` instead +### Install `pyvizio` locally + +
    + +If the `pip3` command is not found, try `pip` instead + +
    - To install, run `pip3 install pyvizio` in your terminal. - If `pyvizio` is already installed locally, make sure you are using the latest version by running `pip3 install --upgrade pyvizio` in your terminal. @@ -25,17 +33,43 @@ The `vizio` integration allows you to control [SmartCast](https://www.vizio.com/ ### Discover devices Find your device using the following command: + ```bash -$ pyvizio --ip=0 discover +pyvizio --ip=0 discover ``` -and note its IP address and port number. If you have trouble finding a device you were expecting to, you can try increasing the discovery timeout period by adding the `--timeout` option (e.g. `pyvizio --ip=0 discover --timeout=10`). +Write down its IP address and port number. If you have trouble finding a device you were expecting to, you can try increasing the discovery timeout period by adding the `--timeout` option (e.g., `pyvizio --ip=0 discover --timeout=10`). ## Pairing -Before adding your device to Home Assistant, you may need to pair it manually. In particular, it is unclear how a sound bar would notify you of a valid auth token. In this case, it might be best to first skip the pairing process entirely, specify a `device_class` of `speaker` in your configuration, and try interacting with the entity to see if you have any success. If the media player controls aren't working, and if specifying different ports as mentioned above doesn't work, you will need to find a way to obtain the auth token during this process. +This integration requires an access token in order to communicate with TVs (speakers do not need an access token). An access token can be obtained by going through a pairing process, either manually, or through the HA frontend. -To obtain an auth token, follow these steps: +### Pair using the HA frontend + + - **Using `configuration.yaml`:** If you have a `vizio` entry in `configuration.yaml` but don't provide an access token value in your configuration, after you initialize HomeAssistant, you will see a Vizio SmartCast device ready to be configured. When you open the configuration window, you will be guided through the pairing process. While HA will store the access token for the life of your `vizio` entity, it is a good idea to note the access token value displayed in the window and add it to your `configuration.yaml`. This will ensure that you will not have to go through the pairing process again in the future if you decide to rebuild your HA instance. +- **Using discovery or manual setup through the Integrations menu:** To initiate the pairing process, submit your initial configuration with an empty Access Token value. + +### Pair manually using the CLI + +The following script, written by [JeffLIrion](https://github.com/JeffLIrion) can be run to obtain an auth token. You will need to replace `` with your IP and `` (which is typically 7345 or 9000). + +```bash +#!/bin/bash + +VIZIO_IP="" +VIZIO_PORT="" + +curl -k -H "Content-Type: application/json" -X PUT -d '{"DEVICE_ID":"pyvizio","DEVICE_NAME":"Python Vizio"}' https://${VIZIO_IP}:${VIZIO_PORT}/pairing/start + +read -p "PIN: " VIZIO_PIN +read -p "PAIRING_REQ_TOKEN: " VIZIO_PAIRING_REQ_TOKEN + +curl -k -H "Content-Type: application/json" -X PUT -d '{"DEVICE_ID": "pyvizio","CHALLENGE_TYPE": 1,"RESPONSE_VALUE": "'"${VIZIO_PIN}"'","PAIRING_REQ_TOKEN": '"${VIZIO_PAIRING_REQ_TOKEN}"'}' https://${VIZIO_IP}:${VIZIO_PORT}/pairing/pair +``` + +### Pair manually using `pyvizio` + +To obtain an auth token manually, follow these steps: Make sure that your device is on before continuing. @@ -47,20 +81,20 @@ Make sure that your device is on before continuing. Enter the following command to initiate pairing: ```bash -$ pyvizio --ip={ip:port} --device_type={device_type} pair +pyvizio --ip={ip:port} --device_type={device_type} pair ``` Initiation will show you two different values: | Value | Description | | :-------------- | :------------------------------------------------------------------------------------------------------ | -| Challenge type | Usually it should be `"1"`. If not, use the additional parameter `--ch_type=your_type` in the next step | +| Challenge type | Usually, it should be `"1"`. | | Challenge token | Token required to finalize pairing in the next step | At this point, a PIN code should be displayed at the top of your TV. With all these values, you can now finish pairing: ```bash -$ pyvizio --ip={ip:port} --device_type={device_type} pair-finish --token={challenge_token} --pin={pin} +pyvizio --ip={ip:port} --device_type={device_type} pair-finish --token={challenge_token} --pin={pin} --ch_type={challenge_type} ``` You will need the authentication token returned by this command to configure Home Assistant. @@ -87,11 +121,11 @@ name: type: string default: Vizio SmartCast access_token: - description: Authentication token you received in the last step of the pairing process (if applicable). + description: Authentication token you received in the last step of the pairing process. This token is only needed if your device is a TV, and you can opt not to provide it in your configuration and instead go through the pairing process via the HA frontend. required: false type: string device_class: - description: The class of your device. Valid options are `tv` or `speaker` + description: The class of your device. Valid options are `tv` or `speaker`. required: false type: string default: tv @@ -100,8 +134,65 @@ volume_step: required: false type: integer default: 1 +apps: + description: Use this section to define app specific settings (only applicable for Vizio Smart TVs). + required: false + type: map + keys: + include: + description: List of apps to include in the source list. Cannot be used in combination with `exclude`. + required: exclusive + type: list + exclude: + description: List of apps to exclude from the source list. Cannot be used in combination with `include`. + required: exclusive + type: list + additional_configs: + description: List of manually configured apps that aren't available in the default app list provided by the integration. + required: false + type: map + keys: + name: + description: The name of the app that will be used in the source list and used to launch the app. + required: true + type: string + config: + description: The app configuration that will be used to detect and launch the app. + required: true + type: map + keys: + APP_ID: + description: See [Obtaining an app configuration](#obtaining-an-app-configuration) section below. + required: true + type: string + NAME_SPACE: + description: See [Obtaining an app configuration](#obtaining-an-app-configuration) section below. + required: true + type: integer + MESSAGE: + description: See [Obtaining an app configuration](#obtaining-an-app-configuration) section below. + required: false + type: string + default: null {% endconfiguration %} +### Obtaining an app configuration + +If there is an app you want to be able to launch from Home Assistant that isn't detected by default, you will need to specify the app configuration in `configuration.yaml`. In order to determine the values to specify for each configuration parameter, launch the app you want to configure on your device, and run the following command (requires `pyvizio` to be installed locally): + +```bash +pyvizio --ip={IP:PORT} get-current-app-config +``` + +`pyvizio` will return the value of the three parameters (`APP_ID`, `NAME_SPACE`, `MESSAGE`) for the currently running app which you can then include in your configuration. + +### Obtaining a list of valid apps to include or exclude +To get the list of apps that can be excluded or included, run the following command (requires `pyvizio` to be installed locally): + +```bash +pyvizio --ip=0 get-apps-list +``` + ## Notes and limitations ### Turning device on @@ -111,7 +202,3 @@ If the `Power Mode` of your device is set to `Eco Mode`, turning the device on w ### Changing tracks Changing tracks works like switching channels. If the current input is anything other than regular TV, this command might not do anything. - -### Sources - -The source list shows all external devices connected to the Vizio device through HDMI, plus a list of internal devices (TV mode, Chromecast, etc.) diff --git a/source/_integrations/vlc.markdown b/source/_integrations/vlc.markdown index 4c9b005d704..7d650229650 100644 --- a/source/_integrations/vlc.markdown +++ b/source/_integrations/vlc.markdown @@ -1,11 +1,11 @@ --- title: VLC media player description: Instructions on how to integrate VLC media player into Home Assistant. -logo: videolan.png ha_category: - Media Player ha_release: 0.35 ha_iot_class: Local Polling +ha_domain: vlc --- The `vlc` platform allows you to control [VLC media player](https://www.videolan.org/vlc/index.html). diff --git a/source/_integrations/vlc_telnet.markdown b/source/_integrations/vlc_telnet.markdown index 2847a27216d..38155b14643 100644 --- a/source/_integrations/vlc_telnet.markdown +++ b/source/_integrations/vlc_telnet.markdown @@ -1,13 +1,13 @@ --- title: VLC media player Telnet description: Instructions on how to integrate VLC media player into Home Assistant using the telnet interface. -logo: videolan.png ha_category: - Media Player ha_release: 0.95 ha_iot_class: Local Polling ha_codeowners: - '@rodripf' +ha_domain: vlc_telnet --- The `vlc_telnet` platform allows you to control a [VLC media player](https://www.videolan.org/vlc/index.html) using the built in telnet interface. diff --git a/source/_integrations/voicerss.markdown b/source/_integrations/voicerss.markdown index e7e5ae6de13..92e07b85c8a 100644 --- a/source/_integrations/voicerss.markdown +++ b/source/_integrations/voicerss.markdown @@ -5,6 +5,7 @@ logo: voicerss.png ha_category: - Text-to-speech ha_release: 0.35 +ha_domain: voicerss --- The `voicerss` text-to-speech platform uses [VoiceRSS](http://www.voicerss.org/) Text-to-Speech engine to read a text with natural sounding voices. diff --git a/source/_integrations/volkszaehler.markdown b/source/_integrations/volkszaehler.markdown index 43449b37e56..7c194d7d48d 100644 --- a/source/_integrations/volkszaehler.markdown +++ b/source/_integrations/volkszaehler.markdown @@ -6,6 +6,7 @@ ha_category: - System Monitor ha_iot_class: Local Polling ha_release: 0.78 +ha_domain: volkszaehler --- The `volkszaehler` sensor platform is consuming the system information provided by the [Volkszaehler](https://wiki.volkszaehler.org/) API. diff --git a/source/_integrations/volumio.markdown b/source/_integrations/volumio.markdown index c68dfc19620..30ae1f073a0 100644 --- a/source/_integrations/volumio.markdown +++ b/source/_integrations/volumio.markdown @@ -5,6 +5,7 @@ logo: volumio.png ha_category: - Media Player ha_release: 0.41 +ha_domain: volumio --- The `Volumio` platform allows you to control a [Volumio](https://volumio.org/) media player from Home Assistant. diff --git a/source/_integrations/volvooncall.markdown b/source/_integrations/volvooncall.markdown index fafa1d1f6e4..e6f31e399f6 100644 --- a/source/_integrations/volvooncall.markdown +++ b/source/_integrations/volvooncall.markdown @@ -1,11 +1,11 @@ --- title: Volvo On Call description: Instructions for how to integrate Volvo On Call into Home Assistant. -logo: volvo.png ha_category: - Car ha_release: 0.39 ha_iot_class: Cloud Polling +ha_domain: volvooncall --- The `volvooncall` integration offers integration with the [Volvo On Call](https://www.volvocars.com/intl/why-volvo/human-innovation/future-of-driving/connectivity/volvo-on-call) cloud service and offers presence detection as well as sensors such as odometer and fuel level. diff --git a/source/_integrations/vultr.markdown b/source/_integrations/vultr.markdown index 850504af798..2a5e99e0a74 100644 --- a/source/_integrations/vultr.markdown +++ b/source/_integrations/vultr.markdown @@ -9,6 +9,7 @@ ha_category: ha_release: 0.58 logo: vultr.png ha_iot_class: Cloud Polling +ha_domain: vultr --- The `vultr` integration allows you to access information about and interact with your [Vultr](https://www.vultr.com) subscriptions (Virtual Private Servers) from Home Assistant. diff --git a/source/_integrations/w800rf32.markdown b/source/_integrations/w800rf32.markdown index 48f5a32457f..011855030a7 100644 --- a/source/_integrations/w800rf32.markdown +++ b/source/_integrations/w800rf32.markdown @@ -7,6 +7,7 @@ ha_category: - Binary Sensor ha_release: 0.83 ha_iot_class: Local Push +ha_domain: w800rf32 --- The `w800rf32` integration supports W800RF32 devices by [WGL Designs](http://www.wgldesigns.com/w800.html) which diff --git a/source/_integrations/wake_on_lan.markdown b/source/_integrations/wake_on_lan.markdown index 2082941e2b3..2b4d1a82b51 100644 --- a/source/_integrations/wake_on_lan.markdown +++ b/source/_integrations/wake_on_lan.markdown @@ -1,12 +1,12 @@ --- title: Wake on LAN description: Instructions on how to setup the Wake on LAN integration in Home Assistant. -logo: ethernet.png ha_category: - Network - Switch ha_release: 0.49 ha_iot_class: Local Push +ha_domain: wake_on_lan --- The `wake_on_lan` integration enables the ability to send _magic packets_ to [Wake on LAN](https://en.wikipedia.org/wiki/Wake-on-LAN) capable devices to turn them on. diff --git a/source/_integrations/waqi.markdown b/source/_integrations/waqi.markdown index 705324b9ba0..0cef8d20804 100644 --- a/source/_integrations/waqi.markdown +++ b/source/_integrations/waqi.markdown @@ -1,13 +1,13 @@ --- title: World Air Quality Index (WAQI) description: Instructions on how to setup World Air Quality Index sensor in Home Assistant. -logo: waqi.png ha_category: - Health ha_release: 0.34 ha_iot_class: Cloud Polling ha_codeowners: - '@andrey-git' +ha_domain: waqi --- The `waqi` sensor platform will query [World Air Quality Index](https://aqicn.org/city/beijing/) service to check AQI value for a specific set of locations. The resulting indexes will be added to the Home Assistant as sensor outputs. diff --git a/source/_integrations/water_heater.markdown b/source/_integrations/water_heater.markdown index d748f687871..99705da7977 100644 --- a/source/_integrations/water_heater.markdown +++ b/source/_integrations/water_heater.markdown @@ -2,6 +2,7 @@ title: Water Heater description: Instructions on how to setup water heater devices within Home Assistant. ha_release: 0.81 +ha_domain: water_heater --- The `water_heater` integration is built for the controlling and monitoring of hot water heaters. diff --git a/source/_integrations/waterfurnace.markdown b/source/_integrations/waterfurnace.markdown index 0042a0d5599..216aabae787 100644 --- a/source/_integrations/waterfurnace.markdown +++ b/source/_integrations/waterfurnace.markdown @@ -1,11 +1,11 @@ --- title: WaterFurnace description: Instructions on how to integrate WaterFurnace Geothermal System into Home Assistant. -logo: waterfurnace.png ha_category: - Sensor ha_release: 0.62 ha_iot_class: Cloud Polling +ha_domain: waterfurnace --- The `waterfurnace` integration communicates with the WaterFurnace Symphony website's WebSocket to show you many of the sensors in your system. While not an official API, this is the same backend the Symphony website is based on, and should be reasonably stable. diff --git a/source/_integrations/watson_iot.markdown b/source/_integrations/watson_iot.markdown index 4aca1417c5c..e20d6c57281 100644 --- a/source/_integrations/watson_iot.markdown +++ b/source/_integrations/watson_iot.markdown @@ -1,10 +1,10 @@ --- title: IBM Watson IoT Platform description: Record events in the IBM Watson IoT Platform. -logo: ibm.png ha_category: - History ha_release: 0.72 +ha_domain: watson_iot --- The `watson_iot` integration enables you to link the devices in Home Assistant diff --git a/source/_integrations/watson_tts.markdown b/source/_integrations/watson_tts.markdown index d81d3dec2d5..3795ebc7fa4 100644 --- a/source/_integrations/watson_tts.markdown +++ b/source/_integrations/watson_tts.markdown @@ -1,12 +1,12 @@ --- title: IBM Watson TTS description: Instructions on how to setup IBM Watson TTS with Home Assistant. -logo: watson_tts.png ha_category: - Text-to-speech ha_release: 0.94 ha_codeowners: - '@rutkai' +ha_domain: watson_tts --- The `watson_tts` text-to-speech platform that works with [IBM Watson Cloud](https://www.ibm.com/watson/services/text-to-speech/) to create the spoken output. diff --git a/source/_integrations/waze_travel_time.markdown b/source/_integrations/waze_travel_time.markdown index 4cc8fdf330f..640e9a7c44a 100644 --- a/source/_integrations/waze_travel_time.markdown +++ b/source/_integrations/waze_travel_time.markdown @@ -1,11 +1,11 @@ --- title: Waze Travel Time description: Instructions on how to add Waze travel time to Home Assistant. -logo: waze.png ha_category: - Transport ha_iot_class: Cloud Polling ha_release: 0.67 +ha_domain: waze_travel_time --- The `waze_travel_time` sensor provides travel time from the [Waze](https://www.waze.com/). diff --git a/source/_integrations/weather.darksky.markdown b/source/_integrations/weather.darksky.markdown index d69779f364b..49a2b403087 100644 --- a/source/_integrations/weather.darksky.markdown +++ b/source/_integrations/weather.darksky.markdown @@ -7,6 +7,7 @@ ha_category: - Weather ha_release: 0.61 ha_iot_class: Cloud Polling +ha_domain: darksky --- The `darksky` platform uses the [Dark Sky](https://darksky.net/) web service as a source for meteorological data for your location. diff --git a/source/_integrations/weather.markdown b/source/_integrations/weather.markdown index 95379a3e10a..3c74ca7b68a 100644 --- a/source/_integrations/weather.markdown +++ b/source/_integrations/weather.markdown @@ -1,13 +1,13 @@ --- title: Weather description: Instructions on how to setup your Weather platforms with Home Assistant. -logo: home-assistant.png ha_category: - Weather ha_release: 0.32 ha_quality_scale: internal ha_codeowners: - '@fabaff' +ha_domain: weather --- The `weather` platforms gather meteorological information from web services and display the conditions and other details about the weather at the given location. Read the integration documentation for your particular weather provider to learn how to set it up. diff --git a/source/_integrations/webhook.markdown b/source/_integrations/webhook.markdown index c062879b79c..fb2d4fa5ec8 100644 --- a/source/_integrations/webhook.markdown +++ b/source/_integrations/webhook.markdown @@ -1,6 +1,7 @@ --- ha_release: 0.8 title: Webhook +ha_domain: webhook --- diff --git a/source/_integrations/weblink.markdown b/source/_integrations/weblink.markdown deleted file mode 100644 index 4490ca1c980..00000000000 --- a/source/_integrations/weblink.markdown +++ /dev/null @@ -1,55 +0,0 @@ ---- -title: Weblink -description: Instructions on how to setup Links within Home Assistant. -logo: home-assistant.png -ha_category: - - Front End -ha_release: 0.13 -ha_quality_scale: internal -ha_codeowners: - - '@home-assistant/core' ---- - -The `weblink` integration allows you to display links in the Home Assistant frontend. - -
    - -The below documentation applies to the classic "States" user interface. -The `weblink` integration has been **deprecated** and pending for removal in Home Assistant 0.107.0. - -Starting with Home Assistant 0.86, Lovelace is the new default interface. For information on configuring weblinks in Lovelace please follow [these instructions](/lovelace/entities/#weblink) instead. - -
    - -## Configuration - -To use this integration in your installation, add something like the following to your `configuration.yaml` file: - -```yaml -# Example configuration.yaml entry -weblink: - entities: - - name: Router - url: http://192.168.1.1/ - - name: Home Assistant - url: https://www.home-assistant.io - - name: Grafana - url: /grafana -``` - -{% configuration %} -name: - description: Text for the link. - required: true - type: string -url: - description: The URL (absolute URL or absolute path) for the link. - required: true - type: string -icon: - description: Icon for entry. - required: false - type: icon -{% endconfiguration %} - -Pick an icon that you can find on [materialdesignicons.com](https://materialdesignicons.com/) to use for your input and prefix the name with `mdi:`. For example `mdi:car`, `mdi:ambulance`, or `mdi:motorbike`. diff --git a/source/_integrations/webostv.markdown b/source/_integrations/webostv.markdown index a23ee0e2844..3658040ee3d 100644 --- a/source/_integrations/webostv.markdown +++ b/source/_integrations/webostv.markdown @@ -9,6 +9,7 @@ ha_iot_class: Local Polling ha_release: 0.18 ha_codeowners: - '@bendavid' +ha_domain: webostv --- The `webostv` platform allows you to control a [LG](https://www.lg.com/) webOS Smart TV. @@ -135,9 +136,9 @@ To obtain complete list of available sources currently configured on the TV, onc The `play_media` service can be used in a script to switch to the specified TV channel. It selects the best matching channel according to the `media_content_id` parameter: - 1. Channel number *(i.e. '1' or '6')* - 2. Exact channel name *(i.e. 'France 2' or 'CNN')* - 3. Substring in channel name *(i.e. 'BFM' in 'BFM TV')* + 1. Channel number *(i.e., '1' or '6')* + 2. Exact channel name *(i.e., 'France 2' or 'CNN')* + 3. Substring in channel name *(i.e., 'BFM' in 'BFM TV')* ```yaml # Example action entry in script to switch to channel number 1 @@ -190,7 +191,7 @@ Available services: `button`, `command` | Service data attribute | Optional | Description | | ---------------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `entity_id` | no | Target a specific webostv media player. | -| `command` | no | Endpoint for the command, e.g. `media.controls/rewind`. The full list of known endpoints is available at | +| `command` | no | Endpoint for the command, e.g., `media.controls/rewind`. The full list of known endpoints is available at | ### Example diff --git a/source/_integrations/websocket_api.markdown b/source/_integrations/websocket_api.markdown index 0b94ef6a80c..35d004b11d3 100644 --- a/source/_integrations/websocket_api.markdown +++ b/source/_integrations/websocket_api.markdown @@ -1,13 +1,13 @@ --- title: Home Asssitant WebSocket API description: Instructions on how to setup the WebSocket API within Home Assistant. -logo: home-assistant.png ha_category: - Other ha_release: 0.34 ha_quality_scale: internal ha_codeowners: - '@home-assistant/core' +ha_domain: websocket_api --- The `websocket_api` integration set up a WebSocket API and allows one to interact with a Home Assistant instance that is running headless. This integration depends on the [`http` component](/integrations/http/). diff --git a/source/_integrations/wemo.markdown b/source/_integrations/wemo.markdown index 3762e7f78f2..ce664b6c1d8 100644 --- a/source/_integrations/wemo.markdown +++ b/source/_integrations/wemo.markdown @@ -1,7 +1,6 @@ --- title: Belkin WeMo description: Instructions on how to integrate Belkin WeMo devices into Home Assistant. -logo: belkin_wemo.png ha_category: - Hub - Binary Sensor @@ -12,6 +11,7 @@ ha_release: pre 0.7 ha_config_flow: true ha_codeowners: - '@sqldiablo' +ha_domain: wemo --- The `wemo` integration is the main integration to integrate various [Belkin WeMo](https://www.belkin.com/us/Products/home-automation/c/wemo-home-automation/) devices with Home Assistant. diff --git a/source/_integrations/whois.markdown b/source/_integrations/whois.markdown index 68515e63eb1..0d84c856c4c 100644 --- a/source/_integrations/whois.markdown +++ b/source/_integrations/whois.markdown @@ -1,11 +1,11 @@ --- title: Whois description: Instructions on how to integrate WHOIS lookup sensor within Home Assistant. -logo: icann.png ha_category: - Network ha_release: 0.57 ha_iot_class: Cloud Polling +ha_domain: whois --- The `whois` sensor platform allows you to perform daily WHOIS lookups against your owned domains. This provides you with information such as `expiration_date`, `name_servers` and `registrar` details. diff --git a/source/_integrations/wink.markdown b/source/_integrations/wink.markdown index 47b16b98913..1a203caceed 100644 --- a/source/_integrations/wink.markdown +++ b/source/_integrations/wink.markdown @@ -18,6 +18,7 @@ ha_category: featured: false ha_iot_class: Cloud Polling ha_release: pre 0.7 +ha_domain: wink --- [Wink](https://www.wink.com/) is a home automation hub that can control a whole wide range of devices on the market. Or, as they say in their own words: diff --git a/source/_integrations/wirelesstag.markdown b/source/_integrations/wirelesstag.markdown index 946b946d67b..2f43d1582e1 100644 --- a/source/_integrations/wirelesstag.markdown +++ b/source/_integrations/wirelesstag.markdown @@ -1,7 +1,6 @@ --- title: Wireless Sensor Tags description: Instructions on how to integrate your Wireless Tags sensors within Home Assistant. -logo: wirelesstag.png ha_category: - Hub - Binary Sensor @@ -9,6 +8,7 @@ ha_category: - Switch ha_iot_class: Cloud Polling and Local Push ha_release: 0.68 +ha_domain: wirelesstag --- The `wirelesstag` implementation allows you to integrate your [wirelesstag.net](https://wirelesstag.net/) sensors tags in Home Assistant. diff --git a/source/_integrations/withings.markdown b/source/_integrations/withings.markdown index 2f35973026b..6de0a2b05d0 100644 --- a/source/_integrations/withings.markdown +++ b/source/_integrations/withings.markdown @@ -1,7 +1,6 @@ --- title: Withings description: Instructions on how to integrate Withings health products within Home Assistant. -logo: withings.png ha_category: - Health - Sensor @@ -10,6 +9,7 @@ ha_iot_class: Cloud Polling ha_config_flow: true ha_codeowners: - '@vangorra' +ha_domain: withings --- The `withings` sensor platform consumes data from various health products produced by [Withings](https://www.withings.com). diff --git a/source/_integrations/wled.markdown b/source/_integrations/wled.markdown index ccf93c7c436..7a5136c68ac 100644 --- a/source/_integrations/wled.markdown +++ b/source/_integrations/wled.markdown @@ -1,7 +1,6 @@ --- title: WLED description: Instructions on how to integrate WLED with Home Assistant. -logo: wled.png ha_category: - Light - Sensor @@ -12,6 +11,7 @@ ha_config_flow: true ha_quality_scale: platinum ha_codeowners: - '@frenck' +ha_domain: wled --- [WLED](https://github.com/Aircoookie/WLED) is a fast and feature-rich diff --git a/source/_integrations/workday.markdown b/source/_integrations/workday.markdown index 33c5b66f255..a1db0001d47 100644 --- a/source/_integrations/workday.markdown +++ b/source/_integrations/workday.markdown @@ -1,7 +1,6 @@ --- title: Workday description: Steps to configure the binary workday sensor. -logo: home-assistant.png ha_category: - Utility ha_iot_class: Local Polling @@ -9,17 +8,17 @@ ha_release: 0.41 ha_quality_scale: internal ha_codeowners: - '@fabaff' +ha_domain: workday --- -The `workday` binary sensor indicates, whether the current day is a workday or not. It allows specifying, which days of the week counts as workdays and also -uses the Python module [holidays](https://pypi.python.org/pypi/holidays) to incorporate information about region-specific public holidays. +The `workday` binary sensor indicates, whether the current day is a workday or not. It allows specifying, which days of the week will count as workdays and also +uses the Python module [holidays](https://pypi.python.org/pypi/holidays) to incorporate information about region-specific public holidays. ## Setup Check the [country list](https://github.com/dr-prodigy/python-holidays#available-countries) for available province. ## Configuration - To enable the `workday` sensor in your installation, add the following to your `configuration.yaml` file: ```yaml @@ -71,26 +70,40 @@ The keyword `holiday` is used for public holidays identified by the holidays mod
    If you use the sensor for Norway (`NO`) you need to wrap `NO` in quotes or write the name in full. -Otherwise the value is evaluated as `false`. +Otherwise, the value is evaluated as `false`. If you use the sensor for Canada (`CA`) with Ontario (`ON`) as `province:` then you need to wrap `ON` in quotes. -Otherwise the value is evaluated as `true` (check the YAML documentation for further details) and the sensor will not work. +Otherwise, the value is evaluated as `true` (check the YAML documentation for further details) and the sensor will not work. + +One other thing to watch is how the `holiday` keyword is used. Your first instinct might be to add it to the `exclude` configuration, thinking that it means to skip the holidays. Actually it means to exclude the days in the holidays’ list from the workdays. So when you exclude `holiday` and a workday falls on that day, then that workday is excluded. Meaning the sensor will be off. If you want the workday flagged without regarding holidays, make sure that there is something in your `Excludes` configuration other than `holiday`.
    -## Full example +## Full examples -This examples excludes Saturdays, Sundays and holiday. Two custom holidays are added. +This example excludes Saturdays, Sundays but not a holiday. Two custom holidays are added. +Even though `sat` and `sun` was not included in `workdays` and in theory, it would not need to be excluded, but because we do not what holidays excluded, we add them so exclude would not default and skip the holidays. Therefore as the note above, 2/17/2020 in the US would still be a workday. ```yaml -# Example configuration.yaml entry +# Example 1 configuration.yaml entry +binary_sensor: + - platform: workday + country: US + workdays: [mon, tue, wed, thu, fri] + excludes: [sat, sun] +``` + +This example excludes Saturdays, Sundays and holidays. Two custom holidays are added. +The date February 24th, 2020 is a Monday but will be excluded because it was added to the `add_holiday` configuration. + +```yaml +# Example 2 configuration.yaml entry binary_sensor: - platform: workday country: DE workdays: [mon, wed, fri] excludes: [sat, sun, holiday] add_holidays: - - '2018-12-26' - - '2018-12-31' + - '2020-02-24' ``` ## Automation example diff --git a/source/_integrations/worldclock.markdown b/source/_integrations/worldclock.markdown index 5af1dadbf9a..490f7b3dc3d 100644 --- a/source/_integrations/worldclock.markdown +++ b/source/_integrations/worldclock.markdown @@ -1,7 +1,6 @@ --- title: Worldclock description: Instructions on how to integrate a Worldclock within Home Assistant. -logo: home-assistant.png ha_category: - Calendar ha_iot_class: Local Push @@ -9,6 +8,7 @@ ha_release: pre 0.7 ha_quality_scale: internal ha_codeowners: - '@fabaff' +ha_domain: worldclock --- The `worldclock` sensor platform simply displays the current time in a different time zone. diff --git a/source/_integrations/worldtidesinfo.markdown b/source/_integrations/worldtidesinfo.markdown index 3f9857275fb..341af74e66e 100644 --- a/source/_integrations/worldtidesinfo.markdown +++ b/source/_integrations/worldtidesinfo.markdown @@ -1,10 +1,10 @@ --- title: World Tides description: Instructions on how to add Tides information to Home Assistant. -logo: worldtidesinfo.png ha_category: - Environment ha_release: 0.52 +ha_domain: worldtidesinfo --- The `worldtidesinfo` sensor platform uses details from [World Tides](https://www.worldtides.info/) to provide information about the prediction for the tides for any location in the world. diff --git a/source/_integrations/worxlandroid.markdown b/source/_integrations/worxlandroid.markdown index 4448e8195fc..bbd644c901e 100644 --- a/source/_integrations/worxlandroid.markdown +++ b/source/_integrations/worxlandroid.markdown @@ -6,6 +6,7 @@ ha_category: - DIY ha_release: 0.54 ha_iot_class: Local Polling +ha_domain: worxlandroid --- The `worxlandroid` sensor platform allows you to get the current state, battery level and error status Worx Landroid WG796E.1 or WG797E. diff --git a/source/_integrations/wsdot.markdown b/source/_integrations/wsdot.markdown index fab914eb19b..958e93d3d32 100644 --- a/source/_integrations/wsdot.markdown +++ b/source/_integrations/wsdot.markdown @@ -6,6 +6,7 @@ ha_category: - Transport ha_iot_class: Cloud Polling ha_release: 0.37 +ha_domain: wsdot --- The `wsdot` sensor will give you travel time information from the [Washington State Department of Transportation (WSDOT)](https://wsdot.com/). diff --git a/source/_integrations/wunderground.markdown b/source/_integrations/wunderground.markdown index ab6c7ad725a..473d6a0dbac 100644 --- a/source/_integrations/wunderground.markdown +++ b/source/_integrations/wunderground.markdown @@ -6,6 +6,7 @@ ha_category: - Weather ha_release: 0.27 ha_iot_class: Cloud Polling +ha_domain: wunderground --- The `wunderground` platform uses [Weather Underground](https://www.wunderground.com/) as a source for current weather information. diff --git a/source/_integrations/wunderlist.markdown b/source/_integrations/wunderlist.markdown index 6c05f4db403..6fada54fe3f 100644 --- a/source/_integrations/wunderlist.markdown +++ b/source/_integrations/wunderlist.markdown @@ -5,6 +5,7 @@ logo: wunderlist.png ha_category: - Calendar ha_release: 0.84 +ha_domain: wunderlist --- The `wunderlist` integration allows you to create tasks in [Wunderlist](https://www.wunderlist.com) from Home Assistant. You can use this if you want Home Assistant to send you a task that you should not forget, e.g., Congratulate Dani. diff --git a/source/_integrations/wwlln.markdown b/source/_integrations/wwlln.markdown index ea03b75dc06..1134683fbaa 100644 --- a/source/_integrations/wwlln.markdown +++ b/source/_integrations/wwlln.markdown @@ -1,13 +1,13 @@ --- title: World Wide Lightning Location Network (WWLLN) description: Instructions on how to integrate WWLLN within Home Assistant. -logo: wwlln.jpg ha_category: Geolocation ha_release: 0.96 ha_iot_class: Cloud Polling ha_config_flow: true ha_codeowners: - '@bachya' +ha_domain: wwlln --- The `wwlln` integration displays lightning strike information from the diff --git a/source/_integrations/x10.markdown b/source/_integrations/x10.markdown index 2d17e404b2d..014419d7274 100644 --- a/source/_integrations/x10.markdown +++ b/source/_integrations/x10.markdown @@ -1,11 +1,11 @@ --- title: Heyu X10 description: Instructions on how to setup X10 devices within Home Assistant. -logo: x10.gif ha_category: - Light ha_iot_class: Local Polling ha_release: 0.25 +ha_domain: x10 --- The `x10` light platform allows you to control your X10 based lights with Home Assistant. diff --git a/source/_integrations/xbox_live.markdown b/source/_integrations/xbox_live.markdown index baca918f0ad..d47283e9259 100644 --- a/source/_integrations/xbox_live.markdown +++ b/source/_integrations/xbox_live.markdown @@ -1,13 +1,13 @@ --- title: Xbox Live description: Instructions on how to set up Xbox Live sensors in Home Assistant. -logo: xbox-live.png ha_category: - Social ha_iot_class: Cloud Polling ha_release: 0.28 ha_codeowners: - '@MartinHjelmare' +ha_domain: xbox_live --- The Xbox Live integration is able to track [Xbox](https://xbox.com/) profiles. diff --git a/source/_integrations/xeoma.markdown b/source/_integrations/xeoma.markdown index e20a853525c..ea99c6d8bd5 100644 --- a/source/_integrations/xeoma.markdown +++ b/source/_integrations/xeoma.markdown @@ -1,11 +1,11 @@ --- title: Xeoma description: Instructions on how to integrate camera video feeds from a Xeoma server in Home Assistant -logo: xeoma.png ha_category: - Camera ha_iot_class: Local Polling ha_release: 0.62 +ha_domain: xeoma --- The `Xeoma` camera platform allows you to view the video feeds from a [Xeoma](https://felenasoft.com/xeoma) video surveillance server. diff --git a/source/_integrations/xfinity.markdown b/source/_integrations/xfinity.markdown deleted file mode 100644 index 8ddd1a64277..00000000000 --- a/source/_integrations/xfinity.markdown +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: Xfinity Gateway -description: Instructions on how to integrate Xfinity Gateways into Home Assistant. -ha_category: - - Presence Detection -logo: xfinity.svg -ha_release: 0.9 -ha_iot_class: Local Polling -ha_codeowners: - - '@cisasteelersfan' ---- - -The `xfinity` device tracker platform offers presence detection by looking at connected devices to an Xfinity gateway. - -It was tested with an Xfinity Gateway model TG1682G. - -## Configuration - -To use an Xfinity Gateway in your installation, add the following to your `configuration.yaml` file: - -```yaml -# Example configuration.yaml entry -device_tracker: - - platform: xfinity -``` - -{% configuration %} -host: - description: The IP address of your router, e.g., `192.168.1.1`. - required: false - type: string - default: 10.0.0.1 -{% endconfiguration %} - -See the [device tracker integration page](/integrations/device_tracker/) for instructions how to configure the people to be tracked. diff --git a/source/_integrations/xiaomi.markdown b/source/_integrations/xiaomi.markdown index ab14375a4bd..ef038ec5fa2 100644 --- a/source/_integrations/xiaomi.markdown +++ b/source/_integrations/xiaomi.markdown @@ -1,11 +1,11 @@ --- title: Xiaomi description: Instructions on how to integrate a video feed (via FFmpeg) as a camera within Home Assistant. -logo: xiaomi.png ha_category: - Camera ha_release: 0.72 ha_iot_class: Local Polling +ha_domain: xiaomi --- The `Xiaomi` camera platform allows you to utilize Xiaomi Cameras within Home Assistant. diff --git a/source/_integrations/xiaomi_aqara.markdown b/source/_integrations/xiaomi_aqara.markdown index f5928ddfe6e..a8a66bf3a9c 100644 --- a/source/_integrations/xiaomi_aqara.markdown +++ b/source/_integrations/xiaomi_aqara.markdown @@ -1,7 +1,6 @@ --- title: Xiaomi Gateway (Aqara) description: Instructions for how to integrate the Xiaomi Gateway (Aqara) within Home Assistant. -logo: xiaomi.png ha_category: - Hub ha_release: 0.57 @@ -9,6 +8,7 @@ ha_iot_class: Local Push ha_codeowners: - '@danielhiversen' - '@syssi' +ha_domain: xiaomi_aqara --- The `xiaomi_aqara` integration allows you to integrate [Xiaomi](https://www.mi.com/en/) Aqara-compatible devices into Home Assistant. @@ -283,7 +283,7 @@ That means that Home Assistant is not getting any response from your Xiaomi gate - Find a USB-UART cable/module and connect it to your computer. - Solder 3 wires - RX, TX and GND like [here](https://cs5-3.4pda.to/14176168/IMG_20181020_201150.jpg). - Turn on the gateway (220V). - - Open a serial terminal application (e.g. PuTTY) and connect to the serial port assigned to the USB-UART module (baudrate: 115200). + - Open a serial terminal application (e.g., PuTTY) and connect to the serial port assigned to the USB-UART module (baudrate: 115200). - Wait until the gateway is booted up, connect the RX, TX and GND wires to the UART module (don't connect the Vcc (power) wire!). - You will see all the messages from the gateway. - Send the command `psm-set network open_pf 3` (the command has to end with a `CR` newline character). diff --git a/source/_integrations/xiaomi_miio.markdown b/source/_integrations/xiaomi_miio.markdown index 4f630c20309..34f5b04f5a6 100644 --- a/source/_integrations/xiaomi_miio.markdown +++ b/source/_integrations/xiaomi_miio.markdown @@ -1,7 +1,6 @@ --- title: Xiaomi miio description: Instructions how to integrate your Xiaomi Mi WiFi Repeater 2 within Home Assistant. -logo: xiaomi.png ha_category: - Presence Detection ha_iot_class: Local Polling @@ -9,6 +8,7 @@ ha_release: 0.67 ha_codeowners: - '@rytilahti' - '@syssi' +ha_domain: xiaomi_miio --- The `xiaomi_miio` device tracker platform is observing your Xiaomi Mi WiFi Repeater 2 and reporting all associated WiFi clients. diff --git a/source/_integrations/xiaomi_tv.markdown b/source/_integrations/xiaomi_tv.markdown index aa178f09453..9d4ee55efb9 100644 --- a/source/_integrations/xiaomi_tv.markdown +++ b/source/_integrations/xiaomi_tv.markdown @@ -1,13 +1,13 @@ --- title: Xiaomi TV description: Instructions on how to integrate a Xiaomi TV into Home Assistant. -logo: xiaomi.png ha_category: - Media Player ha_release: 0.64 ha_iot_class: Assumed State ha_codeowners: - '@simse' +ha_domain: xiaomi_tv --- The `xiaomi_tv` platform allows you to control a [Xiaomi TV](https://www.mi.com/en/mitv3s/65flat/). diff --git a/source/_integrations/xmpp.markdown b/source/_integrations/xmpp.markdown index b1a86c5dadc..26d93ac8c4b 100644 --- a/source/_integrations/xmpp.markdown +++ b/source/_integrations/xmpp.markdown @@ -1,13 +1,13 @@ --- title: Jabber (XMPP) description: Instructions on how to add Jabber (XMPP) notifications to Home Assistant. -logo: xmpp.png ha_category: - Notifications ha_release: pre 0.7 ha_codeowners: - '@fabaff' - '@flowolf' +ha_domain: xmpp --- The `xmpp` notification platform allows you to deliver notifications from Home Assistant to a [Jabber (XMPP)](https://xmpp.org/) account. @@ -19,7 +19,7 @@ To enable Jabber notifications in your installation, add the following to your ` ```yaml # Example configuration.yaml entry notify: - - name: NOTIFIER_NAME # e.g. jabber + - name: NOTIFIER_NAME # e.g., jabber platform: xmpp sender: YOUR_JID password: YOUR_JABBER_ACCOUNT_PASSWORD @@ -33,7 +33,7 @@ name: type: string default: notify sender: - description: "The Jabber ID (JID) that will act as origin of the messages. Add your JID including the domain, e.g. your_name@jabber.org." + description: "The Jabber ID (JID) that will act as origin of the messages. Add your JID including the domain, e.g., your_name@jabber.org." required: true type: string resource: diff --git a/source/_integrations/xs1.markdown b/source/_integrations/xs1.markdown index 77a903754f1..ad42cca52f4 100644 --- a/source/_integrations/xs1.markdown +++ b/source/_integrations/xs1.markdown @@ -1,7 +1,6 @@ --- title: EZcontrol XS1 description: Instructions on how to integrate an XS1 Gateway within Home Assistant. -logo: xs1.jpg ha_category: - Hub - Climate @@ -9,9 +8,10 @@ ha_category: - Switch ha_release: 0.88 ha_iot_class: Local Polling +ha_domain: xs1 --- -The [EZcontrol XS1](http://www.ezcontrol.de/content/view/36/28/) integration for Home Assistant allows you to observe and control devices configured on the XS1 Gateway. Please have a look at the official docs for using this gateway [Bedienungsanleitung v3.0.0.0](http://www.ezcontrol.de/support/downloads/XS1/xs1manual/Bedienungsanleitung_EZcontrol_XS1_3.0.0.0-2.pdf). +The [EZcontrol XS1](http://www.ezcontrol.de/content/view/36/28/) integration for Home Assistant allows you to observe and control devices configured on the XS1 Gateway. Please have a look at the official documentation for using this gateway [Bedienungsanleitung v3.0.0.0](http://www.ezcontrol.de/support/downloads/XS1/xs1manual/Bedienungsanleitung_EZcontrol_XS1_3.0.0.0-2.pdf). ## Configuration diff --git a/source/_integrations/yale_smart_alarm.markdown b/source/_integrations/yale_smart_alarm.markdown index c73c1b6500b..832633aed32 100644 --- a/source/_integrations/yale_smart_alarm.markdown +++ b/source/_integrations/yale_smart_alarm.markdown @@ -5,6 +5,7 @@ logo: yale.png ha_category: - Alarm ha_release: 0.78 +ha_domain: yale_smart_alarm --- The `yale_smart_alarm` platform provides connectivity with the Yale Smart Alarm systems and Smart Hub through Yale's API. diff --git a/source/_integrations/yamaha.markdown b/source/_integrations/yamaha.markdown index beb992fb2ab..4231c030500 100644 --- a/source/_integrations/yamaha.markdown +++ b/source/_integrations/yamaha.markdown @@ -5,6 +5,7 @@ logo: yamaha.png ha_category: - Media Player ha_release: 0.16 +ha_domain: yamaha --- The `yamaha` platform allows you to control [Yamaha Network Receivers](https://usa.yamaha.com/products/audio-visual/av-receivers-amps/rx) from Home Assistant. diff --git a/source/_integrations/yamaha_musiccast.markdown b/source/_integrations/yamaha_musiccast.markdown index 8a6efb548a3..68afcada03e 100644 --- a/source/_integrations/yamaha_musiccast.markdown +++ b/source/_integrations/yamaha_musiccast.markdown @@ -7,6 +7,7 @@ ha_category: ha_release: 0.53 ha_codeowners: - '@jalmeroth' +ha_domain: yamaha_musiccast --- The `yamaha_musiccast` platform allows you to control [Yamaha MusicCast Receivers](https://usa.yamaha.com/products/audio_visual/hifi_components/index.html) from Home Assistant. diff --git a/source/_integrations/yandex_transport.markdown b/source/_integrations/yandex_transport.markdown index 6381d1efd4e..30b3ad55199 100644 --- a/source/_integrations/yandex_transport.markdown +++ b/source/_integrations/yandex_transport.markdown @@ -8,6 +8,7 @@ ha_category: ha_release: '0.100' ha_codeowners: - '@rishatik92' +ha_domain: yandex_transport --- The `yandex_tranport` sensor platform uses [Yandex Maps](https://maps.yandex.ru/) it will give you the time until the next departure time from a bus/tramway/etc stop. diff --git a/source/_integrations/yandextts.markdown b/source/_integrations/yandextts.markdown index a5262fc60e0..e6669e78709 100644 --- a/source/_integrations/yandextts.markdown +++ b/source/_integrations/yandextts.markdown @@ -5,6 +5,7 @@ logo: yandex.png ha_category: - Text-to-speech ha_release: 0.36 +ha_domain: yandextts --- The `yandextts` text-to-speech platform uses [Yandex SpeechKit](https://tech.yandex.com/speechkit/) Text-to-Speech engine to read a text with natural sounding voices. diff --git a/source/_integrations/yeelight.markdown b/source/_integrations/yeelight.markdown index 5d11ed4014b..6ff7f6258ae 100644 --- a/source/_integrations/yeelight.markdown +++ b/source/_integrations/yeelight.markdown @@ -9,6 +9,7 @@ ha_iot_class: Local Polling ha_codeowners: - '@rytilahti' - '@zewelor' +ha_domain: yeelight --- The `yeelight` integration allows you to control your Yeelight Wi-Fi bulbs with Home Assistant. There are two possible methods for configuration of the Yeelight: Manual or Automatic. diff --git a/source/_integrations/yeelightsunflower.markdown b/source/_integrations/yeelightsunflower.markdown index 0c7440df4fa..aee48a0bbdb 100644 --- a/source/_integrations/yeelightsunflower.markdown +++ b/source/_integrations/yeelightsunflower.markdown @@ -8,6 +8,7 @@ ha_release: 0.39 ha_iot_class: Local Polling ha_codeowners: - '@lindsaymarkward' +ha_domain: yeelightsunflower --- The `yeelightsunflower` light platform allows you to control your Yeelight Sunflower light bulbs with Home Assistant. diff --git a/source/_integrations/yessssms.markdown b/source/_integrations/yessssms.markdown index fe7e1304200..a41bac51895 100644 --- a/source/_integrations/yessssms.markdown +++ b/source/_integrations/yessssms.markdown @@ -1,12 +1,12 @@ --- title: yesss! SMS description: Instructions on how to add Yesss-SMS notifications to Home Assistant. -logo: yesssat.png ha_category: - Notifications ha_release: 0.57 ha_codeowners: - '@flowolf' +ha_domain: yessssms --- The `yessssms` platform is using the Austrian mobile operator [Yesss.at](https://yesss.at) and others to send SMS via their web-site. diff --git a/source/_integrations/yi.markdown b/source/_integrations/yi.markdown index 0a1e6a9fd74..856320725df 100644 --- a/source/_integrations/yi.markdown +++ b/source/_integrations/yi.markdown @@ -1,13 +1,13 @@ --- title: Yi Home Cameras description: Instructions on how to integrate a video feed (via FFmpeg) as a camera within Home Assistant. -logo: yi.png ha_category: - Camera ha_release: 0.56 ha_iot_class: Local Polling ha_codeowners: - '@bachya' +ha_domain: yi --- The `yi` camera platform allows you to utilize [Yi Home Cameras](https://www.yitechnology.com/) within Home Assistant. Specifically, this platform supports the line of Yi Home Cameras that are based on the Hi3518e Chipset. This includes: diff --git a/source/_integrations/yr.markdown b/source/_integrations/yr.markdown index a3a8398d830..6c3151563ea 100644 --- a/source/_integrations/yr.markdown +++ b/source/_integrations/yr.markdown @@ -8,6 +8,7 @@ ha_release: 0.11 ha_iot_class: Cloud Polling ha_codeowners: - '@danielhiversen' +ha_domain: yr --- The `yr` platform uses [YR.no](https://www.yr.no/) as a source for current diff --git a/source/_integrations/yweather.markdown b/source/_integrations/yweather.markdown index ef9b69df738..d7f9d87af71 100644 --- a/source/_integrations/yweather.markdown +++ b/source/_integrations/yweather.markdown @@ -1,12 +1,12 @@ --- title: Yahoo Weather description: Instructions on how to integrate Yahoo Weather within Home Assistant. -logo: yahooweather.png ha_category: - Weather - Sensor ha_release: 0.24 ha_iot_class: Cloud Polling +ha_domain: yweather ---
    diff --git a/source/_integrations/zabbix.markdown b/source/_integrations/zabbix.markdown index 20470892bbf..4f581f386a4 100644 --- a/source/_integrations/zabbix.markdown +++ b/source/_integrations/zabbix.markdown @@ -7,6 +7,7 @@ ha_category: - Sensor ha_release: 0.37 ha_iot_class: Local Polling +ha_domain: zabbix --- The `zabbix` integration is the main integration to connect to a [Zabbix](https://www.zabbix.com/) monitoring instance via the Zabbix API. diff --git a/source/_integrations/zamg.markdown b/source/_integrations/zamg.markdown index a1e452ac792..5e9ff97c481 100644 --- a/source/_integrations/zamg.markdown +++ b/source/_integrations/zamg.markdown @@ -7,6 +7,7 @@ ha_category: - Sensor ha_release: 0.35 ha_iot_class: Cloud Polling +ha_domain: zamg --- The `zamg` platform uses meteorological details published by the Austrian weather service [Zentralanstalt für Meteorologie und Geodynamik (ZAMG)](https://www.zamg.ac.at). diff --git a/source/_integrations/zengge.markdown b/source/_integrations/zengge.markdown index 3f7b42de092..680eca6e963 100644 --- a/source/_integrations/zengge.markdown +++ b/source/_integrations/zengge.markdown @@ -1,11 +1,11 @@ --- title: Zengge description: Instructions on how to integrate Zengge Bluetooth bulbs into Home Assistant. -logo: zengge.png ha_category: - Light ha_iot_class: Local Polling ha_release: 0.36 +ha_domain: zengge --- The `zengge` platform allows you to integrate your [Zengge Bluetooth bulbs](http://www.zengge.com/) into Home Assistant. diff --git a/source/_integrations/zeroconf.markdown b/source/_integrations/zeroconf.markdown index 6406826de28..cb95e551435 100644 --- a/source/_integrations/zeroconf.markdown +++ b/source/_integrations/zeroconf.markdown @@ -4,11 +4,11 @@ description: Exposes Home Assistant using the Zeroconf protocol. ha_category: - Network ha_release: 0.18 -logo: home-assistant.png ha_quality_scale: internal ha_codeowners: - '@robbiet480' - '@Kane610' +ha_domain: zeroconf --- The `zeroconf` integration will scan the network for supported devices and services. Discovered integrations will show up in the discovered section on the integrations page in the configuration panel. It will also make Home Assistant discoverable for other services in the network. Zeroconf is also sometimes known as Bonjour, Rendezvous, and Avahi. diff --git a/source/_integrations/zestimate.markdown b/source/_integrations/zestimate.markdown index affd98a54c3..c0d7f2e1f72 100644 --- a/source/_integrations/zestimate.markdown +++ b/source/_integrations/zestimate.markdown @@ -3,9 +3,9 @@ title: Zestimate description: Instructions on how to integrate the Zestimate sensor into Home Assistant. ha_category: - Sensor -logo: zillow.png ha_release: 0.65 ha_iot_class: Cloud Polling +ha_domain: zestimate --- The `zestimate` sensor allows one to track the Zestimate® value of properties using the [Zillow API](https://www.zillow.com/howto/api/APIOverview.htm). According to Zillow's website, a Zestimate® home valuation is Zillow's estimated market value. It is not an appraisal. Use it as a starting point to determine a home's value. The Zestimate® is provided by [Zillow](https://www.zillow.com), a website primarily for listing homes to buy/sell/rent in the United States. diff --git a/source/_integrations/zha.markdown b/source/_integrations/zha.markdown index 827fef5fa1e..e6110542bc1 100644 --- a/source/_integrations/zha.markdown +++ b/source/_integrations/zha.markdown @@ -18,9 +18,10 @@ ha_config_flow: true ha_codeowners: - '@dmulcahey' - '@adminiuga' +ha_domain: zha --- -[Zigbee Home Automation](https://zigbee.org/zigbee-for-developers/applicationstandards/zigbeehomeautomation/) +[Zigbee Home Automation](https://zigbeealliance.org) integration for Home Assistant allows you to connect many off-the-shelf Zigbee based devices to Home Assistant, using one of the available Zigbee radio modules that is compatible with [zigpy](https://github.com/zigpy/zigpy) (an open source Python library implementing a Zigbee stack, which in turn relies on separate libraries which can each interface a with Zigbee radio module a different manufacturer). There is currently support for the following device types within Home Assistant: @@ -35,7 +36,7 @@ There is currently support for the following device types within Home Assistant: ## ZHA exception and deviation handling -Zigbee devices that deviate from or do not fully conform to the standard specifications set by the [Zigbee Alliance](https://www.zigbee.org) may require the development of custom [ZHA Device Handlers](https://github.com/dmulcahey/zha-device-handlers) (ZHA custom quirks handler implementation) to for all their functions to work properly with the ZHA integration in Home Assistant. These ZHA Device Handlers for Home Assistant can thus be used to parse custom messages to and from Zigbee devices. +Zigbee devices that deviate from or do not fully conform to the standard specifications set by the [Zigbee Alliance](https://zigbeealliance.org) may require the development of custom [ZHA Device Handlers](https://github.com/dmulcahey/zha-device-handlers) (ZHA custom quirks handler implementation) to for all their functions to work properly with the ZHA integration in Home Assistant. These ZHA Device Handlers for Home Assistant can thus be used to parse custom messages to and from Zigbee devices. The custom quirks implementations for zigpy implemented as ZHA Device Handlers for Home Assistant are a similar concept to that of [Hub-connected Device Handlers for the SmartThings Classics platform](https://docs.smartthings.com/en/latest/device-type-developers-guide/) as well as that of [Zigbee-Shepherd Converters as used by Zigbee2mqtt](https://www.zigbee2mqtt.io/how_tos/how_to_support_new_devices.html), meaning they are each virtual representations of a physical device that expose additional functionality that is not provided out-of-the-box by the existing integration between these platforms. @@ -77,17 +78,25 @@ Use the plus button in the bottom right to add a new integration called **ZHA**. In the popup: -- USB Device Path - on a Linux system will be something like `/dev/ttyUSB0` -- Radio type - select device type `ezsp`, `deconz` or `xbee` +- USB Device Path - on a Linux system will be something like `/dev/ttyUSB0` or `/dev/ttyACM0` +- Radio type - select device type `ezsp`, `deconz`, `ti_cc`, `xbee` or `zigate` - Submit -The success dialog will appear or an error will be displayed in the popup. An error is likely if Home Assistant can't access the USB device or your device is not up to date (see troubleshooting). +| Radio Type | Zigbee Radio Hardware | +| ------------- | ------------- | +| `ezsp` | EmberZNet based radios, Telegesis ETRX357USB*** (using EmberZNet firmware) | +| `deconz` | ConBee, ConBee II | +| `xbee` | Digi XBee Series 2, 2C, 3 | + +- Press `Submit` to save changes. + +The success dialog will appear or an error will be displayed in the popup. An error is likely if Home Assistant can't access the USB device or your device is not up to date. Refer to [Troubleshooting](#troubleshooting) below for more information. ## Configuration - Manual To configure the component, select ZHA on the Integrations page and provide the path to your Zigbee USB stick. -Or, you can manually confiure `zha` section in `configuration.yaml`. The path to the database which will persist your network data is required. +Or, you can manually configure `zha` section in `configuration.yaml`. The path to the database which will persist your network data is required. ```yaml # Example configuration.yaml entry @@ -104,7 +113,7 @@ If you are use ZiGate, you have to use some special usb_path configuration: {% configuration %} radio_type: - description: One of `ezsp`, `xbee`, `deconz` or `zigate`. + description: One of `deconz`, `ezsp`, `ti_cc`, `xbee` or `zigate`. required: false type: string default: ezsp diff --git a/source/_integrations/zhong_hong.markdown b/source/_integrations/zhong_hong.markdown index 49dfe6047c6..ab023eeae9c 100644 --- a/source/_integrations/zhong_hong.markdown +++ b/source/_integrations/zhong_hong.markdown @@ -6,6 +6,7 @@ ha_category: - Climate ha_release: 0.72 ha_iot_class: Local Push +ha_domain: zhong_hong --- The `zhong_hong` climate platform lets you control [Zhonghong HVAC Gateway Controller](http://zhonghongtech.cn/v1/index.shtml) thermostats through Home Assistant. diff --git a/source/_integrations/zigbee.markdown b/source/_integrations/zigbee.markdown index 0803edb81e1..9348dbd1157 100644 --- a/source/_integrations/zigbee.markdown +++ b/source/_integrations/zigbee.markdown @@ -9,6 +9,7 @@ ha_category: - Switch ha_release: 0.12 ha_iot_class: Local Polling +ha_domain: zigbee --- [Zigbee](https://zigbee.org/what-is-zigbee/) integration for Home Assistant allows you to utilize modules such as the [XBee](https://www.digi.com/xbee) as wireless General Purpose Input/Output (GPIO) devices. The integration requires a local Zigbee device to be connected to a serial port. Through this, it will send and receive commands to and from other devices on the Zigbee mesh network. diff --git a/source/_integrations/ziggo_mediabox_xl.markdown b/source/_integrations/ziggo_mediabox_xl.markdown index 7bf3a5c1b9e..250527324dd 100644 --- a/source/_integrations/ziggo_mediabox_xl.markdown +++ b/source/_integrations/ziggo_mediabox_xl.markdown @@ -6,6 +6,7 @@ ha_category: - Media Player ha_iot_class: Local Polling ha_release: '0.60' +ha_domain: ziggo_mediabox_xl --- The `ziggo_mediabox_xl` integration allows you to control a [Ziggo](https://www.ziggo.nl/) Mediabox XL from Home Assistant. diff --git a/source/_integrations/zone.markdown b/source/_integrations/zone.markdown index 6aae7b693c5..de594d22d56 100644 --- a/source/_integrations/zone.markdown +++ b/source/_integrations/zone.markdown @@ -1,13 +1,13 @@ --- title: Zone description: Instructions on how to set up zones within Home Assistant. -logo: home-assistant.png ha_category: - Organization ha_release: 0.69 ha_quality_scale: internal ha_codeowners: - '@home-assistant/core' +ha_domain: zone --- Zones allow you to specify certain regions on earth (for now). When a device tracker sees a device to be within a zone, the state will take the name from the zone. Zones can also be used as a [trigger](/getting-started/automation-trigger/#zone-trigger) or [condition](/getting-started/automation-condition/#zone-condition) inside automation setups. diff --git a/source/_integrations/zoneminder.markdown b/source/_integrations/zoneminder.markdown index 6b5018d7cff..7c1c150afa6 100644 --- a/source/_integrations/zoneminder.markdown +++ b/source/_integrations/zoneminder.markdown @@ -12,6 +12,7 @@ ha_release: 0.31 ha_iot_class: Local Polling ha_codeowners: - '@rohankapoorcom' +ha_domain: zoneminder --- The `zoneminder` integration sets up Home Assistant with your [ZoneMinder](https://www.zoneminder.com) instance. diff --git a/source/_integrations/zwave.markdown b/source/_integrations/zwave.markdown index 22d7a4d35ee..4544965cf3c 100644 --- a/source/_integrations/zwave.markdown +++ b/source/_integrations/zwave.markdown @@ -1,7 +1,6 @@ --- title: Z-Wave description: Instructions on how to integrate your existing Z-Wave within Home Assistant. -logo: z-wave.png ha_category: - Hub - Binary Sensor @@ -18,6 +17,7 @@ ha_release: 0.7 ha_config_flow: true ha_codeowners: - '@home-assistant/z-wave' +ha_domain: zwave --- The [Z-Wave](https://www.z-wave.com/) integration for Home Assistant allows you to observe and control connected Z-Wave devices. Please see the [Z-Wave getting started section](/docs/z-wave/) for in-depth documentation on how to use and setup the Z-Wave component. diff --git a/source/_lovelace/alarm-panel.markdown b/source/_lovelace/alarm-panel.markdown index 09e25d85f7d..a31020d0ac0 100644 --- a/source/_lovelace/alarm-panel.markdown +++ b/source/_lovelace/alarm-panel.markdown @@ -1,10 +1,10 @@ --- title: "Alarm Panel Card" sidebar_label: Alarm Panel -description: "The Alarm Panel allows you to Arm and Disarm your Alarm Control Panel Integrations" +description: "The Alarm Panel card allows you to Arm and Disarm your alarm control panel integrations." --- -The Alarm Panel allows you to Arm and Disarm your Alarm Control Panel Integrations. +The Alarm Panel card allows you to Arm and Disarm your alarm control panel integrations.

    Screenshot of the alarm panel card diff --git a/source/_lovelace/button.markdown b/source/_lovelace/button.markdown index 2c06e57d49f..4250db8e1f2 100644 --- a/source/_lovelace/button.markdown +++ b/source/_lovelace/button.markdown @@ -1,7 +1,7 @@ --- title: "Button Card" sidebar_label: Button -description: "The Button card allows you to add buttons to perform tasks" +description: "The Button card allows you to add buttons to perform tasks." --- The Button card allows you to add buttons to perform tasks. @@ -57,129 +57,22 @@ state_color: default: true tap_action: required: false - description: Action to take on tap + description: Action taken on card tap. See [action documentation](/lovelace/actions/#tap-action). type: map - keys: - action: - required: true - description: "Action to perform (`more-info`, `toggle`, `call-service`, `navigate`, `url`, `none`)" - type: string - default: "`toggle`" - navigation_path: - required: false - description: "Path to navigate to (e.g. `/lovelace/0/`) when `action` defined as `navigate`" - type: string - default: none - url_path: - required: false - description: "Path to navigate to (e.g. `https://www.home-assistant.io`) when `action` defined as `url`" - type: string - default: none - service: - required: false - description: "Service to call (e.g. `media_player.media_play_pause`) when `action` defined as `call-service`" - type: string - default: none - service_data: - required: false - description: "Service data to include (e.g. `entity_id: media_player.bedroom`) when `action` defined as `call-service`" - type: string - default: none - confirmation: - required: false - description: "Present a confirmation dialog to confirm the action. See `confirmation` object below" - type: [boolean, map] - default: "false" hold_action: required: false - description: Action to take on tap-and-hold + description: Action taken on card tap and hold. See [action documentation](/lovelace/actions/#hold-action). type: map - keys: - action: - required: true - description: "Action to perform (`more-info`, `toggle`, `call-service`, `navigate`, `url`, `none`)" - type: string - default: "`more-info`" - navigation_path: - required: false - description: "Path to navigate to (e.g. `/lovelace/0/`) when `action` defined as `navigate`" - type: string - default: none - url_path: - required: false - description: "Path to navigate to (e.g. `https://www.home-assistant.io`) when `action` defined as `url`" - type: string - default: none - service: - required: false - description: "Service to call (e.g. `media_player.media_play_pause`) when `action` defined as `call-service`" - type: string - default: none - service_data: - required: false - description: "Service data to include (e.g. `entity_id: media_player.bedroom`) when `action` defined as `call-service`" - type: string - default: none - confirmation: - required: false - description: "Present a confirmation dialog to confirm the action. See `confirmation` object below" - type: [boolean, map] - default: "false" double_tap_action: required: false - description: Action to take on double tap + description: Action taken on card double tap. See [action documentation](/lovelace/actions/#double-tap-action). type: map - keys: - action: - required: true - description: "Action to perform (`more-info`, `toggle`, `call-service`, `navigate`, `url`, `none`)" - type: string - default: "`more-info`" - navigation_path: - required: false - description: "Path to navigate to (e.g. `/lovelace/0/`) when `action` defined as `navigate`" - type: string - default: none - url_path: - required: false - description: "Path to navigate to (e.g. `https://www.home-assistant.io`) when `action` defined as `url`" - type: string - default: none - service: - required: false - description: "Service to call (e.g. `media_player.media_play_pause`) when `action` defined as `call-service`" - type: string - default: none - service_data: - required: false - description: "Service data to include (e.g. `entity_id: media_player.bedroom`) when `action` defined as `call-service`" - type: string - default: none - confirmation: - required: false - description: "Present a confirmation dialog to confirm the action. See `confirmation` object below" - type: [boolean, map] - default: "false" theme: required: false description: "Set to any theme within `themes.yaml`" type: string {% endconfiguration %} -## Options For Confirmation - -If you define confirmation as an object instead of boolean, you can add more customization and configurations: -{% configuration %} -text: - required: false - description: Text to present in the confirmation dialog. - type: string -exemptions: - required: false - description: "List of `exemption` objects. See below" - type: list -{% endconfiguration %} - ## Options For Exemptions {% configuration badges %} diff --git a/source/_lovelace/conditional.markdown b/source/_lovelace/conditional.markdown index ed3b6e9fff8..a82ba6c9212 100644 --- a/source/_lovelace/conditional.markdown +++ b/source/_lovelace/conditional.markdown @@ -1,10 +1,10 @@ --- title: Conditional Card sidebar_label: Conditional -description: Displays another card based on entity states. +description: The Conditional card displays another card based on entity states. --- -Displays another card based on entity states. +The Conditional card displays another card based on entity states. {% configuration %} type: diff --git a/source/_lovelace/entities.markdown b/source/_lovelace/entities.markdown index 6931968a4fc..ddabf75f3c3 100644 --- a/source/_lovelace/entities.markdown +++ b/source/_lovelace/entities.markdown @@ -1,10 +1,10 @@ --- title: "Entities Card" sidebar_label: Entities -description: "Entities will be the most common type of card that will also be the most familiar to people using the standard interface. It groups items together very close to how groups used to do." +description: "The Entities card is the most common type of card. It groups items together into lists." --- -Entities will be the most common type of card that will also be the most familiar to people using the standard interface. It groups items together very close to how groups used to do. +The Entities card is the most common type of card. It groups items together into lists. {% configuration %} type: @@ -99,94 +99,16 @@ state_color: default: false tap_action: required: false - description: Action to take on tap + description: Action taken on card tap. See [action documentation](/lovelace/actions/#tap-action). type: map - keys: - action: - required: true - description: "Action to perform (`more-info`, `toggle`, `call-service`, `navigate`, `url`, `none`)" - type: string - default: "`toggle`" - navigation_path: - required: false - description: "Path to navigate to (e.g. `/lovelace/0/`) when `action` defined as `navigate`" - type: string - default: none - url_path: - required: false - description: "Path to navigate to (e.g. `https://www.home-assistant.io`) when `action` defined as `url`" - type: string - default: none - service: - required: false - description: "Service to call (e.g. `media_player.media_play_pause`) when `action` defined as `call-service`" - type: string - default: none - service_data: - required: false - description: "Service data to include (e.g. `entity_id: media_player.bedroom`) when `action` defined as `call-service`" - type: string - default: none hold_action: required: false - description: Action to take on tap-and-hold + description: Action taken on card tap and hold. See [action documentation](/lovelace/actions/#hold-action). type: map - keys: - action: - required: true - description: "Action to perform (`more-info`, `toggle`, `call-service`, `navigate`, `url`, `none`)" - type: string - default: "`more-info`" - navigation_path: - required: false - description: "Path to navigate to (e.g. `/lovelace/0/`) when `action` defined as `navigate`" - type: string - default: none - url_path: - required: false - description: "Path to navigate to (e.g. `https://www.home-assistant.io`) when `action` defined as `url`" - type: string - default: none - service: - required: false - description: "Service to call (e.g. `media_player.media_play_pause`) when `action` defined as `call-service`" - type: string - default: none - service_data: - required: false - description: "Service data to include (e.g. `entity_id: media_player.bedroom`) when `action` defined as `call-service`" - type: string - default: none double_tap_action: required: false - description: Action to take on double tap + description: Action taken on card double tap. See [action documentation](/lovelace/actions/#double-tap-action). type: map - keys: - action: - required: true - description: "Action to perform (`more-info`, `toggle`, `call-service`, `navigate`, `url`, `none`)" - type: string - default: "`more-info`" - navigation_path: - required: false - description: "Path to navigate to (e.g. `/lovelace/0/`) when `action` defined as `navigate`" - type: string - default: none - url_path: - required: false - description: "Path to navigate to (e.g. `https://www.home-assistant.io`) when `action` defined as `url`" - type: string - default: none - service: - required: false - description: "Service to call (e.g. `media_player.media_play_pause`) when `action` defined as `call-service`" - type: string - default: none - service_data: - required: false - description: "Service data to include (e.g. `entity_id: media_player.bedroom`) when `action` defined as `call-service`" - type: string - default: none {% endconfiguration %} ## Special Row Elements diff --git a/source/_lovelace/entity-filter.markdown b/source/_lovelace/entity-filter.markdown index 089930c171f..3f6e6da06e5 100644 --- a/source/_lovelace/entity-filter.markdown +++ b/source/_lovelace/entity-filter.markdown @@ -1,10 +1,10 @@ --- title: "Entity Filter Card" sidebar_label: Entity Filter -description: "This card allows you to define a list of entities that you want to track only when in a certain state. Very useful for showing lights that you forgot to turn off or show a list of people only when they're at home. " +description: "The Entity Filter card allows you to define a list of entities that you want to track only when in a certain state. Very useful for showing lights that you forgot to turn off or show a list of people only when they're at home. " --- -This card allows you to define a list of entities that you want to track only when in a certain state. Very useful for showing lights that you forgot to turn off or show a list of people only when they're at home. +The Entity Filter card allows you to define a list of entities that you want to track only when in a certain state. Very useful for showing lights that you forgot to turn off or show a list of people only when they're at home. This type of card can also be used together with rest of cards that allow multiple entities, allowing you to use [glance](/lovelace/glance/) or [picture-glance](/lovelace/picture-glance/). By default it uses [entities](/lovelace/entities/) card model. diff --git a/source/_lovelace/gauge.markdown b/source/_lovelace/gauge.markdown index 235b019ea73..4d0f362f1ac 100644 --- a/source/_lovelace/gauge.markdown +++ b/source/_lovelace/gauge.markdown @@ -1,10 +1,10 @@ --- title: "Gauge Card" sidebar_label: Gauge -description: "The Gauge card allows you to display sensor information visually" +description: "The Gauge card is a basic card that allows visually seeing sensor data." --- -Gauge card is a basic card that allows visually seeing sensor data. +The Gauge card is a basic card that allows visually seeing sensor data.

    Screenshot of the gauge card diff --git a/source/_lovelace/glance.markdown b/source/_lovelace/glance.markdown index 90d731e8278..45b808d4c9f 100644 --- a/source/_lovelace/glance.markdown +++ b/source/_lovelace/glance.markdown @@ -1,10 +1,10 @@ --- title: "Glance Card" sidebar_label: Glance -description: "The Glance card allows you to see a list of entities at a glance." +description: "The Glance card is useful to group multiple sensors in a compact overview." --- -Glance cards are very compact. Very useful to group together multiple sensors for a quick and easy overview. Keep in mind that this can be used together with [entity-filter](/lovelace/entity-filter/) cards to create dynamic cards. +The Glance card is useful to group multiple sensors in a compact overview. Keep in mind that this can be used together with [entity-filter](/lovelace/entity-filter/) cards to create dynamic cards.

    Screenshot of the glance card @@ -87,123 +87,16 @@ show_state: default: true tap_action: required: false - description: Action to take on tap + description: Action taken on card tap. See [action documentation](/lovelace/actions/#tap-action). type: map - keys: - action: - required: true - description: "Action to perform (`more-info`, `toggle`, `call-service`, `navigate`, `url`, `none`)" - type: string - default: "`more-info`" - navigation_path: - required: false - description: "Path to navigate to (e.g. `/lovelace/0/`) when `action` defined as `navigate`" - type: string - default: none - url_path: - required: false - description: "Path to navigate to (e.g. `https://www.home-assistant.io`) when `action` defined as `url`" - type: string - default: none - service: - required: false - description: "Service to call (e.g. `media_player.media_play_pause`) when `action` defined as `call-service`" - type: string - default: none - service_data: - required: false - description: "Service data to include (e.g. `entity_id: media_player.bedroom`) when `action` defined as `call-service`" - type: string - default: none - confirmation: - required: false - description: "Present a confirmation dialog to confirm the action. See `confirmation` object below" - type: [boolean, map] - default: "false" hold_action: required: false - description: Action to take on tap-and-hold + description: Action taken on card tap and hold. See [action documentation](/lovelace/actions/). type: map - keys: - action: - required: true - description: "Action to perform (`more-info`, `toggle`, `call-service`, `navigate`, `url`, `none`)" - type: string - default: "`more-info`" - navigation_path: - required: false - description: "Path to navigate to (e.g. `/lovelace/0/`) when `action` defined as `navigate`" - type: string - default: none - url_path: - required: false - description: "Path to navigate to (e.g. `https://www.home-assistant.io`) when `action` defined as `url`" - type: string - default: none - service: - required: false - description: "Service to call (e.g. `media_player.media_play_pause`) when `action` defined as `call-service`" - type: string - default: none - service_data: - required: false - description: "Service data to include (e.g. `entity_id: media_player.bedroom`) when `action` defined as `call-service`" - type: string - default: none - confirmation: - required: false - description: "Present a confirmation dialog to confirm the action. See `confirmation` object below" - type: [boolean, map] - default: "false" double_tap_action: required: false - description: Action to take on double tap + description: Action taken on card double tap. See [action documentation](/lovelace/actions/#double-tap-action). type: map - keys: - action: - required: true - description: "Action to perform (`more-info`, `toggle`, `call-service`, `navigate`, `url`, `none`)" - type: string - default: "`more-info`" - navigation_path: - required: false - description: "Path to navigate to (e.g. `/lovelace/0/`) when `action` defined as `navigate`" - type: string - default: none - url_path: - required: false - description: "Path to navigate to (e.g. `https://www.home-assistant.io`) when `action` defined as `url`" - type: string - default: none - service: - required: false - description: "Service to call (e.g. `media_player.media_play_pause`) when `action` defined as `call-service`" - type: string - default: none - service_data: - required: false - description: "Service data to include (e.g. `entity_id: media_player.bedroom`) when `action` defined as `call-service`" - type: string - default: none - confirmation: - required: false - description: "Present a confirmation dialog to confirm the action. See `confirmation` object below" - type: [boolean, map] - default: "false" -{% endconfiguration %} - -## Options For Confirmation - -If you define confirmation as an object instead of boolean, you can add more customization and configurations: -{% configuration %} -text: - required: false - description: Text to present in the confirmation dialog. - type: string -exemptions: - required: false - description: "List of `exemption` objects. See below" - type: list {% endconfiguration %} ## Options For Exemptions diff --git a/source/_lovelace/history-graph.markdown b/source/_lovelace/history-graph.markdown index 0ab31ec0ddf..04fa9819ced 100644 --- a/source/_lovelace/history-graph.markdown +++ b/source/_lovelace/history-graph.markdown @@ -1,10 +1,10 @@ --- title: "History Graph Card" sidebar_label: History Graph -description: "History graph is a basic card, allowing you to display a graph for each of the entities in the list specified as config." +description: "The History Graph card allows you to display a graph for each of the entities listed." --- -History graph is a basic card, allowing you to display a graph for each of the entities in the list specified configuration. +The History Graph card allows you to display a graph for each of the entities listed.

    Screenshot of the history graph card for entities without a unit_of_measurement diff --git a/source/_lovelace/horizontal-stack.markdown b/source/_lovelace/horizontal-stack.markdown index 0c3c05a4581..4fc74ed3aa3 100644 --- a/source/_lovelace/horizontal-stack.markdown +++ b/source/_lovelace/horizontal-stack.markdown @@ -1,10 +1,10 @@ --- title: "Horizontal Stack Card" sidebar_label: Horizontal Stack -description: "Horizontal stack card allows you to stack together multiple cards, so they always sit next to each other in the space of one column." +description: "The Horizontal Stack card allows you to stack together multiple cards, so they always sit next to each other in the space of one column." --- -Horizontal stack card allows you to stack together multiple cards, so they always sit next to each other in the space of one column. +The Horizontal Stack card allows you to stack together multiple cards, so they always sit next to each other in the space of one column. {% configuration %} type: diff --git a/source/_lovelace/iframe.markdown b/source/_lovelace/iframe.markdown index 332a08947f0..24db48ba9ee 100644 --- a/source/_lovelace/iframe.markdown +++ b/source/_lovelace/iframe.markdown @@ -1,18 +1,18 @@ --- -title: "Iframe Card" -sidebar_label: Iframe -description: "Embed data from other webservices in your dashboard." +title: "Webpage Card" +sidebar_label: Webpage +description: "The Webpage card allows you to embed your favorite webpage right into Home Assistant." --- -Embed data from other webservices in your dashboard. You can also embed files stored in your `/www` folder and reference them using `/local/`. +The Webpage card allows you to embed your favorite webpage right into Home Assistant. You can also embed files stored in your `/www` folder and reference them using `/local/`.

    You can't embed sites using HTTP if you are using HTTPS for your Home Assistant.

    - Windy weather radar as iframe - Windy weather radar as iframe. + Windy weather radar as Webpage + Windy weather radar as Webpage.

    {% configuration %} diff --git a/source/_lovelace/map.markdown b/source/_lovelace/map.markdown index 401568ca677..eb2ae770851 100644 --- a/source/_lovelace/map.markdown +++ b/source/_lovelace/map.markdown @@ -1,10 +1,10 @@ --- title: "Map Card" sidebar_label: Map -description: "A card that allows you to display entities on a map" +description: "The Map card that allows you to display entities on a map" --- -A card that allows you to display entities on a map. +The Map card that allows you to display entities on a map

    Screenshot of the map card diff --git a/source/_lovelace/markdown.markdown b/source/_lovelace/markdown.markdown index 4df04eaa741..d4eaa7a0feb 100644 --- a/source/_lovelace/markdown.markdown +++ b/source/_lovelace/markdown.markdown @@ -1,10 +1,10 @@ --- title: "Markdown Card" sidebar_label: Markdown -description: "Markdown card is used to render markdown" +description: "The Markdown card is used to render Markdown" --- -Markdown card is used to render [Markdown](https://commonmark.org/help/). +The Markdown card is used to render [Markdown](https://commonmark.org/help/). The renderer uses [Marked.js](https://marked.js.org), which supports [several specifications of Markdown](https://marked.js.org/#/README.md#specifications), including CommonMark, GitHub Flavored Markdown (GFM) and `markdown.pl`. diff --git a/source/_lovelace/media-control.markdown b/source/_lovelace/media-control.markdown index f3c7b961340..17378ed4012 100644 --- a/source/_lovelace/media-control.markdown +++ b/source/_lovelace/media-control.markdown @@ -1,10 +1,10 @@ --- title: "Media Control Card" sidebar_label: Media Control -description: "The media controller card is used to display Media Player entities on an interface with easy to use controls. " +description: "The Media Control card is used to display media player entities on an interface with easy to use controls." --- -The media control card is used to display [Media Player](/integrations/#search/media-player) entities on an interface with easy to use controls. +The Media Control card is used to display [Media Player](/integrations/#search/media-player) entities on an interface with easy to use controls.

    Screenshot of the media player control card diff --git a/source/_lovelace/picture-elements.markdown b/source/_lovelace/picture-elements.markdown index 4cb8999ead2..6de03f07d2c 100644 --- a/source/_lovelace/picture-elements.markdown +++ b/source/_lovelace/picture-elements.markdown @@ -1,10 +1,10 @@ --- title: "Picture Elements Card" sidebar_label: Picture Elements -description: "Picture elements card is one of the most versatile types of cards" +description: "The Picture Elements card is one of the most versatile types of cards. The cards allow you to position icons or text and even services! On an image based on coordinates." --- -Picture elements card is one of the most versatile types of cards. +The Picture Elements card is one of the most versatile types of cards. The cards allow you to position icons or text and even services! On an image based on coordinates. Imagine floor plan, imagine [picture-glance](/lovelace/picture-glance/) with no restrictions! @@ -64,109 +64,16 @@ title: type: string tap_action: required: false - description: Action to take on tap + description: Action taken on card tap. See [action documentation](/lovelace/actions/#tap-action). type: map - keys: - action: - required: true - description: "Action to perform (`more-info`, `toggle`, `call-service`, `navigate`, `url`, `none`)" - type: string - default: "`toggle`" - navigation_path: - required: false - description: "Path to navigate to (e.g. `/lovelace/0/`) when `action` defined as `navigate`" - type: string - default: none - url_path: - required: false - description: "Path to navigate to (e.g. `https://www.home-assistant.io`) when `action` defined as `url`" - type: string - default: none - service: - required: false - description: "Service to call (e.g. `media_player.media_play_pause`) when `action` defined as `call-service`" - type: string - default: none - service_data: - required: false - description: "Service data to include (e.g. `entity_id: media_player.bedroom`) when `action` defined as `call-service`" - type: string - default: none - confirmation: - required: false - description: "Present a confirmation dialog to confirm the action. See `confirmation` object below" - type: [boolean, map] - default: "false" hold_action: required: false - description: Action to take on tap-and-hold + description: Action taken on card tap and hold. See [action documentation](/lovelace/actions/#hold-action). type: map - keys: - action: - required: true - description: "Action to perform (`more-info`, `toggle`, `call-service`, `navigate`, `url`, `none`)" - type: string - default: "`more-info`" - navigation_path: - required: false - description: "Path to navigate to (e.g. `/lovelace/0/`) when `action` defined as `navigate`" - type: string - default: none - url_path: - required: false - description: "Path to navigate to (e.g. `https://www.home-assistant.io`) when `action` defined as `url`" - type: string - default: none - service: - required: false - description: "Service to call (e.g. `media_player.media_play_pause`) when `action` defined as `call-service`" - type: string - default: none - service_data: - required: false - description: "Service data to include (e.g. `entity_id: media_player.bedroom`) when `action` defined as `call-service`" - type: string - default: none - confirmation: - required: false - description: "Present a confirmation dialog to confirm the action. See `confirmation` object below" - type: [boolean, map] - default: "false" double_tap_action: required: false - description: Action to take on double tap + description: Action taken on card double tap. See [action documentation](/lovelace/actions/#double-tap-action). type: map - keys: - action: - required: true - description: "Action to perform (`more-info`, `toggle`, `call-service`, `navigate`, `url`, `none`)" - type: string - default: "`more-info`" - navigation_path: - required: false - description: "Path to navigate to (e.g. `/lovelace/0/`) when `action` defined as `navigate`" - type: string - default: none - url_path: - required: false - description: "Path to navigate to (e.g. `https://www.home-assistant.io`) when `action` defined as `url`" - type: string - default: none - service: - required: false - description: "Service to call (e.g. `media_player.media_play_pause`) when `action` defined as `call-service`" - type: string - default: none - service_data: - required: false - description: "Service data to include (e.g. `entity_id: media_player.bedroom`) when `action` defined as `call-service`" - type: string - default: none - confirmation: - required: false - description: "Present a confirmation dialog to confirm the action. See `confirmation` object below" - type: [boolean, map] - default: "false" {% endconfiguration %} ### Icon representing an entity state @@ -205,22 +112,22 @@ tap_action: default: "`more-info`" navigation_path: required: false - description: "Path to navigate to (e.g. `/lovelace/0/`) when `action` defined as `navigate`" + description: "Path to navigate to (e.g., `/lovelace/0/`) when `action` defined as `navigate`" type: string default: none url_path: required: false - description: "Path to navigate to (e.g. `https://www.home-assistant.io`) when `action` defined as `url`" + description: "Path to navigate to (e.g., `https://www.home-assistant.io`) when `action` defined as `url`" type: string default: none service: required: false - description: "Service to call (e.g. `media_player.media_play_pause`) when `action` defined as `call-service`" + description: "Service to call (e.g., `media_player.media_play_pause`) when `action` defined as `call-service`" type: string default: none service_data: required: false - description: "Service data to include (e.g. `entity_id: media_player.bedroom`) when `action` defined as `call-service`" + description: "Service data to include (e.g., `entity_id: media_player.bedroom`) when `action` defined as `call-service`" type: string default: none confirmation: @@ -228,76 +135,18 @@ tap_action: description: "Present a confirmation dialog to confirm the action. See `confirmation` object below" type: [boolean, map] default: "false" +tap_action: + required: false + description: Action taken on card tap. See [action documentation](/lovelace/actions/#tap-action). + type: map hold_action: required: false - description: Action to take on tap-and-hold + description: Action taken on card tap and hold. See [action documentation](/lovelace/actions/#hold-action). type: map - keys: - action: - required: true - description: "Action to perform (`more-info`, `toggle`, `call-service`, `navigate`, `url`, `none`)" - type: string - default: "`more-info`" - navigation_path: - required: false - description: "Path to navigate to (e.g. `/lovelace/0/`) when `action` defined as `navigate`" - type: string - default: none - url_path: - required: false - description: "Path to navigate to (e.g. `https://www.home-assistant.io`) when `action` defined as `url`" - type: string - default: none - service: - required: false - description: "Service to call (e.g. `media_player.media_play_pause`) when `action` defined as `call-service`" - type: string - default: none - service_data: - required: false - description: "Service data to include (e.g. `entity_id: media_player.bedroom`) when `action` defined as `call-service`" - type: string - default: none - confirmation: - required: false - description: "Present a confirmation dialog to confirm the action. See `confirmation` object below" - type: [boolean, map] - default: "false" double_tap_action: required: false - description: Action to take on double tap + description: Action taken on card double tap. See [action documentation](/lovelace/actions/#double-tap-action). type: map - keys: - action: - required: true - description: "Action to perform (`more-info`, `toggle`, `call-service`, `navigate`, `url`, `none`)" - type: string - default: "`more-info`" - navigation_path: - required: false - description: "Path to navigate to (e.g. `/lovelace/0/`) when `action` defined as `navigate`" - type: string - default: none - url_path: - required: false - description: "Path to navigate to (e.g. `https://www.home-assistant.io`) when `action` defined as `url`" - type: string - default: none - service: - required: false - description: "Service to call (e.g. `media_player.media_play_pause`) when `action` defined as `call-service`" - type: string - default: none - service_data: - required: false - description: "Service data to include (e.g. `entity_id: media_player.bedroom`) when `action` defined as `call-service`" - type: string - default: none - confirmation: - required: false - description: "Present a confirmation dialog to confirm the action. See `confirmation` object below" - type: [boolean, map] - default: "false" style: required: true description: Position and style the element using CSS. @@ -330,109 +179,16 @@ title: type: string tap_action: required: false - description: Action to take on tap + description: Action taken on card tap. See [action documentation](/lovelace/actions/#tap-action). type: map - keys: - action: - required: true - description: "Action to perform (`more-info`, `toggle`, `call-service`, `navigate`, `url`, `none`)" - type: string - default: "`more-info`" - navigation_path: - required: false - description: "Path to navigate to (e.g. `/lovelace/0/`) when `action` defined as `navigate`" - type: string - default: none - url_path: - required: false - description: "Path to navigate to (e.g. `https://www.home-assistant.io`) when `action` defined as `url`" - type: string - default: none - service: - required: false - description: "Service to call (e.g. `media_player.media_play_pause`) when `action` defined as `call-service`" - type: string - default: none - service_data: - required: false - description: "Service data to include (e.g. `entity_id: media_player.bedroom`) when `action` defined as `call-service`" - type: string - default: none - confirmation: - required: false - description: "Present a confirmation dialog to confirm the action. See `confirmation` object below" - type: [boolean, map] - default: "false" hold_action: required: false - description: Action to take on tap-and-hold + description: Action taken on card tap and hold. See [action documentation](/lovelace/actions/#hold-action). type: map - keys: - action: - required: true - description: "Action to perform (`more-info`, `toggle`, `call-service`, `navigate`, `url`,, `none`)" - type: string - default: "`more-info`" - navigation_path: - required: false - description: "Path to navigate to (e.g. `/lovelace/0/`) when `action` defined as `navigate`" - type: string - default: none - url_path: - required: false - description: "Path to navigate to (e.g. `https://www.home-assistant.io`) when `action` defined as `url`" - type: string - default: none - service: - required: false - description: "Service to call (e.g. `media_player.media_play_pause`) when `action` defined as `call-service`" - type: string - default: none - service_data: - required: false - description: "Service data to include (e.g. `entity_id: media_player.bedroom`) when `action` defined as `call-service`" - type: string - default: none - confirmation: - required: false - description: "Present a confirmation dialog to confirm the action. See `confirmation` object below" - type: [boolean, map] - default: "false" double_tap_action: required: false - description: Action to take on double tap + description: Action taken on card double tap. See [action documentation](/lovelace/actions/#double-tap-action). type: map - keys: - action: - required: true - description: "Action to perform (`more-info`, `toggle`, `call-service`, `navigate`, `url`, `none`)" - type: string - default: "`more-info`" - navigation_path: - required: false - description: "Path to navigate to (e.g. `/lovelace/0/`) when `action` defined as `navigate`" - type: string - default: none - url_path: - required: false - description: "Path to navigate to (e.g. `https://www.home-assistant.io`) when `action` defined as `url`" - type: string - default: none - service: - required: false - description: "Service to call (e.g. `media_player.media_play_pause`) when `action` defined as `call-service`" - type: string - default: none - service_data: - required: false - description: "Service data to include (e.g. `entity_id: media_player.bedroom`) when `action` defined as `call-service`" - type: string - default: none - confirmation: - required: false - description: "Present a confirmation dialog to confirm the action. See `confirmation` object below" - type: [boolean, map] - default: "false" style: required: true description: Position and style the element using CSS. @@ -487,109 +243,16 @@ entity: type: string tap_action: required: false - description: Action to take on tap + description: Action taken on card tap. See [action documentation](/lovelace/actions/#tap-action). type: map - keys: - action: - required: true - description: "Action to perform (`more-info`, `toggle`, `call-service`, `navigate`, `url`, `none`)" - type: string - default: "`more-info`" - navigation_path: - required: false - description: "Path to navigate to (e.g. `/lovelace/0/`) when `action` defined as `navigate`" - type: string - default: none - url_path: - required: false - description: "Path to navigate to (e.g. `https://www.home-assistant.io`) when `action` defined as `url`" - type: string - default: none - service: - required: false - description: "Service to call (e.g. `media_player.media_play_pause`) when `action` defined as `call-service`" - type: string - default: none - service_data: - required: false - description: "Service data to include (e.g. `entity_id: media_player.bedroom`) when `action` defined as `call-service`" - type: string - default: none - confirmation: - required: false - description: "Present a confirmation dialog to confirm the action. See `confirmation` object below" - type: [boolean, map] - default: "false" hold_action: required: false - description: Action to take on tap-and-hold + description: Action taken on card tap and hold. See [action documentation](/lovelace/actions/#hold-action). type: map - keys: - action: - required: true - description: "Action to perform (`more-info`, `toggle`, `call-service`, `navigate`, `url`, `none`)" - type: string - default: "`more-info`" - navigation_path: - required: false - description: "Path to navigate to (e.g. `/lovelace/0/`) when `action` defined as `navigate`" - type: string - default: none - url_path: - required: false - description: "Path to navigate to (e.g. `https://www.home-assistant.io`) when `action` defined as `url`" - type: string - default: none - service: - required: false - description: "Service to call (e.g. `media_player.media_play_pause`) when `action` defined as `call-service`" - type: string - default: none - service_data: - required: false - description: "Service data to include (e.g. `entity_id: media_player.bedroom`) when `action` defined as `call-service`" - type: string - default: none - confirmation: - required: false - description: "Present a confirmation dialog to confirm the action. See `confirmation` object below" - type: [boolean, map] - default: "false" double_tap_action: required: false - description: Action to take on double tap + description: Action taken on card double tap. See [action documentation](/lovelace/actions/#double-tap-action). type: map - keys: - action: - required: true - description: "Action to perform (`more-info`, `toggle`, `call-service`, `navigate`, `url`, `none`)" - type: string - default: "`more-info`" - navigation_path: - required: false - description: "Path to navigate to (e.g. `/lovelace/0/`) when `action` defined as `navigate`" - type: string - default: none - url_path: - required: false - description: "Path to navigate to (e.g. `https://www.home-assistant.io`) when `action` defined as `url`" - type: string - default: none - service: - required: false - description: "Service to call (e.g. `media_player.media_play_pause`) when `action` defined as `call-service`" - type: string - default: none - service_data: - required: false - description: "Service data to include (e.g. `entity_id: media_player.bedroom`) when `action` defined as `call-service`" - type: string - default: none - confirmation: - required: false - description: "Present a confirmation dialog to confirm the action. See `confirmation` object below" - type: [boolean, map] - default: "false" style: required: true description: Position and style the element using CSS. @@ -614,109 +277,16 @@ title: type: string tap_action: required: false - description: Action to take on tap + description: Action taken on card tap. See [action documentation](/lovelace/actions/#tap-action). type: map - keys: - action: - required: true - description: "Action to perform (`more-info`, `toggle`, `call-service`, `navigate`, `url`, `none`)" - type: string - default: "`more-info`" - navigation_path: - required: false - description: "Path to navigate to (e.g. `/lovelace/0/`) when `action` defined as `navigate`" - type: string - default: none - url_path: - required: false - description: "Path to navigate to (e.g. `https://www.home-assistant.io`) when `action` defined as `url`" - type: string - default: none - service: - required: false - description: "Service to call (e.g. `media_player.media_play_pause`) when `action` defined as `call-service`" - type: string - default: none - service_data: - required: false - description: "Service data to include (e.g. `entity_id: media_player.bedroom`) when `action` defined as `call-service`" - type: string - default: none - confirmation: - required: false - description: "Present a confirmation dialog to confirm the action. See `confirmation` object below" - type: [boolean, map] - default: "false" hold_action: required: false - description: Action to take on tap-and-hold + description: Action taken on card tap and hold. See [action documentation](/lovelace/actions/#hold-action). type: map - keys: - action: - required: true - description: "Action to perform (`more-info`, `toggle`, `call-service`, `navigate`, `url`, `none`)" - type: string - default: "`more-info`" - navigation_path: - required: false - description: "Path to navigate to (e.g. `/lovelace/0/`) when `action` defined as `navigate`" - type: string - default: none - url_path: - required: false - description: "Path to navigate to (e.g. `https://www.home-assistant.io`) when `action` defined as `url`" - type: string - default: none - service: - required: false - description: "Service to call (e.g. `media_player.media_play_pause`) when `action` defined as `call-service`" - type: string - default: none - service_data: - required: false - description: "Service data to include (e.g. `entity_id: media_player.bedroom`) when `action` defined as `call-service`" - type: string - default: none - confirmation: - required: false - description: "Present a confirmation dialog to confirm the action. See `confirmation` object below" - type: [boolean, map] - default: "false" double_tap_action: required: false - description: Action to take on double tap + description: Action taken on card double tap. See [action documentation](/lovelace/actions/#double-tap-action). type: map - keys: - action: - required: true - description: "Action to perform (`more-info`, `toggle`, `call-service`, `navigate`, `url`, `none`)" - type: string - default: "`more-info`" - navigation_path: - required: false - description: "Path to navigate to (e.g. `/lovelace/0/`) when `action` defined as `navigate`" - type: string - default: none - url_path: - required: false - description: "Path to navigate to (e.g. `https://www.home-assistant.io`) when `action` defined as `url`" - type: string - default: none - service: - required: false - description: "Service to call (e.g. `media_player.media_play_pause`) when `action` defined as `call-service`" - type: string - default: none - service_data: - required: false - description: "Service data to include (e.g. `entity_id: media_player.bedroom`) when `action` defined as `call-service`" - type: string - default: none - confirmation: - required: false - description: "Present a confirmation dialog to confirm the action. See `confirmation` object below" - type: [boolean, map] - default: "false" image: required: false description: The image to display. @@ -786,20 +356,6 @@ elements: type: list {% endconfiguration %} -## Options For Confirmation - -If you define confirmation as an object instead of boolean, you can add more customization and configurations: -{% configuration %} -text: - required: false - description: Text to present in the confirmation dialog. - type: string -exemptions: - required: false - description: "List of `exemption` objects. See below" - type: list -{% endconfiguration %} - ## Options For Exemptions {% configuration badges %} @@ -824,7 +380,7 @@ style: {% endconfiguration %} The process for creating and referencing custom elements is the same as for custom cards. -Please see the [developer docs on creating custom cards](https://developers.home-assistant.io/docs/en/lovelace_custom_card.html) +Please see the [developer documentation](https://developers.home-assistant.io/docs/en/lovelace_custom_card.html) for more information. ## How to use the style object diff --git a/source/_lovelace/picture-entity.markdown b/source/_lovelace/picture-entity.markdown index 5e989299daa..907e410501f 100644 --- a/source/_lovelace/picture-entity.markdown +++ b/source/_lovelace/picture-entity.markdown @@ -1,10 +1,10 @@ --- title: Picture Entity Card sidebar_label: Picture Entity -description: Displays the entity in form of an image. Instead of images from URL it can also show the picture of `camera` entities. +description: The Picture Entity card displays an entity in the form of an image. Instead of images from URL, it can also show the picture of camera entities. --- -Displays the entity in form of an image. Instead of images from URL it can also show the picture of `camera` entities. +The Picture Entity card displays an entity in the form of an image. Instead of images from URL, it can also show the picture of `camera` entities.

    Picture entity card @@ -65,123 +65,16 @@ theme: type: string tap_action: required: false - description: Action to take on tap + description: Action taken on card tap. See [action documentation](/lovelace/actions/#tap-action). type: map - keys: - action: - required: true - description: "Action to perform (`more-info`, `toggle`, `call-service`, `navigate`, `url`, `none`)" - type: string - default: "`more-info`" - navigation_path: - required: false - description: "Path to navigate to (e.g. `/lovelace/0/`) when `action` defined as `navigate`" - type: string - default: none - url_path: - required: false - description: "Path to navigate to (e.g. `https://www.home-assistant.io`) when `action` defined as `url`" - type: string - default: none - service: - required: false - description: "Service to call (e.g. `media_player.media_play_pause`) when `action` defined as `call-service`" - type: string - default: none - service_data: - required: false - description: "Service data to include (e.g. `entity_id: media_player.bedroom`) when `action` defined as `call-service`" - type: string - default: none - confirmation: - required: false - description: "Present a confirmation dialog to confirm the action. See `confirmation` object below" - type: [boolean, map] - default: "false" hold_action: required: false - description: Action to take on tap-and-hold + description: Action taken on card tap and hold. See [action documentation](/lovelace/actions/#hold-action). type: map - keys: - action: - required: true - description: "Action to perform (`more-info`, `toggle`, `call-service`, `navigate`, `url`, `none`)" - type: string - default: "`more-info`" - navigation_path: - required: false - description: "Path to navigate to (e.g. `/lovelace/0/`) when `action` defined as `navigate`" - type: string - default: none - url_path: - required: false - description: "Path to navigate to (e.g. `https://www.home-assistant.io`) when `action` defined as `url`" - type: string - default: none - service: - required: false - description: "Service to call (e.g. `media_player.media_play_pause`) when `action` defined as `call-service`" - type: string - default: none - service_data: - required: false - description: "Service data to include (e.g. `entity_id: media_player.bedroom`) when `action` defined as `call-service`" - type: string - default: none - confirmation: - required: false - description: "Present a confirmation dialog to confirm the action. See `confirmation` object below" - type: [boolean, map] - default: "false" double_tap_action: required: false - description: Action to take on double tap + description: Action taken on card double tap. See [action documentation](/lovelace/actions/#double-tap-action). type: map - keys: - action: - required: true - description: "Action to perform (`more-info`, `toggle`, `call-service`, `navigate`, `url`, `none`)" - type: string - default: "`more-info`" - navigation_path: - required: false - description: "Path to navigate to (e.g. `/lovelace/0/`) when `action` defined as `navigate`" - type: string - default: none - url_path: - required: false - description: "Path to navigate to (e.g. `https://www.home-assistant.io`) when `action` defined as `url`" - type: string - default: none - service: - required: false - description: "Service to call (e.g. `media_player.media_play_pause`) when `action` defined as `call-service`" - type: string - default: none - service_data: - required: false - description: "Service data to include (e.g. `entity_id: media_player.bedroom`) when `action` defined as `call-service`" - type: string - default: none - confirmation: - required: false - description: "Present a confirmation dialog to confirm the action. See `confirmation` object below" - type: [boolean, map] - default: "false" -{% endconfiguration %} - -## Options For Confirmation - -If you define confirmation as an object instead of boolean, you can add more customization and configurations: -{% configuration %} -text: - required: false - description: Text to present in the confirmation dialog. - type: string -exemptions: - required: false - description: "List of `exemption` objects. See below" - type: list {% endconfiguration %} ## Options For Exemptions @@ -226,6 +119,7 @@ state_image: Displaying a live feed from an FFmpeg camera: {% raw %} + ```yaml type: picture-entity entity: camera.backdoor @@ -237,6 +131,7 @@ tap_action: entity_id: camera.backdoor filename: '/shared/backdoor-{{ now().strftime("%Y-%m-%d-%H%M%S") }}.jpg' ``` + {% endraw %} The filename needs to be a path that is writable by Home Assistant in your system. You may need to configure `whitelist_external_dirs` ([documentation](/docs/configuration/basic/)). diff --git a/source/_lovelace/picture-glance.markdown b/source/_lovelace/picture-glance.markdown index cf92f560d7a..b1f538974f4 100644 --- a/source/_lovelace/picture-glance.markdown +++ b/source/_lovelace/picture-glance.markdown @@ -1,10 +1,10 @@ --- title: "Picture Glance Card" sidebar_label: Picture Glance -description: "Show an image card and corresponding entity states as icon" +description: "The Picture Glance card shows an image and corresponding entity states as an icon. The entities on the right side allow toggle actions, others show the more information dialog." --- -Show an image card and corresponding entity states as icon. The entities on the right side allow toggle actions, others show the more-info-dialog. +The Picture Glance card shows an image and corresponding entity states as an icon. The entities on the right side allow toggle actions, others show the more information dialog.

    Picture glance card for a living room @@ -69,109 +69,16 @@ theme: type: string tap_action: required: false - description: Action to take on tap + description: Action taken on card tap. See [action documentation](/lovelace/actions/#tap-action). type: map - keys: - action: - required: true - description: "Action to perform (`more-info`, `toggle`, `call-service`, `navigate`, `url`, `none`)" - type: string - default: "`more-info`" - navigation_path: - required: false - description: "Path to navigate to (e.g. `/lovelace/0/`) when `action` defined as `navigate`" - type: string - default: none - url_path: - required: false - description: "Path to navigate to (e.g. `https://www.home-assistant.io`) when `action` defined as `url`" - type: string - default: none - service: - required: false - description: "Service to call (e.g. `media_player.media_play_pause`) when `action` defined as `call-service`" - type: string - default: none - service_data: - required: false - description: "Service data to include (e.g. `entity_id: media_player.bedroom`) when `action` defined as `call-service`" - type: string - default: none - confirmation: - required: false - description: "Present a confirmation dialog to confirm the action. See `confirmation` object below" - type: [boolean, map] - default: "false" hold_action: required: false - description: Action to take on tap-and-hold + description: Action taken on card tap and hold. See [action documentation](/lovelace/actions/#hold-action). type: map - keys: - action: - required: true - description: "Action to perform (`more-info`, `toggle`, `call-service`, `navigate`, `url`, `none`)" - type: string - default: "`more-info`" - navigation_path: - required: false - description: "Path to navigate to (e.g. `/lovelace/0/`) when `action` defined as `navigate`" - type: string - default: none - url_path: - required: false - description: "Path to navigate to (e.g. `https://www.home-assistant.io`) when `action` defined as `url`" - type: string - default: none - service: - required: false - description: "Service to call (e.g. `media_player.media_play_pause`) when `action` defined as `call-service`" - type: string - default: none - service_data: - required: false - description: "Service data to include (e.g. `entity_id: media_player.bedroom`) when `action` defined as `call-service`" - type: string - default: none - confirmation: - required: false - description: "Present a confirmation dialog to confirm the action. See `confirmation` object below" - type: [boolean, map] - default: "false" double_tap_action: required: false - description: Action to take on double tap + description: Action taken on card double tap. See [action documentation](/lovelace/actions/). type: map - keys: - action: - required: true - description: "Action to perform (`more-info`, `toggle`, `call-service`, `navigate`, `url`, `none`)" - type: string - default: "`more-info`" - navigation_path: - required: false - description: "Path to navigate to (e.g. `/lovelace/0/`) when `action` defined as `navigate`" - type: string - default: none - url_path: - required: false - description: "Path to navigate to (e.g. `https://www.home-assistant.io`) when `action` defined as `url`" - type: string - default: none - service: - required: false - description: "Service to call (e.g. `media_player.media_play_pause`) when `action` defined as `call-service`" - type: string - default: none - service_data: - required: false - description: "Service data to include (e.g. `entity_id: media_player.bedroom`) when `action` defined as `call-service`" - type: string - default: none - confirmation: - required: false - description: "Present a confirmation dialog to confirm the action. See `confirmation` object below" - type: [boolean, map] - default: "false" {% endconfiguration %} ## Options For Entities @@ -194,113 +101,16 @@ show_state: default: true tap_action: required: false - description: Action to take on tap + description: Action taken on card tap. See [action documentation](/lovelace/actions/#tap-action). type: map - keys: - action: - required: true - description: "Action to perform (`more-info`, `toggle`, `call-service`, `navigate`, `url`, `none`)" - type: string - default: "`more-info`" - navigation_path: - required: false - description: "Path to navigate to (e.g., `/lovelace/0/`) when `action` defined as `navigate`" - type: string - default: none - service: - required: false - description: "Service to call (e.g., `media_player.media_play_pause`) when `action` defined as `call-service`" - type: string - default: none - service_data: - required: false - description: "Service data to include (e.g., `entity_id: media_player.bedroom`) when `action` defined as `call-service`" - type: string - default: none - confirmation: - required: false - description: "Present a confirmation dialog to confirm the action. See `confirmation` object below" - type: [boolean, map] - default: "false" hold_action: required: false - description: Action to take on tap-and-hold + description: Action taken on card tap and hold. See [action documentation](/lovelace/actions/#hold-action). type: map - keys: - action: - required: true - description: "Action to perform (`more-info`, `toggle`, `call-service`, `navigate`, `url`, `none`)" - type: string - default: "`more-info`" - navigation_path: - required: false - description: "Path to navigate to (e.g., `/lovelace/0/`) when `action` defined as `navigate`" - type: string - default: none - service: - required: false - description: "Service to call (e.g., `media_player.media_play_pause`) when `action` defined as `call-service`" - type: string - default: none - service_data: - required: false - description: "Service data to include (e.g., `entity_id: media_player.bedroom`) when `action` defined as `call-service`" - type: string - default: none - confirmation: - required: false - description: "Present a confirmation dialog to confirm the action. See `confirmation` object below" - type: [boolean, map] - default: "false" double_tap_action: required: false - description: Action to take on double tap + description: Action taken on card double tap. See [action documentation](/lovelace/actions/#double-tap-action). type: map - keys: - action: - required: true - description: "Action to perform (`more-info`, `toggle`, `call-service`, `navigate`, `url`, `none`)" - type: string - default: "`more-info`" - navigation_path: - required: false - description: "Path to navigate to (e.g. `/lovelace/0/`) when `action` defined as `navigate`" - type: string - default: none - url_path: - required: false - description: "Path to navigate to (e.g. `https://www.home-assistant.io`) when `action` defined as `url`" - type: string - default: none - service: - required: false - description: "Service to call (e.g. `media_player.media_play_pause`) when `action` defined as `call-service`" - type: string - default: none - service_data: - required: false - description: "Service data to include (e.g. `entity_id: media_player.bedroom`) when `action` defined as `call-service`" - type: string - default: none - confirmation: - required: false - description: "Present a confirmation dialog to confirm the action. See `confirmation` object below" - type: [boolean, map] - default: "false" -{% endconfiguration %} - -## Options For Confirmation - -If you define confirmation as an object instead of boolean, you can add more customization and configurations: -{% configuration %} -text: - required: false - description: Text to present in the confirmation dialog. - type: string -exemptions: - required: false - description: "List of `exemption` objects. See below" - type: list {% endconfiguration %} ## Options For Exemptions diff --git a/source/_lovelace/picture.markdown b/source/_lovelace/picture.markdown index 6a97fb0e5e4..c38959d6ca0 100644 --- a/source/_lovelace/picture.markdown +++ b/source/_lovelace/picture.markdown @@ -1,10 +1,10 @@ --- title: "Picture Card" sidebar_label: Picture -description: "A very simple card that allows you to set an image to use for navigation to various paths in your interface or to call a service." +description: "The Picture card allows you to set an image to use for navigation to various paths in your interface or to call a service." --- -A very simple card that allows you to set an image to use for navigation to various paths in your interface or to call a service. +The Picture card allows you to set an image to use for navigation to various paths in your interface or to call a service.

    Screenshot of the picture card @@ -26,123 +26,16 @@ theme: type: string tap_action: required: false - description: Action to take on tap + description: Action taken on card tap. See [action documentation](/lovelace/actions/#tap-action). type: map - keys: - action: - required: true - description: "Action to perform (`call-service`, `navigate`, `url`, `none`)" - type: string - default: "`none`" - navigation_path: - required: false - description: "Path to navigate to (e.g. `/lovelace/0/`) when `action` defined as `navigate`" - type: string - default: none - url_path: - required: false - description: "Path to navigate to (e.g. `https://www.home-assistant.io`) when `action` defined as `url`" - type: string - default: none - service: - required: false - description: "Service to call (e.g. `media_player.media_play_pause`) when `action` defined as `call-service`" - type: string - default: none - service_data: - required: false - description: "Service data to include (e.g. `entity_id: media_player.bedroom`) when `action` defined as `call-service`" - type: string - default: none - confirmation: - required: false - description: "Present a confirmation dialog to confirm the action. See `confirmation` object below" - type: [boolean, map] - default: "false" hold_action: required: false - description: Action to take on tap-and-hold + description: Action taken on card tap and hold. See [action documentation](/lovelace/actions/#hold-action). type: map - keys: - action: - required: true - description: "Action to perform (`call-service`, `navigate`, `url`, `none`)" - type: string - default: "`none`" - navigation_path: - required: false - description: "Path to navigate to (e.g. `/lovelace/0/`) when `action` defined as `navigate`" - type: string - default: none - url_path: - required: false - description: "Path to navigate to (e.g. `https://www.home-assistant.io`) when `action` defined as `url`" - type: string - default: none - service: - required: false - description: "Service to call (e.g. `media_player.media_play_pause`) when `action` defined as `call-service`" - type: string - default: none - service_data: - required: false - description: "Service data to include (e.g. `entity_id: media_player.bedroom`) when `action` defined as `call-service`" - type: string - default: none - confirmation: - required: false - description: "Present a confirmation dialog to confirm the action. See `confirmation` object below" - type: [boolean, map] - default: "false" double_tap_action: required: false - description: Action to take on double tap + description: Action taken on card double tap. See [action documentation](/lovelace/actions/#double-tap-action). type: map - keys: - action: - required: true - description: "Action to perform (`more-info`, `toggle`, `call-service`, `navigate`, `url`, `none`)" - type: string - default: "`more-info`" - navigation_path: - required: false - description: "Path to navigate to (e.g. `/lovelace/0/`) when `action` defined as `navigate`" - type: string - default: none - url_path: - required: false - description: "Path to navigate to (e.g. `https://www.home-assistant.io`) when `action` defined as `url`" - type: string - default: none - service: - required: false - description: "Service to call (e.g. `media_player.media_play_pause`) when `action` defined as `call-service`" - type: string - default: none - service_data: - required: false - description: "Service data to include (e.g. `entity_id: media_player.bedroom`) when `action` defined as `call-service`" - type: string - default: none - confirmation: - required: false - description: "Present a confirmation dialog to confirm the action. See `confirmation` object below" - type: [boolean, map] - default: "false" -{% endconfiguration %} - -## Options For Confirmation - -If you define confirmation as an object instead of boolean, you can add more customization and configurations: -{% configuration %} -text: - required: false - description: Text to present in the confirmation dialog. - type: string -exemptions: - required: false - description: "List of `exemption` objects. See below" - type: list {% endconfiguration %} ## Options For Exemptions diff --git a/source/_lovelace/plant-status.markdown b/source/_lovelace/plant-status.markdown index 4a51516674a..221345752a1 100644 --- a/source/_lovelace/plant-status.markdown +++ b/source/_lovelace/plant-status.markdown @@ -1,10 +1,10 @@ --- title: "Plant Status Card" sidebar_label: Plant Status -description: "The Plant card gives you an easy way of viewing the status of your plants" +description: "The Plant Status card is for all the lovely botanists out there." --- -A card for all the lovely botanists out there. +The Plant Status card is for all the lovely botanists out there.

    Screenshot of the plant status card diff --git a/source/_lovelace/sensor.markdown b/source/_lovelace/sensor.markdown index d856949503d..d47eef1de3a 100644 --- a/source/_lovelace/sensor.markdown +++ b/source/_lovelace/sensor.markdown @@ -1,10 +1,10 @@ --- title: "Sensor Card" sidebar_label: Sensor -description: "The sensor card gives you information about the sensor state" +description: "The Sensor card gives you a quick overview of your sensors state with an optional graph to visualize change over time." --- -The sensor card gives you a quick overview of your sensors state with an optional graph to visualize change over time. +The Sensor card gives you a quick overview of your sensors state with an optional graph to visualize change over time.

    Screenshot of the sensor card diff --git a/source/_lovelace/shopping-list.markdown b/source/_lovelace/shopping-list.markdown index ac066ceb7a6..276128687cc 100644 --- a/source/_lovelace/shopping-list.markdown +++ b/source/_lovelace/shopping-list.markdown @@ -1,10 +1,10 @@ --- title: "Shopping List Card" sidebar_label: Shopping List -description: "The Shopping List Card allows you to add, edit, check-off, and clear items from your shopping list" +description: "The Shopping List card allows you to add, edit, check-off, and clear items from your shopping list." --- -The Shopping List Card allows you to add, edit, check-off, and clear items from your shopping list. +The Shopping List card allows you to add, edit, check-off, and clear items from your shopping list. Setup of the [Shopping List Intent](/integrations/shopping_list/) is required diff --git a/source/_lovelace/thermostat.markdown b/source/_lovelace/thermostat.markdown index 941092e775e..b56883fe984 100644 --- a/source/_lovelace/thermostat.markdown +++ b/source/_lovelace/thermostat.markdown @@ -1,10 +1,10 @@ --- title: "Thermostat Card" sidebar_label: Thermostat -description: "The thermostat card allows you to control a climate entity." +description: "The Thermostat card gives control of your climate entity. Allowing you to change the temperature and mode of the entity." --- -The thermostat card gives control of your climate entity. +The Thermostat card gives control of your climate entity. Allowing you to change the temperature and mode of the entity.

    Screenshot of the thermostat card diff --git a/source/_lovelace/vertical-stack.markdown b/source/_lovelace/vertical-stack.markdown index c918c3cc4ef..6d12f2dc03c 100644 --- a/source/_lovelace/vertical-stack.markdown +++ b/source/_lovelace/vertical-stack.markdown @@ -1,10 +1,10 @@ --- title: "Vertical Stack Card" sidebar_label: Vertical Stack -description: "The Vertical Stack card allows you to stack multiple cards together" +description: "The Vertical Stack card allows you to group multiple cards so they always sit in the same column." --- -Vertical stack allows you to group multiple cards so they always sit in the same column. +The Vertical Stack card allows you to group multiple cards so they always sit in the same column. {% configuration %} type: diff --git a/source/_lovelace/weather-forecast.markdown b/source/_lovelace/weather-forecast.markdown index 64354728c2e..5edc5aa6081 100644 --- a/source/_lovelace/weather-forecast.markdown +++ b/source/_lovelace/weather-forecast.markdown @@ -1,10 +1,10 @@ --- title: "Weather Forecast Card" sidebar_label: Weather Forecast -description: "The Weather card allows you a visual card to display the weather." +description: "The Weather Forecast card displays the weather. Very useful to include on interfaces that people display on the wall." --- -The weather forecast is a card to display the weather. Very useful to include on interfaces that people display on the wall. +The Weather Forecast card displays the weather. Very useful to include on interfaces that people display on the wall.

    Screenshot of the weather card diff --git a/source/_posts/2015-05-14-release-notes.markdown b/source/_posts/2015-05-14-release-notes.markdown index 5fb47c858cc..e2009dd82a9 100644 --- a/source/_posts/2015-05-14-release-notes.markdown +++ b/source/_posts/2015-05-14-release-notes.markdown @@ -38,7 +38,7 @@ homeassistant: ``` __MySensors__ - [Andythigpen](https://github.com/andythigpen) and [Theolind](https://github.com/theolind) have added support for the [MySensors platform](http://www.mysensors.org) to Home Assistant. + [Andythigpen](https://github.com/andythigpen) and [Theolind](https://github.com/theolind) have added support for the [MySensors platform](http://www.mysensors.org) to Home Assistant. ```yaml # Example configuration.yaml entry diff --git a/source/_posts/2015-10-11-rfxtrx-blinkstick-and-snmp-support.markdown b/source/_posts/2015-10-11-rfxtrx-blinkstick-and-snmp-support.markdown index 30c63dd2cdf..4fa16538b3d 100644 --- a/source/_posts/2015-10-11-rfxtrx-blinkstick-and-snmp-support.markdown +++ b/source/_posts/2015-10-11-rfxtrx-blinkstick-and-snmp-support.markdown @@ -15,7 +15,7 @@ We discovered two issues annoying enough to warrant the release of 0.7.5: This release also includes some new platforms (because they keep coming!): - + - Light: [blinkstick platform](/integrations/blinksticklight) added ([@alanbowman](https://github.com/alanbowman)) - Device Tracker: [SNMP platform](/integrations/snmp) added ([@tomduijf](https://github.com/tomduijf)) diff --git a/source/_posts/2016-01-17-extended-support-for-diy-solutions.markdown b/source/_posts/2016-01-17-extended-support-for-diy-solutions.markdown index b39db3f69e0..48d3b1e7e61 100644 --- a/source/_posts/2016-01-17-extended-support-for-diy-solutions.markdown +++ b/source/_posts/2016-01-17-extended-support-for-diy-solutions.markdown @@ -13,7 +13,7 @@ First release of 2016 and we are on 🔥! The [main repository][github-ha] has p [github-ha]: https://github.com/home-assistant/home-assistant/ [release-pr]: https://github.com/home-assistant/home-assistant/pull/883#partial-users-participants - + - [MySensors] revamped and switch support added ([@MartinHjelmare][@MartinHjelmare]) - Full refactor of RPi GPIO. Now includes [binary sensor][rpi-bs] and [switch][rpi-s] ([@sfam]) diff --git a/source/_posts/2016-02-13-speedtest-bloomsky-splunk-and-garage-doors.markdown b/source/_posts/2016-02-13-speedtest-bloomsky-splunk-and-garage-doors.markdown index 35ea53dbe13..672fab2fc19 100644 --- a/source/_posts/2016-02-13-speedtest-bloomsky-splunk-and-garage-doors.markdown +++ b/source/_posts/2016-02-13-speedtest-bloomsky-splunk-and-garage-doors.markdown @@ -13,7 +13,7 @@ The focus of 0.13 was on test coverage, big cheers to [@rmkraus] for his hard wo

    - Examples of the new [input_select] and [weblink] components. + Examples of the new [input_select] and weblink components.

    Not only did we gain a lot of test coverage, we also attracted a lot of new developers that contributed a variety of components and platforms: @@ -32,7 +32,7 @@ Not only did we gain a lot of test coverage, we also attracted a lot of new deve - Component: Added support for [Bloomsky Weather Station] ([@haraldnagel]) - Component: Added support for pushing stats to [graphite] ([@kk7ds]) - Component: Added support for [SCSGate] devices ([@flavio]) - - Component: Added [weblink] component to link to other pages ([@MagnusKnutas]) + - Component: Added weblink component to link to other pages ([@MagnusKnutas]) - Component: Support for Ubiquiti mFI [sensors][mfi.sensor] and [switchable devices][mfi.switch] added ([@kk7ds]) - Alarm control panel: Added [Caddx/GE/Interlogix NetworX][nx584] support ([@kk7ds]) - Camera: [MJPEG] camera's will now show real stream instead of a 2fps stream ([@stjohnjohnson]) @@ -92,7 +92,6 @@ Not only did we gain a lot of test coverage, we also attracted a lot of new deve [Bloomsky Weather Station]: /integrations/bloomsky/ [graphite]: /integrations/graphite/ [SCSGate]: /integrations/scsgate/ -[weblink]: /integrations/weblink/ [mfi.switch]: /integrations/mfi#switch [mfi.sensor]: /integrations/mfi#sensor [nx584]: /integrations/nx584 diff --git a/source/_posts/2016-02-18-multi-room-audio-with-snapcast.markdown b/source/_posts/2016-02-18-multi-room-audio-with-snapcast.markdown index 7803554a2b9..fce1cd41c3f 100644 --- a/source/_posts/2016-02-18-multi-room-audio-with-snapcast.markdown +++ b/source/_posts/2016-02-18-multi-room-audio-with-snapcast.markdown @@ -15,7 +15,7 @@ You'll need two key software packages, besides Home Assistant. The first is [Mop Finally, you also need a player to control Mopidy. Any MPD-compatible player will work, and there are several [Mopidy-only web-based options](https://docs.mopidy.com/en/latest/ext/web/#ext-web) available. On Android, [Remotedy](https://play.google.com/store/apps/details?id=se.anil.remotedy) is particularly nice since you can access multiple Mopidy instances in one place. -Home Assistant will provide device status, and volume control for each room. If you want to play music in all your rooms (on all your clients), access the server instance of Mopidy. If you want to play music only in a specific room, access that specific Mopidy instance. If you're using a web UI for Mopidy, you can add links to each instance in Home Assistant with the [weblink] component. +Home Assistant will provide device status, and volume control for each room. If you want to play music in all your rooms (on all your clients), access the server instance of Mopidy. If you want to play music only in a specific room, access that specific Mopidy instance. If you're using a web UI for Mopidy, you can add links to each instance in Home Assistant with the weblink component.

    @@ -134,6 +134,5 @@ weblink: url: xxxx ``` -[weblink]: /integrations/weblink/ [snapcast]: /integrations/snapcast [mpd]: /integrations/mpd diff --git a/source/_posts/2016-05-21-release-020.markdown b/source/_posts/2016-05-21-release-020.markdown index ab894fddc31..355de586afa 100644 --- a/source/_posts/2016-05-21-release-020.markdown +++ b/source/_posts/2016-05-21-release-020.markdown @@ -8,7 +8,7 @@ author_twitter: balloob categories: Release-Notes --- - + Tons of new supported things in 0.20. diff --git a/source/_posts/2016-07-16-sqlalchemy-knx-join-simplisafe.markdown b/source/_posts/2016-07-16-sqlalchemy-knx-join-simplisafe.markdown index 1881baaef42..39d7a4dd884 100644 --- a/source/_posts/2016-07-16-sqlalchemy-knx-join-simplisafe.markdown +++ b/source/_posts/2016-07-16-sqlalchemy-knx-join-simplisafe.markdown @@ -21,7 +21,7 @@ hass --script db_migrator --config /path/to/config You can omit the `--config` option if you use the default configuration directory. Run the script with `--help` to get more options. - + - Config: Improved support for storing [secrets][secrets] ([@kellerza]) - Sensor: Support for [Yahoo! Weather][yahoo-weather] ([@pvizeli]) diff --git a/source/_posts/2016-08-13-foursquare-fast-com-ffmpeg-gpsd.markdown b/source/_posts/2016-08-13-foursquare-fast-com-ffmpeg-gpsd.markdown index 79408404736..47d40348a43 100644 --- a/source/_posts/2016-08-13-foursquare-fast-com-ffmpeg-gpsd.markdown +++ b/source/_posts/2016-08-13-foursquare-fast-com-ffmpeg-gpsd.markdown @@ -12,7 +12,7 @@ It's time for 0.26 and it's again full of new features and fixes. First I want t This release includes code contributed by 31 different people. The biggest change in this release is a new unit system. Instead of picking Celsius or Fahrenheit you'll have to pick imperial or metric now. This influences the units for your temperature, distance, and weight. This will simplify any platform or component that needs to know this information. Big thanks to [@Teagan42] for her hard work on this! - + - Core: Introduce notion of unit system (deprecates temperature unit option) ([@Teagan42]) - Front end: Speed improvements ([@balloob]) diff --git a/source/_posts/2016-10-08-hassbian-rest-digital-ocean.markdown b/source/_posts/2016-10-08-hassbian-rest-digital-ocean.markdown index 8621f25ec01..ea14e2ea640 100644 --- a/source/_posts/2016-10-08-hassbian-rest-digital-ocean.markdown +++ b/source/_posts/2016-10-08-hassbian-rest-digital-ocean.markdown @@ -107,7 +107,7 @@ sensor - Fix some html5 push notification configuration options were discarded after first use ([@T3m3z]) - Fix Homematic device name with autodiscovery ([@pvizeli]) - Make 'pin' optional for zigbee device config ([@flyte]) -- Fix when sending a notification to a service with target attached (i.e. `notify.html5_unnamed_device_2`) the target was not submitted to the platform as a list causing iteration over every character in the string. ([@robbiet480]) +- Fix when sending a notification to a service with target attached (i.e., `notify.html5_unnamed_device_2`) the target was not submitted to the platform as a list causing iteration over every character in the string. ([@robbiet480]) - Fix for Slack targets ([@fabaff]) - Fix for Pushover targets ([@Nixon506E]) diff --git a/source/_posts/2016-11-05-hacktoberfest-influxdb-weather.markdown b/source/_posts/2016-11-05-hacktoberfest-influxdb-weather.markdown index e613bda7bc2..3f144e3cda6 100644 --- a/source/_posts/2016-11-05-hacktoberfest-influxdb-weather.markdown +++ b/source/_posts/2016-11-05-hacktoberfest-influxdb-weather.markdown @@ -28,7 +28,7 @@ For a long time we have had a bunch of [weather sensors][weather-sensors] but it ### All changes - + - Cover: New [garadget] platform ([@JasonCarter80]) - Media player: New support for [Emby][emby-media] ([@mezz64]) diff --git a/source/_posts/2017-04-22-ikea-tradfri--spotify.markdown b/source/_posts/2017-04-22-ikea-tradfri--spotify.markdown index dda9b5bb667..deb6f410341 100644 --- a/source/_posts/2017-04-22-ikea-tradfri--spotify.markdown +++ b/source/_posts/2017-04-22-ikea-tradfri--spotify.markdown @@ -472,7 +472,7 @@ Experiencing issues introduced by this release? Please report them in our [issue [switch.tplink docs]: /integrations/tplink [switch.wake_on_lan docs]: /integrations/wake_on_lan#switch [switch.wemo docs]: /integrations/wemo -[telegram_bot docs]: /integrations/telegram_chatbot/ +[telegram_bot docs]: /integrations/telegram_bot/ [telegram_bot.polling docs]: /integrations/telegram_polling [telegram_bot.webhooks docs]: /integrations/telegram_webhooks [tts.google docs]: /integrations/google_translate @@ -493,7 +493,7 @@ Experiencing issues introduced by this release? Please report them in our [issue [cover.zwave docs]: /integrations/zwave#cover [recorder docs]: /integrations/recorder/ [switch.wemo docs]: /integrations/wemo -[telegram_bot docs]: /integrations/telegram_chatbot/ +[telegram_bot docs]: /integrations/telegram_bot/ [telegram_bot.webhooks docs]: /integrations/telegram_webhooks [wemo docs]: /integrations/wemo/ [#7271]: https://github.com/home-assistant/home-assistant/pull/7271 diff --git a/source/_posts/2017-05-06-zigbee-opencv-dlib.markdown b/source/_posts/2017-05-06-zigbee-opencv-dlib.markdown index d67e2ddd53d..ea557720d74 100644 --- a/source/_posts/2017-05-06-zigbee-opencv-dlib.markdown +++ b/source/_posts/2017-05-06-zigbee-opencv-dlib.markdown @@ -486,7 +486,7 @@ influxdb: [switch.thinkingcleaner docs]: /integrations/thinkingcleaner#switch [switch.wemo docs]: /integrations/wemo [switch.zha docs]: /integrations/zha -[telegram_bot docs]: /integrations/telegram_chatbot/ +[telegram_bot docs]: /integrations/telegram_bot/ [telegram_bot.polling docs]: /integrations/telegram_polling [telegram_bot.webhooks docs]: /integrations/telegram_webhooks [updater docs]: /integrations/updater/ diff --git a/source/_posts/2017-05-20-automation-editor-zwave-panel-ocr.markdown b/source/_posts/2017-05-20-automation-editor-zwave-panel-ocr.markdown index fd7684ca022..8bf09909cb9 100644 --- a/source/_posts/2017-05-20-automation-editor-zwave-panel-ocr.markdown +++ b/source/_posts/2017-05-20-automation-editor-zwave-panel-ocr.markdown @@ -413,9 +413,9 @@ Experiencing issues introduced by this release? Please report them in our [issue [sensor.wunderground docs]: /integrations/wunderground [sun docs]: /integrations/sun/ [switch.rpi_pfio docs]: /integrations/rpi_pfio#switch -[telegram_bot docs]: /integrations/telegram_chatbot/ +[telegram_bot docs]: /integrations/telegram_bot/ [telegram_bot.polling docs]: /integrations/telegram_polling -[telegram_bot.services.yaml docs]: /integrations/telegram_chatbot/#notification-services +[telegram_bot.services.yaml docs]: /integrations/telegram_bot/#notification-services [telegram_bot.webhooks docs]: /integrations/telegram_webhooks [tradfri docs]: /integrations/tradfri/ [vera docs]: /integrations/vera/ @@ -434,5 +434,5 @@ Experiencing issues introduced by this release? Please report them in our [issue [device_tracker.ubus docs]: /integrations/ubus [hassio docs]: /integrations/hassio/ [media_player.volumio docs]: /integrations/volumio -[telegram_bot.__init__ docs]: /integrations/telegram_chatbot/ +[telegram_bot.__init__ docs]: /integrations/telegram_bot/ [discord]: https://discord.gg/c5DvZ4e diff --git a/source/_posts/2017-06-04-release-46.markdown b/source/_posts/2017-06-04-release-46.markdown index e9de42940d8..2f402e7a76b 100644 --- a/source/_posts/2017-06-04-release-46.markdown +++ b/source/_posts/2017-06-04-release-46.markdown @@ -369,7 +369,7 @@ Experiencing issues introduced by this release? Please report them in our [issue [switch.broadlink docs]: /integrations/broadlink#switch [switch.rachio docs]: /integrations/rachio#switch [switch.rflink docs]: /integrations/switch.rflink/ -[telegram_bot.__init__ docs]: /integrations/telegram_chatbot/ +[telegram_bot.__init__ docs]: /integrations/telegram_bot/ [telegram_bot.polling docs]: /integrations/telegram_polling [telegram_bot.webhooks docs]: /integrations/telegram_webhooks [tellduslive docs]: /integrations/tellduslive/ diff --git a/source/_posts/2017-06-17-release-47.markdown b/source/_posts/2017-06-17-release-47.markdown index af58001c4d2..a1463d5f2e7 100644 --- a/source/_posts/2017-06-17-release-47.markdown +++ b/source/_posts/2017-06-17-release-47.markdown @@ -547,7 +547,7 @@ automation: [switch.raspihats docs]: /integrations/raspihats#switch [switch.rest docs]: /integrations/switch.rest/ [switch.template docs]: /integrations/switch.template/ -[telegram_bot.__init__ docs]: /integrations/telegram_chatbot/ +[telegram_bot.__init__ docs]: /integrations/telegram_bot/ [telegram_bot.polling docs]: /integrations/telegram_polling [telegram_bot.webhooks docs]: /integrations/telegram_webhooks [updater docs]: /integrations/updater/ diff --git a/source/_posts/2017-07-02-release-48.markdown b/source/_posts/2017-07-02-release-48.markdown index e3d54c7e025..651d975d5fd 100644 --- a/source/_posts/2017-07-02-release-48.markdown +++ b/source/_posts/2017-07-02-release-48.markdown @@ -504,7 +504,7 @@ light: [switch.verisure docs]: /integrations/verisure [switch.wake_on_lan docs]: /integrations/wake_on_lan#switch [tado docs]: /integrations/tado/ -[telegram_bot docs]: /integrations/telegram_chatbot/ +[telegram_bot docs]: /integrations/telegram_bot/ [telegram_bot.webhooks docs]: /integrations/telegram_webhooks [tellduslive docs]: /integrations/tellduslive/ [tts docs]: /integrations/tts/ diff --git a/source/_posts/2017-07-16-release-49.markdown b/source/_posts/2017-07-16-release-49.markdown index e7d2c1100b2..6f8201c8916 100644 --- a/source/_posts/2017-07-16-release-49.markdown +++ b/source/_posts/2017-07-16-release-49.markdown @@ -488,7 +488,7 @@ amcrest: [@maikelwever]: https://github.com/maikelwever [@ypollart]: https://github.com/ypollart [binary_sensor.rfxtrx docs]: /integrations/binary_sensor.rfxtrx/ -[telegram_bot docs]: /integrations/telegram_chatbot/ +[telegram_bot docs]: /integrations/telegram_bot/ [#8545]: https://github.com/home-assistant/home-assistant/pull/8545 [#8571]: https://github.com/home-assistant/home-assistant/pull/8571 [#8601]: https://github.com/home-assistant/home-assistant/pull/8601 diff --git a/source/_posts/2017-08-12-release-51.markdown b/source/_posts/2017-08-12-release-51.markdown index 8ce4edd2269..76f8cd2fb65 100644 --- a/source/_posts/2017-08-12-release-51.markdown +++ b/source/_posts/2017-08-12-release-51.markdown @@ -442,7 +442,7 @@ vacuum: [switch.rainmachine docs]: /integrations/rainmachine#switch [switch.wink docs]: /integrations/wink#switch [switch.xiaomi_vacuum docs]: /integrations/vacuum.xiaomi_miio/ -[telegram_bot docs]: /integrations/telegram_chatbot/ +[telegram_bot docs]: /integrations/telegram_bot/ [updater docs]: /integrations/updater/ [vacuum docs]: /integrations/vacuum/ [vacuum.demo docs]: /integrations/vacuum.demo/ diff --git a/source/_posts/2017-09-09-release-53.markdown b/source/_posts/2017-09-09-release-53.markdown index 27abd107487..d0c05471051 100644 --- a/source/_posts/2017-09-09-release-53.markdown +++ b/source/_posts/2017-09-09-release-53.markdown @@ -439,7 +439,7 @@ frontend: [switch.rest docs]: /integrations/switch.rest/ [switch.rfxtrx docs]: /integrations/switch.rfxtrx/ [switch.knx docs]: /integrations/switch.knx/ -[telegram_bot docs]: /integrations/telegram_chatbot/ +[telegram_bot docs]: /integrations/telegram_bot/ [tesla docs]: /integrations/tesla/ [tradfri docs]: /integrations/tradfri/ [volvooncall docs]: /integrations/volvooncall/ diff --git a/source/_posts/2017-10-07-release-55.markdown b/source/_posts/2017-10-07-release-55.markdown index 7d43e88825c..ef0742b215d 100644 --- a/source/_posts/2017-10-07-release-55.markdown +++ b/source/_posts/2017-10-07-release-55.markdown @@ -61,7 +61,7 @@ Experiencing issues introduced by this release? Please report them in our [issue ## Breaking Changes -- history_graph component: If your component used `history.get_significant_states` function then you need to adjust the string `entity_id` parameter has been changed to a list of strings `entity_ids` parameter. ([@andrey-git] - [#9472]) ([history_graph docs]) (breaking change) +- history_graph component: If your component used `history.get_significant_states` function then you need to adjust the string `entity_id` parameter has been changed to a list of strings `entity_ids` parameter. ([@andrey-git] - [#9472]) (breaking change) - UPNP component: The `external_port` configuration option was removed. ([@balloob] - [#9560]) ([upnp docs]) (breaking change) - New Wink services: pair new device, rename, delete and add new lock key code. All device attributes that are multi-words are now separated by "_" and no longer " ". ([@w1ll1am23] - [#9303]) ([wink docs]) ([binary_sensor.wink docs]) ([lock.wink docs]) (breaking change) - TP-Link Switch: Attribute names now uses underscores and unnecessary capitalization was removed. ([@djchen] - [#9607]) ([switch.tplink docs]) (breaking change) @@ -383,7 +383,6 @@ Experiencing issues introduced by this release? Please report them in our [issue [forum]: https://community.home-assistant.io/ [issue]: https://github.com/home-assistant/home-assistant/issues [discord]: https://discord.gg/c5DvZ4e -[history_graph docs]: /integrations/history_graph/ [#9754]: https://github.com/home-assistant/home-assistant/pull/9754 [#9776]: https://github.com/home-assistant/home-assistant/pull/9776 [#9785]: https://github.com/home-assistant/home-assistant/pull/9785 diff --git a/source/_posts/2017-10-21-release-56.markdown b/source/_posts/2017-10-21-release-56.markdown index fd8ac7e6a77..b25ba71446f 100644 --- a/source/_posts/2017-10-21-release-56.markdown +++ b/source/_posts/2017-10-21-release-56.markdown @@ -527,7 +527,7 @@ Experiencing issues introduced by this release? Please report them in our [issue [switch.tplink docs]: /integrations/tplink [switch.wink docs]: /integrations/wink#switch [switch.xiaomi_miio docs]: /integrations/switch.xiaomi_miio/ -[telegram_bot docs]: /integrations/telegram_chatbot/ +[telegram_bot docs]: /integrations/telegram_bot/ [tesla docs]: /integrations/tesla/ [toon docs]: /integrations/toon/ [tradfri docs]: /integrations/tradfri/ diff --git a/source/_posts/2017-11-18-release-58.markdown b/source/_posts/2017-11-18-release-58.markdown index 23d5576758f..c95fc35b056 100644 --- a/source/_posts/2017-11-18-release-58.markdown +++ b/source/_posts/2017-11-18-release-58.markdown @@ -469,7 +469,7 @@ Experiencing issues introduced by this release? Please report them in our [issue [switch.snmp docs]: /integrations/snmp#switch [switch.xiaomi_miio docs]: /integrations/switch.xiaomi_miio/ [system_log docs]: /integrations/system_log/ -[telegram_bot docs]: /integrations/telegram_chatbot/ +[telegram_bot docs]: /integrations/telegram_bot/ [telegram_bot.polling docs]: /integrations/telegram_polling [tradfri docs]: /integrations/tradfri/ [tts docs]: /integrations/tts/ diff --git a/source/_posts/2017-12-17-release-60.markdown b/source/_posts/2017-12-17-release-60.markdown index 6ec45d50acd..b4afdf02547 100644 --- a/source/_posts/2017-12-17-release-60.markdown +++ b/source/_posts/2017-12-17-release-60.markdown @@ -121,7 +121,7 @@ Experiencing issues introduced by this release? Please report them in our [issue - Added force_update for REST sensor ([@foxel] - [#11016]) ([sensor.miflora docs]) ([sensor.mqtt docs]) ([sensor.rest docs]) - Add support for Logitech UE Smart Radios. ([@GreenTurtwig] - [#10077]) ([media_player.ue_smart_radio docs]) (new-platform) - Make notify.html5 depend on config ([@balloob] - [#11052]) ([notify.html5 docs]) -- This change fixes the error `OSError: [WinError 193]` on Windows debuggers (i.e. PyCharm) ([@tringler] - [#11034]) +- This change fixes the error `OSError: [WinError 193]` on Windows debuggers (i.e., PyCharm) ([@tringler] - [#11034]) - Added support for cover in tellstick ([@perfalk] - [#10858]) ([tellstick docs]) ([cover.tellstick docs]) (new-platform) - Add a caldav calendar component ([@maxlaverse] - [#10842]) ([calendar.caldav docs]) (new-platform) - Add GPS coords to meraki ([@addelovein] - [#10998]) ([device_tracker.meraki docs]) diff --git a/source/_posts/2018-01-14-release-61.markdown b/source/_posts/2018-01-14-release-61.markdown index fba4b0fd1a8..eed5ed65952 100644 --- a/source/_posts/2018-01-14-release-61.markdown +++ b/source/_posts/2018-01-14-release-61.markdown @@ -760,7 +760,7 @@ Note however, that this feature was replaced by a new ignore_string config optio [switch.transmission docs]: /integrations/transmission [switch.xiaomi_miio docs]: /integrations/switch.xiaomi_miio/ [tahoma docs]: /integrations/tahoma/ -[telegram_bot docs]: /integrations/telegram_chatbot/ +[telegram_bot docs]: /integrations/telegram_bot/ [timer docs]: /integrations/timer/ [tts.baidu docs]: /integrations/baidu [tts.marytts docs]: /integrations/marytts diff --git a/source/_posts/2018-02-10-release-63.markdown b/source/_posts/2018-02-10-release-63.markdown index dcf388d94af..0eaafb14648 100644 --- a/source/_posts/2018-02-10-release-63.markdown +++ b/source/_posts/2018-02-10-release-63.markdown @@ -127,7 +127,7 @@ Experiencing issues introduced by this release? Please report them in our [issue - Map media_stop to idle state ([@akloeckner] - [#11819]) - Adds allergy/disease sensor platform from Pollen.com ([@bachya] - [#11573]) ([sensor.pollen docs]) (new-platform) - check_config.py: allow colorlog==3.1. ([@dotlambda] - [#11927]) -- Weblink - Allow relative urls in config ([@ReneNulschDE] - [#11808]) ([weblink docs]) +- Weblink - Allow relative urls in config ([@ReneNulschDE] - [#11808]) - Panel_Iframe - Allow relative urls in config ([@ReneNulschDE] - [#11832]) ([panel_iframe docs]) - Python 3.6 invalid escape sequence deprecation fixes ([@scop] - [#11941]) - tests: Use assertEqual instead of deprecated assertEquals ([@scop] - [#11943]) @@ -622,7 +622,6 @@ Experiencing issues introduced by this release? Please report them in our [issue [wake_on_lan docs]: /integrations/wake_on_lan/ [waterfurnace docs]: /integrations/waterfurnace/ [weather.openweathermap docs]: /integrations/openweathermap#weather -[weblink docs]: /integrations/weblink/ [websocket_api docs]: /integrations/websocket_api/ [zha docs]: /integrations/zha/ [zha.const docs]: /integrations/zha.const/ diff --git a/source/_posts/2018-02-26-release-64.markdown b/source/_posts/2018-02-26-release-64.markdown index 72a5c8cff7e..e58b5fcdeae 100644 --- a/source/_posts/2018-02-26-release-64.markdown +++ b/source/_posts/2018-02-26-release-64.markdown @@ -139,7 +139,7 @@ Experiencing issues introduced by this release? Please report them in our [issue - check_config check bootstrap errors ([@kellerza] - [#12291]) - Attempt fixing flakiness of check config test ([@balloob] - [#12283]) - Fix MQTT retained message not being re-dispatched ([@OttoWinter] - [#12004]) ([mqtt docs]) -- Fix config error for FTP links, add test ([@ReneNulschDE] - [#12294]) ([weblink docs]) +- Fix config error for FTP links, add test ([@ReneNulschDE] - [#12294]) - Fix Panel_IFrame - FTP URL not allowed in 0.63 ([@ReneNulschDE] - [#12295]) ([panel_iframe docs]) - Upgrade pylint to 1.8.2 ([@OttoWinter] - [#12274]) - Move HassIntent handler code into helpers/intent ([@tschmidty69] - [#12181]) ([conversation docs]) @@ -576,11 +576,10 @@ Experiencing issues introduced by this release? Please report them in our [issue [switch.smappee docs]: /integrations/smappee [switch.xiaomi_miio docs]: /integrations/switch.xiaomi_miio/ [tahoma docs]: /integrations/tahoma/ -[telegram_bot docs]: /integrations/telegram_chatbot/ +[telegram_bot docs]: /integrations/telegram_bot/ [vacuum.xiaomi_miio docs]: /integrations/vacuum.xiaomi_miio/ [vera docs]: /integrations/vera/ [weather.buienradar docs]: /integrations/buienradar -[weblink docs]: /integrations/weblink/ [xiaomi_aqara docs]: /integrations/xiaomi_aqara/ [zha docs]: /integrations/zha/ [#12635]: https://github.com/home-assistant/home-assistant/pull/12635 diff --git a/source/_posts/2018-03-30-release-66.markdown b/source/_posts/2018-03-30-release-66.markdown index bf0ec721ad6..939ae2a063f 100644 --- a/source/_posts/2018-03-30-release-66.markdown +++ b/source/_posts/2018-03-30-release-66.markdown @@ -550,7 +550,7 @@ Experiencing issues introduced by this release? Please report them in our [issue [switch.vesync docs]: /integrations/vesync#switches [switch.xiaomi_miio docs]: /integrations/switch.xiaomi_miio/ [switch.zha docs]: /integrations/zha -[telegram_bot docs]: /integrations/telegram_chatbot/ +[telegram_bot docs]: /integrations/telegram_bot/ [upcloud docs]: /integrations/upcloud/ [vacuum.xiaomi_miio docs]: /integrations/vacuum.xiaomi_miio/ [weather.darksky docs]: /integrations/weather.darksky/ diff --git a/source/_posts/2018-05-18-release-70.markdown b/source/_posts/2018-05-18-release-70.markdown index 1fde7339710..60cd476658b 100644 --- a/source/_posts/2018-05-18-release-70.markdown +++ b/source/_posts/2018-05-18-release-70.markdown @@ -432,7 +432,7 @@ Experiencing issues introduced by this release? Please report them in our [issue [switch.tahoma docs]: /integrations/tahoma [system_log docs]: /integrations/system_log/ [tahoma docs]: /integrations/tahoma/ -[telegram_bot docs]: /integrations/telegram_chatbot/ +[telegram_bot docs]: /integrations/telegram_bot/ [tts docs]: /integrations/tts/ [updater docs]: /integrations/updater/ [weather.bom docs]: /integrations/bom diff --git a/source/_posts/2018-06-10-release-71.markdown b/source/_posts/2018-06-10-release-71.markdown index 83443597398..ab53fcad357 100644 --- a/source/_posts/2018-06-10-release-71.markdown +++ b/source/_posts/2018-06-10-release-71.markdown @@ -56,7 +56,7 @@ Experiencing issues introduced by this release? Please report them in our [issue - BOM sensor: `'Wind Direction kt'` to `'Wind Speed kt'` (fixes #14535) ([@fabaff] - [#14541]) ([sensor.bom docs]) (breaking change) - Removed attribute current_time from Raincloudy sensors to avoid being triggered by recorder component ([@tchellomello] - [#14584]) ([raincloud docs]) ([switch.raincloud docs]) (breaking change) - Remove Notify My Android component as it shut down on May 24 ([@cgarwood] - [#14594]) ([notify docs]) (breaking change) -- CoinMarketCap sensor: It is no longer possible to query a ticker by the name of the currency (i.e. bitcoin). The API instead uses IDs (integers) for these tickers (i.e. bitcoin -> 1). Rounding of decimals is now configurable, because it made no sense to round to 2 decimals if display_currency was set to BTC, some values showed up as 0.00. (#14437) ([@kotlarz] - [#14604]) ([sensor.coinmarketcap docs]) (breaking change) +- CoinMarketCap sensor: It is no longer possible to query a ticker by the name of the currency (i.e., bitcoin). The API instead uses IDs (integers) for these tickers (i.e., bitcoin -> 1). Rounding of decimals is now configurable, because it made no sense to round to 2 decimals if display_currency was set to BTC, some values showed up as 0.00. (#14437) ([@kotlarz] - [#14604]) ([sensor.coinmarketcap docs]) (breaking change) - Give unknown zwave nodes a better name and don't add them to entity registry ([@andrey-git] - [#14353]) ([zwave docs]) (breaking change) - The `netdata` sensor was re-worked to support all available details from [Netdata](https://my-netdata.io/). This requires you to adjust the your existing configuration if you use the `netdata` sensor. ([@fabaff] - [#14613]) ([sensor.netdata docs]) (breaking change) diff --git a/source/_posts/2018-09-15-release-78.markdown b/source/_posts/2018-09-15-release-78.markdown index 92655fe1979..ddebd0a075c 100644 --- a/source/_posts/2018-09-15-release-78.markdown +++ b/source/_posts/2018-09-15-release-78.markdown @@ -480,7 +480,7 @@ The configuration value type should no longer be used. ([@endor-force] - [#15935 [switch.tahoma docs]: /integrations/tahoma [switch.tplink docs]: /integrations/tplink [tahoma docs]: /integrations/tahoma/ -[telegram_bot docs]: /integrations/telegram_chatbot/ +[telegram_bot docs]: /integrations/telegram_bot/ [tts docs]: /integrations/tts/ [upnp docs]: /integrations/upnp/ [vacuum docs]: /integrations/vacuum/ diff --git a/source/_posts/2018-10-12-release-80.markdown b/source/_posts/2018-10-12-release-80.markdown index fa54d4a3f93..4351081033e 100644 --- a/source/_posts/2018-10-12-release-80.markdown +++ b/source/_posts/2018-10-12-release-80.markdown @@ -80,7 +80,7 @@ On the devices side, we got basic support for the new IKEA TRÅDFRI switches, Ho [camera.blink docs]: /integrations/blink [cloud docs]: /integrations/cloud/ [sensor.blink docs]: /integrations/blink -[telegram_bot docs]: /integrations/telegram_chatbot/ +[telegram_bot docs]: /integrations/telegram_bot/ ## Release 0.80.3 - October 18 @@ -709,7 +709,7 @@ Experiencing issues introduced by this release? Please report them in our [issue [switch.tradfri docs]: /integrations/tradfri [switch.volvooncall docs]: /integrations/volvooncall [switch.xiaomi_aqara docs]: /integrations/switch.xiaomi_aqara/ -[telegram_bot docs]: /integrations/telegram_chatbot/ +[telegram_bot docs]: /integrations/telegram_bot/ [tibber docs]: /integrations/tibber/ [timer docs]: /integrations/timer/ [tradfri docs]: /integrations/tradfri/ diff --git a/source/_posts/2018-10-29-release-81.markdown b/source/_posts/2018-10-29-release-81.markdown index 8ac74a3bdb7..17466e657ec 100644 --- a/source/_posts/2018-10-29-release-81.markdown +++ b/source/_posts/2018-10-29-release-81.markdown @@ -843,7 +843,7 @@ Experiencing issues introduced by this release? Please report them in our [issue [switch.xiaomi_aqara docs]: /integrations/switch.xiaomi_aqara/ [switch.xiaomi_miio docs]: /integrations/switch.xiaomi_miio/ [switch.zwave docs]: /integrations/zwave -[telegram_bot docs]: /integrations/telegram_chatbot/ +[telegram_bot docs]: /integrations/telegram_bot/ [tts docs]: /integrations/tts/ [twilio docs]: /integrations/twilio/ [unifi docs]: /integrations/unifi/ diff --git a/source/_posts/2018-11-08-release-82.markdown b/source/_posts/2018-11-08-release-82.markdown index cdc29a83f86..1f95b61a1a3 100644 --- a/source/_posts/2018-11-08-release-82.markdown +++ b/source/_posts/2018-11-08-release-82.markdown @@ -678,7 +678,7 @@ Experiencing issues introduced by this release? Please report them in our [issue [switch.xiaomi_aqara docs]: /integrations/switch.xiaomi_aqara/ [switch.xiaomi_miio docs]: /integrations/switch.xiaomi_miio/ [switch.zigbee docs]: /integrations/zigbee#switch -[telegram_bot docs]: /integrations/telegram_chatbot/ +[telegram_bot docs]: /integrations/telegram_bot/ [tts docs]: /integrations/tts/ [twilio docs]: /integrations/twilio/ [updater docs]: /integrations/updater/ diff --git a/source/_posts/2019-03-13-release-89.markdown b/source/_posts/2019-03-13-release-89.markdown index 906e336ab93..d407e4730cc 100644 --- a/source/_posts/2019-03-13-release-89.markdown +++ b/source/_posts/2019-03-13-release-89.markdown @@ -713,7 +713,7 @@ Experiencing issues introduced by this release? Please report them in our [issue [switch.tplink docs]: /integrations/tplink [system_log docs]: /integrations/system_log/ [tahoma docs]: /integrations/tahoma/ -[telegram_bot docs]: /integrations/telegram_chatbot/ +[telegram_bot docs]: /integrations/telegram_bot/ [tellduslive docs]: /integrations/tellduslive/ [tibber docs]: /integrations/tibber/ [toon docs]: /integrations/toon/ diff --git a/source/_posts/2019-04-03-release-91.markdown b/source/_posts/2019-04-03-release-91.markdown index 7e6886ff03f..907e0548259 100644 --- a/source/_posts/2019-04-03-release-91.markdown +++ b/source/_posts/2019-04-03-release-91.markdown @@ -210,7 +210,7 @@ Experiencing issues introduced by this release? Please report them in our [issue - __Axis__ - Events supplied from component might differ. Events will not be configurable in the beginning but will instead provide a subset set of events supported per device. This will be configurable in a later stage when config entry options are available. Configuration.yaml support for Axis component will be removed in the future so make sure to remove references to Axis component after upgrade. ([@Kane610] - [#18543]) ([axis docs]) - __HTTP__ - Lower severity level of log messages from http.view ([@thomasloven] - [#21091]) ([http docs]) - __Dark Sky__ - Dark Sky provides hourly forecasts for various monitored conditions. This change creates new sensors for each hourly forecasted condition with suffix `_h` while adding the suffix `_d` to the daily forecasted conditions. For example, now a `sensor.dark_sky_summary_d` and `sensor.dark_sky_summary_h` will be created if the forecast and hourly_forecast parameters are populated. ([@rtclauss] - [#21820]) ([darksky docs]) -- __Konnected__ - This will change the internal unique_id for Konnected switches (i.e. siren, buzzer, generic switch). Users will need to manually remove the orphaned switch entities from the entity registry after updating and re-configure any changes stored in the entity registry (i.e. name and entity_id), as their unique IDs will change. ([@heythisisnate] - [#22389]) ([konnected docs]) +- __Konnected__ - This will change the internal unique_id for Konnected switches (i.e., siren, buzzer, generic switch). Users will need to manually remove the orphaned switch entities from the entity registry after updating and re-configure any changes stored in the entity registry (i.e., name and entity_id), as their unique IDs will change. ([@heythisisnate] - [#22389]) ([konnected docs]) - __Mopar__ - The mopar sensor platform has been broken up into a base component with sensor, switch, and lock platforms. The sensor.mopar_remote_command service has been removed since the functionality has been folded into the new platforms and the new mopar.sound_horn service. Please view the documentation to see the new setup instructions. ([@rohankapoorcom] - [#21526]) ([mopar docs]) @@ -831,7 +831,7 @@ Experiencing issues introduced by this release? Please report them in our [issue [switch docs]: /integrations/switch/ [switchbot docs]: /integrations/switchbot/ [systemmonitor docs]: /integrations/systemmonitor/ -[telegram_bot docs]: /integrations/telegram_chatbot/ +[telegram_bot docs]: /integrations/telegram_bot/ [tellduslive docs]: /integrations/tellduslive/ [tfiac docs]: /integrations/tfiac/ [tibber docs]: /integrations/tibber/ diff --git a/source/_posts/2019-04-24-release-92.markdown b/source/_posts/2019-04-24-release-92.markdown index 3f74e2d99e3..421882711cf 100644 --- a/source/_posts/2019-04-24-release-92.markdown +++ b/source/_posts/2019-04-24-release-92.markdown @@ -1076,7 +1076,7 @@ Experiencing issues introduced by this release? Please report them in our [issue [stream docs]: /integrations/stream/ [supla docs]: /integrations/supla/ [switch docs]: /integrations/switch/ -[telegram_bot docs]: /integrations/telegram_chatbot/ +[telegram_bot docs]: /integrations/telegram_bot/ [tellduslive docs]: /integrations/tellduslive/ [tplink docs]: /integrations/tplink/ [trend docs]: /integrations/trend/ diff --git a/source/_posts/2019-05-16-release-93.markdown b/source/_posts/2019-05-16-release-93.markdown index 11b761ad1a0..92b8925b8d5 100644 --- a/source/_posts/2019-05-16-release-93.markdown +++ b/source/_posts/2019-05-16-release-93.markdown @@ -853,7 +853,7 @@ Experiencing issues introduced by this release? Please report them in our [issue [systemmonitor docs]: /integrations/systemmonitor/ [tapsaff docs]: /integrations/tapsaff/ [ted5000 docs]: /integrations/ted5000/ -[telegram_bot docs]: /integrations/telegram_chatbot/ +[telegram_bot docs]: /integrations/telegram_bot/ [tellduslive docs]: /integrations/tellduslive/ [tensorflow docs]: /integrations/tensorflow/ [thethingsnetwork docs]: /integrations/thethingsnetwork/ diff --git a/source/_posts/2019-08-28-release-98.markdown b/source/_posts/2019-08-28-release-98.markdown index d9e5434ade0..b94a38bf296 100644 --- a/source/_posts/2019-08-28-release-98.markdown +++ b/source/_posts/2019-08-28-release-98.markdown @@ -371,7 +371,7 @@ anymore. - ([@abmantis] - [#25971]) - Update sensor.py ([@MatsNl] - [#25825]) ([statistics docs]) - Add pip-wheel-metadata in .gitignore ([@oncleben31] - [#25832]) - Fix configuration field name ([@skarcha] - [#25840]) ([plex docs]) -- Allow components with empty list config (i.e. person) in packages ([@kellerza] - [#25827]) +- Allow components with empty list config (i.e., person) in packages ([@kellerza] - [#25827]) - Make reproduce state use platform instead of rely on function ([@balloob] - [#25856]) ([climate docs]) ([group docs]) ([media_player docs]) - Type check various base components ([@scop] - [#25878]) - Fix script/translations_develop launch + clean some unused error i18n ([@Quentame] - [#25459]) ([arcam_fmj docs]) ([heos docs]) ([tellduslive docs]) ([twentemilieu docs]) ([upnp docs]) ([vesync docs]) ([zha docs]) diff --git a/source/_posts/2019-10-10-release-100.markdown b/source/_posts/2019-10-10-release-100.markdown index 540ed759270..f8b9ab5d5a6 100644 --- a/source/_posts/2019-10-10-release-100.markdown +++ b/source/_posts/2019-10-10-release-100.markdown @@ -234,7 +234,7 @@ Experiencing issues introduced by this release? Please report them in our [issue - **Ecobee** - Ecobee will now be set up via config flow. Existing users will have their config imported from ecobee.conf via an import flow so it shouldn't break their experience. Users configuring via configuration.yaml will have their api key and options imported into the flow but will still need to finish authorization via the flow (instead of the configurator component as previously). The configuration parameter `hold_temp` has been removed, as it was not being used in the climate platform and had no effect on whether the temperature was held indefinitely or not. Users will need to remove the parameter `hold_temp` from configuration.yaml. - Ecobee-specific services will now be registered under the ecobee domain rather than the climate domain, and service names will not include the prefix "ecobee\_" (e.g. the service "climate.ecobee_resume_program" will become "ecobee.resume_program"). - ([@marthoc] - [#26634]) ([ecobee docs]) + Ecobee-specific services will now be registered under the ecobee domain rather than the climate domain, and service names will not include the prefix "ecobee\_" (e.g., the service "climate.ecobee_resume_program" will become "ecobee.resume_program"). - ([@marthoc] - [#26634]) ([ecobee docs]) - **Transmission** - The Transmission integration can now be configured through a config flow via Integrations in the GUI. Once configured all sensors and switches will be created and available for the user. `monitored_conditions` has been removed so existing users need to update their configuration in configuration.yaml and remove monitored conditions. The existing configuration will be imported as an entry under Integrations. - ([@engrbm87] - [#26434]) ([transmission docs]) @@ -270,14 +270,14 @@ Experiencing issues introduced by this release? Please report them in our [issue - **Evohome** - Device state attributes keys have been changed to snake_case and, since this a breaking change, the opportunity was taken to revise/simplify the entire device state attributes schema. Evohome is a complicated integration, has had major changes in recent times, and is not yet mature - these changes address some bugs and related architectural issues: - - Modify behavior of set_temperature to mirror that of the vendor's UI (e.g. any target temp changes until next setpoint, unless explicitly set otherwise) + - Modify behavior of set_temperature to mirror that of the vendor's UI (e.g., any target temp changes until next setpoint, unless explicitly set otherwise) - Setpoint datetimes are now correctly converted to local/aware isoformat (internally, and for logging/state attributes) - Use snake_case for device state attributes - Add a unique_id for each entity (systemId, zoneID, dhwId) - Refactoring - remove API wrappers (no longer using private methods) - Add away mode for DHW (set to permanent off or Auto, depending)([@zxdavb] - [#26810]) ([evohome docs]) -- **OpenTherm** - Move climate entity state to hvac_action attribute to comply with climate 1.0. May break e.g. automations. - ([@mvn23] - [#25931]) ([opentherm_gw docs]) +- **OpenTherm** - Move climate entity state to hvac_action attribute to comply with climate 1.0. May break e.g., automations. - ([@mvn23] - [#25931]) ([opentherm_gw docs]) - **Genius Hub** - Users connecting to a Hub via the v1 API will need to specify a valid MAC address for the hub (see example YAML, below). Those using the v3 API will be unaffected. This change is in preparation for for further changes, so the geniushub entities can be given more appropriate `entity_ids`. diff --git a/source/_posts/2020-01-15-release-104.markdown b/source/_posts/2020-01-15-release-104.markdown index f396523a3e1..d91968f4dda 100644 --- a/source/_posts/2020-01-15-release-104.markdown +++ b/source/_posts/2020-01-15-release-104.markdown @@ -2028,7 +2028,7 @@ Make sure to fill in all fields of the issue template, that is helping us a lot! [tado docs]: /integrations/tado/ [tahoma docs]: /integrations/tahoma/ [tank_utility docs]: /integrations/tank_utility/ -[telegram_bot docs]: /integrations/telegram_chatbot/ +[telegram_bot docs]: /integrations/telegram_bot/ [tellduslive docs]: /integrations/tellduslive/ [template docs]: /integrations/template/ [tesla docs]: /integrations/tesla/ diff --git a/source/_posts/2020-02-05-release-105.markdown b/source/_posts/2020-02-05-release-105.markdown index 50a9221093e..69cca2c0277 100644 --- a/source/_posts/2020-02-05-release-105.markdown +++ b/source/_posts/2020-02-05-release-105.markdown @@ -234,9 +234,9 @@ Experiencing issues introduced by this release? Please report them in our [issue Please ensure your configuration and automations do not use these anymore. - ([@frenck] - [#30831]) ([group docs]) -- __Weblink__ *Deprecated* - The weblink integration is now deprecated and pending removal in Home Assistant 0.107.0. This integration only works with the old states UI. - ([@frenck] - [#30834]) ([weblink docs]) +- __Weblink__ *Deprecated* - The weblink integration is now deprecated and pending removal in Home Assistant 0.107.0. This integration only works with the old states UI. - ([@frenck] - [#30834]) -- __History Graph__ *Deprecated* - The `history_graph` integration has been deprecated and pending for removal in Home Assistant 0.107.0. This integration was used for the old states UI. Going ahead, please ensure this configuration option is not used in your configuration. - ([@frenck] - [#30835]) ([history_graph docs]) +- __History Graph__ *Deprecated* - The `history_graph` integration has been deprecated and pending for removal in Home Assistant 0.107.0. This integration was used for the old states UI. Going ahead, please ensure this configuration option is not used in your configuration. - ([@frenck] - [#30835]) - __Neato__ - This change adds a neato boundary name to the state if it exists, requiring to potentially update automations. - ([@Olen] - [#29915]) ([neato docs]) @@ -774,9 +774,9 @@ Hats over your heart for these shuttered integrations. Pour one out for: - Use collection helpers for input_datetime component ([@Adminiuga] - [#30815]) ([input_datetime docs]) - Handle location API being exhausted ([@balloob] - [#30798]) - Deprecate states UI options in group integration ([@frenck] - [#30831]) ([group docs]) (breaking change) -- Deprecate weblink integration ([@frenck] - [#30834]) ([weblink docs]) (breaking change) +- Deprecate weblink integration ([@frenck] - [#30834]) (breaking change) - Deprecate hide_if_away from device_tracker ([@frenck] - [#30833]) ([device_tracker docs]) (breaking change) -- Deprecate history_graph integration ([@frenck] - [#30835]) ([history_graph docs]) (breaking change) +- Deprecate history_graph integration ([@frenck] - [#30835]) (breaking change) - Remove unused import ([@dshokouhi] - [#30858]) ([ring docs]) - Bump pyvizio version to 0.1.1 ([@raman325] - [#30867]) ([vizio docs]) - Update pyatmo to 3.2.2 and add available attribute ([@cgtobi] - [#30882]) ([netatmo docs]) @@ -1458,7 +1458,6 @@ Hats over your heart for these shuttered integrations. Pour one out for: [group docs]: /integrations/group/ [hassio docs]: /integrations/hassio/ [hisense_aehw4a1 docs]: /integrations/hisense_aehw4a1/ -[history_graph docs]: /integrations/history_graph/ [hlk_sw16 docs]: /integrations/hlk_sw16/ [homeassistant docs]: /integrations/homeassistant/ [homekit docs]: /integrations/homekit/ @@ -1551,7 +1550,6 @@ Hats over your heart for these shuttered integrations. Pour one out for: [versasense docs]: /integrations/versasense/ [vicare docs]: /integrations/vicare/ [vizio docs]: /integrations/vizio/ -[weblink docs]: /integrations/weblink/ [webostv docs]: /integrations/webostv/ [wemo docs]: /integrations/wemo/ [withings docs]: /integrations/withings/ diff --git a/source/_posts/2020-02-26-release-106-3.markdown b/source/_posts/2020-02-26-release-106-3.markdown new file mode 100644 index 00000000000..cd0cab55772 --- /dev/null +++ b/source/_posts/2020-02-26-release-106-3.markdown @@ -0,0 +1,70 @@ +--- +layout: post +title: "0.106.3: Coronavirus integration (COVID-19), track the outbreak" +description: "A special release of Home Assistant, adding the Coronavirus integration (COVID-19)." +date: 2020-03-02 00:00:00 +date_formatted: "March 02, 2020" +author: Franck Nijhof +author_twitter: frenck +comments: true +categories: Release-Notes +og_image: /images/blog/2020-03-0.106.3/social.png +--- + + + +In December 2019, an outbreak of a novel [Coronavirus](https://en.wikipedia.org/wiki/Coronavirus) +also called severe acute respiratory syndrome coronavirus-2 +([SARS-CoV-2](https://en.wikipedia.org/wiki/Severe_acute_respiratory_syndrome_coronavirus_2)), +began in the Wuhan region of China. This virus can cause the +[COVID-19](https://en.wikipedia.org/wiki/Coronavirus_disease_2019) disease. + +This novel Coronavirus is spreading globally at a disturbing rate, which keeps +everybody on top of the news. The media worldwide is covering the spread of +the virus constantly, and a lot of people are tracking the number of cases +in their country. + +This special release adds the [Coronavirus integration](/integrations/coronavirus), +allowing you to track the outbreak from within Home Assistant. + +## The Coronavirus integration + +While having a meeting at [Nabu Casa](https://www.nabucasa.com/), +we caught ourselves talking a lot about the state of the virus spreading in +the countries we live in. Which brought us to the subject of being able to +track the virus in Home Assistant itself. + +So together, we started working on an integration right away. We decided to +bring you a special release of Home Assistant that includes this integration. + +The Coronavirus integration tracks the number of people that are confirmed with, +recovered from, and deceased caused by the virus in your country, or worldwide. + +The data is sourced from the [Johns Hopkins University](https://www.arcgis.com/apps/opsdashboard/index.html#/bda7594740fd40299423467b48e9ecf6). + +

    +Screenshot of the Coronavirus integration in Home Assistant +Screenshot of the Coronavirus integration in Home Assistant. +

    + +## Adding the Coronavirus integration + +This integration can be configured via the Home Assistant frontend. + +- Go to **Configuration** -> **Integrations**. +- Click on the `+` in the bottom right corner to add a new integration. +- Search and select the **Coronavirus** integration form the list. +- Follow the instruction on screen to add the sensors. Either choose for adding + world-wide sensors, or a specific set of sensors for your country. + +If you want to track both world-wide and one or more countries at the same time, +you can repeat the configuration process described above to add multiple +instances of the integration. + +## Resources + +For the latest information about the Coronavirus, be sure check the website +of the [World Health Organization](https://www.who.int/). The WHO provides +good information on +[basic protective measures](https://www.who.int/emergencies/diseases/novel-coronavirus-2019/advice-for-public) +you can take against the new Coronavirus. diff --git a/source/_posts/2020-02-26-release-106.markdown b/source/_posts/2020-02-26-release-106.markdown index ae5db35adb7..362767ba7eb 100644 --- a/source/_posts/2020-02-26-release-106.markdown +++ b/source/_posts/2020-02-26-release-106.markdown @@ -197,7 +197,9 @@ Experiencing issues introduced by this release? Please report them in our [issue - **Core** - Only administrator users can stop or restart Home Assistant. - ([@balloob] - [#31509]) ([homeassistant docs]) -- **Sure Petcare** - Sure Petcare supports new features and has improved existing features. As a result, you will want to note that `household_id` has been removed from configuration options as it is no longer needed. - ([@benleb] - [#31437]) ([surepetcare docs]) +- **Sure Petcare** - Sure Petcare supports new features and has improved existing features. As a result, you will want to note that the format of the `feeders`/`flaps`/`pets` options changed from a map (`id`/`name`) to a simple list of IDs, which means the `name` option is removed. The `name` is now gathered directly from the Sure Petcare API but changeable via the HA UI. + + The `household_id` (which is no longer needed) and customizing options `icon` and `device_class` are also removed but can still be configured via the UI. - ([@benleb] - [#31437]) ([surepetcare docs]) Example YAML configuration: @@ -228,7 +230,7 @@ Experiencing issues introduced by this release? Please report them in our [issue input_type: discrete_input ``` -- **Tado** - Adding support of multiple Tado accounts has changed the unique ID generation of sensor and climate devices, and now includes the ID of the home. +- **Tado** - Adding support of multiple Tado accounts has changed the unique ID generation of sensor and climate devices, and now includes the ID of the home. As a result you will see new entity ID's for `sensor` and `climate` devices. In addition, support for water heater zones has been added. Tado hot water zones with temperature control previously created a climate entity, e.g., `climate.hot_water`, and these will be replaced by a `water_heater.hot_water` entity. This change is not breaking for hot water zones without temperature control as they do not have a climate zone. @@ -333,6 +335,100 @@ Experiencing issues introduced by this release? Please report them in our [issue - Updated frontend to 20200220.4 ([@bramkragten] - [#32205]) ([frontend docs]) (beta fix) - Remove deprecated Hue options (fixes CI) ([@frenck] - [#32027]) ([hue docs]) (breaking change) (beta fix) +## Release 0.106.1 - February 27 + +- Add missing translations for light actions ([@emontnemery] - [#32216]) ([light docs]) +- Mark clients away if they have never been seen. ([@lociii] - [#32222]) ([unifi docs]) +- Fix DSMR 5 ([@dupondje] - [#32233]) ([dsmr docs]) +- Bump simplisafe-python to 9.0.0 ([@bachya] - [#32215]) ([simplisafe docs]) +- Bump simplisafe-python to 9.0.2 ([@bachya] - [#32273]) ([simplisafe docs]) +- deCONZ - Race condition on slower systems ([@Kane610] - [#32274]) ([deconz docs]) +- Catch more Hue errors ([@balloob] - [#32275]) ([hue docs]) + +[#32215]: https://github.com/home-assistant/home-assistant/pull/32215 +[#32216]: https://github.com/home-assistant/home-assistant/pull/32216 +[#32222]: https://github.com/home-assistant/home-assistant/pull/32222 +[#32233]: https://github.com/home-assistant/home-assistant/pull/32233 +[#32273]: https://github.com/home-assistant/home-assistant/pull/32273 +[#32274]: https://github.com/home-assistant/home-assistant/pull/32274 +[#32275]: https://github.com/home-assistant/home-assistant/pull/32275 +[@Kane610]: https://github.com/Kane610 +[@bachya]: https://github.com/bachya +[@balloob]: https://github.com/balloob +[@dupondje]: https://github.com/dupondje +[@emontnemery]: https://github.com/emontnemery +[@lociii]: https://github.com/lociii +[deconz docs]: /integrations/deconz/ +[dsmr docs]: /integrations/dsmr/ +[hue docs]: /integrations/hue/ +[light docs]: /integrations/light/ +[simplisafe docs]: /integrations/simplisafe/ +[unifi docs]: /integrations/unifi/ + +## Release 0.106.2 - February 28 + +- Updated frontend to 20200220.5 ([@bramkragten] - [#32312]) ([frontend docs]) +- revent saving/deleting Lovelace config in safe mode ([@balloob] - [#32319]) ([lovelace docs]) +- UniFi - Temporary workaround to get device tracker to mark cli… ([@Kane610] - [#32321]) ([unifi docs]) +- Ensure rest sensors are marked unavailable when http requests… ([@bdraco] - [#32309]) ([rest docs]) + +[#32309]: https://github.com/home-assistant/home-assistant/pull/32309 +[#32312]: https://github.com/home-assistant/home-assistant/pull/32312 +[#32319]: https://github.com/home-assistant/home-assistant/pull/32319 +[#32321]: https://github.com/home-assistant/home-assistant/pull/32321 +[@Kane610]: https://github.com/Kane610 +[@balloob]: https://github.com/balloob +[@bdraco]: https://github.com/bdraco +[@bramkragten]: https://github.com/bramkragten +[frontend docs]: /integrations/frontend/ +[lovelace docs]: /integrations/lovelace/ +[rest docs]: /integrations/rest/ +[unifi docs]: /integrations/unifi/ + +## Release 0.106.3 - March 2 + +Added a Coronavirus integration to help monitor the ongoing epidemic. [More information here.](/blog/2020/03/02/release-106-3/) + +## Release 0.106.4 - March 2 + +- Fixed TypeError with old server versions ([@elmurato] - [#32329]) ([minecraft_server docs]) +- Bump pyeight to 0.1.4 ([@mezz64] - [#32363]) ([eight_sleep docs]) +- Catch Eight Sleep API errors, don't round None type ([@mezz64] - [#32410]) +- Coronavirus updates ([@balloob] - [#32417]) +- Add unique ID to coronavirus ([@balloob] - [#32423]) + +[#32329]: https://github.com/home-assistant/core/pull/32329 +[#32363]: https://github.com/home-assistant/core/pull/32363 +[#32410]: https://github.com/home-assistant/core/pull/32410 +[#32417]: https://github.com/home-assistant/core/pull/32417 +[#32423]: https://github.com/home-assistant/core/pull/32423 +[@balloob]: https://github.com/balloob +[@elmurato]: https://github.com/elmurato +[@mezz64]: https://github.com/mezz64 +[eight_sleep docs]: /integrations/eight_sleep/ +[minecraft_server docs]: /integrations/minecraft_server/ + +## Release 0.106.5 - March 3 + +- Fix too many device tracker updates in log for Tesla ([@alandtse] - [#32426]) +- Filter out duplicate logbook states ([@balloob] - [#32427]) +- Properly define dependency for pvoutput integration on rest in… ([@bdraco] - [#32435]) +- Fix pushover's ATTR_RETRY env variable typo ([@axilleas] - [#32440]) +- Remove hassfest blacklisted rest ([@balloob] - [#32441]) +- UniFi - Fix websocket bug ([@Kane610] - [#32449]) + +[#32426]: https://github.com/home-assistant/core/pull/32426 +[#32427]: https://github.com/home-assistant/core/pull/32427 +[#32435]: https://github.com/home-assistant/core/pull/32435 +[#32440]: https://github.com/home-assistant/core/pull/32440 +[#32441]: https://github.com/home-assistant/core/pull/32441 +[#32449]: https://github.com/home-assistant/core/pull/32449 +[@Kane610]: https://github.com/Kane610 +[@alandtse]: https://github.com/alandtse +[@axilleas]: https://github.com/axilleas +[@balloob]: https://github.com/balloob +[@bdraco]: https://github.com/bdraco + ## All changes - Change scan_interval defaults for Tesla ([@alandtse] - [#31194]) ([tesla docs]) (breaking change) @@ -1097,7 +1193,7 @@ Experiencing issues introduced by this release? Please report them in our [issue [system_log docs]: /integrations/system_log/ [tado docs]: /integrations/tado/ [tahoma docs]: /integrations/tahoma/ -[telegram_bot docs]: /integrations/telegram_chatbot/ +[telegram_bot docs]: /integrations/telegram_bot/ [template docs]: /integrations/template/ [tensorflow docs]: /integrations/tensorflow/ [tesla docs]: /integrations/tesla/ diff --git a/source/_posts/2020-02-28-community-highlights.markdown b/source/_posts/2020-02-28-community-highlights.markdown new file mode 100644 index 00000000000..2b511862628 --- /dev/null +++ b/source/_posts/2020-02-28-community-highlights.markdown @@ -0,0 +1,100 @@ +--- +title: "Community Highlights: 4th edition" +description: "3D All the things!" +date: 2020-02-28 00:00:00 +date_formatted: "February 28, 2020" +author: Franck Nijhof +author_twitter: frenck +categories: Community +og_image: /images/blog/2020-02-28-community-highlights/social.png +--- + +For the 4th edition, I thought it fitted to devote the community highlights to 3D! + +_That is actually a lie, the [3rd edition](/blog/2020/02/19/community-highlights/) +would have been much more fitting, but was hijacked by Paulus ;) +At least it's my 3rd community highlight writeup, so that counts, right?_ + +Ready for some highly inspiring and mind-blowing 3D creations? + +## 3D home navigation and control, using Unity + +Are you sure you ready? Because Harrie de Groot created a fully navigatable +3D model of his home using Unity, accessible from within Home Assistant. + +You really **need** to watch the video below now... + +
    + +
    + +Well done, Harrie! That looks slick! + +More details on his creation can be found on the +[Home Assistant Community Forum](https://community.home-assistant.io/t/3d-home-navigation-control-unity-home-assistant/174972). + +## 3D printed interactive floorplan + +If you have been around a bit, you might have come across a screenshot of +someone with an interactive floorplan in Home Assistant. [Ryan Connolly](https://twitter.com/rynam0) +took that idea straight into the real world by 3D printing his floorplan, +wired it, and hooked it up Home Assistant. + +Talking about taking things into another dimension... + + + +### Getting started with your own 3D floorplan + +Ok, so the above two, rather impressive, listings might be a bit out of reach +for the most of us. Still, with some help, you could still achieve some pretty +nice looking 3D floorplans. [Aaron Godfrey](https://github.com/boralyl) wrote a +couple of excellent blog posts on this. + +In his [first blog post](https://aarongodfrey.dev/home%20automation/floorplan-in-home-assistant/), +Aaron shows you what his floorplan looks like + +
    + +
    + +He followed up with two blog posting on how to achieve this: + +- [Tips for creating a Floorplan in Sweet Home 3D](https://aarongodfrey.dev/home%20automation/tips_for_creating_a_3d_floorplan_using_sweethome3d/) +- [Creating an Interactive 3D Floorplan in Home Assistant](https://aarongodfrey.dev/home%20automation/creating-a-3d-floorplan-in-home-assistant/) + +### Bonus tip: HomeByMe + +I've personally got recommended a tool for creating a 3D floorplan with a tool +that is generally lesser-known, but actually pretty awesome! [HomeByMe](https://home.by.me/en/) + +Screenshot of HomeByMe. + +This is a result of a 3D floorplan created with [HomeByMe](https://home.by.me/en/). + +It works fully in the browser and I enjoyed the experience using that. +So credits where credits due: Thanks for recommending me this sweet little +gem [Andrea Donno](https://www.twitter.com/andreadonno)! + +## Got a tip for the next edition? + +Have you seen (or made) something awesome, interesting, unique, amazing, inspirational, unusual or funny, using Home Assistant? + +[Click here to send us your Community Highlight suggestion](/suggest-community-highlight). + +Also, don't forget to share your creations with us via Social Media: + +- Twitter it! Be sure to mention [@home_assistant][twitter] +- Share it on our [Facebook group][facebook-group] +- Post it to our [subreddit][reddit] +- Tag [@homeasssistant][instagram] on Instagram +- Or via chat, drop us a line in the [#lounge at Discord][chat] + +See you next edition! + +[chat]: https://www.home-assistant.io/join-chat +[facebook-group]: https://www.facebook.com/groups/HomeAssistant/ +[instagram]: https://www.instagram.com/homeassistant/ +[reddit]: https://www.reddit.com/r/homeassistant +[twitter]: https://www.twitter.com/home_assistant diff --git a/source/_redirects b/source/_redirects index 85c6100244f..321aa5292db 100644 --- a/source/_redirects +++ b/source/_redirects @@ -373,7 +373,6 @@ /components/device_tracker.unifi_direct /integrations/unifi_direct /components/device_tracker.upc_connect /integrations/upc_connect /components/device_tracker.volvooncall /integrations/volvooncall -/components/device_tracker.xfinity /integrations/xfinity /components/device_tracker.xiaomi_miio /integrations/xiaomi_miio /components/fan.comfoconnect /integrations/comfoconnect /components/fan.dyson /integrations/dyson#fan @@ -1420,7 +1419,6 @@ /components/hikvision /integrations/hikvision /components/hikvisioncam /integrations/hikvisioncam /components/history /integrations/history -/components/history_graph /integrations/history_graph /components/history_stats /integrations/history_stats /components/hitron_coda /integrations/hitron_coda /components/hive /integrations/hive @@ -1887,7 +1885,7 @@ /components/ted5000 /integrations/ted5000 /components/teksavvy /integrations/teksavvy /components/telegram /integrations/telegram -/components/telegram_bot /integrations/telegram_chatbot +/components/telegram_bot /integrations/telegram_bot /components/tellduslive /integrations/tellduslive /components/tellstick /integrations/tellstick /components/telnet /integrations/telnet @@ -1989,7 +1987,6 @@ /components/weather.darksky /integrations/weather.darksky /components/webhook /integrations/webhook /components/webhooks /integrations/telegram_webhooks -/components/weblink /integrations/weblink /components/webostv /integrations/webostv /components/websocket_api /integrations/websocket_api /components/wemo /integrations/wemo @@ -2008,7 +2005,6 @@ /components/x10 /integrations/x10 /components/xbox_live /integrations/xbox_live /components/xeoma /integrations/xeoma -/components/xfinity /integrations/xfinity /components/xiaomi /integrations/xiaomi /components/xiaomi_aqara /integrations/xiaomi_aqara /components/xiaomi_miio /integrations/xiaomi_miio @@ -2040,9 +2036,9 @@ # Breaking changes /integrations/switch.pca /integrations/elv +/integrations/telegram_chatbot /integrations/telegram_bot -# App documentation -/ios/whats-new https://companion.home-assistant.io/docs/getting_started/getting-started +# Moved documentation /docs/ecosystem/ios/ https://companion.home-assistant.io/ /docs/ecosystem/ios/devices_file https://companion.home-assistant.io/ /docs/ecosystem/ios/integration https://companion.home-assistant.io/docs/integrations/integrations @@ -2056,7 +2052,21 @@ /docs/ecosystem/ios/notifications/privacy_security_rate_limits https://companion.home-assistant.io/docs/notifications/notifications-basic /docs/ecosystem/ios/notifications/requesting_location_updates https://companion.home-assistant.io/docs/notifications/notifications-basic /docs/ecosystem/ios/notifications/sounds https://companion.home-assistant.io/docs/notifications/notification-sounds +/docs/ecosystem/notebooks https://data.home-assistant.io +/docs/ecosystem/notebooks/api https://data.home-assistant.io +/docs/ecosystem/notebooks/database https://data.home-assistant.io +/docs/ecosystem/notebooks/graph https://data.home-assistant.io +/docs/ecosystem/notebooks/installation https://data.home-assistant.io +/docs/ecosystem/notebooks/stats https://data.home-assistant.io +/docs/frontend/mobile https://companion.home-assistant.io /ecosystem/ios/notifications https://companion.home-assistant.io/docs/notifications/notifications-basic +/ecosystem/notebooks https://data.home-assistant.io +/ecosystem/notebooks/api https://data.home-assistant.io +/ecosystem/notebooks/database https://data.home-assistant.io +/ecosystem/notebooks/graph https://data.home-assistant.io +/ecosystem/notebooks/installation https://data.home-assistant.io +/ecosystem/notebooks/stats https://data.home-assistant.io +/ios/whats-new https://companion.home-assistant.io/docs/getting_started/getting-started # Add-ons /addons/cec_scan https://github.com/home-assistant/hassio-addons/blob/master/cec_scan/README.md diff --git a/source/cloud/index.markdown b/source/cloud/index.markdown index a16af21ad7c..b172af08f5a 100644 --- a/source/cloud/index.markdown +++ b/source/cloud/index.markdown @@ -2,10 +2,10 @@ title: "Home Assistant Cloud" description: "Enable the Home Assistant Cloud integration." sidebar: false -logo: home-assistant.png ha_release: "0.60" ha_category: Voice ha_iot_class: Cloud Push +ha_domain: cloud --- Home Assistant Cloud is a subscription service provided by our partner Nabu Casa, Inc. Check out [their website](https://www.nabucasa.com) for more information on features, pricing and [how to configure Home Assistant](https://www.nabucasa.com/config/). diff --git a/source/docs/index.markdown b/source/docs/index.markdown index 8d2a4446926..489af81e433 100644 --- a/source/docs/index.markdown +++ b/source/docs/index.markdown @@ -8,7 +8,7 @@ The documentation covers beginner to advanced topics around the installation, se
    - +
    Hass.io
    @@ -20,13 +20,13 @@ The documentation covers beginner to advanced topics around the installation, se
    - +
    Z-Wave
    - +
    MQTT
    @@ -38,7 +38,7 @@ The documentation covers beginner to advanced topics around the installation, se
    - +
    iOS
    diff --git a/source/getting-started/configuration.markdown b/source/getting-started/configuration.markdown index 09f63818744..257af1defe4 100644 --- a/source/getting-started/configuration.markdown +++ b/source/getting-started/configuration.markdown @@ -11,23 +11,23 @@ The steps below do not apply to Home Assistant Core installations, for those typ
    -We are going to help you make your first changes to `configuration.yaml`. To do this, we are going to install an add-on from the Home Assistant add-on store: the Configurator. To get to the add-on store, click on the menu icon in the top left, then click on Supervisor. On the new page, open the add-on store tab. +We are going to help you make your first changes to `configuration.yaml`. To do this, we are going to install an add-on from the Home Assistant add-on store: the File editor. To get to the add-on store, click on the menu icon in the top left, then click on Supervisor. On the new page, open the add-on store tab.

    -From the Hass.io main panel, open the add-on store. +From the Supervisor main panel, open the add-on store.

    -Under the "Core" section you will find Configurator. +Under the "Official add-ons" section you will find the File editor add-on. - - Click on Configurator and click on INSTALL. When installation is complete, the UI will go to the add-on details page for the configurator. + - Click on File Editor and click on INSTALL. When installation is complete, the UI will go to the add-on details page for the file editor. - Now start the add-on by clicking on START. - Open the user interface by clicking on OPEN WEB UI. -Now let's make a change using the configurator: we are going to change the name, location, unit system, and time zone of your Home Assistant installation. +Now let's make a change using the file editor: we are going to change the name, location, unit system, and time zone of your Home Assistant installation. - - Click the folder icon in the top left of the configurator window to open the file browser sidebar. - - Click the `configuration.yaml` file (in the `/config/` folder) to load it into the main Configurator edit window. + - Click the folder icon in the top left of the file editor window to open the file browser sidebar. + - Click the `configuration.yaml` file (in the `/config/` folder) to load it into the main file editor window. - Add the following to this file (preferably at the very top, but it ultimately doesn't matter): ```yaml homeassistant: diff --git a/source/hassio/index.markdown b/source/hassio/index.markdown index fd05b8106a7..5241e043899 100644 --- a/source/hassio/index.markdown +++ b/source/hassio/index.markdown @@ -20,7 +20,7 @@ The advantages of using Home Assistant: - Active community that is helpful and sharing add-ons including AppDaemon, Homebridge and InfluxDB.

    [Browse the forums »][forums]
    [Join the Home Assistant chat »][chat]
    [Browse community add-on repositories »][comm-add-ons]

    - +
    ### Upgrading @@ -40,6 +40,6 @@ Home Assistant dashboard with upgrade notification (under the hamburger menu -> [comm-add-ons]: https://community.home-assistant.io/tags/hassio-repository [all]: /addons/ [chat]: https://discord.gg/K3UVxJd -[Home Assistant Operating System]: https://github.com/home-assistant/homeassistant +[Home Assistant Operating System]: https://github.com/home-assistant/operating-system [Home Assistant Core]: https://www.home-assistant.io/docs/installation/ [install]: /hassio/installation/ diff --git a/source/hassio/installation.markdown b/source/hassio/installation.markdown index 604dfd3ba82..33109490214 100644 --- a/source/hassio/installation.markdown +++ b/source/hassio/installation.markdown @@ -166,9 +166,8 @@ Debian/Ubuntu: ```bash sudo -i -apt-get install software-properties-common apt-get update -apt-get install -y apparmor-utils apt-transport-https avahi-daemon ca-certificates curl dbus jq network-manager socat +apt-get install -y software-properties-common apparmor-utils apt-transport-https avahi-daemon ca-certificates curl dbus jq network-manager socat systemctl disable ModemManager curl -fsSL get.docker.com | sh ``` @@ -197,7 +196,6 @@ curl -sL "https://raw.githubusercontent.com/home-assistant/hassio-installer/mast - `odroid-c2` - `odroid-cu2` - `odroid-xu` -- `orangepi-prime` - `tinker` - `qemuarm` - `qemuarm-64` @@ -217,21 +215,21 @@ A detailed guide about running Home Assistant as a virtual machine is available [balenaEtcher]: https://www.balena.io/etcher [Virtual Appliance]: https://github.com/home-assistant/operating-system/blob/dev/Documentation/boards/ova.md [hassos-network]: https://github.com/home-assistant/operating-system/blob/dev/Documentation/network.md -[pi0-w]: https://github.com/home-assistant/operating-system/releases/download/3.11/hassos_rpi0-w-3.11.img.gz -[pi1]: https://github.com/home-assistant/operating-system/releases/download/3.11/hassos_rpi-3.11.img.gz -[pi2]: https://github.com/home-assistant/operating-system/releases/download/3.11/hassos_rpi2-3.11.img.gz -[pi3-32]: https://github.com/home-assistant/operating-system/releases/download/3.11/hassos_rpi3-3.11.img.gz -[pi3-64]: https://github.com/home-assistant/operating-system/releases/download/3.11/hassos_rpi3-64-3.11.img.gz -[pi4-32]: https://github.com/home-assistant/operating-system/releases/download/3.11/hassos_rpi4-3.11.img.gz -[pi4-64]: https://github.com/home-assistant/operating-system/releases/download/3.11/hassos_rpi4-64-3.11.img.gz -[tinker]: https://github.com/home-assistant/operating-system/releases/download/3.11/hassos_tinker-3.11.img.gz -[odroid-c2]: https://github.com/home-assistant/operating-system/releases/download/3.11/hassos_odroid-c2-3.11.img.gz -[odroid-n2]: https://github.com/home-assistant/operating-system/releases/download/4.3/hassos_odroid-n2-4.3.img.gz -[odroid-xu4]: https://github.com/home-assistant/operating-system/releases/download/3.11/hassos_odroid-xu4-3.11.img.gz -[intel-nuc]: https://github.com/home-assistant/operating-system/releases/download/3.11/hassos_intel-nuc-3.11.img.gz -[vmdk]: https://github.com/home-assistant/operating-system/releases/download/3.11/hassos_ova-3.11.vmdk.gz -[vhdx]: https://github.com/home-assistant/operating-system/releases/download/3.11/hassos_ova-3.11.vhdx.gz -[vdi]: https://github.com/home-assistant/operating-system/releases/download/3.11/hassos_ova-3.11.vdi.gz +[pi0-w]: https://github.com/home-assistant/operating-system/releases/download/3.12/hassos_rpi0-w-3.12.img.gz +[pi1]: https://github.com/home-assistant/operating-system/releases/download/3.12/hassos_rpi-3.12.img.gz +[pi2]: https://github.com/home-assistant/operating-system/releases/download/3.12/hassos_rpi2-3.12.img.gz +[pi3-32]: https://github.com/home-assistant/operating-system/releases/download/3.12/hassos_rpi3-3.12.img.gz +[pi3-64]: https://github.com/home-assistant/operating-system/releases/download/3.12/hassos_rpi3-64-3.12.img.gz +[pi4-32]: https://github.com/home-assistant/operating-system/releases/download/3.12/hassos_rpi4-3.12.img.gz +[pi4-64]: https://github.com/home-assistant/operating-system/releases/download/3.12/hassos_rpi4-64-3.12.img.gz +[tinker]: https://github.com/home-assistant/operating-system/releases/download/3.12/hassos_tinker-3.12.img.gz +[odroid-c2]: https://github.com/home-assistant/operating-system/releases/download/3.12/hassos_odroid-c2-3.12.img.gz +[odroid-n2]: https://github.com/home-assistant/operating-system/releases/download/4.4/hassos_odroid-n2-4.4.img.gz +[odroid-xu4]: https://github.com/home-assistant/operating-system/releases/download/3.12/hassos_odroid-xu4-3.12.img.gz +[intel-nuc]: https://github.com/home-assistant/operating-system/releases/download/3.12/hassos_intel-nuc-3.12.img.gz +[vmdk]: https://github.com/home-assistant/operating-system/releases/download/3.12/hassos_ova-3.12.vmdk.gz +[vhdx]: https://github.com/home-assistant/operating-system/releases/download/3.12/hassos_ova-3.12.vhdx.gz +[vdi]: https://github.com/home-assistant/operating-system/releases/download/3.12/hassos_ova-3.12.vdi.gz [linux]: https://github.com/home-assistant/hassio-installer [local]: http://homeassistant.local:8123 [samba]: /addons/samba/ diff --git a/source/images/architecture/architecture-remote.png b/source/images/architecture/architecture-remote.png deleted file mode 100644 index 3d9b3cb2a5c..00000000000 Binary files a/source/images/architecture/architecture-remote.png and /dev/null differ diff --git a/source/images/architecture/component_interaction.png b/source/images/architecture/component_interaction.png deleted file mode 100644 index a5f2a7a1825..00000000000 Binary files a/source/images/architecture/component_interaction.png and /dev/null differ diff --git a/source/images/architecture/ha_architecture.png b/source/images/architecture/ha_architecture.png deleted file mode 100644 index ad72d0c59dd..00000000000 Binary files a/source/images/architecture/ha_architecture.png and /dev/null differ diff --git a/source/images/architecture/ha_full_architecture.png b/source/images/architecture/ha_full_architecture.png deleted file mode 100644 index 24823eb1aab..00000000000 Binary files a/source/images/architecture/ha_full_architecture.png and /dev/null differ diff --git a/source/images/architecture/intents.png b/source/images/architecture/intents.png deleted file mode 100644 index ac31e4af7a7..00000000000 Binary files a/source/images/architecture/intents.png and /dev/null differ diff --git a/source/images/blog/2015-08-laundry-automation/moteino.jpg b/source/images/blog/2015-08-laundry-automation/moteino.jpg deleted file mode 100644 index 49089af872e..00000000000 Binary files a/source/images/blog/2015-08-laundry-automation/moteino.jpg and /dev/null differ diff --git a/source/images/blog/2015-08-laundry-automation/moteino2.jpg b/source/images/blog/2015-08-laundry-automation/moteino2.jpg deleted file mode 100644 index 39e4d13c774..00000000000 Binary files a/source/images/blog/2015-08-laundry-automation/moteino2.jpg and /dev/null differ diff --git a/source/images/blog/2015-08-laundry-automation/reed-switch.jpg b/source/images/blog/2015-08-laundry-automation/reed-switch.jpg deleted file mode 100644 index 8ded6f9f0e4..00000000000 Binary files a/source/images/blog/2015-08-laundry-automation/reed-switch.jpg and /dev/null differ diff --git a/source/images/blog/2018-12-logitech-harmony-removes-local-api/forum-post-4.png b/source/images/blog/2018-12-logitech-harmony-removes-local-api/forum-post-4.png deleted file mode 100644 index 9a071872302..00000000000 Binary files a/source/images/blog/2018-12-logitech-harmony-removes-local-api/forum-post-4.png and /dev/null differ diff --git a/source/images/blog/2018-12-logitech-harmony-removes-local-api/vuln-timeline.png b/source/images/blog/2018-12-logitech-harmony-removes-local-api/vuln-timeline.png deleted file mode 100644 index 7681a2bbe49..00000000000 Binary files a/source/images/blog/2018-12-logitech-harmony-removes-local-api/vuln-timeline.png and /dev/null differ diff --git a/source/images/blog/2020-01-0.104/lovelace-suggestion.png b/source/images/blog/2020-01-0.104/lovelace-suggestion.png deleted file mode 100644 index b5f07b0f31e..00000000000 Binary files a/source/images/blog/2020-01-0.104/lovelace-suggestion.png and /dev/null differ diff --git a/source/images/blog/2020-02-0.105/zone-editor.png b/source/images/blog/2020-02-0.105/zone-editor.png deleted file mode 100644 index 9de454fd5ad..00000000000 Binary files a/source/images/blog/2020-02-0.105/zone-editor.png and /dev/null differ diff --git a/source/images/blog/2020-02-28-community-highlights/homebyme.png b/source/images/blog/2020-02-28-community-highlights/homebyme.png new file mode 100644 index 00000000000..f0d0edc79e5 Binary files /dev/null and b/source/images/blog/2020-02-28-community-highlights/homebyme.png differ diff --git a/source/images/blog/2020-02-28-community-highlights/social.png b/source/images/blog/2020-02-28-community-highlights/social.png new file mode 100644 index 00000000000..841b721690a Binary files /dev/null and b/source/images/blog/2020-02-28-community-highlights/social.png differ diff --git a/source/images/blog/2020-03-0.106.3/components.png b/source/images/blog/2020-03-0.106.3/components.png new file mode 100644 index 00000000000..1681b1eb51e Binary files /dev/null and b/source/images/blog/2020-03-0.106.3/components.png differ diff --git a/source/images/blog/2020-03-0.106.3/screenshot.png b/source/images/blog/2020-03-0.106.3/screenshot.png new file mode 100644 index 00000000000..9b5317b2bae Binary files /dev/null and b/source/images/blog/2020-03-0.106.3/screenshot.png differ diff --git a/source/images/blog/2020-03-0.106.3/social.png b/source/images/blog/2020-03-0.106.3/social.png new file mode 100644 index 00000000000..b288f739d17 Binary files /dev/null and b/source/images/blog/2020-03-0.106.3/social.png differ diff --git a/source/images/blog/ha-logo-material-big.png b/source/images/blog/ha-logo-material-big.png deleted file mode 100644 index 1f803834290..00000000000 Binary files a/source/images/blog/ha-logo-material-big.png and /dev/null differ diff --git a/source/images/blog/ha-logo-material-small.png b/source/images/blog/ha-logo-material-small.png deleted file mode 100644 index aaab575401b..00000000000 Binary files a/source/images/blog/ha-logo-material-small.png and /dev/null differ diff --git a/source/images/blog/ha-logo-original.png b/source/images/blog/ha-logo-original.png deleted file mode 100644 index 67eed19efc4..00000000000 Binary files a/source/images/blog/ha-logo-original.png and /dev/null differ diff --git a/source/images/docs/scripts/sun-conditions-source.ods b/source/images/docs/scripts/sun-conditions-source.ods deleted file mode 100644 index 444793e1a77..00000000000 Binary files a/source/images/docs/scripts/sun-conditions-source.ods and /dev/null differ diff --git a/source/images/frontend/choose-language.png b/source/images/frontend/choose-language.png deleted file mode 100644 index fc9beab263b..00000000000 Binary files a/source/images/frontend/choose-language.png and /dev/null differ diff --git a/source/images/frontend/choose-theme.png b/source/images/frontend/choose-theme.png deleted file mode 100644 index dd1f4d4968f..00000000000 Binary files a/source/images/frontend/choose-theme.png and /dev/null differ diff --git a/source/images/frontend/frontend-badges.png b/source/images/frontend/frontend-badges.png deleted file mode 100644 index 4f26b007cec..00000000000 Binary files a/source/images/frontend/frontend-badges.png and /dev/null differ diff --git a/source/images/frontend/frontend-cards.png b/source/images/frontend/frontend-cards.png deleted file mode 100644 index ea46cb17bf6..00000000000 Binary files a/source/images/frontend/frontend-cards.png and /dev/null differ diff --git a/source/images/frontend/frontend-cards1.png b/source/images/frontend/frontend-cards1.png deleted file mode 100644 index b2bec716533..00000000000 Binary files a/source/images/frontend/frontend-cards1.png and /dev/null differ diff --git a/source/images/frontend/frontend-more-info-light.png b/source/images/frontend/frontend-more-info-light.png deleted file mode 100644 index 5b4d6d482e1..00000000000 Binary files a/source/images/frontend/frontend-more-info-light.png and /dev/null differ diff --git a/source/images/frontpage/sotu2019.png b/source/images/frontpage/sotu2019.png deleted file mode 100644 index a53990a5fa5..00000000000 Binary files a/source/images/frontpage/sotu2019.png and /dev/null differ diff --git a/source/images/gravatar.jpg b/source/images/gravatar.jpg deleted file mode 100644 index 85fa115eac7..00000000000 Binary files a/source/images/gravatar.jpg and /dev/null differ diff --git a/source/images/hadashboard/alarm_panel.png b/source/images/hadashboard/alarm_panel.png deleted file mode 100644 index 35c741af082..00000000000 Binary files a/source/images/hadashboard/alarm_panel.png and /dev/null differ diff --git a/source/images/hassio/architecture.png b/source/images/hassio/architecture.png deleted file mode 100644 index 098d4bd6826..00000000000 Binary files a/source/images/hassio/architecture.png and /dev/null differ diff --git a/source/images/hassio/screenshots/addon-hass-configurator.png b/source/images/hassio/screenshots/addon-hass-configurator.png deleted file mode 100644 index 7fa3d7f3c8d..00000000000 Binary files a/source/images/hassio/screenshots/addon-hass-configurator.png and /dev/null differ diff --git a/source/images/hassio/screenshots/local_repository.png b/source/images/hassio/screenshots/local_repository.png deleted file mode 100644 index a924efbab58..00000000000 Binary files a/source/images/hassio/screenshots/local_repository.png and /dev/null differ diff --git a/source/images/hassio/tutorial/addon_hello_world_logs.png b/source/images/hassio/tutorial/addon_hello_world_logs.png deleted file mode 100644 index 70930d4ad63..00000000000 Binary files a/source/images/hassio/tutorial/addon_hello_world_logs.png and /dev/null differ diff --git a/source/images/hassio/tutorial/python3-http-server.png b/source/images/hassio/tutorial/python3-http-server.png deleted file mode 100644 index 80f1bd1754d..00000000000 Binary files a/source/images/hassio/tutorial/python3-http-server.png and /dev/null differ diff --git a/source/images/hassio/tutorial/samba.png b/source/images/hassio/tutorial/samba.png deleted file mode 100644 index 1b8866cd600..00000000000 Binary files a/source/images/hassio/tutorial/samba.png and /dev/null differ diff --git a/source/images/hassio/tutorial/ssh.png b/source/images/hassio/tutorial/ssh.png deleted file mode 100644 index 4a67db29b65..00000000000 Binary files a/source/images/hassio/tutorial/ssh.png and /dev/null differ diff --git a/source/images/home-assistant-logo-2164x2164.png b/source/images/home-assistant-logo-2164x2164.png deleted file mode 100644 index fd8067e1e1d..00000000000 Binary files a/source/images/home-assistant-logo-2164x2164.png and /dev/null differ diff --git a/source/images/integrations/alexa/alexa_app_cover_position.png b/source/images/integrations/alexa/alexa_app_cover_position.png deleted file mode 100644 index 4fde3a0d51d..00000000000 Binary files a/source/images/integrations/alexa/alexa_app_cover_position.png and /dev/null differ diff --git a/source/images/integrations/apple_tv/authenticate.png b/source/images/integrations/apple_tv/authenticate.png deleted file mode 100644 index e5695da2cde..00000000000 Binary files a/source/images/integrations/apple_tv/authenticate.png and /dev/null differ diff --git a/source/images/integrations/apple_tv/credentials.png b/source/images/integrations/apple_tv/credentials.png deleted file mode 100644 index 586c82263b0..00000000000 Binary files a/source/images/integrations/apple_tv/credentials.png and /dev/null differ diff --git a/source/images/integrations/calendar/todoist-108x108.png b/source/images/integrations/calendar/todoist-108x108.png deleted file mode 100644 index 31ddfc5481b..00000000000 Binary files a/source/images/integrations/calendar/todoist-108x108.png and /dev/null differ diff --git a/source/images/integrations/calendar/todoist-512x512.png b/source/images/integrations/calendar/todoist-512x512.png deleted file mode 100644 index 37adcda6ab4..00000000000 Binary files a/source/images/integrations/calendar/todoist-512x512.png and /dev/null differ diff --git a/source/images/ios/NotificationActionFlow.png b/source/images/ios/NotificationActionFlow.png deleted file mode 100644 index d540608f59e..00000000000 Binary files a/source/images/ios/NotificationActionFlow.png and /dev/null differ diff --git a/source/images/ios/PushNotificationLayout.png b/source/images/ios/PushNotificationLayout.png deleted file mode 100644 index d9f2998dd9b..00000000000 Binary files a/source/images/ios/PushNotificationLayout.png and /dev/null differ diff --git a/source/images/ios/attachment.png b/source/images/ios/attachment.png deleted file mode 100644 index c62aab734d5..00000000000 Binary files a/source/images/ios/attachment.png and /dev/null differ diff --git a/source/images/ios/control1.png b/source/images/ios/control1.png deleted file mode 100644 index 1cbb53092b8..00000000000 Binary files a/source/images/ios/control1.png and /dev/null differ diff --git a/source/images/ios/control2.png b/source/images/ios/control2.png deleted file mode 100644 index a5a728fd805..00000000000 Binary files a/source/images/ios/control2.png and /dev/null differ diff --git a/source/images/ios/expanded_attachment.png b/source/images/ios/expanded_attachment.png deleted file mode 100644 index f2c632caa69..00000000000 Binary files a/source/images/ios/expanded_attachment.png and /dev/null differ diff --git a/source/images/isy994/isy994_SensorExample.png b/source/images/isy994/isy994_SensorExample.png deleted file mode 100644 index 7802c7b2f7c..00000000000 Binary files a/source/images/isy994/isy994_SensorExample.png and /dev/null differ diff --git a/source/images/isy994/isy994_SensorStatusExample.png b/source/images/isy994/isy994_SensorStatusExample.png deleted file mode 100644 index 96f8a27a95e..00000000000 Binary files a/source/images/isy994/isy994_SensorStatusExample.png and /dev/null differ diff --git a/source/images/isy994/isy994_SwitchExample.png b/source/images/isy994/isy994_SwitchExample.png deleted file mode 100644 index 7a925c04a34..00000000000 Binary files a/source/images/isy994/isy994_SwitchExample.png and /dev/null differ diff --git a/source/images/lovelace/lovelace_glance_card_custom_title.png b/source/images/lovelace/lovelace_glance_card_custom_title.png deleted file mode 100644 index a884b960cc4..00000000000 Binary files a/source/images/lovelace/lovelace_glance_card_custom_title.png and /dev/null differ diff --git a/source/images/lovelace/lovelace_mediaplayer.png b/source/images/lovelace/lovelace_mediaplayer.png index fcdccde36da..c8476106141 100644 Binary files a/source/images/lovelace/lovelace_mediaplayer.png and b/source/images/lovelace/lovelace_mediaplayer.png differ diff --git a/source/images/lovelace/lovelace_plant.png b/source/images/lovelace/lovelace_plant.png deleted file mode 100644 index 4e0af04ecc6..00000000000 Binary files a/source/images/lovelace/lovelace_plant.png and /dev/null differ diff --git a/source/images/lovelace/lovelace_unused_entites.png b/source/images/lovelace/lovelace_unused_entites.png deleted file mode 100644 index 75d175364f8..00000000000 Binary files a/source/images/lovelace/lovelace_unused_entites.png and /dev/null differ diff --git a/source/images/screenshots/android-homescreen-guide.gif b/source/images/screenshots/android-homescreen-guide.gif deleted file mode 100644 index 659907a1122..00000000000 Binary files a/source/images/screenshots/android-homescreen-guide.gif and /dev/null differ diff --git a/source/images/screenshots/blink_example_frontend.png b/source/images/screenshots/blink_example_frontend.png deleted file mode 100644 index 65038448602..00000000000 Binary files a/source/images/screenshots/blink_example_frontend.png and /dev/null differ diff --git a/source/images/screenshots/create-component01.png b/source/images/screenshots/create-component01.png deleted file mode 100644 index 44b5bc03457..00000000000 Binary files a/source/images/screenshots/create-component01.png and /dev/null differ diff --git a/source/images/screenshots/developer-tool-events-icon.png b/source/images/screenshots/developer-tool-events-icon.png deleted file mode 100644 index 12df27e4c0a..00000000000 Binary files a/source/images/screenshots/developer-tool-events-icon.png and /dev/null differ diff --git a/source/images/screenshots/developer-tool-mqtt-icon.png b/source/images/screenshots/developer-tool-mqtt-icon.png deleted file mode 100644 index e7783d7836a..00000000000 Binary files a/source/images/screenshots/developer-tool-mqtt-icon.png and /dev/null differ diff --git a/source/images/screenshots/group-views.png b/source/images/screenshots/group-views.png deleted file mode 100644 index 60232b2d792..00000000000 Binary files a/source/images/screenshots/group-views.png and /dev/null differ diff --git a/source/images/screenshots/hello-world-state-card.png b/source/images/screenshots/hello-world-state-card.png deleted file mode 100644 index ad375e963b8..00000000000 Binary files a/source/images/screenshots/hello-world-state-card.png and /dev/null differ diff --git a/source/images/screenshots/instapush.png b/source/images/screenshots/instapush.png deleted file mode 100644 index 4043186d647..00000000000 Binary files a/source/images/screenshots/instapush.png and /dev/null differ diff --git a/source/images/screenshots/jupyter-graph.png b/source/images/screenshots/jupyter-graph.png deleted file mode 100644 index 9740213a44f..00000000000 Binary files a/source/images/screenshots/jupyter-graph.png and /dev/null differ diff --git a/source/images/screenshots/jupyter-notebook.png b/source/images/screenshots/jupyter-notebook.png deleted file mode 100644 index 04ca37e8290..00000000000 Binary files a/source/images/screenshots/jupyter-notebook.png and /dev/null differ diff --git a/source/images/screenshots/more-info-dialog-light.png b/source/images/screenshots/more-info-dialog-light.png deleted file mode 100644 index 855fb6b4559..00000000000 Binary files a/source/images/screenshots/more-info-dialog-light.png and /dev/null differ diff --git a/source/images/screenshots/netatmo_module.png b/source/images/screenshots/netatmo_module.png deleted file mode 100644 index eb4d477a0a9..00000000000 Binary files a/source/images/screenshots/netatmo_module.png and /dev/null differ diff --git a/source/images/screenshots/plex-configure.png b/source/images/screenshots/plex-configure.png deleted file mode 100644 index e360493e35c..00000000000 Binary files a/source/images/screenshots/plex-configure.png and /dev/null differ diff --git a/source/images/screenshots/plex-token.png b/source/images/screenshots/plex-token.png deleted file mode 100644 index 970b1c65415..00000000000 Binary files a/source/images/screenshots/plex-token.png and /dev/null differ diff --git a/source/images/supported_brands/17track.png b/source/images/supported_brands/17track.png deleted file mode 100644 index 1d60660ea0c..00000000000 Binary files a/source/images/supported_brands/17track.png and /dev/null differ diff --git a/source/images/supported_brands/HERE_logo.svg b/source/images/supported_brands/HERE_logo.svg deleted file mode 100644 index 3604dac7874..00000000000 --- a/source/images/supported_brands/HERE_logo.svg +++ /dev/null @@ -1,14 +0,0 @@ - - - - - diff --git a/source/images/supported_brands/Ryobi.png b/source/images/supported_brands/Ryobi.png deleted file mode 100644 index a6d2f081d15..00000000000 Binary files a/source/images/supported_brands/Ryobi.png and /dev/null differ diff --git a/source/images/supported_brands/abode.jpg b/source/images/supported_brands/abode.jpg deleted file mode 100644 index e72c4d7be5f..00000000000 Binary files a/source/images/supported_brands/abode.jpg and /dev/null differ diff --git a/source/images/supported_brands/acer.png b/source/images/supported_brands/acer.png deleted file mode 100644 index 83d4b9147b5..00000000000 Binary files a/source/images/supported_brands/acer.png and /dev/null differ diff --git a/source/images/supported_brands/adguard.png b/source/images/supported_brands/adguard.png deleted file mode 100644 index 6bfd89b7b66..00000000000 Binary files a/source/images/supported_brands/adguard.png and /dev/null differ diff --git a/source/images/supported_brands/afraid_freedns.png b/source/images/supported_brands/afraid_freedns.png deleted file mode 100644 index 6355b00182f..00000000000 Binary files a/source/images/supported_brands/afraid_freedns.png and /dev/null differ diff --git a/source/images/supported_brands/aftership.png b/source/images/supported_brands/aftership.png deleted file mode 100644 index 61bbca6f40a..00000000000 Binary files a/source/images/supported_brands/aftership.png and /dev/null differ diff --git a/source/images/supported_brands/airly.png b/source/images/supported_brands/airly.png deleted file mode 100644 index dd6cc4685fd..00000000000 Binary files a/source/images/supported_brands/airly.png and /dev/null differ diff --git a/source/images/supported_brands/airvisual.jpg b/source/images/supported_brands/airvisual.jpg deleted file mode 100644 index c809df0b201..00000000000 Binary files a/source/images/supported_brands/airvisual.jpg and /dev/null differ diff --git a/source/images/supported_brands/android_ip_webcam.png b/source/images/supported_brands/android_ip_webcam.png deleted file mode 100644 index d9f6e6f5d2f..00000000000 Binary files a/source/images/supported_brands/android_ip_webcam.png and /dev/null differ diff --git a/source/images/supported_brands/androidtv.png b/source/images/supported_brands/androidtv.png deleted file mode 100644 index b98653066da..00000000000 Binary files a/source/images/supported_brands/androidtv.png and /dev/null differ diff --git a/source/images/supported_brands/apache_kafka.png b/source/images/supported_brands/apache_kafka.png deleted file mode 100644 index 6e22be0279c..00000000000 Binary files a/source/images/supported_brands/apache_kafka.png and /dev/null differ diff --git a/source/images/supported_brands/apple-homekit.png b/source/images/supported_brands/apple-homekit.png deleted file mode 100644 index 8261f4b5c2d..00000000000 Binary files a/source/images/supported_brands/apple-homekit.png and /dev/null differ diff --git a/source/images/supported_brands/apprise.png b/source/images/supported_brands/apprise.png deleted file mode 100644 index 6dc869a1aea..00000000000 Binary files a/source/images/supported_brands/apprise.png and /dev/null differ diff --git a/source/images/supported_brands/aprs.png b/source/images/supported_brands/aprs.png deleted file mode 100644 index 0bb10adb6cb..00000000000 Binary files a/source/images/supported_brands/aprs.png and /dev/null differ diff --git a/source/images/supported_brands/arcam.svg b/source/images/supported_brands/arcam.svg deleted file mode 100644 index 849787cebeb..00000000000 --- a/source/images/supported_brands/arcam.svg +++ /dev/null @@ -1,6 +0,0 @@ - - - - - - diff --git a/source/images/supported_brands/avahi.png b/source/images/supported_brands/avahi.png deleted file mode 100644 index ebf1d777147..00000000000 Binary files a/source/images/supported_brands/avahi.png and /dev/null differ diff --git a/source/images/supported_brands/avm.png b/source/images/supported_brands/avm.png deleted file mode 100644 index 94dd3d41262..00000000000 Binary files a/source/images/supported_brands/avm.png and /dev/null differ diff --git a/source/images/supported_brands/avri.jpeg b/source/images/supported_brands/avri.jpeg new file mode 100644 index 00000000000..08066f8c5db Binary files /dev/null and b/source/images/supported_brands/avri.jpeg differ diff --git a/source/images/supported_brands/awair.jpg b/source/images/supported_brands/awair.jpg deleted file mode 100644 index 6f1b0d9c125..00000000000 Binary files a/source/images/supported_brands/awair.jpg and /dev/null differ diff --git a/source/images/supported_brands/aws.png b/source/images/supported_brands/aws.png deleted file mode 100644 index 5417dcde712..00000000000 Binary files a/source/images/supported_brands/aws.png and /dev/null differ diff --git a/source/images/supported_brands/azure_event_hub.svg b/source/images/supported_brands/azure_event_hub.svg deleted file mode 100644 index 6e57c82f82c..00000000000 --- a/source/images/supported_brands/azure_event_hub.svg +++ /dev/null @@ -1,22 +0,0 @@ - - - - - - - - - - - - diff --git a/source/images/supported_brands/azure_service_bus.svg b/source/images/supported_brands/azure_service_bus.svg deleted file mode 100644 index 4b39746e62e..00000000000 --- a/source/images/supported_brands/azure_service_bus.svg +++ /dev/null @@ -1,14 +0,0 @@ - - - - - - - - diff --git a/source/images/supported_brands/beaglebone-black.png b/source/images/supported_brands/beaglebone-black.png deleted file mode 100644 index 3fb012d132d..00000000000 Binary files a/source/images/supported_brands/beaglebone-black.png and /dev/null differ diff --git a/source/images/supported_brands/beewi_by_otio.png b/source/images/supported_brands/beewi_by_otio.png deleted file mode 100644 index 6ac5e6f8782..00000000000 Binary files a/source/images/supported_brands/beewi_by_otio.png and /dev/null differ diff --git a/source/images/supported_brands/bmw.png b/source/images/supported_brands/bmw.png deleted file mode 100644 index 7cb7c8d2716..00000000000 Binary files a/source/images/supported_brands/bmw.png and /dev/null differ diff --git a/source/images/supported_brands/brunt.png b/source/images/supported_brands/brunt.png deleted file mode 100644 index 760d04305e5..00000000000 Binary files a/source/images/supported_brands/brunt.png and /dev/null differ diff --git a/source/images/supported_brands/camcorder.png b/source/images/supported_brands/camcorder.png deleted file mode 100644 index 918a5f742ac..00000000000 Binary files a/source/images/supported_brands/camcorder.png and /dev/null differ diff --git a/source/images/supported_brands/centralite.svg b/source/images/supported_brands/centralite.svg deleted file mode 100644 index 33fc5ac7dd1..00000000000 --- a/source/images/supported_brands/centralite.svg +++ /dev/null @@ -1 +0,0 @@ -Centralite_LogoWebai \ No newline at end of file diff --git a/source/images/supported_brands/cisco_webex_teams.png b/source/images/supported_brands/cisco_webex_teams.png deleted file mode 100644 index d6056126e5e..00000000000 Binary files a/source/images/supported_brands/cisco_webex_teams.png and /dev/null differ diff --git a/source/images/supported_brands/citybikes.png b/source/images/supported_brands/citybikes.png deleted file mode 100644 index 7b6abe44337..00000000000 Binary files a/source/images/supported_brands/citybikes.png and /dev/null differ diff --git a/source/images/supported_brands/clementine.png b/source/images/supported_brands/clementine.png deleted file mode 100644 index f7f6596dea6..00000000000 Binary files a/source/images/supported_brands/clementine.png and /dev/null differ diff --git a/source/images/supported_brands/clicksend.png b/source/images/supported_brands/clicksend.png deleted file mode 100644 index 186eede3d4e..00000000000 Binary files a/source/images/supported_brands/clicksend.png and /dev/null differ diff --git a/source/images/supported_brands/cloudflare.png b/source/images/supported_brands/cloudflare.png deleted file mode 100644 index 6fb076250bc..00000000000 Binary files a/source/images/supported_brands/cloudflare.png and /dev/null differ diff --git a/source/images/supported_brands/coinmarketcap.png b/source/images/supported_brands/coinmarketcap.png deleted file mode 100644 index 7366e49ce90..00000000000 Binary files a/source/images/supported_brands/coinmarketcap.png and /dev/null differ diff --git a/source/images/supported_brands/command_line.png b/source/images/supported_brands/command_line.png deleted file mode 100644 index 56ed161c2f9..00000000000 Binary files a/source/images/supported_brands/command_line.png and /dev/null differ diff --git a/source/images/supported_brands/conversation.png b/source/images/supported_brands/conversation.png deleted file mode 100644 index da75e6fac52..00000000000 Binary files a/source/images/supported_brands/conversation.png and /dev/null differ diff --git a/source/images/supported_brands/cups.png b/source/images/supported_brands/cups.png deleted file mode 100644 index 726e46de9c0..00000000000 Binary files a/source/images/supported_brands/cups.png and /dev/null differ diff --git a/source/images/supported_brands/danfoss_air.png b/source/images/supported_brands/danfoss_air.png deleted file mode 100644 index cfaad46e693..00000000000 Binary files a/source/images/supported_brands/danfoss_air.png and /dev/null differ diff --git a/source/images/supported_brands/datadog.png b/source/images/supported_brands/datadog.png deleted file mode 100644 index 25e1f78e346..00000000000 Binary files a/source/images/supported_brands/datadog.png and /dev/null differ diff --git a/source/images/supported_brands/deconz.jpeg b/source/images/supported_brands/deconz.jpeg deleted file mode 100644 index d9474ff74b1..00000000000 Binary files a/source/images/supported_brands/deconz.jpeg and /dev/null differ diff --git a/source/images/supported_brands/delijn.svg b/source/images/supported_brands/delijn.svg deleted file mode 100644 index 8f9ee82532c..00000000000 --- a/source/images/supported_brands/delijn.svg +++ /dev/null @@ -1 +0,0 @@ - \ No newline at end of file diff --git a/source/images/supported_brands/deluge.png b/source/images/supported_brands/deluge.png deleted file mode 100644 index 1969fdd372e..00000000000 Binary files a/source/images/supported_brands/deluge.png and /dev/null differ diff --git a/source/images/supported_brands/digitalloggers.png b/source/images/supported_brands/digitalloggers.png deleted file mode 100644 index aa7b30abad2..00000000000 Binary files a/source/images/supported_brands/digitalloggers.png and /dev/null differ diff --git a/source/images/supported_brands/dlib.png b/source/images/supported_brands/dlib.png deleted file mode 100644 index 92adbfa5b41..00000000000 Binary files a/source/images/supported_brands/dlib.png and /dev/null differ diff --git a/source/images/supported_brands/docker.png b/source/images/supported_brands/docker.png deleted file mode 100644 index c0a31487f36..00000000000 Binary files a/source/images/supported_brands/docker.png and /dev/null differ diff --git a/source/images/supported_brands/downloader.png b/source/images/supported_brands/downloader.png deleted file mode 100644 index 8a5ff5789e9..00000000000 Binary files a/source/images/supported_brands/downloader.png and /dev/null differ diff --git a/source/images/supported_brands/dunehd.png b/source/images/supported_brands/dunehd.png deleted file mode 100644 index 03da1c33e00..00000000000 Binary files a/source/images/supported_brands/dunehd.png and /dev/null differ diff --git a/source/images/supported_brands/econet.png b/source/images/supported_brands/econet.png deleted file mode 100644 index 5245c500489..00000000000 Binary files a/source/images/supported_brands/econet.png and /dev/null differ diff --git a/source/images/supported_brands/eff.png b/source/images/supported_brands/eff.png deleted file mode 100644 index aafcf341dcd..00000000000 Binary files a/source/images/supported_brands/eff.png and /dev/null differ diff --git a/source/images/supported_brands/elgato.jpg b/source/images/supported_brands/elgato.jpg deleted file mode 100644 index 02074bc40de..00000000000 Binary files a/source/images/supported_brands/elgato.jpg and /dev/null differ diff --git a/source/images/supported_brands/elv.png b/source/images/supported_brands/elv.png deleted file mode 100644 index 139d727b3f1..00000000000 Binary files a/source/images/supported_brands/elv.png and /dev/null differ diff --git a/source/images/supported_brands/enedis.png b/source/images/supported_brands/enedis.png deleted file mode 100644 index 115fc2162fb..00000000000 Binary files a/source/images/supported_brands/enedis.png and /dev/null differ diff --git a/source/images/supported_brands/energy_meter.png b/source/images/supported_brands/energy_meter.png deleted file mode 100644 index 602af055d53..00000000000 Binary files a/source/images/supported_brands/energy_meter.png and /dev/null differ diff --git a/source/images/supported_brands/enphase-logo.svg b/source/images/supported_brands/enphase-logo.svg deleted file mode 100644 index 3f8f7b3de38..00000000000 --- a/source/images/supported_brands/enphase-logo.svg +++ /dev/null @@ -1 +0,0 @@ -Artboard 1 \ No newline at end of file diff --git a/source/images/supported_brands/entur.svg b/source/images/supported_brands/entur.svg deleted file mode 100644 index a64ca1543b8..00000000000 --- a/source/images/supported_brands/entur.svg +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - - - - - - diff --git a/source/images/supported_brands/esphome.png b/source/images/supported_brands/esphome.png deleted file mode 100644 index dbc7a4f9a91..00000000000 Binary files a/source/images/supported_brands/esphome.png and /dev/null differ diff --git a/source/images/supported_brands/ethernet.png b/source/images/supported_brands/ethernet.png deleted file mode 100644 index c8785ccb455..00000000000 Binary files a/source/images/supported_brands/ethernet.png and /dev/null differ diff --git a/source/images/supported_brands/ezviz.png b/source/images/supported_brands/ezviz.png new file mode 100644 index 00000000000..ddfb7bd68cd Binary files /dev/null and b/source/images/supported_brands/ezviz.png differ diff --git a/source/images/supported_brands/fail2ban.png b/source/images/supported_brands/fail2ban.png deleted file mode 100644 index 532dff1c4c2..00000000000 Binary files a/source/images/supported_brands/fail2ban.png and /dev/null differ diff --git a/source/images/supported_brands/familyhub.png b/source/images/supported_brands/familyhub.png deleted file mode 100644 index b34b9823a20..00000000000 Binary files a/source/images/supported_brands/familyhub.png and /dev/null differ diff --git a/source/images/supported_brands/ffmpeg.png b/source/images/supported_brands/ffmpeg.png deleted file mode 100644 index 8a120742b08..00000000000 Binary files a/source/images/supported_brands/ffmpeg.png and /dev/null differ diff --git a/source/images/supported_brands/fibaro.png b/source/images/supported_brands/fibaro.png deleted file mode 100644 index cb266067f25..00000000000 Binary files a/source/images/supported_brands/fibaro.png and /dev/null differ diff --git a/source/images/supported_brands/fios.svg b/source/images/supported_brands/fios.svg deleted file mode 100644 index c2bc459e43b..00000000000 --- a/source/images/supported_brands/fios.svg +++ /dev/null @@ -1,130 +0,0 @@ - - - - - - - - - - - - - - image/svg+xml - - - - - - - - - - - - - - - - - - - - - diff --git a/source/images/supported_brands/fitbit.png b/source/images/supported_brands/fitbit.png deleted file mode 100644 index 5204d736ce5..00000000000 Binary files a/source/images/supported_brands/fitbit.png and /dev/null differ diff --git a/source/images/supported_brands/fixer-io.png b/source/images/supported_brands/fixer-io.png deleted file mode 100644 index e149d5b7c3c..00000000000 Binary files a/source/images/supported_brands/fixer-io.png and /dev/null differ diff --git a/source/images/supported_brands/fleetgo.png b/source/images/supported_brands/fleetgo.png deleted file mode 100644 index 1e7355ef094..00000000000 Binary files a/source/images/supported_brands/fleetgo.png and /dev/null differ diff --git a/source/images/supported_brands/flume.jpg b/source/images/supported_brands/flume.jpg deleted file mode 100644 index e1417d08f5d..00000000000 Binary files a/source/images/supported_brands/flume.jpg and /dev/null differ diff --git a/source/images/supported_brands/foobot.png b/source/images/supported_brands/foobot.png deleted file mode 100644 index e8cbc3fb94d..00000000000 Binary files a/source/images/supported_brands/foobot.png and /dev/null differ diff --git a/source/images/supported_brands/fortinet.jpg b/source/images/supported_brands/fortinet.jpg deleted file mode 100644 index b764105fc00..00000000000 Binary files a/source/images/supported_brands/fortinet.jpg and /dev/null differ diff --git a/source/images/supported_brands/freebox.svg b/source/images/supported_brands/freebox.svg deleted file mode 100644 index cc9e6c87c50..00000000000 --- a/source/images/supported_brands/freebox.svg +++ /dev/null @@ -1,45 +0,0 @@ - - - - - - - - - - - - diff --git a/source/images/supported_brands/fronius.png b/source/images/supported_brands/fronius.png deleted file mode 100644 index 6b44d1cb351..00000000000 Binary files a/source/images/supported_brands/fronius.png and /dev/null differ diff --git a/source/images/supported_brands/frontier.png b/source/images/supported_brands/frontier.png deleted file mode 100644 index c99a75bd595..00000000000 Binary files a/source/images/supported_brands/frontier.png and /dev/null differ diff --git a/source/images/supported_brands/fuelcheck.png b/source/images/supported_brands/fuelcheck.png deleted file mode 100644 index 81b47c476f1..00000000000 Binary files a/source/images/supported_brands/fuelcheck.png and /dev/null differ diff --git a/source/images/supported_brands/geofency.png b/source/images/supported_brands/geofency.png deleted file mode 100644 index 50860752d14..00000000000 Binary files a/source/images/supported_brands/geofency.png and /dev/null differ diff --git a/source/images/supported_brands/gios.png b/source/images/supported_brands/gios.png deleted file mode 100644 index ecf74ab70d1..00000000000 Binary files a/source/images/supported_brands/gios.png and /dev/null differ diff --git a/source/images/supported_brands/gitlab.png b/source/images/supported_brands/gitlab.png deleted file mode 100644 index 0273ae49565..00000000000 Binary files a/source/images/supported_brands/gitlab.png and /dev/null differ diff --git a/source/images/supported_brands/global-cache.png b/source/images/supported_brands/global-cache.png deleted file mode 100644 index a711e672ed3..00000000000 Binary files a/source/images/supported_brands/global-cache.png and /dev/null differ diff --git a/source/images/supported_brands/google-assistant.png b/source/images/supported_brands/google-assistant.png deleted file mode 100644 index f5a9bda7e41..00000000000 Binary files a/source/images/supported_brands/google-assistant.png and /dev/null differ diff --git a/source/images/supported_brands/google-pubsub.png b/source/images/supported_brands/google-pubsub.png deleted file mode 100644 index 0ff9a4df927..00000000000 Binary files a/source/images/supported_brands/google-pubsub.png and /dev/null differ diff --git a/source/images/supported_brands/google.png b/source/images/supported_brands/google.png deleted file mode 100644 index adea680f7ea..00000000000 Binary files a/source/images/supported_brands/google.png and /dev/null differ diff --git a/source/images/supported_brands/google_calendar.png b/source/images/supported_brands/google_calendar.png deleted file mode 100644 index b767b764104..00000000000 Binary files a/source/images/supported_brands/google_calendar.png and /dev/null differ diff --git a/source/images/supported_brands/google_cast.png b/source/images/supported_brands/google_cast.png deleted file mode 100644 index be53c784994..00000000000 Binary files a/source/images/supported_brands/google_cast.png and /dev/null differ diff --git a/source/images/supported_brands/google_cloud.png b/source/images/supported_brands/google_cloud.png deleted file mode 100644 index c63cd67ca4d..00000000000 Binary files a/source/images/supported_brands/google_cloud.png and /dev/null differ diff --git a/source/images/supported_brands/google_domains.png b/source/images/supported_brands/google_domains.png deleted file mode 100644 index d1843a45f04..00000000000 Binary files a/source/images/supported_brands/google_domains.png and /dev/null differ diff --git a/source/images/supported_brands/google_maps.png b/source/images/supported_brands/google_maps.png deleted file mode 100644 index ac7fdc0132d..00000000000 Binary files a/source/images/supported_brands/google_maps.png and /dev/null differ diff --git a/source/images/supported_brands/google_wifi.png b/source/images/supported_brands/google_wifi.png deleted file mode 100644 index d304b4d496f..00000000000 Binary files a/source/images/supported_brands/google_wifi.png and /dev/null differ diff --git a/source/images/supported_brands/gpmdp.png b/source/images/supported_brands/gpmdp.png deleted file mode 100644 index abbfada9ae2..00000000000 Binary files a/source/images/supported_brands/gpmdp.png and /dev/null differ diff --git a/source/images/supported_brands/gpslogger.png b/source/images/supported_brands/gpslogger.png deleted file mode 100644 index 04e1d08f5a1..00000000000 Binary files a/source/images/supported_brands/gpslogger.png and /dev/null differ diff --git a/source/images/supported_brands/habitica.png b/source/images/supported_brands/habitica.png deleted file mode 100644 index 79837b46838..00000000000 Binary files a/source/images/supported_brands/habitica.png and /dev/null differ diff --git a/source/images/supported_brands/hangouts.png b/source/images/supported_brands/hangouts.png deleted file mode 100644 index af08baaba2d..00000000000 Binary files a/source/images/supported_brands/hangouts.png and /dev/null differ diff --git a/source/images/supported_brands/hayward.png b/source/images/supported_brands/hayward.png deleted file mode 100644 index 3c644de943b..00000000000 Binary files a/source/images/supported_brands/hayward.png and /dev/null differ diff --git a/source/images/supported_brands/heat-control.png b/source/images/supported_brands/heat-control.png deleted file mode 100644 index eb7821b1a58..00000000000 Binary files a/source/images/supported_brands/heat-control.png and /dev/null differ diff --git a/source/images/supported_brands/hive.png b/source/images/supported_brands/hive.png deleted file mode 100644 index b495f3183df..00000000000 Binary files a/source/images/supported_brands/hive.png and /dev/null differ diff --git a/source/images/supported_brands/http.png b/source/images/supported_brands/http.png deleted file mode 100644 index e6037a1d0f3..00000000000 Binary files a/source/images/supported_brands/http.png and /dev/null differ diff --git a/source/images/supported_brands/huawei.svg b/source/images/supported_brands/huawei.svg deleted file mode 100644 index df30a44d898..00000000000 --- a/source/images/supported_brands/huawei.svg +++ /dev/null @@ -1 +0,0 @@ -image/svg+xml \ No newline at end of file diff --git a/source/images/supported_brands/hyperion.png b/source/images/supported_brands/hyperion.png deleted file mode 100644 index d194c77bc11..00000000000 Binary files a/source/images/supported_brands/hyperion.png and /dev/null differ diff --git a/source/images/supported_brands/iammeter-logo.png b/source/images/supported_brands/iammeter-logo.png new file mode 100644 index 00000000000..d178816c2e2 Binary files /dev/null and b/source/images/supported_brands/iammeter-logo.png differ diff --git a/source/images/supported_brands/iaqualink.png b/source/images/supported_brands/iaqualink.png deleted file mode 100644 index 75e4f8dc67e..00000000000 Binary files a/source/images/supported_brands/iaqualink.png and /dev/null differ diff --git a/source/images/supported_brands/ibm.png b/source/images/supported_brands/ibm.png deleted file mode 100644 index ca3c4415a41..00000000000 Binary files a/source/images/supported_brands/ibm.png and /dev/null differ diff --git a/source/images/supported_brands/icann.png b/source/images/supported_brands/icann.png deleted file mode 100644 index 51227a41c93..00000000000 Binary files a/source/images/supported_brands/icann.png and /dev/null differ diff --git a/source/images/supported_brands/idteck.jpg b/source/images/supported_brands/idteck.jpg deleted file mode 100644 index e3f99b01a27..00000000000 Binary files a/source/images/supported_brands/idteck.jpg and /dev/null differ diff --git a/source/images/supported_brands/ign-sismologia.png b/source/images/supported_brands/ign-sismologia.png deleted file mode 100644 index ce89a8cf2c2..00000000000 Binary files a/source/images/supported_brands/ign-sismologia.png and /dev/null differ diff --git a/source/images/supported_brands/ihc.png b/source/images/supported_brands/ihc.png deleted file mode 100644 index 9d4ea4cf0a8..00000000000 Binary files a/source/images/supported_brands/ihc.png and /dev/null differ diff --git a/source/images/supported_brands/incomfort.png b/source/images/supported_brands/incomfort.png deleted file mode 100644 index 41ee3f8375f..00000000000 Binary files a/source/images/supported_brands/incomfort.png and /dev/null differ diff --git a/source/images/supported_brands/iperf3.png b/source/images/supported_brands/iperf3.png deleted file mode 100644 index a65799a84bd..00000000000 Binary files a/source/images/supported_brands/iperf3.png and /dev/null differ diff --git a/source/images/supported_brands/iqvia.png b/source/images/supported_brands/iqvia.png deleted file mode 100644 index 6a89f0e37a1..00000000000 Binary files a/source/images/supported_brands/iqvia.png and /dev/null differ diff --git a/source/images/supported_brands/iss.png b/source/images/supported_brands/iss.png deleted file mode 100644 index 33b91c82a2d..00000000000 Binary files a/source/images/supported_brands/iss.png and /dev/null differ diff --git a/source/images/supported_brands/kaiterra.svg b/source/images/supported_brands/kaiterra.svg deleted file mode 100644 index fe12292c09f..00000000000 --- a/source/images/supported_brands/kaiterra.svg +++ /dev/null @@ -1,57 +0,0 @@ - - - - - -kaiterra-logo-2019-white - - diff --git a/source/images/supported_brands/kef.png b/source/images/supported_brands/kef.png deleted file mode 100644 index 3eb73f3a3e2..00000000000 Binary files a/source/images/supported_brands/kef.png and /dev/null differ diff --git a/source/images/supported_brands/keyboard.png b/source/images/supported_brands/keyboard.png deleted file mode 100644 index 714757d22f7..00000000000 Binary files a/source/images/supported_brands/keyboard.png and /dev/null differ diff --git a/source/images/supported_brands/kiwi.png b/source/images/supported_brands/kiwi.png deleted file mode 100644 index 79536db637d..00000000000 Binary files a/source/images/supported_brands/kiwi.png and /dev/null differ diff --git a/source/images/supported_brands/knx.png b/source/images/supported_brands/knx.png deleted file mode 100644 index 6a8986e73e5..00000000000 Binary files a/source/images/supported_brands/knx.png and /dev/null differ diff --git a/source/images/supported_brands/kwb.png b/source/images/supported_brands/kwb.png deleted file mode 100644 index cfe09c9f087..00000000000 Binary files a/source/images/supported_brands/kwb.png and /dev/null differ diff --git a/source/images/supported_brands/linn.png b/source/images/supported_brands/linn.png deleted file mode 100644 index ab3ee666458..00000000000 Binary files a/source/images/supported_brands/linn.png and /dev/null differ diff --git a/source/images/supported_brands/llamalab_automate.png b/source/images/supported_brands/llamalab_automate.png deleted file mode 100644 index fca2b56ebae..00000000000 Binary files a/source/images/supported_brands/llamalab_automate.png and /dev/null differ diff --git a/source/images/supported_brands/logentries.png b/source/images/supported_brands/logentries.png deleted file mode 100644 index 85f9554c790..00000000000 Binary files a/source/images/supported_brands/logentries.png and /dev/null differ diff --git a/source/images/supported_brands/logi_circle.png b/source/images/supported_brands/logi_circle.png deleted file mode 100644 index 4a96ea651dc..00000000000 Binary files a/source/images/supported_brands/logi_circle.png and /dev/null differ diff --git a/source/images/supported_brands/london_underground.png b/source/images/supported_brands/london_underground.png deleted file mode 100644 index 3250916a8bf..00000000000 Binary files a/source/images/supported_brands/london_underground.png and /dev/null differ diff --git a/source/images/supported_brands/luftdaten.png b/source/images/supported_brands/luftdaten.png deleted file mode 100644 index 8726fe8158f..00000000000 Binary files a/source/images/supported_brands/luftdaten.png and /dev/null differ diff --git a/source/images/supported_brands/lyft.png b/source/images/supported_brands/lyft.png deleted file mode 100644 index a27ee89e68e..00000000000 Binary files a/source/images/supported_brands/lyft.png and /dev/null differ diff --git a/source/images/supported_brands/machine-box.png b/source/images/supported_brands/machine-box.png deleted file mode 100644 index 1d8d854cfa5..00000000000 Binary files a/source/images/supported_brands/machine-box.png and /dev/null differ diff --git a/source/images/supported_brands/mastodon.png b/source/images/supported_brands/mastodon.png deleted file mode 100644 index d1e43017cd6..00000000000 Binary files a/source/images/supported_brands/mastodon.png and /dev/null differ diff --git a/source/images/supported_brands/mediaroom.png b/source/images/supported_brands/mediaroom.png deleted file mode 100644 index 64e27cc5e36..00000000000 Binary files a/source/images/supported_brands/mediaroom.png and /dev/null differ diff --git a/source/images/supported_brands/melcloud.png b/source/images/supported_brands/melcloud.png deleted file mode 100644 index 85595ed8970..00000000000 Binary files a/source/images/supported_brands/melcloud.png and /dev/null differ diff --git a/source/images/supported_brands/meteo-france.png b/source/images/supported_brands/meteo-france.png deleted file mode 100644 index 066867e6e38..00000000000 Binary files a/source/images/supported_brands/meteo-france.png and /dev/null differ diff --git a/source/images/supported_brands/metno.png b/source/images/supported_brands/metno.png deleted file mode 100644 index 2f09c7fe696..00000000000 Binary files a/source/images/supported_brands/metno.png and /dev/null differ diff --git a/source/images/supported_brands/mhz19_logo.png b/source/images/supported_brands/mhz19_logo.png deleted file mode 100644 index 608031e11c9..00000000000 Binary files a/source/images/supported_brands/mhz19_logo.png and /dev/null differ diff --git a/source/images/supported_brands/microsoft.png b/source/images/supported_brands/microsoft.png deleted file mode 100644 index 8113de114e3..00000000000 Binary files a/source/images/supported_brands/microsoft.png and /dev/null differ diff --git a/source/images/supported_brands/mill.png b/source/images/supported_brands/mill.png deleted file mode 100644 index 0976f28e17c..00000000000 Binary files a/source/images/supported_brands/mill.png and /dev/null differ diff --git a/source/images/supported_brands/minecraft.png b/source/images/supported_brands/minecraft.png deleted file mode 100644 index 0b274b8eb09..00000000000 Binary files a/source/images/supported_brands/minecraft.png and /dev/null differ diff --git a/source/images/supported_brands/minio.png b/source/images/supported_brands/minio.png deleted file mode 100644 index 38f6ff9f01d..00000000000 Binary files a/source/images/supported_brands/minio.png and /dev/null differ diff --git a/source/images/supported_brands/minut.svg b/source/images/supported_brands/minut.svg deleted file mode 100644 index 6d73080ba2a..00000000000 --- a/source/images/supported_brands/minut.svg +++ /dev/null @@ -1 +0,0 @@ - \ No newline at end of file diff --git a/source/images/supported_brands/modbus.png b/source/images/supported_brands/modbus.png deleted file mode 100644 index b01d70fa021..00000000000 Binary files a/source/images/supported_brands/modbus.png and /dev/null differ diff --git a/source/images/supported_brands/monoprice.svg b/source/images/supported_brands/monoprice.svg deleted file mode 100644 index 17079a4ca26..00000000000 --- a/source/images/supported_brands/monoprice.svg +++ /dev/null @@ -1,46 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - diff --git a/source/images/supported_brands/mopar.png b/source/images/supported_brands/mopar.png deleted file mode 100644 index 1b43a07fa70..00000000000 Binary files a/source/images/supported_brands/mopar.png and /dev/null differ diff --git a/source/images/supported_brands/mpchc.png b/source/images/supported_brands/mpchc.png deleted file mode 100644 index 938cb1fd254..00000000000 Binary files a/source/images/supported_brands/mpchc.png and /dev/null differ diff --git a/source/images/supported_brands/msteams.jpg b/source/images/supported_brands/msteams.jpg deleted file mode 100644 index e411bfcea1b..00000000000 Binary files a/source/images/supported_brands/msteams.jpg and /dev/null differ diff --git a/source/images/supported_brands/mysensors.png b/source/images/supported_brands/mysensors.png deleted file mode 100644 index c59458474d8..00000000000 Binary files a/source/images/supported_brands/mysensors.png and /dev/null differ diff --git a/source/images/supported_brands/mystrom.png b/source/images/supported_brands/mystrom.png deleted file mode 100644 index d7f6583155a..00000000000 Binary files a/source/images/supported_brands/mystrom.png and /dev/null differ diff --git a/source/images/supported_brands/n26.png b/source/images/supported_brands/n26.png deleted file mode 100644 index 72555066332..00000000000 Binary files a/source/images/supported_brands/n26.png and /dev/null differ diff --git a/source/images/supported_brands/nabu-casa.svg b/source/images/supported_brands/nabu-casa.svg deleted file mode 100644 index a038f7e6890..00000000000 --- a/source/images/supported_brands/nabu-casa.svg +++ /dev/null @@ -1 +0,0 @@ -logo \ No newline at end of file diff --git a/source/images/supported_brands/nad.png b/source/images/supported_brands/nad.png deleted file mode 100644 index be3291945d2..00000000000 Binary files a/source/images/supported_brands/nad.png and /dev/null differ diff --git a/source/images/supported_brands/nasa.png b/source/images/supported_brands/nasa.png deleted file mode 100644 index 12b96d1a3b6..00000000000 Binary files a/source/images/supported_brands/nasa.png and /dev/null differ diff --git a/source/images/supported_brands/ness.png b/source/images/supported_brands/ness.png deleted file mode 100644 index 9682e269c7d..00000000000 Binary files a/source/images/supported_brands/ness.png and /dev/null differ diff --git a/source/images/supported_brands/netdata.png b/source/images/supported_brands/netdata.png deleted file mode 100644 index cd9fe2f06af..00000000000 Binary files a/source/images/supported_brands/netdata.png and /dev/null differ diff --git a/source/images/supported_brands/network-snmp.png b/source/images/supported_brands/network-snmp.png deleted file mode 100644 index 5337e6024d5..00000000000 Binary files a/source/images/supported_brands/network-snmp.png and /dev/null differ diff --git a/source/images/supported_brands/nissan.png b/source/images/supported_brands/nissan.png deleted file mode 100644 index 23b947e8dcb..00000000000 Binary files a/source/images/supported_brands/nissan.png and /dev/null differ diff --git a/source/images/supported_brands/nmap.png b/source/images/supported_brands/nmap.png deleted file mode 100644 index 1c73d6d460e..00000000000 Binary files a/source/images/supported_brands/nmap.png and /dev/null differ diff --git a/source/images/supported_brands/noaa.png b/source/images/supported_brands/noaa.png deleted file mode 100644 index 471fbca3e3d..00000000000 Binary files a/source/images/supported_brands/noaa.png and /dev/null differ diff --git a/source/images/supported_brands/nsw-rural-fire-service.png b/source/images/supported_brands/nsw-rural-fire-service.png deleted file mode 100644 index 6d3a6bfa3fe..00000000000 Binary files a/source/images/supported_brands/nsw-rural-fire-service.png and /dev/null differ diff --git a/source/images/supported_brands/nuheat.png b/source/images/supported_brands/nuheat.png deleted file mode 100644 index 12d558e54f6..00000000000 Binary files a/source/images/supported_brands/nuheat.png and /dev/null differ diff --git a/source/images/supported_brands/nut.png b/source/images/supported_brands/nut.png deleted file mode 100644 index d661ce720c7..00000000000 Binary files a/source/images/supported_brands/nut.png and /dev/null differ diff --git a/source/images/supported_brands/nws.png b/source/images/supported_brands/nws.png deleted file mode 100644 index 373ce61d76d..00000000000 Binary files a/source/images/supported_brands/nws.png and /dev/null differ diff --git a/source/images/supported_brands/oasa.png b/source/images/supported_brands/oasa.png deleted file mode 100644 index 8780f104c76..00000000000 Binary files a/source/images/supported_brands/oasa.png and /dev/null differ diff --git a/source/images/supported_brands/octoprint.png b/source/images/supported_brands/octoprint.png deleted file mode 100644 index 1a785ecd8c2..00000000000 Binary files a/source/images/supported_brands/octoprint.png and /dev/null differ diff --git a/source/images/supported_brands/oem.png b/source/images/supported_brands/oem.png deleted file mode 100644 index a9fc79238d0..00000000000 Binary files a/source/images/supported_brands/oem.png and /dev/null differ diff --git a/source/images/supported_brands/ombi.png b/source/images/supported_brands/ombi.png deleted file mode 100644 index d52f8241797..00000000000 Binary files a/source/images/supported_brands/ombi.png and /dev/null differ diff --git a/source/images/supported_brands/onewire.png b/source/images/supported_brands/onewire.png deleted file mode 100644 index 04d988b57fd..00000000000 Binary files a/source/images/supported_brands/onewire.png and /dev/null differ diff --git a/source/images/supported_brands/opencv.png b/source/images/supported_brands/opencv.png deleted file mode 100644 index cda0478e20d..00000000000 Binary files a/source/images/supported_brands/opencv.png and /dev/null differ diff --git a/source/images/supported_brands/openhardwaremonitor.png b/source/images/supported_brands/openhardwaremonitor.png deleted file mode 100644 index 068abb56533..00000000000 Binary files a/source/images/supported_brands/openhardwaremonitor.png and /dev/null differ diff --git a/source/images/supported_brands/opensensemap.png b/source/images/supported_brands/opensensemap.png deleted file mode 100644 index 4245b80f297..00000000000 Binary files a/source/images/supported_brands/opensensemap.png and /dev/null differ diff --git a/source/images/supported_brands/opentherm.png b/source/images/supported_brands/opentherm.png deleted file mode 100644 index 65acc68bb30..00000000000 Binary files a/source/images/supported_brands/opentherm.png and /dev/null differ diff --git a/source/images/supported_brands/openuv.jpg b/source/images/supported_brands/openuv.jpg deleted file mode 100644 index a15741c381c..00000000000 Binary files a/source/images/supported_brands/openuv.jpg and /dev/null differ diff --git a/source/images/supported_brands/opnsense.png b/source/images/supported_brands/opnsense.png deleted file mode 100644 index 9f66dabea1f..00000000000 Binary files a/source/images/supported_brands/opnsense.png and /dev/null differ diff --git a/source/images/supported_brands/opple.png b/source/images/supported_brands/opple.png deleted file mode 100644 index f897489591d..00000000000 Binary files a/source/images/supported_brands/opple.png and /dev/null differ diff --git a/source/images/supported_brands/orange-pi.png b/source/images/supported_brands/orange-pi.png deleted file mode 100644 index ffc73e84a2f..00000000000 Binary files a/source/images/supported_brands/orange-pi.png and /dev/null differ diff --git a/source/images/supported_brands/oru.png b/source/images/supported_brands/oru.png deleted file mode 100644 index b06c29e787a..00000000000 Binary files a/source/images/supported_brands/oru.png and /dev/null differ diff --git a/source/images/supported_brands/owntracks.png b/source/images/supported_brands/owntracks.png deleted file mode 100644 index ac237c56877..00000000000 Binary files a/source/images/supported_brands/owntracks.png and /dev/null differ diff --git a/source/images/supported_brands/plaato.png b/source/images/supported_brands/plaato.png deleted file mode 100644 index 78ac490866b..00000000000 Binary files a/source/images/supported_brands/plaato.png and /dev/null differ diff --git a/source/images/supported_brands/plugwise.png b/source/images/supported_brands/plugwise.png deleted file mode 100644 index f48480b7b13..00000000000 Binary files a/source/images/supported_brands/plugwise.png and /dev/null differ diff --git a/source/images/supported_brands/pocketcasts.png b/source/images/supported_brands/pocketcasts.png deleted file mode 100644 index e52ed3cef02..00000000000 Binary files a/source/images/supported_brands/pocketcasts.png and /dev/null differ diff --git a/source/images/supported_brands/polly.png b/source/images/supported_brands/polly.png deleted file mode 100644 index af4a1e031d8..00000000000 Binary files a/source/images/supported_brands/polly.png and /dev/null differ diff --git a/source/images/supported_brands/prezzibenzina.png b/source/images/supported_brands/prezzibenzina.png deleted file mode 100644 index a224b36651e..00000000000 Binary files a/source/images/supported_brands/prezzibenzina.png and /dev/null differ diff --git a/source/images/supported_brands/prometheus.png b/source/images/supported_brands/prometheus.png deleted file mode 100644 index b98ffa95724..00000000000 Binary files a/source/images/supported_brands/prometheus.png and /dev/null differ diff --git a/source/images/supported_brands/prowl.png b/source/images/supported_brands/prowl.png deleted file mode 100644 index a8548452060..00000000000 Binary files a/source/images/supported_brands/prowl.png and /dev/null differ diff --git a/source/images/supported_brands/proxmoxve.png b/source/images/supported_brands/proxmoxve.png deleted file mode 100644 index 0d08aec1b21..00000000000 Binary files a/source/images/supported_brands/proxmoxve.png and /dev/null differ diff --git a/source/images/supported_brands/pyload.png b/source/images/supported_brands/pyload.png deleted file mode 100644 index 4157ac6c71c..00000000000 Binary files a/source/images/supported_brands/pyload.png and /dev/null differ diff --git a/source/images/supported_brands/python.svg b/source/images/supported_brands/python.svg deleted file mode 100644 index 5b333e80039..00000000000 --- a/source/images/supported_brands/python.svg +++ /dev/null @@ -1 +0,0 @@ -image/svg+xml \ No newline at end of file diff --git a/source/images/supported_brands/qbittorrent.png b/source/images/supported_brands/qbittorrent.png deleted file mode 100644 index 814c5e62aaa..00000000000 Binary files a/source/images/supported_brands/qbittorrent.png and /dev/null differ diff --git a/source/images/supported_brands/qvr_pro.png b/source/images/supported_brands/qvr_pro.png new file mode 100644 index 00000000000..99e1e73763e Binary files /dev/null and b/source/images/supported_brands/qvr_pro.png differ diff --git a/source/images/supported_brands/radarr.png b/source/images/supported_brands/radarr.png deleted file mode 100644 index 6f54a874ebc..00000000000 Binary files a/source/images/supported_brands/radarr.png and /dev/null differ diff --git a/source/images/supported_brands/rainforest_automation_logo.png b/source/images/supported_brands/rainforest_automation_logo.png deleted file mode 100644 index 26bce1cc86a..00000000000 Binary files a/source/images/supported_brands/rainforest_automation_logo.png and /dev/null differ diff --git a/source/images/supported_brands/rainmachine.png b/source/images/supported_brands/rainmachine.png deleted file mode 100644 index 7c9bfe777da..00000000000 Binary files a/source/images/supported_brands/rainmachine.png and /dev/null differ diff --git a/source/images/supported_brands/reddit.png b/source/images/supported_brands/reddit.png deleted file mode 100644 index b560fb18f37..00000000000 Binary files a/source/images/supported_brands/reddit.png and /dev/null differ diff --git a/source/images/supported_brands/repetier.png b/source/images/supported_brands/repetier.png deleted file mode 100644 index 7cbba43ad45..00000000000 Binary files a/source/images/supported_brands/repetier.png and /dev/null differ diff --git a/source/images/supported_brands/restful.png b/source/images/supported_brands/restful.png deleted file mode 100644 index 1443f75c23a..00000000000 Binary files a/source/images/supported_brands/restful.png and /dev/null differ diff --git a/source/images/supported_brands/rfxtrx.png b/source/images/supported_brands/rfxtrx.png deleted file mode 100644 index 9b9436c67da..00000000000 Binary files a/source/images/supported_brands/rfxtrx.png and /dev/null differ diff --git a/source/images/supported_brands/rocketchat.png b/source/images/supported_brands/rocketchat.png deleted file mode 100644 index 1434cf28629..00000000000 Binary files a/source/images/supported_brands/rocketchat.png and /dev/null differ diff --git a/source/images/supported_brands/route53.png b/source/images/supported_brands/route53.png deleted file mode 100644 index aab5f8882c9..00000000000 Binary files a/source/images/supported_brands/route53.png and /dev/null differ diff --git a/source/images/supported_brands/rova.jpg b/source/images/supported_brands/rova.jpg deleted file mode 100644 index ead2f2b7cfe..00000000000 Binary files a/source/images/supported_brands/rova.jpg and /dev/null differ diff --git a/source/images/supported_brands/rtorrent.png b/source/images/supported_brands/rtorrent.png deleted file mode 100644 index c7a39c43a65..00000000000 Binary files a/source/images/supported_brands/rtorrent.png and /dev/null differ diff --git a/source/images/supported_brands/sensirion.png b/source/images/supported_brands/sensirion.png deleted file mode 100644 index f592fc5bb1f..00000000000 Binary files a/source/images/supported_brands/sensirion.png and /dev/null differ diff --git a/source/images/supported_brands/sentry.svg b/source/images/supported_brands/sentry.svg deleted file mode 100644 index 59b79bc58f8..00000000000 --- a/source/images/supported_brands/sentry.svg +++ /dev/null @@ -1 +0,0 @@ -sentry-logo-black \ No newline at end of file diff --git a/source/images/supported_brands/shiftr.png b/source/images/supported_brands/shiftr.png deleted file mode 100644 index bed6fad1873..00000000000 Binary files a/source/images/supported_brands/shiftr.png and /dev/null differ diff --git a/source/images/supported_brands/signal_messenger.png b/source/images/supported_brands/signal_messenger.png deleted file mode 100644 index c8cbb4ea03b..00000000000 Binary files a/source/images/supported_brands/signal_messenger.png and /dev/null differ diff --git a/source/images/supported_brands/sisyphus.png b/source/images/supported_brands/sisyphus.png deleted file mode 100644 index a1fd5cc537d..00000000000 Binary files a/source/images/supported_brands/sisyphus.png and /dev/null differ diff --git a/source/images/supported_brands/skybell.png b/source/images/supported_brands/skybell.png deleted file mode 100644 index b8a8a0cec2f..00000000000 Binary files a/source/images/supported_brands/skybell.png and /dev/null differ diff --git a/source/images/supported_brands/smarthab.png b/source/images/supported_brands/smarthab.png deleted file mode 100644 index 47db7fbd810..00000000000 Binary files a/source/images/supported_brands/smarthab.png and /dev/null differ diff --git a/source/images/supported_brands/sncb_nmbs.gif b/source/images/supported_brands/sncb_nmbs.gif deleted file mode 100644 index f78f3f35f6d..00000000000 Binary files a/source/images/supported_brands/sncb_nmbs.gif and /dev/null differ diff --git a/source/images/supported_brands/solax-logo.png b/source/images/supported_brands/solax-logo.png deleted file mode 100644 index a9dce20ba7b..00000000000 Binary files a/source/images/supported_brands/solax-logo.png and /dev/null differ diff --git a/source/images/supported_brands/soma.png b/source/images/supported_brands/soma.png deleted file mode 100644 index 9ad8a13d5d6..00000000000 Binary files a/source/images/supported_brands/soma.png and /dev/null differ diff --git a/source/images/supported_brands/somfy.png b/source/images/supported_brands/somfy.png deleted file mode 100644 index f9ef2a55ae0..00000000000 Binary files a/source/images/supported_brands/somfy.png and /dev/null differ diff --git a/source/images/supported_brands/sonarr.png b/source/images/supported_brands/sonarr.png deleted file mode 100644 index 18eb6066685..00000000000 Binary files a/source/images/supported_brands/sonarr.png and /dev/null differ diff --git a/source/images/supported_brands/spaceapi.png b/source/images/supported_brands/spaceapi.png deleted file mode 100644 index 83b10582565..00000000000 Binary files a/source/images/supported_brands/spaceapi.png and /dev/null differ diff --git a/source/images/supported_brands/spider.png b/source/images/supported_brands/spider.png deleted file mode 100644 index 6444ecec9e1..00000000000 Binary files a/source/images/supported_brands/spider.png and /dev/null differ diff --git a/source/images/supported_brands/spotify.png b/source/images/supported_brands/spotify.png deleted file mode 100644 index aca36380cba..00000000000 Binary files a/source/images/supported_brands/spotify.png and /dev/null differ diff --git a/source/images/supported_brands/sql.png b/source/images/supported_brands/sql.png deleted file mode 100644 index b190bf363e5..00000000000 Binary files a/source/images/supported_brands/sql.png and /dev/null differ diff --git a/source/images/supported_brands/starline.png b/source/images/supported_brands/starline.png deleted file mode 100644 index 1cc29749e16..00000000000 Binary files a/source/images/supported_brands/starline.png and /dev/null differ diff --git a/source/images/supported_brands/starlingbank.png b/source/images/supported_brands/starlingbank.png deleted file mode 100644 index 1a6fbd7f6e7..00000000000 Binary files a/source/images/supported_brands/starlingbank.png and /dev/null differ diff --git a/source/images/supported_brands/statsd.png b/source/images/supported_brands/statsd.png deleted file mode 100644 index bb0f431cbf8..00000000000 Binary files a/source/images/supported_brands/statsd.png and /dev/null differ diff --git a/source/images/supported_brands/stookalert.png b/source/images/supported_brands/stookalert.png deleted file mode 100644 index 8f01864ca96..00000000000 Binary files a/source/images/supported_brands/stookalert.png and /dev/null differ diff --git a/source/images/supported_brands/streamlabswater.png b/source/images/supported_brands/streamlabswater.png deleted file mode 100644 index b77ba3cc54c..00000000000 Binary files a/source/images/supported_brands/streamlabswater.png and /dev/null differ diff --git a/source/images/supported_brands/suez.png b/source/images/supported_brands/suez.png deleted file mode 100644 index 57c8d53c06d..00000000000 Binary files a/source/images/supported_brands/suez.png and /dev/null differ diff --git a/source/images/supported_brands/supla.png b/source/images/supported_brands/supla.png deleted file mode 100644 index ee690c28729..00000000000 Binary files a/source/images/supported_brands/supla.png and /dev/null differ diff --git a/source/images/supported_brands/sure_petcare.png b/source/images/supported_brands/sure_petcare.png deleted file mode 100644 index 0ede30903bc..00000000000 Binary files a/source/images/supported_brands/sure_petcare.png and /dev/null differ diff --git a/source/images/supported_brands/swiss-hydrological-data.png b/source/images/supported_brands/swiss-hydrological-data.png deleted file mode 100644 index 56acf41976b..00000000000 Binary files a/source/images/supported_brands/swiss-hydrological-data.png and /dev/null differ diff --git a/source/images/supported_brands/switchbot.png b/source/images/supported_brands/switchbot.png deleted file mode 100644 index 9dc95f280be..00000000000 Binary files a/source/images/supported_brands/switchbot.png and /dev/null differ diff --git a/source/images/supported_brands/switcher_boiler.png b/source/images/supported_brands/switcher_boiler.png deleted file mode 100644 index ad29c02e969..00000000000 Binary files a/source/images/supported_brands/switcher_boiler.png and /dev/null differ diff --git a/source/images/supported_brands/switchmate-logo-rgb.png b/source/images/supported_brands/switchmate-logo-rgb.png deleted file mode 100644 index 800fa82ceee..00000000000 Binary files a/source/images/supported_brands/switchmate-logo-rgb.png and /dev/null differ diff --git a/source/images/supported_brands/syslog.png b/source/images/supported_brands/syslog.png deleted file mode 100644 index de352e232ba..00000000000 Binary files a/source/images/supported_brands/syslog.png and /dev/null differ diff --git a/source/images/supported_brands/system_monitor.png b/source/images/supported_brands/system_monitor.png deleted file mode 100644 index b76145c2b11..00000000000 Binary files a/source/images/supported_brands/system_monitor.png and /dev/null differ diff --git a/source/images/supported_brands/tankerkoenig.png b/source/images/supported_brands/tankerkoenig.png new file mode 100755 index 00000000000..5d3dd815677 Binary files /dev/null and b/source/images/supported_brands/tankerkoenig.png differ diff --git a/source/images/supported_brands/tautulli.png b/source/images/supported_brands/tautulli.png deleted file mode 100644 index 10496c5440e..00000000000 Binary files a/source/images/supported_brands/tautulli.png and /dev/null differ diff --git a/source/images/supported_brands/tcp_ip.png b/source/images/supported_brands/tcp_ip.png deleted file mode 100644 index ee28a51ba2e..00000000000 Binary files a/source/images/supported_brands/tcp_ip.png and /dev/null differ diff --git a/source/images/supported_brands/tellduslive.svg b/source/images/supported_brands/tellduslive.svg deleted file mode 100644 index 86962e8a7f7..00000000000 --- a/source/images/supported_brands/tellduslive.svg +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/source/images/supported_brands/tensorflow.png b/source/images/supported_brands/tensorflow.png deleted file mode 100644 index 0a8f6982628..00000000000 Binary files a/source/images/supported_brands/tensorflow.png and /dev/null differ diff --git a/source/images/supported_brands/tesla.png b/source/images/supported_brands/tesla.png deleted file mode 100644 index 3f828e53152..00000000000 Binary files a/source/images/supported_brands/tesla.png and /dev/null differ diff --git a/source/images/supported_brands/tfiac.png b/source/images/supported_brands/tfiac.png deleted file mode 100644 index 27c11faedf9..00000000000 Binary files a/source/images/supported_brands/tfiac.png and /dev/null differ diff --git a/source/images/supported_brands/thethingsnetwork.png b/source/images/supported_brands/thethingsnetwork.png deleted file mode 100644 index b530e5b19f2..00000000000 Binary files a/source/images/supported_brands/thethingsnetwork.png and /dev/null differ diff --git a/source/images/supported_brands/tile.png b/source/images/supported_brands/tile.png deleted file mode 100644 index 5fe620999b2..00000000000 Binary files a/source/images/supported_brands/tile.png and /dev/null differ diff --git a/source/images/supported_brands/tomato.png b/source/images/supported_brands/tomato.png deleted file mode 100644 index 11150d51582..00000000000 Binary files a/source/images/supported_brands/tomato.png and /dev/null differ diff --git a/source/images/supported_brands/trackr.png b/source/images/supported_brands/trackr.png deleted file mode 100644 index 57a6b6cb60d..00000000000 Binary files a/source/images/supported_brands/trackr.png and /dev/null differ diff --git a/source/images/supported_brands/train.png b/source/images/supported_brands/train.png deleted file mode 100644 index 6ab406b2604..00000000000 Binary files a/source/images/supported_brands/train.png and /dev/null differ diff --git a/source/images/supported_brands/travisci.svg b/source/images/supported_brands/travisci.svg deleted file mode 100644 index ae791ed9f25..00000000000 --- a/source/images/supported_brands/travisci.svg +++ /dev/null @@ -1 +0,0 @@ - \ No newline at end of file diff --git a/source/images/supported_brands/upc.png b/source/images/supported_brands/upc.png deleted file mode 100644 index c2419cb0447..00000000000 Binary files a/source/images/supported_brands/upc.png and /dev/null differ diff --git a/source/images/supported_brands/updater.png b/source/images/supported_brands/updater.png deleted file mode 100644 index c9808e4d699..00000000000 Binary files a/source/images/supported_brands/updater.png and /dev/null differ diff --git a/source/images/supported_brands/uscis.png b/source/images/supported_brands/uscis.png deleted file mode 100644 index fe35b8b9aff..00000000000 Binary files a/source/images/supported_brands/uscis.png and /dev/null differ diff --git a/source/images/supported_brands/vallox.png b/source/images/supported_brands/vallox.png deleted file mode 100644 index e8c0b6a3f70..00000000000 Binary files a/source/images/supported_brands/vallox.png and /dev/null differ diff --git a/source/images/supported_brands/velbus.png b/source/images/supported_brands/velbus.png index 76b24398b3f..072f9dbc98e 100644 Binary files a/source/images/supported_brands/velbus.png and b/source/images/supported_brands/velbus.png differ diff --git a/source/images/supported_brands/verizon.png b/source/images/supported_brands/verizon.png deleted file mode 100644 index 564aa99b493..00000000000 Binary files a/source/images/supported_brands/verizon.png and /dev/null differ diff --git a/source/images/supported_brands/versasense.png b/source/images/supported_brands/versasense.png deleted file mode 100644 index e51daeba944..00000000000 Binary files a/source/images/supported_brands/versasense.png and /dev/null differ diff --git a/source/images/supported_brands/vesync.png b/source/images/supported_brands/vesync.png deleted file mode 100644 index ca2b3ca75a3..00000000000 Binary files a/source/images/supported_brands/vesync.png and /dev/null differ diff --git a/source/images/supported_brands/videolan.png b/source/images/supported_brands/videolan.png deleted file mode 100644 index 776fe71bee0..00000000000 Binary files a/source/images/supported_brands/videolan.png and /dev/null differ diff --git a/source/images/supported_brands/vilfo.png b/source/images/supported_brands/vilfo.png deleted file mode 100644 index 9cd24924616..00000000000 Binary files a/source/images/supported_brands/vilfo.png and /dev/null differ diff --git a/source/images/supported_brands/visual-studio.png b/source/images/supported_brands/visual-studio.png deleted file mode 100644 index 64af2161e6c..00000000000 Binary files a/source/images/supported_brands/visual-studio.png and /dev/null differ diff --git a/source/images/supported_brands/vivotek.jpg b/source/images/supported_brands/vivotek.jpg deleted file mode 100644 index 951b786c605..00000000000 Binary files a/source/images/supported_brands/vivotek.jpg and /dev/null differ diff --git a/source/images/supported_brands/vizio-smartcast.png b/source/images/supported_brands/vizio-smartcast.png deleted file mode 100644 index 7d740d21a44..00000000000 Binary files a/source/images/supported_brands/vizio-smartcast.png and /dev/null differ diff --git a/source/images/supported_brands/waqi.png b/source/images/supported_brands/waqi.png deleted file mode 100644 index 2b18ec20927..00000000000 Binary files a/source/images/supported_brands/waqi.png and /dev/null differ diff --git a/source/images/supported_brands/waterfurnace.png b/source/images/supported_brands/waterfurnace.png deleted file mode 100644 index 6ff59eea92a..00000000000 Binary files a/source/images/supported_brands/waterfurnace.png and /dev/null differ diff --git a/source/images/supported_brands/watson_tts.png b/source/images/supported_brands/watson_tts.png deleted file mode 100644 index 91a882537be..00000000000 Binary files a/source/images/supported_brands/watson_tts.png and /dev/null differ diff --git a/source/images/supported_brands/waze.png b/source/images/supported_brands/waze.png deleted file mode 100644 index da757989362..00000000000 Binary files a/source/images/supported_brands/waze.png and /dev/null differ diff --git a/source/images/supported_brands/windows.png b/source/images/supported_brands/windows.png deleted file mode 100644 index cb7a8574105..00000000000 Binary files a/source/images/supported_brands/windows.png and /dev/null differ diff --git a/source/images/supported_brands/wirelesstag.png b/source/images/supported_brands/wirelesstag.png deleted file mode 100644 index 283b0a7e631..00000000000 Binary files a/source/images/supported_brands/wirelesstag.png and /dev/null differ diff --git a/source/images/supported_brands/withings.png b/source/images/supported_brands/withings.png deleted file mode 100644 index 51b690f7cab..00000000000 Binary files a/source/images/supported_brands/withings.png and /dev/null differ diff --git a/source/images/supported_brands/wled.png b/source/images/supported_brands/wled.png deleted file mode 100644 index 6e553ca7f55..00000000000 Binary files a/source/images/supported_brands/wled.png and /dev/null differ diff --git a/source/images/supported_brands/woonveilig.png b/source/images/supported_brands/woonveilig.png deleted file mode 100644 index 4f016de020c..00000000000 Binary files a/source/images/supported_brands/woonveilig.png and /dev/null differ diff --git a/source/images/supported_brands/worldtidesinfo.png b/source/images/supported_brands/worldtidesinfo.png deleted file mode 100644 index d8674171925..00000000000 Binary files a/source/images/supported_brands/worldtidesinfo.png and /dev/null differ diff --git a/source/images/supported_brands/wwlln.jpg b/source/images/supported_brands/wwlln.jpg deleted file mode 100644 index 6edc2ddc3d8..00000000000 Binary files a/source/images/supported_brands/wwlln.jpg and /dev/null differ diff --git a/source/images/supported_brands/x10.gif b/source/images/supported_brands/x10.gif deleted file mode 100644 index 0c0e80dbc8b..00000000000 Binary files a/source/images/supported_brands/x10.gif and /dev/null differ diff --git a/source/images/supported_brands/xeoma.png b/source/images/supported_brands/xeoma.png deleted file mode 100644 index 5ef0a558709..00000000000 Binary files a/source/images/supported_brands/xeoma.png and /dev/null differ diff --git a/source/images/supported_brands/xfinity.svg b/source/images/supported_brands/xfinity.svg deleted file mode 100644 index 8a9ec171c8a..00000000000 --- a/source/images/supported_brands/xfinity.svg +++ /dev/null @@ -1,102 +0,0 @@ - - - - - - - - - - image/svg+xml - - - - - - - - - - - - - - - diff --git a/source/images/supported_brands/xiaomi.png b/source/images/supported_brands/xiaomi.png deleted file mode 100644 index c123fefdb43..00000000000 Binary files a/source/images/supported_brands/xiaomi.png and /dev/null differ diff --git a/source/images/supported_brands/xs1.jpg b/source/images/supported_brands/xs1.jpg deleted file mode 100644 index b4215eda276..00000000000 Binary files a/source/images/supported_brands/xs1.jpg and /dev/null differ diff --git a/source/images/supported_brands/yesssat.png b/source/images/supported_brands/yesssat.png deleted file mode 100644 index 6b6adf2a0ce..00000000000 Binary files a/source/images/supported_brands/yesssat.png and /dev/null differ diff --git a/source/images/supported_brands/yi.png b/source/images/supported_brands/yi.png deleted file mode 100644 index ddda8667075..00000000000 Binary files a/source/images/supported_brands/yi.png and /dev/null differ diff --git a/source/images/supported_brands/zengge.png b/source/images/supported_brands/zengge.png deleted file mode 100644 index c08820028c2..00000000000 Binary files a/source/images/supported_brands/zengge.png and /dev/null differ diff --git a/source/images/supported_brands/zillow.png b/source/images/supported_brands/zillow.png deleted file mode 100644 index 4cb006f8dba..00000000000 Binary files a/source/images/supported_brands/zillow.png and /dev/null differ diff --git a/source/integrations/index.html b/source/integrations/index.html index 4a2e487f851..ae02ee938d9 100644 --- a/source/integrations/index.html +++ b/source/integrations/index.html @@ -74,7 +74,6 @@ regenerate: false
    {{{image}}}
    {{title}}
    -
    {{cat}}
    {{/components}} {{^components}} @@ -88,14 +87,15 @@ regenerate: false var allComponents = [ {%- for component in components -%} {%- if component.ha_category -%} -{%- assign sliced_version = component.ha_release | split: '.' -%} -{%- assign minor_version = sliced_version[1]|plus: 0 -%} -{%- assign major_version = sliced_version[0]|plus: 0 -%} -{%- assign featured_first = true -%} + {%- assign sliced_version = component.ha_release | split: '.' -%} + {%- assign minor_version = sliced_version[1]|plus: 0 -%} + {%- assign major_version = sliced_version[0]|plus: 0 -%} + {% assign categories = "" | split: ',' %} {%- for ha_category in component.ha_category -%} -{url:"{{ component.url }}", title:"{{component.title}}", cat:"{{ha_category | slugify}}", featured: {% if component.featured and featured_first %}true{% else %}false{% endif %}, v: "{{major_version}}.{{minor_version}}", logo: "{{component.logo}}"}, - {%- assign featured_first = false -%} + {% capture category %}"{{ ha_category | slugify | downcase }}"{% endcapture %} + {% assign categories = categories | push: category %} {%- endfor -%} + {url:"{{ component.url }}", title:"{{component.title}}", cat: [{{categories|join: ","}}], featured: {% if component.featured %}true{% else %}false{% endif %}, v: "{{major_version}}.{{minor_version}}", logo: "{{component.logo}}", domain: "{{component.ha_domain}}"}, {% endif -%} {%- endfor -%} false @@ -112,7 +112,6 @@ allComponents.pop(); // remove placeholder element at the end // do the lowerCase transformation once for (i = 0; i < (allComponents.length); i++) { allComponents[i].titleLC = allComponents[i].title.toLowerCase(); - allComponents[i].catLC = allComponents[i].cat.toLowerCase(); } // sort the components alphabetically @@ -145,7 +144,7 @@ allComponents.pop(); // remove placeholder element at the end components: [], image: function () { if (this.logo === '') { - return ''; + return ''; } else { return ''; } @@ -169,7 +168,7 @@ allComponents.pop(); // remove placeholder element at the end search = decodeURIComponent(hash).substring(8).toLowerCase(); filter = function (comp) { return (comp.titleLC.indexOf(search) !== -1) || - (comp.catLC.indexOf(search) !== -1); + (comp.cat.find(c => c.includes("#")) != undefined); }; } else if (hash === '#featured' || hash === '') { @@ -190,7 +189,7 @@ allComponents.pop(); // remove placeholder element at the end // regular filter categories search = hash.substring(1); filter = function (comp) { - return comp.catLC === search; + return comp.cat.includes(search); }; } diff --git a/source/latest-release-notes/index.html b/source/latest-release-notes/index.html index ce27c6f0841..ed4b5859c39 100644 --- a/source/latest-release-notes/index.html +++ b/source/latest-release-notes/index.html @@ -1,7 +1,15 @@ --- --- - -{% assign posts = site.categories['Release-Notes'] | where_exp: "post", "post.title contains site.current_minor_version" %} +{% comment %} +Ugly workaround to make the release notes for 0.106 redirect nicely. +We did a special release with a blog post, so the latest release Notes +are going the wrong way. This hack can be removed after 0.107 is released. +{% endcomment %} +{% if site.current_minor_version == 106 %} + {% assign posts = site.categories['Release-Notes'] | where_exp: "post", "post.title contains 'Light brightness stepping'" %} +{% else %} + {% assign posts = site.categories['Release-Notes'] | where_exp: "post", "post.title contains site.current_minor_version" %} +{% endif %} {% assign recent_release_post = posts.first %}