jeans/home-assistant.io
jeans/home-assistant.io
1
0
Fork 0
mirror of https://github.com/home-assistant/home-assistant.io.git synced 2025-07-19 07:17:14 +00:00
Code Issues Packages Projects Releases Wiki Activity

Merge remote-tracking branch 'origin/next' into rc

Browse Source
This commit is contained in:
Paulus Schoutsen 2019-07-10 20:51:36 -07:00
commit 8184596fb8
1130 changed files with 7936 additions and 6841 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

33
.devcontainer/Dockerfile Normal file
View File

@ -0,0 +1,33 @@
FROM ruby:2.6
# Avoid warnings by switching to noninteractive
ENV DEBIAN_FRONTEND=noninteractive
# Use Bash as the default shell
ENV SHELL=/bin/bash
# Locale env vars
ENV \
LANG=en_US.UTF-8 \
LANGUAGE=en_US:en \
LC_ALL=en_US.UTF-8
# Install git, process tools
RUN apt update \
&& apt-get install -y --no-install-recommends \
ack \
git \
locales \
procps \
&& echo "en_US UTF-8" > /etc/locale.gen \
&& locale-gen en_US.UTF-8 \
&& echo 'export PS1="\\w\$ "' > /root/.bashrc \
&& apt-get autoremove -y \
&& apt-get clean -y \
&& rm -rf /var/lib/apt/lists/*
# Install the specific version of bundler we need
RUN gem install bundler -v 2.0.1
# Switch back to dialog for any ad-hoc use of apt-get
ENV DEBIAN_FRONTEND=dialog

30
.devcontainer/devcontainer.json Normal file
View File

@ -0,0 +1,30 @@
{
"name": "home-assistant.io",
"dockerFile": "Dockerfile",
"appPort": [
4000
],
"postCreateCommand": "bundle install",
"extensions": [
"davidanson.vscode-markdownlint",
"eamodio.gitlens",
"editorconfig.editorconfig",
"github.vscode-pull-request-github",
"mrmlnc.vscode-scss",
"ms-vsliveshare.vsliveshare",
"rebornix.Ruby",
"streetsidesoftware.code-spell-checker",
"yzhang.markdown-all-in-one"
],
"settings": {
"editor.rulers": [80, 100, 120],
"editor.renderWhitespace": "boundary",
"errorLens.gutterIconsEnabled": true,
"errorLens.addAnnotationTextPrefixes": false,
"errorLens.enabledDiagnosticLevels": [
"error",
"warning"
],
"terminal.integrated.shell.linux": "/bin/bash"
}
}

1
.github/stale.yml vendored
View File

@ -5,6 +5,7 @@ daysUntilClose: 7
# Issues with these labels will never be considered stale
exemptLabels:
- has-parent
- Help wanted
# Label to use when marking an issue as stale
staleLabel: Stale
# Comment to post when marking an issue as stale. Set to `false` to disable

13
.gitignore vendored
View File

@ -4,8 +4,6 @@
.gist-cache
.pygments-cache
public
sass.old
source.old
source/_stash
source/stylesheets/screen.css
vendor
@ -13,11 +11,8 @@ node_modules
source/.jekyll-metadata
*.iml
.idea/
/.vs/home-assistant.github.io/v15/.suo
/.vs/ProjectSettings.json
/.vs/slnx.sqlite
/.vs/config/applicationhost.config
/.vs/slnx.sqlite-journal
/.vs/VSWorkspaceState.json
.vscode
.vscode/*
!.vscode/cSpell.json
!.vscode/extensions.json
!.vscode/tasks.json
*.suo

3
.gitmodules vendored
View File

@ -1,3 +0,0 @@
[submodule "_deploy"]
path = _deploy
url = https://github.com/home-assistant/home-assistant.github.io.git

15
.gitpod.yml Normal file
View File

@ -0,0 +1,15 @@
tasks:
- init: gem install bundler -v 2.0.1 && bundle install && bundle exec rake generate
ports:
- port: 4000
onOpen: open-browser
github:
prebuilds:
master: true
branches: true
pullRequests: true
pullRequestsFromForks: true
addCheck: true
addComment: false
addBadge: true
addLabel: false

6
.markdownlint.json Normal file
View File

@ -0,0 +1,6 @@
{
"MD002": { "level": 2 },
"MD013": false,
"MD024": { "siblings_only": true },
"MD033": false
}

11
.project
View File

@ -1,11 +0,0 @@
<?xml version="1.0" encoding="UTF-8"?>
<projectDescription>
<name>home-assistant.github.io</name>
<comment></comment>
<projects>
</projects>
<buildSpec>
</buildSpec>
<natures>
</natures>
</projectDescription>

30
.theia/tasks.json Normal file
View File

@ -0,0 +1,30 @@
{
"tasks": [
{
"label": "Generate",
"type": "shell",
"command": "bundle",
"args": [
"exec",
"rake",
"generate"
],
"options": {
"cwd": "${workspaceFolder}"
}
},
{
"label": "Preview",
"type": "shell",
"command": "bundle",
"args": [
"exec",
"rake",
"preview"
],
"options": {
"cwd": "${workspaceFolder}"
}
}
]
}

8
.travis.yml
View File

@ -1,8 +0,0 @@
language: ruby
sudo: false
cache: bundler
before_install:
- gem install bundler:2.0.1
script: travis_wait bundle exec rake generate
after_success:
- '[ "${TRAVIS_BRANCH}" = "current" ] && [ "${TRAVIS_PULL_REQUEST}" = "false" ] && bundle exec rake deploy || false'

83
.vscode/cSpell.json vendored Normal file
View File

@ -0,0 +1,83 @@
// cSpell Settings
// Contains additional words for our project
{
"version": "0.1",
"language": "en",
"words": [
"arest",
"automations",
"bloomsky",
"bluesound",
"BTLE",
"Denon",
"endconfiguration",
"endraw",
"fitbit",
"Flexit",
"geizhals",
"Harman",
"hass",
"hass.io",
"hassos",
"hcitool",
"heos",
"hikvision",
"Homematic",
"IBAN",
"icloud",
"kardon",
"macos",
"Modbus",
"Mosquitto",
"nginx",
"ohmconnect",
"Onkyo",
"paulus",
"templating",
"waqi",
"Webhook"
],
// flagWords - list of words to be always considered incorrect
// This is useful for offensive words and common spelling errors.
// For example "hte" should be "the"
"flagWords": [
"hte",
"asssistant"
],
"enabledLanguageIds": [
"asciidoc",
"c",
"cpp",
"csharp",
"css",
"dockerfile",
"gemfile",
"git-commit",
"go",
"handlebars",
"html",
"jade",
"java",
"javascript",
"javascriptreact",
"json",
"jsonc",
"latex",
"less",
"liquid",
"markdown",
"php",
"plaintext",
"pug",
"python",
"restructuredtext",
"rust",
"scala",
"scss",
"text",
"typescript",
"typescriptreact",
"yaml",
"yml"
]
}

8
.vscode/extensions.json vendored Normal file
View File

@ -0,0 +1,8 @@
{
"recommendations": [
"davidanson.vscode-markdownlint",
"editorconfig.editorconfig",
"streetsidesoftware.code-spell-checker",
"yzhang.markdown-all-in-one"
]
}

23
.vscode/tasks.json vendored Normal file
View File

@ -0,0 +1,23 @@
{
"version": "2.0.0",
"tasks": [
{
"label": "Generate",
"type": "shell",
"command": "bundle exec rake generate",
"group": {
"kind": "build",
"isDefault": true
}
},
{
"label": "Preview",
"type": "shell",
"command": "bundle exec rake preview",
"group": {
"kind": "test",
"isDefault": true,
}
}
]
}

0
README.markdown → README.md
View File

1
_deploy

@ -1 +0,0 @@
Subproject commit 69146ecaf4d31902ab9ea0a4e6c9f3985d99e808

7
plugins/linkable_title.rb
View File

@ -5,12 +5,11 @@ module Jekyll
@title = text
end
def render(context)
def render(context)
title = Liquid::Template.parse(@title).render context
slug = title.downcase.strip.gsub(' ', '-').gsub(/[^\w-]/, '')
"<a class='title-link' name='#{slug}' href='\##{slug}'></a> #{title}"
"#{title}"
end
end
end
Liquid::Template.register_tag('linkable_title', Jekyll::LinkableTitleTag)
Liquid::Template.register_tag('linkable_title', Jekyll::LinkableTitleTag)

33
plugins/no_follow.rb
View File

@ -1,33 +0,0 @@
# Jekyll Auto Nofollow Plugin
# Automatically adds rel='external nofollow' to outgoing links.
require 'jekyll'
require 'nokogiri'
module Jekyll
module NoFollow
def nofollow(content)
dom = Nokogiri::HTML.fragment(content)
# Find all links
dom.css('a').each do |link|
rel = ['external', 'nofollow']
# All external links start with 'http', skip when this one does not
next unless link.get_attribute('href') =~ /\Ahttp/i
# Play nice with our own links
next if link.get_attribute('href') =~ /\Ahttps?:\/\/\w*.?home-assistant.io/i
# Play nice with links that already have a rel attribute set
rel.unshift(link.get_attribute('rel'))
# Add rel attribute to link
link.set_attribute('rel', rel.join(' ').strip)
end
dom.to_s
end
end
end
Liquid::Template.register_filter(Jekyll::NoFollow)

50
plugins/output_modder.rb Normal file
View File

@ -0,0 +1,50 @@
# Jekyll Out Modder - Allows for mangling/modding the HTML output
#
# This is combined in a single plugin/filter to reduce the NokoGiri dom
# parsing to just once per page/content.
#
# - Automatically adds rel='external nofollow' to outgoing links.
# - Automatically make headers linkable
#
require 'jekyll'
require 'nokogiri'
module Jekyll
module OutputModder
def output_modder(content)
dom = Nokogiri::HTML.fragment(content)
# Find all links, make all external links rel='external nofollow'
dom.css('a').each do |link|
rel = ['external', 'nofollow']
# All external links start with 'http', skip when this one does not
next unless link.get_attribute('href') =~ /\Ahttp/i
# Play nice with our own links
next if link.get_attribute('href') =~ /\Ahttps?:\/\/\w*.?home-assistant.io/i
# Play nice with links that already have a rel attribute set
rel.unshift(link.get_attribute('rel'))
# Add rel attribute to link
link.set_attribute('rel', rel.join(' ').strip)
end
# Find all headers, make them linkable
dom.css('h2,h3,h4,h5,h6,h7,h8').each do |header|
# Skip linked headers
next if header.at_css('a')
title = header.content
slug = title.downcase.strip.gsub(' ', '-').gsub(/[^\w-]/, '')
header.children = "<a class='title-link' name='#{slug}' href='\##{slug}'></a> #{title}"
end
dom.to_s
end
end
end
Liquid::Template.register_filter(Jekyll::OutputModder)

2
sass/custom/_paulus.scss
View File

@ -210,7 +210,7 @@ dt:hover a.title-link {
&::before {
position: absolute;
top: 2px;
top: 5px;
left: -25px;
padding-right: 40px;
font-family: "FontAwesome";

22
source/_addons/bluetooth_bcm43xx.markdown
View File

@ -1,22 +0,0 @@
---
layout: page
title: "Bluetooth BCM43xx"
description: "Activate the BCM43xx Bluetooth chipset on a Raspberry Pi 3."
date: 2017-04-30 13:28
sidebar: true
comments: false
sharing: true
footer: true
---
Start this add-on to activate the BCM43xx Bluetooth chipset in the old ResinOS based builds. If you first installed Hass.io after mid July 2018 then you will have a HassOS based system.
You can identify the base of your system by looking in the System tab of the Hass.io menu.
<p class='note warning'>
This is not required on the new HassOS based Hass.io installs and should not be installed.
</p>
Supported platforms:
- Raspberry Pi 3

4
source/_addons/check_config.markdown
View File

@ -11,7 +11,7 @@ footer: true
You can use this add-on to check whether your configuration files are valid against the new version of Home Assistant before you actually update your Home Assistant installation. This add-on will help you avoid errors due to breaking changes, resulting in a smooth update.
### {% linkable_title How to use this add-on %}
### How to use this add-on
1. Just start the add-on.
2. Wait (On a Raspberry Pi it can take several minutes).
@ -19,7 +19,7 @@ You can use this add-on to check whether your configuration files are valid agai
If you get errors, then you should look for **Breaking Changes** against the version you specified for this add-on and change your configuration accordingly.
### {% linkable_title Add-on configuration %}
### Add-on configuration
```json
{

6
source/_addons/configurator.markdown
View File

@ -20,7 +20,7 @@ More information and a standalone version for regular Home Assistant installatio
Screenshot of the HASS Configurator.
</p>
### {% linkable_title Feature list %}
### Feature list
- Web-based editor to modify your files with syntax highlighting and YAML linting.
- Upload and download files.
@ -32,7 +32,7 @@ Screenshot of the HASS Configurator.
- Editor settings are saved in your browser.
- And much more...
### {% linkable_title Add-on Configuration %}
### Add-on Configuration
```json
{
@ -54,6 +54,6 @@ enforce_basepath:
default: false
{% endconfiguration %}
### {% linkable_title Old port based Access %}
### Old port based Access
You can set a network Port and the Add-on listens on that Port with Home Assistant user credential. That is as a backup if you are not able to connect to Home Assistant anymore. Today, you can restart Home Assistant with broken config, but maybe some times usefully.

6
source/_addons/duckdns.markdown
View File

@ -49,7 +49,7 @@ seconds:
type: integer
{% endconfiguration %}
## {% linkable_title Home Assistant configuration %}
## Home Assistant configuration
Use the following configuration in Home Assistant to use the generated certificate:
@ -62,7 +62,7 @@ http:
If you use a port other than `8123` or an SSL proxy, change the port number accordingly.
## {% linkable_title Router configuration %}
## Router configuration
You'll need to forward the port you listed in your configuration (8123 in the example above) on your router to your Home Assistant system. You can find guides on how to do this on [Port Forward](https://portforward.com/). Noting that you'll only need to forward the TCP port.
@ -70,7 +70,7 @@ Ensure that you allocate the Home Assistant system a fixed IP on your network be
Restart Home Assistant for the configured changes to take effect. When you access the Home Assistant frontend you will now need to use `https`, even when accessing local instances, for example at `https://192.168.0.1:8123`.
## {% linkable_title Generate Let's Encrypt certificate for Duck DNS sub sub domains %}
## Generate Let's Encrypt certificate for Duck DNS sub sub domains
To generate certificates for nr.my-domain.duckdns.org update the domain JSON settings to:

2
source/_addons/google_assistant.markdown
View File

@ -79,7 +79,7 @@ speaker:
type: string
{% endconfiguration %}
### {% linkable_title Home Assistant configuration %}
### Home Assistant configuration
Use the Home Assistant [DialogFlow component][comp] to integrate the add-on into Home Assistant.

6
source/_addons/homematic.markdown
View File

@ -103,7 +103,7 @@ hmip:
type: string
{% endconfiguration %}
## {% linkable_title Home Assistant configuration %}
## Home Assistant configuration
Use the following configuration in Home Assistant to use it:
@ -121,7 +121,7 @@ homematic:
port: 2010
```
## {% linkable_title Raspberry Pi3 %}
## Raspberry Pi3
With HM-MOD-RPI-PCB you need to add follow into your `config.txt` on boot partition:
@ -129,6 +129,6 @@ With HM-MOD-RPI-PCB you need to add follow into your `config.txt` on boot partit
dtoverlay=pi3-miniuart-bt
```
## {% linkable_title HmIP-RFUSB %}
## HmIP-RFUSB
HassOS > 1.11 support HmIP-RFUSB default and don't need any configuration. If you run a Linux, you need to follow the installation guide from documentation to set up the UART USB interface on your computer.

4
source/_addons/lets_encrypt.markdown
View File

@ -45,7 +45,7 @@ keyfile:
default: privkey.pem
{% endconfiguration %}
## {% linkable_title Home Assistant configuration %}
## Home Assistant configuration
Use the following configuration in Home Assistant to use the generated certificate:
@ -58,7 +58,7 @@ http:
If you use another port such as `8123` or an SSL proxy, change the port number.
## {% linkable_title Enabling auto-renewals %}
## Enabling auto-renewals
Out of the box, the add-on will not automatically renew your certificate. In fact, it only starts, tries to get/renew your certificate, and then stops. It's up to you to manually start it again whenever your certificate comes close to expiry.

2
source/_addons/mariadb.markdown
View File

@ -77,7 +77,7 @@ rights:
type: string
{% endconfiguration %}
## {% linkable_title Home Assistant configuration %}
## Home Assistant configuration
Use the following configuration in Home Assistant to use the database above:

10
source/_addons/mosquitto.markdown
View File

@ -47,15 +47,15 @@ customize:
type: [boolean, string]
{% endconfiguration %}
### {% linkable_title Home Assistant user management %}
### Home Assistant user management
This add-on is attached to the Home Assistant user system, so mqtt clients can make use of these credentials. Local users may also still be set independently within the configuration options for the add-on. For the internal Hass.io ecosystem we register `homeassistant` and `addons`, so these may not be used as user names.
### {% linkable_title Home Assistant configuration %}
### Home Assistant configuration
To use the Mosquitto as [broker](/docs/mqtt/broker/#run-your-own), go to the integration page and install the configuration with one click. If you have old MQTT settings available, remove this old integration and restart Home Assistant to see the new one.
#### {% linkable_title Using Mosquitto with Hass.io %}
#### Using Mosquitto with Hass.io
1. Install the [Mosquitto add-on](/addons/mosquitto/) with the default configuration via 'Hass.io > ADD-ON STORE'. (Don't forget to start the add-on & verify that 'Start on boot' is enabled.)
@ -73,11 +73,11 @@ To use the Mosquitto as [broker](/docs/mqtt/broker/#run-your-own), go to the int
Note: .yaml modifications are not required.
See [testing your setup](/docs/mqtt/testing/) to verify the steps above.
### {% linkable_title Disable listening on insecure (1883) ports %}
### Disable listening on insecure (1883) ports
Remove the ports from the add-on page network card (set them as blank) to disable them.
### {% linkable_title Access Control Lists (ACLs) %}
### Access Control Lists (ACLs)
It is possible to restrict access to topics based upon the user logged in to Mosquitto. In this scenario it is recommended to create individual users for each of your clients and create an appropriate ACL.

2
source/_addons/rpc_shutdown.markdown
View File

@ -33,7 +33,7 @@ Allows you to shut down a Windows computer with a service call from Home Assista
- **computers/address** (*Required*): IP address or NetBIOS name of the computer for the shutdown.
- **computers/credentials** (*Required*): Credentials for logging into computer. Use a `%` as the delimiter of username and password.
### {% linkable_title Home Assistant configuration %}
### Home Assistant configuration
Use the following inside Home Assistant service call to use it:

18
source/_addons/snips.markdown
View File

@ -17,7 +17,7 @@ The Snips add-on depends on the Mosquitto add on to bridge to Home Assistant, so
Home Assistant comes with certain Intents builtin to handle common tasks. A complete list of Intents can be found in this wiki [Hass Snips Bundle](https://github.com/tschmidty69/hass-snips-bundle-intents/wiki).
The Snips add-on by default comes with an assistant that allows you to turn on lights or switches, open covers, or add and list items to a shopping list if that integration is enabled.
The Snips add-on by default comes with an assistant that allows you to turn on lights or switches, open covers, or add and list items to a [Shopping List](/components/shopping_list/) if that integration is enabled.
If using a USB microphone and speakers plugged into the Raspberry Pi output, Snips will work without any change to the configuration. Trying saying things like:
@ -33,7 +33,7 @@ Now install and activate the [Samba](/addons/samba/) add-on so you can upload yo
Now it's time to start Snips for the first time. You can configure the microphone and sound card using the Add-on interface. Now start the add-on.
### {% linkable_title Add-On configuration %}
### Add-On configuration
```json
{
@ -66,23 +66,23 @@ tts_platform:
type: string
{% endconfiguration %}
### {% linkable_title Home Assistant configuration %}
### Home Assistant configuration
A simple configuration just requires this. Consult [Snips.ai component](/components/snips/) for more options.
A simple configuration just requires this. Consult [Snips.ai integration](/components/snips/) for more options.
```yaml
snips:
```
### {% linkable_title Home Assistant configuration %}
### Home Assistant configuration
There is an active [discord](https://discordapp.com/invite/3939Kqx) channel for further support.
There is an active [discord](https://discordapp.com/invite/3939Kqx) channel and [Snips forum](https://forum.snips.ai/) for further support.
### {% linkable_title Examples %}
### Examples
So now you can turn lights on and off, let's check the weather. Log on to the [console](https://console.snips.ai/). If this is your first time, create a new assistant and add the Home Assistant skill, along with the Weather skill by snips. Download your assistant manually and copy it to the `/share` folder on your HassIO installation using the Samba add-on.
Next create a weather sensor, e.g., one for (Dark Sky)[/components/sensor.darksky/] and put the `api_key` in your `secrets.yaml` file.
Next create a weather sensor, e.g., one for [Dark Sky](/components/darksky/), and put the `api_key` in your `secrets.yaml` file. For this example to work you will need to have a valid API key from [Dark Sky](https://darksky.net/dev).
```yaml
- platform: darksky
@ -98,7 +98,7 @@ Next create a weather sensor, e.g., one for (Dark Sky)[/components/sensor.darksk
- temperature_min
```
Next add this to your `configuration.yaml` file to reference a new `intent_script` component. This is a good practice to [split your configuration files](/docs/configuration/splitting_configuration/) up.
Next add this to your `configuration.yaml` file to reference a new `intent_script` integration. This is a good practice to [split your configuration files](/docs/configuration/splitting_configuration/) up.
```yaml
intent_script: !include intent_script.yaml

6
source/_addons/tellstick.markdown
View File

@ -29,7 +29,7 @@ To add [lights](/components/light.tellstick/), [sensors](/components/sensor.tell
The add-on will also enable you to interact with the `tdtool` via a Home Assistant services call, see example below for self-learning device.
## {% linkable_title Examples %}
## Examples
Example for adding more devices in the add-on configuration (note the comma separator between devices):
@ -93,7 +93,7 @@ code:
For more information about the configuration including protocols, see the [telldus documentation](https://developer.telldus.com/wiki/TellStick_conf).
## {% linkable_title Service calls %}
## Service calls
If you wish to teach a self-learning device in your TellStick configuration:
@ -108,7 +108,7 @@ Replace `1` with the corresponding ID of the device in your TellStick configurat
You can also use this to list devices or sensors and read the output in the add-on log:
`{"addon":"core_tellstick","input":{"function":"list-sensors"}}`
### {% linkable_title Supported service commands %}
### Supported service commands
- `"function":"list"`: List currently configured devices with name and device id and all discovered sensors.

34
source/_components/abode.markdown
View File

@ -31,7 +31,7 @@ redirect_from:
- /components/sensor.abode/
---
The `abode` component will allow users to integrate their Abode Home Security systems into Home Assistant and use its alarm system and sensors to automate their homes.
The `abode` integration will allow users to integrate their Abode Home Security systems into Home Assistant and use its alarm system and sensors to automate their homes.
Please visit the [Abode website](https://goabode.com/) for further information about Abode Security.
@ -46,7 +46,7 @@ There is currently support for the following device types within Home Assistant:
- [**Switch**](/components/abode/#switch): Reports on `Power Switch` devices and can be used to turn the power switch on and off. Also reports on `Automations` set up in the Abode system and allows you to activate or deactivate them.
- **Sensor**: Reports on `Temperature`, `Humidity`, and `Light` sensors.
## {% linkable_title Configuration %}
## Configuration
To use Abode devices in your installation,
add the following `abode` section to your `configuration.yaml` file:
@ -88,18 +88,18 @@ polling:
exclude:
description: >
A list of devices to exclude from Home Assistant by their Abode `device_id`
or `automation_id`, found within the component attributes.
or `automation_id`, found within the integration attributes.
required: false
type: list
lights:
description: >
A list of switch devices that Home Assistant should treat as lights by the
switches Abode `device_id`, found within the component attributes.
switches Abode `device_id`, found within the integration attributes.
required: false
type: list
{% endconfiguration %}
## {% linkable_title Events %}
## Events
There are a number of events that can be triggered from Abode.
They are grouped into the below events:
@ -128,9 +128,9 @@ Field | Description
There is a unique list of known event_codes that can be found
[here](https://github.com/MisterWil/abodepy/files/1262019/timeline_events.txt).
## {% linkable_title Services %}
## Services
### {% linkable_title Service `change_setting` %}
### Service `change_setting`
Change settings on your Abode system.
For a full list of settings and valid values, consult the
@ -141,7 +141,7 @@ For a full list of settings and valid values, consult the
| `setting` | No | The setting you wish to change.
| `value` | No | The value you wish to change the setting to.
### {% linkable_title Service `capture_image` %}
### Service `capture_image`
Request a new still image from your Abode IR camera.
@ -149,7 +149,7 @@ Request a new still image from your Abode IR camera.
| ---------------------- | -------- | ----------- |
| `entity_id` | No | String or list of strings that point at `entity_id`s of Abode cameras.
### {% linkable_title Service `trigger_quick_action` %}
### Service `trigger_quick_action`
Trigger a quick action automation on your Abode system.
@ -157,18 +157,18 @@ Trigger a quick action automation on your Abode system.
| ---------------------- | -------- | ----------- |
| `entity_id` | No | String or list of strings that point at `entity_id`s of binary_sensors that represent your Abode quick actions.
### {% linkable_title Binary Sensor %}
### Binary Sensor
This component will add `Door Contacts`, `Connectivity` sensors (remotes, keypads, and status indicators), `Moisture` sensors, and `Motion` or `Occupancy` sensors.
This integration will add `Door Contacts`, `Connectivity` sensors (remotes, keypads, and status indicators), `Moisture` sensors, and `Motion` or `Occupancy` sensors.
This component will also list all Abode `Quick Actions` that are set up. You can trigger these quick actions by passing the `entity_id` of your quick action binary sensor to the [trigger_quick_action service](/components/abode/#trigger_quick_action).
This integration will also list all Abode `Quick Actions` that are set up. You can trigger these quick actions by passing the `entity_id` of your quick action binary sensor to the [trigger_quick_action service](/components/abode/#trigger_quick_action).
### {% linkable_title Light %}
### Light
This component will automatically add `Lights` configured in your Abode account. You can reclassify `Switches` to show up within Home Assistant as lights by listing the Abode device ID in your [configuration](/components/abode/#configuration).
This integration will automatically add `Lights` configured in your Abode account. You can reclassify `Switches` to show up within Home Assistant as lights by listing the Abode device ID in your [configuration](/components/abode/#configuration).
### {% linkable_title Switch %}
### Switch
This component will automatically add `Power Switches` configured in your Abode account. You can reclassify switches to show up within Home Assistant as `Lights` by listing the Abode device ID in your [configuration](/components/abode/#configuration).
This integration will automatically add `Power Switches` configured in your Abode account. You can reclassify switches to show up within Home Assistant as `Lights` by listing the Abode device ID in your [configuration](/components/abode/#configuration).
This component will also list all Abode `Automations` that are set up within the Abode system, allowing you to activate and deactivate the automations.
This integration will also list all Abode `Automations` that are set up within the Abode system, allowing you to activate and deactivate the automations.

2
source/_components/acer_projector.markdown
View File

@ -18,7 +18,7 @@ redirect_from:
The `acer_projector` switch platform allows you to control the state of RS232 connected projectors from [Acer](http://www.acer.com).
## {% linkable_title Configuration %}
## Configuration
To use your Acer Projector in your installation, add the following to your `configuration.yaml` file:

2
source/_components/actiontec.markdown
View File

@ -52,4 +52,4 @@ password:
type: string
{% endconfiguration %}
See the [device tracker component page](/components/device_tracker/) for instructions how to configure the people to be tracked.
See the [device tracker integration page](/components/device_tracker/) for instructions how to configure the people to be tracked.

18
source/_components/adguard.markdown
View File

@ -20,7 +20,7 @@ AdGuard Home is a network-wide ad-and-tracker blocking DNS server with parental
control (adult content blocking) capabilities. The `adguard` integration allows
you to control and monitor your AdGuard Home instance in Home Assistant.
## {% linkable_title Configuration via the frontend %}
## Configuration via the frontend
Menu: **Configuration** -> **Integrations**.
@ -28,7 +28,7 @@ Click on the `+` sign to add an integration and click on **AdGuard Home**.
Follow the configuration flow, after finishing, the AdGuard Home
integration will be available.
## {% linkable_title Sensors %}
## Sensors
This integration provides sensors for the following information from AdGuard Home:
@ -41,7 +41,7 @@ This integration provides sensors for the following information from AdGuard Hom
- Total number of active filter rules loaded.
- Average response time of AdGuard's DNS server in milliseconds.
## {% linkable_title Switches %}
## Switches
The integration will create a number of switches:
@ -63,7 +63,7 @@ Turning off Query Log will result in all sensors not receiving updates anymore.
AdGuard relies on Query Log to provide stats.
</p>
## {% linkable_title Services %}
## Services
These services allow one to manage filter subscriptions in AdGuard Home.
Using these services in automations could be helpful to block certain
@ -72,7 +72,7 @@ sites/domains at certain times.
For example, you could create a custom filter list blocking social media sites,
during the day and release them during the evening, using a simple automation.
### {% linkable_title Service `add_url` %}
### Service `add_url`
Add a new filter subscription to AdGuard Home.
@ -81,7 +81,7 @@ Add a new filter subscription to AdGuard Home.
| `name` | No | The name of the filter subscription. |
| `url` | No | The filter URL to subscribe to, containing the filter rules. |
### {% linkable_title Service `remove_url` %}
### Service `remove_url`
Removes a filter subscription from AdGuard Home.
@ -89,7 +89,7 @@ Removes a filter subscription from AdGuard Home.
| ---------------------- | -------- | -------------------------------------- |
| `url` | No | The filter subscription URL to remove. |
### {% linkable_title Service `enable_url` %}
### Service `enable_url`
Enables a filter subscription in AdGuard Home.
@ -97,7 +97,7 @@ Enables a filter subscription in AdGuard Home.
| ---------------------- | -------- | -------------------------------------- |
| `url` | No | The filter subscription URL to enable. |
### {% linkable_title Service `disable_url` %}
### Service `disable_url`
Disables a filter subscription in AdGuard Home.
@ -105,7 +105,7 @@ Disables a filter subscription in AdGuard Home.
| ---------------------- | -------- | --------------------------------------- |
| `url` | No | The filter subscription URL to disable. |
### {% linkable_title Service `refresh` %}
### Service `refresh`
Refresh all filter subscriptions in AdGuard Home.

16
source/_components/ads.markdown
View File

@ -34,7 +34,7 @@ There is currently support for the following device types within Home Assistant:
- [Switch](#switch)
- [Cover](#cover)
## {% linkable_title Configuration %}
## Configuration
To enable ADS, add the following lines to your `configuration.yaml` file:
@ -60,9 +60,9 @@ ip_address:
type: string
{% endconfiguration %}
## {% linkable_title Service %}
## Service
The ADS component will register the service `write_by_name` allowing you to write a value to a variable on your ADS device.
The ADS integration will register the service `write_by_name` allowing you to write a value to a variable on your ADS device.
```json
{
@ -78,7 +78,7 @@ Service parameters:
- **adstype**: Specify the type of the variable. Use one of the following: `int`, `byte`, `uint`, `bool`
- **value**: The value that will be written in the variable.
## {% linkable_title Binary Sensor %}
## Binary Sensor
The `ads` binary sensor platform can be used to monitor a boolean value on your ADS device.
@ -107,7 +107,7 @@ device_class:
type: string
{% endconfiguration %}
## {% linkable_title Light %}
## Light
The `ads` light platform allows you to control your connecte ADS lights.
@ -137,7 +137,7 @@ name:
type: string
{% endconfiguration %}
## {% linkable_title Sensor %}
## Sensor
The `ads` sensor platform allows reading the value of a numeric variable on your ADS device. The variable can be of type *INT*, *UINT*, *BYTE*, *DINT* or *UDINT*.
@ -176,7 +176,7 @@ factor:
The *factor* can be used to implement fixed decimals. E.g., set *factor* to 100 if you want to display a fixed decimal value with two decimals. A variable value of `123` will be displayed as `1.23`.
## {% linkable_title Switch %}
## Switch
The `ads` switch platform accesses a boolean variable on the connected ADS device. The variable is identified by its name.
@ -201,7 +201,7 @@ name:
type: string
{% endconfiguration %}
## {% linkable_title Cover %}
## Cover
The `ads` cover platform allows you to control your connected ADS covers.

10
source/_components/aftership.markdown
View File

@ -20,7 +20,7 @@ The `aftership` platform allows one to track deliveries by [AfterShip](https://w
The sensor value shows the number of packages that are not in `Delivered` state. As attributes are the number of packages per status.
## {% linkable_title Setup %}
## Setup
To use this sensor, you need an [AfterShip Account](https://accounts.aftership.com/register) and set up an API Key. To set up an API Key go to [AfterShip API](https://secure.aftership.com/#/settings/api) page, and copy existing key or generate a new one.
@ -28,7 +28,7 @@ To use this sensor, you need an [AfterShip Account](https://accounts.aftership.c
AfterShip recently started requiring having a credit card on file even if you are only using the free plan. That does not change the functionality of the platform, just something to be aware of.
</p>
## {% linkable_title Configuration %}
## Configuration
To enable this sensor, add the following lines to your `configuration.yaml`:
@ -50,7 +50,7 @@ api_key:
type: string
{% endconfiguration %}
## {% linkable_title Service `add_tracking` %}
## Service `add_tracking`
You can use the service `aftership.add_tracking` to add trackings to Aftership.
@ -60,7 +60,7 @@ api_key:
| `slug` | `False` | string | Carrier e.g. `fedex`
| `title` | `False` | string | Friendly name of package
## {% linkable_title Service `remove_tracking` %}
## Service `remove_tracking`
You can use the service `aftership.remove_tracking` to remove trackings from Aftership.
@ -70,5 +70,5 @@ api_key:
| `slug` | `True` | string | Carrier e.g. `fedex`
<p class='note info'>
This component retrieves data from AfterShip public REST API, but the component is not affiliated with AfterShip.
This integration retrieves data from AfterShip public REST API, but the integration is not affiliated with AfterShip.
</p>

3
source/_components/air_quality.markdown
View File

@ -7,7 +7,8 @@ sidebar: true
comments: false
sharing: true
footer: true
redirect_from: /components/air_pollutants/
redirect_from:
- /components/air_pollutants/
ha_release: 0.85
---

8
source/_components/airvisual.markdown
View File

@ -26,7 +26,7 @@ The Community API key is valid for 12 months after which it will expire. You mus
The "Community" API key is limited to 10,000 calls per month. In order to leave a buffer, the `airvisual` platform queries the API every 10 minutes (600 seconds) by default. Modification of this (via the `scan_interval` key) to a too-low value may result in your API key being deactivated.
</p>
## {% linkable_title Configuration %}
## Configuration
To enable the platform and gather data via latitude/longitude, add the following lines to your `configuration.yaml` file:
@ -80,7 +80,7 @@ country:
type: string
{% endconfiguration %}
## {% linkable_title Example Configurations %}
## Example Configurations
Configuration using custom Latitude and Longitude:
@ -111,7 +111,7 @@ sensor:
country: USA
```
## {% linkable_title Determining the City/State/Country %}
## Determining the City/State/Country
To easily determine the proper values for a particular location, use the [AirVisual region directory](https://airvisual.com/world). Once you browse to the particular city you want, take note of the breadcrumb title, which is of the form `country > state/region > city`. Use this information to fill out `configuration.yaml`.
@ -129,7 +129,7 @@ sensor:
country: brazil
```
## {% linkable_title Sensor Types %}
## Sensor Types
When configured, the platform will create three sensors for each configured air quality standard:

2
source/_components/aladdin_connect.markdown
View File

@ -22,7 +22,7 @@ The `aladdin_connect` cover platform lets you control Genie Aladdin Connect gara
Only doors that are owned by your Aladdin Connect account will be available. Doors that your account has been granted shared access to are not yet supported.
</p>
## {% linkable_title Configuration %}
## Configuration
To use your Aladdin Connect cover in your installation, add the following to your `configuration.yaml` file:

6
source/_components/alarm_control_panel.ifttt.markdown
View File

@ -15,13 +15,13 @@ ha_release: 0.66
The `ifttt` platform allows you to integrate security systems that have no open API but can be controlled through [IFTTT](https://ifttt.com/discover).
This platform depends on the [IFTTT](/components/ifttt/) Home Assistant component. See the component's documentation to set it up.
This platform depends on the [IFTTT](/components/ifttt/) Home Assistant integration. See the integrations documentation to set it up.
<p class='note'>
It is important to note that this platform fully relies on IFTTT to receive updates when the security system's state changes. Therefore, this platform shows an assumed state.
</p>
## {% linkable_title Configuration %}
## Configuration
To enable this, add the following lines to your `configuration.yaml` file:
@ -80,7 +80,7 @@ optimistic:
It is strongly discouraged to use this platform when you don't use encryption; otherwise, your API password will be send unprotected through the IFTTT Webhooks. It is advised to [setup encryption using Let's Encrypt](https://home-assistant.io/blog/2017/09/27/effortless-encryption-with-lets-encrypt-and-duckdns/).
</p>
### {% linkable_title Required IFTTT applets %}
### Required IFTTT applets
Next, you will need to set up the required IFTTT applets as listed below.

6
source/_components/alarm_control_panel.mqtt.markdown
View File

@ -16,7 +16,7 @@ ha_iot_class: Configurable
The `mqtt` alarm panel platform enables the possibility to control MQTT capable alarm panels. The Alarm icon will change state after receiving a new state from `state_topic`. If these messages are published with *RETAIN* flag, the MQTT alarm panel will receive an instant state update after subscription and will start with the correct state. Otherwise, the initial state will be `unknown`.
The component will accept the following states from your Alarm Panel (in lower case):
The integration will accept the following states from your Alarm Panel (in lower case):
- `disarmed`
- `armed_home`
@ -25,9 +25,9 @@ The component will accept the following states from your Alarm Panel (in lower c
- `pending`
- `triggered`
The component can control your Alarm Panel by publishing to the `command_topic` when a user interacts with the Home Assistant frontend.
The integration can control your Alarm Panel by publishing to the `command_topic` when a user interacts with the Home Assistant frontend.
## {% linkable_title Configuration %}
## Configuration
To enable this platform, add the following lines to your `configuration.yaml`:

16
source/_components/alarmdecoder.markdown
View File

@ -20,7 +20,7 @@ redirect_from:
- /components/sensor.alarmdecoder/
---
The `alarmdecoder` component will allow Home Assistant users who own either a DSC or Honeywell alarm panel to leverage their alarm system and its sensors to provide Home Assistant with rich information about their homes. Connectivity between Home Assistant and the alarm panel is accomplished through a device produced by Nu Tech Software Solutions, known as the AlarmDecoder. The AlarmDecoder devices provide a serial, TCP/IP socket or USB interface to the alarm panel, where it emulates an alarm keypad.
The `alarmdecoder` integration will allow Home Assistant users who own either a DSC or Honeywell alarm panel to leverage their alarm system and its sensors to provide Home Assistant with rich information about their homes. Connectivity between Home Assistant and the alarm panel is accomplished through a device produced by Nu Tech Software Solutions, known as the AlarmDecoder. The AlarmDecoder devices provide a serial, TCP/IP socket or USB interface to the alarm panel, where it emulates an alarm keypad.
Please visit the [AlarmDecoder website](https://www.alarmdecoder.com/) for further information about the AlarmDecoder devices.
@ -32,7 +32,7 @@ There is currently support for the following device types within Home Assistant:
This is a fully event-based component. Any event sent by the AlarmDecoder device will be immediately reflected within Home Assistant.
## {% linkable_title Configuration %}
## Configuration
An `alarmdecoder` section must be present in the `configuration.yaml` file and contain the following options as required:
@ -91,7 +91,7 @@ panel_display:
default: false
type: boolean
zones:
description: "AlarmDecoder has no way to tell us which zones are actually in use, so each zone must be configured in Home Assistant. For each zone, at least a name must be given. For more information on the available zone types, take a look at the [Binary Sensor](/components/binary_sensor.alarmdecoder/) docs. *Note: If no zones are specified, Home Assistant will not load any binary_sensor components.*"
description: "AlarmDecoder has no way to tell us which zones are actually in use, so each zone must be configured in Home Assistant. For each zone, at least a name must be given. For more information on the available zone types, take a look at the [Binary Sensor](/components/binary_sensor.alarmdecoder/) docs. *Note: If no zones are specified, Home Assistant will not load any binary_sensor integrations.*"
required: false
type: list
keys:
@ -122,7 +122,7 @@ zones:
type: integer
{% endconfiguration %}
## {% linkable_title Alarm Control Panel %}
## Alarm Control Panel
There are several attributes available on the alarm panel to give you more information about your alarm.
@ -136,9 +136,9 @@ There are several attributes available on the alarm panel to give you more infor
- `ready`: Set to `true` if your system is ready to be armed. Any faults, including motions sensors, will make this value `false`.
- `zone_bypassed`: Set to `true` if your system is currently bypassing a zone.
## {% linkable_title Services %}
## Services
The Alarm Decoder component gives you access to several services for you to control your alarm with.
The Alarm Decoder integration gives you access to several services for you to control your alarm with.
- `alarm_arm_away`: Arms the alarm in away mode; all faults will trigger the alarm.
- `alarm_arm_home`: Arms the alarm in stay mode; faults to the doors or windows will trigger the alarm.
@ -150,11 +150,11 @@ The Alarm Decoder component gives you access to several services for you to cont
`alarm_arm_custom_bypass` and `alarm_trigger`, while available in the services list in Home Assistant, are not currently implemented in the Alarm Decoder platform.
</p>
### {% linkable_title Examples %}
### Examples
Using a combination of the available services and attributes, you can create switch templates.
### {% linkable_title Chime Status and Control %}
### Chime Status and Control
{% raw %}
```yaml

2
source/_components/alarmdotcom.markdown
View File

@ -17,7 +17,7 @@ redirect_from:
The `alarmdotcom` platform is consuming the information provided by [Alarm.com](https://www.alarm.com/).
## {% linkable_title Configuration %}
## Configuration
To enable this, add the following lines to your `configuration.yaml`:

24
source/_components/alert.markdown
View File

@ -14,8 +14,8 @@ ha_release: 0.38
ha_qa_scale: internal
---
The `alert` component is designed to notify you when problematic issues arise.
For example, if the garage door is left open, the `alert` component can be used
The `alert` integration is designed to notify you when problematic issues arise.
For example, if the garage door is left open, the `alert` integration can be used
remind you of this by sending you repeating notifications at customizable
intervals. This is also used for low battery sensors,
water leak sensors, or any condition that may need your attention.
@ -23,10 +23,10 @@ water leak sensors, or any condition that may need your attention.
Alerts will add an entity to the front end only when they are firing.
This entity allows you to silence an alert until it is resolved.
### {% linkable_title Basic Example %}
### Basic Example
The `alert` component makes use of any of the `notifications` components. To
setup the `alert` component, first, you must setup a `notification` component.
The `alert` integration makes use of any of the `notifications` integrations. To
setup the `alert` integration, first, you must setup a `notification` integration.
Then, add the following to your configuration file:
```yaml
@ -97,7 +97,7 @@ done_message:
required: false
type: template
notifiers:
description: "List of `notification` components to use for alerts."
description: "List of `notification` integrations to use for alerts."
required: true
type: list
data:
@ -143,9 +143,9 @@ alert:
- john_phone_sms
```
### {% linkable_title Complex Alert Criteria %}
### Complex Alert Criteria
By design, the `alert` component only handles very simple criteria for firing.
By design, the `alert` integration only handles very simple criteria for firing.
That is, it only checks if a single entity's state is equal to a value. At some
point, it may be desirable to have an alert with a more complex criteria.
Possibly, when a battery percentage falls below a threshold. Maybe you want to
@ -159,7 +159,7 @@ binary_sensor:
- platform: template
sensors:
motion_battery_low:
value_template: '{{ states.sensor.motion.attributes.battery < 15 }}'
value_template: '{{ state_attr('sensor.motion', 'battery') < 15 }}'
friendly_name: 'Motion battery is low'
alert:
@ -177,7 +177,7 @@ This example will begin firing as soon as the entity `sensor.motion`'s `battery`
attribute falls below 15. It will continue to fire until the battery attribute
raises above 15 or the alert is acknowledged on the frontend.
### {% linkable_title Dynamic Notification Delay Times %}
### Dynamic Notification Delay Times
It may be desirable to have the delays between alert notifications dynamically
change as the alert continues to fire. This can be done by setting the `repeat`
@ -208,7 +208,7 @@ following notification.
For example, if the garage door opens at 2:00, a notification will be
sent at 2:15, 2:45, 3:45, 4:45, etc., continuing every 60 minutes.
### {% linkable_title Message Templates %}
### Message Templates
It may be desirable to have the alert notifications include information
about the state of the entity. [Templates](/docs/configuration/templating/)
@ -237,7 +237,7 @@ alert:
The resulting message could be `Plant Officeplant needs help (moisture low)`.
### {% linkable_title Additional parameters for notifiers %}
### Additional parameters for notifiers
Some notifiers support more parameters (e.g., to set text color or action
buttons). These can be supplied via the `data` parameter:

8
source/_components/alexa.flash_briefings.markdown
View File

@ -14,11 +14,11 @@ featured: false
ha_release: "0.31"
---
## {% linkable_title Flash Briefing Skills %}
## Flash Briefing Skills
As of version [0.31][zero-three-one] Home Assistant supports the new [Alexa Flash Briefing Skills API][flash-briefing-api]. A Flash Briefing Skill adds a new Flash Briefing source that is generated by Home Assistant.
### {% linkable_title Requirements %}
### Requirements
Amazon requires the endpoint of a skill to be hosted via SSL. Self-signed certificates are OK because our skills will only run in development mode. Read more on [our blog][blog-lets-encrypt] about how to set up encryption for Home Assistant. When running Hass.io, using the [Let's Encrypt](/addons/lets_encrypt/) and [Duck DNS](/addons/duckdns/) add-ons is the easiest method. If you are unable to get HTTPS up and running, consider using [this AWS Lambda proxy for Alexa skills](https://community.home-assistant.io/t/aws-lambda-proxy-custom-alexa-skill-when-you-dont-have-https/5230).
@ -30,7 +30,7 @@ Additionally, note that at the time of this writing, your Alexa skill endpoint *
[blog-lets-encrypt]: /blog/2015/12/13/setup-encryption-using-lets-encrypt/
### {% linkable_title Configuring a Flash Briefing skill in Home Assistant %}
### Configuring a Flash Briefing skill in Home Assistant
You can use [templates] for the `title`, `audio`, `text` and `display_url` configuration parameters.
@ -56,7 +56,7 @@ You can add multiple items for a feed if you want. The Amazon required UID and t
Please refer to the [Amazon documentation][flash-briefing-api-docs] for more information about allowed configuration parameters and formats.
### {% linkable_title Configuring your Flash Briefing skill %}
### Configuring your Flash Briefing skill
- Log in to [Amazon developer console][amazon-dev-console]
- Click the Alexa navigation tab at the top of the console

20
source/_components/alexa.intent.markdown
View File

@ -14,15 +14,15 @@ featured: false
ha_release: "0.10"
---
## {% linkable_title I want to build custom commands to use with Echo %}
## I want to build custom commands to use with Echo
The built-in Alexa component allows you to integrate Home Assistant into Alexa/Amazon Echo. This component will allow you to query information and call services within Home Assistant by using your voice. Home Assistant offers no built-in sentences but offers a framework for you to define your own.
The built-in Alexa integration allows you to integrate Home Assistant into Alexa/Amazon Echo. This integration will allow you to query information and call services within Home Assistant by using your voice. Home Assistant offers no built-in sentences but offers a framework for you to define your own.
<div class='videoWrapper'>
<iframe width="560" height="315" src="https://www.youtube.com/embed/1Ke3mtWd_cQ" frameborder="0" allowfullscreen></iframe>
</div>
### {% linkable_title Requirements %}
### Requirements
Amazon requires the endpoint of a skill to be hosted via SSL. Self-signed certificates are OK because our skills will only run in development mode. Read more on [our blog][blog-lets-encrypt] about how to set up encryption for Home Assistant. When running Hass.io, using the [Let's Encrypt](/addons/lets_encrypt/) and [Duck DNS](/addons/duckdns/) add-ons is the easiest method. If you are unable to get HTTPS up and running, consider using [this AWS Lambda proxy for Alexa skills](https://community.home-assistant.io/t/aws-lambda-proxy-custom-alexa-skill-when-you-dont-have-https/5230).
@ -49,7 +49,7 @@ To get started with Alexa skills:
You can use this [specially sized Home Assistant logo][large-icon] as the large icon and [this one][small-icon] as the small one.
### {% linkable_title Configuring your Amazon Alexa skill %}
### Configuring your Amazon Alexa skill
Alexa works based on intents. Each intent has a name and variable slots. For example, a `LocateIntent` with a slot that contains a `User`. Example intent schema:
@ -88,9 +88,9 @@ This means that we can now ask Alexa things like:
- Alexa, ask Home Assistant where Paul is
- Alexa, ask Home Assistant where we are
## {% linkable_title Configuring Home Assistant %}
## Configuring Home Assistant
When activated, the Alexa component will have Home Assistant's native intent support handle the incoming intents. If you want to run actions based on intents, use the [`intent_script`](/components/intent_script) component.
When activated, the Alexa integration will have Home Assistant's native intent support handle the incoming intents. If you want to run actions based on intents, use the [`intent_script`](/components/intent_script) integration.
To enable Alexa, add the following entry to your `configuration.yaml` file:
@ -98,7 +98,7 @@ To enable Alexa, add the following entry to your `configuration.yaml` file:
alexa:
```
### {% linkable_title Working With Scenes %}
### Working With Scenes
One of the most useful applications of Alexa integrations is to call scenes directly. This is easily achieved with some simple setup on the Home Assistant side and by letting Alexa know which scenes you want to run.
@ -157,7 +157,7 @@ Here we are using [templates] to take the name we gave to Alexa e.g., `downstair
Now say `Alexa ask Home Assistant to activate <some scene>` and Alexa will activate that scene for you.
### {% linkable_title Adding Scripts %}
### Adding Scripts
We can easily extend the above idea to work with scripts as well. As before, add an intent for scripts:
@ -203,7 +203,7 @@ intent_script:
Now say `Alexa ask Home Assistant to run <some script>` and Alexa will run that script for you.
### {% linkable_title Support for Launch Requests %}
### Support for Launch Requests
There may be times when you want to respond to a launch request initiated from a command such as "Alexa, Red Alert!".
@ -227,7 +227,7 @@ intent_script:
text: OK
```
## {% linkable_title Giving Alexa Some Personality %}
## Giving Alexa Some Personality
In the examples above, we told Alexa to say `OK` when she successfully completed the task. This is effective but a little dull! We can again use [templates] to spice things up a little.

8
source/_components/alexa.markdown
View File

@ -14,22 +14,22 @@ featured: true
ha_release: "0.10"
---
## {% linkable_title Automatic setup via Home Assistant Cloud %}
## Automatic setup via Home Assistant Cloud
With [Home Assistant Cloud](/cloud/), you can connect your Home Assistant instance in a few simple clicks to Amazon Alexa. With Home Assistant Cloud you don't have to deal with dynamic DNS, SSL certificates or opening ports on your router. Just log in via the user interface and a secure connection with the cloud will be established. Home Assistant Cloud requires a paid subscription after a 30-day free trial.
For Home Assistant Cloud Users, documentation can be found [here](https://www.nabucasa.com/config/amazon_alexa/).
## {% linkable_title Manual setup %}
## Manual setup
There are a few ways that you can use Amazon Alexa and Home Assistant together.
- [Build custom commands to use](/components/alexa.intent/)
- [Create a new Flash Briefing source](/components/alexa.flash_briefings/)
- [Use the Smart Home API to control lights, etc](/components/alexa.smart_home/)
- Alternative: use the [Emulated Hue component][emulated-hue-component] to trick Alexa to thinking Home Assistant is a Philips Hue hub.
- Alternative: use the [Emulated Hue integration][emulated-hue-component] to trick Alexa to thinking Home Assistant is a Philips Hue hub.
### {% linkable_title Requirements %}
### Requirements
Manual setup the integration with Amazon Alexa needs several requirements

26
source/_components/alexa.smart_home.markdown
View File

@ -14,12 +14,12 @@ featured: false
ha_release: "0.54"
---
## {% linkable_title Amazon Alexa Smart Home %}
## Amazon Alexa Smart Home
While the Skills API described above allows for arbitrary intents, all
utterances must begin with "Alexa, tell $invocation_name ..."
The [Emulated Hue component][emulated-hue-component] provides a simpler
The [Emulated Hue integration][emulated-hue-component] provides a simpler
interface such as, "Alexa, turn on the kitchen light". However, it has some
limitations since everything looks like a light bulb.
@ -38,13 +38,13 @@ With [Home Assistant Cloud](/cloud/), you can connect your Home Assistant instan
For Home Assistant Cloud Users, documentation can be found [here](https://www.nabucasa.com/config/amazon_alexa/).
</p>
### {% linkable_title Requirements %}
### Requirements
- Amazon Developer Account. You can sign on [here](https://developer.amazon.com).
- An [AWS account](https://aws.amazon.com/free/) is need if you want to use Smart Home Skill API. Part of your Smart Home Skill will be hosted on [AWS Lambda](https://aws.amazon.com/lambda/pricing/). However you don't need worry the cost, AWS Lambda allow free to use up to 1 millions requests and 1GB outbound data transfer per month.
- Smart Home API also needs your Home Assistant instance can be accessed from Internet. We strongly suggest you host HTTPS server and use validation certificate. Read more on [our blog](/blog/2015/12/13/setup-encryption-using-lets-encrypt/) about how to set up encryption for Home Assistant. When running Hass.io, using the [Let's Encrypt](/addons/lets_encrypt/) and [Duck DNS](/addons/duckdns/) add-ons is the easiest method.
### {% linkable_title Create Your Amazon Alexa Smart Home Skill %}
### Create Your Amazon Alexa Smart Home Skill
- Sign in [Alexa Developer Console][alexa-dev-console], you can create your free account on the sign in page.
- Go to `Alexa Skills` page if you are not, click `Create Skill` button to start the process.
@ -56,9 +56,9 @@ For Home Assistant Cloud Users, documentation can be found [here](https://www.na
- In next screen, make sure *v3* is selected in `Payload version`.
- Now, you have created a skeleton of Smart Home skill. Next step we will do some "real" developer work. You can keep Alex Developer Console opened, we need change the skill configuration later.
### {% linkable_title Create Your Lambda Function %}
### Create Your Lambda Function
Alexa Smart Home skill will trigger a AWS Lambda function to process the request, we will write a small piece of code hosted as an Lambda function basically redirect the request to your Home Assistant instance, then Alexa integration component in Home Assistant will process the request and send back the response. Your Lambda function will delivery the response back to Alexa.
Alexa Smart Home skill will trigger a AWS Lambda function to process the request, we will write a small piece of code hosted as an Lambda function basically redirect the request to your Home Assistant instance, then Alexa integration integration in Home Assistant will process the request and send back the response. Your Lambda function will delivery the response back to Alexa.
<p class='info'>
There already are some great tutorials and solutions in our community to achieve same goal "Create your Alexa Smart Home Skill to connect Home Assistant", for example: [Haaska](https://github.com/mike-grant/haaska/wiki).
@ -70,7 +70,7 @@ Amazon also provided a [step-by-step guide](https://developer.amazon.com/docs/sm
OK, let's go. You first need sign in your [AWS console](https://console.aws.amazon.com/), if you don't have an AWS account yet, you can create a new user [here](https://aws.amazon.com/free/) with 12-month free tire benefit. You don't need worry the cost if your account already pass the first 12 months, AWS provides up to 1 million Lambda request, 1GB outbound data and all inbound data for free, every month, all users. See [Lambda pricing](https://aws.amazon.com/lambda/pricing/) for details.
#### {% linkable_title Create an IAM Role for Lambda %}
#### Create an IAM Role for Lambda
First thing you need to do after sing in [AWS console](https://console.aws.amazon.com/) is to create an IAM Role for Lambda execution. AWS has very strict access control, you have to specific define and assign the permissions.
@ -83,7 +83,7 @@ First thing you need to do after sing in [AWS console](https://console.aws.amazo
- You can skip `Add tags` page, click `Next: Review`.
- Give your new role a name, such as `AWSLambdaBasicExecutionRole-SmartHome`, then click `Create role` button. You should be able to find your new role in the roles list now.
#### {% linkable_title Create a Lambda function and add code %}
#### Create a Lambda function and add code
Next you need create a Lambda function.
@ -111,7 +111,7 @@ Next you need create a Lambda function.
- Now scroll up to the top, click `Save` button.
- You need copy the ARN displayed in the top of the page, which is the identify of this Lambda function. You will need this ARN to continue Alexa Smart Home skill configuration later.
#### {% linkable_title Test the Lambda function %}
#### Test the Lambda function
Now, you have created the Lambda function, before you can test it, you have to set up your Home Assistant. Put following minimal configuration to your configuration.yaml, it will exposures all of your supported device and automation to Alexa. Check the [configuration section](#alexa-component-configuration) if you want more control of the exposure.
@ -150,7 +150,7 @@ Now, you can login to your Home Assistant and [generate a long-lived access toke
This time, you will get a list of your devices as the response. 🎉
### {% linkable_title Config the Smart Home Service Endpoint %}
### Config the Smart Home Service Endpoint
Now removed the long-lived access token if you want, copied the ARN of your Lambda function, then back to [Alexa Developer Console][alexa-dev-console]. You will finish the configuration of the Smart Home skill.
@ -159,7 +159,7 @@ Now removed the long-lived access token if you want, copied the ARN of your Lamb
- Click `SMART HOME` in the left navigation bar of build page.
- Fill in `Default endpoint` under `2. Smart Home service endpoint` using the `ARN` you copied from your Lambda function configuration.
### {% linkable_title Account Linking %}
### Account Linking
Alexa can link your Amazon account to your Home Assistant account. Therefore Home Assistant can make sure only authenticated Alexa request be able to access your home's devices. In order to link the account, you have to make sure your Home Assistant can be accessed from Internet.
@ -193,7 +193,7 @@ Alexa can link your Amazon account to your Home Assistant account. Therefore Hom
* You can discovery your devices now.
- Now, you can ask your Echo or in Alexa App, *turn on bedroom* 🎉
### {% linkable_title Alexa Component Configuration %}
### Alexa Component Configuration
Example configuration:
@ -226,7 +226,7 @@ The `endpoint`, `client_id` and `client_secret` are optional, and are only requi
- If the "Send Alexa Events" permission was not enabled previously, you need to unlink and relink the skill using the Alexa App, or else Home Assistant will show the following error: "Token invalid and no refresh token available."
### {% linkable_title Alexa web-based app %}
### Alexa web-based app
The following is a list of regions and the corresponding URL for the web-based Alexa app:

4
source/_components/alpha_vantage.markdown
View File

@ -78,11 +78,11 @@ foreign_exchange:
type: string
{% endconfiguration %}
## {% linkable_title Examples %}
## Examples
In this section you find some real-life examples of how to use this sensor.
### {% linkable_title Google and the exchange rate for Bitcoin %}
### Google and the exchange rate for Bitcoin
```yaml
sensor:

6
source/_components/amazon_polly.markdown
View File

@ -18,13 +18,13 @@ redirect_from:
The `amazon_polly` text-to-speech platform that works with [Amazon Polly](https://aws.amazon.com/polly/) to create the spoken output.
Polly is a paid service via Amazon Web Services. There is a [free tier](https://aws.amazon.com/polly/pricing/) for the first 12 months and then a charge per million characters afterwards.
## {% linkable_title Setup %}
## Setup
For more information, please read the [AWS General Reference regarding Security Credentials](http://docs.aws.amazon.com/general/latest/gr/aws-security-credentials.html) to get the needed details. Also, check the [boto3 Documentation](http://boto3.readthedocs.io/en/latest/guide/configuration.html#shared-credentials-file) about the profiles and the [AWS Regions and Endpoints Reference](https://docs.aws.amazon.com/general/latest/gr/rande.html#pol_region) for available regions.
Available voices are listed in the [Amazon Documentation](http://docs.aws.amazon.com/polly/latest/dg/voicelist.html).
## {% linkable_title Configuration %}
## Configuration
To get started, add the following lines to your `configuration.yaml` (example for Amazon Polly):
@ -79,7 +79,7 @@ sample_rate:
default: 22050 for MP3 and Ogg Vorbis, 16000 for pcm
{% endconfiguration %}
## {% linkable_title Usage %}
## Usage
Say to all `media_player` device entities:

2
source/_components/ambiclimate.markdown
View File

@ -42,7 +42,7 @@ client_secret:
Note that you have to select manual mode from the Ambiclimate app to be able to control the A/C from Home Assistant.
## {% linkable_title Component services %}
## Component services
Enable comfort mode on your AC:

8
source/_components/ambient_station.markdown
View File

@ -14,16 +14,16 @@ redirect_from:
- /components/sensor.ambient_station/
---
The `Ambient Weather Station` component retrieves local weather information
The `Ambient Weather Station` integration retrieves local weather information
via personal weather stations from [Ambient Weather](https://ambientweather.net).
## {% linkable_title Setup %}
## Setup
Using this component requires both an Application Key and an API Key. To
Using this integration requires both an Application Key and an API Key. To
generate both, simply utilize the profile section of
[your Ambient Weather dashboard](https://dashboard.ambientweather.net).
## {% linkable_title Configuration %}
## Configuration
To add your Ambient Weather PWS to your Home Assistant installation, add the
following to your `configuration.yaml` file:

20
source/_components/amcrest.markdown
View File

@ -31,7 +31,7 @@ There is currently support for the following device types within Home Assistant:
- Sensor
- Switch (deprecated)
## {% linkable_title Configuration %}
## Configuration
To enable your camera in your installation, add the following to your `configuration.yaml` file:
@ -175,9 +175,9 @@ Newer Amcrest firmware may not work, then **rtsp** is recommended instead.
make sure to follow the steps mentioned at [FFMPEG](/components/ffmpeg/)
documentation to install the `ffmpeg`.
## {% linkable_title Services %}
## Services
Once loaded, the `amcrest` component will expose services that can be called to perform various actions. The `entity_id` service attribute can specify one or more specific cameras, or `all` can be used to specify all configured Amcrest cameras.
Once loaded, the `amcrest` integration will expose services that can be called to perform various actions. The `entity_id` service attribute can specify one or more specific cameras, or `all` can be used to specify all configured Amcrest cameras.
Available services:
`enable_audio`, `disable_audio`,
@ -186,7 +186,7 @@ Available services:
`goto_preset`, `set_color_bw`,
`start_tour` and `stop_tour`
#### {% linkable_title Service `enable_audio`/`disable_audio` %}
#### Service `enable_audio`/`disable_audio`
These services enable or disable the camera's audio stream.
@ -194,7 +194,7 @@ Service data attribute | Optional | Description
-|-|-
`entity_id` | no | Name(s) of entities, e.g., `camera.living_room_camera`.
#### {% linkable_title Service `enable_motion_recording`/`disable_motion_recording` %}
#### Service `enable_motion_recording`/`disable_motion_recording`
These services enable or disable the camera to record a clip to its configured storage location when motion is detected.
@ -202,7 +202,7 @@ Service data attribute | Optional | Description
-|-|-
`entity_id` | no | Name(s) of entities, e.g., `camera.living_room_camera`.
#### {% linkable_title Service `enable_recording`/`disable_recording` %}
#### Service `enable_recording`/`disable_recording`
These services enable or disable the camera to continuously record to its configured storage location.
@ -210,7 +210,7 @@ Service data attribute | Optional | Description
-|-|-
`entity_id` | no | Name(s) of entities, e.g., `camera.living_room_camera`.
#### {% linkable_title Service `goto_preset` %}
#### Service `goto_preset`
This service will cause the camera to move to one of the PTZ locations configured within the camera.
@ -219,7 +219,7 @@ Service data attribute | Optional | Description
`entity_id` | no | Name(s) of entities, e.g., `camera.living_room_camera`.
`preset` | no | Preset number, starting from 1.
#### {% linkable_title Service `set_color_bw` %}
#### Service `set_color_bw`
This service will set the color mode of the camera.
@ -228,7 +228,7 @@ Service data attribute | Optional | Description
`entity_id` | no | Name(s) of entities, e.g., `camera.living_room_camera`.
`color_bw` | no | One of `auto`, `bw` or `color`.
#### {% linkable_title Service `start_tour`/`stop_tour` %}
#### Service `start_tour`/`stop_tour`
These services start or stop the camera's PTZ tour function.
@ -236,7 +236,7 @@ Service data attribute | Optional | Description
-|-|-
`entity_id` | no | Name(s) of entities, e.g., `camera.living_room_camera`.
## {% linkable_title Advanced Configuration %}
## Advanced Configuration
You can also use this more advanced configuration example:

4
source/_components/ampio.markdown
View File

@ -17,11 +17,11 @@ ha_iot_class: "Cloud Polling"
The `ampio` air quality platform will query the open data API of [ampio.pl](http://smog1.ampio.pl:3050/) to monitor air quality sensor station.
## {% linkable_title Setup %}
## Setup
To get the ID of a station you need to contact Ampio directly.
## {% linkable_title Manual Configuration %}
## Manual Configuration
To enable this platform, add the following lines to your `configuration.yaml` file:

20
source/_components/android_ip_webcam.markdown
View File

@ -23,7 +23,7 @@ redirect_from:
- /components/switch.android_ip_webcam/
---
The `android_ip_webcam` component turns any Android phone or tablet into a network camera with multiple viewing options.
The `android_ip_webcam` integration turns any Android phone or tablet into a network camera with multiple viewing options.
It's setup as an MJPEG camera and all settings as switches inside of Home Assistant. You can also expose the sensors. If you have multiple phones, you can use all options inside a list.
@ -34,11 +34,11 @@ There is currently support for the following device types within Home Assistant:
- Sensor
- Switch
## {% linkable_title Setup %}
## Setup
Download [the IP Webcam app](https://play.google.com/store/apps/details?id=com.pas.webcam) and launch the app. When you press 'Start Server', it will start streaming video from your phone and the IP address of the device will be shown on screen.
## {% linkable_title Configuration %}
## Configuration
To set up the component, add the following information to your `configuration.yaml` file:
@ -134,7 +134,7 @@ motion_sensor:
You need to enable logging in the Android app (`Data logging` > `Enable data logging`), if you wish to see the sensor states in Home Assistant. The sensor states stays as `unknown`, until it's enabled.
</p>
## {% linkable_title Full example %}
## Full example
```yaml
# Example configuration.yaml entry
@ -170,11 +170,11 @@ android_ip_webcam:
- torch
```
## {% linkable_title Binary Sensor %}
## Binary Sensor
The `android_ip_webcam` binary sensor platform lets you observe the motion state of [Android IP webcam](https://play.google.com/store/apps/details?id=com.pas.webcam) sensors through Home Assistant. Devices will be configured automatically.
## {% linkable_title Examples %}
## Examples
You can also setup the binary motion sensor with the following script:
@ -191,11 +191,11 @@ binary_sensor:
{% endraw %}
## {% linkable_title Camera %}
## Camera
The `android_ip_webcam` component adds a camera by default if you choose not to use the component but still want to see the video feed then the [`mjpeg` camera](/components/camera.mjpeg/) platform can be used.
The `android_ip_webcam` integration adds a camera by default if you choose not to use the integration but still want to see the video feed then the [`mjpeg` camera](/components/camera.mjpeg/) platform can be used.
## {% linkable_title Configuration %}
## Configuration
To enable only the camera in your installation, add the following to your `configuration.yaml` file:
@ -206,7 +206,7 @@ camera:
mjpeg_url: http://IP_ADDRESS:8080/video
```
## {% linkable_title Sensor %}
## Sensor
The `android_ip_webcam` sensor platform lets you observe states of [Android IP webcam](https://play.google.com/store/apps/details?id=com.pas.webcam) sensors through Home Assistant. Devices will be configured automatically.

26
source/_components/androidtv.markdown
View File

@ -18,7 +18,7 @@ redirect_from:
The `androidtv` platform allows you to control an Android TV device or [Amazon Fire TV](https://www.amazon.com/b/?node=8521791011) device.
## {% linkable_title Device preparation %}
## Device preparation
To set up your device, you will need to find its IP address and enable ADB debugging. For Android TV devices, please consult the documentation for your device.
@ -32,7 +32,7 @@ For Fire TV devices, the instructions are as follows:
- From the main (Launcher) screen, select Settings.
- Select System > About > Network.
## {% linkable_title Configuration %}
## Configuration
```yaml
# Example configuration.yaml entry
@ -108,7 +108,7 @@ turn_off_command:
type: string
{% endconfiguration %}
### {% linkable_title Full Configuration %}
### Full Configuration
```yaml
# Example configuration.yaml entry
@ -135,23 +135,23 @@ media_player:
get_sources: false
```
## {% linkable_title ADB Setup %}
## ADB Setup
This component works by sending ADB commands to your Android TV / Fire TV device. There are two ways to accomplish this:
This integration works by sending ADB commands to your Android TV / Fire TV device. There are two ways to accomplish this:
### {% linkable_title 1. ADB Server %}
### 1. ADB Server
You can use an ADB server to connect to your Android TV and Fire TV devices.
For Hass.io users, you can install the [Android Debug Bridge](https://github.com/hassio-addons/addon-adb/blob/master/README.md) addon. Using this approach, Home Assistant will send the ADB commands to the server, which will then send them to the Android TV / Fire TV device and report back to Home Assistant. To use this option, add the `adb_server_ip` option to your configuration. If you are running the server on the same machine as Home Assistant, you can use `127.0.0.1` for this value.
### {% linkable_title 2. Python ADB Implementation %}
### 2. Python ADB Implementation
The second option is to connect to your device using the `adb` Python package.
If your device requires ADB authentication, you will need to follow the instructions in the [ADB Authentication](#adb-authentication) section below. Once you have an authenticated key, this approach does not require any additional setup or addons. However, users with newer devices may find that the ADB connection is unstable. For a Fire TV device, you can try setting the `get_sources` configuration option to `false`. If the problem cannot be resolved, you should use the ADB server option.
#### {% linkable_title ADB Authentication %}
#### ADB Authentication
If you get a "Device authentication required, no keys available" error when trying to set up your Android TV or Fire TV, then you'll need to create an adbkey and add its path to your configuration. Follow the instructions on this page to connect to your device from your computer: [Connecting to Fire TV Through adb](https://developer.amazon.com/zh/docs/fire-tv/connecting-adb-to-device.html).
@ -166,7 +166,7 @@ Once you've successfully connected to your Android TV / Fire TV via the command
Copy the `adbkey` file to your Home Assistant folder and add the path to the `adbkey` file to your configuration.
## {% linkable_title ADB Troubleshooting %}
## ADB Troubleshooting
If you receive the error message `Error while setting up platform androidtv` in your log when trying to set up an Android TV or Fire TV device, then there is probably an issue with your ADB connection. Here are some possible causes.
@ -180,13 +180,13 @@ If you receive the error message `Error while setting up platform androidtv` in
* Your key is not pre-authenticated. Before using the `adbkey` in Home Assistant, you _**must**_ connect to your device using the ADB binary and tell it to always allow connections from this computer. For more information, see the section [ADB Authentication](#adb-authentication) above.
* Home Assistant does not have the appropriate permissions for the `adbkey` file and so it is not able to use it. Once you fix the permissions, the component should work.
* Home Assistant does not have the appropriate permissions for the `adbkey` file and so it is not able to use it. Once you fix the permissions, the integration should work.
4. Some Android TV devices (e.g., Philips TVs running Android TV) only accept the initial ADB connection request over their Wi-Fi interface. If you have the TV wired, you need to connect it to WiFi and try the initial connection again. Once the authentication has been granted via Wi-Fi, you can connect to the TV over the wired interface as well.
## {% linkable_title Services %}
## Services
### {% linkable_title `media_player.select_source` %}
### `media_player.select_source`
For Fire TV devices, you can launch an app using the `media_player.select_source` command. Simply provide the app ID as the `source`. You can also stop an app by prefixing the app ID with a `!`. For example, you could define [scripts](/docs/scripts) to start and stop Netflix as follows:
@ -206,7 +206,7 @@ stop_netflix:
source: '!com.netflix.ninja'
```
### {% linkable_title `androidtv.adb_command` %}
### `androidtv.adb_command`
The service `androidtv.adb_command` allows you to send either keys or ADB shell commands to your Android TV / Fire TV device. If there is any output, it will be stored in the `'adb_response'` attribute (i.e., `state_attr('media_player.android_tv_living_room', 'adb_response')` in a template) and logged at the INFO level.

2
source/_components/anthemav.markdown
View File

@ -18,7 +18,7 @@ redirect_from:
Both [Anthem]'s current and last generation of A/V Receivers and Processors support IP-based, network control. This Home Assistant platform adds proper "local push" support for any of these receivers on your network.
## {% linkable_title Supported Models %}
## Supported Models
* MRX 520, MRX 720, MRX 1120, and AVM 60
* MRX 310, MRX 510, MRX 710

18
source/_components/apcupsd.markdown
View File

@ -26,13 +26,13 @@ There is currently support for the following device types within Home Assistant:
- [Binary Sensor](#binary-sensor)
- [Sensor](#sensor)
## {% linkable_title Hass.io Installation %}
## Hass.io Installation
Install this [unofficial add-on](https://github.com/korylprince/hassio-apcupsd/) to use this integration with Hass.io. Keep in mind that we can't give you support for this add-on.
After installation, follow the instructions on the Github page to configure the plugin. Then continue to follow the integration configurations below.
## {% linkable_title Configuration %}
## Configuration
To enable this sensor, add the following lines to your `configuration.yaml`:
@ -58,13 +58,13 @@ port:
If you get `ConnectionRefusedError: Connection refused` errors in the Home assistant logs, ensure the [APCUPSd](http://www.apcupsd.org/) configuration directives used by its Network Information Server is set to permit connections from all addresses [NISIP 0.0.0.0](http://www.apcupsd.org/manual/manual.html#configuration-directives-used-by-the-network-information-server), else non-local addesses will not connect. This includes Hass.io running in Docker, even when hosted on the same machine or a virtual machine.
</p>
## {% linkable_title Binary sensor %}
## Binary sensor
In addition to the [APCUPSd Sensor](#sensor) devices, you may also create a device which is simply "on" when the UPS status is online and "off" at all other times.
### {% linkable_title Configuration %}
### Configuration
To enable this sensor, you first have to set up apcupsd component (above), and add the following lines to your `configuration.yaml` file:
To enable this sensor, you first have to set up apcupsd integration (above), and add the following lines to your `configuration.yaml` file:
```yaml
# Example configuration.yaml entry
@ -80,13 +80,13 @@ name:
default: UPS Online Status
{% endconfiguration %}
## {% linkable_title Sensor %}
## Sensor
The `apcupsd` sensor platform allows you to monitor a UPS (battery backup) by using data from the [apcaccess](http://linux.die.net/man/8/apcaccess) command.
### {% linkable_title Configuration %}
### Configuration
To use this sensor platform, you first have to set up apcupsd component (above), and add the following to your `configuration.yaml` file:
To use this sensor platform, you first have to set up apcupsd integration (above), and add the following to your `configuration.yaml` file:
```yaml
# Example configuration.yaml entry
@ -104,7 +104,7 @@ resources:
type: list
{% endconfiguration %}
### {% linkable_title Example %}
### Example
Given the following output from `apcaccess`:

2
source/_components/api.markdown
View File

@ -14,7 +14,7 @@ ha_qa_scale: internal
ha_release: 0.7
---
The `api` component exposes a RESTful API and allows one to interact with a Home Assistant instance that is running headless. This component depends on the [`http` component](/components/http/).
The `api` integration exposes a RESTful API and allows one to interact with a Home Assistant instance that is running headless. This integration depends on the [`http` integration](/components/http/).
<p class='note warning'>
It is HIGHLY recommended that you set the `api_password`, especially if you are planning to expose your installation to the internet.

8
source/_components/apns.markdown
View File

@ -17,11 +17,11 @@ redirect_from:
The `apns` platform uses the Apple Push Notification service (APNS) to deliver notifications from Home Assistant.
## {% linkable_title Setup %}
## Setup
To use the APNS service you will need an Apple developer account and you will need to create an app to receive push notifications. For more information, see the Apple developer documentation.
## {% linkable_title Configuration %}
## Configuration
To enable APNS notifications, add the following lines to your `configuration.yaml`:
@ -56,13 +56,13 @@ sandbox:
The APNS platform will register two services, `notify.NOTIFIER_NAME` and `notify.apns_NOTIFIER_NAME`.
### {% linkable_title notify.apns_NOTIFIER_NAME %}
### notify.apns_NOTIFIER_NAME
This service will register device IDs with Home Assistant. In order to receive a notification a device must be registered. The app on the device can use this service to send an ID to Home Assistant during startup, the ID will be stored in `[NOTIFIER_NAME]_apns.yaml`.
See `didRegisterForRemoteNotificationsWithDeviceToken` in the [Apple developer documentation](https://developer.apple.com/library/ios/documentation/UIKit/Reference/UIApplicationDelegate_Protocol/#//apple_ref/occ/intfm/UIApplicationDelegate/application:didRegisterForRemoteNotificationsWithDeviceToken:) for more information about how to obtain a device ID.
### {% linkable_title notify.NOTIFIER_NAME %}
### notify.NOTIFIER_NAME
This service will send messages to a registered device. The following parameters can be used:

18
source/_components/apple_tv.markdown
View File

@ -30,7 +30,7 @@ There is currently support for the following device types within Home Assistant:
Currently, you must have Home Sharing enabled for this to work. Support for pairing Home Assistant with your device will be supported in a later release.
</p>
## {% linkable_title Configuration %}
## Configuration
To use this component, you must first install some system libraries and a compiler. For Debian or a similar system, this should be enough:
@ -80,9 +80,9 @@ credentials:
In order to connect to the device, you need a *login id*. The easiest way to obtain this identifier is to use the `apple_tv_scan` service (described below). Additional information about `start_off` and `credentials` can also be found under the guides section.
## {% linkable_title Guides %}
## Guides
### {% linkable_title Scanning for devices %}
### Scanning for devices
Make sure Home Sharing is enabled on the Apple TV.
@ -110,7 +110,7 @@ Note: You must use 'pair' with devices that have home sharing disabled
Just copy and paste the `login_id` from the device you want to add. For more details about `atvremote`, see: [this page](http://pyatv.readthedocs.io/en/master/atvremote.html).
### {% linkable_title Setting up device authentication %}
### Setting up device authentication
If you, when playing media with `play_url`, get the following error message:
@ -140,7 +140,7 @@ apple_tv:
Restart Home Assistant, and you should now be able to use `play_url` as before.
### {% linkable_title My Apple TV turns on when I restart Home Assistant %}
### My Apple TV turns on when I restart Home Assistant
The Apple TV will automatically turn on if a request is sent to it, e.g., if a button is pressed, something is streamed to it via AirPlay or if current state (currently playing) is accessed. This is how Apple has designed it, and it will cause problems if you are using HDMI CEC. Every time Home Assistant is started, a new request is sent to the device to figure out what is currently playing. When using CEC, this will wake up your TV and other devices you have configured.
@ -158,9 +158,9 @@ To put a device into fake standby when starting Home Assistant, add `start_off:
Turning the device on/off in the user interface will *not* turn the physical device on/off according to the description above.
</p>
## {% linkable_title Services %}
## Services
### {% linkable_title Service `apple_tv_authenticate` %}
### Service `apple_tv_authenticate`
To play media on an Apple TV with device authentication enabled (e.g., ATV4 with tvOS 10.2+), Home Assistant must be properly authenticated. This method starts the process and presents the credentials needed for playback as a persistent notification. Please see guide above for usage.
@ -168,11 +168,11 @@ To play media on an Apple TV with device authentication enabled (e.g., ATV4 with
| ---------------------- | -------- | ----------- |
| `entity_id` | yes | String or list of strings that point at `entity_id`s of Apple TVs.
### {% linkable_title Service `apple_tv_scan` %}
### Service `apple_tv_scan`
Scans the local network for Apple TVs. All found devices are presented as a persistent notification.
## {% linkable_title Remote %}
## Remote
The `apple_tv` remote platform allows you to send remote control buttons to an Apple TV. It is automatically setup when an Apple TV is configured.

4
source/_components/aprs.markdown
View File

@ -13,9 +13,9 @@ ha_category: Presence Detection
ha_iot_class: Cloud Push
---
The `aprs` [(Automatic Packet Reporting System)](https://en.wikipedia.org/wiki/Automatic_Packet_Reporting_System) device tracker component connects to the [APRS-IS](http://aprs-is.net/) network for tracking amateur radio devices.
The `aprs` [(Automatic Packet Reporting System)](https://en.wikipedia.org/wiki/Automatic_Packet_Reporting_System) device tracker integration connects to the [APRS-IS](http://aprs-is.net/) network for tracking amateur radio devices.
## {% linkable_title Configuration %}
## Configuration
To enable APRS tracking in Home Assistant, add the following section to `configuration.yaml`:

10
source/_components/aqualogic.markdown
View File

@ -19,16 +19,16 @@ redirect_from:
- /components/switch.aqualogic/
---
The AquaLogic component provides connectivity to a Hayward/Goldline AquaLogic/ProLogic pool controller. Note that an RS-485 to Ethernet adapter connected to the pool controller is required.
The AquaLogic integration provides connectivity to a Hayward/Goldline AquaLogic/ProLogic pool controller. Note that an RS-485 to Ethernet adapter connected to the pool controller is required.
There is currently support for the following device types within Home Assistant:
- [Sensor](#sensor)
- [Switch](#switch)
## {% linkable_title Configuration %}
## Configuration
To add the AquaLogic component to your installation, add the following to your `configuration.yaml` file:
To add the AquaLogic integration to your installation, add the following to your `configuration.yaml` file:
```yaml
# Example configuration.yaml entry
@ -48,7 +48,7 @@ port:
type: int
{% endconfiguration %}
## {% linkable_title Sensor %}
## Sensor
Once you have enabled the AquaLogic component, add the following to your `configuration.yaml` file:
@ -87,7 +87,7 @@ monitored_conditions:
description: The current system status.
{% endconfiguration %}
## {% linkable_title Switch %}
## Switch
Once you have enabled the AquaLogic component, add the following to your `configuration.yaml` file:

103
source/_components/arcam_fmj.markdown Normal file
View File

@ -0,0 +1,103 @@
---
layout: page
title: "Arcam FMJ Receivers"
description: "Instructions on how to integrate Arcam FMJ Receivers into Home Assistant."
date: 2019-04-28 13:59 +0200
sidebar: true
comments: false
sharing: true
footer: true
logo: arcam.svg
ha_category: Media Player
ha_release: 0.96
ha_iot_class: Local Polling
---
The `arcam_fmj` integration allows you to control [Arcam FMJ Receveivers](https://www.arcam.co.uk/range/fmj.htm) from Home Assistant.
Supported devices:
- AVR 380
- AVR 450
- AVR 750
- Likely other AVRs
## Configuration
To add an Arcam FMJ to your installation, add the following to your `configuration.yaml` file:
```yaml
# Minimal example configuration.yaml entry
arcam_fmj:
- host: HOSTNAME
zone:
1:
```
{% configuration %}
host:
description: IP address or hostname of the device.
required: true
type: string
port:
description: Port to connect to.
required: false
default: 50000
type: integer
zone:
description: Per zone specific configuration
type: map
keys:
ZONE_INDEX:
name:
description: Name of zone
required: false
type: string
default: Arcam FMJ - ZONE_INDEX
turn_on:
description: Service to use when turning on device when no connection is established
required: false
type: action
{% endconfiguration %}
```yaml
# Larger example configuration.yaml entry
media_player:
- platform: arcam_fmj
host: HOSTNAME
zone:
1:
name: "Zone 1 name"
turn_on:
service: 'broadlink.send'
data:
host: BROADLINK_IR_IP
packet: JgAVADodHTo6HR0dHR0dOh0dHR06Oh0dHQ0FAA==
2:
name: "Zone 2 name"
turn_on:
service: 'broadlink.send'
data:
host: BROADLINK_IR_IP
packet: JgAYADodHTo6Oh0dHR0dHR0dHR06Oh0dHQALZw0FAAAAAAAAAAAAAAAAAAA=
```
## Power state
Arcam FMJ receivers turn off their network port when in standby, the component will try to
reconnect to the receiver every 5 seconds. This mean powering on the first zone is not
possible over the builtin network connection. Two options for complete power control
exists: IR or Serial gateway.
### IR command
Use an IR blaster to send a command to turn the device on using these discrete codes:
- Zone 1: Protocol: NEC1 Device: 16 Function: 123
- Zone 2: Protocol: NEC1 Device: 23 Function: 123
### Serial Port to network gateway
Use a network to a serial port gateway to connect to the serial port of the
receiver. The serial port is always available and can power on the device.
This is the most reliable communication method as well.

8
source/_components/arduino.markdown
View File

@ -25,14 +25,14 @@ The equipment depends on the [type](https://www.arduino.cc/en/Main/Products) of
There are a lot of extensions (so-called [shields](https://www.arduino.cc/en/Main/ArduinoShields)) available. Those shields can be plugged-in into the existing connectors and stacked on top of each other. This makes it possible to expand the capabilities of the Arduino boards.
The `arduino` component is designed to let you use a directly attached board to your Home Assistant host over USB.
The `arduino` integration is designed to let you use a directly attached board to your Home Assistant host over USB.
There is currently support for the following device types within Home Assistant:
- [Sensor](#sensor)
- [Switch](#switch)
## {% linkable_title Configuration %}
## Configuration
You need to have the [Firmata firmware](https://github.com/firmata/) on your board. Please upload the `StandardFirmata` sketch to your board; please refer to the [Arduino documentation](https://www.arduino.cc/en/Main/Howto) for further information.
@ -69,7 +69,7 @@ Add the user who is used to run Home Assistant to the groups to allow access to
$ sudo usermod -a -G dialout,lock $USER
```
## {% linkable_title Sensor %}
## Sensor
The `arduino` sensor platform allows you to get numerical values from an analog input pin of an [Arduino](https://www.arduino.cc/) board. Usually the value is between 0 and 1024.
@ -104,7 +104,7 @@ pins:
The 6 analog pins of an Arduino UNO are numbered from A0 to A5.
## {% linkable_title Switch %}
## Switch
The `arduino` switch platform allows you to control the digital pins of your [Arduino](https://www.arduino.cc/) board. Support for switching pins is limited to high/on and low/off of the digital pins. PWM (pin 3, 5, 6, 9, 10, and 11 on an Arduino Uno) is not supported yet.

6
source/_components/arest.markdown
View File

@ -27,7 +27,7 @@ There is currently support for the following device types within Home Assistant:
- [Sensor](#sensor)
- [Switch](#switch)
## {% linkable_title Binary Sensor %}
## Binary Sensor
The `arest` binary sensor platform allows you to get all data from your devices (like Arduinos with an ethernet/wifi connection, the ESP8266, and the Raspberry Pi) running the [aREST](http://arest.io/) RESTful framework.
@ -78,7 +78,7 @@ binary_sensor:
This sensor is not suitable for fast state changes because there is a high possibility that the change took place between two update cycle.
</p>
## {% linkable_title Sensor %}
## Sensor
The `arest` sensor platform allows you to get all data from your devices (like Arduinos with a Ethernet/Wifi connection, the ESP8266, and the Raspberry Pi) running the [aREST](http://arest.io/) RESTful framework.
@ -181,7 +181,7 @@ The root will give you a JSON response that contains all variables and their cur
{"return_value": 34, "id": "sensor02", "name": "livingroom", "connected": true}
```
## {% linkable_title Switch %}
## Switch
The `arest` switch platform allows you to toggle pins of your devices (like Arduino boards with an Ethernet/Wifi connection, ESP8266 based devices, and the Raspberry Pi) running the [aREST](http://arest.io/) RESTful framework.

20
source/_components/arlo.markdown
View File

@ -29,7 +29,7 @@ There is currently support for the following device types within Home Assistant:
- [Camera](#camera)
- [Sensor](#sensor)
## {% linkable_title Configuration %}
## Configuration
To enable device linked in your [Arlo](https://arlo.netgear.com/) account, add the following to your `configuration.yaml` file:
@ -59,7 +59,7 @@ It is recommended to create a dedicated user on Arlo website to be used within H
Finish its configuration by visiting the [Arlo sensor page](/components/sensor.arlo/) or [Arlo camera page](/components/camera.arlo/) or [Arlo control panel page](/components/alarm_control_panel.arlo/). Arlo also has a service call `arlo.update` that can be manually called to force an update prior to the regular scheduled interval.
The Arlo component also provides a camera service to enable/disable the motion detection sensor. The example below enables the motion detection every time the Home Assistant service starts.
The Arlo integration also provides a camera service to enable/disable the motion detection sensor. The example below enables the motion detection every time the Home Assistant service starts.
```yaml
#automation.yaml
@ -73,9 +73,9 @@ The Arlo component also provides a camera service to enable/disable the motion d
entity_id: camera.arlo_frontdoor
```
## {% linkable_title Alarm %}
## Alarm
### {% linkable_title Configuration %}
### Configuration
Once you have enabled the [Arlo component](/components/arlo), add the following to your `configuration.yaml` file:
@ -102,7 +102,7 @@ night_mode_name:
default: "`Armed` mode in Arlo"
{% endconfiguration %}
### {% linkable_title Examples %}
### Examples
These examples are based on an Arlo base station named `my_arlo_base_station`. Replace this with the name of your base station's `entity_id`.
@ -140,11 +140,11 @@ You can also completely disarm the Arlo base station by calling the `alarm_contr
More examples and configuration options can be found on the [Manual Alarm Control page](/components/alarm_control_panel.manual/#examples).
## {% linkable_title Camera %}
## Camera
This component is not yet able to live stream from your Arlo camera, but it will be able to playback the last video capture.
This integration is not yet able to live stream from your Arlo camera, but it will be able to playback the last video capture.
### {% linkable_title Configuration %}
### Configuration
Once you have enabled the [Arlo component](/components/arlo), add the following to your `configuration.yaml` file:
@ -164,13 +164,13 @@ ffmpeg_arguments:
**Note:** To be able to playback the last capture, it is required to install the `ffmpeg` component. Make sure to follow the steps mentioned at [FFMPEG](/components/ffmpeg/) documentation.
## {% linkable_title Sensor %}
## Sensor
To get your [Arlo](https://arlo.netgear.com/) sensors working within Home Assistant, please follow the instructions for the general [Arlo component](/components/arlo).
This platform does not support Arlo Q.
### {% linkable_title Configuration %}
### Configuration
Once you have enabled the [Arlo component](/components/arlo), add the following to your `configuration.yaml` file:

2
source/_components/aruba.markdown
View File

@ -52,4 +52,4 @@ password:
type: string
{% endconfiguration %}
See the [device tracker component page](/components/device_tracker/) for instructions how to configure the people to be tracked.
See the [device tracker integration page](/components/device_tracker/) for instructions how to configure the people to be tracked.

2
source/_components/arwn.markdown
View File

@ -17,7 +17,7 @@ redirect_from:
The `arwn` sensor platform is a client for the [Ambient Radio Weather Network](http://github.com/sdague/arwn) project. This collects weather station data and makes it available in an MQTT subtree.
To use your ARWN setup, you must already have configured the [MQTT](mqtt) platform. Then add the following to your `configuration.yaml` file:
To use your ARWN setup, you must already have configured the [MQTT](/components/mqtt/) platform. Then add the following to your `configuration.yaml` file:
```yaml
# Example configuration.yaml entry

2
source/_components/asterisk_cdr.markdown
View File

@ -15,4 +15,4 @@ redirect_from:
- /components/mailbox.asterisk_cdr/
---
The Asterisk Call Data Recorder provides access to Asterisk call logs on the Asterisk PBX server. This mailbox is enabled automatically through the [Asterisk Voicemail component](/components/asterisk_mbox/) configuration if the `asterisk_mbox_server` is configured to provide CDR data. More information on configuring the server can be found in the [Asterisk PBX configuration guide](/docs/asterisk_mbox/).
The Asterisk Call Data Recorder provides access to Asterisk call logs on the Asterisk PBX server. This mailbox is enabled automatically through the [Asterisk Voicemail integration](/components/asterisk_mbox/) configuration if the `asterisk_mbox_server` is configured to provide CDR data. More information on configuring the server can be found in the [Asterisk PBX configuration guide](/docs/asterisk_mbox/).

6
source/_components/asterisk_mbox.markdown
View File

@ -16,13 +16,13 @@ redirect_from:
- /components/mailbox.asterisk_mbox/
---
The `asterisk_mbox` Asterisk Voicemail integration for Home Assistant allows you to view, listen to, and delete voicemails from an Asterisk voicemail mailbox. The component includes a panel on the frontend that provides caller-id and speech-to-text transcription (using Google's API) of messages in addition to playback and message deletion. There is also an included sensor that indicates of the number of available messages. There is no requirement that the Asterisk PBX and Home Assistant are running on the same machine.
The `asterisk_mbox` Asterisk Voicemail integration for Home Assistant allows you to view, listen to, and delete voicemails from an Asterisk voicemail mailbox. The integration includes a panel on the frontend that provides caller-id and speech-to-text transcription (using Google's API) of messages in addition to playback and message deletion. There is also an included sensor that indicates of the number of available messages. There is no requirement that the Asterisk PBX and Home Assistant are running on the same machine.
To enable the component, a configuration is required in both Home Assistant as well as on the Asterisk server.
First follow the [Asterisk PBX configuration guide](/docs/asterisk_mbox/) to setup the necessary server on the Asterisk PBX server (this is needed even if Asterisk and Home Assistant are running on the same server)
## {% linkable_title Configuration %}
## Configuration
Once that is complete, add the following entry `configuration.yaml` file:
@ -52,5 +52,5 @@ port:
{% endconfiguration %}
<p class='note warning'>
Communication between the Asterisk PBX server and the Home Assistant server is password-protected, but the data transmission is not encrypted. It is recommended to only use this component when communication is contained within a local area network.
Communication between the Asterisk PBX server and the Home Assistant server is password-protected, but the data transmission is not encrypted. It is recommended to only use this integration when communication is contained within a local area network.
</p>

10
source/_components/asuswrt.markdown
View File

@ -19,14 +19,14 @@ redirect_from:
- /components/sensor.asuswrt/
---
The `asuswrt` component is the main component to connect to a [ASUSWRT](http://event.asus.com/2013/nw/ASUSWRT/) based router.
The `asuswrt` integration is the main integration to connect to a [ASUSWRT](http://event.asus.com/2013/nw/ASUSWRT/) based router.
There is currently support for the following device types within Home Assistant:
- **Presence Detection** - The asuswrt platform offers presence detection by looking at connected devices to a ASUSWRT based router.
- **Sensor** - The asuswrt sensor platform allows you to get upload and download data from your ASUSWRT within Home Assistant.
## {% linkable_title Configuration %}
## Configuration
To use an ASUSWRT router in your installation, add the following to your `configuration.yaml` file:
@ -93,7 +93,7 @@ sensors:
You need to [enable telnet](https://www.asus.com/support/faq/1005449/) on your router if you choose to use `protocol: telnet`.
</p>
### {% linkable_title Example Sensor Configuration %}
### Example Sensor Configuration
To enable ASUSWRT sensors as part of your installation, reference the following example configuration:
@ -118,9 +118,9 @@ The example above, creates the following sensors:
- sensor.asuswrt_upload_speed (unit_of_measurement: Mbit/s)
## {% linkable_title Padavan custom firmware (The rt-n56u project) %}
## Padavan custom firmware (The rt-n56u project)
The [rt-n56u project](https://bitbucket.org/padavan/rt-n56u) does not store `dnsmasq.leases` which is used to track devices at `/var/lib/misc/` as `asuswrt` do. However this component can still be used for the rt-n56u project by linking `dnsmasq.leases` during the boot process of the router.
The [rt-n56u project](https://bitbucket.org/padavan/rt-n56u) does not store `dnsmasq.leases` which is used to track devices at `/var/lib/misc/` as `asuswrt` do. However this integration can still be used for the rt-n56u project by linking `dnsmasq.leases` during the boot process of the router.
Follow these steps to setup the link.

8
source/_components/august.markdown
View File

@ -21,7 +21,7 @@ redirect_from:
- /components/lock.august/
---
The `august` component allows you to integrate your [August](http://august.com) devices in Home Assistant.
The `august` integration allows you to integrate your [August](http://august.com) devices in Home Assistant.
There is currently support for the following device types within Home Assistant:
@ -34,7 +34,7 @@ There is currently support for the following device types within Home Assistant:
August Lock 2nd Gen will need either August Connect or Doorbell to connect to Home Assistant.
</p>
## {% linkable_title Configuration %}
## Configuration
You will need your August login information (username (either phone# or email), and password) to use this module.
@ -70,7 +70,7 @@ timeout:
Once Home Assistant is started, a configurator will pop up asking you to enter verification code that is sent to your phone number or email.
### {% linkable_title Binary Sensor %}
### Binary Sensor
If you have August Doorbell, once you have enabled the August component, you should see following sensors:
@ -82,6 +82,6 @@ If you have August Smart Lock with DoorSense, once you have enabled the August c
- Door sensor
### {% linkable_title Camera %}
### Camera
The `august` camera platform allows you to view the latest camera image (triggered by motion) by your [August](http://august.com) device in Home Assistant.

4
source/_components/aurora.markdown
View File

@ -21,7 +21,7 @@ This service gives a number 0-100 representing the current likelihood of visible
You can check the attributes of the sensor to see your exact forecast.
## {% linkable_title Configuration %}
## Configuration
To add the aurora binary sensor to your installation, add the following to your `configuration.yaml` file:
@ -44,7 +44,7 @@ name:
default: Aurora Visibility
{% endconfiguration %}
## {% linkable_title Full example %}
## Full example
```yaml
binary_sensor:

65
source/_components/aurora_abb_powerone.markdown Normal file
View File

@ -0,0 +1,65 @@
---
layout: page
title: "Aurora ABB Powerone PV Inverter Sensor"
description: "Instructions on how to integrate an Aurora ABB Powerone solar inverter within Home Assistant."
date: 2019-06-27 23:30
sidebar: true
comments: false
sharing: true
footer: true
logo: powerone.png
ha_category:
- Sensor
- Energy
ha_release: 0.96
ha_iot_class: Local Polling
---
This implements a direct RS485 connection to a solar inverter in the
PVI-3.0/3.6/4.2-TL-OUTD ABB series, and may work on others.
The inverter was formerly made by PowerOne who got taken over by ABB.
The TCP/IP method of communicating with inverters is supported by the
Python library, but not by this implementation in this integration.
This integration provides a single sensor which reports the live power output
in watts.
Note the PV inverter will be unresponsive to communications when in darkness,
so the value 'unknown' will be displayed during the night.
## Configuration
Add the following to your `configuration.yaml` file:
```yaml
# Example configuration.yaml entry
sensor:
- platform: aurora_abb_powerone
device: 'SERIAL_PORT'
```
{% configuration %}
device:
description: The serial port your RS485 adaptor is connected to.
required: true
type: string
address:
description: The address of the inverter - only need to set this if you have changed your inverter away from the default address of 2.
required: false
type: integer
default: 2
name:
description: Name of the sensor to use in the frontend.
required: false
default: Solar PV
type: string
{% endconfiguration %}
```yaml
# Example configuration.yaml entry for aurora_abb_powerone platform
sensor:
- platform: aurora_abb_powerone
address: 2
device: '/dev/serial/by-id/usb-FTDI_FT232R_USB_UART_A50285BI-if00-port0'
```

6
source/_components/auth.markdown
View File

@ -1,7 +1,7 @@
---
layout: page
title: "Auth"
description: "This component is responsible for providing the authentication endpoints."
description: "This integration is responsible for providing the authentication endpoints."
date: 2018-03-19 21:04
sidebar: true
comments: false
@ -14,5 +14,5 @@ ha_release: 0.73
ha_qa_scale: internal
---
This component creates the endpoints for the [authentication system](/docs/authentication/) that is built into Home Assistant.
There are no configuration options for this component directly as it relies on the auth system in the core.
This integration creates the endpoints for the [authentication system](/docs/authentication/) that is built into Home Assistant.
There are no configuration options for this integration directly as it relies on the auth system in the core.

6
source/_components/automatic.markdown
View File

@ -19,13 +19,13 @@ redirect_from:
The `automatic` device tracker platform offers presence detection by retrieving your car's information from the [Automatic](http://automatic.com/) cloud service.
## {% linkable_title Setup %}
## Setup
To use Automatic with Home Assistant, first you must [create a free development account](https://developer.automatic.com/). Automatic will generate a Client ID and Secret for you to use in your Home Assistant configuration. You will need to update your Event Delivery preferences to ensure Home Assistant can receive updates. On the developer page, under App Settings / Event Delivery, select "Websocket" for Event Delivery Preference. Next, specify the OAuth Redirect URL in the developer page. This should be configured to `<home-assistant-url>/api/automatic/callback`. (Example: `http://hassio.local:8123/api/automatic/callback`) Note that this URL only needs to be accessible from the browser you use to perform the authentication.
Home Assistant can also take advantage of `scope:current_location` if available. This will allow Home Assistant to receive periodic location updates during a trip. In order to use this functionality, you must request the scope for your application from Automatic. Once `scope:current_location` is available, change `current_location` to `true` in your configuration.yaml.
## {% linkable_title Configuration %}
## Configuration
Once your developer account is created, add the following to your `configuration.yaml` file:
@ -80,4 +80,4 @@ automation:
You can obtain the correct ID for your vehicle from your known_devices.yaml file. Be sure to lower-case any letters contained in your vehicle's ID when using it in an automation trigger.
</p>
See the [device tracker component page](/components/device_tracker/) for instructions how to configure the cars to be tracked.
See the [device tracker integration page](/components/device_tracker/) for instructions how to configure the cars to be tracked.

6
source/_components/avion.markdown
View File

@ -18,7 +18,7 @@ redirect_from:
Support for the Avi-on Bluetooth dimmer switch [Avi-On](http://avi-on.com/).
## {% linkable_title Setup %}
## Setup
If you want to add your devices manually (like in the example below) then you need to get the API key. The API key can be obtained by executing the following command:
@ -30,7 +30,7 @@ $ curl -X POST -H "Content-Type: application/json" \
with the email and password fields replaced with those used when registering the device via the mobile app. The pass phrase field of the output should be used as the API key in the configuration.
## {% linkable_title Configuration %}
## Configuration
To enable these lights, add the following lines to your `configuration.yaml` file:
@ -70,7 +70,7 @@ devices:
type: string
{% endconfiguration %}
## {% linkable_title Full example %}
## Full example
If username and password are not supplied, devices must be configured manually like so:

4
source/_components/awair.markdown
View File

@ -20,7 +20,7 @@ The `awair` sensor platform will fetch data from your [Awair device(s)](https://
You will need to request access to the Awair API and obtain an access token from the Awair [Developer Console](https://developer.getawair.com/).
## {% linkable_title Configuring the Platform %}
## Configuring the Platform
To enable these sensors, add the following lines to your `configuration.yaml` file:
@ -58,7 +58,7 @@ devices:
type: string
{% endconfiguration %}
## {% linkable_title Available Sensors %}
## Available Sensors
The platform will fetch all available sensors from each Awair device linked to your account. Supported sensors:

22
source/_components/aws.markdown
View File

@ -15,17 +15,17 @@ ha_release: "0.91"
The `aws` integration provides a single place to interact with [Amazon Web Services](https://aws.amazon.com/). Currently it provides a notification platform that can send a message to [AWS SQS](https://aws.amazon.com/sqs/), [AWS SNS](https://aws.amazon.com/sns/), or invoke [AWS Lambda](https://aws.amazon.com/lambda/) functions.
## {% linkable_title Setup %}
## Setup
You have to have an AWS account to use Amazon Web Services, create one [here](https://aws.amazon.com/free/) with a 12 months free tier benefit. Please note, even in the first 12-months, you may still be billed if you use more resources than offered in the free tier. We advise you to monitor your costs in the [AWS Billing Console](https://console.aws.amazon.com/billing/) closely. You can read the [Control your AWS costs](https://aws.amazon.com/getting-started/tutorials/control-your-costs-free-tier-budgets/) guide for more information.
The `lambda`, `sns` and `sqs` services, used in the `aws` component, all provide an **Always Free** tier for all users even after the 12-month period. The general usage in Home Automation will most likely not reach the free tier limit. Please read [Lambda Pricing](https://aws.amazon.com/lambda/pricing/), [SNS Pricing](https://aws.amazon.com/sns/pricing/) and [SQS Pricing](https://aws.amazon.com/sqs/pricing/) for more details.
The `aws` component is using [botocore](https://botocore.amazonaws.com/v1/documentation/api/latest/index.html) to communicate with Amazon Web Services, which is also used by the [AWS Command Client Interface](https://aws.amazon.com/cli/) tool. Therefore, `aws` shares the same credential and profiles with `awscli` tool. Please read [Configuring the AWS CLI](https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-configure.html) to learn how to get access keys and how to manage them on your local system securely.
The `aws` integration is using [botocore](https://botocore.amazonaws.com/v1/documentation/api/latest/index.html) to communicate with Amazon Web Services, which is also used by the [AWS Command Client Interface](https://aws.amazon.com/cli/) tool. Therefore, `aws` shares the same credential and profiles with `awscli` tool. Please read [Configuring the AWS CLI](https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-configure.html) to learn how to get access keys and how to manage them on your local system securely.
## {% linkable_title Configuration %}
## Configuration
To use the `aws` component and the `notify` platform in your installation, add the following to your `configuration.yaml` file:
To use the `aws` integration and the `notify` platform in your installation, add the following to your `configuration.yaml` file:
```yaml
# Example configuration.yaml entry
@ -35,12 +35,12 @@ aws:
aws_access_key_id: AWS_ID
aws_secret_access_key: AWS_SECRET
notify:
# use the first credential defined in aws component by default
# use the first credential defined in aws integration by default
- service: lambda
region_name: us-east-1
```
### {% linkable_title Configuration for credentials %}
### Configuration for credentials
{% configuration %}
name:
@ -66,7 +66,7 @@ validate:
type: boolean
{% endconfiguration %}
### {% linkable_title Configuration for notify %}
### Configuration for notify
{% configuration %}
service:
@ -104,7 +104,7 @@ context:
type: string
{% endconfiguration %}
## {% linkable_title Lambda Notify Usage %}
## Lambda Notify Usage
AWS Lambda is a notification platform and thus can be controlled by calling the `notify` service [as described here](/components/notify/). It will invoke a Lambda for all targets given in the notification payload. A target can be formatted as a function name, an entire ARN ([Amazon Resource Name](http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html)) or a partial ARN. For more information, please see the [botocore docs](https://botocore.amazonaws.com/v1/documentation/api/latest/reference/services/lambda.html#Lambda.Client.invoke).
@ -132,13 +132,13 @@ The context will look like this:
}
```
## {% linkable_title SNS Notify Usage %}
## SNS Notify Usage
AWS SNS is a notification platform and thus can be controlled by calling the `notify` service [as described here](/components/notify/). It will publish a message to all targets given in the notification payload. A target must be a SNS topic or endpoint ARN ([Amazon Resource Name](http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html)). For more information, please see the [botocore docs](https://botocore.amazonaws.com/v1/documentation/api/latest/reference/services/sns.html#SNS.Client.publish).
If one exists, the SNS Subject will be set to the title. All attributes from the payload, except the message, will be sent as stringified message attributes.
### {% linkable_title Setting up SNS within AWS %}
### Setting up SNS within AWS
- Log into your AWS console and under "Security and Identity", select "Identity & Access Management".
- On the left-hand side, select "Users" then click "Create New Users". Enter a name here and then click "Create".
@ -158,7 +158,7 @@ If one exists, the SNS Subject will be set to the title. All attributes from the
- Repeat for additional numbers.
- Back in the "Users" section you will see a long alphanumeric line that starts with "arn:" and ends with the Topic Name you choose previously. This is what your "target" in Home Assistant will be.
## {% linkable_title SQS Notify Usage %}
## SQS Notify Usage
AWS SQS is a notification platform and thus can be controlled by calling the `notify` service [as described here](/components/notify/). It will publish a message to the queue for all targets given in the notification payload. A target must be a SQS topic URL. For more information, please see the [SQS docs](http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/ImportantIdentifiers.html) and [bototcore docs](https://botocore.amazonaws.com/v1/documentation/api/latest/reference/services/sqs.html#SQS.Client.send_message)

8
source/_components/axis.markdown
View File

@ -24,7 +24,7 @@ redirect_from:
Home Assistant will automatically discover their presence on your network.
## {% linkable_title Configuration %}
## Configuration
For configuration go to the `Integrations pane` on your Home Assistant instance.
@ -32,11 +32,11 @@ For configuration go to the `Integrations pane` on your Home Assistant instance.
It is recommended that you create a user on your Axis device specifically for Home Assistant. For all current functionality, it is enough to create a user belonging to user group viewer.
</p>
## {% linkable_title Troubleshooting discovery %}
## Troubleshooting discovery
If your device is not discovered. On your camera, go to **System Options** -> **Advanced** -> **Plain Config**. Change the drop-down box to `network` and click `Select Group`. If `Network Interface I0 ZeroConf` contains the `169.x.x.x` IP address, unchecked the box next to `Enabled` for this section and click `Save`.
## {% linkable_title Binary Sensor %}
## Binary Sensor
The following sensor types are supported:
@ -46,7 +46,7 @@ The following sensor types are supported:
- Day/night mode
- Inputs and Supervised Inputs
## {% linkable_title Switch %}
## Switch
The following controllable port types are supported:

10
source/_components/azure_event_hub.markdown
View File

@ -13,9 +13,9 @@ ha_category:
ha_release: 0.94
---
The `Azure Event Hub` component allows you to hook into the Home Assistant event bus and send events to [Azure Event Hub](https://azure.microsoft.com/en-us/services/event-hubs/) or to a [Azure IoT Hub](https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-devguide-messages-read-builtin).
The `Azure Event Hub` integration allows you to hook into the Home Assistant event bus and send events to [Azure Event Hub](https://azure.microsoft.com/en-us/services/event-hubs/) or to a [Azure IoT Hub](https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-devguide-messages-read-builtin).
## {% linkable_title First time setup %}
## First time setup
This assumes you already have a Azure account. Otherwise create a Free account [here](https://azure.microsoft.com/en-us/free/).
@ -23,9 +23,9 @@ You need to create a Event Hub namespace and a Event Hub in that namespace, you
You must then create a Shared Access Policy for the Event Hub with 'Send' claims or use the RootManageAccessKey from your namespace (this key has additional claims, including managing the event hub and listening, which are not needed for this purpose), for more details on the security of Event Hubs [go here](https://docs.microsoft.com/en-us/azure/event-hubs/event-hubs-authentication-and-security-model-overview).
Once you have the name of your namespace, instance, Shared Access Policy and the key for that policy, you can setup the component itself.
Once you have the name of your namespace, instance, Shared Access Policy and the key for that policy, you can setup the integration itself.
## {% linkable_title Configuration %}
## Configuration
Add the following lines to your `configuration.yaml` file:
@ -92,7 +92,7 @@ filter:
Event Hubs have a retention time of at most 7 days, if you do not capture or use the events they are deleted automatically from the Event Hub, the default retention is 1 day.
</p>
### {% linkable_title Using the data in Azure %}
### Using the data in Azure
There are a number of ways to stream the data that comes into the Event Hub into storages in Azure, the easiest way is to use the built-in Capture function and this allows you to capture the data in Azure Blob Storage or Azure Data Lake store, [details here](https://docs.microsoft.com/en-us/azure/event-hubs/event-hubs-capture-overview).

2
source/_components/baidu.markdown
View File

@ -17,7 +17,7 @@ redirect_from:
The `baidu` text-to-speech platform uses [Baidu TTS engine](https://cloud.baidu.com/product/speech/tts) to read a text with natural sounding voices.
## {% linkable_title Configuration %}
## Configuration
To get started, add the following lines to your `configuration.yaml`:

4
source/_components/bayesian.markdown
View File

@ -21,7 +21,7 @@ The `bayesian` binary sensor platform observes the state from multiple sensors a
This allows for the detection of complex events that may not be readily observable, e.g., cooking, showering, in bed, the start of a morning routine, etc. It can also be used to gain greater confidence about events that _are_ directly observable, but for which the sensors can be unreliable, e.g., presence.
## {% linkable_title Configuration %}
## Configuration
To enable the Bayesian sensor, add the following lines to your `configuration.yaml`:
@ -90,7 +90,7 @@ observations:
type: string
{% endconfiguration %}
## {% linkable_title Full examples %}
## Full examples
The following is an example for the `state` observation platform.

12
source/_components/bbb_gpio.markdown
View File

@ -19,14 +19,14 @@ redirect_from:
- /components/switch.bbb_gpio/
---
The `bbb_gpio` component is the base for all [BeagleBone Black](https://beagleboard.org/black) related GPIO platforms in Home Assistant.
There is no setup needed for the component itself.
The `bbb_gpio` integration is the base for all [BeagleBone Black](https://beagleboard.org/black) related GPIO platforms in Home Assistant.
There is no setup needed for the integration itself.
## {% linkable_title Binary Sensor %}
## Binary Sensor
The `bbb_gpio` binary sensor platform allows you to read sensor values of the GPIOs of your [BeagleBone Black](https://beagleboard.org/black).
## {% linkable_title Configuration %}
## Configuration
To use your BeagleBone Black's GPIO in your installation, add the following to your `configuration.yaml` file:
@ -75,11 +75,11 @@ pins:
For more details about the GPIO layout, visit the [article](http://elinux.org/Beagleboard:BeagleBoneBlack) about the BeagleBone Black.
## {% linkable_title Switch %}
## Switch
The `bbb_gpio` switch platform allows you to control the GPIOs of your [BeagleBone Black](https://beagleboard.org/black).
## {% linkable_title Configuration %}
## Configuration
To use your BeagleBone Black's GPIO in your installation, add the following to your `configuration.yaml` file:

8
source/_components/bbox.markdown
View File

@ -30,7 +30,7 @@ There is currently support for the following device types within Home Assistant:
Due to third party limitation, the sensors will only be available if Home Assistant and the Bbox are on the same local area network. You can check this by going to 192.168.1.254 with your web browser.
</p>
## {% linkable_title Presence Detection %}
## Presence Detection
The `bbox` platform offers presence detection by looking at connected devices to a [Bbox](https://fr.wikipedia.org/wiki/Bbox) based router from [Bouygues](https://www.bouyguestelecom.fr/), which is one of the main Internet provider in France.
@ -38,7 +38,7 @@ Bbox is a generic name for different hardware routers. The platform has been tes
- Sagem F@st 5330b
### {% linkable_title Configuration %}
### Configuration
To use an Bbox router in your installation, add the following to your `configuration.yaml` file:
@ -61,9 +61,9 @@ host:
For now and due to third party limitation, the Bbox must be on the same local network as the Home Assistant installation.
</p>
See the [device tracker component page](/components/device_tracker/) for instructions how to configure the people to be tracked.
See the [device tracker integration page](/components/device_tracker/) for instructions how to configure the people to be tracked.
## {% linkable_title Sensor %}
## Sensor
To add Bbox sensors to your installation, add the following to your `configuration.yaml` file:

8
source/_components/bh1750.markdown
View File

@ -22,7 +22,7 @@ Tested devices:
- [Raspberry Pi](https://www.raspberrypi.org/)
## {% linkable_title Configuration %}
## Configuration
To use your BH1750 sensor in your installation, add the following to your `configuration.yaml` file:
@ -70,7 +70,7 @@ multiplier:
type: integer
{% endconfiguration %}
## {% linkable_title Full Examples %}
## Full Examples
If you want to specify the resolution mode of the digital sensor or need to change the default I2c address (which is 0x23), add more details to the `configuration.yaml` file.
@ -88,7 +88,7 @@ sensor:
scan_interval: 25
```
## {% linkable_title Directions for installing smbus support on Raspberry Pi %}
## Directions for installing smbus support on Raspberry Pi
Enable I2c interface with the Raspberry Pi configuration utility:
@ -112,7 +112,7 @@ $ sudo addgroup homeassistant i2c
$ sudo reboot
```
### {% linkable_title Check the i2c address of the sensor %}
### Check the i2c address of the sensor
After installing `i2c-tools`, a new utility is available to scan the addresses of the connected sensors:

6
source/_components/binary_sensor.knx.markdown
View File

@ -16,9 +16,9 @@ ha_iot_class: Local Polling
The `knx` sensor platform allows you to monitor [KNX](http://www.knx.org) binary sensors.
## {% linkable_title Configuration %}
## Configuration
The `knx` component must be configured correctly, see [KNX Component](/components/knx).
The `knx` integration must be configured correctly, see [KNX Integration](/components/knx).
```yaml
# Example configuration.yaml entry
@ -51,7 +51,7 @@ reset_after:
type: integer
{% endconfiguration %}
### {% linkable_title Automation actions %}
### Automation actions
You can also attach actions to binary sensors (e.g., to switch on a light when a switch was pressed). In this example, one light is switched on when the button was pressed once and two others when the button was pressed a second time.

4
source/_components/binary_sensor.markdown
View File

@ -16,7 +16,7 @@ ha_release: 0.9
Binary sensors gather information about the state of devices which have a "digital" return value (either 1 or 0). These can be switches, contacts, pins, etc. These sensors only have two states: **0/off/low/closed/false** and **1/on/high/open/true**. Knowing that there are only two states allows Home Assistant to represent these sensors in a better way in the frontend according to their functionality.
### {% linkable_title Device Class %}
### Device Class
The way these sensors are displayed in the frontend can be modified in the [customize section](/getting-started/customizing-devices/). The following device classes are supported for binary sensors:
@ -45,7 +45,7 @@ The way these sensors are displayed in the frontend can be modified in the [cust
- **vibration**: `On` means vibration detected, `Off` means no vibration (clear)
- **window**: `On` means open, `Off` means closed
For analog sensors please check the [component overview](/components/#sensor).
For analog sensors please check the [integration overview](/components/#sensor).
<p class='img'>
<img src='/images/screenshots/binary_sensor_classes_icons.png' />

4
source/_components/binary_sensor.modbus.markdown
View File

@ -16,7 +16,7 @@ ha_iot_class: Local Push
The `modbus` binary sensor allows you to gather data from [Modbus](http://www.modbus.org/) coils.
## {% linkable_title Configuration %}
## Configuration
To use your Modbus binary sensors in your installation, add the following to your `configuration.yaml` file:
@ -62,7 +62,7 @@ coils:
It's possible to change the default 30 seconds scan interval for the sensor updates as shown in the [Platform options](/docs/configuration/platform_options/#scan-interval) documentation.
## {% linkable_title Full example %}
## Full example
Example a sensor with a 10 seconds scan interval:

10
source/_components/binary_sensor.mqtt.markdown
View File

@ -20,7 +20,7 @@ The binary sensor state will be updated only after a new message is published on
the binary sensor will receive an instant state update after subscription and Home Assistant will display the correct state on startup.
Otherwise, the initial state displayed in Home Assistant will be `unknown`.
## {% linkable_title Configuration %}
## Configuration
The `mqtt` binary sensor platform optionally supports an `availability_topic` to receive online and offline messages (birth and LWT messages) from the MQTT device. During normal operation, if the MQTT sensor device goes offline (i.e., publishes `payload_not_available` to `availability_topic`), Home Assistant will display the binary sensor as `unavailable`. If these messages are published with the `retain` flag set, the binary sensor will receive an instant update after subscription and Home Assistant will display the correct availability state of the binary sensor when Home Assistant starts up. If the `retain` flag is not set, Home Assistant will display the binary sensor as `unavailable` when Home Assistant starts up. If no `availability_topic`
is defined, Home Assistant will consider the MQTT device to be available.
@ -134,11 +134,11 @@ device:
type: string
{% endconfiguration %}
## {% linkable_title Examples %}
## Examples
In this section, you will find some real-life examples of how to use this sensor.
### {% linkable_title Full configuration %}
### Full configuration
To test, you can use the command line tool `mosquitto_pub` shipped with `mosquitto` or the `mosquitto-clients` package to send MQTT messages.
@ -168,7 +168,7 @@ binary_sensor:
```
{% endraw %}
### {% linkable_title Toggle the binary sensor each time a message is received on state_topic %}
### Toggle the binary sensor each time a message is received on state_topic
{% raw %}
```yaml
# Example configuration.yaml entry
@ -179,7 +179,7 @@ binary_sensor:
```
{% endraw %}
### {% linkable_title Get the state of a device with ESPEasy %}
### Get the state of a device with ESPEasy
Assuming that you have flashed your ESP8266 unit with [ESPEasy](https://github.com/letscontrolit/ESPEasy). Under "Config" is a name ("Unit Name:") set for your device (here it's "bathroom"). A configuration for a "Controller" for MQTT with the protocol "OpenHAB MQTT" is present and the entries ("Controller Subscribe:" and "Controller Publish:") are adjusted to match your needs. In this example, the topics are prefixed with "home". Also, add a "Switch Input" in the "Devices" tap with the name "switch" and "button" as value.

2
source/_components/binary_sensor.mysensors.markdown
View File

@ -39,7 +39,7 @@ S_MOISTURE | V_TRIPPED
For more information, visit the [serial api] of MySensors.
### {% linkable_title Example sketch %}
### Example sketch
```cpp
/**

8
source/_components/binary_sensor.rest.markdown
View File

@ -34,7 +34,7 @@ The JSON messages can contain different values like `1`, `"1"`,
}
```
## {% linkable_title Configuration %}
## Configuration
To enable this sensor,
add the following lines to your `configuration.yaml` file for a GET request:
@ -118,11 +118,11 @@ headers:
Make sure that the URL exactly matches your endpoint or resource.
</p>
## {% linkable_title Examples %}
## Examples
In this section you find some real-life examples of how to use this sensor.
### {% linkable_title aREST sensor %}
### aREST sensor
Instead of using an [aREST](/components/binary_sensor.arest/) binary sensor,
you could retrieve the value of a device supporting
@ -138,7 +138,7 @@ binary_sensor:
value_template: {% raw %}'{{ value_json.return_value }}'{% endraw %}
```
### {% linkable_title Accessing an HTTP authentication protected endpoint %}
### Accessing an HTTP authentication protected endpoint
The REST sensor supports HTTP authentication and customized headers.

10
source/_components/binary_sensor.rflink.markdown
View File

@ -14,11 +14,11 @@ ha_iot_class: Local Push
ha_release: 0.81
---
The `rflink` component supports devices that use [RFLink gateway firmware](http://www.nemcon.nl/blog2/), for example the [Nodo RFLink Gateway](https://www.nodo-shop.nl/nl/21-rflink-gateway). RFLink gateway is an Arduino firmware that allows two-way communication with a multitude of RF wireless devices using cheap hardware (Arduino + transceiver).
The `rflink` integration supports devices that use [RFLink gateway firmware](http://www.nemcon.nl/blog2/), for example the [Nodo RFLink Gateway](https://www.nodo-shop.nl/nl/21-rflink-gateway). RFLink gateway is an Arduino firmware that allows two-way communication with a multitude of RF wireless devices using cheap hardware (Arduino + transceiver).
First, you have to set up your [RFLink hub](/components/rflink/).
The RFLink component does not know the difference between a `binary_sensor`, a `switch` and a `light`. Therefore all switchable devices are automatically added as `light` by default.
The RFLink integration does not know the difference between a `binary_sensor`, a `switch` and a `light`. Therefore all switchable devices are automatically added as `light` by default.
RFLink binary_sensor/switch/light ID's are composed of: protocol, id, switch/channel. For example: `newkaku_0000c6c2_1`.
@ -69,15 +69,15 @@ devices:
default: false
{% endconfiguration %}
### {% linkable_title Sensor state %}
### Sensor state
Initially, the state of a binary sensor is unknown. When a sensor update is received, the state is known and will be shown in the frontend.
### {% linkable_title Device support %}
### Device support
See [device support](/components/rflink/#device-support)
### {% linkable_title Additional configuration examples %}
### Additional configuration examples
Multiple sensors with custom name and device class and set off_delay

14
source/_components/binary_sensor.rfxtrx.markdown
View File

@ -15,15 +15,15 @@ ha_release: 0.48
The `rfxtrx` platform support binary sensors that
communicate in the frequency range of 433.92 MHz.
The rfxtrx binary sensor component provides support for them.
The rfxtrx binary sensor integration provides support for them.
Many cheap sensors available on the web today are based on a particular RF chip
called *PT-2262*. Depending on the running firmware on the RFXcom box, some of
them may be recognized under the X10 protocol but most of them are recognized
under the *Lighting4* protocol. The rfxtrx binary sensor component provides
under the *Lighting4* protocol. The rfxtrx binary sensor integration provides
some special options for them, while other rfxtrx protocols should work too.
## {% linkable_title Setting up your devices %}
## Setting up your devices
Once you have set up your [rfxtrx hub](/components/rfxtrx/), the easiest way
to find your binary sensors is to add this to your `configuration.yaml`:
@ -95,7 +95,7 @@ automatic_add:
{% endconfiguration %}
<p class='note warning'>
This component and the [rfxtrx switch](/components/switch/rfxtrx/) can steal each other's devices when setting the `automatic_add` configuration parameter to `true`.
This integration and the [rfxtrx switch](/components/switch/rfxtrx/) can steal each other's devices when setting the `automatic_add` configuration parameter to `true`.
Set `automatic_add` only when you have some devices to add to your installation, otherwise leave it to `false`.
</p>
@ -133,7 +133,7 @@ binary_sensor:
seconds: 5
```
### {% linkable_title Options for PT-2262 devices under the Lighting4 protocol %}
### Options for PT-2262 devices under the Lighting4 protocol
When a data packet is transmitted by a PT-2262 device using the Lighting4
protocol, there is no way to automatically extract the device identifier and the
@ -188,7 +188,7 @@ devices:
command_off: 0x7
```
The *automatic_add* option makes the rfxtrx binary sensor component calculate
The *automatic_add* option makes the rfxtrx binary sensor integration calculate
and display the configuration options for you in the Home Assistant logs:
```text
@ -203,7 +203,7 @@ This automatic guess should work most of the time but there is
no guarantee on that. You should activate it only when you
want to configure your new devices and leave it off otherwise.
### {% linkable_title Known working devices %}
### Known working devices
The following devices are known to work with the rfxtrx binary sensor component.
There are too many other to list.

22
source/_components/binary_sensor.template.markdown
View File

@ -19,7 +19,7 @@ The `template` platform supports binary sensors which get their values from
other entities. The state of a Template Binary Sensor can only be `on` or
`off`.
## {% linkable_title Configuration %}
## Configuration
Here is an example of adding a Template Binary Sensor to the `configuration.yaml` file:
@ -32,7 +32,7 @@ binary_sensor:
sun_up:
friendly_name: "Sun is up"
value_template: >-
{{ states.sun.sun.attributes.elevation|float > 0 }}
{{ state_attr('sun.sun', 'elevation')|float > 0 }}
```
{% endraw %}
@ -82,7 +82,7 @@ sensors:
type: time
{% endconfiguration %}
## {% linkable_title Considerations %}
## Considerations
### Startup
@ -91,7 +91,7 @@ Template Binary Sensor may get an `unknown` state during startup. This results
in error messages in your log file until that platform has completed loading.
If you use `is_state()` function in your template, you can avoid this situation.
For example, you would replace
{% raw %}`{{ states.switch.source.state == 'on' }}`{% endraw %}
{% raw %}`{{ is_state('switch.source', 'on') }}`{% endraw %}
with this equivalent that returns `true`/`false` and never gives an unknown
result:
{% raw %}`{{ is_state('switch.source', 'on') }}`{% endraw %}
@ -104,11 +104,11 @@ the contents of a group. In this case you can use `entity_id` to provide a
list of entity IDs that will cause the sensor to update or you can run the
service `homeassistant.update_entity` to update the sensor at will.
## {% linkable_title Examples %}
## Examples
In this section you find some real-life examples of how to use this sensor.
### {% linkable_title Sensor Threshold %}
### Sensor Threshold
This example indicates true if a sensor is above a given threshold. Assuming a
sensor of `furnace` that provides a current reading for the fan motor, we can
@ -126,7 +126,7 @@ binary_sensor:
```
{% endraw %}
### {% linkable_title Switch as Sensor %}
### Switch as Sensor
Some movement sensors and door/window sensors will appear as a switch. By using
a Template Binary Sensor, the switch can be displayed as a binary sensors. The
@ -147,7 +147,7 @@ binary_sensor:
```
{% endraw %}
### {% linkable_title Combining Multiple Sensors %}
### Combining Multiple Sensors
This example combines multiple CO sensors into a single overall
status. When using templates with binary sensors, you need to return
@ -168,7 +168,7 @@ binary_sensor:
```
{% endraw %}
### {% linkable_title Washing Machine Running %}
### Washing Machine Running
This example creates a washing machine "load running" sensor by monitoring an
energy meter connected to the washer. During the washer's operation, the energy
@ -191,7 +191,7 @@ binary_sensor:
```
{% endraw %}
### {% linkable_title Is Anyone Home? %}
### Is Anyone Home?
This example is determining if anyone is home based on the combination of device
tracking and motion sensors. It's extremely useful if you have kids/baby sitter/
@ -216,7 +216,7 @@ binary_sensor:
```
{% endraw %}
### {% linkable_title Change the icon when state changes %}
### Change the icon when state changes
This example demonstrates how to use `icon_template` to change the entity's
icon as its state changes, it evaluates the state of its own sensor and uses a

42
source/_components/binary_sensor.xiaomi_aqara.markdown
View File

@ -16,9 +16,9 @@ ha_iot_class: Local Push
The `xiaomi aqara` binary sensor platform allows you to get data from your [Xiaomi](http://www.mi.com/en/) binary sensors.
The requirement is that you have setup the [`xiaomi aqara` component](/components/xiaomi_aqara/).
The requirement is that you have setup the [`xiaomi aqara` integration](/components/xiaomi_aqara/).
### {% linkable_title Type of sensors supported %}
### Type of sensors supported
| Name | Zigbee entity | Model no. | States | Event | Event key | Event values |
| ---- | ------------- | --------- | ------ | ----- | --------- | ------------ |
@ -39,9 +39,9 @@ The requirement is that you have setup the [`xiaomi aqara` component](/component
| Cube | cube | MFKZQ01LM | off (always) | `xiaomi_aqara.cube_action` | `action_type`, `action_value` (rotate) | `flip90`, `flip180`, `move`, `tap_twice`, `shake_air`, `swing`, `alert`, `free_fall`, `rotate` (degrees at action_value) |
| Vibration Sensor | vibration | DJT11LM | off (always) | `xiaomi_aqara.movement` | `movement_type` | `vibrate`, `tilt`, `free_fall` |
### {% linkable_title Automation examples %}
### Automation examples
#### {% linkable_title Motion %}
#### Motion
```yaml
- alias: If there is motion and its dark turn on the gateway light
@ -78,7 +78,7 @@ The requirement is that you have setup the [`xiaomi aqara` component](/component
entity_id: automation.Motion_off
```
#### {% linkable_title Door and/or Window %}
#### Door and/or Window
```yaml
- alias: If the window is open turn off the radiator
@ -107,7 +107,7 @@ The requirement is that you have setup the [`xiaomi aqara` component](/component
operation_mode: 'Smart schedule'
```
#### {% linkable_title Smoke %}
#### Smoke
```yaml
- alias: Send notification on fire alarm
@ -128,7 +128,7 @@ The requirement is that you have setup the [`xiaomi aqara` component](/component
ringtone_vol: 100
```
#### {% linkable_title Gas %}
#### Gas
```yaml
- alias: Send notification on gas alarm
@ -141,10 +141,10 @@ The requirement is that you have setup the [`xiaomi aqara` component](/component
- service: notify.html5
data_template:
title: Gas alarm!
message: 'Gas with a density of {% raw %}{{ states.binary_sensor.natgas_sensor_158dxxxxxxxxxx.attributes.density }}{% endraw %} detected.'
message: 'Gas with a density of {% raw %}{{ state_attr('binary_sensor.natgas_sensor_158dxxxxxxxxxx', 'density') }}{% endraw %} detected.'
```
#### {% linkable_title Xiaomi Wireless Button %}
#### Xiaomi Wireless Button
As indicated in the table on top of this page there are 3 versions of the button. For the round shaped button the available events are `single`, `double`, `hold`, `long_click_press` and `long_click_release`. Aqara branded buttons are square shaped. Model WXKG11LM only supports `single` and `double` events. WXKG12LM supports `single`, `double`, `long_click_press` and `shake` events. For the Aqara versions the delay between two clicks to generate a double click must be larger than with the round button. Clicking too quickly generates a single click event.
@ -184,9 +184,9 @@ As indicated in the table on top of this page there are 3 versions of the button
ringtone_vol: 8
```
#### {% linkable_title Xiaomi Cube %}
#### Xiaomi Cube
Available events are `flip90`, `flip180`, `move`, `tap_twice`, `shake_air`, `swing`, `alert`, `free_fall` and `rotate`. The component stores the last action as the attribute `last_action`.
Available events are `flip90`, `flip180`, `move`, `tap_twice`, `shake_air`, `swing`, `alert`, `free_fall` and `rotate`. The integration stores the last action as the attribute `last_action`.
```yaml
- alias: Cube event flip90
@ -251,7 +251,7 @@ Available events are `flip90`, `flip180`, `move`, `tap_twice`, `shake_air`, `swi
color_name: "blue"
```
#### {% linkable_title Aqara Wireless Switch %}
#### Aqara Wireless Switch
The Aqara Wireless Switch is available as single-key and double-key version. Each key behaves like the Wireless Button limited to the click event `single`. The double key version adds a third device called `binary_sensor.wall_switch_both_158xxxxxxxxx12` which reports a click event called `both` if both keys are pressed.
@ -268,11 +268,11 @@ The Aqara Wireless Switch is available as single-key and double-key version. Eac
entity_id: light.gateway_light_34xxxxxxxx13
data_template:
brightness: {% raw %}>-
{% if states.light.gateway_light_34xxxxxxxx13.attributes.brightness %}
{% if states.light.gateway_light_34xxxxxxxx13.attributes.brightness - 60 >= 10 %}
{{states.light.gateway_light_34xxxxxxxx13.attributes.brightness - 60}}
{% if state_attr('light.gateway_light_34xxxxxxxx13', 'brightness') %}
{% if state_attr('light.gateway_light_34xxxxxxxx13', 'brightness') - 60 >= 10 %}
{{state_attr('light.gateway_light_34xxxxxxxx13', 'brightness') - 60}}
{% else %}
{{states.light.gateway_light_34xxxxxxxx13.attributes.brightness}}
{{state_attr('light.gateway_light_34xxxxxxxx13', 'brightness')}}
{% endif %}
{% else %}
10
@ -290,11 +290,11 @@ The Aqara Wireless Switch is available as single-key and double-key version. Eac
entity_id: light.gateway_light_34xxxxxxxx13
data_template:
brightness: {% raw %}>-
{% if states.light.gateway_light_34xxxxxxxx13.attributes.brightness %}
{% if states.light.gateway_light_34xxxxxxxx13.attributes.brightness + 60 <= 255 %}
{{states.light.gateway_light_34xxxxxxxx13.attributes.brightness + 60}}
{% if state_attr('light.gateway_light_34xxxxxxxx13', 'brightness') %}
{% if state_attr('light.gateway_light_34xxxxxxxx13', 'brightness') + 60 <= 255 %}
{{state_attr('light.gateway_light_34xxxxxxxx13', 'brightness') + 60}}
{% else %}
{{states.light.gateway_light_34xxxxxxxx13.attributes.brightness}}
{{state_attr('light.gateway_light_34xxxxxxxx13', 'brightness')}}
{% endif %}
{% else %}
10
@ -312,7 +312,7 @@ The Aqara Wireless Switch is available as single-key and double-key version. Eac
entity_id: light.gateway_light_34xxxxxxxx13
```
#### {% linkable_title Vibration Sensor %}
#### Vibration Sensor
This automation toggles the living room lamp on vibration/tilt.

2
source/_components/blackbird.markdown
View File

@ -58,7 +58,7 @@ sources:
description: The name of the source.
{% endconfiguration %}
### {% linkable_title Service `media_player.blackbird_set_all_zones` %}
### Service `media_player.blackbird_set_all_zones`
Set all zones to the same input source. This service allows you to immediately synchronize all the TVs in your home. Regardless of `entity_id` provided, all zones will be updated.

30
source/_components/blink.markdown
View File

@ -23,13 +23,13 @@ redirect_from:
- /components/sensor.blink/
---
The `blink` component lets you view camera images and motion events from [Blink](http://blinkforhome.com) camera and security systems.
The `blink` integration lets you view camera images and motion events from [Blink](http://blinkforhome.com) camera and security systems.
## {% linkable_title Setup %}
## Setup
You will need your Blink login information (username, which is usually your email address, and password) to use this module.
## {% linkable_title Configuration %}
## Configuration
To enable devices linked in your [Blink](https://blinkforhome.com) account, add the following to your `configuration.yaml` file:
@ -85,7 +85,7 @@ mode:
default: not set
{% endconfiguration %}
Once Home Assistant starts, the `blink` component will create the following platforms:
Once Home Assistant starts, the `blink` integration will create the following platforms:
- An `alarm_control_panel` to arm/disarm the whole blink system (note, `alarm_arm_home` is not implemented and will not actually do anything, despite it being an option in the GUI).
- A `camera` for each camera linked to your Blink sync module.
@ -115,15 +115,15 @@ blink:
- wifi_strength
```
## {% linkable_title Services %}
## Services
Any sequential calls to services relating to blink should have a minimum of a 5 second delay in between them to prevent the calls fro being throttled and ignored.
### {% linkable_title `blink.blink_update` %}
### `blink.blink_update`
Force a refresh of the Blink system.
### {% linkable_title `blink.trigger_camera` %}
### `blink.trigger_camera`
Trigger a camera to take a new still image.
@ -131,7 +131,7 @@ Trigger a camera to take a new still image.
|------------------------|----------|----------------------------------------|
| `name` | no | Name of camera to take new image with. |
### {% linkable_title `blink.save_video` %}
### `blink.save_video`
Save the last recorded video of a camera to a local file. Note that in most cases, Home Assistant will need to know that the directory is writable via the `whitelist_external_dirs` in your `configuration.yaml` file (see example below).
@ -149,18 +149,18 @@ homeassistant:
- '/path/to/whitelist'
```
### {% linkable_title Other Services %}
### Other Services
In addition to the services mentioned above, there are generic `camera` and `alarm_control_panel` services available for use as well. The `camera.enable_motion_detection` and `camera.disable_motion_detection` services allow for individual cameras to be enabled and disabled, respectively, within the Blink system. The `alarm_control_panel.alarm_arm_away` and `alarm_control_panel.alarm_disarm` services allow for the whole system to be armed and disarmed, respectively.
## {% linkable_title Examples %}
## Examples
The following are some examples showing how to correctly make service calls using Blink:
### {% linkable_title Snap Picture and Save Locally %}
### Snap Picture and Save Locally
This example script shows how to take a picture with your camera, named `My Camera` in your Blink app (this is **not necessarily** the friendly name in home-assistant). After snapping a picture, the image will then be saved to a local directory called `/tmp/my_image.jpg`. Note that this example makes use of services found in the [camera component](https://www.home-assistant.io/components/camera#service-snapshot)
This example script shows how to take a picture with your camera, named `My Camera` in your Blink app (this is **not necessarily** the friendly name in home-assistant). After snapping a picture, the image will then be saved to a local directory called `/tmp/my_image.jpg`. Note that this example makes use of services found in the [camera integration](https://www.home-assistant.io/components/camera#service-snapshot)
```yaml
alias: Blink Snap Picture
@ -176,7 +176,7 @@ sequence:
filename: /tmp/my_image.jpg
```
### {% linkable_title Arm Blink When Away %}
### Arm Blink When Away
This example automation will arm your blink sync module to detect motion on any of your blink cameras that have motion detection enabled. By default, Blink enables motion detection on all cameras so, unless you've changed anything in your app, you're all set. If you want to manually enable motion detection for individual cameras, you can utilize the [appropriate camera service](https://www.home-assistant.io/components/camera#service-enable_motion_detection) but pelase note that motion will only be captured if the sync module is armed.
@ -194,7 +194,7 @@ Here, this example assumes your blink module is named `My Sync Module` and that
entity_id: alarm_control_panel.blink_my_sync_module
```
### {% linkable_title Disarm Blink When Home %}
### Disarm Blink When Home
Similar to the previous example, this automation will disarm blink when arriving home.
@ -210,7 +210,7 @@ Similar to the previous example, this automation will disarm blink when arriving
entity_id: alarm_control_panel.blink_my_sync_module
```
### {% linkable_title Save Video Locally When Motion Detected %}
### Save Video Locally When Motion Detected
When motion is detected, you can use the Blink Home-Assistant integration to save the last recorded video locally, rather than relying on Blink's servers to save your data.

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