mirror of
https://github.com/home-assistant/home-assistant.io.git
synced 2025-07-16 13:56:53 +00:00
Merge branch 'current' into next
This commit is contained in:
Franck Nijhof
commit
7949b2b3b9
2
.github/workflows/lock.yml
vendored
2
.github/workflows/lock.yml
vendored
@ -11,7 +11,7 @@ jobs:
|
||||
pull-requests: write
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- uses: dessant/lock-threads@v4.0.1
|
||||
- uses: dessant/lock-threads@v5.0.1
|
||||
if: ${{ github.repository_owner == 'home-assistant' }}
|
||||
with:
|
||||
github-token: ${{ github.token }}
|
||||
|
||||
@ -273,7 +273,7 @@
|
||||
"ViCare",
|
||||
"Viessmann",
|
||||
"VIVOTEK",
|
||||
"Vizio",
|
||||
"VIZIO",
|
||||
"Vultr",
|
||||
"WebDAV",
|
||||
"WeMo",
|
||||
|
||||
2
Gemfile
2
Gemfile
@ -20,7 +20,7 @@ group :jekyll_plugins do
|
||||
end
|
||||
|
||||
gem 'sinatra', '3.1.0'
|
||||
gem 'nokogiri', '1.15.4'
|
||||
gem 'nokogiri', '1.15.5'
|
||||
|
||||
# Windows and JRuby does not include zoneinfo files, so bundle the tzinfo-data gem
|
||||
# and associated library
|
||||
|
||||
10
Gemfile.lock
10
Gemfile.lock
@ -26,7 +26,7 @@ GEM
|
||||
eventmachine (1.2.7-x64-mingw32)
|
||||
ffi (1.16.3)
|
||||
forwardable-extended (2.6.0)
|
||||
google-protobuf (3.24.4)
|
||||
google-protobuf (3.25.1)
|
||||
http_parser.rb (0.8.0)
|
||||
i18n (1.14.1)
|
||||
concurrent-ruby (~> 1.0)
|
||||
@ -71,13 +71,13 @@ GEM
|
||||
multi_json (1.15.0)
|
||||
mustermann (3.0.0)
|
||||
ruby2_keywords (~> 0.0.1)
|
||||
nokogiri (1.15.4)
|
||||
nokogiri (1.15.5)
|
||||
mini_portile2 (~> 2.8.2)
|
||||
racc (~> 1.4)
|
||||
pathutil (0.16.2)
|
||||
forwardable-extended (~> 2.6)
|
||||
public_suffix (5.0.3)
|
||||
racc (1.7.1)
|
||||
public_suffix (5.0.4)
|
||||
racc (1.7.3)
|
||||
rack (2.2.8)
|
||||
rack-protection (3.1.0)
|
||||
rack (~> 2.2, >= 2.2.4)
|
||||
@ -128,7 +128,7 @@ DEPENDENCIES
|
||||
jekyll-paginate (= 1.1.0)
|
||||
jekyll-sitemap (= 1.4.0)
|
||||
jekyll-toc (= 0.18.0)
|
||||
nokogiri (= 1.15.4)
|
||||
nokogiri (= 1.15.5)
|
||||
rake (= 13.1.0)
|
||||
sass-globbing (= 1.1.5)
|
||||
sassc (= 2.1.0)
|
||||
|
||||
@ -110,8 +110,8 @@ social:
|
||||
# Home Assistant release details
|
||||
current_major_version: 2023
|
||||
current_minor_version: 11
|
||||
current_patch_version: 0
|
||||
date_released: 2023-11-01
|
||||
current_patch_version: 3
|
||||
date_released: 2023-11-22
|
||||
|
||||
# Either # or the anchor link to latest release notes in the blog post.
|
||||
# Must be prefixed with a # and have double quotes around it.
|
||||
|
||||
200
package-lock.json
generated
200
package-lock.json
generated
@ -20,10 +20,10 @@
|
||||
"remark-lint-prohibited-strings": "^3.1.0",
|
||||
"remark-lint-unordered-list-marker-style": "^3.1.2",
|
||||
"remark-stringify": "^11.0.0",
|
||||
"textlint": "^13.3.3",
|
||||
"textlint": "^13.4.1",
|
||||
"textlint-filter-rule-comments": "^1.2.2",
|
||||
"textlint-rule-common-misspellings": "^1.0.1",
|
||||
"textlint-rule-terminology": "^4.0.0"
|
||||
"textlint-rule-terminology": "^4.0.1"
|
||||
}
|
||||
},
|
||||
"node_modules/@aashutoshrathi/word-wrap": {
|
||||
@ -410,59 +410,59 @@
|
||||
}
|
||||
},
|
||||
"node_modules/@textlint/ast-node-types": {
|
||||
"version": "13.3.3",
|
||||
"resolved": "https://registry.npmjs.org/@textlint/ast-node-types/-/ast-node-types-13.3.3.tgz",
|
||||
"integrity": "sha512-KCpJppfX3Km69twa6SmVEJ8mkyAZSrxw3XaaLQSlpc7PWnLUJSCHGPVECI1nSUDhiTd1r6zlRvWuyIAZJiov+A==",
|
||||
"version": "13.4.1",
|
||||
"resolved": "https://registry.npmjs.org/@textlint/ast-node-types/-/ast-node-types-13.4.1.tgz",
|
||||
"integrity": "sha512-qrZyhCh8Ekk6nwArx3BROybm9BnX6vF7VcZbijetV/OM3yfS4rTYhoMWISmhVEP2H2re0CtWEyMl/XF+WdvVLQ==",
|
||||
"dev": true
|
||||
},
|
||||
"node_modules/@textlint/ast-tester": {
|
||||
"version": "13.3.3",
|
||||
"resolved": "https://registry.npmjs.org/@textlint/ast-tester/-/ast-tester-13.3.3.tgz",
|
||||
"integrity": "sha512-vIIEJ0vDJb3Pr4kseOH9yzUCxx1EbX6PQDg/DgQj9sMAnwVG2sZvy2Uiga4+hj8SphdzaKia9Z+156UZzs+mzA==",
|
||||
"version": "13.4.1",
|
||||
"resolved": "https://registry.npmjs.org/@textlint/ast-tester/-/ast-tester-13.4.1.tgz",
|
||||
"integrity": "sha512-YSHUR1qDgMPGF5+nvrquEhif6zRJ667xUnfP/9rTNtThIhoTQINvczr5/7xa43F1PDWplL6Curw+2jrE1qHwGQ==",
|
||||
"dev": true,
|
||||
"dependencies": {
|
||||
"@textlint/ast-node-types": "^13.3.3",
|
||||
"@textlint/ast-node-types": "^13.4.1",
|
||||
"debug": "^4.3.4"
|
||||
}
|
||||
},
|
||||
"node_modules/@textlint/ast-traverse": {
|
||||
"version": "13.3.3",
|
||||
"resolved": "https://registry.npmjs.org/@textlint/ast-traverse/-/ast-traverse-13.3.3.tgz",
|
||||
"integrity": "sha512-tZ25emmWf3mJ4+vM8CO6D7F8l00WXD6MJgnnlY9BHI/HbOlngBfmKhTVizQEwrWfYF80sQO5R9a+N4UEk67Wcg==",
|
||||
"version": "13.4.1",
|
||||
"resolved": "https://registry.npmjs.org/@textlint/ast-traverse/-/ast-traverse-13.4.1.tgz",
|
||||
"integrity": "sha512-uucuC7+NHWkXx2TX5vuyreuHeb+GFiA83V65I+FnYP5EC4dAMOQ86rTSPrZmCwLz+qIWgfDgihGzPccpj3EZGg==",
|
||||
"dev": true,
|
||||
"dependencies": {
|
||||
"@textlint/ast-node-types": "^13.3.3"
|
||||
"@textlint/ast-node-types": "^13.4.1"
|
||||
}
|
||||
},
|
||||
"node_modules/@textlint/config-loader": {
|
||||
"version": "13.3.3",
|
||||
"resolved": "https://registry.npmjs.org/@textlint/config-loader/-/config-loader-13.3.3.tgz",
|
||||
"integrity": "sha512-DQA/7dYu3VDHP9Idd0Sn7HzwiFuNdKUXfA79pUGmJzNQUYaW0qADzyQCwfh7LlvhCcBmnLgX+8wb13o6OaHX5g==",
|
||||
"version": "13.4.1",
|
||||
"resolved": "https://registry.npmjs.org/@textlint/config-loader/-/config-loader-13.4.1.tgz",
|
||||
"integrity": "sha512-ggh6her5PdgcEsvgm3FfCY2+r7IhoQoBTGYxM+IbfkwyVoSoQ2CrXbCVlQkpLPFzhHVbIwgNxkiMr1o2npwfJQ==",
|
||||
"dev": true,
|
||||
"dependencies": {
|
||||
"@textlint/kernel": "^13.3.3",
|
||||
"@textlint/module-interop": "^13.3.3",
|
||||
"@textlint/types": "^13.3.3",
|
||||
"@textlint/utils": "^13.3.3",
|
||||
"@textlint/kernel": "^13.4.1",
|
||||
"@textlint/module-interop": "^13.4.1",
|
||||
"@textlint/types": "^13.4.1",
|
||||
"@textlint/utils": "^13.4.1",
|
||||
"debug": "^4.3.4",
|
||||
"rc-config-loader": "^4.1.3",
|
||||
"try-resolve": "^1.0.1"
|
||||
}
|
||||
},
|
||||
"node_modules/@textlint/feature-flag": {
|
||||
"version": "13.3.3",
|
||||
"resolved": "https://registry.npmjs.org/@textlint/feature-flag/-/feature-flag-13.3.3.tgz",
|
||||
"integrity": "sha512-ltdwKQTvs9f/TgQ3asBx2EXmsSSsvxa7ySnTXSTZBkbVxqmrGY4zehDRiDCmuFZGVGCvCddY1QzCXy16ybk9Fg==",
|
||||
"version": "13.4.1",
|
||||
"resolved": "https://registry.npmjs.org/@textlint/feature-flag/-/feature-flag-13.4.1.tgz",
|
||||
"integrity": "sha512-qY8gKUf30XtzWMTkwYeKytCo6KPx6milpz8YZhuRsEPjT/5iNdakJp5USWDQWDrwbQf7RbRncQdU+LX5JbM9YA==",
|
||||
"dev": true
|
||||
},
|
||||
"node_modules/@textlint/fixer-formatter": {
|
||||
"version": "13.3.3",
|
||||
"resolved": "https://registry.npmjs.org/@textlint/fixer-formatter/-/fixer-formatter-13.3.3.tgz",
|
||||
"integrity": "sha512-iCMFS8GrmUetXMIT4/jFxoL5v1QN5ODj1190Lb6D+EdTxsrAWssHOb6m7MOEhfOGYEArAkb3PjSxu7DPLrb50g==",
|
||||
"version": "13.4.1",
|
||||
"resolved": "https://registry.npmjs.org/@textlint/fixer-formatter/-/fixer-formatter-13.4.1.tgz",
|
||||
"integrity": "sha512-P195Soyxmzv7S5QyCJIjuDXl5t3EyOhYwxR4ukKBZ7bw5hp/P1+e4GEhzqrXWx3z7h0nZZ0TuTjepNxOMo6cAQ==",
|
||||
"dev": true,
|
||||
"dependencies": {
|
||||
"@textlint/module-interop": "^13.3.3",
|
||||
"@textlint/types": "^13.3.3",
|
||||
"@textlint/module-interop": "^13.4.1",
|
||||
"@textlint/types": "^13.4.1",
|
||||
"chalk": "^4.1.2",
|
||||
"debug": "^4.3.4",
|
||||
"diff": "^4.0.2",
|
||||
@ -474,36 +474,35 @@
|
||||
}
|
||||
},
|
||||
"node_modules/@textlint/kernel": {
|
||||
"version": "13.3.3",
|
||||
"resolved": "https://registry.npmjs.org/@textlint/kernel/-/kernel-13.3.3.tgz",
|
||||
"integrity": "sha512-HewzuuX2c2nlR+e8dREWrAYrOiyWb78eeObuW95miMjX/F6TjWmha4qrnrMCWbYbKDwC4en8dNGS4mm0vSdi4A==",
|
||||
"version": "13.4.1",
|
||||
"resolved": "https://registry.npmjs.org/@textlint/kernel/-/kernel-13.4.1.tgz",
|
||||
"integrity": "sha512-r2sUhjPysFjl2Ax37x9AfWkJM8jgKN0bL4SX3xRzOukdcj69Dst5On5qBZtULaVMX1LDkwkdxA6ZEADmq27qQA==",
|
||||
"dev": true,
|
||||
"dependencies": {
|
||||
"@textlint/ast-node-types": "^13.3.3",
|
||||
"@textlint/ast-tester": "^13.3.3",
|
||||
"@textlint/ast-traverse": "^13.3.3",
|
||||
"@textlint/feature-flag": "^13.3.3",
|
||||
"@textlint/source-code-fixer": "^13.3.3",
|
||||
"@textlint/types": "^13.3.3",
|
||||
"@textlint/utils": "^13.3.3",
|
||||
"@textlint/ast-node-types": "^13.4.1",
|
||||
"@textlint/ast-tester": "^13.4.1",
|
||||
"@textlint/ast-traverse": "^13.4.1",
|
||||
"@textlint/feature-flag": "^13.4.1",
|
||||
"@textlint/source-code-fixer": "^13.4.1",
|
||||
"@textlint/types": "^13.4.1",
|
||||
"@textlint/utils": "^13.4.1",
|
||||
"debug": "^4.3.4",
|
||||
"fast-equals": "^4.0.3",
|
||||
"structured-source": "^4.0.0"
|
||||
}
|
||||
},
|
||||
"node_modules/@textlint/linter-formatter": {
|
||||
"version": "13.3.3",
|
||||
"resolved": "https://registry.npmjs.org/@textlint/linter-formatter/-/linter-formatter-13.3.3.tgz",
|
||||
"integrity": "sha512-z8xsk1bo9r8v6Ph76WLTBrfj+0+eyEfRlbTGBs+ie6YAGItBqkLYmDrD26DDfVjIZcXWdCXVX1Et6MOWomb//g==",
|
||||
"version": "13.4.1",
|
||||
"resolved": "https://registry.npmjs.org/@textlint/linter-formatter/-/linter-formatter-13.4.1.tgz",
|
||||
"integrity": "sha512-VDLnyHRO9hf6CGxMJLM5oi7NH9s0mqiWxtgi95nuXmJZWbQLZVfcxkD1Cp16pwk8zTvlbyMZFqamFCYZyD9Sww==",
|
||||
"dev": true,
|
||||
"dependencies": {
|
||||
"@azu/format-text": "^1.0.2",
|
||||
"@azu/style-format": "^1.0.1",
|
||||
"@textlint/module-interop": "^13.3.3",
|
||||
"@textlint/types": "^13.3.3",
|
||||
"@textlint/module-interop": "^13.4.1",
|
||||
"@textlint/types": "^13.4.1",
|
||||
"chalk": "^4.1.2",
|
||||
"debug": "^4.3.4",
|
||||
"is-file": "^1.0.0",
|
||||
"js-yaml": "^3.14.1",
|
||||
"lodash": "^4.17.21",
|
||||
"pluralize": "^2.0.0",
|
||||
@ -515,12 +514,12 @@
|
||||
}
|
||||
},
|
||||
"node_modules/@textlint/markdown-to-ast": {
|
||||
"version": "13.3.3",
|
||||
"resolved": "https://registry.npmjs.org/@textlint/markdown-to-ast/-/markdown-to-ast-13.3.3.tgz",
|
||||
"integrity": "sha512-jeqWyChTtJHWxEnH46V6qjr+OCTh6evm45aDqMzdg+b8ocXY+NhudiCMeHcVGoz042UEwc6w4reLn8+Is+SZ+A==",
|
||||
"version": "13.4.1",
|
||||
"resolved": "https://registry.npmjs.org/@textlint/markdown-to-ast/-/markdown-to-ast-13.4.1.tgz",
|
||||
"integrity": "sha512-jUa5bTNmxjEgfCXW4xfn7eSJqzUXyNKiIDWLKtI4MUKRNhT3adEaa/NuQl0Mii3Hu3HraZR7hYhRHLh+eeM43w==",
|
||||
"dev": true,
|
||||
"dependencies": {
|
||||
"@textlint/ast-node-types": "^13.3.3",
|
||||
"@textlint/ast-node-types": "^13.4.1",
|
||||
"debug": "^4.3.4",
|
||||
"mdast-util-gfm-autolink-literal": "^0.1.3",
|
||||
"remark-footnotes": "^3.0.0",
|
||||
@ -758,61 +757,61 @@
|
||||
}
|
||||
},
|
||||
"node_modules/@textlint/module-interop": {
|
||||
"version": "13.3.3",
|
||||
"resolved": "https://registry.npmjs.org/@textlint/module-interop/-/module-interop-13.3.3.tgz",
|
||||
"integrity": "sha512-CwfVpRGAxbkhGY9vLLU06Q/dy/RMNnyzbmt6IS2WIyxqxvGaF7QZtFYpKEEm63aemVyUvzQ7WM3yVOoUg6P92w==",
|
||||
"version": "13.4.1",
|
||||
"resolved": "https://registry.npmjs.org/@textlint/module-interop/-/module-interop-13.4.1.tgz",
|
||||
"integrity": "sha512-keM5zHwyifijEDqEvAFhhXHC5UbmZjfGytRJzPPJaW3C3UsGbIzDCnfOSE9jUVTWZcngHuSJ7aKGv42Rhy9nEg==",
|
||||
"dev": true
|
||||
},
|
||||
"node_modules/@textlint/source-code-fixer": {
|
||||
"version": "13.3.3",
|
||||
"resolved": "https://registry.npmjs.org/@textlint/source-code-fixer/-/source-code-fixer-13.3.3.tgz",
|
||||
"integrity": "sha512-h4jxWSetmcVuGwl71ai72784aneBQ0MkE5Mc3avl8PKIOIOyz0A1D7i9VQENWWIiqU8zyzmHwKGNSGyqWaqE2Q==",
|
||||
"version": "13.4.1",
|
||||
"resolved": "https://registry.npmjs.org/@textlint/source-code-fixer/-/source-code-fixer-13.4.1.tgz",
|
||||
"integrity": "sha512-Sl29f3Tpimp0uVE3ysyJBjxaFTVYLOXiJX14eWCQ/kC5ZhIXGosEbStzkP1n8Urso1rs1W4p/2UemVAm3NH2ng==",
|
||||
"dev": true,
|
||||
"dependencies": {
|
||||
"@textlint/types": "^13.3.3",
|
||||
"@textlint/types": "^13.4.1",
|
||||
"debug": "^4.3.4"
|
||||
}
|
||||
},
|
||||
"node_modules/@textlint/text-to-ast": {
|
||||
"version": "13.3.3",
|
||||
"resolved": "https://registry.npmjs.org/@textlint/text-to-ast/-/text-to-ast-13.3.3.tgz",
|
||||
"integrity": "sha512-iQdiHAiUfB9XruuYWCb4fY/gD/Q5/MkH1xwUTpS8UJowNgwpTldagUJX1JbZQ2UHux+yRe9JFA+JKm3rrxgQFw==",
|
||||
"version": "13.4.1",
|
||||
"resolved": "https://registry.npmjs.org/@textlint/text-to-ast/-/text-to-ast-13.4.1.tgz",
|
||||
"integrity": "sha512-vCA7uMmbjRv06sEHPbwxTV5iS8OQedC5s7qwmXnWAn2LLWxg4Yp98mONPS1o4D5cPomzYyKNCSfbLwu6yJBUQA==",
|
||||
"dev": true,
|
||||
"dependencies": {
|
||||
"@textlint/ast-node-types": "^13.3.3"
|
||||
"@textlint/ast-node-types": "^13.4.1"
|
||||
}
|
||||
},
|
||||
"node_modules/@textlint/textlint-plugin-markdown": {
|
||||
"version": "13.3.3",
|
||||
"resolved": "https://registry.npmjs.org/@textlint/textlint-plugin-markdown/-/textlint-plugin-markdown-13.3.3.tgz",
|
||||
"integrity": "sha512-EhBZ/Q6ZXMVRPDeQbFdFbtc0wE7SC0DWy9lkjKXfcbLKW0ZPTvtjH3JqJtCPBZAYcexB8wKOiHImfwVfQJhJhg==",
|
||||
"version": "13.4.1",
|
||||
"resolved": "https://registry.npmjs.org/@textlint/textlint-plugin-markdown/-/textlint-plugin-markdown-13.4.1.tgz",
|
||||
"integrity": "sha512-OcLkFKYmbYeGJ0kj2487qcicCYTiE2vJLwfPcUDJrNoMYak5JtvHJfWffck8gON2mEM00DPkHH0UdxZpFjDfeg==",
|
||||
"dev": true,
|
||||
"dependencies": {
|
||||
"@textlint/markdown-to-ast": "^13.3.3"
|
||||
"@textlint/markdown-to-ast": "^13.4.1"
|
||||
}
|
||||
},
|
||||
"node_modules/@textlint/textlint-plugin-text": {
|
||||
"version": "13.3.3",
|
||||
"resolved": "https://registry.npmjs.org/@textlint/textlint-plugin-text/-/textlint-plugin-text-13.3.3.tgz",
|
||||
"integrity": "sha512-MN/JMGLanqj8CJGuit8DDiyrO0yf1vxFMLWTDeMIXwSoe8VToHCt2j20zg8XNHGNrUbKj+wuhzhrkrKEI7uWxg==",
|
||||
"version": "13.4.1",
|
||||
"resolved": "https://registry.npmjs.org/@textlint/textlint-plugin-text/-/textlint-plugin-text-13.4.1.tgz",
|
||||
"integrity": "sha512-z0p5B8WUfTCIRmhjVHFfJv719oIElDDKWOIZei4CyYkfMGo0kq8fkrYBkUR6VZ6gofHwc+mwmIABdUf1rDHzYA==",
|
||||
"dev": true,
|
||||
"dependencies": {
|
||||
"@textlint/text-to-ast": "^13.3.3"
|
||||
"@textlint/text-to-ast": "^13.4.1"
|
||||
}
|
||||
},
|
||||
"node_modules/@textlint/types": {
|
||||
"version": "13.3.3",
|
||||
"resolved": "https://registry.npmjs.org/@textlint/types/-/types-13.3.3.tgz",
|
||||
"integrity": "sha512-i2B7uRh+Iv8ZBKPJ3n4I6uSrTUQq5LdEkhFYNUwnDYxmhudz1o79xm906kri2eM8lxThX/UYYgVuJWpEwS0b+g==",
|
||||
"version": "13.4.1",
|
||||
"resolved": "https://registry.npmjs.org/@textlint/types/-/types-13.4.1.tgz",
|
||||
"integrity": "sha512-1ApwQa31sFmiJeJ5yTNFqjbb2D1ICZvIDW0tFSM0OtmQCSDFNcKD3YrrwDBgSokZ6gWQq/FpNjlhi6iETUWt0Q==",
|
||||
"dev": true,
|
||||
"dependencies": {
|
||||
"@textlint/ast-node-types": "^13.3.3"
|
||||
"@textlint/ast-node-types": "^13.4.1"
|
||||
}
|
||||
},
|
||||
"node_modules/@textlint/utils": {
|
||||
"version": "13.3.3",
|
||||
"resolved": "https://registry.npmjs.org/@textlint/utils/-/utils-13.3.3.tgz",
|
||||
"integrity": "sha512-roN+K3a36RxGc0tV+8HXVXpoPomEr3LCjNI8+hFmVjOu3RsUdLTyraNBqqaghaE0KgwCPODF0seuG1hteNI8LQ==",
|
||||
"version": "13.4.1",
|
||||
"resolved": "https://registry.npmjs.org/@textlint/utils/-/utils-13.4.1.tgz",
|
||||
"integrity": "sha512-wX8RT1ejHAPTDmqlzngf0zI5kYoe3QvGDcj+skoTxSv+m/wOs/NyEr92d+ahCP32YqFYzXlqU7aDx2FkULKT+g==",
|
||||
"dev": true
|
||||
},
|
||||
"node_modules/@types/concat-stream": {
|
||||
@ -4089,9 +4088,9 @@
|
||||
}
|
||||
},
|
||||
"node_modules/path-to-glob-pattern": {
|
||||
"version": "1.0.2",
|
||||
"resolved": "https://registry.npmjs.org/path-to-glob-pattern/-/path-to-glob-pattern-1.0.2.tgz",
|
||||
"integrity": "sha512-ryF65N5MBB9XOjE5mMOi+0bMrh1F0ORQmqDSSERvv5zD62Cfc5QC6rK1AR1xuDIG1I091CkNENblbteWy1bXgw==",
|
||||
"version": "2.0.1",
|
||||
"resolved": "https://registry.npmjs.org/path-to-glob-pattern/-/path-to-glob-pattern-2.0.1.tgz",
|
||||
"integrity": "sha512-tmciSlVyHnX0LC86+zSr+0LURw9rDPw8ilhXcmTpVUOnI6OsKdCzXQs5fTG10Bjz26IBdnKL3XIaP+QvGsk5YQ==",
|
||||
"dev": true
|
||||
},
|
||||
"node_modules/path-type": {
|
||||
@ -4175,9 +4174,9 @@
|
||||
}
|
||||
},
|
||||
"node_modules/punycode": {
|
||||
"version": "2.3.0",
|
||||
"resolved": "https://registry.npmjs.org/punycode/-/punycode-2.3.0.tgz",
|
||||
"integrity": "sha512-rRV+zQD8tVFys26lAGR9WUuS4iUAngJScM+ZRSKtvl5tKeZ2t5bvdNFdNHBW9FWR4guGHlgmsZ1G7BSm2wTbuA==",
|
||||
"version": "2.3.1",
|
||||
"resolved": "https://registry.npmjs.org/punycode/-/punycode-2.3.1.tgz",
|
||||
"integrity": "sha512-vYt7UD1U9Wg6138shLtLOvdAu+8DsC/ilFtEVHcH+wydcSpNE20AfSOduf6MkRFahL5FY7X1oU7nKVZFtfq8Fg==",
|
||||
"dev": true,
|
||||
"engines": {
|
||||
"node": ">=6"
|
||||
@ -5926,32 +5925,31 @@
|
||||
"dev": true
|
||||
},
|
||||
"node_modules/textlint": {
|
||||
"version": "13.3.3",
|
||||
"resolved": "https://registry.npmjs.org/textlint/-/textlint-13.3.3.tgz",
|
||||
"integrity": "sha512-1LhJTNBFVNYtl4C6IJXt1XwAJANvquyDuP4NrhcG+1DwT3S7kiUR9vLo5yo046X83VT7ownzS97Q/yC6A7bZXg==",
|
||||
"version": "13.4.1",
|
||||
"resolved": "https://registry.npmjs.org/textlint/-/textlint-13.4.1.tgz",
|
||||
"integrity": "sha512-ev6XkQEUMWcW90hTHJKlvt23ca1AtmmK2iw4mazqKnSVz8PTSMg45NB68ht3ev92lIPD+8Wt4D6JxCInZkh4GQ==",
|
||||
"dev": true,
|
||||
"dependencies": {
|
||||
"@textlint/ast-node-types": "^13.3.3",
|
||||
"@textlint/ast-traverse": "^13.3.3",
|
||||
"@textlint/config-loader": "^13.3.3",
|
||||
"@textlint/feature-flag": "^13.3.3",
|
||||
"@textlint/fixer-formatter": "^13.3.3",
|
||||
"@textlint/kernel": "^13.3.3",
|
||||
"@textlint/linter-formatter": "^13.3.3",
|
||||
"@textlint/module-interop": "^13.3.3",
|
||||
"@textlint/textlint-plugin-markdown": "^13.3.3",
|
||||
"@textlint/textlint-plugin-text": "^13.3.3",
|
||||
"@textlint/types": "^13.3.3",
|
||||
"@textlint/utils": "^13.3.3",
|
||||
"@textlint/ast-node-types": "^13.4.1",
|
||||
"@textlint/ast-traverse": "^13.4.1",
|
||||
"@textlint/config-loader": "^13.4.1",
|
||||
"@textlint/feature-flag": "^13.4.1",
|
||||
"@textlint/fixer-formatter": "^13.4.1",
|
||||
"@textlint/kernel": "^13.4.1",
|
||||
"@textlint/linter-formatter": "^13.4.1",
|
||||
"@textlint/module-interop": "^13.4.1",
|
||||
"@textlint/textlint-plugin-markdown": "^13.4.1",
|
||||
"@textlint/textlint-plugin-text": "^13.4.1",
|
||||
"@textlint/types": "^13.4.1",
|
||||
"@textlint/utils": "^13.4.1",
|
||||
"debug": "^4.3.4",
|
||||
"file-entry-cache": "^5.0.1",
|
||||
"get-stdin": "^5.0.1",
|
||||
"glob": "^7.2.3",
|
||||
"is-file": "^1.0.0",
|
||||
"md5": "^2.3.0",
|
||||
"mkdirp": "^0.5.6",
|
||||
"optionator": "^0.9.1",
|
||||
"path-to-glob-pattern": "^1.0.2",
|
||||
"optionator": "^0.9.3",
|
||||
"path-to-glob-pattern": "^2.0.1",
|
||||
"rc-config-loader": "^4.1.3",
|
||||
"read-pkg": "^1.1.0",
|
||||
"read-pkg-up": "^3.0.0",
|
||||
@ -6019,9 +6017,9 @@
|
||||
}
|
||||
},
|
||||
"node_modules/textlint-rule-terminology": {
|
||||
"version": "4.0.0",
|
||||
"resolved": "https://registry.npmjs.org/textlint-rule-terminology/-/textlint-rule-terminology-4.0.0.tgz",
|
||||
"integrity": "sha512-tbNpzDNLTVsqtDIMXEZNX2i1dvOqryME8Hknopq6Ze3TAjij5N0wBtG63frZLxJ9auE9fZse15sTi4Qe3arNZA==",
|
||||
"version": "4.0.1",
|
||||
"resolved": "https://registry.npmjs.org/textlint-rule-terminology/-/textlint-rule-terminology-4.0.1.tgz",
|
||||
"integrity": "sha512-wKiVhc2B9HP2MFU4x7ZDx+oM5u43ETpKWTLHKvdhPRZ0+davi4M8mFmkZVovDIMO7igsGjixikcvFmnCMg3kmQ==",
|
||||
"dev": true,
|
||||
"dependencies": {
|
||||
"lodash": "^4.17.15",
|
||||
|
||||
@ -15,10 +15,10 @@
|
||||
"remark-lint-prohibited-strings": "^3.1.0",
|
||||
"remark-lint-unordered-list-marker-style": "^3.1.2",
|
||||
"remark-stringify": "^11.0.0",
|
||||
"textlint": "^13.3.3",
|
||||
"textlint": "^13.4.1",
|
||||
"textlint-filter-rule-comments": "^1.2.2",
|
||||
"textlint-rule-common-misspellings": "^1.0.1",
|
||||
"textlint-rule-terminology": "^4.0.0"
|
||||
"textlint-rule-terminology": "^4.0.1"
|
||||
},
|
||||
"resolutions": {
|
||||
"minimist": ">=1.2.5"
|
||||
|
||||
@ -103,9 +103,9 @@
|
||||
display: inline-block;
|
||||
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);
|
||||
border-radius: 8px;
|
||||
border: 1px solid rgba(0, 0, 0, .12);
|
||||
box-shadow: rgba(0,0,0,0.06) 0 0 10px;
|
||||
padding: 8px;
|
||||
text-align: center;
|
||||
text-decoration: none;
|
||||
|
||||
@ -7,8 +7,9 @@ div.details-block {
|
||||
background-color: white;
|
||||
padding: 4px 16px;
|
||||
margin: 8px;
|
||||
box-shadow: 0px 4px 20px rgba(0, 0, 0, 0.1);
|
||||
border-radius: 16px;
|
||||
border: 1px solid rgba(0, 0, 0, .12);
|
||||
box-shadow: rgba(0,0,0,0.06) 0 0 10px;
|
||||
border-radius: 8px;
|
||||
|
||||
.details-block-title {
|
||||
font-weight: bold;
|
||||
|
||||
@ -30,12 +30,6 @@
|
||||
.card-content {
|
||||
padding-left: 24px;
|
||||
|
||||
.button {
|
||||
font-size: small;
|
||||
font-weight: 600;
|
||||
text-decoration: none;
|
||||
}
|
||||
|
||||
p:last-of-type,
|
||||
ul {
|
||||
margin-bottom: 12px;
|
||||
|
||||
@ -1,150 +1,260 @@
|
||||
#getting_started {
|
||||
.intro {
|
||||
padding-bottom: 16px;
|
||||
.intro {
|
||||
padding-bottom: 16px;
|
||||
font-size: 24px;
|
||||
}
|
||||
|
||||
.installations {
|
||||
.label {
|
||||
background: #e8e6f0;
|
||||
border-radius: 4px;
|
||||
padding: 6px 8px !important;
|
||||
margin-bottom: 16px;
|
||||
text-transform: uppercase;
|
||||
font-size: 16px;
|
||||
font-weight: 500;
|
||||
width: fit-content;
|
||||
|
||||
&.easiest {
|
||||
color: #04b154;
|
||||
}
|
||||
&.easy {
|
||||
color: #02b0ff;
|
||||
}
|
||||
&.intermediate {
|
||||
color: #eb873f;
|
||||
}
|
||||
&.hard {
|
||||
color: #ff5454;
|
||||
}
|
||||
&.expert {
|
||||
color: #ff02b8;
|
||||
}
|
||||
}
|
||||
|
||||
.installations {
|
||||
h2 {
|
||||
margin: 0;
|
||||
}
|
||||
|
||||
h2 {
|
||||
font-size: 0;
|
||||
margin: 0;
|
||||
.installations-card {
|
||||
text-decoration: none !important;
|
||||
color: black !important;
|
||||
margin-bottom: 32px;
|
||||
|
||||
.material-card {
|
||||
display: flex;
|
||||
flex-direction: row;
|
||||
justify-content: space-between;
|
||||
margin: 8px 0;
|
||||
|
||||
h3 {
|
||||
margin: 0;
|
||||
margin-bottom: 4px;
|
||||
}
|
||||
|
||||
.installations-card {
|
||||
text-decoration: none !important;
|
||||
color: black !important;
|
||||
.content-container {
|
||||
display: flex;
|
||||
width: 100%;
|
||||
|
||||
.material-card {
|
||||
.image {
|
||||
margin-right: 16px;
|
||||
|
||||
img {
|
||||
width: 200px;
|
||||
height: 200px;
|
||||
aspect-ratio: 1 / 1;
|
||||
max-height: 300px;
|
||||
border-radius: 4px;
|
||||
vertical-align: middle;
|
||||
object-fit: cover;
|
||||
border: 1px solid rgba(0, 0, 0, 0.12);
|
||||
}
|
||||
}
|
||||
|
||||
.icon {
|
||||
margin-right: 16px;
|
||||
height: 200px;
|
||||
width: 200px;
|
||||
padding: 40px;
|
||||
display: flex;
|
||||
justify-content: center;
|
||||
align-items: center;
|
||||
border-radius: 4px;
|
||||
background-color: #c4c4c4;
|
||||
> * {
|
||||
border-radius: 0;
|
||||
border: 0;
|
||||
box-shadow: none;
|
||||
width: 100%;
|
||||
height: auto;
|
||||
}
|
||||
}
|
||||
|
||||
.content {
|
||||
flex: 1;
|
||||
padding: 8px 0;
|
||||
p {
|
||||
font-size: 0.8em;
|
||||
margin: 0;
|
||||
}
|
||||
b {
|
||||
font-size: 0.7em;
|
||||
}
|
||||
|
||||
.columns {
|
||||
display: flex;
|
||||
width: 100%;
|
||||
margin-top: 8px;
|
||||
gap: 8px;
|
||||
|
||||
& > * {
|
||||
flex-basis: min-content;
|
||||
flex-grow: 1;
|
||||
}
|
||||
}
|
||||
|
||||
ul {
|
||||
font-size: 0.7em;
|
||||
margin: 0;
|
||||
|
||||
li {
|
||||
margin-left: 17px;
|
||||
margin-bottom: 0;
|
||||
}
|
||||
}
|
||||
.buttons {
|
||||
margin-top: 16px;
|
||||
display: flex;
|
||||
flex-direction: column;
|
||||
align-items: flex-start;
|
||||
|
||||
.button {
|
||||
display: flex;
|
||||
flex-direction: row;
|
||||
justify-content: space-between;
|
||||
margin: 8px 0;
|
||||
padding-right: 20px;
|
||||
&:not(:first-child) {
|
||||
margin-top: 12px;
|
||||
}
|
||||
|
||||
.content-container {
|
||||
display: flex;
|
||||
|
||||
div:first-of-type {
|
||||
margin-right: 24px;
|
||||
|
||||
img, svg {
|
||||
max-width: 170px;
|
||||
max-height: 170px;
|
||||
min-width: 170px;
|
||||
min-height: 170px;
|
||||
padding: 32px;
|
||||
border-radius: 3px;
|
||||
box-shadow: rgba(0,0,0,0.06) 0 0 10px;
|
||||
vertical-align: middle;
|
||||
border: 5px solid #fff;
|
||||
}
|
||||
}
|
||||
|
||||
div:last-of-type {
|
||||
|
||||
b {
|
||||
font-size: 28px;
|
||||
}
|
||||
|
||||
p {
|
||||
font-size: 0.8em;
|
||||
margin: 0;
|
||||
}
|
||||
|
||||
ul {
|
||||
font-size: 0.8em;
|
||||
margin-left: 24px;
|
||||
margin-top: 1rem;
|
||||
|
||||
li {
|
||||
margin: 0;
|
||||
}
|
||||
}
|
||||
}
|
||||
&.accent {
|
||||
background-color: #34b155;
|
||||
}
|
||||
svg {
|
||||
height: 42px;
|
||||
max-width: 42px;
|
||||
min-width: 42px;
|
||||
align-self: center;
|
||||
fill: white;
|
||||
height: 24px;
|
||||
min-width: 24px;
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
.compare-installations td,
|
||||
.compare-installations th {
|
||||
text-align: center;
|
||||
}
|
||||
|
||||
.compare-installations {
|
||||
background-color: #ffffff !important;
|
||||
border-radius: 8px;
|
||||
border: 1px solid rgba(0, 0, 0, 0.12);
|
||||
box-shadow: rgba(0, 0, 0, 0.06) 0 0 10px;
|
||||
margin-bottom: 1.5rem;
|
||||
|
||||
table {
|
||||
margin-bottom: 0;
|
||||
}
|
||||
|
||||
.compare-installations td,.compare-installations th {
|
||||
text-align: center;
|
||||
td,
|
||||
th {
|
||||
text-align: center;
|
||||
}
|
||||
|
||||
table.compare-installations {
|
||||
background-color: #ffffff !important;
|
||||
border-radius: 2px !important;
|
||||
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) !important;
|
||||
|
||||
td, th {
|
||||
text-align: center;
|
||||
}
|
||||
|
||||
tr {
|
||||
td:first-of-type {
|
||||
text-align: left;
|
||||
}
|
||||
}
|
||||
|
||||
tr:nth-child(even) {
|
||||
background-color: #fafafa;
|
||||
}
|
||||
tr {
|
||||
td:first-of-type {
|
||||
text-align: left;
|
||||
}
|
||||
}
|
||||
|
||||
tr:nth-child(even) {
|
||||
background-color: #fafafa;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
.link-card {
|
||||
text-decoration: none !important;
|
||||
color: black !important;
|
||||
div {
|
||||
margin: 32px 0;
|
||||
height: 64px;
|
||||
display: flex;
|
||||
justify-content: space-between;
|
||||
svg {
|
||||
height: 32px;
|
||||
width: 32px;
|
||||
max-width: 32px;
|
||||
}
|
||||
p {
|
||||
margin: 0;
|
||||
align-self: center;
|
||||
}
|
||||
text-decoration: none !important;
|
||||
color: black !important;
|
||||
div {
|
||||
margin: 32px 0;
|
||||
height: 64px;
|
||||
display: flex;
|
||||
justify-content: space-between;
|
||||
svg {
|
||||
height: 32px;
|
||||
width: 32px;
|
||||
max-width: 32px;
|
||||
}
|
||||
p {
|
||||
margin: 0;
|
||||
align-self: center;
|
||||
}
|
||||
}
|
||||
}
|
||||
.next-step {
|
||||
p {
|
||||
text-transform: uppercase;
|
||||
}
|
||||
p {
|
||||
text-transform: uppercase;
|
||||
}
|
||||
}
|
||||
|
||||
@media only screen and (max-width: $palm-end) {
|
||||
#getting_started {
|
||||
.installations {
|
||||
.installations-card {
|
||||
.material-card {
|
||||
.content-container {
|
||||
flex-flow: wrap;
|
||||
svg {
|
||||
display: block;
|
||||
}
|
||||
div:first-of-type {
|
||||
width: 100%;
|
||||
display: flex;
|
||||
justify-content: center;
|
||||
margin-bottom: 16px;
|
||||
}
|
||||
}
|
||||
svg {
|
||||
display: none;
|
||||
}
|
||||
}
|
||||
@media only screen and (max-width: 650px) {
|
||||
#getting_started {
|
||||
.installations {
|
||||
.installations-card {
|
||||
.material-card {
|
||||
.content-container {
|
||||
flex-direction: column;
|
||||
.image {
|
||||
width: 100%;
|
||||
display: flex;
|
||||
justify-content: center;
|
||||
margin-right: 0;
|
||||
margin-bottom: 16px;
|
||||
|
||||
img {
|
||||
width: 100%;
|
||||
height: unset;
|
||||
}
|
||||
}
|
||||
.icon {
|
||||
width: 100%;
|
||||
height: 200px;
|
||||
* {
|
||||
height: 100%;
|
||||
width: auto;
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
@media only screen and (max-width: 500px) {
|
||||
#getting_started {
|
||||
.installations {
|
||||
.installations-card {
|
||||
.material-card {
|
||||
.content-container {
|
||||
.columns {
|
||||
flex-direction: column;
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
@ -46,7 +46,6 @@ $ha__primary_color: #03a9f4;
|
||||
svg {
|
||||
stroke: $ha__primary_color;
|
||||
}
|
||||
|
||||
}
|
||||
|
||||
.wide {
|
||||
@ -69,7 +68,6 @@ $ha__primary_color: #03a9f4;
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
.bottom {
|
||||
position: absolute;
|
||||
bottom: 8px;
|
||||
@ -87,6 +85,8 @@ $ha__primary_color: #03a9f4;
|
||||
.button-row-with-icon {
|
||||
display: flex;
|
||||
justify-content: space-evenly;
|
||||
flex-wrap: wrap;
|
||||
gap: 16px;
|
||||
|
||||
a {
|
||||
display: block;
|
||||
@ -101,7 +101,7 @@ $ha__primary_color: #03a9f4;
|
||||
align-items: center;
|
||||
padding: 32px;
|
||||
text-align: center;
|
||||
background: #FFFFFF;
|
||||
background: #ffffff;
|
||||
width: 242px;
|
||||
height: 176px;
|
||||
box-shadow: 0px 4px 20px rgba(0, 0, 0, 0.1);
|
||||
@ -131,13 +131,12 @@ $ha__primary_color: #03a9f4;
|
||||
}
|
||||
|
||||
.section-content {
|
||||
background-color: #FAFAFA;
|
||||
background-color: #fafafa;
|
||||
width: 100%;
|
||||
display: grid;
|
||||
justify-items: center;
|
||||
padding: 64px;
|
||||
|
||||
|
||||
.title {
|
||||
font-size: 24px;
|
||||
line-height: 28px;
|
||||
@ -169,13 +168,16 @@ $ha__primary_color: #03a9f4;
|
||||
display: flex;
|
||||
flex-direction: row;
|
||||
width: 100%;
|
||||
padding: 32px 128px;
|
||||
padding: 32px;
|
||||
justify-content: space-evenly;
|
||||
|
||||
.section-inner-content {
|
||||
align-self: center;
|
||||
padding: 0;
|
||||
|
||||
&.padding {
|
||||
padding: 16px;
|
||||
}
|
||||
|
||||
div {
|
||||
width: 330px;
|
||||
@ -184,12 +186,6 @@ $ha__primary_color: #03a9f4;
|
||||
.title {
|
||||
margin-bottom: 4px;
|
||||
}
|
||||
|
||||
.button {
|
||||
font-size: small;
|
||||
font-weight: 600;
|
||||
text-decoration: none;
|
||||
}
|
||||
}
|
||||
|
||||
img {
|
||||
@ -208,7 +204,7 @@ $ha__primary_color: #03a9f4;
|
||||
}
|
||||
|
||||
.section-content:nth-child(even) {
|
||||
background-color: #F5F5F5;
|
||||
background-color: #f5f5f5;
|
||||
|
||||
.section-inner:nth-child(odd) {
|
||||
flex-direction: row-reverse;
|
||||
@ -231,7 +227,6 @@ $ha__primary_color: #03a9f4;
|
||||
margin: -36px auto 0;
|
||||
|
||||
&.with-box {
|
||||
|
||||
.banner-overlay-content {
|
||||
max-width: 416px;
|
||||
}
|
||||
@ -353,7 +348,7 @@ $ha__primary_color: #03a9f4;
|
||||
.below-button {
|
||||
margin-top: 8px;
|
||||
text-align: center;
|
||||
font-size: .8em;
|
||||
font-size: 0.8em;
|
||||
}
|
||||
}
|
||||
|
||||
@ -719,7 +714,7 @@ $ha__primary_color: #03a9f4;
|
||||
|
||||
.blue3d-container {
|
||||
align-items: flex-end;
|
||||
background-image: url('/images/blue/blue_3d.jpg');
|
||||
background-image: url("/images/blue/blue_3d.jpg");
|
||||
background-position: bottom;
|
||||
background-size: cover;
|
||||
display: flex;
|
||||
@ -734,7 +729,7 @@ $ha__primary_color: #03a9f4;
|
||||
align-items: center;
|
||||
justify-content: space-between;
|
||||
background-color: #000000ab;
|
||||
color: #FFFFFF;
|
||||
color: #ffffff;
|
||||
height: 60px;
|
||||
width: 100%;
|
||||
|
||||
@ -748,7 +743,7 @@ $ha__primary_color: #03a9f4;
|
||||
}
|
||||
}
|
||||
|
||||
.material-card>p:last-child {
|
||||
.material-card > p:last-child {
|
||||
margin-bottom: 0;
|
||||
}
|
||||
}
|
||||
@ -911,13 +906,39 @@ $ha__primary_color: #03a9f4;
|
||||
}
|
||||
}
|
||||
|
||||
@media only screen and (max-width: $desk-start) {
|
||||
#landingpage {
|
||||
.section-content {
|
||||
width: 100%;
|
||||
padding: 32px 8px;
|
||||
|
||||
.header {
|
||||
width: 100%;
|
||||
}
|
||||
|
||||
.section-inner {
|
||||
flex-direction: column-reverse !important;
|
||||
padding: 32px 0;
|
||||
|
||||
img {
|
||||
max-width: 100%;
|
||||
}
|
||||
|
||||
.section-inner-content {
|
||||
margin-bottom: 16px;
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
@media only screen and (max-width: $palm-end) {
|
||||
$landingpage__hero_height: 500px;
|
||||
|
||||
#landingpage {
|
||||
.site-header {
|
||||
background-color: #ffffffe8;
|
||||
transition: background 0.5s;
|
||||
transition: background-color 0.5s;
|
||||
|
||||
ul {
|
||||
margin: 0 4px;
|
||||
@ -962,30 +983,6 @@ $ha__primary_color: #03a9f4;
|
||||
.wide {
|
||||
line-height: 1em;
|
||||
}
|
||||
|
||||
}
|
||||
|
||||
.section-content {
|
||||
width: 100%;
|
||||
padding: 32px 8px;
|
||||
|
||||
.header {
|
||||
width: 100%;
|
||||
}
|
||||
|
||||
.section-inner {
|
||||
flex-direction: column-reverse !important;
|
||||
padding: 32px 0;
|
||||
|
||||
img {
|
||||
max-width: 100%;
|
||||
}
|
||||
|
||||
.section-inner-content {
|
||||
margin-bottom: 16px;
|
||||
width: 100%;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
.button-row-with-icon {
|
||||
@ -998,6 +995,14 @@ $ha__primary_color: #03a9f4;
|
||||
}
|
||||
}
|
||||
|
||||
.section-content {
|
||||
.section-inner {
|
||||
.section-inner-content {
|
||||
width: 100%;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
.content {
|
||||
margin: 0 8px;
|
||||
|
||||
|
||||
@ -109,9 +109,9 @@ a.integration-alert {
|
||||
|
||||
.material-card {
|
||||
background-color: #fefefe;
|
||||
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);
|
||||
border-radius: 8px;
|
||||
border: 1px solid rgba(0, 0, 0, .12);
|
||||
box-shadow: rgba(0,0,0,0.06) 0 0 10px;
|
||||
|
||||
h1 {
|
||||
font-family: Roboto, Noto, sans-serif;
|
||||
@ -155,10 +155,6 @@ a.integration-alert {
|
||||
}
|
||||
|
||||
.feedback {
|
||||
box-shadow: none;
|
||||
border: 1px solid rgba(0, 0, 0, .12);
|
||||
border-radius: 4px;
|
||||
|
||||
h4 {
|
||||
margin: 0 0 8px !important;
|
||||
|
||||
@ -175,9 +171,6 @@ a.integration-alert {
|
||||
}
|
||||
|
||||
.installation-survey {
|
||||
box-shadow: none;
|
||||
border: 1px solid rgba(0, 0, 0, .12);
|
||||
border-radius: 4px;
|
||||
padding-bottom: 64px;
|
||||
|
||||
h4 {
|
||||
@ -189,16 +182,13 @@ a.integration-alert {
|
||||
}
|
||||
}
|
||||
|
||||
.links a {
|
||||
font-weight: 400;
|
||||
text-transform: none;
|
||||
p {
|
||||
margin-bottom: 8px;
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
.survey-button {
|
||||
padding-top: 8px;
|
||||
button {
|
||||
.button {
|
||||
position: relative;
|
||||
cursor: pointer;
|
||||
font-size: 14px;
|
||||
@ -207,10 +197,11 @@ a.integration-alert {
|
||||
color: #fff;
|
||||
background-color: #03a9f4;
|
||||
border: none;
|
||||
text-decoration: none !important;
|
||||
border-radius: 4px;
|
||||
box-shadow: 0 2px 2px 0 rgba(0,0,0,.14), 0 3px 1px -2px rgba(0,0,0,.12), 0 1px 5px 0 rgba(0,0,0,.2);
|
||||
}
|
||||
button::before {
|
||||
|
||||
&::before {
|
||||
content: " ";
|
||||
position: absolute;
|
||||
top: 0;
|
||||
@ -220,29 +211,29 @@ a.integration-alert {
|
||||
opacity: 0.2;
|
||||
border-radius: 4px;
|
||||
}
|
||||
button:hover {
|
||||
&:hover {
|
||||
box-shadow: 0 4px 8px 0 rgba(0,0,0,.14), 0 1px 7px 0 rgba(0,0,0,.12), 0 3px 1px -1px rgba(0,0,0,.2);
|
||||
}
|
||||
button:hover::before {
|
||||
&:hover::before {
|
||||
background-color: rgba(255,255,255,.8);
|
||||
}
|
||||
button:focus {
|
||||
&:focus {
|
||||
outline: none;
|
||||
}
|
||||
button:focus::before {
|
||||
&:focus::before {
|
||||
background-color: white;
|
||||
}
|
||||
button:active::before {
|
||||
&:active::before {
|
||||
background-color: grey;
|
||||
}
|
||||
:host([active]) button {
|
||||
:host([active]) & {
|
||||
color: rgba(0, 0, 0, 0.38);
|
||||
background-color: rgba(0, 0, 0, 0.12);
|
||||
box-shadow: none;
|
||||
cursor: unset;
|
||||
pointer-events: none;
|
||||
}
|
||||
.hidden {
|
||||
&.hidden {
|
||||
display: none;
|
||||
}
|
||||
}
|
||||
@ -332,13 +323,14 @@ a.integration-alert {
|
||||
background-size: cover;
|
||||
background-position: center;
|
||||
text-decoration: none;
|
||||
border: none;
|
||||
|
||||
.caption {
|
||||
padding: 16px 12px 12px;
|
||||
background-color: rgba(0, 0, 0, 0.54);
|
||||
color: white;
|
||||
border-bottom-left-radius: 2px;
|
||||
border-bottom-right-radius: 2px;
|
||||
border-bottom-left-radius: 8px;
|
||||
border-bottom-right-radius: 8px;
|
||||
display: flex;
|
||||
justify-content: space-between;
|
||||
align-items: center;
|
||||
|
||||
@ -13,11 +13,8 @@ code.highlighter-rouge {
|
||||
}
|
||||
|
||||
pre.highlight {
|
||||
background-color: #FFF;
|
||||
border: 1px solid #CCC;
|
||||
font-family: "Courier New","DejaVu Sans Mono","Bitstream Vera Sans Mono",monospace;
|
||||
color: #000;
|
||||
padding: 1em 0px 1em 1em;
|
||||
font-size: 15px;
|
||||
}
|
||||
.highlight .hll { background-color: #ffffcc }
|
||||
|
||||
@ -1,24 +1,24 @@
|
||||
---
|
||||
type: card
|
||||
title: "Alarm Panel Card"
|
||||
sidebar_label: Alarm Panel
|
||||
description: "The Alarm Panel card allows you to arm and disarm your alarm control panel integrations."
|
||||
title: "Alarm panel card"
|
||||
sidebar_label: Alarm panel
|
||||
description: "The alarm panel card allows you to arm and disarm your alarm control panel integrations."
|
||||
---
|
||||
|
||||
The Alarm Panel card allows you to arm and disarm your [alarm control panel](/integrations/#alarm) integrations.
|
||||
The alarm panel card allows you to arm and disarm your [alarm control panel](/integrations/#alarm) integrations.
|
||||
|
||||
<p class='img'>
|
||||
<img src='/images/dashboards/alarm_panel_card.gif' alt='Screenshot of the alarm panel card'>
|
||||
Screenshot of the Alarm Panel card.
|
||||
Screenshot of the alarm panel card.
|
||||
</p>
|
||||
|
||||
To add the Alarm Panel card to your user interface, click the menu (three dots at the top right of the screen) and then **Edit Dashboard**. Click the **Add Card** button in the bottom right corner and select from the card picker.
|
||||
{% include dashboard/edit_dashboard.md %}
|
||||
|
||||
All options for this card can be configured via the user interface.
|
||||
|
||||
## YAML Configuration
|
||||
## YAML configuration
|
||||
|
||||
The following YAML options are available when you use YAML mode or just prefer to use YAML in the Code Editor in the UI.
|
||||
The following YAML options are available when you use YAML mode or just prefer to use YAML in the code editor in the UI.
|
||||
|
||||
{% configuration %}
|
||||
type:
|
||||
@ -66,7 +66,7 @@ entity: alarm_control_panel.alarm
|
||||
|
||||
<p class='img'>
|
||||
<img src='/images/dashboards/alarm_panel_title_card.gif' alt='Screenshot of the alarm panel card'>
|
||||
Screenshot of the Alarm Panel card.
|
||||
Screenshot of the alarm panel card.
|
||||
</p>
|
||||
|
||||
Define the state list:
|
||||
|
||||
@ -1,18 +1,18 @@
|
||||
---
|
||||
type: card
|
||||
title: "Area Card"
|
||||
title: "Area card"
|
||||
sidebar_label: Area
|
||||
description: "The Area card gives control of your entities in a specified area."
|
||||
description: "The area card gives control of your entities in a specified area."
|
||||
---
|
||||
|
||||
The Area card lets you control and monitor an individual area.
|
||||
The area card lets you control and monitor an individual area.
|
||||
|
||||
<p class='img'>
|
||||
<img src='/images/dashboards/area-card.png' alt='Screenshot of the Area card'>
|
||||
Screenshot of the Area card.
|
||||
<img src='/images/dashboards/area-card.png' alt='Screenshot of the area card'>
|
||||
Screenshot of the area card.
|
||||
</p>
|
||||
|
||||
To add the Area card to your user interface, click the menu (three dots at the top right of the screen) and then **Edit Dashboard**. Click the **Add Card** button in the bottom right corner and select from the card picker.
|
||||
{% include dashboard/edit_dashboard.md %}
|
||||
|
||||
All options for this card can be configured via the user interface.
|
||||
|
||||
@ -20,9 +20,9 @@ Buttons will appear on the card for the entities in the area including fan, ligh
|
||||
|
||||
If a camera is added to the area you can show the camera feed instead of the area picture.
|
||||
|
||||
## YAML Configuration
|
||||
## YAML configuration
|
||||
|
||||
The following YAML options are available when you use YAML mode or just prefer to use YAML in the Code Editor in the UI.
|
||||
The following YAML options are available when you use YAML mode or just prefer to use YAML in the code editor in the UI.
|
||||
|
||||
{% configuration %}
|
||||
type:
|
||||
|
||||
@ -1,22 +1,22 @@
|
||||
---
|
||||
type: card
|
||||
title: "Button Card"
|
||||
title: "Button card"
|
||||
sidebar_label: Button
|
||||
description: "The Button card allows you to add buttons to perform tasks."
|
||||
---
|
||||
|
||||
The Button card allows you to add buttons to perform tasks.
|
||||
The button card allows you to add buttons to perform tasks.
|
||||
|
||||
<p class='img'>
|
||||
<img src='/images/dashboards/entity_button_card.png' alt='Screenshot of three Button Cards'>
|
||||
Screenshot of three Button Cards.
|
||||
<img src='/images/dashboards/entity_button_card.png' alt='Screenshot of three button cards'>
|
||||
Screenshot of three button cards.
|
||||
</p>
|
||||
|
||||
To add the Button card to your user interface, click the menu (three dots at the top right of the screen) and then **Edit Dashboard**. Click the **Add Card** button in the bottom right corner and select from the card picker.
|
||||
{% include dashboard/edit_dashboard.md %}
|
||||
|
||||
All options for this card can be configured via the user interface.
|
||||
|
||||
## Card Settings
|
||||
## Card settings
|
||||
|
||||
{% configuration_basic %}
|
||||
Entity:
|
||||
@ -39,9 +39,9 @@ Hold Action:
|
||||
description: The action taken on card tap and hold. For more information, see the [action documentation](/dashboards/actions/#hold-action).
|
||||
{% endconfiguration_basic %}
|
||||
|
||||
## YAML Configuration
|
||||
## YAML configuration
|
||||
|
||||
The following YAML options are available when you use YAML mode or just prefer to use YAML in the Code Editor in the UI.
|
||||
The following YAML options are available when you use YAML mode or just prefer to use YAML in the code editor in the UI.
|
||||
|
||||
{% configuration %}
|
||||
type:
|
||||
@ -119,7 +119,7 @@ type: button
|
||||
entity: light.living_room
|
||||
```
|
||||
|
||||
Button Card with a button name and a script that runs when card is tapped:
|
||||
Button card with a button name and a script that runs when card is tapped:
|
||||
|
||||
```yaml
|
||||
type: button
|
||||
@ -133,6 +133,6 @@ tap_action:
|
||||
```
|
||||
|
||||
<p class='img'>
|
||||
<img src='/images/dashboards/entity_button_complex_card.png' alt='Screenshot of the Button card with Script Service'>
|
||||
Screenshot of the Button card with Script Service.
|
||||
<img src='/images/dashboards/entity_button_complex_card.png' alt='Screenshot of the Button card with script service'>
|
||||
Screenshot of the button card with script service.
|
||||
</p>
|
||||
|
||||
@ -1,23 +1,23 @@
|
||||
---
|
||||
type: card
|
||||
title: "Calendar Card"
|
||||
title: "Calendar card"
|
||||
sidebar_label: Calendar
|
||||
description: "The calendar card displays your calendar entities in a month, day and list view"
|
||||
---
|
||||
|
||||
The Calendar card displays your [calendar](/integrations/#calendar) entities in a month, day and list view (7 days).
|
||||
The calendar card displays your [calendar](/integrations/#calendar) entities in a month, day and list view (7 days).
|
||||
|
||||
<p class='img'>
|
||||
<img src='/images/dashboards/calendar_card.png' alt='Screenshot of the
|
||||
calendar card'>
|
||||
Screenshot of the Calendar card.
|
||||
Screenshot of the calendar card.
|
||||
</p>
|
||||
|
||||
To add the Calendar card to your user interface, click the menu (three dots at the top right of the screen) and then **Edit Dashboard**. Click the **Add Card** button in the bottom right corner and select from the card picker.
|
||||
{% include dashboard/edit_dashboard.md %}
|
||||
|
||||
All options for this card can be configured via the user interface.
|
||||
|
||||
## Card Settings
|
||||
## Card settings
|
||||
|
||||
{% configuration_basic %}
|
||||
Title:
|
||||
@ -30,9 +30,9 @@ Theme:
|
||||
description: Name of any loaded theme to be used for this card. For more information about themes, see the [frontend documentation](/integrations/frontend/).
|
||||
{% endconfiguration_basic %}
|
||||
|
||||
## YAML Configuration
|
||||
## YAML configuration
|
||||
|
||||
The following YAML options are available when you use YAML mode or just prefer to use YAML in the Code Editor in the UI.
|
||||
The following YAML options are available when you use YAML mode or just prefer to use YAML in the code editor in the UI.
|
||||
|
||||
{% configuration %}
|
||||
type:
|
||||
|
||||
@ -5,17 +5,18 @@ sidebar_label: Conditional
|
||||
description: The Conditional card displays another card based on conditions.
|
||||
---
|
||||
|
||||
The Conditional card displays another card based on conditions.
|
||||
The conditional card displays another card based on conditions.
|
||||
|
||||
Note: if there are multiple conditions there will be treated as an 'and' condition. This means that for the card to show, _all_ conditions must be met.
|
||||
|
||||
To add the Conditional card to your user interface, click the menu (three dots at the top right of the screen) and then **Edit Dashboard**. Click the **Add Card** button in the bottom right corner and select from the card picker. Note that while editing the dashboard, the card will always be shown, so be sure to exit editing mode to test the conditions.
|
||||
{% include dashboard/edit_dashboard.md %}
|
||||
Note that while editing the dashboard, the card will always be shown, so be sure to exit editing mode to test the conditions.
|
||||
|
||||
Most options for this card can be configured via the user interface.
|
||||
|
||||
## YAML Configuration
|
||||
## YAML configuration
|
||||
|
||||
The following YAML options are available when you use YAML mode or just prefer to use YAML in the Code Editor in the UI.
|
||||
The following YAML options are available when you use YAML mode or just prefer to use YAML in the code editor in the UI.
|
||||
|
||||
{% configuration %}
|
||||
type:
|
||||
@ -95,7 +96,7 @@ state_not:
|
||||
|
||||
*one is required (`state` or `state_not`)
|
||||
|
||||
### Numeric State
|
||||
### Numeric state
|
||||
|
||||
Tests if an entity state matches the thresholds.
|
||||
|
||||
|
||||
@ -2,16 +2,16 @@
|
||||
type: card
|
||||
title: "Entities Card"
|
||||
sidebar_label: Entities
|
||||
description: "The Entities card is the most common type of card. It groups items together into lists."
|
||||
description: "The entities card is the most common type of card. It groups items together into lists."
|
||||
---
|
||||
|
||||
The Entities card is the most common type of card. It groups items together into lists. It can be used to display an entity's state or attribute, but also contain buttons, web links, etc.
|
||||
The entities card is the most common type of card. It groups items together into lists. It can be used to display an entity's state or attribute, but also contain buttons, web links, etc.
|
||||
|
||||
To add the Entities card to your user interface, click the menu (three dots at the top right of the screen) and then **Edit Dashboard**. Click the **Add Card** button in the bottom right corner and select from the card picker.
|
||||
{% include dashboard/edit_dashboard.md %}
|
||||
|
||||
## YAML Configuration
|
||||
## YAML configuration
|
||||
|
||||
The following YAML options are available when you use YAML mode or just prefer to use YAML in the Code Editor in the UI.
|
||||
The following YAML options are available when you use YAML mode or just prefer to use YAML in the code editor in the UI.
|
||||
|
||||
{% configuration %}
|
||||
type:
|
||||
@ -54,7 +54,7 @@ footer:
|
||||
type: map
|
||||
{% endconfiguration %}
|
||||
|
||||
## Options For Entities
|
||||
## Options for entities
|
||||
|
||||
If you define entities as objects instead of strings (by adding `entity:` before entity ID), you can add more customization and configuration.
|
||||
|
||||
@ -110,9 +110,9 @@ double_tap_action:
|
||||
type: map
|
||||
{% endconfiguration %}
|
||||
|
||||
## Special Row Elements
|
||||
## Special row elements
|
||||
|
||||
Rather than only displaying an entity's state as a text output, the Entities card supports multiple special rows for buttons, attributes, web links, dividers and sections, etc.
|
||||
Rather than only displaying an entity's state as a text output, the entities card supports multiple special rows for buttons, attributes, web links, dividers and sections, etc.
|
||||
|
||||
### Attribute
|
||||
|
||||
|
||||
@ -1,22 +1,22 @@
|
||||
---
|
||||
type: card
|
||||
title: "Entity Filter Card"
|
||||
sidebar_label: Entity Filter
|
||||
description: "The Entity Filter card allows you to define a list of entities that you want to track only when in a certain state. Very useful for showing lights that you forgot to turn off or show a list of people only when they're at home. "
|
||||
title: "Entity filter card"
|
||||
sidebar_label: Entity filter
|
||||
description: "The entity filter card allows you to define a list of entities that you want to track only when in a certain state. Very useful for showing lights that you forgot to turn off or show a list of people only when they're at home. "
|
||||
---
|
||||
|
||||
The Entity Filter card allows you to define a list of entities that you want to track only when in a certain state. Very useful for showing lights that you forgot to turn off or show a list of people only when they're at home.
|
||||
The entity filter card allows you to define a list of entities that you want to track only when in a certain state. Very useful for showing lights that you forgot to turn off or show a list of people only when they're at home.
|
||||
|
||||
<p class='img'>
|
||||
<img src='/images/dashboards/entity_filter.png' alt='Screenshot of the Entity Filter card'>
|
||||
Screenshot of the Entity Filter card.
|
||||
<img src='/images/dashboards/entity_filter.png' alt='Screenshot of the entity filter card'>
|
||||
Screenshot of the entity filter card.
|
||||
</p>
|
||||
|
||||
This type of card can also be used together with other cards that allow multiple entities, allowing you to use [glance](/dashboards/glance/) or [picture-glance](/dashboards/picture-glance/). By default, it uses the [entities](/dashboards/entities/) card model.
|
||||
|
||||
To add the Entity Filter card to your user interface, click the menu (three dots at the top right of the screen) and then **Edit Dashboard**. Click the **Add Card** button in the bottom right corner and select from the card picker.
|
||||
{% include dashboard/edit_dashboard.md %}
|
||||
|
||||
## YAML Configuration
|
||||
## YAML configuration
|
||||
|
||||
This card can only be configured in YAML.
|
||||
|
||||
@ -45,7 +45,7 @@ show_empty:
|
||||
default: true
|
||||
{% endconfiguration %}
|
||||
|
||||
### Options For Entities
|
||||
### Options for entities
|
||||
|
||||
If you define entities as objects instead of strings (by adding `entity:` before entity ID), you can add more customization and configurations:
|
||||
|
||||
@ -80,7 +80,7 @@ state_filter:
|
||||
type: list
|
||||
{% endconfiguration %}
|
||||
|
||||
### Options For state_filter
|
||||
### Options for state filter
|
||||
|
||||
If you define `state_filter` as objects instead of strings (by adding `value:` before your state value), you can add more customization to your filter:
|
||||
|
||||
|
||||
@ -1,24 +1,24 @@
|
||||
---
|
||||
type: card
|
||||
title: "Entity Card"
|
||||
title: "Entity card"
|
||||
sidebar_label: Entity
|
||||
description: "The Entity card gives you a quick overview of your entity's state"
|
||||
description: "The entity card gives you a quick overview of your entity's state"
|
||||
---
|
||||
|
||||
The Entity card gives you a quick overview of your entity's state.
|
||||
The entity card gives you a quick overview of your entity's state.
|
||||
|
||||
<p class='img'>
|
||||
<img src='/images/dashboards/entity_card.png' alt='Screenshot of the entity card'>
|
||||
Screenshot of the Entity card.
|
||||
</p>
|
||||
|
||||
To add the Entity card to your user interface, click the menu (three dots at the top right of the screen) and then **Edit Dashboard**. Click the **Add Card** button in the bottom right corner and select from the card picker.
|
||||
{% include dashboard/edit_dashboard.md %}
|
||||
|
||||
All options for this card can be configured via the user interface.
|
||||
|
||||
## YAML Configuration
|
||||
## YAML configuration
|
||||
|
||||
The following YAML options are available when you use YAML mode or just prefer to use YAML in the Code Editor in the UI.
|
||||
The following YAML options are available when you use YAML mode or just prefer to use YAML in the code editor in the UI.
|
||||
|
||||
{% configuration %}
|
||||
type:
|
||||
|
||||
@ -2,28 +2,28 @@
|
||||
type: card
|
||||
title: "Gauge Card"
|
||||
sidebar_label: Gauge
|
||||
description: "The Gauge card is a basic card that allows visually seeing sensor data."
|
||||
description: "The gauge card is a basic card that allows visually seeing sensor data."
|
||||
---
|
||||
|
||||
The Gauge card is a basic card that allows visually seeing sensor data.
|
||||
The gauge card is a basic card that allows visually seeing sensor data.
|
||||
|
||||
<p class='img'>
|
||||
<img src='/images/dashboards/gauge_card.gif' alt='Screenshot of the Gauge card'>
|
||||
Screenshot of the Gauge card.
|
||||
Screenshot of the gauge card.
|
||||
</p>
|
||||
|
||||
<p class='img'>
|
||||
<img src='/images/dashboards/gauge_needle_card.png' alt='Screenshot of the Gauge card in needle mode'>
|
||||
Screenshot of the Gauge card in needle mode.
|
||||
Screenshot of the gauge card in needle mode.
|
||||
</p>
|
||||
|
||||
To add the Gauge card to your user interface, click the menu (three dots at the top right of the screen) and then **Edit Dashboard**. Click the **Add Card** button in the bottom right corner and select from the card picker.
|
||||
{% include dashboard/edit_dashboard.md %}
|
||||
|
||||
All options for this card can be configured via the user interface.
|
||||
|
||||
## YAML Configuration
|
||||
## YAML configuration
|
||||
|
||||
The following YAML options are available when you use YAML mode or just prefer to use YAML in the Code Editor in the UI.
|
||||
The following YAML options are available when you use YAML mode or just prefer to use YAML in the code editor in the UI.
|
||||
|
||||
{% configuration %}
|
||||
type:
|
||||
|
||||
@ -1,24 +1,24 @@
|
||||
---
|
||||
type: card
|
||||
title: "Glance Card"
|
||||
title: "Glance card"
|
||||
sidebar_label: Glance
|
||||
description: "The Glance card is useful to group multiple sensors in a compact overview."
|
||||
description: "The glance card is useful to group multiple sensors in a compact overview."
|
||||
---
|
||||
|
||||
The Glance card is useful to group multiple sensors in a compact overview. Keep in mind that this can be used together with [entity-filter](/dashboards/entity-filter/) cards to create dynamic cards.
|
||||
The glance card is useful to group multiple sensors in a compact overview. Keep in mind that this can be used together with [entity-filter](/dashboards/entity-filter/) cards to create dynamic cards.
|
||||
|
||||
<p class='img'>
|
||||
<img src='/images/dashboards/glance_card.png' alt='Screenshot of the glance card'>
|
||||
Screenshot of the Glance card.
|
||||
Screenshot of the glance card.
|
||||
</p>
|
||||
|
||||
To add the Glance card to your user interface, click the menu (three dots at the top right of the screen) and then **Edit Dashboard**. Click the **Add Card** button in the bottom right corner and select from the card picker.
|
||||
{% include dashboard/edit_dashboard.md %}
|
||||
|
||||
All options for this card can be configured via the user interface.
|
||||
|
||||
## YAML Configuration
|
||||
## YAML configuration
|
||||
|
||||
The following YAML options are available when you use YAML mode or just prefer to use YAML in the Code Editor in the UI.
|
||||
The following YAML options are available when you use YAML mode or just prefer to use YAML in the code editor in the UI.
|
||||
|
||||
{% configuration %}
|
||||
type:
|
||||
@ -63,7 +63,7 @@ state_color:
|
||||
default: true
|
||||
{% endconfiguration %}
|
||||
|
||||
### Options For Entities
|
||||
### Options for entities
|
||||
|
||||
If you define entities as objects instead of strings, you can add more customization and configuration:
|
||||
|
||||
@ -108,7 +108,7 @@ double_tap_action:
|
||||
type: map
|
||||
{% endconfiguration %}
|
||||
|
||||
### Options For Exemptions
|
||||
### Options for exemptions
|
||||
|
||||
{% configuration badges %}
|
||||
user:
|
||||
|
||||
@ -1,24 +1,24 @@
|
||||
---
|
||||
type: card
|
||||
title: "Grid Card"
|
||||
title: "Grid card"
|
||||
sidebar_label: Grid
|
||||
description: "The Grid card allows you to show multiple cards in a grid."
|
||||
description: "The grid card allows you to show multiple cards in a grid."
|
||||
---
|
||||
|
||||
The Grid card allows you to show multiple cards in a grid. It will first fill the columns, automatically adding new rows as needed.
|
||||
The grid card allows you to show multiple cards in a grid. It will first fill the columns, automatically adding new rows as needed.
|
||||
|
||||
<p class='img'>
|
||||
<img src='/images/dashboards/grid.png' alt='Screenshot of the grid card'>
|
||||
Screenshot of the Grid card.
|
||||
Screenshot of the grid card.
|
||||
</p>
|
||||
|
||||
To add the Grid card to your user interface, click the menu (three dots at the top right of the screen) and then **Edit Dashboard**. Click the **Add Card** button in the bottom right corner and select from the card picker.
|
||||
{% include dashboard/edit_dashboard.md %}
|
||||
|
||||
All options for this card can be configured via the user interface.
|
||||
|
||||
## YAML Configuration
|
||||
## YAML configuration
|
||||
|
||||
The following YAML options are available when you use YAML mode or just prefer to use YAML in the Code Editor in the UI.
|
||||
The following YAML options are available when you use YAML mode or just prefer to use YAML in the code editor in the UI.
|
||||
|
||||
{% configuration %}
|
||||
type:
|
||||
|
||||
@ -1,29 +1,29 @@
|
||||
---
|
||||
type: card
|
||||
title: "History Graph Card"
|
||||
sidebar_label: History Graph
|
||||
description: "The History Graph card allows you to display a graph for each of the entities listed."
|
||||
title: "History graph card"
|
||||
sidebar_label: History graph
|
||||
description: "The history graph card allows you to display a graph for each of the entities listed."
|
||||
---
|
||||
|
||||
The History Graph card allows you to display a graph for each of up to eight entities.
|
||||
The history graph card allows you to display a graph for each of up to eight entities.
|
||||
|
||||
<p class='img'>
|
||||
<img src='/images/dashboards/history_graph.png' alt='Screenshot of the history graph card for entities without a unit_of_measurement'>
|
||||
Screenshot of the History Graph card, when the sensor has no `unit_of_measurement` defined.
|
||||
Screenshot of the history graph card, when the sensor has no `unit_of_measurement` defined.
|
||||
</p>
|
||||
|
||||
<p class='img'>
|
||||
<img src='/images/dashboards/history_graph_lines.png' alt='Screenshot of the history graph card for entities with a unit_of_measurement'>
|
||||
Screenshot of the History Graph card, when the sensor has a `unit_of_measurement` defined.
|
||||
Screenshot of the history graph card, when the sensor has a `unit_of_measurement` defined.
|
||||
</p>
|
||||
|
||||
To add the History Graph card to your user interface, click the menu (three dots at the top right of the screen) and then **Edit Dashboard**. Click the **Add Card** button in the bottom right corner and select from the card picker.
|
||||
{% include dashboard/edit_dashboard.md %}
|
||||
|
||||
All options for this card can be configured via the user interface.
|
||||
|
||||
## YAML Configuration
|
||||
## YAML configuration
|
||||
|
||||
The following YAML options are available when you use YAML mode or just prefer to use YAML in the Code Editor in the UI.
|
||||
The following YAML options are available when you use YAML mode or just prefer to use YAML in the code editor in the UI.
|
||||
|
||||
{% configuration %}
|
||||
type:
|
||||
@ -55,7 +55,7 @@ logarithmic_scale:
|
||||
default: false
|
||||
{% endconfiguration %}
|
||||
|
||||
### Options For Entities
|
||||
### Options for entities
|
||||
|
||||
If you define entities as objects instead of strings, you can add more customization and configuration:
|
||||
|
||||
|
||||
@ -1,17 +1,17 @@
|
||||
---
|
||||
type: card
|
||||
title: "Horizontal Stack Card"
|
||||
sidebar_label: Horizontal Stack
|
||||
description: "The Horizontal Stack card allows you to stack together multiple cards, so they always sit next to each other in the space of one column."
|
||||
title: "Horizontal stack card"
|
||||
sidebar_label: Horizontal stack
|
||||
description: "The horizontal stack card allows you to stack together multiple cards, so they always sit next to each other in the space of one column."
|
||||
---
|
||||
|
||||
The Horizontal Stack card allows you to stack together multiple cards, so they always sit next to each other in the space of one column.
|
||||
The horizontal stack card allows you to stack together multiple cards, so they always sit next to each other in the space of one column.
|
||||
|
||||
To add the Horizontal Stack card to your user interface, click the menu (three dots at the top right of the screen) and then **Edit Dashboard**. Click the **Add Card** button in the bottom right corner and select from the card picker.
|
||||
{% include dashboard/edit_dashboard.md %}
|
||||
|
||||
## YAML Configuration
|
||||
## YAML configuration
|
||||
|
||||
The following YAML options are available when you use YAML mode or just prefer to use YAML in the Code Editor in the UI.
|
||||
The following YAML options are available when you use YAML mode or just prefer to use YAML in the code editor in the UI.
|
||||
|
||||
{% configuration %}
|
||||
type:
|
||||
@ -44,5 +44,5 @@ cards:
|
||||
|
||||
<p class='img'>
|
||||
<img src='/images/dashboards/horizontal_stack.png' alt='Two picture cards in a horizontal stack card'>
|
||||
Two Picture cards in a Horizontal Stack card.
|
||||
Two picture cards in a horizontal stack card.
|
||||
</p>
|
||||
|
||||
@ -1,24 +1,24 @@
|
||||
---
|
||||
type: card
|
||||
title: "Humidifier Card"
|
||||
title: "Humidifier card"
|
||||
sidebar_label: Humidifier
|
||||
description: "The Humidifier card gives control of your humidifier entity, allowing you to change the target humidity and mode of the entity."
|
||||
description: "The humidifier card gives control of your humidifier entity, allowing you to change the target humidity and mode of the entity."
|
||||
---
|
||||
|
||||
The Humidifier card lets you control and monitor humidifiers, dehumidifiers, and hygrostat devices.
|
||||
The humidifier card lets you control and monitor humidifiers, dehumidifiers, and hygrostat devices.
|
||||
|
||||
<p class='img'>
|
||||
<img src='/images/dashboards/humidifier_card.png' alt='Screenshot of the humidifier card'>
|
||||
Screenshot of the humidifier card.
|
||||
</p>
|
||||
|
||||
To add the Humidifier card to your user interface, click the menu (three dots at the top right of the screen) and then **Edit Dashboard**. Click the **Add Card** button in the bottom right corner and select from the card picker.
|
||||
{% include dashboard/edit_dashboard.md %}
|
||||
|
||||
All options for this card can be configured via the user interface.
|
||||
|
||||
## YAML Configuration
|
||||
## YAML configuration
|
||||
|
||||
The following YAML options are available when you use YAML mode or just prefer to use YAML in the Code Editor in the UI.
|
||||
The following YAML options are available when you use YAML mode or just prefer to use YAML in the code editor in the UI.
|
||||
|
||||
{% configuration %}
|
||||
type:
|
||||
|
||||
@ -1,18 +1,18 @@
|
||||
---
|
||||
type: card
|
||||
title: "Webpage Card"
|
||||
title: "Webpage card"
|
||||
sidebar_label: Webpage
|
||||
description: "The Webpage card allows you to embed your favorite webpage right into Home Assistant."
|
||||
description: "The webpage card allows you to embed your favorite webpage right into Home Assistant."
|
||||
---
|
||||
|
||||
The Webpage card allows you to embed your favorite webpage right into Home Assistant. You can also embed files stored in your `<config-directory>/www` folder and reference them using `/local/<file>`.
|
||||
The webpage card allows you to embed your favorite webpage right into Home Assistant. You can also embed files stored in your `<config-directory>/www` folder and reference them using `/local/<file>`.
|
||||
|
||||
<p class='img'>
|
||||
<img width="500" src='/images/dashboards/iframe.png' alt='Windy weather radar as Webpage'>
|
||||
Windy weather radar as Webpage.
|
||||
Windy weather radar as webpage.
|
||||
</p>
|
||||
|
||||
To add the Webpage card to your user interface, click the menu (three dots at the top right of the screen) and then **Edit Dashboard**. Click the **Add Card** button in the bottom right corner and select from the card picker.
|
||||
{% include dashboard/edit_dashboard.md %}
|
||||
|
||||
All options for this card can be configured via the user interface.
|
||||
|
||||
@ -20,9 +20,9 @@ All options for this card can be configured via the user interface.
|
||||
You can't embed sites using HTTP if you are using HTTPS for your Home Assistant.
|
||||
</div>
|
||||
|
||||
## YAML Configuration
|
||||
## YAML configuration
|
||||
|
||||
The following YAML options are available when you use YAML mode or just prefer to use YAML in the Code Editor in the UI.
|
||||
The following YAML options are available when you use YAML mode or just prefer to use YAML in the code editor in the UI.
|
||||
|
||||
{% configuration %}
|
||||
type:
|
||||
@ -53,6 +53,6 @@ title:
|
||||
|
||||
```yaml
|
||||
type: iframe
|
||||
url: https://grafana.localhost/d/000000027/worldping-endpoint-summary?var-probe=All&panelId=2&fullscreen&orgId=3&theme=light
|
||||
url: https://www.home-assistant.io
|
||||
aspect_ratio: 75%
|
||||
```
|
||||
|
||||
@ -1,24 +1,24 @@
|
||||
---
|
||||
type: card
|
||||
title: "Light Card"
|
||||
title: "Light card"
|
||||
sidebar_label: Light
|
||||
description: "The Light card allows you to change the brightness of the light."
|
||||
description: "The light card allows you to change the brightness of the light."
|
||||
---
|
||||
|
||||
The Light card allows you to change the brightness of the light.
|
||||
The light card allows you to change the brightness of the light.
|
||||
|
||||
<p class='img'>
|
||||
<img src='/images/dashboards/light_card.png' alt='Screenshot of the Light card'>
|
||||
Screenshot of the Light card.
|
||||
Screenshot of the light card.
|
||||
</p>
|
||||
|
||||
To add the Light card to your user interface, click the menu (three dots at the top right of the screen) and then **Edit Dashboard**. Click the **Add Card** button in the bottom right corner and select from the card picker.
|
||||
{% include dashboard/edit_dashboard.md %}
|
||||
|
||||
All options for this card can be configured via the user interface.
|
||||
|
||||
## YAML Configuration
|
||||
## YAML configuration
|
||||
|
||||
The following YAML options are available when you use YAML mode or just prefer to use YAML in the Code Editor in the UI.
|
||||
The following YAML options are available when you use YAML mode or just prefer to use YAML in the code editor in the UI.
|
||||
|
||||
{% configuration %}
|
||||
type:
|
||||
|
||||
@ -1,20 +1,20 @@
|
||||
---
|
||||
type: card
|
||||
title: "Logbook Card"
|
||||
title: "Logbook card"
|
||||
sidebar_label: Logbook
|
||||
description: "The Logbook card displays entries from the logbook for specific entities."
|
||||
description: "The logbook card displays entries from the logbook for specific entities."
|
||||
---
|
||||
|
||||
The Logbook card displays entries from the logbook for specific entities.
|
||||
The logbook card displays entries from the logbook for specific entities.
|
||||
|
||||
<p class='img'>
|
||||
<img src='/images/dashboards/logbook.png' alt='Screenshot of the logbook card'>
|
||||
Screenshot of the Logbook card.
|
||||
Screenshot of the logbook card.
|
||||
</p>
|
||||
|
||||
To add the Logbook card to your user interface, click the menu (three dots at the top right of the screen) and then **Edit Dashboard**. Click the **Add Card** button in the bottom right corner and select from the card picker.
|
||||
{% include dashboard/edit_dashboard.md %}
|
||||
|
||||
## Card Settings
|
||||
## Card settings
|
||||
|
||||
{% configuration_basic %}
|
||||
Entities:
|
||||
@ -27,9 +27,9 @@ Theme:
|
||||
description: Name of any loaded theme to be used for this card. For more information about themes, see the [frontend documentation](/integrations/frontend/).
|
||||
{% endconfiguration_basic %}
|
||||
|
||||
## YAML Configuration
|
||||
## YAML configuration
|
||||
|
||||
The following YAML options are available when you use YAML mode or just prefer to use YAML in the Code Editor in the UI.
|
||||
The following YAML options are available when you use YAML mode or just prefer to use YAML in the code editor in the UI.
|
||||
|
||||
{% configuration %}
|
||||
type:
|
||||
|
||||
@ -1,24 +1,24 @@
|
||||
---
|
||||
type: card
|
||||
title: "Map Card"
|
||||
title: "Map card"
|
||||
sidebar_label: Map
|
||||
description: "The Map card that allows you to display entities on a map"
|
||||
description: "The map card that allows you to display entities on a map"
|
||||
---
|
||||
|
||||
The Map card that allows you to display entities on a map
|
||||
The map card that allows you to display entities on a map
|
||||
|
||||
<p class='img'>
|
||||
<img src='/images/dashboards/map_card.png' alt='Screenshot of the map card'>
|
||||
Screenshot of the map card.
|
||||
</p>
|
||||
|
||||
To add the Map card to your user interface, click the menu (three dots at the top right of the screen) and then **Edit Dashboard**. Click the **Add Card** button in the bottom right corner and select from the card picker.
|
||||
{% include dashboard/edit_dashboard.md %}
|
||||
|
||||
All options for this card can be configured via the user interface.
|
||||
|
||||
## YAML Configuration
|
||||
## YAML configuration
|
||||
|
||||
The following YAML options are available when you use YAML mode or just prefer to use YAML in the Code Editor in the UI.
|
||||
The following YAML options are available when you use YAML mode or just prefer to use YAML in the code editor in the UI.
|
||||
|
||||
{% configuration %}
|
||||
type:
|
||||
@ -75,7 +75,7 @@ hours_to_show:
|
||||
|
||||
</div>
|
||||
|
||||
## Options For Entities
|
||||
## Options for entities
|
||||
|
||||
If you define entities as objects instead of strings (by adding `entity:` before entity ID), you can add more customization and configuration.
|
||||
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
---
|
||||
type: card
|
||||
title: "Markdown Card"
|
||||
title: "Markdown card"
|
||||
sidebar_label: Markdown
|
||||
description: "The Markdown card is used to render Markdown"
|
||||
---
|
||||
@ -14,11 +14,11 @@ Screenshot of the Markdown card.
|
||||
|
||||
The renderer uses [Marked.js](https://marked.js.org), which supports [several specifications of Markdown](https://marked.js.org/#specifications), including CommonMark, GitHub Flavored Markdown (GFM) and `markdown.pl`.
|
||||
|
||||
To add the Markdown card to your user interface, click the menu (three dots at the top right of the screen) and then **Edit Dashboard**. Click the **Add Card** button in the bottom right corner and select from the card picker.
|
||||
{% include dashboard/edit_dashboard.md %}
|
||||
|
||||
## YAML Configuration
|
||||
## YAML configuration
|
||||
|
||||
The following YAML options are available when you use YAML mode or just prefer to use YAML in the Code Editor in the UI.
|
||||
The following YAML options are available when you use YAML mode or just prefer to use YAML in the code editor in the UI.
|
||||
|
||||
{% configuration %}
|
||||
type:
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
---
|
||||
type: view
|
||||
title: Masonry View
|
||||
title: Masonry view
|
||||
sidebar_label: Masonry (default)
|
||||
description: "The default panel layout uses a masonry algorithme."
|
||||
---
|
||||
|
||||
@ -1,22 +1,22 @@
|
||||
---
|
||||
type: card
|
||||
title: "Media Control Card"
|
||||
sidebar_label: Media Control
|
||||
description: "The Media Control card is used to display media player entities on an interface with easy to use controls."
|
||||
title: "Media control card"
|
||||
sidebar_label: Media control
|
||||
description: "The media control card is used to display media player entities on an interface with easy to use controls."
|
||||
---
|
||||
|
||||
The Media Control card is used to display [Media Player](/integrations/#media-player) entities on an interface with easy to use controls.
|
||||
The media control card is used to display [media player](/integrations/#media-player) entities on an interface with easy to use controls.
|
||||
|
||||
<p class='img'>
|
||||
<img src='/images/dashboards/mediaplayer.png' alt='Screenshot of the media player control card'>
|
||||
Screenshot of the Media Control card.
|
||||
Screenshot of the media control card.
|
||||
</p>
|
||||
|
||||
To add the Media Control card to your user interface, click the menu (three dots at the top right of the screen) and then **Edit Dashboard**. Click the **Add Card** button in the bottom right corner and select from the card picker.
|
||||
{% include dashboard/edit_dashboard.md %}
|
||||
|
||||
## YAML Configuration
|
||||
## YAML configuration
|
||||
|
||||
The following YAML options are available when you use YAML mode or just prefer to use YAML in the Code Editor in the UI.
|
||||
The following YAML options are available when you use YAML mode or just prefer to use YAML in the code editor in the UI.
|
||||
|
||||
{% configuration %}
|
||||
type:
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
---
|
||||
type: view
|
||||
title: Panel View
|
||||
title: Panel view
|
||||
sidebar_label: Panel
|
||||
description: "The panel view shows a single card in the full width of the screen."
|
||||
---
|
||||
|
||||
@ -1,11 +1,11 @@
|
||||
---
|
||||
type: card
|
||||
title: "Picture Elements Card"
|
||||
sidebar_label: Picture Elements
|
||||
description: "The Picture Elements card is one of the most versatile types of cards. The cards allow you to position icons or text and even services! On an image based on coordinates."
|
||||
title: "Picture elements card"
|
||||
sidebar_label: Picture elements
|
||||
description: "The picture elements card is one of the most versatile types of cards. The cards allow you to position icons or text and even services! On an image based on coordinates."
|
||||
---
|
||||
|
||||
The Picture Elements card is one of the most versatile types of cards.
|
||||
The picture elements card is one of the most versatile types of cards.
|
||||
|
||||
<p class='img'>
|
||||
<img src='/images/dashboards/picture_elements.gif' alt='A functional floorplan powered by picture elements'>
|
||||
@ -14,9 +14,9 @@ The Picture Elements card is one of the most versatile types of cards.
|
||||
|
||||
The cards allow you to position icons or text and even services on an image based on coordinates. Imagine floor plan, imagine [picture-glance](/dashboards/picture-glance/) with no restrictions!
|
||||
|
||||
To add the Picture Elements card to your user interface, click the menu (three dots at the top right of the screen) and then **Edit Dashboard**. Click the **Add Card** button in the bottom right corner and select from the card picker.
|
||||
{% include dashboard/edit_dashboard.md %}
|
||||
|
||||
## YAML Configuration
|
||||
## YAML configuration
|
||||
|
||||
This card can only be configured in YAML.
|
||||
|
||||
@ -70,7 +70,7 @@ Elements are the active components (icons, badges, buttons, text, etc.) that ove
|
||||
|
||||
There are several different element types that can be added to a Picture Elements card:
|
||||
|
||||
- [State Badge](#state-badge)
|
||||
- [State badge](#state-badge)
|
||||
- [State Icon](#state-icon)
|
||||
- [State Label](#state-label)
|
||||
- [Service Call Button](#service-call-button)
|
||||
@ -79,7 +79,7 @@ There are several different element types that can be added to a Picture Element
|
||||
- [Conditional](#conditional-element)
|
||||
- [Custom](#custom-elements)
|
||||
|
||||
### State Badge
|
||||
### State badge
|
||||
|
||||
This element creates a badge representing the state of an entity.
|
||||
|
||||
@ -115,7 +115,7 @@ double_tap_action:
|
||||
type: map
|
||||
{% endconfiguration %}
|
||||
|
||||
### State Icon
|
||||
### State icon
|
||||
|
||||
This element represents an entity state using an icon.
|
||||
|
||||
@ -160,7 +160,7 @@ style:
|
||||
default: "position: absolute, transform: translate(-50%, -50%)"
|
||||
{% endconfiguration %}
|
||||
|
||||
### State Label
|
||||
### State label
|
||||
|
||||
This element represents an entity's state via text.
|
||||
|
||||
@ -208,7 +208,7 @@ style:
|
||||
default: "position: absolute, transform: translate(-50%, -50%)"
|
||||
{% endconfiguration %}
|
||||
|
||||
### Service Call Button
|
||||
### Service call button
|
||||
|
||||
This entity creates a button (with arbitrary text) that can be used to call a service.
|
||||
|
||||
@ -236,7 +236,7 @@ style:
|
||||
default: "position: absolute, transform: translate(-50%, -50%)"
|
||||
{% endconfiguration %}
|
||||
|
||||
### Icon Element
|
||||
### Icon element
|
||||
|
||||
This element creates a static icon that is not linked to the state of an entity.
|
||||
|
||||
@ -276,7 +276,7 @@ style:
|
||||
default: "position: absolute, transform: translate(-50%, -50%)"
|
||||
{% endconfiguration %}
|
||||
|
||||
### Image Element
|
||||
### Image element
|
||||
|
||||
This creates an image element that overlays the background image.
|
||||
|
||||
@ -342,7 +342,7 @@ style:
|
||||
default: "position: absolute, transform: translate(-50%, -50%)"
|
||||
{% endconfiguration %}
|
||||
|
||||
### Conditional Element
|
||||
### Conditional element
|
||||
|
||||
Much like the Conditional card, this element will let you show its sub-elements based on entity states.
|
||||
|
||||
@ -374,7 +374,7 @@ elements:
|
||||
type: list
|
||||
{% endconfiguration %}
|
||||
|
||||
### Custom Elements
|
||||
### Custom elements
|
||||
|
||||
The process for creating and referencing custom elements is the same as for custom cards.
|
||||
Please see the [developer documentation](https://developers.home-assistant.io/docs/frontend/custom-ui/custom-card)
|
||||
@ -392,7 +392,7 @@ style:
|
||||
default: "position: absolute, transform: translate(-50%, -50%)"
|
||||
{% endconfiguration %}
|
||||
|
||||
## Options For Exemptions
|
||||
## Options for exemptions
|
||||
|
||||
{% configuration badges %}
|
||||
user:
|
||||
@ -502,7 +502,7 @@ elements:
|
||||
left: 10%
|
||||
```
|
||||
|
||||
### Images Example
|
||||
### Images example
|
||||
|
||||
```yaml
|
||||
type: picture-elements
|
||||
@ -551,7 +551,7 @@ elements:
|
||||
width: 5%
|
||||
```
|
||||
|
||||
### Conditional Example
|
||||
### Conditional example
|
||||
|
||||
```yaml
|
||||
type: picture-elements
|
||||
|
||||
@ -1,22 +1,22 @@
|
||||
---
|
||||
type: card
|
||||
title: Picture Entity Card
|
||||
sidebar_label: Picture Entity
|
||||
description: The Picture Entity card displays an entity in the form of an image. Instead of images from URL, it can also show the picture of camera entities.
|
||||
title: Picture entity card
|
||||
sidebar_label: Picture entity
|
||||
description: The picture entity card displays an entity in the form of an image. Instead of images from URL, it can also show the picture of camera entities.
|
||||
---
|
||||
|
||||
The Picture Entity card displays an entity in the form of an image. Instead of images from URL, it can also show the picture of `camera` entities.
|
||||
The picture entity card displays an entity in the form of an image. Instead of images from URL, it can also show the picture of `camera` entities.
|
||||
|
||||
<p class='img'>
|
||||
<img src='/images/dashboards/picture_entity.gif' alt='Picture entity card'>
|
||||
Background changes according to the entity state.
|
||||
</p>
|
||||
|
||||
To add the Picture Entity card to your user interface, click the menu (three dots at the top right of the screen) and then **Edit Dashboard**. Click the **Add Card** button in the bottom right corner and select from the card picker.
|
||||
{% include dashboard/edit_dashboard.md %}
|
||||
|
||||
## YAML Configuration
|
||||
## YAML configuration
|
||||
|
||||
The following YAML options are available when you use YAML mode or just prefer to use YAML in the Code Editor in the UI.
|
||||
The following YAML options are available when you use YAML mode or just prefer to use YAML in the code editor in the UI.
|
||||
|
||||
{% configuration %}
|
||||
type:
|
||||
|
||||
@ -1,22 +1,22 @@
|
||||
---
|
||||
type: card
|
||||
title: "Picture Glance Card"
|
||||
sidebar_label: Picture Glance
|
||||
description: "The Picture Glance card shows an image and corresponding entity states as an icon. The entities on the right side allow toggle actions, others show the more information dialog."
|
||||
title: "Picture glance card"
|
||||
sidebar_label: Picture glance
|
||||
description: "The picture glance card shows an image and corresponding entity states as an icon. The entities on the right side allow toggle actions, others show the more information dialog."
|
||||
---
|
||||
|
||||
The Picture Glance card shows an image and corresponding entity states as an icon. The entities on the right side allow toggle actions, others show the more information dialog.
|
||||
The picture glance card shows an image and lets you place small icons of entity states on top of that card to control those entities from there. In the image below: the entities on the right allow toggle actions, the others show the more information dialog.
|
||||
|
||||
<p class='img'>
|
||||
<img src='/images/dashboards/picture_glance.gif' alt='Picture glance card for a living room'>
|
||||
Picture glance card for a living room.
|
||||
</p>
|
||||
|
||||
To add the Picture Glance card to your user interface, click the menu (three dots at the top right of the screen) and then **Edit Dashboard**. Click the **Add Card** button in the bottom right corner and select from the card picker.
|
||||
{% include dashboard/edit_dashboard.md %}
|
||||
|
||||
## YAML Configuration
|
||||
## YAML configuration
|
||||
|
||||
The following YAML options are available when you use YAML mode or just prefer to use YAML in the Code Editor in the UI.
|
||||
The following YAML options are available when you use YAML mode or just prefer to use YAML in the code editor in the UI.
|
||||
|
||||
{% configuration %}
|
||||
type:
|
||||
@ -88,7 +88,7 @@ double_tap_action:
|
||||
type: map
|
||||
{% endconfiguration %}
|
||||
|
||||
### Options For Entities
|
||||
### Options for entities
|
||||
|
||||
If you define entities as objects instead of strings, you can add more customization and configuration:
|
||||
|
||||
@ -132,7 +132,7 @@ double_tap_action:
|
||||
type: map
|
||||
{% endconfiguration %}
|
||||
|
||||
### Options For Exemptions
|
||||
### Options for exemptions
|
||||
|
||||
{% configuration badges %}
|
||||
user:
|
||||
@ -154,6 +154,74 @@ entity: switch.decorative_lights
|
||||
|
||||
### Examples
|
||||
|
||||
This section lists a few examples of how the picture glance card can be used.
|
||||
|
||||
### Creating a card to control the camera
|
||||
|
||||
If your camera supports <abbr title="pan, tilt, and zoom">PTZ</abbr> (can be moved in different directions), you can use the picture glance card to control the camera.
|
||||
|
||||
<p class='img'>
|
||||
<img src='/images/dashboards/picture_glance_camera_control.gif' alt='Picture glance card to control the camera'>
|
||||
Picture glance card to control the camera.
|
||||
</p>
|
||||
|
||||
1. Select your camera entity.
|
||||
- **Image path** and **Image entity** are not required.
|
||||
|
||||
2. If you want something to happen when you tap the card itself, define a tap action.
|
||||
- Here, we toggle a light.
|
||||
|
||||
3. Select the entities to move the camera left, right, up, or down.
|
||||
|
||||
4. Select **Show code editor**.
|
||||
5. For each of the entities, specify an icon, as indicated in the YAML example.
|
||||
6. For the buttons to react on press (instead of bringing up the dialog):
|
||||
- For each of the entities, under `tap_action`, call a `button.press` service.
|
||||
|
||||
```yaml
|
||||
camera_view: live
|
||||
type: picture-glance
|
||||
title: Desk
|
||||
entities:
|
||||
- entity: button.camera1_ptz_left
|
||||
icon: mdi:pan-left
|
||||
tap_action:
|
||||
action: call-service
|
||||
service: button.press
|
||||
data:
|
||||
entity_id: button.camera1_ptz_left
|
||||
- entity: button.camera1_ptz_right
|
||||
icon: mdi:pan-right
|
||||
tap_action:
|
||||
action: call-service
|
||||
service: button.press
|
||||
data:
|
||||
entity_id: button.camera1_ptz_right
|
||||
- entity: button.camera1_ptz_up
|
||||
icon: mdi:pan-up
|
||||
tap_action:
|
||||
action: call-service
|
||||
service: button.press
|
||||
data:
|
||||
entity_id: button.camera1_ptz_up
|
||||
- entity: button.camera1_ptz_down
|
||||
icon: mdi:pan-down
|
||||
tap_action:
|
||||
action: call-service
|
||||
service: button.press
|
||||
data:
|
||||
entity_id: button.camera1_ptz_down
|
||||
camera_image: camera.camera1_sub
|
||||
tap_action:
|
||||
action: call-service
|
||||
service: light.toggle
|
||||
target:
|
||||
entity_id: light.philips_929003052501_01_huelight
|
||||
```
|
||||
7. That's it. You can now control your camera from the picture glance card on your dashboard.
|
||||
|
||||
### More examples
|
||||
|
||||
```yaml
|
||||
type: picture-glance
|
||||
title: Living room
|
||||
|
||||
@ -2,21 +2,21 @@
|
||||
type: card
|
||||
title: "Picture Card"
|
||||
sidebar_label: Picture
|
||||
description: "The Picture card allows you to set an image to use for navigation to various paths in your interface or to call a service."
|
||||
description: "The picture card allows you to set an image to use for navigation to various paths in your interface or to call a service."
|
||||
---
|
||||
|
||||
The Picture card allows you to set an image to use for navigation to various paths in your interface or to call a service.
|
||||
The picture card allows you to set an image to use for navigation to various paths in your interface or to call a service.
|
||||
|
||||
<p class='img'>
|
||||
<img src='/images/dashboards/picture.png' alt='Screenshot of the picture card'>
|
||||
Screenshot of the picture card.
|
||||
</p>
|
||||
|
||||
To add the Picture card to your user interface, click the menu (three dots at the top right of the screen) and then **Edit Dashboard**. Click the **Add Card** button in the bottom right corner and select from the card picker.
|
||||
{% include dashboard/edit_dashboard.md %}
|
||||
|
||||
## YAML Configuration
|
||||
## YAML configuration
|
||||
|
||||
The following YAML options are available when you use YAML mode or just prefer to use YAML in the Code Editor in the UI.
|
||||
The following YAML options are available when you use YAML mode or just prefer to use YAML in the code editor in the UI.
|
||||
|
||||
{% configuration %}
|
||||
type:
|
||||
|
||||
@ -1,24 +1,24 @@
|
||||
---
|
||||
type: card
|
||||
title: "Plant Status Card"
|
||||
sidebar_label: Plant Status
|
||||
description: "The Plant Status card is for all the lovely botanists out there."
|
||||
title: "Plant status card"
|
||||
sidebar_label: Plant status
|
||||
description: "The plant status card is for all the lovely botanists out there."
|
||||
---
|
||||
|
||||
The Plant Status card is for all the lovely botanists out there.
|
||||
The plant status card is for all the lovely botanists out there.
|
||||
|
||||
<p class='img'>
|
||||
<img src='/images/dashboards/plant_card.png' alt='Screenshot of the plant status card'>
|
||||
Screenshot of the plant status card.
|
||||
</p>
|
||||
|
||||
To add the Plant Status card to your user interface, click the menu (three dots at the top right of the screen) and then **Edit Dashboard**. Click the **Add Card** button in the bottom right corner and select from the card picker.
|
||||
{% include dashboard/edit_dashboard.md %}
|
||||
|
||||
All options for this card can be configured via the user interface.
|
||||
|
||||
## YAML Configuration
|
||||
## YAML configuration
|
||||
|
||||
The following YAML options are available when you use YAML mode or just prefer to use YAML in the Code Editor in the UI.
|
||||
The following YAML options are available when you use YAML mode or just prefer to use YAML in the code editor in the UI.
|
||||
|
||||
{% configuration %}
|
||||
type:
|
||||
|
||||
@ -1,24 +1,24 @@
|
||||
---
|
||||
type: card
|
||||
title: "Sensor Card"
|
||||
title: "Sensor card"
|
||||
sidebar_label: Sensor
|
||||
description: "The Sensor card gives you a quick overview of your sensors state with an optional graph to visualize change over time."
|
||||
description: "The sensor card gives you a quick overview of your sensors state with an optional graph to visualize change over time."
|
||||
---
|
||||
|
||||
The Sensor card gives you a quick overview of your sensors state with an optional graph to visualize change over time.
|
||||
The sensor card gives you a quick overview of your sensors state with an optional graph to visualize change over time.
|
||||
|
||||
<p class='img'>
|
||||
<img src='/images/dashboards/sensor.png' alt='Screenshot of the sensor card'>
|
||||
Screenshot of the sensor card.
|
||||
</p>
|
||||
|
||||
To add the Sensor card to your user interface, click the menu (three dots at the top right of the screen) and then **Edit Dashboard**. Click the **Add Card** button in the bottom right corner and select from the card picker.
|
||||
{% include dashboard/edit_dashboard.md %}
|
||||
|
||||
All options for this card can be configured via the user interface.
|
||||
|
||||
## YAML Configuration
|
||||
## YAML configuration
|
||||
|
||||
The following YAML options are available when you use YAML mode or just prefer to use YAML in the Code Editor in the UI.
|
||||
The following YAML options are available when you use YAML mode or just prefer to use YAML in the code editor in the UI.
|
||||
|
||||
{% configuration %}
|
||||
type:
|
||||
|
||||
@ -1,26 +1,26 @@
|
||||
---
|
||||
type: card
|
||||
title: "Shopping List Card"
|
||||
sidebar_label: Shopping List
|
||||
description: "The Shopping List card allows you to add, edit, check-off, and clear items from your shopping list."
|
||||
title: "Shopping list card"
|
||||
sidebar_label: Shopping list
|
||||
description: "The shopping list card allows you to add, edit, check-off, and clear items from your shopping list."
|
||||
---
|
||||
|
||||
The Shopping List card allows you to add, edit, check-off, and clear items from your shopping list.
|
||||
The shopping list card allows you to add, edit, check-off, and clear items from your shopping list.
|
||||
|
||||
<p class='img'>
|
||||
<img src='/images/dashboards/shopping_list_card.gif' alt='Screenshot of the shopping list card'>
|
||||
Screenshot of the Shopping List card.
|
||||
Screenshot of the shopping list card.
|
||||
</p>
|
||||
|
||||
Setup of the [Shopping List integration](/integrations/shopping_list/) is required.
|
||||
Setup of the [shopping list integration](/integrations/shopping_list/) is required.
|
||||
|
||||
To add the Shopping List card to your user interface, click the menu (three dots at the top right of the screen) and then **Edit Dashboard**. Click the **Add Card** button in the bottom right corner and select from the card picker.
|
||||
{% include dashboard/edit_dashboard.md %}
|
||||
|
||||
All options for this card can be configured via the user interface.
|
||||
|
||||
## YAML Configuration
|
||||
## YAML configuration
|
||||
|
||||
The following YAML options are available when you use YAML mode or just prefer to use YAML in the Code Editor in the UI.
|
||||
The following YAML options are available when you use YAML mode or just prefer to use YAML in the code editor in the UI.
|
||||
|
||||
{% configuration %}
|
||||
type:
|
||||
@ -43,5 +43,5 @@ Title Example:
|
||||
|
||||
```yaml
|
||||
type: shopping-list
|
||||
title: Shopping List
|
||||
title: shopping list
|
||||
```
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
---
|
||||
type: view
|
||||
title: Sidebar View
|
||||
title: Sidebar view
|
||||
sidebar_label: Sidebar
|
||||
description: "The sidebar view has 2 columns, a wide one and a smaller one on the right."
|
||||
---
|
||||
|
||||
@ -1,11 +1,11 @@
|
||||
---
|
||||
type: card
|
||||
title: "Statistic Card"
|
||||
title: "Statistic card"
|
||||
sidebar_label: Statistic
|
||||
description: "The Statistic card allows you to display a statistical value for an entity."
|
||||
description: "The statistic card allows you to display a statistical value for an entity."
|
||||
---
|
||||
|
||||
The Statistic card allows you to display a statistical value for an entity.
|
||||
The statistic card allows you to display a statistical value for an entity.
|
||||
|
||||
Statistics are gathered every 5 minutes for sensors that support it. It will either keep the `min`, `max` and `mean` of a sensors value for a specific period, or the `sum` for a metered entity.
|
||||
|
||||
@ -16,7 +16,9 @@ If your sensor doesn't work with statistics, check [this](/more-info/statistics/
|
||||
Screenshot of the statistic card for a temperature sensor.
|
||||
</p>
|
||||
|
||||
To add the Statistic card to your user interface, click the menu (three dots at the top right of the screen) and then **Edit Dashboard**. Click the "Add Card" button in the bottom right corner and select **Statistic** from the card picker. All options for this card can be configured via the user interface, but if you want more options for the period, you will have to define them in `yaml`.
|
||||
{% include dashboard/edit_dashboard.md %}
|
||||
|
||||
All options for this card can be configured via the user interface, but if you want more options for the period, you will have to define them in `yaml`.
|
||||
|
||||
{% configuration %}
|
||||
type:
|
||||
@ -72,7 +74,7 @@ period:
|
||||
stat_type: change
|
||||
```
|
||||
|
||||
## Options For Period
|
||||
## Options for period
|
||||
|
||||
Periods can be configured in 3 different ways:
|
||||
|
||||
@ -140,7 +142,7 @@ period:
|
||||
stat_type: change
|
||||
```
|
||||
|
||||
### Rolling Window
|
||||
### Rolling window
|
||||
|
||||
{% configuration %}
|
||||
duration:
|
||||
|
||||
@ -1,33 +1,33 @@
|
||||
---
|
||||
type: card
|
||||
title: "Statistics Graph Card"
|
||||
sidebar_label: Statistics Graph
|
||||
description: "The Statistics Graph card allows you to display a graph with statistics data for each of the entities listed."
|
||||
title: "Statistics graph card"
|
||||
sidebar_label: Statistics graph
|
||||
description: "The statistics graph card allows you to display a graph with statistics data for each of the entities listed."
|
||||
---
|
||||
|
||||
The Statistics Graph card allows you to display a graph of statistics data for each of the entities listed.
|
||||
The statistics graph card allows you to display a graph of statistics data for each of the entities listed.
|
||||
|
||||
<p class='img'>
|
||||
<img src='/images/dashboards/statistics_graph_line.png' alt='Screenshot of the statistics graph card for power entities'>
|
||||
Screenshot of the Statistics Graph card with none metered entities and `chart_type` `line`.
|
||||
Screenshot of the statistics graph card with none metered entities and `chart_type` `line`.
|
||||
</p>
|
||||
|
||||
<p class='img'>
|
||||
<img src='/images/dashboards/statistics_graph_bar.png' alt='Screenshot of the statistics graph card for energy entities'>
|
||||
Screenshot of the Statistics Graph card with a metered entity and `chart_type` `bar`.
|
||||
Screenshot of the statistics graph card with a metered entity and `chart_type` `bar`.
|
||||
</p>
|
||||
|
||||
Statistics are gathered every 5 minutes for sensors that support it. It will either keep the `min`, `max`, and `mean` of a sensor's value for a specific hour or the `sum` for a metered entity.
|
||||
|
||||
If your sensor doesn't work with statistics, check [this](/more-info/statistics/).
|
||||
|
||||
To add the Statistics Graph card to your user interface, click the menu (three dots at the top right of the screen) and then **Edit Dashboard**. Click the **Add Card** button in the bottom right corner and select from the card picker.
|
||||
{% include dashboard/edit_dashboard.md %}
|
||||
|
||||
All options for this card can be configured via the user interface.
|
||||
|
||||
## YAML Configuration
|
||||
## YAML configuration
|
||||
|
||||
The following YAML options are available when you use YAML mode or just prefer to use YAML in the Code Editor in the UI.
|
||||
The following YAML options are available when you use YAML mode or just prefer to use YAML in the code editor in the UI.
|
||||
|
||||
{% configuration %}
|
||||
type:
|
||||
@ -71,7 +71,7 @@ logarithmic_scale:
|
||||
default: false
|
||||
{% endconfiguration %}
|
||||
|
||||
### Options For Entities
|
||||
### Options for entities
|
||||
|
||||
If you define entities as objects instead of strings, you can add more customization and configuration:
|
||||
|
||||
|
||||
@ -1,24 +1,24 @@
|
||||
---
|
||||
type: card
|
||||
title: "Thermostat Card"
|
||||
title: "Thermostat card"
|
||||
sidebar_label: Thermostat
|
||||
description: "The Thermostat card gives control of your climate entity, allowing you to change the temperature and mode of the entity."
|
||||
description: "The thermostat card gives control of your climate entity, allowing you to change the temperature and mode of the entity."
|
||||
---
|
||||
|
||||
The Thermostat card gives control of your [climate](/integrations/#climate) entity, allowing you to change the temperature and mode of the entity.
|
||||
The thermostat card gives control of your [climate](/integrations/#climate) entity, allowing you to change the temperature and mode of the entity.
|
||||
|
||||
<p class='img'>
|
||||
<img src='/images/dashboards/thermostat_card.png' alt='Screenshot of the thermostat card'>
|
||||
Screenshot of the Thermostat card.
|
||||
<img src='/images/dashboards/thermostat_card.gif' alt='Screenshot of the thermostat card'>
|
||||
Screenshot of the thermostat card.
|
||||
</p>
|
||||
|
||||
To add the Thermostat card to your user interface, click the menu (three dots at the top right of the screen) and then **Edit Dashboard**. Click the **Add Card** button in the bottom right corner and select from the card picker.
|
||||
{% include dashboard/edit_dashboard.md %}
|
||||
|
||||
All options for this card can be configured via the user interface.
|
||||
|
||||
## YAML Configuration
|
||||
## YAML configuration
|
||||
|
||||
The following YAML options are available when you use YAML mode or just prefer to use YAML in the Code Editor in the UI.
|
||||
The following YAML options are available when you use YAML mode or just prefer to use YAML in the code editor in the UI.
|
||||
|
||||
{% configuration %}
|
||||
type:
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
---
|
||||
type: card
|
||||
title: "Tile Card"
|
||||
title: "Tile card"
|
||||
sidebar_label: Tile
|
||||
description: "The tile card gives you a quick overview of your entity. The card allows you to toggle the entity, show the more-info dialog, or custom actions."
|
||||
---
|
||||
@ -9,10 +9,10 @@ The tile card gives you a quick overview of your entity. The card allows you to
|
||||
|
||||
<p class='img'>
|
||||
<img src='/images/dashboards/tile_card.png' alt='Screenshot of tile cards'>
|
||||
Screenshot of Tile cards.
|
||||
Screenshot of tile cards.
|
||||
</p>
|
||||
|
||||
To add the Tile card to your user interface, click the menu (three dots at the top right of the screen) and then **Edit Dashboard**. Click the "Add Card" button in the bottom right corner and select **Tile** from the card picker.
|
||||
{% include dashboard/edit_dashboard.md %}
|
||||
|
||||
{% configuration %}
|
||||
type:
|
||||
|
||||
@ -1,17 +1,17 @@
|
||||
---
|
||||
type: card
|
||||
title: "Vertical Stack Card"
|
||||
sidebar_label: Vertical Stack
|
||||
description: "The Vertical Stack card allows you to group multiple cards so they always sit in the same column."
|
||||
title: "Vertical stack card"
|
||||
sidebar_label: Vertical stack
|
||||
description: "The vertical stack card allows you to group multiple cards so they always sit in the same column."
|
||||
---
|
||||
|
||||
The Vertical Stack card allows you to group multiple cards so they always sit in the same column.
|
||||
The vertical stack card allows you to group multiple cards so they always sit in the same column.
|
||||
|
||||
To add the Vertical Stack card to your user interface, click the menu (three dots at the top right of the screen) and then **Edit Dashboard**. Click the **Add Card** button in the bottom right corner and select from the card picker.
|
||||
{% include dashboard/edit_dashboard.md %}
|
||||
|
||||
## YAML Configuration
|
||||
## YAML configuration
|
||||
|
||||
The following YAML options are available when you use YAML mode or just prefer to use YAML in the Code Editor in the UI.
|
||||
The following YAML options are available when you use YAML mode or just prefer to use YAML in the code editor in the UI.
|
||||
|
||||
{% configuration %}
|
||||
type:
|
||||
|
||||
@ -1,20 +1,20 @@
|
||||
---
|
||||
type: card
|
||||
title: "Weather Forecast Card"
|
||||
sidebar_label: Weather Forecast
|
||||
description: "The Weather Forecast card displays the weather. Very useful to include on interfaces that people display on the wall."
|
||||
title: "Weather forecast card"
|
||||
sidebar_label: Weather forecast
|
||||
description: "The weather forecast card displays the weather. Very useful to include on interfaces that people display on the wall."
|
||||
---
|
||||
|
||||
The Weather Forecast card displays the weather. Very useful to include on interfaces that people display on the wall.
|
||||
The weather forecast card displays the weather. This card is particularly useful on wall-mounted displays.
|
||||
|
||||
<p class='img'>
|
||||
<img src='/images/dashboards/weather.png' alt='Screenshot of the weather card'>
|
||||
Screenshot of the Weather card.
|
||||
Screenshot of the weather card.
|
||||
</p>
|
||||
|
||||
To add the Weather card to your user interface, click the menu (three dots at the top right of the screen) and then **Edit Dashboard**. Click the **Add Card** button in the bottom right corner and select from the card picker.
|
||||
{% include dashboard/edit_dashboard.md %}
|
||||
|
||||
## Card Settings
|
||||
## Card settings
|
||||
|
||||
{% configuration_basic %}
|
||||
Entity:
|
||||
@ -39,9 +39,9 @@ Theme:
|
||||
|
||||
</div>
|
||||
|
||||
## YAML Configuration
|
||||
## YAML configuration
|
||||
|
||||
The following YAML options are available when you use YAML mode or just prefer to use YAML in the Code Editor in the UI.
|
||||
The following YAML options are available when you use YAML mode or just prefer to use YAML in the code editor in the UI.
|
||||
|
||||
{% configuration %}
|
||||
type:
|
||||
@ -102,7 +102,7 @@ forecast_type: daily
|
||||
|
||||
### Advanced
|
||||
|
||||
#### Themeable Icons
|
||||
#### Themeable icons
|
||||
|
||||
The default weather icons are themable via a [theme](/integrations/frontend/#themes). Theme variables include:
|
||||
|
||||
@ -123,7 +123,7 @@ Example theme configuration:
|
||||
--weather-icon-rain-color: purple
|
||||
```
|
||||
|
||||
#### Personal Icons
|
||||
#### Personal icons
|
||||
|
||||
Weather icons can be overwritten with your own personal images via a [theme](/integrations/frontend/#themes). Theme variables include:
|
||||
|
||||
|
||||
@ -7,21 +7,16 @@
|
||||
# - link: A URL to link to for more information (optional)
|
||||
# - aliases: A list of aliases for the term (optional)
|
||||
#
|
||||
|
||||
- term: Action
|
||||
definition: |-
|
||||
Actions are used in several places in Home Assistant. As part of a script or automation, actions define what is going to happen once a trigger is activated. In scripts, an action is called *sequence*.
|
||||
|
||||
Actions use service calls and/or scenes to interact with entities and cause these entities to do something. Actions can also include conditions and a delay. An action can call multiple services at the same time. For example, if your presence is detected in a room, an action may call one service to turn on a light and call another service to start playing music after a delay.
|
||||
|
||||
Actions are also used on the dashboard, for example as tap or hold action on a UI element. When triggered, the action calls a service.
|
||||
|
||||
aliases:
|
||||
- actions
|
||||
link: /docs/automation/action/
|
||||
excerpt: >
|
||||
Actions are used in several places in Home Assistant. As part of a script or automation, actions define what is going to happen once a trigger is activated. In scripts, an action is called *sequence*.
|
||||
|
||||
- term: Add-on
|
||||
definition: >-
|
||||
Add-ons are additional standalone third-party software packages that can be
|
||||
@ -31,7 +26,6 @@
|
||||
excerpt: >
|
||||
Add-ons are additional standalone third-party software packages that can be
|
||||
installed on Home Assistant OS.
|
||||
|
||||
- term: Area
|
||||
definition: >-
|
||||
Locations within your home such as living room, dance floor, etc.
|
||||
@ -41,7 +35,6 @@
|
||||
Places within your home such as rooms, spaces, etc.
|
||||
aliases:
|
||||
- areas
|
||||
|
||||
- term: Automation
|
||||
definition: >-
|
||||
Automations connect one or more triggers to one or more actions in a
|
||||
@ -56,7 +49,6 @@
|
||||
link: /docs/automation/
|
||||
aliases:
|
||||
- automations
|
||||
|
||||
- term: Backup
|
||||
definition: >-
|
||||
Home Assistant has built-in functionality to create files containing a copy of
|
||||
@ -69,13 +61,11 @@
|
||||
your configurations. This is available on certain installation types.
|
||||
aliases:
|
||||
- backups
|
||||
|
||||
- term: Binary sensor
|
||||
definition: >-
|
||||
A binary sensor returns information about things that only have two states -
|
||||
such as on or off.
|
||||
link: /integrations/binary_sensor
|
||||
|
||||
- term: Blueprint
|
||||
definition: >-
|
||||
A blueprint is a script or automation configuration with certain parts marked as configurable. This allows users to create multiple scripts or automations based on the same blueprint, with each having its own configuration-specific settings. Blueprints are shared by the community on the [blueprints exchange](https://community.home-assistant.io/c/blueprints-exchange/53) in the forum.
|
||||
@ -84,11 +74,9 @@
|
||||
A blueprint is a script or automation configuration with certain parts marked as configurable. This allows users to create multiple scripts or automations based on the same blueprint, with each having its own configuration-specific settings.
|
||||
aliases:
|
||||
- blueprints
|
||||
|
||||
- term: Component
|
||||
definition: >-
|
||||
Better known as: Integrations. Integrations used to be known as components.
|
||||
|
||||
- term: Condition
|
||||
definition: >-
|
||||
Conditions are an optional part of an automation that will prevent an
|
||||
@ -96,44 +84,35 @@
|
||||
link: /docs/scripts/conditions/
|
||||
aliases:
|
||||
- conditions
|
||||
|
||||
- term: Cover
|
||||
definition: >-
|
||||
Covers are devices such as blinds, garage doors, etc that can be opened
|
||||
and closed and optionally set to a specific position.
|
||||
link: /integrations/cover
|
||||
|
||||
- term: Customize
|
||||
definition: >-
|
||||
Customization allows you to overwrite the default parameters of your
|
||||
devices in the configuration.
|
||||
|
||||
- term: Device
|
||||
definition: |-
|
||||
A device is a model representing a physical or logical unit that contains entities.
|
||||
|
||||
**Example for a device as a physical unit**
|
||||
A smart plug named 'Coffee machine' which provides 2 entities: a `switch` entity to turn power on or off ('Coffee machine power switch') and a `sensor` entity for power monitoring ('Coffee machine power sensor').
|
||||
|
||||
**Example for a device as a logical unit**
|
||||
An ecobee thermostat with 4 room sensors. This thermostat is seen as 5 devices in Home Assistant: 1 device for the thermostat with 4 sensors, and 1 device for each room sensor. Each device can be in a different area and may have more than one input or output within that area.
|
||||
|
||||
Devices have properties such as ID, manufacturer, name, model, hardware version, firmware version, connections, etc.
|
||||
excerpt: >
|
||||
A device is a model representing a physical or logical unit that contains entities.
|
||||
aliases:
|
||||
- devices
|
||||
|
||||
- term: Device tracker
|
||||
definition: >-
|
||||
Device trackers are used to track the presence, or location, of a device.
|
||||
link: /integrations/device_tracker
|
||||
|
||||
- term: Discovery
|
||||
definition: >
|
||||
Discovery is the automatic setup of zeroconf/mDNS and uPnP devices after
|
||||
they are discovered.
|
||||
|
||||
- term: Domain
|
||||
definition: >-
|
||||
Each integration in Home Assistant has a unique identifier:
|
||||
@ -147,60 +126,47 @@
|
||||
excerpt: >
|
||||
Each integration in Home Assistant has a unique identifier: The domain.
|
||||
It is often shown as the first part (before the dot) of entity IDs.
|
||||
|
||||
- term: Entity
|
||||
definition: |-
|
||||
An entity represents a sensor, actor, or function in Home Assistant. Entities are used to monitor physical properties or to control other entities. An entity is usually part of a device or a service. Entities have states.
|
||||
|
||||
**Example for entities as part of a device**
|
||||
A combined temperature and humidity sensor device provides two sensor entities. One for temperature (e.g. `sensor.temperature` with state `21.0` and unit `°C`) and one for humidity
|
||||
(e.g. `sensor.humidity` with state `65.4` and unit `%`).
|
||||
|
||||
**Example for entities as part of a service**
|
||||
A weather service that provides 3 entities: wind speed, air pressure, and ozon level.
|
||||
|
||||
**Example of an entity used for control**
|
||||
A fan that is turned on when the temperature exceeds 30 °C.
|
||||
|
||||
There are standardized types of entities for common integrations such as light, switch, camera, sensor, fan, or vacuum.
|
||||
|
||||
Some entities are not part of a device or service. Examples of standalone entities are automation, script, scene entities, and helper entities (e.g. input helpers).
|
||||
|
||||
Most properties of entities are related to the state. Entities have optional attributes such as friendly name, unit of measurement, and an icon or picture that can be displayed in the frontend.
|
||||
link: /docs/configuration/state_object/
|
||||
excerpt: >
|
||||
An entity represents a sensor, actor, or function in Home Assistant. Entities are used to monitor physical properties or to control other entities. An entity is usually part of a device or a service.
|
||||
aliases:
|
||||
- entities
|
||||
|
||||
- term: Event
|
||||
definition: >-
|
||||
An event is when something happens.
|
||||
link: /docs/configuration/events/
|
||||
aliases:
|
||||
- events
|
||||
|
||||
- term: Frontend
|
||||
definition: >-
|
||||
The frontend is a necessary component for the UI, it is also where you
|
||||
can define your themes.
|
||||
link: /integrations/frontend/
|
||||
|
||||
- term: Group
|
||||
definition: >-
|
||||
Groups are a way to organize your entities into a single unit.
|
||||
link: /integrations/group/
|
||||
|
||||
- term: HASS
|
||||
definition: >-
|
||||
HASS or [hass](/docs/tools/hass/) is often used as an abbreviation for
|
||||
Home Assistant. It is also the command-line tool.
|
||||
|
||||
- term: HassOS
|
||||
definition: >-
|
||||
Another name for Home Assistant Operating System
|
||||
link: /hassio/installation/
|
||||
|
||||
- term: Home Assistant Core
|
||||
definition: >-
|
||||
Home Assistant Core is a Python program. It can be run on various operating
|
||||
@ -211,7 +177,6 @@
|
||||
excerpt: >
|
||||
Home Assistant Core is the hart of Home Assistant itself. It is a Python
|
||||
program that powers every installation type, but can be installed standalone.
|
||||
|
||||
- term: Home Assistant Supervised
|
||||
definition: >-
|
||||
Home Assistant Supervised is a full UI managed home automation ecosystem that
|
||||
@ -221,13 +186,11 @@
|
||||
excerpt: >
|
||||
Home Assistant Supervised is the full Home Assistant ecosystem, without the
|
||||
Home Assistant Operating System.
|
||||
|
||||
- term: Home Assistant Supervisor
|
||||
definition: >-
|
||||
The Home Assistant Supervisor is a program that manages a Home Assistant
|
||||
installation, taking care of installing and updating Home Assistant,
|
||||
add-ons, itself and, if used, updating the Home Assistant Operating System.
|
||||
|
||||
- term: Home Assistant Operating System
|
||||
definition: >-
|
||||
Home Assistant OS, the Home Assistant Operating System, is an embedded,
|
||||
@ -238,74 +201,64 @@
|
||||
excerpt: >
|
||||
Home Assistant OS, the Home Assistant Operating System, is an embedded,
|
||||
minimalistic, operating system designed to run the Home Assistant ecosystem.
|
||||
|
||||
- term: Host
|
||||
definition: >-
|
||||
A device that can communicate with other devices on a network. During setup and configuration,
|
||||
an input requesting a **Host** typically refers to a device's network address so that
|
||||
Home Assistant can attempt to connect to it. This may be in the form of a hostname, URL,
|
||||
IP address or some other type of network identifier.
|
||||
IP address or some other type of network identifier. If you do not know the hostname or IP address of a device, you can find it in your router's webinterface. For example, if your device is connected wirelessly, somewhere there is a page listing all the devices that are connected to your network. It depends on your router, where exactly this page is. It could be under **Network** > **Wireless**.
|
||||
excerpt: >-
|
||||
A device that can communicate with other devices on a network.
|
||||
A device that participates in your network. If asked for the host, enter either the device's IP address or host name. If you don't know those, check the list of hosts in your router.
|
||||
link: https://en.wikipedia.org/wiki/Host_(network)
|
||||
aliases:
|
||||
- hosts
|
||||
|
||||
- term: Integration
|
||||
definition: >-
|
||||
Integrations connect and integrates Home Assistant with devices, services,
|
||||
and more. Such an integration contains all the logic that takes care of
|
||||
vendor- and device-specific implementations such as authentication or
|
||||
special protocols and brings those into Home Assistant in a standardized
|
||||
Integrations connect and integrate Home Assistant with devices, services,
|
||||
and more. They contain all the logic to handle
|
||||
vendor- and device-specific implementations, such as authentication or
|
||||
specific protocols. The integration brings such device-specific elements into Home Assistant in a standardized
|
||||
way. For example, the [Hue](/integrations/hue) integration integrates
|
||||
the Philips Hue bridge and its connected bulbs into Home Assistant, making
|
||||
them available as Home Assistant light entities you can control.
|
||||
excerpt: >
|
||||
Integrations connect and integrates Home Assistant with your devices,
|
||||
Integrations connect and integrate Home Assistant with your devices,
|
||||
services, and more.
|
||||
link: /integrations/
|
||||
aliases:
|
||||
- integrations
|
||||
|
||||
- term: Intent
|
||||
definition: >-
|
||||
Intent is a term used with voice assistants. The intent is what Home Assistant thinks you want it to do when it extracts a command from your voice or text utterance. Currently, the following intents are supported out of the box: HassTurnOn, HassTurnOff, HassGetState, and HassLightSet.
|
||||
|
||||
These intents allow you to turn things on or off, inquire about a state, or change the brightness or color of a light.
|
||||
excerpt: >
|
||||
Intent is a term used with voice assistants. The intent is what Home Assistant thinks you want it to do when it extracts a command from your voice or text utterance.
|
||||
link: https://developers.home-assistant.io/docs/intent_builtin
|
||||
aliases:
|
||||
- Intents
|
||||
|
||||
- term: Lovelace
|
||||
definition: >-
|
||||
Lovelace is the original code name of the UI that is now known as
|
||||
[Home Assistant dashboards](/dashboards).
|
||||
|
||||
- term: Light
|
||||
definition: >-
|
||||
A light has a brightness you can control, and optionally color temperature
|
||||
or RGB color control.
|
||||
link: /integrations/light
|
||||
|
||||
- term: Matter
|
||||
definition: >-
|
||||
Matter is an open-source standard that defines how to control smart home devices on a Wi-Fi or Thread network. The aim of the standard is to improve security and to make devices interoperable across vendors, replacing proprietary protocols for smart home ecosystems. Unlike other standards, Matter allows joining the same device to multiple controllers. For example, you can add a light to Google Home, Apple Home, and Home Assistant at the same time. A bridge device can be used to connect devices running on other smart home technologies such as Zigbee or Z-Wave.
|
||||
excerpt: >
|
||||
Matter is an open-source standard that defines how to control smart home devices on a Wi-Fi or Thread network.
|
||||
link: /integrations/matter
|
||||
|
||||
- term: Notification
|
||||
definition: >-
|
||||
You can use notifications to send messages, pictures, and more, to devices.
|
||||
link: /integrations/#notifications
|
||||
|
||||
- term: Packages
|
||||
definition: >
|
||||
Packages allow you to bundle different component configurations together.
|
||||
link: /docs/configuration/packages/
|
||||
|
||||
- term: Platform
|
||||
definition: >-
|
||||
Platforms are building blocks provided by some integrations to be used by
|
||||
@ -317,7 +270,6 @@
|
||||
Platforms are building blocks provided by some integrations to be used by
|
||||
other integrations.
|
||||
link: /docs/configuration/platform_options/
|
||||
|
||||
- term: Reload
|
||||
definition: >-
|
||||
Applies the changes made to the Home Assistant configuration files. Changes
|
||||
@ -331,13 +283,14 @@
|
||||
Applies the changes made to Home Assistant configuration files. Changes are normally
|
||||
automatically updated. However, changes made outside of the front
|
||||
end will not be reflected in Home Assistant and require a reload.
|
||||
|
||||
- term: Scene
|
||||
definition: >-
|
||||
Scenes capture the states you want certain entities to be. For example,
|
||||
a scene can specify that light A should be turned on and light B should
|
||||
be bright red.
|
||||
link: /integrations/scene/
|
||||
aliases:
|
||||
- scenes
|
||||
|
||||
- term: Script
|
||||
definition: >
|
||||
@ -346,7 +299,6 @@
|
||||
link: /docs/scripts/
|
||||
aliases:
|
||||
- scripts
|
||||
|
||||
- term: Sensor
|
||||
definition: >-
|
||||
Sensors return information about a thing, for instance the level of water
|
||||
@ -354,7 +306,6 @@
|
||||
link: /integrations/sensor/
|
||||
aliases:
|
||||
- sensors
|
||||
|
||||
- term: Selectors
|
||||
definition: >-
|
||||
Selectors are components for the user interface. Some selectors can,
|
||||
@ -365,21 +316,15 @@
|
||||
Selectors are components for the user interface. Like toggle, dropdown,
|
||||
and more.
|
||||
link: /docs/blueprint/selectors/
|
||||
|
||||
- term: Service
|
||||
definition: |-
|
||||
The term service has 2 meanings in Home Assistant:
|
||||
|
||||
**The information service**
|
||||
For example, the municipal waste management service that provides entities for organic, paper, and packaging waste. In terms of functionality, the information service is like a device. It is called *service* to avoid confusion, as it does not come with a piece of hardware.
|
||||
|
||||
**The software function that interacts with targets to make something happen**
|
||||
A service carries out one specific task, for example: turning on the light in the living room or sending a notification to a mobile phone.
|
||||
|
||||
A service has targets and data. Service targets are: areas, devices, and entities. Service data carries the information required to define the desired state change in the target. For example, the target, together with brightness 150 and RGB color `[255,0,0]`, or the message “Your coffee is ready”.
|
||||
|
||||
Services can be used in, for example, automation, scripts, dashboards, or voice commands to control your home.
|
||||
|
||||
Home Assistant provides a series of predefined services, such as `homeassistant.turn_on`, `homeassistant.toggle`, or `homeassistant.reload`.
|
||||
excerpt: >
|
||||
A service carries out one specific task, for example: turn on the light in the
|
||||
@ -388,55 +333,53 @@
|
||||
link: /docs/scripts/service-calls/
|
||||
aliases:
|
||||
- services
|
||||
|
||||
- term: State
|
||||
definition: |-
|
||||
The state holds the information of interest of an entity. For example, if a light is on or off, the current temperature, or the amount of energy used. The data type of state is `string` (a textual value). Entities store 2 timestamps related to the state: `last_updated` and `last_changed`. Each entity has exactly one state and the state only holds one value at a time. However, entities can store attributes related to that state. For example, the state of a light is _on_, and the related state attributes could be its current brightness and color values.
|
||||
|
||||
State changes can be used as the source of triggers. The current state can be used in conditions.
|
||||
|
||||
link: /docs/configuration/state_object/
|
||||
aliases:
|
||||
- states
|
||||
excerpt: >
|
||||
The state holds the information of interest of an entity, for example, if a light is on or off. Each entity has exactly one state and the state only holds one value at a time. However, entities can store attributes related to that state such as brightness, color, or a unit of measurement.
|
||||
|
||||
- term: Switch
|
||||
definition: >-
|
||||
Switches are things that have two states you can select between, such as
|
||||
turning on or off a socket.
|
||||
link: /integrations/switch/
|
||||
|
||||
- term: Template
|
||||
definition: >-
|
||||
A template is an automation definition that can include variables for the
|
||||
service or data from the trigger values. This allows automations to generate
|
||||
dynamic actions.
|
||||
link: /docs/automation/templating/
|
||||
aliases:
|
||||
- templates
|
||||
|
||||
- term: Thread
|
||||
definition: >-
|
||||
Thread is a low-power mesh networking standard that is specifically designed for smart home applications. It is a protocol that defines how devices communicate. *Mesh* topology means that the devices can communicate with each other directly, without going through a central controller first. Thread uses the same radio frequency (RF) technology as Zigbee, but provides IP connectivity similar to Wi-Fi. Unlike Zigbee, Thread does not specify how to control devices. How Thread-enabled devices are controlled is specified in a higher level protocol such as HomeKit or Matter.
|
||||
|
||||
link: /integrations/thread/
|
||||
excerpt: >
|
||||
Thread is a low-power mesh networking standard that is specifically designed for smart home applications. It is a protocol that defines how devices communicate.
|
||||
|
||||
- term: Trigger
|
||||
definition: >-
|
||||
A trigger is a set of values or conditions of a platform that are defined
|
||||
to cause an automation to run.
|
||||
link: /docs/automation/trigger/
|
||||
aliases:
|
||||
- triggers
|
||||
|
||||
- term: TTS
|
||||
definition: >-
|
||||
TTS (text-to-speech) allows Home Assistant to talk to you.
|
||||
link: /integrations/tts/
|
||||
|
||||
- term: Variables
|
||||
definition: >-
|
||||
Variables are used to store values in memory that can be processed
|
||||
for example, in a script.
|
||||
link: /docs/scripts/#variables
|
||||
|
||||
- term: Zone
|
||||
definition: >-
|
||||
Zones are areas that can be used for presence detection.
|
||||
|
||||
@ -1,5 +1,5 @@
|
||||
---
|
||||
title: "Asterisk Voicemail Server Installation"
|
||||
title: "Asterisk Voicemail server installation"
|
||||
description: "Instructions on how to integrate your existing Asterisk voicemail within Home Assistant."
|
||||
---
|
||||
|
||||
|
||||
@ -24,7 +24,7 @@ For the moment, other user accounts will have the same access as the owner accou
|
||||
If you want to manage users and you're an owner but you do not see "Users" in your main configuration menu, make sure that "Advanced Mode" is enabled for your user in your profile.
|
||||
</div>
|
||||
|
||||
### Your Account Profile
|
||||
### Your account profile
|
||||
|
||||
Once you're logged in, you can see the details of your account at the _Profile_ page by clicking on the circular at the very bottom of the sidebar.
|
||||
|
||||
@ -46,7 +46,7 @@ As an extra level of security, you can turn on [multi-factor authentication](/do
|
||||
|
||||
## Other authentication techniques
|
||||
|
||||
Home Assistant provides several ways to authenticate. See the [Auth Providers](/docs/authentication/providers/) section.
|
||||
Home Assistant provides several ways to authenticate. See the [Auth providers](/docs/authentication/providers/) section.
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
@ -105,9 +105,9 @@ Replace `12.34.56.78` with your Home Assistant's public IP address.
|
||||
|
||||
This will allow you to open Home Assistant at `http://homeassistant.home:8123/`
|
||||
|
||||
### Stuck on Loading data
|
||||
### Stuck on loading data
|
||||
|
||||
Some ad blocking software, such as Wipr, also blocks web sockets. If you're stuck on the Loading data screen, try disabling your ad blocker.
|
||||
Some ad blocking software, such as Wipr, also blocks WebSockets. If you're stuck on the Loading data screen, try disabling your ad blocker.
|
||||
|
||||
### Migrating from pre 0.77
|
||||
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
---
|
||||
title: "Authentication Providers"
|
||||
description: "Guide on configuring different auth providers."
|
||||
title: "Authentication providers"
|
||||
description: "Guide on configuring different authentication providers."
|
||||
---
|
||||
|
||||
<div class='note warning'>
|
||||
@ -54,9 +54,9 @@ homeassistant:
|
||||
|
||||
If you don't specify any `auth_providers` section in the `configuration.yaml` file then this provider will be set up automatically.
|
||||
|
||||
### Trusted Networks
|
||||
### Trusted networks
|
||||
|
||||
The Trusted Networks auth provider defines a range of IP addresses for which no authentication will be required (also known as "allowlisting"). For example, you can allowlist your local network so you won't be prompted for a password if you access Home Assistant from inside your home.
|
||||
The trusted networks auth provider defines a range of IP addresses for which no authentication will be required (also known as "allowlisting"). For example, you can allowlist your local network so you won't be prompted for a password if you access Home Assistant from inside your home.
|
||||
|
||||
When you log in from one of these networks, you will be asked which user account to use and won't need to enter a password.
|
||||
|
||||
@ -104,7 +104,7 @@ allow_bypass_login:
|
||||
type: boolean
|
||||
{% endconfiguration %}
|
||||
|
||||
#### Trusted Users Examples
|
||||
#### Trusted users examples
|
||||
|
||||
```yaml
|
||||
homeassistant:
|
||||
@ -132,7 +132,7 @@ In above example, if user try to access Home Assistant from 192.168.0.1, they wi
|
||||
|
||||
Specially, you can use `group: GROUP_ID` to assign all users in certain `user group` to be available to choose. Group and users can be mix and match.
|
||||
|
||||
#### Skip Login Page Examples
|
||||
#### Skip login page examples
|
||||
|
||||
This is a feature to allow you to bring back some of the experience before the user system was implemented. You can directly jump to the main page if you are accessing from trusted networks, the `allow_bypass_login` is on, and you have ONLY ONE available user to choose from in the login form.
|
||||
|
||||
@ -153,9 +153,9 @@ homeassistant:
|
||||
|
||||
Assuming you have only the owner created though onboarding process, no other users ever created. The above example configuration will allow you directly access Home Assistant main page if you access from your internal network (192.168.0.0/24) or from localhost (127.0.0.1). If you get a login abort error, then you can change to use Home Assistant Authentication Provider to login, if you access your Home Assistant instance from outside network.
|
||||
|
||||
### Command Line
|
||||
### Command line
|
||||
|
||||
The Command Line auth provider executes a configurable shell command to perform user authentication. Two environment variables, `username` and `password`, are passed to the command. Access is granted when the command exits successfully (with exit code 0).
|
||||
The command line auth provider executes a configurable shell command to perform user authentication. Two environment variables, `username` and `password`, are passed to the command. Access is granted when the command exits successfully (with exit code 0).
|
||||
|
||||
This provider can be used to integrate Home Assistant with arbitrary external authentication services, from plaintext databases over LDAP to RADIUS. A compatible script for LDAP authentication is [this one](https://github.com/bob1de/ldap-auth-sh), for instance. Please note, this will only work when using the Home Assistant Core installation type.
|
||||
|
||||
|
||||
@ -3,7 +3,7 @@ title: "Automating Home Assistant"
|
||||
description: "Steps to help you get automation setup in Home Assistant."
|
||||
---
|
||||
|
||||
Home Assistant contains information about all your devices and services. This information is available for the user in the dashboard and it can be used to trigger automations. And that's fun!
|
||||
Home Assistant contains information about all your {% term devices %} and {% term services %}. This information is available for the user in the dashboard and it can be used to trigger {% term automations %}. And that's fun!
|
||||
|
||||
Automations in Home Assistant allow you to automatically respond to things that happen. You can turn the lights on at sunset or pause the music when you receive a call.
|
||||
|
||||
|
||||
@ -1,11 +1,11 @@
|
||||
---
|
||||
title: "Automation Actions"
|
||||
title: "Automation actions"
|
||||
description: "Automations result in action."
|
||||
---
|
||||
|
||||
The action of an automation rule is what is being executed when a rule fires. The action part follows the [script syntax](/docs/scripts/) which can be used to interact with anything via services or events. For services you can specify the entity_id that it should apply to and optional service parameters (to specify for example the brightness).
|
||||
The action of an automation rule is what is being executed when a rule fires. The action part follows the [script syntax](/docs/scripts/) which can be used to interact with anything via services or events. For {% term services %}, you can specify the entity_id that it should apply to and optional service parameters (to specify for example the brightness).
|
||||
|
||||
You can also call the service to activate [a scene](/integrations/scene/) which will allow you to define how you want your devices to be and have Home Assistant call the right services.
|
||||
You can also call the {% term service %} to activate [a scene](/integrations/scene/) which will allow you to define how you want your devices to be and have Home Assistant call the right services.
|
||||
|
||||
{% raw %}
|
||||
|
||||
|
||||
@ -1,5 +1,5 @@
|
||||
---
|
||||
title: "Understanding Automations"
|
||||
title: "Understanding automations"
|
||||
description: "A breakdown of what an automation consists of."
|
||||
---
|
||||
|
||||
|
||||
@ -1,9 +1,9 @@
|
||||
---
|
||||
title: "Automation Conditions"
|
||||
title: "Automation conditions"
|
||||
description: "Automations can test conditions when invoked."
|
||||
---
|
||||
|
||||
Conditions are an optional part of an automation rule. They can be used to prevent the automation's actions from being run. After a trigger occurred, all conditions will be checked. If any of them do not return true, the automation will stop executing. Conditions look very similar to triggers, but they are very different — a trigger will look at events happening in the system, while a condition only looks at how the system looks right now. A trigger can observe that a switch is being turned on. A condition can only see if a switch is currently on or off.
|
||||
Conditions are an optional part of an automation rule. They can be used to prevent the automation's actions from being run. After a {% term trigger %} occurred, all conditions will be checked. If any of them do not return true, the automation will stop executing. Conditions look very similar to triggers, but they are very different — a trigger will look at events happening in the system, while a condition only looks at how the system looks right now. A trigger can observe that a switch is being turned on. A condition can only see if a switch is currently on or off.
|
||||
|
||||
The available conditions for an automation are the same as for the script syntax so see that page for a [full list of available conditions](/docs/scripts/conditions/).
|
||||
|
||||
|
||||
@ -1,5 +1,5 @@
|
||||
---
|
||||
title: "Automation Editor"
|
||||
title: "Automation editor"
|
||||
description: "Instructions on how to use the automation editor."
|
||||
---
|
||||
|
||||
|
||||
@ -1,11 +1,11 @@
|
||||
---
|
||||
title: "Automation Modes"
|
||||
title: "Automation modes"
|
||||
description: "How to use and configure automation modes."
|
||||
---
|
||||
|
||||
An automation can be triggered while it is already running.
|
||||
An {% term automation %} can be triggered while it is already running.
|
||||
|
||||
The automation's `mode` configuration option controls what happens when the automation is triggered while the actions are still running from a previous trigger.
|
||||
The automation's `mode` configuration option controls what happens when the automation is triggered while the {% term actions %} are still running from a previous {% term trigger %}.
|
||||
|
||||
Mode | Description
|
||||
-|-
|
||||
@ -38,7 +38,7 @@ automation:
|
||||
- delay: 300 # seconds (=5 minutes)
|
||||
```
|
||||
|
||||
## Example Queued
|
||||
## Example queued
|
||||
|
||||
Sometimes an automation is doing an action on a device that does not support multiple simultaneous actions. In such cases, a queue can be used. In that case, the automation will be executed once it's current invocation and queue are done.
|
||||
|
||||
|
||||
@ -1,5 +1,5 @@
|
||||
---
|
||||
title: "Automation Services"
|
||||
title: "Automation services"
|
||||
description: "How to use the various automation services."
|
||||
---
|
||||
|
||||
@ -7,7 +7,7 @@ The automation integration has services to control automations, like turning aut
|
||||
|
||||
## Service {% my developer_call_service service="automation.turn_on" %}
|
||||
|
||||
This service enables the automation's triggers.
|
||||
This service enables the automation's {% term triggers %}.
|
||||
|
||||
Service data attribute | Optional | Description
|
||||
-|-|-
|
||||
@ -15,7 +15,7 @@ Service data attribute | Optional | Description
|
||||
|
||||
## Service {% my developer_call_service service="automation.turn_off" %}
|
||||
|
||||
This service disables the automation's triggers, and optionally stops any currently active actions.
|
||||
This service disables the automation's {% term triggers %}, and optionally stops any currently active {% term actions %}.
|
||||
|
||||
Service data attribute | Optional | Description
|
||||
-|-|-
|
||||
@ -32,7 +32,7 @@ Service data attribute | Optional | Description
|
||||
|
||||
## Service {% my developer_call_service service="automation.trigger" %}
|
||||
|
||||
This service will trigger the action of an automation. By default it bypasses any conditions, though that can be changed via the `skip_condition` attribute.
|
||||
This service will trigger the {% term action %} of an {% term automation %}. By default it bypasses any conditions, though that can be changed via the `skip_condition` attribute.
|
||||
|
||||
Service data attribute | Optional | Description
|
||||
-|-|-
|
||||
|
||||
@ -1,5 +1,5 @@
|
||||
---
|
||||
title: "Automation Trigger Variables"
|
||||
title: "Automation trigger variables"
|
||||
description: "List all available variables made available by triggers."
|
||||
---
|
||||
|
||||
@ -7,13 +7,13 @@ Automations support [templating](/docs/configuration/templating/) in the same wa
|
||||
|
||||
The template variable `this` is also available when evaluating any `trigger_variables` declared in the configuration.
|
||||
|
||||
## Available this Data
|
||||
## Available `this` data
|
||||
|
||||
The variable `this` is the [state object](/docs/configuration/state_object) of the automation at the moment of triggering the actions. State objects also contain context data which can be used to identify the user that caused a script or automation to execute. Note that `this` will not change while executing the actions.
|
||||
The variable `this` is the [state object](/docs/configuration/state_object) of the automation at the moment of triggering the actions. State objects also contain context data which can be used to identify the user that caused a {% term script %} or {% term automation %} to execute. Note that `this` will not change while executing the {% term actions %}.
|
||||
|
||||
## Available Trigger Data
|
||||
## Available trigger data
|
||||
|
||||
The variable `trigger` is an object that contains details about which trigger triggered the automation.
|
||||
The variable `trigger` is an object that contains details about which {% term trigger %} triggered the automation.
|
||||
|
||||
Templates can use the data to modify the actions performed by the automation or displayed in a message. For example, you could create an automation that multiple sensors can trigger and then use the sensor's location to specify a light to activate; or you could send a notification containing the friendly name of the sensor that triggered it.
|
||||
|
||||
@ -78,9 +78,9 @@ These are the properties available for a [MQTT trigger](/docs/automation/trigger
|
||||
| `trigger.payload_json` | Dictionary of the JSON parsed payload.
|
||||
| `trigger.qos` | QOS of payload.
|
||||
|
||||
### Numeric State
|
||||
### Numeric state
|
||||
|
||||
These are the properties available for a [Numeric State trigger](/docs/automation/trigger/#numeric-state-trigger).
|
||||
These are the properties available for a [numeric state trigger](/docs/automation/trigger/#numeric-state-trigger).
|
||||
|
||||
| Template variable | Data |
|
||||
| ---- | ---- |
|
||||
@ -146,18 +146,18 @@ These are the properties available for a [Time trigger](/docs/automation/trigger
|
||||
| `trigger.platform` | Hardcoded: `time`
|
||||
| `trigger.now` | DateTime object that triggered the time trigger.
|
||||
|
||||
### Time Pattern
|
||||
### Time pattern
|
||||
|
||||
These are the properties available for a [Time Pattern trigger](/docs/automation/trigger/#time-pattern-trigger).
|
||||
These are the properties available for a [time pattern trigger](/docs/automation/trigger/#time-pattern-trigger).
|
||||
|
||||
| Template variable | Data |
|
||||
| ---- | ---- |
|
||||
| `trigger.platform` | Hardcoded: `time_pattern`
|
||||
| `trigger.now` | DateTime object that triggered the time_pattern trigger.
|
||||
|
||||
### Persistent Notification
|
||||
### Persistent notification
|
||||
|
||||
These properties are available for a [Persistent Notification trigger](/docs/automation/trigger/#persistent-notification-trigger).
|
||||
These properties are available for a [persistent notification trigger](/docs/automation/trigger/#persistent-notification-trigger).
|
||||
|
||||
| Template variable | Data |
|
||||
| ---- | ---- |
|
||||
|
||||
@ -3,9 +3,9 @@ title: "Automation Trigger"
|
||||
description: "All the different ways how automations can be triggered."
|
||||
---
|
||||
|
||||
Triggers are what starts the processing of an automation rule. When _any_ of the automation's triggers becomes true (trigger _fires_), Home Assistant will validate the [conditions](/docs/automation/condition/), if any, and call the [action](/docs/automation/action/).
|
||||
Triggers are what starts the processing of an {% term automation %} rule. When _any_ of the automation's triggers becomes true (trigger _fires_), Home Assistant will validate the [conditions](/docs/automation/condition/), if any, and call the [action](/docs/automation/action/).
|
||||
|
||||
An automation can be triggered by an event, a certain entity state, at a given time, and more. These can be specified directly or more flexible via templates. It is also possible to specify multiple triggers for one automation.
|
||||
An {% term automation %} can be triggered by an {% term event %}, a certain {% term entity %} {% term state %}, at a given time, and more. These can be specified directly or more flexible via templates. It is also possible to specify multiple triggers for one automation.
|
||||
|
||||
- [Trigger ID](#trigger-id)
|
||||
- [Trigger variables](#trigger-variables)
|
||||
@ -33,7 +33,8 @@ An automation can be triggered by an event, a certain entity state, at a given t
|
||||
|
||||
All triggers can be assigned an optional `id`. If the ID is omitted, it will instead be set to the index of the trigger. The `id` can be referenced from [trigger conditions and actions](/docs/scripts/conditions/#trigger-condition). The `id` does not have to be unique for each trigger, and it can be used to group similar triggers for use later in the automation (i.e., several triggers of different types that should all turn some entity on).
|
||||
|
||||
### Video Tutorial
|
||||
### Video tutorial
|
||||
|
||||
This video tutorial explains how trigger IDs work.
|
||||
|
||||
<lite-youtube videoid="fE_MYcXYwMI" videotitle="How to use Trigger IDs in Home Assistant - Tutorial" posterquality="maxresdefault"></lite-youtube>
|
||||
@ -673,7 +674,7 @@ If for your use case this is undesired, you could consider using the automation
|
||||
|
||||
The time trigger is configured to fire once a day at a specific time, or at a specific time on a specific date. There are three allowed formats:
|
||||
|
||||
### Time String
|
||||
### Time string
|
||||
|
||||
A string that represents a time to fire on each day. Can be specified as `HH:MM` or `HH:MM:SS`. If the seconds are not specified, `:00` will be used.
|
||||
|
||||
@ -685,9 +686,9 @@ automation:
|
||||
at: "15:32:00"
|
||||
```
|
||||
|
||||
### Input Datetime
|
||||
### Input datetime
|
||||
|
||||
The Entity ID of an [Input Datetime](/integrations/input_datetime/).
|
||||
The entity ID of an [input datetime](/integrations/input_datetime/).
|
||||
|
||||
| has_date | has_time | Description |
|
||||
| -------- | -------- | ---------------------------------------- |
|
||||
@ -740,7 +741,7 @@ automation:
|
||||
entity_id: light.bedroom
|
||||
```
|
||||
|
||||
### Multiple Times
|
||||
### Multiple times
|
||||
|
||||
Multiple times can be provided in a list. Both formats can be intermixed.
|
||||
|
||||
@ -939,7 +940,7 @@ The sentences matched by this trigger will be:
|
||||
|
||||
Punctuation and casing are ignored, so "It's PARTY TIME!!!" will also match.
|
||||
|
||||
### Sentence Wildcards
|
||||
### Sentence wildcards
|
||||
|
||||
Adding one or more `{lists}` to your trigger sentences will capture any text at that point in the sentence. A `slots` object will be [available in the trigger data](/docs/automation/templating#sentence).
|
||||
This allows you to match sentences with variable parts, such as album/artist names or a description of a picture.
|
||||
@ -971,7 +972,7 @@ automation:
|
||||
event: sunset
|
||||
```
|
||||
|
||||
## Multiple Entity IDs for the same Trigger
|
||||
## Multiple entity IDs for the same trigger
|
||||
|
||||
It is possible to specify multiple entities for the same trigger. To do so add multiple entities using a nested list. The trigger will fire and start, processing your automation each time the trigger is true for any entity listed.
|
||||
|
||||
|
||||
@ -1,9 +1,9 @@
|
||||
---
|
||||
title: "Troubleshooting Automations"
|
||||
title: "Troubleshooting automations"
|
||||
description: "Tips on how to troubleshoot your automations."
|
||||
---
|
||||
|
||||
When an automation is run, all steps are recorded and a trace is made. From the UI choose **Settings** which is located in the sidebar, then click on **Automations & Scenes** to go to the automation editor or click this button directly: {% my automations badge %}
|
||||
When an {% term automation %} is run, all steps are recorded and a trace is made. From the UI, open **Settings**, which is located in the sidebar, then select **Automations & Scenes** to go to the automation editor or click this button directly: {% my automations badge %}
|
||||
|
||||
Click on the clock icon next to an automation to enter the debugging screen. Alternatively, click on **Show trace** directly from a Logbook automation entry.
|
||||
|
||||
|
||||
@ -3,7 +3,7 @@ title: "Using automation blueprints"
|
||||
description: "How to create automations based off blueprints."
|
||||
---
|
||||
|
||||
Automation blueprints are pre-made automations that you can easily add to your Home Assistant instance. Each blueprint can be added as many times as you want.
|
||||
Automation blueprints are pre-made {% term automations %} that you can easily add to your Home Assistant instance. Each blueprint can be added as many times as you want.
|
||||
|
||||
Quick links:
|
||||
|
||||
@ -11,7 +11,7 @@ Quick links:
|
||||
|
||||
## Blueprint automations
|
||||
|
||||
Automations based on a blueprint need to be configured. What needs to be configured differs on each blueprint.
|
||||
Automations based on a blueprint need to be configured. What needs to be configured differs by blueprint.
|
||||
|
||||
1. To create your first automation based on a blueprint, go to **{% my blueprints title="Settings > Automations & Scenes > Blueprints" %}**.
|
||||
2. Find the blueprint that you want to use and select **Create Automation**.
|
||||
|
||||
@ -3,7 +3,7 @@ title: "Automation YAML"
|
||||
description: "How to use the automation integration with YAML."
|
||||
---
|
||||
|
||||
Automations are created in Home Assistant via the UI, but are stored in a YAML format. If you want to edit the YAML of an automation, select the automation, click on the menu button in the top right then on **Edit in YAML**.
|
||||
Automations are created in Home Assistant via the UI, but are stored in a YAML format. If you want to edit the YAML of an {% term automation %}, select the automation, click on the menu button in the top right then on **Edit in YAML**.
|
||||
|
||||
The UI will write your automations to `automations.yaml`. This file is managed by the UI and should not be edited manually.
|
||||
|
||||
@ -70,7 +70,7 @@ trigger_variables:
|
||||
description: "The value of the variable. Any YAML is valid. Only [limited templates](/docs/configuration/templating/#limited-templates) can be used."
|
||||
type: any
|
||||
mode:
|
||||
description: "Controls what happens when the automation is invoked while it is still running from one or more previous invocations. See [Automation Modes](#automation-modes)."
|
||||
description: "Controls what happens when the automation is invoked while it is still running from one or more previous invocations. See [Automation modes](#automation-modes)."
|
||||
required: false
|
||||
type: string
|
||||
default: single
|
||||
@ -112,7 +112,7 @@ action:
|
||||
type: list
|
||||
{% endconfiguration %}
|
||||
|
||||
### Automation Modes
|
||||
### Automation modes
|
||||
|
||||
Mode | Description
|
||||
-|-
|
||||
@ -126,8 +126,7 @@ Mode | Description
|
||||
</p>
|
||||
|
||||
|
||||
|
||||
## YAML Example
|
||||
## YAML example
|
||||
|
||||
Example of a YAML based automation that you can add to `configuration.yaml`.
|
||||
|
||||
@ -262,9 +261,9 @@ If you want to migrate your manual automations to use the editor, you'll have to
|
||||
|
||||
{% endraw %}
|
||||
|
||||
### Deleting Automations
|
||||
### Deleting automations
|
||||
|
||||
When automations remain visible in the Home Assistant Dashboard, even after having deleted in the YAML file, you have to delete them in the UI.
|
||||
When automations remain visible in the Home Assistant dashboard, even after having deleted in the YAML file, you have to delete them in the UI.
|
||||
|
||||
To delete them completely, go to UI **{% my entities title="Settings -> Devices & Services -> Entities" %}** and find the automation in the search field or by scrolling down.
|
||||
|
||||
|
||||
@ -3,7 +3,7 @@ title: "Database"
|
||||
description: "Details about the database used by Home Assistant."
|
||||
---
|
||||
|
||||
Home Assistant uses database to store events and parameters for history and tracking. The default database used 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>/home-assistant_v2.db`); however, other databases can be used. If you prefer to run a database server (e.g., PostgreSQL), use the [`recorder` integration](/integrations/recorder/).
|
||||
Home Assistant uses databases to store {% term events %} and parameters for history and tracking. The default database used 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>/home-assistant_v2.db`); however, other databases can be used. If you prefer to run a database server (e.g., PostgreSQL), use the [`recorder` integration](/integrations/recorder/).
|
||||
|
||||
To work with SQLite database manually from the command-line, you will need an [installation](https://www.sqlitetutorial.net/download-install-sqlite/) of `sqlite3`. Alternatively [DB Browser for SQLite](https://sqlitebrowser.org/) provides a viewer for exploring the database data and an editor for executing SQL commands.
|
||||
First load your database with `sqlite3`:
|
||||
|
||||
@ -7,9 +7,9 @@ This section gives a high-level introduction to blueprints. To view a descriptio
|
||||
|
||||
## What is a blueprint?
|
||||
|
||||
A blueprint is a script or automation configuration with certain parts marked as configurable. This allows you to create different scripts or automations based on the same blueprint.
|
||||
A blueprint is a {% term script %} or {% term automation %} configuration with certain parts marked as configurable. This allows you to create different scripts or automations based on the same blueprint.
|
||||
|
||||
Imagine you want to control lights based on motion. A blueprint provides the generic automation framework, while letting you select one specific motion sensor as a trigger, and the exact light to control. This blueprint makes it possible to create two automations. Each automation has their own configuration and act completely independently. Yet, they share some basic automation configuration so that you do not have to set this up every time.
|
||||
Imagine you want to control lights based on motion. A blueprint provides the generic {% term automation %} framework, while letting you select one specific motion sensor as a {% term trigger %}, and the exact light to control. This blueprint makes it possible to create two automations. Each automation has their own configuration and act completely independently. Yet, they share some basic automation configuration so that you do not have to set this up every time.
|
||||
|
||||
Blueprints are shared by the community in the [blueprint community forum][blueprint-forums].
|
||||
|
||||
|
||||
@ -76,7 +76,7 @@ action:
|
||||
The output of this selector is a list of actions. For example:
|
||||
|
||||
```yaml
|
||||
# Example Action selector output result
|
||||
# Example action selector output result
|
||||
- service: scene.turn_on
|
||||
target:
|
||||
entity_id: scene.watching_movies
|
||||
@ -97,7 +97,7 @@ selected add-on.
|
||||
This selector does not have any other options; therefore, it only has its key.
|
||||
|
||||
```yaml
|
||||
# Example Add-on selector
|
||||
# Example add-on selector
|
||||
addon:
|
||||
```
|
||||
|
||||
@ -202,10 +202,10 @@ The output of this selector is the area ID, or (in case `multiple` is set to
|
||||
`true`) a list of area IDs.
|
||||
|
||||
```yaml
|
||||
# Example Area selector output result, when multiple is set to false
|
||||
# Example area selector output result, when multiple is set to false
|
||||
living_room
|
||||
|
||||
# Example Area selector output result, when multiple is set to true
|
||||
# Example area selector output result, when multiple is set to true
|
||||
- living_room
|
||||
- kitchen
|
||||
```
|
||||
@ -347,7 +347,7 @@ condition:
|
||||
The output of this selector is a list of conditions. For example:
|
||||
|
||||
```yaml
|
||||
# Example Condition selector output result
|
||||
# Example condition selector output result
|
||||
- condition: numeric_state
|
||||
entity_id: "sensor.outside_temperature"
|
||||
below: 20
|
||||
@ -568,10 +568,10 @@ The output of this selector is the device ID, or (in case `multiple` is set to
|
||||
`true`) a list of devices IDs.
|
||||
|
||||
```yaml
|
||||
# Example Device selector output result, when multiple is set to false
|
||||
# Example device selector output result, when multiple is set to false
|
||||
faadde5365842003e8ca55267fe9d1f4
|
||||
|
||||
# Example Device selector output result, when multiple is set to true
|
||||
# Example device selector output result, when multiple is set to true
|
||||
- faadde5365842003e8ca55267fe9d1f4
|
||||
- 3da77cb054352848b9544d40e19de562
|
||||
```
|
||||
@ -717,7 +717,7 @@ light.living_room
|
||||
An example entity selector that, will only show entities that are:
|
||||
|
||||
- Provided by the [ZHA](/integrations/zha) integration.
|
||||
- From the [Binary Sensor](/integrations/binary_sensor) domain.
|
||||
- From the [Binary sensor](/integrations/binary_sensor) domain.
|
||||
- Have presented themselves as devices of a motion device class.
|
||||
- Allows selecting one or more entities.
|
||||
|
||||
|
||||
@ -5,7 +5,7 @@ description: "Tutorial on creating an automation blueprint."
|
||||
|
||||
<div class='note'>
|
||||
|
||||
While the tutorial only shows how to create an automation blueprint, scripts also support blueprints in the same way.
|
||||
While the tutorial only shows how to create an automation blueprint, {% term scripts %} also support blueprints in the same way.
|
||||
|
||||
</div>
|
||||
|
||||
@ -248,7 +248,7 @@ Don't forget to reload automations after you make changes to your blueprint to h
|
||||
|
||||
|
||||
|
||||
## Video Tutorial
|
||||
## Video tutorial
|
||||
|
||||
This video tutorial explains how to create a blueprint that toggles a light on motion when the lux value is below a certain threshold.
|
||||
|
||||
|
||||
@ -118,6 +118,6 @@ country:
|
||||
type: string
|
||||
{% endconfiguration %}
|
||||
|
||||
## Reload Core Service
|
||||
## Reload core service
|
||||
|
||||
Home Assistant offers a service to reload the core configuration while Home Assistant is running called {% my developer_call_service service="homeassistant.reload_core_config" %}. This allows you to change any of the above sections and see it being applied without having to restart Home Assistant. To call this service, go to the "{% my developer_services %}" tab under {% my developer_services title="Developer Tools" %}, select the {% my developer_call_service service="homeassistant.reload_core_config" %} service and click the "CALL SERVICE" button. Alternatively, you can press the "Reload Location & Customizations" button under {% my server_controls title="Developer Tools > YAML" %}.
|
||||
Home Assistant offers a service to reload the core configuration while Home Assistant is running called {% my developer_call_service service="homeassistant.reload_core_config" %}. This allows you to change any of the above sections and see it being applied without having to restart Home Assistant. To call this service, go to the "{% my developer_services %}" tab under {% my developer_services title="Developer Tools" %}, select the {% my developer_call_service service="homeassistant.reload_core_config" %} service and click the "CALL SERVICE" button. Alternatively, you can press the "Location & Customizations" button under {% my server_controls title="Developer Tools > YAML" %}.
|
||||
|
||||
@ -7,8 +7,8 @@ description: "Simple customization for entities."
|
||||
|
||||
You can use the UI to change the entity ID and friendly name of supported entities. To do this:
|
||||
|
||||
1. Select the entity, either from the frontend or by clicking the info button next to the entity in the Developer Tools "States" tab.
|
||||
2. Click on the cog icon in the right corner of the entity's dialog
|
||||
1. Select the {% term entity %}, either from the frontend or by selecting the info button next to the entity in the Developer Tools "States" tab.
|
||||
2. Select the cog icon in the right corner of the entity's dialog
|
||||
|
||||
3. Enter the new name or the new entity ID (remember not to change the domain of the entity - the part before the `.`)
|
||||
|
||||
@ -57,15 +57,15 @@ initial_state:
|
||||
default: None
|
||||
{% endconfiguration %}
|
||||
|
||||
### Device Class
|
||||
### Device class
|
||||
|
||||
Device class is currently supported by the following platforms:
|
||||
|
||||
- [Binary Sensor](/integrations/binary_sensor/)
|
||||
- [Binary sensor](/integrations/binary_sensor/)
|
||||
- [Button](/integrations/button/)
|
||||
- [Cover](/integrations/cover/)
|
||||
- [Humidifier](/integrations/humidifier/)
|
||||
- [Media Player](/integrations/media_player/)
|
||||
- [Media player](/integrations/media_player/)
|
||||
- [Number](/integrations/number/)
|
||||
- [Sensor](/integrations/sensor/)
|
||||
- [Switch](/integrations/switch/)
|
||||
|
||||
@ -23,7 +23,7 @@ A secure way to remotely access your Home Assistant is to use a Virtual Private
|
||||
|
||||
A VPN connection needs to be established before you can connect to your Home Assistant from outside your local network. The VPN makes this connection secure. When using the Home Assistant Companion app (such as on a mobile device), without this connection, your sensors will not update in Home Assistant.
|
||||
|
||||
## Port Forwarding
|
||||
## Port forwarding
|
||||
|
||||
Set up port forwarding (for any port) from your router to port 8123 on the computer that is hosting Home Assistant. General instructions on how to do this can be found by searching `<router model> port forwarding instructions`. You can use any free port on your router and forward that to port 8123.
|
||||
|
||||
|
||||
@ -13,9 +13,9 @@ Here's the summary of what you *must* do to secure your Home Assistant system:
|
||||
- **Note**: Storing secrets in `secrets.yaml` does not encrypt them.
|
||||
- Regularly keep the system up to date
|
||||
|
||||
## Remote Access
|
||||
## Remote access
|
||||
|
||||
If you want secure remote access, the easiest option is to use [Home Assistant cloud](/cloud/) by which you also [support](https://www.nabucasa.com/about/) the founders of Home Assistant.
|
||||
If you want secure remote access, the easiest option is to use [Home Assistant Cloud](/cloud/) by which you also [support](https://www.nabucasa.com/about/) the founders of Home Assistant.
|
||||
|
||||
Another option is to use TLS/SSL via the add-on [Duck DNS](/integrations/duckdns/) integrating Let's Encrypt.
|
||||
|
||||
|
||||
@ -200,7 +200,7 @@ If you have many configuration files, Home Assistant provides a CLI that allows
|
||||
- [Core](/common-tasks/core/#configuration-check)
|
||||
- [Supervised](/common-tasks/supervised/#configuration-check)
|
||||
|
||||
## Advanced Usage
|
||||
## Advanced usage
|
||||
|
||||
We offer four advanced options to include whole directories at once. Please note that your files must have the `.yaml` file extension; `.yml` is not supported.
|
||||
|
||||
|
||||
@ -1,9 +1,9 @@
|
||||
---
|
||||
title: "State Objects"
|
||||
title: "State objects"
|
||||
description: "Describes all there is to know about state objects in Home Assistant."
|
||||
---
|
||||
|
||||
Your devices are represented in Home Assistant as entities. The entities will write their current state to the state machine for other entities/templates/frontend to access. States are a current representation of the entity.
|
||||
Your {% term devices %} are represented in Home Assistant as entities. The {% term entities %} will write their current {% term state %} to the state machine for other entities/templates/frontend to access. States are a current representation of the {% term entity %}.
|
||||
|
||||
If you overwrite a state via the states dev tool or the API, it will not impact the actual device. If the device state is being polled, it will overwrite the state in the state machine the next polling.
|
||||
|
||||
@ -23,7 +23,7 @@ All states will always have an entity id, a state and a timestamp when last upda
|
||||
|
||||
## Attributes
|
||||
|
||||
The attributes of an entity are optional. There are a few attributes that are used by Home Assistant for representing the entity in a specific way. Each integration will also have its own attributes to represent extra state data about the entity. For example, the light integration has attributes for the current brightness and color of the light. When an attribute is not available, Home Assistant will not write it to the state.
|
||||
The attributes of an {% term entity %} are optional. There are a few attributes that are used by Home Assistant for representing the entity in a specific way. Each integration will also have its own attributes to represent extra state data about the entity. For example, the light integration has attributes for the current brightness and color of the light. When an attribute is not available, Home Assistant will not write it to the state.
|
||||
|
||||
When using templates, attributes will be available by their name. For example `state.attributes.assumed_state`.
|
||||
|
||||
@ -39,7 +39,7 @@ When an attribute contains spaces, you can retrieve it like this: `state_attr('s
|
||||
|
||||
## Context
|
||||
|
||||
Context is used to tie events and states together in Home Assistant. Whenever an automation or user interaction causes states to change, a new context is assigned. This context will be attached to all events and states that happen as result of the change.
|
||||
Context is used to tie {% term events %} and {% term states %} together in Home Assistant. Whenever an {% term automation %} or user interaction causes states to change, a new context is assigned. This context will be attached to all events and states that happen as result of the change.
|
||||
|
||||
| Field | Description |
|
||||
| ----- | ------------------------------------------------------------------- |
|
||||
|
||||
@ -46,7 +46,7 @@ script:
|
||||
|
||||
{% endraw %}
|
||||
|
||||
### Important Template Rules
|
||||
### Important template rules
|
||||
|
||||
There are a few very important rules to remember when adding templates to YAML:
|
||||
|
||||
@ -57,7 +57,7 @@ There are a few very important rules to remember when adding templates to YAML:
|
||||
|
||||
Remembering these simple rules will help save you from many headaches and endless hours of frustration when using automation templates.
|
||||
|
||||
### Enabled Jinja Extensions
|
||||
### Enabled Jinja extensions
|
||||
|
||||
Jinja supports a set of language extensions that add new functionality to the language.
|
||||
To improve the experience of writing Jinja templates, we have enabled the following
|
||||
@ -65,7 +65,7 @@ extensions:
|
||||
|
||||
- [Loop Controls](https://jinja.palletsprojects.com/en/3.0.x/extensions/#loop-controls) (`break` and `continue`)
|
||||
|
||||
### Reusing Templates
|
||||
### Reusing templates
|
||||
|
||||
You can write reusable Jinja templates by adding them to a `custom_templates` folder under your
|
||||
configuration directory. All template files must have the `.jinja` extension and be less than 5MiB.
|
||||
@ -102,7 +102,7 @@ In your automations, you could then reuse this macro by importing it:
|
||||
|
||||
Extensions allow templates to access all of the Home Assistant specific states and adds other convenience functions and filters.
|
||||
|
||||
### Limited Templates
|
||||
### Limited templates
|
||||
|
||||
Templates for some [triggers](/docs/automation/trigger/) as well as `trigger_variables` only support a subset of the Home Assistant template extensions. This subset is referred to as "Limited Templates".
|
||||
|
||||
@ -325,7 +325,7 @@ List of lights that are on with a brightness of 255:
|
||||
|
||||
{% endraw %}
|
||||
|
||||
### Working with Groups
|
||||
### Working with groups
|
||||
|
||||
Not supported in [limited templates](#limited-templates).
|
||||
|
||||
@ -418,7 +418,7 @@ The same thing can also be expressed as a test:
|
||||
|
||||
{% endraw %}
|
||||
|
||||
### Config Entries
|
||||
### Config entries
|
||||
|
||||
- `config_entry_id(entity_id)` returns the config entry ID for a given entity ID. Can also be used as a filter.
|
||||
|
||||
@ -1066,7 +1066,7 @@ The following overview contains a couple of options to get the needed values:
|
||||
|
||||
{% endraw %}
|
||||
|
||||
To evaluate a response, go to **{% my developer_template title="Developer Tools -> Template" %}**, create your output in "Template editor", and check the result.
|
||||
To evaluate a response, go to **{% my developer_template title="Developer Tools > Template" %}**, create your output in "Template editor", and check the result.
|
||||
|
||||
{% raw %}
|
||||
|
||||
|
||||
@ -98,11 +98,11 @@ The only characters valid in entity names are:
|
||||
|
||||
If you create an entity with other characters then Home Assistant may not generate an error for that entity. However you will find that attempts to use that entity will generate errors (or possibly fail silently).
|
||||
|
||||
## Debug Logs and Diagnostics
|
||||
## Debug logs and diagnostics
|
||||
|
||||
The first thing you will need before reporting an issue online is debug logs and diagnostics (if available) for the integration giving you trouble. Getting those ahead of time will ensure someone can help resolve your issue in the fastest possible manner.
|
||||
|
||||
### Enabling Debug Logging
|
||||
### Enabling debug logging
|
||||
|
||||
To enable debug logging for an integration, go to **Settings** > **Devices & Services** > **Integrations** and go to the detail page of the integration. Select the **Enable Debug Logging** button on the left side of the integration detail page.
|
||||
|
||||
@ -111,11 +111,11 @@ To enable debug logging for an integration, go to **Settings** > **Devices & Ser
|
||||
Example of Enable debug logging.
|
||||
</p>
|
||||
|
||||
### Disable Debug Logging and Download Logs
|
||||
### Disable debug logging and download logs
|
||||
|
||||
Once you enable debug logging, you ideally need to make the error happen. Run your automation, change up your device or whatever was giving you an error and then come back and disable the debug logging. Disabling the debug logging is the same as enabling, but now the button says **Disable Debug Logging**. After you disable it, you will be automatically prompted you to download your log file. Save this to a safe location to upload later.
|
||||
|
||||
### Download Diagnostics
|
||||
### Download diagnostics
|
||||
|
||||
After you download logs, you will also want to download the diagnostics for the integration giving you trouble. If the integration provides diagnostics, it will appear in the three dot menu next to the integration configuration.
|
||||
|
||||
|
||||
@ -93,7 +93,7 @@ light: !include lights.yaml
|
||||
|
||||
More information about this feature can also be found at [splitting configuration](/docs/configuration/splitting_configuration/).
|
||||
|
||||
## Common Issues
|
||||
## Common issues
|
||||
|
||||
### found character '\t'
|
||||
|
||||
|
||||
@ -45,6 +45,12 @@ We have developed [Home Assistant Glow](https://github.com/klaasnicolaas/home-as
|
||||
|
||||
|
||||
|
||||
#### Reading the meter via a IEC62056-21
|
||||
|
||||
The IEC62056-21 is a common protocol not only for electric meters. It uses an infrared port to read data.
|
||||
[Aquaticus](https://github.com/aquaticus) has created an [ESPHome component](https://community.home-assistant.io/t/new-iec62056-21-component/555236) for reading this data. [PiggyMeter](https://aquaticus.info/meter.html) is a complete project that allows easy installation.
|
||||
|
||||
|
||||
#### Using (Smart Message Language) interface
|
||||
|
||||
In countries like Germany, SML (Smart Message Language) is used typically. ESPHome's [SML (Smart Message Language)](https://esphome.io/components/sml.html) is one way to integrate it. If you prefer to integrate it via MQTT, [sml2mqtt](https://github.com/spacemanspiff2007/sml2mqtt) is another open source option.
|
||||
@ -69,7 +75,7 @@ _Attention! Installing CT clamp sensor devices requires opening your electrical
|
||||
|
||||
Some energy providers will provide you real-time information about your usage and have this data integrated into Home Assistant.
|
||||
|
||||
### Manual Integration
|
||||
### Manual integration
|
||||
|
||||
If you manually integrate your sensors, for example, using the [MQTT](/integrations/mqtt) or [Template](/integrations/template) integrations: Make sure you set and provide the `device_class`, `state_class`, and `unit_of_measurement` for those sensors.
|
||||
|
||||
|
||||
@ -29,7 +29,7 @@ If you are using a 3rd party device (e.g. not reading directly from your utility
|
||||
|
||||
To accomplish such, you can use the [utility_meter integration](/integrations/utility_meter/). With this integration, you define as many tariffs as required (in accordance with your utility provider contract) and HA will be able to differentiate energy consumptions in each of the tariffs. Please note that each utility provider has its own time schedules for peak and off-peak and you are required to create an automation that switches the utility_meter entity from one tariff to the other.
|
||||
|
||||
## The Energy panel is not visible
|
||||
## The energy panel is not visible
|
||||
|
||||
If you do not see the Energy panel in the sidebar, make sure you have not removed [`default_config:`](/integrations/default_config/) from your `configuration.yaml`. If you have, you will need to add the `energy:` integration manually.
|
||||
|
||||
|
||||
@ -13,7 +13,7 @@ Smart plugs sit between the device and the outlet and measure the energy flowing
|
||||
|
||||
Depending on what protocols you use at home, you can use Zigbee, Z-Wave or Wi-Fi based plugs.
|
||||
|
||||
### Smart Relays
|
||||
### Smart relays
|
||||
|
||||
Smart relays sit behind your "normal" switches and make them smart. It allows you to control the devices via Home Assistant and via the connected buttons/switches.
|
||||
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
---
|
||||
title: "Browsers"
|
||||
description: "Browser Compatibility List"
|
||||
description: "Browser compatibility list"
|
||||
---
|
||||
|
||||
Home Assistant requires a web browser to show the frontend and supports all major modern browsers. We don't test the web interface against all available browsers but this page tracks different browsers on various operating systems and should help you to pick a browser which works. The "Release" column contains the release number which was tested. This doesn't mean that older or newer releases will not work.
|
||||
|
||||
@ -9,15 +9,15 @@ description: "Material Design Icons in the Home Assistant frontend"
|
||||
|
||||
Home Assistant utilizes the community-driven [Material Design Icons](https://pictogrammers.com/library/mdi/) (MDI) project for icons in the frontend. The icon library is a superset of the base icon library provided by Google and contains thousands of community-made icons for very specific applications, industries, and use-cases.
|
||||
|
||||
## Default Icons
|
||||
## Default icons
|
||||
|
||||
Every entity in Home Assistant has a default icon assigned to it. There are way too many to list out here, but you'll see them in your dashboard. You can [customize any of your entities](/docs/configuration/customizing-devices/#icon) to change the icons displayed to you.
|
||||
|
||||
## Finding Icons
|
||||
## Finding icons
|
||||
|
||||
### Icon Picker
|
||||
### Icon picker
|
||||
|
||||
The most common way you can find icons is by using the icon picker built right into Home Assistant. Click into the "Icon" field when customizing an entity and start typing. The list will filter to icons that match your search criteria. You can also scroll through all available icons when the field is empty.
|
||||
The most common way you can find icons is by using the icon picker built right into Home Assistant. Select the "Icon" field when customizing an entity and start typing. The list will filter to icons that match your search criteria. You can also scroll through all available icons when the field is empty.
|
||||
|
||||
<p class='img'>
|
||||
<img src='/images/screenshots/icon-picker.png' alt='Icon Picker in Home Assistant' />
|
||||
@ -29,7 +29,7 @@ The most common way you can find icons is by using the icon picker built right i
|
||||
|
||||
</div>
|
||||
|
||||
### Material Design Icons Picker Browser Extension
|
||||
### Material design icons picker browser extension
|
||||
|
||||
The easiest way to browse and find icons outside of Home Assistant is with the official [Material Design Icons Picker](https://github.com/Pictogrammers/MaterialDesignIcons-Picker) browser extension. The extension is available for Chrome, Firefox, and Edge and is maintained by the MDI team.
|
||||
|
||||
@ -43,19 +43,19 @@ The easiest way to browse and find icons outside of Home Assistant is with the o
|
||||
|
||||
</div>
|
||||
|
||||
### Material Design Icons on the Pictogrammers Website
|
||||
### Material design icons on the Pictogrammers website
|
||||
|
||||
The last way to browse through available icons is by viewing the library on the Pictogrammers website, [https://pictogrammers.com/library/mdi/](https://pictogrammers.com/library/mdi/). Select an icon you'd like to use, then click "Home Assistant" to see an example of its usage.
|
||||
|
||||
<div class='note info'>
|
||||
|
||||
The Pictogrammers website will always show the latest release of the Material Design Icons library. However, you may find icons that may not yet be available in Home Assistant (yet!). Watch the Home Assistant release notes for announcements on upgrades of the Material Design Icons library.
|
||||
The Pictogrammers website will always show the latest release of the material design icons library. However, you may find icons that may not yet be available in Home Assistant (yet!). Watch the Home Assistant release notes for announcements on upgrades of the Material Design Icons library.
|
||||
|
||||
</div>
|
||||
|
||||
## Suggesting or Contributing New Icons
|
||||
## Suggesting or contributing new icons
|
||||
|
||||
Being open-source like Home Assistant, the Material Design Icons library is always accepting suggestions and contributions to expand the library.
|
||||
Being open-source like Home Assistant, the material design icons library is always accepting suggestions and contributions to expand the library.
|
||||
|
||||
<div class='note info'>
|
||||
|
||||
@ -63,7 +63,7 @@ Being open-source like Home Assistant, the Material Design Icons library is alwa
|
||||
|
||||
</div>
|
||||
|
||||
### Suggesting a New Icon
|
||||
### Suggesting a new icon
|
||||
|
||||
If you have an idea for an icon that isn't currently in the library, but are not interested in creating it yourself, [open a new icon suggestion](https://github.com/Templarian/MaterialDesign/issues/new?assignees=&labels=Icon+Request&template=1_icon_request.yml).
|
||||
|
||||
|
||||
@ -45,11 +45,12 @@ If you are running Home Assistant in a container, you can use the command line i
|
||||
4. `exit` to exit the container command line
|
||||
5. `docker restart homeassistant` to restart the container.
|
||||
|
||||
#### To reset a user's password, as an administrator via the web interface
|
||||
#### To reset a user's password, as an owner via the web interface
|
||||
|
||||
1. In the bottom left, select your user to go to the {% my profile title="**Profile**" %} page and make sure **Advanced Mode** is activated.
|
||||
2. Go to {% my people title="**Settings** > **People**" %} and select the person for which you want to change the password.
|
||||
3. At the bottom of the dialog box, select **Change Password**.
|
||||
- Note: this is available as the owner, not administrator.
|
||||
4. Enter the new password, and select **OK**.
|
||||
5. Confirm the new password by entering it again, and select **OK** again.
|
||||
6. A confirmation box will be displayed with the text **Password was changed successfully**.
|
||||
@ -78,7 +79,7 @@ If you lose the password associated with the owner account and the steps above d
|
||||
- `hassio`
|
||||
- `cloud`
|
||||
|
||||
## Recovering Data for Home Assistant (including Supervised)
|
||||
## Recovering data for Home Assistant (including Supervised)
|
||||
|
||||
Unless your SD card/data is corrupted, you can still get to your files or troubleshoot further.
|
||||
There are a few routes:
|
||||
@ -101,7 +102,7 @@ You will then be at the Home Assistant CLI, where you can run the custom command
|
||||
- `dns logs` for checking DNS
|
||||
- etc (typing `help` will show more)
|
||||
|
||||
## Accessing Files from the SD/HDD
|
||||
## Accessing files from the SD/HDD
|
||||
|
||||
### Remove the SD and access the files from another computer
|
||||
|
||||
|
||||
@ -1,5 +1,5 @@
|
||||
---
|
||||
title: "Scenes Editor"
|
||||
title: "Scenes editor"
|
||||
description: "Instructions on how to use the scenes editor."
|
||||
---
|
||||
|
||||
|
||||
@ -241,7 +241,7 @@ This action can use the same triggers that are available in an automation's `tri
|
||||
|
||||
{% endraw %}
|
||||
|
||||
### Wait Timeout
|
||||
### Wait timeout
|
||||
|
||||
With both types of waits it is possible to set a timeout after which the script will continue its execution if the condition/event is not satisfied. Timeout has the same syntax as `delay`, and like `delay`, also accepts templates.
|
||||
|
||||
@ -275,7 +275,7 @@ You can also get the script to abort after the timeout by using optional `contin
|
||||
|
||||
Without `continue_on_timeout: false` the script will always continue since the default for `continue_on_timeout` is `true`.
|
||||
|
||||
### Wait Variable
|
||||
### Wait variable
|
||||
|
||||
After each time a wait completes, either because the condition was met, the event happened, or the timeout expired, the variable `wait` will be created/updated to indicate the result.
|
||||
|
||||
@ -387,12 +387,12 @@ The following automation example shows how to capture the custom event `event_li
|
||||
|
||||
{% endraw %}
|
||||
|
||||
## Repeat a Group of Actions
|
||||
## Repeat a group of actions
|
||||
|
||||
This action allows you to repeat a sequence of other actions. Nesting is fully supported.
|
||||
There are three ways to control how many times the sequence will be run.
|
||||
|
||||
### Counted Repeat
|
||||
### Counted repeat
|
||||
|
||||
This form accepts a count value. The value may be specified by a template, in which case
|
||||
the template is rendered when the repeat step is reached.
|
||||
@ -473,7 +473,7 @@ repeat:
|
||||
|
||||
{% endraw %}
|
||||
|
||||
### While Loop
|
||||
### While loop
|
||||
|
||||
This form accepts a list of conditions (see [conditions page] for available options) that are evaluated _before_ each time the sequence
|
||||
is run. The sequence will be run _as long as_ the condition(s) evaluate to true.
|
||||
@ -514,7 +514,7 @@ For example:
|
||||
|
||||
{% endraw %}
|
||||
|
||||
### Repeat Until
|
||||
### Repeat until
|
||||
|
||||
This form accepts a list of conditions that are evaluated _after_ each time the sequence
|
||||
is run. Therefore the sequence will always run at least once. The sequence will be run
|
||||
@ -564,7 +564,7 @@ For example:
|
||||
```
|
||||
{% endraw %}
|
||||
|
||||
### Repeat Loop Variable
|
||||
### Repeat loop variable
|
||||
|
||||
A variable named `repeat` is defined within the repeat action (i.e., it is available inside `sequence`, `while` & `until`.)
|
||||
It contains the following fields:
|
||||
|
||||
@ -5,9 +5,9 @@ toc: true
|
||||
no_toc: true
|
||||
---
|
||||
|
||||
Conditions can be used within a script or automation to prevent further execution. When a condition evaluates true, the script or automation will be executed. If any other value is returned, the script or automation stops executing. A condition will look at the system at that moment. For example, a condition can test if a switch is currently turned on or off.
|
||||
Conditions can be used within a {% term script %} or {% term automation %} to prevent further execution. When a condition evaluates true, the script or automation will be executed. If any other value is returned, the script or automation stops executing. A condition will look at the system at that moment. For example, a condition can test if a switch is currently turned on or off.
|
||||
|
||||
Unlike a trigger, which is always `or`, conditions are `and` by default - all conditions have to be true.
|
||||
Unlike a {% term trigger %}, which is always `or`, conditions are `and` by default - all conditions have to be true.
|
||||
|
||||
All conditions support an optional `alias`.
|
||||
|
||||
|
||||
@ -1,9 +1,9 @@
|
||||
---
|
||||
title: "Service Calls"
|
||||
title: "Service calls"
|
||||
description: "Instructions on how to call services in Home Assistant."
|
||||
---
|
||||
|
||||
Various integrations allow calling services when a certain event occurs. The most common one is calling a service when an automation trigger happens. But a service can also be called from a script, a dashboard or via voice command devices such as Amazon Echo.
|
||||
Various integrations allow calling {% term services %} when a certain event occurs. The most common one is calling a service when an automation {% term trigger %} happens. But a service can also be called from a {% term script %}, a dashboard or via voice command devices such as Amazon Echo.
|
||||
|
||||
The configuration options to call a configuration are the same between all integrations and are described on this page.
|
||||
|
||||
@ -15,7 +15,7 @@ Use the "Services" tab under Developer Tools to discover available services.
|
||||
|
||||
### The basics
|
||||
|
||||
Call the service `homeassistant.turn_on` on the entity `group.living_room`. This will turn all members of `group.living_room` on. You can also use `entity_id: all` and it will turn on all possible entities.
|
||||
Call the service `homeassistant.turn_on` on the {% term entity %} `group.living_room`. This will turn all members of `group.living_room` on. You can also use `entity_id: all` and it will turn on all possible entities.
|
||||
|
||||
```yaml
|
||||
service: homeassistant.turn_on
|
||||
@ -24,7 +24,7 @@ entity_id: group.living_room
|
||||
|
||||
### Targeting areas and devices
|
||||
|
||||
Instead of targeting an entity, you can also target an area or device. Or a combination of these.
|
||||
Instead of targeting an entity, you can also target an {% term area %} or {% term device %}. Or a combination of these.
|
||||
This is done with the `target` key.
|
||||
|
||||
A `target` is a map that contains at least one of the following: `area_id`, `device_id`, `entity_id`.
|
||||
|
||||
@ -3,7 +3,7 @@ title: "check_config"
|
||||
description: "Script to perform a check of the current configuration"
|
||||
---
|
||||
|
||||
Test any changes to your `configuration.yaml` file before launching Home Assistant. This script allows you to test changes without the need to restart Home Assistant.
|
||||
Test any changes to your `configuration.yaml` file before launching Home Assistant. This {% term script %} allows you to test changes without the need to restart Home Assistant.
|
||||
|
||||
```bash
|
||||
hass --script check_config
|
||||
|
||||
@ -1,13 +1,13 @@
|
||||
---
|
||||
title: "Developer Tools"
|
||||
description: "Description of the Developer Tools."
|
||||
title: "Developer tools"
|
||||
description: "Description of the developer tools."
|
||||
---
|
||||
|
||||
The frontend contains a section called **Developer Tools**.
|
||||
The dashboard contains a section called **Developer tools**.
|
||||
|
||||
<p class='img'>
|
||||
<img src='/images/screenshots/developer-tools.png' />
|
||||
Screenshot of Home Assistant's Developer Tools.
|
||||
Screenshot of Home Assistant's developer tools.
|
||||
</p>
|
||||
|
||||
| Section |Description |
|
||||
@ -58,9 +58,9 @@ brightness: 255
|
||||
rgb_color: [255, 0, 0]
|
||||
```
|
||||
|
||||
## Template Editor
|
||||
## Template editor
|
||||
|
||||
The Template Editor provides a way to quickly test templates prior to placing them into automations and scripts. A code editor is on the left side and your real-time output is displayed in the preview on the right side.
|
||||
The template editor provides a way to quickly test templates prior to placing them into automations and scripts. A code editor is on the left side and your real-time output is displayed in the preview on the right side.
|
||||
|
||||
By default, this will contain sample code that illustrates how templates can be written and tested. This sample code can be removed and replaced with your own. You can restore the default example by pressing the "Reset to Demo Template" button beneath the code editor.
|
||||
|
||||
|
||||
@ -1,9 +1,9 @@
|
||||
---
|
||||
title: "Quick Bar"
|
||||
title: "Quick bar"
|
||||
description: "Dialog for quickly accessing entities or running commands."
|
||||
---
|
||||
|
||||
The "Quick Bar" allows you to quickly look up entities or run commands without needing to navigate away from your current view (Similar to the "quick open" feature in VS Code, Chrome Developer Tools, etc).
|
||||
The **Quick bar** allows you to quickly look up entities or run commands without needing to navigate away from your current view (Similar to the "quick open" feature in VS Code, Chrome Developer Tools, etc).
|
||||
|
||||
It can be launched from anywhere in the frontend using [hotkeys](#hotkeys).
|
||||
|
||||
@ -26,7 +26,7 @@ Type these from anywhere in the application to launch the dialog.
|
||||
The application must have focus for the hotkey to register. If the dialog doesn't launch, try clicking into an empty part of the main content area of Home Assistant and type it again.
|
||||
</div>
|
||||
|
||||
## Entity Filter
|
||||
## Entity filter
|
||||
|
||||
*Hotkey: `e`*
|
||||
|
||||
@ -41,7 +41,7 @@ Once launched, start typing your entity id (or ["bits and pieces" of your entity
|
||||
|
||||
This is helpful when, say, you are in the middle of writing an automation and need some quick insight about an entity but don't want to navigate away to Developer Tools.
|
||||
|
||||
## Command Palette
|
||||
## Command palette
|
||||
|
||||
*Hotkey: `c`*
|
||||
|
||||
@ -66,7 +66,7 @@ Type | Available |
|
||||
|
||||
Create [`my`](/integrations/my) links from any supported page in the user interface, when invoked on a supported page it will open a new tab that will allow you to share the link in different formats.
|
||||
|
||||
## Disabling Shortcuts
|
||||
## Disabling shortcuts
|
||||
|
||||
You can enable or disable all of Home Assistant's keyboard shortcuts by going to your User Profile and clicking the "Keyboard Shortcuts" toggle button.
|
||||
|
||||
|
||||
@ -52,7 +52,7 @@ If you are just starting out, we recommend that you purchase a 700 series contro
|
||||
If you're using Home Assistant OS, Supervised, or Container, it's recommended to use a USB stick, not a module. Passing a module through Docker is more complicated than passing a USB stick through.
|
||||
</div>
|
||||
|
||||
## Stick Alternatives
|
||||
## Stick alternatives
|
||||
|
||||
The alternative to a stick is a hub that supports Z-Wave. Home Assistant supports the following hubs with Z-Wave support:
|
||||
|
||||
@ -61,7 +61,7 @@ The alternative to a stick is a hub that supports Z-Wave. Home Assistant support
|
||||
- [SmartThings](/integrations/smartthings/)
|
||||
- [Z-Wave.Me Z-Way](/integrations/zwave_me)
|
||||
|
||||
## Controller Notes
|
||||
## Controller notes
|
||||
|
||||
### 800 Series Controllers
|
||||
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
<section class="aside-module grid__item one-whole lap-one-half">
|
||||
<div class='section'>
|
||||
<h1 class="title delta">Common Tasks</h1>
|
||||
<h1 class="title delta">Common tasks</h1>
|
||||
<ul class='divided sidebar-menu'>
|
||||
<li>{% active_link /common-tasks/os/ Home Assistant Operating System %}</li>
|
||||
<li>{% active_link /common-tasks/container/ Home Assistant Container %}</li>
|
||||
|
||||
@ -32,7 +32,7 @@
|
||||
{%- else -%}
|
||||
The {{ page.title | default: page.name }} {{ page.ha_integration_type | default: "integration" }} was introduced in Home Assistant {{ page.ha_release | default: "unknown" }}
|
||||
|
||||
{%- if page.ha_iot_standard -%}
|
||||
{%- if page.ha_iot_standard or page.ha_integration_type == "entity" -%}
|
||||
.
|
||||
{%- else -%}
|
||||
, and it's used by <a title="Open analytics.home-assistant.io" href="https://analytics.home-assistant.io/integrations" target="_blank" rel="noopener">
|
||||
|
||||
@ -8,10 +8,10 @@
|
||||
<b>{% active_link /docs/glossary/ Glossary %}</b>
|
||||
</li>
|
||||
<li>
|
||||
<b>{% active_link /getting-started Getting Started %}</b>
|
||||
<b>{% active_link /getting-started Getting started %}</b>
|
||||
<ul>
|
||||
<li>{% active_link /installation Installation %}</li>
|
||||
<li>{% active_link /common-tasks/os/ Common Tasks %}</li>
|
||||
<li>{% active_link /common-tasks/os/ Common tasks %}</li>
|
||||
<li>
|
||||
{% active_link /docs/troubleshooting/ Troubleshooting
|
||||
%}
|
||||
@ -34,7 +34,7 @@
|
||||
%}
|
||||
</li>
|
||||
<li>
|
||||
{% active_link /docs/configuration/securing/ Security Check Points
|
||||
{% active_link /docs/configuration/securing/ Security check points
|
||||
%}
|
||||
</li>
|
||||
</ul>
|
||||
@ -42,14 +42,14 @@
|
||||
<li>
|
||||
<b>{% active_link /docs/energy/ Home Energy Management %}</b>
|
||||
<ul>
|
||||
<li>{% active_link /docs/energy/electricity-grid/ Electricity Grid %}</li>
|
||||
<li>{% active_link /docs/energy/solar-panels/ Solar Panels %}</li>
|
||||
<li>{% active_link /docs/energy/individual-devices/ Individual Devices %}</li>
|
||||
<li>{% active_link /docs/energy/electricity-grid/ Electricity grid %}</li>
|
||||
<li>{% active_link /docs/energy/solar-panels/ Solar panels %}</li>
|
||||
<li>{% active_link /docs/energy/individual-devices/ Individual devices %}</li>
|
||||
<li>{% active_link /docs/energy/faq/ FAQ %}</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
Advanced Configuration
|
||||
Advanced configuration
|
||||
<ul>
|
||||
<li>{% active_link /docs/configuration/remote/ Remote access %}</li>
|
||||
<li>
|
||||
@ -58,7 +58,7 @@
|
||||
</li>
|
||||
<li>{% active_link /docs/configuration/packages/ Packages %}</li>
|
||||
<li>
|
||||
{% active_link /docs/configuration/secrets/ Storing Secrets %}
|
||||
{% active_link /docs/configuration/secrets/ Storing secrets %}
|
||||
</li>
|
||||
<li>{% active_link /docs/configuration/templating/ Templating %}</li>
|
||||
<li>
|
||||
@ -71,11 +71,11 @@
|
||||
<b>{% active_link /docs/authentication/ Authentication %}</b>
|
||||
<ul>
|
||||
<li>
|
||||
{% active_link /docs/authentication/providers/ Auth Providers %}
|
||||
{% active_link /docs/authentication/providers/ Auth providers %}
|
||||
</li>
|
||||
<li>
|
||||
{% active_link /docs/authentication/multi-factor-auth/ Multi Factor
|
||||
Auth %}
|
||||
{% active_link /docs/authentication/multi-factor-auth/ Multi factor
|
||||
auth %}
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
@ -84,20 +84,20 @@
|
||||
<ul>
|
||||
<li>{% active_link /docs/configuration/events/ Events %}</li>
|
||||
<li>
|
||||
{% active_link /docs/configuration/state_object/ State Objects %}
|
||||
{% active_link /docs/configuration/state_object/ State objects %}
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<b>{% active_link /docs/automation/ Automation %}</b>
|
||||
<ul>
|
||||
<li>{% active_link /docs/automation/using_blueprints/ Using Automation Blueprints %}</li>
|
||||
<li>{% active_link /docs/automation/basics/ Automation Basics %}</li>
|
||||
<li>{% active_link /docs/automation/using_blueprints/ Using automation blueprints %}</li>
|
||||
<li>{% active_link /docs/automation/basics/ Automation basics %}</li>
|
||||
<li>{% active_link /docs/automation/editor/ Editor %}</li>
|
||||
<li>{% active_link /docs/automation/trigger/ Triggers %}</li>
|
||||
<li>{% active_link /docs/automation/condition/ Conditions %}</li>
|
||||
<li>{% active_link /docs/automation/action/ Actions %}</li>
|
||||
<li>{% active_link /docs/automation/modes/ Run Modes %}</li>
|
||||
<li>{% active_link /docs/automation/modes/ Run modes %}</li>
|
||||
<li>{% active_link /docs/automation/services/ Services %}</li>
|
||||
<li>{% active_link /docs/automation/templating/ Templates %}</li>
|
||||
<li>{% active_link /docs/automation/yaml/ YAML %}</li>
|
||||
@ -118,7 +118,7 @@
|
||||
<b>{% active_link /docs/frontend/ Frontend %}</b>
|
||||
<ul>
|
||||
<li>
|
||||
{% active_link /docs/frontend/browsers/ Browser Compatibility List %}
|
||||
{% active_link /docs/frontend/browsers/ Browser compatibility list %}
|
||||
</li>
|
||||
<li>{% active_link /dashboards Dashboards %}</li>
|
||||
<li>{% active_link /docs/frontend/icons/ Icons%}</li>
|
||||
@ -133,7 +133,7 @@
|
||||
<li>
|
||||
<b>{% active_link /docs/scripts/ Scripts %}</b>
|
||||
<ul>
|
||||
<li>{% active_link /docs/scripts/service-calls/ Service Calls %}</li>
|
||||
<li>{% active_link /docs/scripts/service-calls/ Service calls %}</li>
|
||||
<li>{% active_link /docs/scripts/conditions/ Conditions %}</li>
|
||||
</ul>
|
||||
</li>
|
||||
@ -144,10 +144,10 @@
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
<b>{% active_link /docs/tools/ Tools and Helpers %}</b>
|
||||
<b>{% active_link /docs/tools/ Tools and helpers %}</b>
|
||||
<ul>
|
||||
<li>{% active_link /docs/tools/dev-tools/ Developer Tools %}</li>
|
||||
<li>{% active_link /docs/tools/quick-bar/ Quick Bar %}</li>
|
||||
<li>{% active_link /docs/tools/dev-tools/ Developer tools %}</li>
|
||||
<li>{% active_link /docs/tools/quick-bar/ Quick bar %}</li>
|
||||
<li>{% active_link /docs/tools/hass/ hass %}</li>
|
||||
<li>{% active_link /docs/tools/check_config/ check_config %}</li>
|
||||
</ul>
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
<section class="aside-module grid__item one-whole lap-one-half">
|
||||
<div class="section">
|
||||
<h1 class="title delta">Getting Started</h1>
|
||||
<h1 class="title delta">Getting started</h1>
|
||||
<ul class="divided sidebar-menu">
|
||||
<li>{% active_link /installation/ Installation %}</li>
|
||||
<li>{% active_link /getting-started/onboarding/ Onboarding %}</li>
|
||||
@ -17,7 +17,7 @@
|
||||
%}
|
||||
</li>
|
||||
<li>
|
||||
{% active_link /getting-started/configuration/ Advanced Configuration %}
|
||||
{% active_link /getting-started/configuration/ Advanced configuration %}
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
@ -11,22 +11,4 @@ If you want to define a specific interval at which your device is being polled f
|
||||
- Define any trigger and condition you like.
|
||||
- Under action, select **Call service** and use the [`homeassistant.update_entity` service](/integrations/homeassistant/#service-homeassistantupdate_entity).
|
||||
|
||||
- Example in YAML.
|
||||
|
||||
```yaml
|
||||
automation:
|
||||
- alias: "Only update weather information every 20 minutes when I'm home"
|
||||
trigger:
|
||||
- platform: time_pattern
|
||||
minutes: "/20"
|
||||
condition:
|
||||
- condition: state
|
||||
entity_id: device_tracker.cynthia
|
||||
state: home
|
||||
action:
|
||||
- service: homeassistant.update_entity
|
||||
target:
|
||||
entity_id: weather.home
|
||||
```
|
||||
|
||||
4. Save your new automation to poll for data.
|
||||
|
||||
@ -3,7 +3,7 @@
|
||||
Best practice for updating a Home Assistant installation:
|
||||
|
||||
1. Backup your installation{% if page.installation == "os" or page.installation == "supervised" %}, using the backup functionality Home Assistant offers{% endif %}.
|
||||
2. Check the release notes for breaking changes on [Home Assistant release notes](/blog/categories/core/). Be sure to check all release notes between the version you are running and the one you are upgrading to. Use the search function in your browser (`CTRL + f` / `CMD + f`) and search for **Breaking Changes**.
|
||||
2. Check the release notes for backward-incompatible changes on [Home Assistant release notes](/blog/categories/core/). Be sure to check all release notes between the version you are running and the one you are upgrading to. Use the search function in your browser (`CTRL + f` / `CMD + f`) and search for **Backward-incompatible changes**.
|
||||
{% if page.installation == "os" or page.installation == "supervised" %}
|
||||
3. Select "Create backup before updating" in case you encounter an issue that requires a rollback.
|
||||
4. Update Home Assistant.
|
||||
|
||||
8
source/_includes/dashboard/edit_dashboard.md
Normal file
8
source/_includes/dashboard/edit_dashboard.md
Normal file
@ -0,0 +1,8 @@
|
||||
{% capture name %}{{ include.name | default: page.title }}{% endcapture %}
|
||||
{% capture domain %}{{ include.domain | default: page.ha_domain }}{% endcapture %}
|
||||
{% capture title %}{{ include.title | default: page.title }}{% endcapture %}
|
||||
|
||||
To add the {{ title | downcase }} to your user interface:
|
||||
1. In the top right of the screen, select the three dots menu and then select **Edit dashboard**.
|
||||
- By editing the dashboard, you are taking over control of this dashboard. This means that it is no longer automatically updated when new dashboard elements become available. To continue, in the dialog, select **Take control**.
|
||||
2. In the bottom right corner, select the **Add card** button and select from the card picker.
|
||||
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