mirror of
https://github.com/home-assistant/home-assistant.io.git
synced 2025-07-23 09:17:06 +00:00
Merge branch 'next' into rc
This commit is contained in:
commit
9d4ad45851
@ -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"],
|
||||
|
17
CODEOWNERS
17
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
|
||||
|
2
Gemfile
2
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
|
||||
|
@ -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)
|
||||
|
@ -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.
|
||||
|
@ -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;
|
||||
}
|
||||
}
|
||||
|
@ -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]
|
||||
|
@ -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.
|
||||
|
||||
<div class='note'>
|
||||
|
||||
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_.
|
||||
|
||||
</div>
|
||||
|
||||
```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).
|
||||
|
||||
<div class='note'>
|
||||
|
||||
|
@ -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
|
||||
|
@ -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., `<path to config dir>/.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., `<path to config dir>/.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`:
|
||||
|
@ -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`.
|
||||
|
||||
<div class='note warning'>
|
||||
|
||||
@ -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).
|
||||
|
@ -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/).
|
||||
|
@ -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
|
||||
```
|
||||
|
||||
|
||||
|
@ -50,7 +50,7 @@ Creating a `.gitignore` file in your repository will tell Git which files NOT to
|
||||
|
||||
<div class='note'>
|
||||
|
||||
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++).
|
||||
|
||||
</div>
|
||||
|
||||
|
@ -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.
|
||||
|
||||
|
@ -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.
|
||||
|
@ -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.
|
||||
|
||||
<p class='img'>
|
||||
<img src='/images/hassio/screenshots/addon-hass-configurator.png'>
|
||||
Screenshot of the Configurator.
|
||||
</p>
|
||||
|
||||
### 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
|
||||
|
||||
<div class='note warning'>
|
||||
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.<br />
|
||||
Consider running the configurator as a user with limited privileges to limit possible damage.
|
||||
</div>
|
||||
|
||||
### 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
|
||||
```
|
||||
|
||||
<div class='note warning'>
|
||||
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!
|
||||
</div>
|
||||
|
||||
### 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.
|
@ -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.
|
@ -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.
|
@ -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.
|
@ -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
|
||||
```
|
||||
|
||||
<div class='note warning'>
|
||||
|
||||
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.
|
||||
|
||||
</div>
|
||||
|
||||
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.
|
||||
|
||||
<p class='img'>
|
||||
<img src='{{site_root}}/images/screenshots/jupyter-new.png' />
|
||||
</p>
|
||||
|
||||
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.
|
||||
|
||||
<p class='img'>
|
||||
<img src='{{site_root}}/images/screenshots/jupyter-notebook.png' />
|
||||
</p>
|
||||
|
||||
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.
|
@ -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.
|
@ -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
|
||||
|
||||
<p class='img' style='max-width:500px; margin-left: auto; margin-right: auto;'>
|
||||
<img src='/images/screenshots/android-homescreen-guide.gif' />
|
||||
</p>
|
||||
|
||||
## 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
|
@ -47,7 +47,7 @@ These install options are fully supported by Home Assistant's documentation. For
|
||||
|
||||
<div class='note'>
|
||||
|
||||
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.
|
||||
|
||||
</div>
|
||||
|
||||
@ -96,13 +96,13 @@ These guides are provided as-is. Some of these install methods are more limited
|
||||
</a>
|
||||
<a class='option-card' href='/docs/installation/macos/'>
|
||||
<div class='img-container'>
|
||||
<img src='/images/supported_brands/apple.png' />
|
||||
<img src='https://brands.home-assistant.io/ios/icon.png' />
|
||||
</div>
|
||||
<div class='title'>macOS</div>
|
||||
</a>
|
||||
<a class='option-card' href='/docs/installation/synology/'>
|
||||
<div class='img-container'>
|
||||
<img src='/images/supported_brands/synology.png' />
|
||||
<img src='https://brands.home-assistant.io/synology/logo.png' />
|
||||
</div>
|
||||
<div class='title'>Synology</div>
|
||||
</a>
|
||||
@ -112,9 +112,9 @@ These guides are provided as-is. Some of these install methods are more limited
|
||||
</div>
|
||||
<div class='title'>FreeNAS</div>
|
||||
</a>
|
||||
<a class='option-card' href='/hassio/installation/#alternative-install-on-a-generic-linux-host'>
|
||||
<a class='option-card' href='/hassio/installation/#alternative-install-home-assistant-supervised-on-a-generic-linux-host'>
|
||||
<div class='img-container'>
|
||||
<img src='/images/supported_brands/home-assistant.png' />
|
||||
<img src='https://brands.home-assistant.io/homeassistant/icon.png' />
|
||||
</div>
|
||||
<div class='title'>Home Assistant Supervised <br> on generic Linux server</div>
|
||||
</a>
|
||||
|
@ -4,6 +4,14 @@ description: "Instructions to install Home Assistant on a Docker."
|
||||
redirect_from: /getting-started/installation-docker/
|
||||
---
|
||||
|
||||
<div class='note warning'>
|
||||
|
||||
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/).
|
||||
|
||||
</div>
|
||||
|
||||
## 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
|
||||
|
||||
|
@ -6,15 +6,15 @@ redirect_from: /getting-started/updating/
|
||||
|
||||
<div class='note warning'>
|
||||
|
||||
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).
|
||||
|
||||
</div>
|
||||
|
||||
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.
|
||||
|
||||
<div class='note'>
|
||||
|
||||
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).
|
||||
|
||||
</div>
|
||||
|
||||
@ -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
|
||||
|
@ -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/)
|
||||
|
||||
<div class='info'>
|
||||
|
||||
|
@ -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:
|
||||
|
@ -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/)
|
||||
|
@ -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.
|
||||
|
||||
<img src='/images/docs/scripts/sun-conditions.svg' alt='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:
|
||||
|
@ -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
|
||||
|
@ -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
|
||||
|
||||
|
@ -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
|
||||
|
@ -1,6 +1,6 @@
|
||||
---
|
||||
title: "Missing Documentation"
|
||||
description: "The docs are missing or outdated"
|
||||
description: "The documentation is missing or outdated"
|
||||
ha_category: Documentation
|
||||
---
|
||||
|
||||
|
@ -1,20 +1,18 @@
|
||||
{%- assign github_main_repo = 'https://github.com/home-assistant/home-assistant/blob/dev/homeassistant' -%}
|
||||
<section class="aside-module grid__item one-whole lap-one-half">
|
||||
{%- include edit_github.html -%}
|
||||
|
||||
<div class='brand-logo-container section'>
|
||||
{%- if page.logo -%}
|
||||
<img src='/images/supported_brands/{{ page.logo }}' />
|
||||
{%- else -%}
|
||||
<img src='https://brands.home-assistant.io/{{ page.ha_domain }}/logo.png' srcset='https://brands.home-assistant.io/{{ page.ha_domain }}/logo@2x.png 2x' />
|
||||
{%- endif -%}
|
||||
</div>
|
||||
|
||||
{%- assign file_parts = page.url | split: '/' | last | split: '.' -%}
|
||||
{%- assign imp_name = file_parts | last -%}
|
||||
{%- assign imp_url = imp_name | prepend: '/components/' | append: '/' -%}
|
||||
|
||||
<div class="section">
|
||||
<kb-alert-link integration="{{ imp_name }}"></kb-alert-link>
|
||||
</div>
|
||||
{%- if page.ha_domain -%}
|
||||
<div class="section">
|
||||
<kb-alert-link integration="{{ page.ha_domain }}"></kb-alert-link>
|
||||
</div>
|
||||
{%- endif -%}
|
||||
|
||||
{%- if page.ha_iot_class -%}
|
||||
<div class='section'>
|
||||
@ -50,9 +48,11 @@
|
||||
</div>
|
||||
{%- endif -%}
|
||||
|
||||
<div class='section'>
|
||||
Source: <a href='{{github_main_repo}}{{imp_url}}'>{{imp_url}}</a>
|
||||
</div>
|
||||
{%- if page.ha_domain -%}
|
||||
<div class='section'>
|
||||
Source: <a href='https://github.com/home-assistant/core/tree/dev/homeassistant/components/{{ page.ha_domain }}'>View on GitHub</a>
|
||||
</div>
|
||||
{%- endif -%}
|
||||
|
||||
{%- if page.ha_category.first -%}
|
||||
<div class='section'>
|
||||
|
@ -98,9 +98,6 @@
|
||||
<li>
|
||||
<b>{% active_link /docs/frontend/ Frontend %}</b>
|
||||
<ul>
|
||||
<li>
|
||||
{% active_link /docs/frontend/mobile/ Android/iOS Homescreen %}
|
||||
</li>
|
||||
<li>
|
||||
{% active_link /docs/frontend/browsers/ Browser Compatibility List
|
||||
%}
|
||||
@ -270,27 +267,6 @@
|
||||
<li>
|
||||
{% active_link /docs/ecosystem/hadashboard/ HADashboard %}
|
||||
</li>
|
||||
<li>
|
||||
{% active_link /docs/ecosystem/notebooks/ Notebooks %}
|
||||
<ul>
|
||||
<li>{% active_link /docs/ecosystem/notebooks/ Introduction %}</li>
|
||||
<li>
|
||||
{% active_link /docs/ecosystem/notebooks/installation/
|
||||
Installation %}
|
||||
</li>
|
||||
<li>{% active_link /docs/ecosystem/notebooks/graph/ Graph %}</li>
|
||||
<li>
|
||||
{% active_link /docs/ecosystem/notebooks/api/ Home Assistant API
|
||||
%}
|
||||
</li>
|
||||
<li>
|
||||
{% active_link /docs/ecosystem/notebooks/database/ Database %}
|
||||
</li>
|
||||
<li>
|
||||
{% active_link /docs/ecosystem/notebooks/stats/ Statistics %}
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
Remote access
|
||||
<ul>
|
||||
@ -342,10 +318,6 @@
|
||||
</ul>
|
||||
</li>
|
||||
<li>{% active_link /docs/ecosystem/synology/ Synology %}</li>
|
||||
<li>
|
||||
{% active_link /docs/ecosystem/hass-configurator/ Configurator
|
||||
%}
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
@ -17,6 +17,7 @@
|
||||
<li>{% active_link /lovelace/header-footer/ Headers & Footers %}</li>
|
||||
<li>{% active_link /lovelace/yaml-mode/ YAML mode %}</li>
|
||||
<li>{% active_link /lovelace/views/ Views %}</li>
|
||||
<li>{% active_link /lovelace/actions/ Actions %}</li>
|
||||
<li><a href='https://developers.home-assistant.io/docs/en/lovelace_custom_card.html'>Developing Custom Cards <i icon='icon-external-link'></i></a></li>
|
||||
</ul>
|
||||
</div>
|
||||
|
@ -12,7 +12,7 @@
|
||||
<img src='/images/supported_brands/philips_hue.png' alt="Philips Hue" />
|
||||
</a>
|
||||
<a href='/integrations/cast/'>
|
||||
<img src='/images/supported_brands/google_cast.png' alt="Google Cast" />
|
||||
<img src='https://brands.home-assistant.io/cast/logo.png' srcset="https://brands.home-assistant.io/cast/logo@2x.png 2x" alt="Google Cast"/>
|
||||
</a>
|
||||
<a href='/integrations/mqtt/'>
|
||||
<img src='/images/supported_brands/mqtt.png' alt="MQTT" />
|
||||
@ -41,9 +41,6 @@
|
||||
<a href='/integrations/arduino/'>
|
||||
<img src='/images/supported_brands/arduino.png' alt="Arduino" />
|
||||
</a>
|
||||
<!-- <a href='/integrations/wink/'>
|
||||
<img src='/images/supported_brands/wink.png' alt="Wink" />
|
||||
</a> -->
|
||||
</div>
|
||||
|
||||
<p class='pull-right'><a href='/integrations/'>Browse all »</a></p>
|
||||
|
@ -24,7 +24,7 @@
|
||||
{% endcomment %}
|
||||
<li><a href="/getting-started/">Getting started</a></li>
|
||||
<li><a href="/integrations/">Integrations</a></li>
|
||||
<li><a href="/docs/">Docs</a></li>
|
||||
<li><a href="/docs/">Documentation</a></li>
|
||||
<li><a href="/cookbook/">Examples</a></li>
|
||||
<li><a href="/blog/">Blog</a></li>
|
||||
<li><a href="/help/">Need help?</a></li>
|
||||
@ -35,7 +35,7 @@
|
||||
<div class='search-container' style='display: none'>
|
||||
<div class='search'>
|
||||
<i class="icon-search"></i>
|
||||
<input id='search' placeholder='Search the docs…'>
|
||||
<input id='search' placeholder='Search the documentation…'>
|
||||
<a href='#' class='close'><i class="icon-remove-sign"></i></a>
|
||||
</div>
|
||||
</div>
|
||||
|
@ -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.
|
||||
|
@ -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/).
|
||||
|
@ -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.
|
||||
|
@ -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
|
||||
|
@ -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.
|
||||
|
@ -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`
|
||||
|
||||
<div class='note info'>
|
||||
This integration retrieves data from AfterShip public REST API, but the integration is not affiliated with AfterShip.
|
||||
|
@ -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.
|
||||
|
@ -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.
|
||||
|
@ -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.
|
||||
|
@ -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
|
||||
|
||||
<div class='note warning'>
|
||||
|
||||
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.
|
||||
|
||||
</div>
|
||||
|
||||
@ -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
|
||||
|
||||
|
@ -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.
|
||||
|
@ -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).
|
||||
|
@ -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.
|
||||
|
@ -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 %}
|
||||
|
@ -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.
|
||||
|
@ -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:
|
||||
|
@ -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/).
|
||||
|
@ -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'
|
||||
|
@ -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
|
||||
|
@ -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
|
||||
|
@ -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
|
||||
|
@ -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.
|
||||
|
||||
<div class='info'>
|
||||
|
||||
@ -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 <https://developer.amazon.com/docs/smarthome/send-events-to-the-alexa-event-gateway.html#endpoints>
|
||||
- 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.
|
||||
|
@ -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.
|
||||
|
@ -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.
|
||||
|
@ -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.
|
||||
|
@ -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:
|
||||
|
||||
|
@ -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
|
||||
|
@ -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.
|
||||
|
@ -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.
|
||||
|
@ -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.
|
||||
|
@ -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.
|
||||
|
@ -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.
|
||||
|
@ -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.
|
||||
|
@ -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
|
||||
|
@ -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.
|
||||
|
@ -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/).
|
||||
|
@ -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.
|
||||
|
@ -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.
|
||||
|
@ -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.)
|
||||
|
@ -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.
|
||||
|
@ -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.
|
||||
|
@ -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).
|
||||
|
@ -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.
|
||||
|
@ -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.
|
||||
|
@ -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:
|
||||
|
@ -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.
|
||||
|
@ -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.
|
||||
|
@ -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.
|
||||
|
@ -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/).
|
||||
|
@ -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.
|
||||
|
@ -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
|
||||
|
@ -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.
|
||||
|
@ -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).
|
||||
|
@ -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
|
||||
|
@ -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.
|
||||
|
@ -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
|
||||
|
@ -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.
|
||||
|
@ -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.
|
||||
|
@ -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.
|
||||
|
||||
<p class='img'>
|
||||
|
@ -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.
|
||||
|
@ -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/).
|
||||
|
Some files were not shown because too many files have changed in this diff Show More
Loading…
x
Reference in New Issue
Block a user